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.

Server (VPC) overview

Prev Next

Available in VPC

Server is a NAVER Cloud Platform service that helps you create, scale, operate, and manage servers in a cloud environment. On the Server, the vserver command provides a CLI for server management features, including server instances, storage, networking, and security.

Common Server (VPC) settings

This section covers the command and option formats used across the Server (VPC) CLI.

Syntax

Run vserver using the following syntax.

./ncloud vserver <subcommand> [options]

Options

The following options are available across all vserver subcommands:

Options Type Required Description
--regionCode String Optional Region code of the server instance
  • KR | SGN | JPN
  • Default: First Region of the getRegionList query result (default)
--output String Optional Format of the output result
  • xml | json (default)

Server (VPC) commands

The following subcommands are available under vserver.

Login Key

The following describes the authentication key-related commands:

Commands Description
createLoginKey Create authentication key.
importLoginKey Import a public key generated by the user as an authentication key.
getLoginKeyList Get authentication key list.
deleteLoginKeys Delete authentication key.

ACG

The following describes the access control group (ACG)-related commands:

Commands Description
createAccessControlGroup Create ACG.
getAccessControlGroupList Get ACG list.
getAccessControlGroupDetail Get ACG details.
getAccessControlGroupRuleList Get the list of ACG rules.
addAccessControlGroupInboundRule Add an inbound rule to ACG.
removeAccessControlGroupInboundRule Delete an inbound rule from ACG.
addAccessControlGroupOutboundRule Add an outbound rule to ACG.
removeAccessControlGroupOutboundRule Delete an outbound rule from ACG.
deleteAccessControlGroup Delete ACG.

Init Script

The following describes the init script-related commands:

Commands Description
createInitScript Create initialization script number.
getInitScriptList Get the list of init scripts.
getInitScriptDetail Get init script details.
deleteInitScripts Delete init script.

Placement Group

The following describes the physical placement group-related commands:

Commands Description
createPlacementGroup Create a physical placement group where the server instance belongs.
getPlacementGroupList Get physical placement group list.
getPlacementGroupDetail Get details of physical placement group
addPlacementGroupServerInstance Add server instance to a physical placement group.
removePlacementGroupServerInstance Remove server instance from a physical placement group.
deletePlacementGroup Delete physical placement group.

Server Image

The following describes the server image-related commands:

Commands Description
createServerImage Create a server image with a server instance.
createServerImageFromSnapshot Create a server image with a snapshot.
getServerImageList Get server image list.
getServerImageDetail Get detailed information about server image.
addServerImageSharingPermission Add sharing permissions to a server image.
removeServerImageSharingPermission Delete sharing permissions from a server image.
deleteServerImage Delete server image.
createMemberServerImageInstance Create a member server image with a server instance.
getMemberServerImageInstanceList Get member server image list.
getMemberServerImageInstanceDetail Get member server image details.
addMemberServerImageSharingPermission Add sharing permission to a member server image.
setMemberServerImageSharingPermission Set sharing permissions for a member server image.
removeMemberServerImageSharingPermission Delete sharing permissions from a member server image.
deleteMemberServerImageInstances Delete a member server image.

Server Instance

The following describes the server instance-related commands:

Commands Description
createServerInstances Create a server instance.
getServerInstanceList Get server instance list.
getServerInstanceDetail Get server instance details.
getRootPasswordServerInstanceList Get the admin password list using the authentication key of a server instance.
getRootPassword Get the admin password using the authentication key of a server instance.
changeServerInstanceName Change the server instance name.
changeServerInstanceSpec Change the server instance specifications.
setProtectServerTermination Set server instance termination protection status.
startServerInstances Start server instance in the Stopped status.
stopServerInstances Stop server instance in the Running status.
rebootServerInstances Restart server instance in the Running status.
interruptServerInstance Run a diagnostic interrupt to analyze the status of a server instance.
terminateServerInstances Terminate a server instance in the Stopped status.

Network Interface

The following describes the network interface-related commands:

Commands Description
createNetworkInterface Create network interfaces.
getNetworkInterfaceList Get the list of network interfaces.
getNetworkInterfaceDetail Get network interface details.
attachNetworkInterface Assign a network interface to a server instance.
detachNetworkInterface Remove the network interface assigned to a server instance.
addNetworkInterfaceAccessControlGroup Add an ACG to a network interface.
removeNetworkInterfaceAccessControlGroup Delete an ACG from a network interface.
assignSecondaryIps Assign secondary IPs to network interfaces.
unassignSecondaryIps Remove a secondary IP assigned to a network interface.
enableFlowLog Enable Flow Log.
getFlowLogConfigurationList Get Flow Log configuration information.
disableFlowLog Disable Flow Log.
deleteNetworkInterface Delete network interfaces.

Public IP

The following describes the public IP-related commands:

Commands Description
createPublicIpInstance Create public IP instance.
getPublicIpInstanceList Get public IP instance list.
getPublicIpInstanceDetail Get public IP instance details.
getPublicIpTargetServerInstanceList Get the list of server instances that can be assigned a public IP address.
associatePublicIpWithServerInstance Assign public IP instance to a server instance.
disassociatePublicIpFromServerInstance Remove a public IP instance assigned to a server instance.
deletePublicIpInstance Delete public IP instance.

Storage

The following describes the storage-related commands:

Commands Description
createBlockStorageInstance Create block storage instance.
getBlockStorageInstanceList Get the list of block storage instances.
getBlockStorageInstanceDetail Get block storage instance details.
getBlockStorageVolumeTypeList Get the list of block storage volume types.
attachBlockStorageInstance Assign block storage instance to a server instance.
detachBlockStorageInstances Remove the list of block storage instances assigned to a server instance.
changeBlockStorageInstance Change block storage volume size.
changeBlockStorageVolumeSize Change block storage volume size.
setBlockStorageReturnProtection Set block storage termination protection status.
deleteBlockStorageInstances Delete a block storage instance.

Snapshot

The following describes the snapshot-related commands:

Commands Description
createBlockStorageSnapshotInstance Create block storage snapshot instance.
getBlockStorageSnapshotInstanceList Get the list of block storage snapshot instances.
getBlockStorageSnapshotInstanceDetail Get block storage snapshot instance details.
deleteBlockStorageSnapshotInstances Delete a block storage snapshot instance.

Fabric Cluster

The following describes the fabric cluster-related commands:

Commands Description
createFabricCluster Create Fabric cluster.
getFabricClusterPoolList Get the Fabric cluster pool list.
getFabricClusterList Get Fabric cluster list.
getFabricClusterDetail Get Fabric cluster details.
updateFabricCluster Edit Fabric cluster.
updateFabricClusterServerInstances Change the list of server instances in Fabric cluster.
deleteFabricCluster Delete Fabric cluster.

Common

Use the following common lookup commands when creating resources:

Commands Description
getRegionList Get Region list.
getZoneList Get zone list.
getServerImageProductList Get the list of Server image product codes.
getServerProductList Get the list of Server spec codes.
getServerSpecList Get server specification list.
getServerSpecDetail Get server specification details.
getHypervisorTypeList Get the hypervisor type list.
getRaidList Get RAID list.

Server (VPC) related resources

These resources provide additional context and support for the Server (VPC) CLI.