- NAME
-
- gcloud filestore instances snapshots update - update the description or labels of a Filestore snapshot
- SYNOPSIS
-
-
gcloud 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
- 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 named
for the instancemy-snapshotfrommy-instance, run:us-central1gcloud filestore instances snapshots update my-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 is
modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. 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-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloud filestore instances snapshots update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud filestore instances snapshots update --clear-labels --update-labels foo = bar,baz = qux -
--remove-labels=[KEY,…] - List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labelsis also specified then--update-labelsis 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 helpfor details. - API REFERENCE
- This command uses the
file/v1API. The full documentation for this API can be found at: https://cloud.google.com/filestore/ - NOTES
- This variant is also available:
gcloud beta filestore instances snapshots update
gcloud filestore instances snapshots update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.

