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.

Cloud DB for MSSQL (VPC) overview

Prev Next

Available in VPC

Cloud DB for MSSQL is a fully managed cloud database service that allows you to easily set up and reliably operate MSSQL databases using NAVER’s optimized settings, and automatically recover from failures. Cloud DB for MSSQL provides CLIs for database management features with the vmssql command.

Common Cloud DB for MSSQL (VPC) settings

This section covers the command and option formats used across the Cloud DB for MSSQL (VPC) CLI.

Syntax

Run vmssql using the following syntax.

./ncloud vmssql <subcommand> [options]

Options

The following options are available across all vmssql subcommands:

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

Cloud DB for MSSQL (VPC) commands

The following subcommands are available under vmssql.

DB Server

The following describes the DB server-related commands:

Commands Description
createCloudMssqlInstance Create Cloud DB for MSSQL instances.
getCloudMssqlInstanceList Get the Cloud DB for MSSQL instance list.
getCloudMssqlInstanceDetail Get Cloud DB for MSSQL instance details.
createCloudMssqlSlaveInstance Add a slave server instance in a Cloud DB for MSSQL instance.
rebootCloudMssqlServerInstance Restart Cloud DB for MSSQL server instances.
deleteCloudMssqlServerInstance Delete a slave server instance in a Cloud DB for MSSQL instance.
deleteCloudMssqlInstance Delete Cloud DB for MSSQL instances.

Backup

The following describes the backup-related commands:

Commands Description
getCloudMssqlBackupList Get the Cloud DB for MSSQL instance backup list.
getCloudMssqlBackupDetailList Get the list of Cloud DB for MSSQL instance backup details.
exportBackupToObjectStorage Send Cloud DB for MSSQL instance backup files to Object Storage.

DB Server Log

The following describes the DB server logs-related commands:

Commands Description
getCloudMssqlLogFileList Get the Cloud DB for MSSQL log file list.
getCloudMssqlLogBackupFileList Get the Cloud DB for MSSQL instance log backup file list.
exportDbServerLogsToObjectStorage Send DB server log files in a Cloud DB for MSSQL instance to Object Storage.

Common

Use the following common lookup commands when creating resources:

Commands Description
getCloudMssqlImageProductList Get the list of Cloud DB for MSSQL image product codes.
getCloudMssqlProductList Get the list of Cloud DB for MSSQL server specification codes.
getCloudMssqlTargetVpcList Get VPC list.
getCloudMssqlTargetSubnetList Get subnet list.
getCloudMssqlCharacterSetList Get the Cloud DB for MSSQL character set list.
getCloudMssqlConfigGroupList Get the Cloud DB for MSSQL config group list.
getCloudMssqlBucketList Get Object Storage bucket list.
getCloudMssqlFolderList Get the Object Storage folder list.

Cloud DB for MSSQL (VPC) related resources

These resources provide additional context and support for the Cloud DB for MSSQL (VPC) CLI.