setRouteTableDescription

Available in VPC

Edit the route table description by specifying a route table number.

Syntax

The setRouteTableDescription syntax is as follows:

./ncloud vpc setRouteTableDescription \
    --routeTableNo <route-table-no> \
    [--routeTableDescription <route-table-description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running setRouteTableDescription.

Required options

The following options are required for setRouteTableDescription.

Options	Type	Required	Description
`--routeTableNo`	String	Required	Route table number See getRouteTableList.

Optional options

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

Options	Type	Required	Description
`--routeTableDescription`	String	Optional	Description of the route table (byte) `0`-`1,000`

Common options

For information about the options common to all vpc subcommands, see VPC options.

Examples

If the request to edit the route table description is successful, the configuration information for the route table is returned.

Command

The command example is as follows:

./ncloud vpc setRouteTableDescription \
    --routeTableNo 45678901 \
    --routeTableDescription "Updated route table description" \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "setRouteTableDescriptionResponse": {
    "totalRows": 1,
    "routeTableList": [
      {
        "routeTableNo": "45678901",
        "routeTableName": "test-route-table",
        "regionCode": "KR",
        "vpcNo": "12345678",
        "supportedSubnetType": {
          "code": "PUBLIC",
          "codeName": "Public"
        },
        "isDefault": false,
        "routeTableStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "routeTableDescription": "Updated route table description"
      }
    ],
    "requestId": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "returnCode": "0",
    "returnMessage": "success"
  }
}