---
title: "setVpcPeeringDescription"
slug: "cli-vpc-vpcpeering-setvpcpeeringdescription"
tags: ["VPC"]
updated: 2026-10-08T05:04:26Z
published: 2026-10-08T05:04:26Z
canonical: "cli.ncloud-docs.com/cli-vpc-vpcpeering-setvpcpeeringdescription"
---

> ## 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.

# setVpcPeeringDescription

Available in VPC

Edit the VPC peering description by specifying the VPC peering instance number.

## Syntax

The `setVpcPeeringDescription` syntax is as follows:

```
./ncloud vpc setVpcPeeringDescription \
    --vpcPeeringInstanceNo <vpc-peering-instance-no> \
    [--vpcPeeringDescription <vpc-peering-description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]
```

## Options

This section describes the options available when running `setVpcPeeringDescription`.

### Required options

The following options are required for `setVpcPeeringDescription`.

| Options | Type | Required | Description |
| --- | --- | --- | --- |
| `--vpcPeeringInstanceNo` | String | Required | VPC peering instance number - See [getVpcPeeringInstanceList](/docs/en/cli-vpc-vpcpeering-getvpcpeeringinstancelist). |

### Optional options

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

| Options | Type | Required | Description |
| --- | --- | --- | --- |
| `--vpcPeeringDescription` | String | Optional | Description of the VPC peering (byte) - 0-1000 |

### Common options

For information about the options common to all `vpc` subcommands, see [VPC options](/docs/en/cli-vpc#%EC%98%B5%EC%85%98).

## Examples

If the request to edit the VPC peering description is successful, the instance's configuration information is returned.

### Command

The command example is as follows:

```
./ncloud vpc setVpcPeeringDescription \
    --vpcPeeringInstanceNo 67890123 \
    --vpcPeeringDescription "Updated peering description" \
    --regionCode KR \
    --output json
```

### Output

The output example is as follows:

```
{
  "setVpcPeeringDescriptionResponse": {
    "totalRows": 1,
    "vpcPeeringInstanceList": [
      {
        "vpcPeeringInstanceNo": "67890123",
        "vpcPeeringName": "test-peering",
        "regionCode": "KR",
        "createDate": "2026-07-07T16:41:47+0900",
        "lastModifyDate": "2026-07-07T16:41:47+0900",
        "vpcPeeringInstanceStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "vpcPeeringInstanceStatusName": "Running",
        "vpcPeeringInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        },
        "sourceVpcNo": "12345678",
        "sourceVpcName": "test-vpc-01",
        "sourceVpcIpv4CidrBlock": "10.0.0.0/16",
        "sourceVpcLoginId": "user@example.com",
        "targetVpcNo": "12345679",
        "targetVpcName": "test-vpc-02",
        "targetVpcIpv4CidrBlock": "172.31.0.0/16",
        "targetVpcLoginId": "user2@example.com",
        "vpcPeeringDescription": "Updated peering description",
        "hasReverseVpcPeering": false,
        "isBetweenAccounts": true,
        "reverseVpcPeeringInstanceNo": ""
      }
    ],
    "requestId": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
```