Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createServerImageFromSnapshot

Prev Next

Available in VPC

Create a My server image with a KVM-based snapshot.

Syntax

The createServerImageFromSnapshot syntax is as follows:

./ncloud vserver createServerImageFromSnapshot \
    --serverImageName <server-image-name> \
    --blockStorageList <block-storage-config> \
    [--serverImageDescription <description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createServerImageFromSnapshot.

Required options

The following options are required for createServerImageFromSnapshot.

Options Type Required Description
--serverImageName String Required Server image name
  • Enter 3-30 characters using a combination of English letters, numbers, and special character -.
  • The string must start with a lowercase English letter and end with a lowercase English letter or a number.
--blockStorageList List Required List of block storage devices for the server image
  • For each storage, enter {field=‘value’} pairs within quotation marks, separated by commas.
    • order (required): Storage order. 0~20. One default storage (order=0) must be allocated, and up to 20 additional instances can be added (for a total of 21, including the default storage).
    • snapshotInstanceNo (conditional): Storage snapshot instance number. Required when allocating additional storage to the default storage or an existing snapshot. Only snapshots where isBootable is true can be used. Either snapshotInstanceNo or blockStorageVolumeTypeCode is required. See getBlockStorageSnapshotInstanceList.
    • blockStorageSize (conditional) Storage size (GB). Required when adding new storage. When using snapshotInstanceNo, set this to a value equal to or greater than the size of the existing snapshot. For storage-type-specific restrictions, see Storage specifications.
    • blockStorageVolumeTypeCode (conditional): Storage type. CB1 | CB2 | FB1 | FB2. Required when adding new storage. The type can be changed when using an existing snapshot. snapshotInstanceNo or blockStorageVolumeTypeCode is required. Default storage can't be used.
    • emptyBlockStorage (conditional) Whether to create new storage. true (Create) | false (Not create, snapshotInstanceNo required). Default storage can't be used.

Optional options

These are the optional options for createServerImageFromSnapshot. Options that are not specified will use their default values.

Options Type Required Description
--serverImageDescription String Optional Server image description (byte)
  • 0-1000

Common options

For information about the options common to all vserver subcommands, see Server (VPC) options.

Examples

If the request to create a server image from a snapshot is successful, the server image's identifier and the source snapshot information are returned.

Command

The command example is as follows:

./ncloud vserver createServerImageFromSnapshot \
    --serverImageName test-server-image-fromsnap-01 \
    --blockStorageList "order='0',snapshotInstanceNo='90123456'" \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createServerImageFromSnapshotResponse": {
    "totalRows": 1,
    "serverImageList": [
      {
        "serverImageNo": "45678901",
        "serverImageName": "test-server-image-fromsnap-01",
        "serverImageType": {
          "code": "SELF",
          "codeName": "SELF server image"
        },
        "serverImageLifeCyclePhase": {
          "code": "IN_SERVICE",
          "codeName": "In Service"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "cpuArchitectureType": {
          "code": "X86_64",
          "codeName": "x86 64bit"
        },
        "osCategoryType": {
          "code": "LINUX",
          "codeName": "LINUX"
        },
        "osType": {
          "code": "NAVIX",
          "codeName": "NAVIX"
        },
        "serverImageStatus": {
          "code": "CREAT",
          "codeName": "NSI CREATED state"
        },
        "serverImageOperation": {
          "code": "NULL",
          "codeName": "NSI NULL OP"
        },
        "serverImageStatusName": "created",
        "shareStatus": {
          "code": "NULL",
          "codeName": "NSI Share NULL State"
        },
        "blockStorageMappingList": [
          {
            "order": 0,
            "blockStorageSnapshotInstanceNo": 90123456,
            "blockStorageSnapshotName": "test-bootable-snap-01",
            "blockStorageSize": 10737418240,
            "blockStorageVolumeType": {
              "code": "CB1",
              "codeName": "Common BlockStorage 1"
            },
            "iops": 100,
            "throughput": 104857600,
            "isEncryptedVolume": false
          }
        ],
        "sharedLoginIdList": [],
        "serverImageProductCode": "SW.VSVR.OS.LNX64.NAVIX.09.G003",
        "createDate": "2026-05-14T16:31:28+0900",
        "platformCategoryCode": "OS"
      }
    ],
    "requestId": "b2c3d4e5-f678-9012-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}