gcloud beta filestore instances snapshots update

NAME
gcloud beta filestore instances snapshots update - update the description or labels of a Filestore snapshot
SYNOPSIS
gcloud beta filestore instances snapshots updateSNAPSHOT--instance=INSTANCE(--instance-location=INSTANCE_LOCATION    |--instance-region=INSTANCE_REGION)[--async][--description=DESCRIPTION][--update-labels=[KEY=VALUE,…]][--clear-labels    |--remove-labels=[KEY,…]][GCLOUD_WIDE_FLAG]
DESCRIPTION
(BETA) Update the metadata of a Filestore snapshot.

This command can fail for the following reasons:

  • The snapshot or instance specified does not exist.
  • The active account does not have permission to update the given snapshot.
EXAMPLES
To update the description of a snapshot namedmy-snapshot for the instancemy-instance fromus-central1, run:
gcloudbetafilestoreinstancessnapshotsupdatemy-snapshot--instance=my-instance--instance-region=us-central1--description="A new description."
POSITIONAL ARGUMENTS
SNAPSHOT
Name of the Filestore snapshot to be updated.
REQUIRED FLAGS
--instance=INSTANCE
Name of the Filestore instance the snapshot belongs to.
Exactly one of these must be specified:
--instance-location=INSTANCE_LOCATION
Location of the Filestore instance.
--instance-region=INSTANCE_REGION
Region of the Filestore instance.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--description=DESCRIPTION
Description of the snapshot.
--update-labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers.

At most one of these can be specified:
--clear-labels
Remove all labels. If--update-labels is also specified then--clear-labels is applied first.

For example, to remove all labels:

gcloudbetafilestoreinstancessnapshotsupdate--clear-labels

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

gcloudbetafilestoreinstancessnapshotsupdate--clear-labels--update-labelsfoo=bar,baz=qux
--remove-labels=[KEY,…]
List of label keys to remove. If a label does not exist it is silently ignored.If--update-labels is also specified then--update-labels is applied first.
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 thefile/v1beta1 API. The full documentation forthis API can be found at:https://cloud.google.com/filestore/
NOTES
This command is currently in beta and might change without notice. This variantis also available:
gcloudfilestoreinstancessnapshotsupdate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-03 UTC.