ID of the device or fully qualified identifier for the device
Options
Name
Description
--account <ACCOUNT>
Google Cloud Platform user account to use for invocation. Overrides the default *core/account* property value for this command invocation
--auth-method <AUTH_METHOD>
The authorization/authentication method used by devices in relation to the gateway. This property is set only on gateways. If left unspecified, devices will not be able to access the gateway. _AUTH_METHOD_ must be one of:
+
*association-and-device-auth-token*::: The device is authenticated through both device credentials and gateway association.
*association-only*::: The device is authenticated through the gateway association only. Device credentials are ignored if provided.
*device-auth-token-only*::: The device is authenticated through its own credentials. Gateway association is not checked.
:::
+
--billing-project <BILLING_PROJECT>
The Google Cloud Platform project that will be charged quota for operations performed in gcloud. If you need to operate on one project, but need quota against a different project, you can use this flag to specify the billing project. If both `billing/quota_project` and `--billing-project` are specified, `--billing-project` takes precedence. Run `$ gcloud config set --help` to see more information about `billing/quota_project`
--blocked
If blocked, connections from this device will fail.
+
Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance.
+
+
+
Connections to device is not blocked by default
--configuration <CONFIGURATION>
The configuration to use for this command invocation. For more
information on how to use configurations, run:
`gcloud topic configurations`. You can also use the CLOUDSDK_ACTIVE_CONFIG_NAME environment
variable to set the equivalent of this flag for a terminal
session
--device-type <DEVICE_TYPE>
Whether this device is a gateway. If unspecified, non-gateway is assumed. _DEVICE_TYPE_ must be one of: *gateway*, *non-gateway*
--flags-file <YAML_FILE>
A YAML or JSON file that specifies a *--flag*:*value* dictionary.
Useful for specifying complex flag values with special characters
that work with any command interpreter. Additionally, each
*--flags-file* arg is replaced by its constituent flags. See
$ gcloud topic flags-file for more information
--flatten <KEY>
Flatten _name_[] output resource slices in _KEY_ into separate records
for each item in each slice. Multiple keys and slices may be specified.
This also flattens keys for *--format* and *--filter*. For example,
*--flatten=abc.def* flattens *abc.def[].ghi* references to
*abc.def.ghi*. A resource record containing *abc.def[]* with N elements
will expand to N records in the flattened output. This flag interacts
with other flags that are applied in this order: *--flatten*,
*--sort-by*, *--filter*, *--limit*
--format <FORMAT>
Set the format for printing command output resources. The default is a
command-specific human-friendly output format. The supported formats
are: `config`, `csv`, `default`, `diff`, `disable`, `flattened`, `get`, `json`, `list`, `multi`, `none`, `object`, `table`, `text`, `value`, `yaml`. For more details run $ gcloud topic formats
For this gcloud invocation, all API requests will be made as the given service account instead of the currently selected account. This is done without needing to create, download, and activate a key for the account. In order to perform operations as the service account, your currently selected account must have an IAM role that includes the iam.serviceAccounts.getAccessToken permission for the service account. The roles/iam.serviceAccountTokenCreator role has this permission or you may create a custom role. Overrides the default *auth/impersonate_service_account* property value for this command invocation
--log-http
Log all HTTP server requests and responses to stderr. Overrides the default *core/log_http* property value for this command invocation
--log-level <LOG_LEVEL>
The default logging verbosity for activity from devices in this
registry. The verbosity level can be overridden by setting a specific
device's log level. _LOG_LEVEL_ must be one of:
+
*debug*::: All events will be logged.
*error*::: Error events will be logged.
*info*::: Informational events will be logged, such as connections and disconnections. Also includes error events.
*none*::: Disables logging.
:::
+
--metadata <KEY=VALUE>
The metadata key/value pairs assigned to devices. This metadata is not
interpreted or indexed by Cloud IoT Core. It can be used to add contextual
information for the device.
+
Keys should only contain the following characters ```[a-zA-Z0-9-_]``` and be
fewer than 128 bytes in length. Values are free-form strings. Each value must
be fewer than or equal to 32 KB in size.
+
The total size of all keys and values must be less than 256 KB, and the
maximum number of key-value pairs is 500
--metadata-from-file <KEY=PATH>
Same as --metadata, but the metadata values will be read from the file specified by path
--project <PROJECT_ID>
The Google Cloud Platform project ID to use for this invocation. If
omitted, then the current project is assumed; the current project can
be listed using `gcloud config list --format='text(core.project)'`
and can be set using `gcloud config set project PROJECTID`.
+
`--project` and its fallback `core/project` property play two roles
in the invocation. It specifies the project of the resource to
operate on. It also specifies the project for API enablement check,
quota, and billing. To specify a different project for quota and
billing, use `--billing-project` or `billing/quota_project` property
Disable all interactive prompts when running gcloud commands. If input
is required, defaults will be used, or an error will be raised.
Overrides the default core/disable_prompts property value for this
command invocation. This is equivalent to setting the environment
variable `CLOUDSDK_CORE_DISABLE_PROMPTS` to 1
--region <REGION>
The name of the Cloud IoT region
--registry <REGISTRY>
The name of the Cloud IoT registry
--trace-token <TRACE_TOKEN>
Token used to route traces of service requests for investigation of issues. Overrides the default *core/trace_token* property value for this command invocation
--user-output-enabled
Print user intended output to the console. Overrides the default *core/user_output_enabled* property value for this command invocation. Use *--no-user-output-enabled* to disable
--verbosity <VERBOSITY>
Override the default verbosity for this command. Overrides the default *core/verbosity* property value for this command invocation. _VERBOSITY_ must be one of: *debug*, *info*, *warning*, *error*, *critical*, *none*