.TH "GCLOUD_COMPUTE_TPUS_TPU\-VM_UPDATE" 1



.SH "NAME"
.HP
gcloud compute tpus tpu\-vm update \- update a Cloud TPU VM node



.SH "SYNOPSIS"
.HP
\f5gcloud compute tpus tpu\-vm update\fR (\fITPU\fR\ :\ \fB\-\-zone\fR=\fIZONE\fR) [\fB\-\-add\-tags\fR=[\fITAGS\fR,...]] [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-internal\-ips\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-attach\-disk\fR=[\fISOURCE\fR=\fIDATA_DISK\fR,...]\ |\ \fB\-\-detach\-disk\fR=\fIDATA_DISK\fR] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-clear\-tags\fR\ |\ \fB\-\-remove\-tags\fR=[\fITAG\fR,...]] [\fB\-\-metadata\-from\-file\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ |\ \fB\-\-update\-metadata\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-metadata\fR\ |\ \fB\-\-remove\-metadata\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Cloud TPU VM node.



.SH "EXAMPLES"

To modify a TPU VM node with ID \f5my\-tpu\fR in the default user project and
compute/zone by updating the description to "A new description", run:

.RS 2m
$ gcloud compute tpus tpu\-vm update my\-tpu \e
    \-\-description="A new description"
.RE

To modify a TPU VM node with ID \f5my\-tpu\fR in the default user project,
network and compute/zone (with other defaults supplied by API) by adding labels
\f5k0\fR, with value \f5value0\fR and label \f5k1\fR with value \f5value1\fR and
removing labels with key \f5k2\fR, run:

.RS 2m
$ gcloud compute tpus tpu\-vm update my\-tpu \e
    \-\-update\-labels=k0=value0,k1=value1 \-\-remove\-labels=k2
.RE

Labels can be used to identify the TPU VM node. To list TPU VM nodes with the
\f5k1:value1\fR label, run:

.RS 2m
$ gcloud compute tpus tpu\-vm list \-\-filter='labels.k1=value1'
.RE

To list only the labels when describing a resource, use \f5\-\-format\fR to
filter the result:

.RS 2m
$ gcloud compute tpus tpu\-vm describe my\-tpu \e
    \-\-format="default(labels)"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Tpu resource \- Name of the Cloud TPU VM node to update. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5tpu\fR on the command line with a fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fITPU\fR

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

To set the \f5tpu\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tpu\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-zone\fR=\fIZONE\fR

Zone of the Cloud TPU.

If not specified, will use \f5default\fR compute/zone.


To set the \f5zone\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tpu\fR on the command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-zone\fR on the command line;
.IP "\(bu" 2m
set the property \f5compute/zone\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-add\-tags\fR=[\fITAGS\fR,...]

Tags to add to the TPU Node. Tags are used to identify valid sources or targets
for network firewalls. See
https://cloud.google.com/vpc/docs/add\-remove\-network\-tags for more details.

.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Text description of the TPU.

.TP 2m
\fB\-\-internal\-ips\fR

Indicate that the IP addresses for the node should be internal. The default is
that external IP addresses will be associated with the TPU workers.

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

Resource labels to update that represent user\-provided metadata. If a label
exists, its value is modified. Otherwise, a new label is created. See
https://cloud.google.com/compute/docs/labeling\-resources for details.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-attach\-disk\fR=[\fISOURCE\fR=\fIDATA_DISK\fR,...]

Attach a data disk to the TPU VM. For example,

.RS 2m
$ gcloud compute tpus tpu\-vm update example\-tpu \e
    \-\-attach\-disk \e
    source=projects/my\-project/zones/us\-central1\-c/disks/my\-disk,\e
mode=read\-only \-\-zone=us\-central1\-c
.RE

attaches the disk named
\'projects/my\-project/zones/us\-central1\-c/disks/my\-disk' to a TPU VM named
\'example\-tpu' in read\-only mode in zone \f5us\-central1\-c\fR.

The following keys are allowed:

.RS 2m
.TP 2m
\fBsource\fR
Specify the full path to an existing disk. Required. The disk must be in the
same zone.

.TP 2m
\fBmode\fR
Specify the mode in which to attach this disk. Valid options are 'read\-write',
\'read\-only'. If not specified, the default is 'read\-write'.

.RE
.sp
.TP 2m
\fB\-\-detach\-disk\fR=\fIDATA_DISK\fR

Detach a data disk from the TPU VM. For example,

This flag must be repeated to provide multiple data disks. For example:

.RS 2m
$ gcloud compute tpus tpu\-vm update example\-tpu \e
    \-\-detach\-disk=projects/my\-project/zones/us\-central1\-c/disks/\e
my\-disk \-\-zone=us\-central1\-c
.RE

detaches the disk named
\'projects/my\-project/zones/us\-central1\-c/disks/my\-disk' from a TPU VM named
\'example\-tpu' in zone \f5us\-central1\-c\fR.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud compute tpus tpu\-vm update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, 'foo' and 'baz':

.RS 2m
$ gcloud compute tpus tpu\-vm update \-\-clear\-labels \e
    \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-tags\fR

Remove all tags. If \f5\-\-add\-tags\fR is also specified then
\f5\-\-clear\-tags\fR is applied first.

For example, to remove all tags:

.RS 2m
$ gcloud compute tpus tpu\-vm update \-\-clear\-tags
.RE

To remove all existing tags and create two new tags, 'foo' and 'bar':

.RS 2m
$ gcloud compute tpus tpu\-vm update \-\-clear\-tags \-\-add\-tags foo,bar
.RE

.TP 2m
\fB\-\-remove\-tags\fR=[\fITAG\fR,...]

List of tags to remove. If a tag does not exist it is silently ignored. If
\f5\-\-add\-tags\fR is also specified then \f5\-\-add\-tags\fR is applied first.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-metadata\-from\-file\fR=[\fIKEY\fR=\fIVALUE\fR,...]

Same as \f5\-\-metadata\fR except the value for the entry will be read from a
local file. Example: \f5\-\-metadata\-from\-file='key1=value1.txt'\fR

.TP 2m
\fB\-\-update\-metadata\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of comma\-separated metadata key\-value pairs for the Cloud TPU VM node. If
a key exists, its value is modified. Otherwise, a new key\-value pair is
created.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-metadata\fR

Remove all metadata. If \f5\-\-update\-metadata\fR is also specified then
\f5\-\-clear\-metadata\fR is applied first.

For example, to remove all metadata:

.RS 2m
$ gcloud compute tpus tpu\-vm update \-\-clear\-metadata
.RE

To remove all existing metadata and create two new metadata key\-value pairs,
\'foo=bar' and 'baz=qux':

.RS 2m
$ gcloud compute tpus tpu\-vm update \-\-clear\-metadata \e
    \-\-update\-metadata foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-metadata\fR=[\fIKEY\fR,...]

List of comma\-separated metadata keys to remove. If a key does not exist it is
silently ignored. If \f5\-\-update\-metadata\fR is also specified then
\f5\-\-update\-metadata\fR is applied first.


.RE
.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBtpu/v2\fR API. The full documentation for this API can
be found at: https://cloud.google.com/tpu/



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha compute tpus tpu\-vm update
.RE