Backups in Yandex IoT Core
- Getting a list of registries
- Getting information about a registry
- Getting a list of registry certificates
- Getting a list of registry devices
- Getting information about a device
- Getting a list of device certificates
- Getting a list of device aliases
- Getting a list of brokers
- Getting information about a broker
- Getting a list of broker certificates
Data in Yandex IoT Core is stored securely and replicated within the Yandex Cloud infrastructure. You can view:
- Lists of registries.
- Information about registries.
- Lists of registry certificates.
- Lists of registry devices.
- Information about the devices.
- Lists of device certificates.
- Lists of device aliases.
Warning
Registry and device passwords are not backed up. We recommend saving them on your own.
Getting a list of registries
- In the management console
, select the folder where you want to get a list of registries. - Go to IoT Core.
- The Registries page will show the list of registries.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
-
View the description of the CLI command to get a list of registries:
yc iot registry list --help -
Get a list of registries in the default folder:
yc iot registry listResult:
+----------------------+-------------+ | ID | NAME | +----------------------+-------------+ | b91ki3851hab******** | my-registry | +----------------------+-------------+
To get a list of registries, use the list REST API method for the Registry resource or the RegistryService/List gRPC API call.
Getting information about a registry
- In the management console
, select the folder where the registry is located. - Go to IoT Core.
- Select the registry.
- The Overview page will show the registry details.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
-
View the description of the CLI command to get information about the registry:
yc iot registry get --help -
Get detailed information about the registry by specifying its name or ID:
yc iot registry get <registry_name>Result:
id: b91ki3851hab******** folder_id: aoek49ghmknn******** created_at: "2019-05-28T11:29:42.420Z" name: my-registry
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To get detailed information about a registry using Terraform:
-
Add the
dataandoutputsections to the Terraform configuration file:data "yandex_iot_core_registry" "my_registry" { registry_id = "<registry_ID>" } output "registry_params" { value = data.yandex_iot_core_registry.my_registry.created_at }Where:
data "yandex_iot_core_registry": Description of the registry as a data source:registry_id: Registry ID.
output "registry_params": Output variable that contains information about the registry creation timestamp:value: Return value.
You can replace
created_atwith any other parameter to get the information you need. For more information about theyandex_iot_core_registrydata source properties, see this Terraform provider article. -
Create the resources:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validateIf the configuration is correct, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.
-
Apply the changes:
terraform apply -
Type
yesand press Enter to confirm the changes.
Terraform will create the required resources and display their output variables. To check the results, run this command:
terraform outputResult:
registry_params = "2024-05-08T06:40:52Z" -
To get detailed information about a registry, use the get REST API method for the Registry resource or the RegistryService/Get gRPC API call.
Getting a list of registry certificates
- In the management console
, select the folder where the registry is located. - Go to IoT Core.
- Select the registry.
- On the Overview page, go to the Certificates section.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
Get a list of registry certificates:
yc iot registry certificate list --registry-name my-registry
Result:
+------------------------------------------+---------------------+
| FINGERPRINT | CREATED AT |
+------------------------------------------+---------------------+
| 0f511ea32139178edf73afb953a9cc39******** | 2019-05-29 16:46:23 |
| 589ce1605019eeff7bb0992f290be0cd******** | 2019-05-29 16:40:48 |
+------------------------------------------+---------------------+
To get a list of registry certificates, use the listCertificates REST API method for the Registry resource or the RegistryService/ListCertificates gRPC API call.
Getting a list of registry devices
- In the management console
, select the folder where the registry is located. - Go to IoT Core.
- Select the registry.
- Navigate to the Devices tab.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
-
View the description of the CLI command to get a list of devices:
yc iot device list --help -
Get a list of devices in the registry by specifying its name or ID:
yc iot device list --registry-name <registry_name>Result:
+----------------------+-----------+ | ID | NAME | +----------------------+-----------+ | b9135goeh1uc******** | my-device | +----------------------+-----------+
To get a list of devices in a registry, use the list REST API method for the Device resource or the DeviceService/List gRPC API call.
Getting information about a device
- In the management console
, select the folder where the device is located. - Go to IoT Core.
- Select the registry where the device is located.
- Navigate to the Devices tab.
- Select the device.
- The Overview page will show the device details.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
-
View the description of the CLI command to get information about a device:
yc iot device get --help -
Get detailed information about a device by specifying its name or ID:
yc iot device get <device_name>Result:
id: b9135goeh1uc******** registry_id: b91ki3851hab******** created_at: "2019-05-28T16:08:30.938Z" name: my-device
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To get detailed information about a device using Terraform:
-
Add the
dataandoutputsections to the Terraform configuration file:data "yandex_iot_core_device" "my_device" { device_id = "<device_ID>" } output "device_params" { value = data.yandex_iot_core_device.my_device.registry_id }Where:
data "yandex_iot_core_device": Description of the device as a data source:device_id: Device ID.
output "device_params": Output variable containing information about the registry the device belongs to:value: Return value.
You can replace
registry_idwith any other parameter to get the information you need. For more information about theyandex_iot_core_devicedata source properties, see this Terraform provider article. -
Create the resources:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validateIf the configuration is correct, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.
-
Apply the changes:
terraform apply -
Type
yesand press Enter to confirm the changes.
Terraform will create the required resources and display their output variables. To check the results, run this command:
terraform outputResult:
device_params = "are7ajlrf493********" -
To get detailed information about a device, use the get REST API method for the Device resource or the DeviceService/Get gRPC API call.
Getting a list of device certificates
- In the management console
, select the folder where the device is located. - Go to IoT Core.
- Select the registry where the device is located.
- Navigate to the Devices tab.
- Select the device.
- On the Overview page, go to the Certificates section.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
View the list of device certificates:
yc iot device certificate list --device-name my-device
Result:
+------------------------------------------+---------------------+
| FINGERPRINT | CREATED AT |
+------------------------------------------+---------------------+
| df3cc4f337eba01a264803d15b119e2d******** | 2019-05-29 17:14:36 |
| 65e5b050069da5ca5996a4a8a9251409******** | 2019-05-29 17:14:18 |
+------------------------------------------+---------------------+
To get a list of device certificates, use the listCertificates REST API method for the Device resource or the DeviceService/ListCertificates gRPC API call.
Getting a list of device aliases
- In the management console
, select the folder where the device is located. - Go to IoT Core.
- Select the registry where the device is located.
- Navigate to the Devices tab.
- Select the device.
- On the Overview page, go to the Aliases section.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
You can only get a list of aliases for all devices in the registry.
Get a list of aliases for all devices in the registry:
yc iot registry list-device-topic-aliases my-registry
Result:
+----------+----------------------------------------+----------------------+
| ALIAS | TOPIC PREFIX | DEVICE ID |
+----------+----------------------------------------+----------------------+
| commands | $devices/arenak5ciqss********/commands | arenak5ciqss******** |
+----------+----------------------------------------+----------------------+
To get a list of device aliases, use the get REST API method for the Device resource or the DeviceService/Get gRPC API call.
Getting a list of brokers
- In the management console
, select the folder where you want to get a list of brokers. - Go to IoT Core.
- In the left-hand panel, select Brokers. A list of brokers will be displayed on the Brokers page.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
-
View the description of the CLI command to get a list of brokers:
yc iot broker list --help -
Get a list of brokers in the default folder:
yc iot broker listResult:
+----------------------+-------------+ | ID | NAME | +----------------------+-------------+ | b91ki3851h********** | my-broker | +----------------------+-------------+
To get a list of brokers, use the list REST API method for the Broker resource or the BrokerService/List gRPC API call.
Getting information about a broker
- In the management console
, select the folder where the broker is located. - Go to IoT Core.
- In the left-hand panel, select Brokers.
- Select the broker. Detailed information about the broker will be displayed on the Overview page.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
-
View the description of the CLI command to get information about a broker:
yc iot broker get --help -
Get detailed information about a broker by specifying its name or ID:
yc iot broker get <broker_name>Result:
id: b91ki3851h********** folder_id: aoek49ghmk********** created_at: "2022-05-28T11:29:42.420Z" name: my-broker
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To get information about a broker using Terraform:
-
Add the
dataandoutputsections to the Terraform configuration file:data "yandex_iot_core_broker" "my_broker" { broker_id = "<broker_ID>" } output "broker_params" { value = data.yandex_iot_core_broker.my_broker.created_at }Where:
data "yandex_iot_core_broker": Description of the broker as a data source:broker_id: Broker ID.
output "broker_params": Output variable that contains information about the broker creation timestamp:value: Return value.
You can replace
created_atwith any other parameter to get the information you need. For more information about theyandex_iot_core_brokerdata source properties, see this Terraform provider article. -
Create the resources:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validateIf the configuration is correct, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.
-
Apply the changes:
terraform apply -
Type
yesand press Enter to confirm the changes.
Terraform will create the required resources and display their output variables. To check the results, run this command:
terraform outputResult:
broker_params = "2024-05-09T17:39:54Z" -
To get detailed information about a broker, use the get REST API method for the Broker resource or the BrokerService/Get gRPC API call.
Getting a list of broker certificates
- In the management console
, select the folder where the broker is located. - Go to IoT Core.
- In the left-hand panel, select Brokers.
- Select the broker. A list of certificates will be displayed in the Certificates section.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
Get a list of broker certificates:
yc iot broker certificate list --broker-name my-broker
Result:
+------------------------------------------+---------------------+
| FINGERPRINT | CREATED AT |
+------------------------------------------+---------------------+
| 0f511ea32139178edf73afb953a9cc********** | 2019-05-29 16:46:23 |
| 589ce1605019eeff7bb0992f290be0********** | 2019-05-29 16:40:48 |
+------------------------------------------+---------------------+
To get a list of broker certificates, use the listCertificates REST API method for the Broker resource or the BrokerService/ListCertificates gRPC API call.