Updating a VM

Examples

After you create a VM, you can change its name, description, tags, platform, or metadata.

For more information about how to update a VM's configuration, see the section Changing VM computing resources.

CLI

API

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

See the description of the CLI's update VM parameter command:
```
$ yc compute instance update --help
```

Get a list of VMs in the default folder:

$ yc compute instance list
+----------------------+-----------------+---------------+---------+----------------------+
|          ID          |       NAME      |    ZONE ID    | STATUS  |     DESCRIPTION      |
+----------------------+-----------------+---------------+---------+----------------------+
| fhm0b28lgfp4tkoa3jl6 | first-instance  | ru-central1-a | RUNNING | my first vm via CLI  |
| fhm9gk85nj7gcoji2f8s | second-instance | ru-central1-a | RUNNING | my second vm via CLI |
+----------------------+-----------------+---------------+---------+----------------------+

Select the ID or NAME of the VM you need (for example, first-instance).

Change the VM parameters, for example, rename it:

$ yc compute instance update first-instance \
    --new-name windows-vm

To change the VM, use the update method for the Instance resource.

Examples

Viewing a list of configurable parameters

To view the list of configurable parameters, run the command:

CLI

$ yc compute instance update --help

Changing the name and description

To change the name and description of a VM, follow these steps:

CLI

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

Get a list of VMs in the default folder:

$ yc compute instance list
+----------------------+-----------------+---------------+---------+----------------------+
|          ID          |       NAME      |    ZONE ID    | STATUS  |     DESCRIPTION      |
+----------------------+-----------------+---------------+---------+----------------------+
| fhm0b28lgfp4tkoa3jl6 | first-instance  | ru-central1-a | RUNNING | my first vm via CLI  |
| fhm9gk85nj7gcoji2f8s | second-instance | ru-central1-a | RUNNING | my second vm via CLI |
+----------------------+-----------------+---------------+---------+----------------------+

Select the ID or NAME of the VM you need (for example, first-instance).

Change the VM's name and description:

$ yc compute instance update first-instance \
    --new-name first-vm \
    --description "changed description vm via CLI"

Changing metadata

Metadata based on different operating systems may differ. When you change an existing set of metadata, it is completely replaced by the set passed in the command.

To change a VM's metadata, follow these steps:

CLI

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

Get a list of VMs in the default folder:

$ yc compute instance list
+----------------------+-----------------+---------------+---------+----------------------+
|          ID          |       NAME      |    ZONE ID    | STATUS  |     DESCRIPTION      |
+----------------------+-----------------+---------------+---------+----------------------+
| fhm0b28lgfp4tkoa3jl6 | first-instance  | ru-central1-a | RUNNING | my first vm via CLI  |
| fhm9gk85nj7gcoji2f8s | second-instance | ru-central1-a | RUNNING | my second vm via CLI |
+----------------------+-----------------+---------------+---------+----------------------+

Select the ID or NAME of the VM you need (for example, first-instance).
Get information about the VM with the metadata. All user-defined metadata is specified in the user-data key.
```
$ yc compute instance get --full first-instance
```
Change the VM's metadata. You can change the metadata using the flags:
- --metadata — to change a value from a single string.
- --metadata-from-file — to change a value from multiple strings.
Example of changing the administrator's password on a Windows-based VM:
1. Create a YAML file (for example, metadata.yaml) and specify the following:
```
#ps1
net user administrator "<password>"
```
2. Run the command:
```
$ yc compute instance update first-instance \
    --metadata-from-file user-data=metadata.yaml
```
The existing metadata set will be completely overwritten.

Changing an SSH key

To change or add an SSH key, follow these steps:

CLI

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

Get a list of VMs in the default folder:

$ yc compute instance list
+----------------------+-----------------+---------------+---------+----------------------+
|          ID          |       NAME      |    ZONE ID    | STATUS  |     DESCRIPTION      |
+----------------------+-----------------+---------------+---------+----------------------+
| fhm0b28lgfp4tkoa3jl6 | first-instance  | ru-central1-a | RUNNING | my first vm via CLI  |
| fhm9gk85nj7gcoji2f8s | second-instance | ru-central1-a | RUNNING | my second vm via CLI |
+----------------------+-----------------+---------------+---------+----------------------+

Select the ID or NAME of the VM you need (for example, first-instance).

Get information about the VM with the metadata. All user-defined metadata is specified in the user-data key.

$ yc compute instance get --full first-instance

Sample response:

...
#cloud-config
users:
- name: demo
    groups: sudo
    shell: /bin/bash
    sudo: ['ALL=(ALL) NOPASSWD:ALL']
    ssh-authorized-keys:
        - ssh-rsa AAAAB3Nza......OjbSMRX user@example.com
...

Create a text file with any name, for example metadata.txt.

Copy the received data to the created file and add a new SSH key.

Example:

#cloud-config
users:
- name: demo
    groups: sudo
    shell: /bin/bash
    sudo: ['ALL=(ALL) NOPASSWD:ALL']
    ssh-authorized-keys:
        - ssh-rsa AAAAB3Nza......OjbSMRX user@example.com
        - ssh-rsa AAAAB3Nza......Pu00jRN user@example.com

Change the VM's metadata:

$ yc compute instance update first-instance \
    --metadata-from-file user-data=metadata.txt

The existing metadata set will be completely overwritten.