createServerImage

Available in VPC

Create a My server image.

Syntax

The createServerImage syntax is as follows:

./ncloud vserver createServerImage \
    --serverInstanceNo <server-instance-no> \
    --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 createServerImage.

Required options

The following options are required for createServerImage.

Options	Type	Required	Description
`--serverInstanceNo`	String	Required	Source server instance number See getServerInstanceList.
`--serverImageName`	String	Required	Server image name Enter 3-30 characters using a combination of English letters, numbers, and special characters `-` and `_`. The string must start with a lowercase English letter and end with a lowercase English letter or a number.

Optional options

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

Options	Type	Required	Description
`--blockStorageList`	List	Optional	List of block storage devices to add to the server image For each storage, enter {field=‘value’} pairs within quotation marks, separated by commas. `order` (required): Storage order. `1`~`20`. The default storage (`order=0`) is automatically allocated by the source server, 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 an existing snapshot. 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. Either `snapshotInstanceNo` or `blockStorageVolumeTypeCode` is required. `noBlockStorage` (conditional): Whether to exclude storage. `true` (Excluded) \| `false` (Not excluded, `snapshotInstanceNo` required) `emptyBlockStorage` (conditional): Whether to create new storage. `true` (Create) \| `false` (Not create, `snapshotInstanceNo` required) Available only for KVM. If not entered, My server image will be created that includes all block storage on the server.
`--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 server image creation request is successful, the server image's identification information and initial state are returned.

Command

The command example is as follows:

./ncloud vserver createServerImage \
    --serverInstanceNo 34567890 \
    --serverImageName test-server-image-01 \
    --serverImageDescription "Test server image" \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createServerImageResponse": {
    "totalRows": 1,
    "serverImageList": [
      {
        "serverImageNo": "45678901",
        "serverImageName": "test-server-image-01",
        "serverImageDescription": "Test server image",
        "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": "INIT",
          "codeName": "NSI INIT state"
        },
        "serverImageOperation": {
          "code": "CREAT",
          "codeName": "NSI CREAT OP"
        },
        "serverImageStatusName": "creating",
        "shareStatus": {
          "code": "NULL",
          "codeName": "NSI Share NULL State"
        },
        "blockStorageMappingList": [
          {
            "order": 0,
            "blockStorageSnapshotInstanceNo": 90123456,
            "blockStorageSnapshotName": "n01234567890abcd",
            "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:25:00+0900",
        "platformCategoryCode": "OS"
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index