File: //snap/google-cloud-cli/current/lib/surface/compute/tpus/tpu_vm/get_guest_attributes.yaml
- release_tracks: [GA, ALPHA]
command_type: LIST
help_text:
brief: Retrieve the Guest Attributes for a Cloud TPU VM.
description: Retrieve the Guest Attributes for a Cloud TPU VM.
examples: |
To retrieve the guest attributes, run:
$ {command} my-tpu --zone=us-central1-b
To select only a specific query path, use the --query-path flag:
$ {command} 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:
$ {command} my-tpu --zone=us-central1-b --filter="worker_id:3"
where 3 is an example of the worker ID (0-indexed).
request:
collection: tpu.projects.locations.nodes
ALPHA:
api_version: v2alpha1
GA:
api_version: v2
method: getGuestAttributes
response:
modify_response_hooks:
- googlecloudsdk.command_lib.compute.tpus.tpu_vm.util:TransformGuestAttributes
arguments:
resource:
help_text: Name of the Cloud TPU VM.
spec: !REF googlecloudsdk.command_lib.compute.tpus.tpu_vm.resources:tpu
params:
- arg_name: query-path
api_field: getGuestAttributesRequest.queryPath
required: false
help_text: |
Attribute path to query. Can be empty string or of the form `<namespace>/` or
`<namespace>/<key>`. Default is the empty string.
output:
format: |
table(
namespace,
key,
worker_id,
value
)