gcloud filestore backups update

NAME
gcloud filestore backups update - update a Filestore backup
SYNOPSIS
gcloud filestore backups updateBACKUP--region=REGION[--async][--description=DESCRIPTION][--update-labels=[KEY=VALUE,…]][--clear-labels    |--remove-labels=[KEY,…]][GCLOUD_WIDE_FLAG]
DESCRIPTION
Update the metadata of a Filestore backup.

This command can fail for the following reasons:

  • The backup specified does not exist.
  • The active account does not have permission to update the given backup.
EXAMPLES
The following command updates the Filestore Backup named 'my-backup' in regionus-central1 to change the description to 'A new description.'
gcloudfilestorebackupsupdatemy-backup--region=us-central1--description="A new description."
POSITIONAL ARGUMENTS
BACKUP
Arguments and flags that specify the Filestore backup you want to update.
REQUIRED FLAGS
--region=REGION
Compute region (e.g. us-central1) for the backup.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--description=DESCRIPTION
Description of the backup.
--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:

gcloudfilestorebackupsupdate--clear-labels

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

gcloudfilestorebackupsupdate--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/v1 API. The full documentation for thisAPI can be found at:https://cloud.google.com/filestore/
NOTES
These variants are also available:
gcloudalphafilestorebackupsupdate
gcloudbetafilestorebackupsupdate

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.