gcloud alpha compute tpus tpu-vm get-guest-attributes

NAME
gcloud alpha compute tpus tpu-vm get-guest-attributes - retrieve the Guest Attributes for a Cloud TPU VM
SYNOPSIS
gcloud alpha compute tpus tpu-vm get-guest-attributes (TPU : --zone=ZONE) [--query-path=QUERY_PATH] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,…]] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Retrieve the Guest Attributes for a Cloud TPU VM.
EXAMPLES
To retrieve the guest attributes, run: 
gcloud alpha compute tpus tpu-vm get-guest-attributes my-tpu --zone=us-central1-b

To select only a specific query path, use the --query-path flag: 

gcloud alpha compute tpus tpu-vm get-guest-attributes my-tpu --zone=us-central1-b --query-path=lifecycle/event

To only display the guest attributes for one of the workers in a TPU pod, use the --filter flag: 

gcloud alpha compute tpus tpu-vm get-guest-attributes my-tpu --zone=us-central1-b --filter="worker_id:3"

where 3 is an example of the worker ID (0-indexed).

POSITIONAL ARGUMENTS
Tpu resource - Name of the Cloud TPU VM. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument tpu on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

TPU
ID of the tpu or fully qualified identifier for the tpu.

To set the tpu attribute:

  • provide the argument tpu on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--zone=ZONE
Zone of the Cloud TPU.

If not specified, will use default compute/zone. To set the zone attribute:

  • provide the argument tpu on the command line with a fully specified name;
  • provide the argument --zone on the command line;
  • set the property compute/zone.
FLAGS
--query-path=QUERY_PATH
Attribute path to query. Can be empty string or of the form <namespace>/ or <namespace>/<key>. Default is the empty string.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed. If the expression evaluates True, then that item is listed. For more details and examples of filter expressions, run $ gcloud topic filters. This flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag specifies the maximum number of resources per page. The default is determined by the service if it supports paging, otherwise it is unlimited (no paging). Paging may be applied before or after --filter and --limit depending on the service.
--sort-by=[FIELD,…]
Comma-separated list of resource field key names to sort by. The default order is ascending. Prefix a field with ``~´´ for descending order on that field. This flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE
This command uses the tpu/v2alpha1 API. The full documentation for this API can be found at: https://cloud.google.com/tpu/
NOTES
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. This variant is also available: 
gcloud compute tpus tpu-vm get-guest-attributes