.TH "GCLOUD_FILESTORE_INSTANCES_SNAPSHOTS_UPDATE" 1



.SH "NAME"
.HP
gcloud filestore instances snapshots update \- update the description or labels of a Filestore snapshot



.SH "SYNOPSIS"
.HP
\f5gcloud filestore instances snapshots update\fR \fISNAPSHOT\fR \fB\-\-instance\fR=\fIINSTANCE\fR (\fB\-\-instance\-location\fR=\fIINSTANCE_LOCATION\fR\ |\ \fB\-\-instance\-region\fR=\fIINSTANCE_REGION\fR) [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update the metadata of a Filestore snapshot.

This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
The snapshot or instance specified does not exist.
.IP "\(bu" 2m
The active account does not have permission to update the given snapshot.
.RE
.sp



.SH "EXAMPLES"

To update the description of a snapshot named \f5\fImy\-snapshot\fR\fR for the
instance \f5\fImy\-instance\fR\fR from \f5\fIus\-central1\fR\fR, run:

.RS 2m
$ gcloud filestore instances snapshots update my\-snapshot \e
    \-\-instance=my\-instance \-\-instance\-region=us\-central1 \e
    \-\-description="A new description."
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fISNAPSHOT\fR

Name of the Filestore snapshot to be updated.


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-instance\fR=\fIINSTANCE\fR

Name of the Filestore instance the snapshot belongs to.

.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-instance\-location\fR=\fIINSTANCE_LOCATION\fR

Location of the Filestore instance.

.TP 2m
\fB\-\-instance\-region\fR=\fIINSTANCE_REGION\fR

Region of the Filestore instance.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

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

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

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

Description of the snapshot.

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

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.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 filestore instances snapshots update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud filestore instances snapshots 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
.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 \fBfile/v1\fR API. The full documentation for this API can
be found at: https://cloud.google.com/filestore/



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud beta filestore instances snapshots update
.RE