- NAME
-
- gcloud filestore backups create - create a Filestore backup
- SYNOPSIS
-
-
gcloud filestore backups create
BACKUP
--file-share
=FILE_SHARE
--instance
=INSTANCE
--region
=REGION
(--instance-location
=INSTANCE_LOCATION
|--instance-zone
=INSTANCE_ZONE
) [--async
] [--description
=DESCRIPTION
] [--kms-key
=KMS_KEY
] [--labels
=[KEY
=VALUE
,…]] [--tags
=[KEY
=VALUE
,…]] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
Create a Filestore backup of an instance file share.
This command can fail for the following reasons:
- A backup with the same name already exists.
- The active account does not have permission to create backups.
- EXAMPLES
-
To create a backup with the name 'my-backup' and description 'My backup
description' in a particular region like 'us-central1' from an instance called
'my-instance' in 'us-central1-c' and the source file share called 'my-fs', run:
gcloud filestore backups create my-backup --instance=my-instance --file-share=my-fs --instance-zone=us-central1-c --region=us-central1 --description="My backup description"
- POSITIONAL ARGUMENTS
-
BACKUP
- Arguments and flags that specify the Filestore backup you want to create.
- REQUIRED FLAGS
-
- File share name on the Filestore instance to backup.
--instance
=INSTANCE
- Share name of the Filestore instance you want to backup.
--region
=REGION
- Region (e.g. us-central1) for the backup.
-
Exactly one of these must be specified:
--instance-location
=INSTANCE_LOCATION
- Region of the Filestore instance.
--instance-zone
=INSTANCE_ZONE
- Zone of the Filestore instance.
- OPTIONAL FLAGS
-
--async
- Return immediately, without waiting for the operation in progress to complete.
--description
=DESCRIPTION
- Description for the backup. Limit: 2048 characters.
--kms-key
=KMS_KEY
-
CMEK for backup in the form of
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}
--labels
=[KEY
=VALUE
,…]- List of label KEY=VALUE pairs to add.
- List of tag KEY=VALUE pairs to add.
- 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 the
file/v1
API. The full documentation for this API can be found at: https://cloud.google.com/filestore/ - NOTES
-
These variants are also available:
gcloud alpha filestore backups create
gcloud beta filestore backups create
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 2024-12-10 UTC.