roboto device-types

Manage device types: named kinds of device within your org, such as one robot model. Every device of a type inherits the type's configurations.

roboto device-types [-h] {create,delete,devices,list,show,update} ...

Arguments

Argument	Description
`-h, --help`	show this help message and exit

roboto device-types create

Creates a device type.

roboto device-types create [-h] [-d DESCRIPTION] [-m [KEY=VALUE ...]]
                           [-t [TAG ...]] [--org ORG]
                           name

Arguments

Argument	Description
`name` Required	The name of the device type, unique within the org.
`-h, --help`	show this help message and exit
`-d, --description <description>`	A free-text description of the device type.
`-m, --metadata <KEY=VALUE>`	Zero or more `<key>=<value>` pairs to add to the device type’s metadata. Each value is parsed as JSON when it can be, and is otherwise stored as a string.
`-t, --tag <tag>`	One or more tags to add to the device type.
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.

roboto device-types delete

Deletes a device type and its configurations. Refused while any device has that type.

roboto device-types delete [-h] [--org ORG] device_type_id

Arguments

Argument	Description
`device_type_id` Required	The ID (dt_…) of the target device type.
`-h, --help`	show this help message and exit
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.

roboto device-types devices

Lists the devices of a device type.

roboto device-types devices [-h] [--org ORG] device_type_id

Arguments

Argument	Description
`device_type_id` Required	The ID (dt_…) of the target device type.
`-h, --help`	show this help message and exit
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.

roboto device-types list

Lists the device types of an org.

roboto device-types list [-h] [--org ORG]

Arguments

Argument	Description
`-h, --help`	show this help message and exit
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.

roboto device-types show

Gets info about an individual device type.

roboto device-types show [-h] [--org ORG] device_type_id

Arguments

Argument	Description
`device_type_id` Required	The ID (dt_…) of the target device type.
`-h, --help`	show this help message and exit
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.

roboto device-types update

Updates a device type’s name, description, metadata or tags.

roboto device-types update [-h] [--name NAME]
                           [--description DESCRIPTION]
                           [--put-tags [PUT_TAGS ...]]
                           [--remove-tags [REMOVE_TAGS ...]]
                           [--put-metadata [KEY_PATH=VALUE ...]]
                           [--remove-metadata [KEY_PATH ...]]
                           [--org ORG]
                           device_type_id

Arguments

Argument	Description
`device_type_id` Required	The ID (dt_…) of the target device type.
`-h, --help`	show this help message and exit
`--name <name>`	A new name for the device type, unique within the org.
`--description <description>`	A new description for the device type. Specify `null` to clear the description.
`--put-tags <put_tags>`	Add each listed tag the device type does not already have.
`--remove-tags <remove_tags>`	Remove each listed tag the device type has.
`--put-metadata <KEY_PATH=VALUE>`	Zero or more `<key>=<value>` pairs to add to the device type’s metadata, overwriting existing keys. Each value is parsed as JSON when it can be, and is otherwise stored as a string. Dot notation is supported for nested keys.
`--remove-metadata <key_path>`	Remove each key from the device type’s metadata if it exists. Dot notation is supported for nested keys.
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.