Updating a cloud network

Written by

Yandex Cloud

Updated at November 26, 2024

Examples
- Updating a cloud network using its name

After creating a cloud network, you can change its name, description, and tags.

CLI

Terraform

API

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

See the description of the CLI command for updating cloud network parameters:
```
yc vpc network update --help
```

Get a list of all networks in the default folder:

yc vpc network list

Result:

+----------------------+----------------+
|          ID          |      NAME      |
+----------------------+----------------+
| enpavfmgapum******** | test-network-1 |
| enplom7a98s1******** | default        |
+----------------------+----------------+

Select the network's ID or NAME.

Change the parameters of the cloud network by specifying its name:

yc vpc network update enpavfmgapum******** --new-name test-network-renamed

Result:

id: enpavfmgapum********
folder_id: b1g6ci08ma55********
created_at: "2018-10-23T14:05:32Z"
name: test-network-renamed
description: My first network
labels:
  new_label: test_label

You can provide the ID and name not only as positional arguments, but also using the --id and --name flags:

yc vpc network update \
  --id enpavfmgapum******** \
  --new-name test-network-renamed \
  --labels new_label=test_label

yc vpc network update \
  --name test-network-1 \
  --new-name test-network-renamed \
  --labels new_label=test_label

If you don't have Terraform, install it and configure the Yandex Cloud provider.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

Open the Terraform configuration file and edit the fragment with the cloud network description:
```
...
resource "yandex_vpc_network" "default" {
  name        = "network-1"
  description = "My first network"
  labels = {
    tf-label    = "tf-label-value"
    empty-label = ""
  }
}
...
```
For more information about the yandex_vpc_network resource parameters in Terraform, see the provider documentation.
Check the configuration using this command:
```
terraform validate
```
If the configuration is correct, you will get this message:
```
Success! The configuration is valid.
```
Run this command:
```
terraform plan
```
The terminal will display a list of resources with parameters. No changes will be made at this step. If the configuration contains any errors, Terraform will point them out.
Apply the configuration changes:
```
terraform apply
```
Confirm the changes: type yes into the terminal and press Enter.

You can check the cloud network update using the management console or the following CLI command:
```
yc vpc network get <network_name>
```

To update a cloud network, use the update REST API method for the Network resource or the NetworkService/Update gRPC API call, and provide the following in the request:

ID of the cloud network you want to update in the networkId parameter.

To get the cloud network ID, use the list REST API method for the Network resource or the NetworkService/List gRPC API call and provide the folder ID in the folderId request parameter.

To learn how to find out the folder ID, see Getting the folder ID.
New network settings if needed:
- Name in the name parameter.
- Description in the description parameter.
- Network labels in the labels parameter.
List of settings to update in the updateMask parameter.

Warning

The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

Examples