Getting information about a cloud network

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the CLI command to get information about the cloud network:

   yc vpc network get --help
   

2. Get information about a network by specifying its name or ID:

   yc vpc network get <network_name>
   

   Result:

   id: ne7w0rkfj75j********
   folder_id: f01derqpemb4********
   created_at: "2023-10-25T14:59:46Z"
   name: my-network
   description: Auto-created network
   default_security_group_id: 5ecur17yj09k********
   

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.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To get information about a cloud network using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_vpc_network" "admin" {
     network_id = "<network_ID>"
   }
   
   output "network" {
     value = data.yandex_vpc_network.admin.created_at
   }
   

   Where:

   • data "yandex_vpc_network": Description of the cloud network as a data source:
     • network_id: Cloud network ID.
   • output "network": Output variable that contains information about the network creation timestamp:
     • value: Returned value.

   You can replace created_at with any other parameter to get the information you need. For more information about the yandex_vpc_network data source parameters, see the relevant provider documentation.

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   Terraform will create all the required resources and display the output variable values in the terminal. To check the results, run this command:

   terraform output
   

   Result:

   network = "2024-04-05T06:42:00Z"
   

To get detailed information about a cloud network, use the get REST API method for the Network resource or the NetworkService/Get gRPC API call and provide the ID of the cloud network you need in the networkId request 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.