Updating a device

Written by

Updated at November 26, 2024

Updating device names
Updating device descriptions

You can update the name or description of a device.

To access a device, use its unique ID or name. For information about how to get its unique ID or name, see Getting information about devices.

Updating device names

Management console

CLI

Terraform

API

To update the name of a device:

In the management console, select the folder to update the device name in.
Select IoT Core.
Select the required registry from the list.
On the left side of the window, select the Devices section.
To the right of the name of the device you need, click and select Edit from the drop-down list.
Edit the Name field.
Click Save.

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

Update a device description:

yc iot device update my-device --new-name test-device

Result:

id: b9135goeh1uc********
registry_id: b91ki3851hab********
created_at: "2019-05-28T16:08:30.938Z"
name: test-device

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 don't have Terraform, install it and configure the Yandex Cloud provider.

To update the name of a device created using Terraform:

Open the Terraform configuration file and edit the name parameter value in the device description fragment:

Example device description in the Terraform configuration:
```
resource "yandex_iot_core_device" "my_device" {
  registry_id = "<registry_ID>"
  name        = "test-device"
  description = "test device for terraform provider documentation"
...
}
```
For more information about the yandex_iot_core_device resource parameters in Terraform, see the relevant provider documentation.
In the command line, change to the folder where you edited the configuration file.
Make sure the configuration file is correct 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 updated device name in the management console or using this CLI command:
```
yc iot device list --registry-id <registry_ID>
```

To rename a device, use the update REST API method for the Device resource or the DeviceService/Update gRPC API call.

Updating device descriptions