Getting information about a VM

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.

1. View a description of the command to get serial port output:

   yc compute instance get --help
   

2. Select a VM, such as first-instance:

   yc compute instance list
   

   Result:

   +----------------------+-----------------+---------------+---------+----------------------+
   |          ID          |       NAME      |    ZONE ID    | STATUS  |     DESCRIPTION      |
   +----------------------+-----------------+---------------+---------+----------------------+
   | fhm0b28lgfp4******** | first-instance  | ru-central1-a | RUNNING | my first vm via CLI  |
   | fhm9gk85nj7g******** | second-instance | ru-central1-a | RUNNING | my second vm via CLI |
   +----------------------+-----------------+---------------+---------+----------------------+
   

3. Get basic information about the VM:

   yc compute instance get first-instance
   

   To get VM information with metadata, use the --full flag:

   yc compute instance get --full first-instance
   

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

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

1. In the Terraform configuration file, describe the parameters of the resources you want to create:

   data "yandex_compute_instance" "my_instance" {
     instance_id = "<instance_ID>"
   }
   
   output "instance_external_ip" {
     value = "${data.yandex_compute_instance.my_instance.network_interface.0.nat_ip_address}"
   }
   

   Where:

   • data "yandex_compute_instance": Description of the data source to get VM information from:
     • instance_id: VM ID.
   • output "instance_external_ip": Public IP address of the VM to output:
     • value: Returned value.

   For more information about the yandex_compute_instance data source parameters, see the 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 the required resources and display the output variable values in the terminal. To check the results, run:

   terraform output instance_external_ip
   

   Result:

   instance_external_ip = "158.160.50.228"
   

To get basic information about a VM, use the get REST API method for the Instance resource or the InstanceService/Get gRPC API call.

The basic information does not include the user-defined metadata provided when creating or updating the VM. To get the information along with the metadata, specify view=FULL in the parameters.

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

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

1. Open the Terraform configuration file and change the metadata_options parameter in the VM description:

   ...
   resource "yandex_compute_instance" "test-vm" {
     ...
     metadata_options {
       aws_v1_http_endpoint = 2
       aws_v1_http_token    = 2
       gce_http_endpoint    = 0
       gce_http_token       = 0
     }
     ...
   }
   ...
   

   Where:

   • yandex_compute_instance: Description of the VM:
     • metadata_options: Metadata parameters:
       • aws_v1_http_endpoint: Provides access to metadata using AWS format (IMDSv1). Possible values: 0 and 1: Enabled; 2: Disabled.
       • aws_v1_http_token: Provides access to Identity and Access Management credentials using AWS format (IMDSv1). Possible values: 0 and 1: Enabled; 2: Disabled.
       • gce_http_endpoint: Provides access to metadata using Google Compute Engine format. Possible values: 0 and 1: Enabled; 2: Disabled.
       • gce_http_token: Provides access to Identity and Access Management credentials using Google Compute Engine format. Possible values: 0 and 1: Enabled; 2: Disabled.

   For more information about the yandex_compute_instance resource parameters in Terraform, see the 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.

   All the resources you need will then be created in the specified folder with the settings you defined. You can check the new resources and their configuration using the management console or this CLI command:

   yc compute instance get <VM_name>
   

Use the update REST API method for the Instance resource or the InstanceService/Update gRPC API call.

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.

1. View a description of the CLI command to remove metadata:

   yc compute instance remove-metadata --help
   

2. Remove the keys:

   yc compute instance remove-metadata <VM_ID> --keys <SSH_key_name>
   

To remove SSH keys from the VM metadata, use the updateMetadata REST API method for the Instance resource or the InstanceService/UpdateMetadata gRPC API call.

In your request, provide the delete parameter with the SSH key.

Sample REST API request

curl -X POST -H "Authorization: Bearer <IAM_token>" \
  -d '{"delete":["<SSH_key_name>"]}' https://compute.api.cloud.yandex.net/compute/v1/instances/<VM_ID>/updateMetadata