createNasVolumeInstance

Prev Next

Available in VPC

Create NAS volume instances.

Syntax

The createNasVolumeInstance syntax is as follows:

./ncloud vnas createNasVolumeInstance \
    --volumeAllotmentProtocolTypeCode <NFS|CIFS> \
    --volumeSize <volume-size> \
    [--zoneCode <zone-code>] \
    [--volumeName <volume-name>] \
    [--nasVolumeDescription <nas-volume-description>] \
    [--accessControlRuleList <access-control-rule-config>] \
    [--cifsUserName <cifs-user-name>] \
    [--cifsUserPassword <cifs-user-password>] \
    [--isEncryptedVolume <true|false>] \
    [--isReturnProtection <true|false>] \
    [--isAsync <true|false>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createNasVolumeInstance.

Required options

The following options are required for createNasVolumeInstance.

Options Type Required Description
--volumeAllotmentProtocolTypeCode String Required Volume allocation protocol type code
  • NFS | CIFS
    • NFS: It can be mounted on Linux servers such as CentOS and Ubuntu.
    • CIFS: It can be mounted on Windows Servers.
--volumeSize Integer Required Volume size (GB)
  • 500-20000
  • Enter in 100 GB increments.
--cifsUserName String Conditional CIFS username
  • Enter 6-19 characters using a combination of English letters and numbers.
  • Required when creating a CIFS volume for the first time.
  • Can't be changed after configuration.
--cifsUserPassword String Conditional CIFS user password
  • Enter 8-14 characters using a combination of English letters, numbers, and the following special characters: ! @ ^ & *.
  • Required when creating a CIFS volume for the first time.
  • Passwords similar to the CIFS username can't be used.

Optional options

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

Options Type Required Description
--zoneCode String Optional Zone code where the NAS volume instance will be created
--volumeName String Optional NAS volume name
  • Enter 3-20 characters using a combination of English letters and numbers.
  • Assigned automatically if not entered.
  • The prefix nMemberNo_ is added to the name entered for customer identification.
--nasVolumeDescription String Optional Description of the volume (bytes)
  • 0-1000
--accessControlRuleList List Optional Access control rule list
  • For each rule, enter {field='value'} pairs enclosed in quotes and separated by commas.
    • serverInstanceNo (conditional): Server instance number to configure for access control. Required when entering writeAccess. See getServerInstanceList.
    • writeAccess (optional): Write permission. true (default) | false
--isEncryptedVolume Boolean Optional NAS volume encryption settings
  • true | false (default)
    • true: Enable.
    • false: Disable.
  • Encryption is applied by NAS volume.
  • Can only be applied when creating the NAS volume for the first time.
--isReturnProtection Boolean Optional Set termination protection
  • true | false (default)
    • true: Set
    • false: Not set
--isAsync Boolean Optional Set async
  • true | false (default)
    • true: Set
    • false: Not set

Common options

For information about the options common to all vnas subcommands, see NAS (VPC) options.

Examples

If the request to create a NAS volume instance is successful, the instance's configuration information and creation status are returned.

Command

The command example is as follows:

./ncloud vnas createNasVolumeInstance \
    --volumeAllotmentProtocolTypeCode NFS \
    --volumeSize 500 \
    --volumeName testnas01 \
    --nasVolumeDescription "Test NAS volume" \
    --isEncryptedVolume false \
    --isReturnProtection false \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createNasVolumeInstanceResponse": {
    "totalRows": 1,
    "nasVolumeInstanceList": [
      {
        "nasVolumeInstanceNo": "10234567",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS creation status"
        },
        "nasVolumeInstanceOperation": {
          "code": "NULL",
          "codeName": "NAS NULL OP"
        },
        "nasVolumeInstanceStatusName": "created",
        "createDate": "2026-08-19T11:32:32+0900",
        "nasVolumeDescription": "Test NAS volume",
        "mountInformation": "192.0.2.10:/n123456_testnas01",
        "volumeAllotmentProtocolType": {
          "code": "NFS",
          "codeName": "NFS"
        },
        "volumeName": "n123456_testnas01",
        "volumeTotalSize": 536870912000,
        "volumeSize": 536870912000,
        "snapshotVolumeConfigurationRatio": 0.0,
        "snapshotVolumeSize": 0,
        "isSnapshotConfiguration": false,
        "isEventConfiguration": false,
        "regionCode": "KR",
        "zoneCode": "KR-2",
        "nasVolumeServerInstanceNoList": [],
        "isEncryptedVolume": false,
        "nasVolumeInstanceCustomIpList": [],
        "isReturnProtection": false
      }
    ],
    "requestId": "",
    "returnCode": "0",
    "returnMessage": "success"
  }
}