- NAME
-
- gcloud alpha filestore instances restore - restore a Filestore instance from a snapshot or backup
- SYNOPSIS
-
-
gcloud alpha filestore instances restore(INSTANCE:--zone=ZONE)--file-share=FILE_SHARE(--source-backup=SOURCE_BACKUP--source-backup-region=SOURCE_BACKUP_REGION| [--source-snapshot=SOURCE_SNAPSHOT:--source-snapshot-region=SOURCE_SNAPSHOT_REGION]) [--async] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Restore an existing Filestore instance from an existing snapshot or backup. - EXAMPLES
-
The following command restores an instance named 'my-instance' with a fileshare
named 'vol1' in the zone europe-west3-a from a backup named 'my-backup' in the
region europe-west3.
gcloud alpha filestore instances restore my-instance --zone=europe-west3-a --file-share=vol1 --source-backup=my-backup --source-backup-region=europe-west3 - POSITIONAL ARGUMENTS
-
-
Instance resource - Arguments and flags that specify the Filestore instance to
restore. The arguments in this group can be used to specify the attributes of
this resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the
projectattribute:-
provide the argument
instanceon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
INSTANCE-
ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:-
provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--zone=ZONE-
The zone of the Filestore instance.
To set the
zoneattribute:-
provide the argument
instanceon the command line with a fully specified name; -
provide the argument
--zoneon the command line; -
set the property
filestore/zone.
-
provide the argument
-
provide the argument
-
Instance resource - Arguments and flags that specify the Filestore instance to
restore. The arguments in this group can be used to specify the attributes of
this resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
- REQUIRED FLAGS
-
- File share to restore from the snapshot or backup.
-
Exactly one of these must be specified:
-
The name and region of the Filestore backup to restore from.
--source-backup=SOURCE_BACKUP-
Name of the Filestore backup to restore from.
This flag argument must be specified if any of the other arguments in this group are specified.
--source-backup-region=SOURCE_BACKUP_REGION-
Region of the Filestore backup to restore from.
This flag argument must be specified if any of the other arguments in this group are specified.
-
The name and region of the Filestore snapshot to restore from.
--source-snapshot=SOURCE_SNAPSHOT-
Name of the Filestore snapshot to restore from.
This flag argument must be specified if any of the other arguments in this group are specified.
--source-snapshot-region=SOURCE_SNAPSHOT_REGION- Region of the Filestore snapshot to restore from. If unspecified, it is assumed that the Filestore snapshot is local.
-
The name and region of the Filestore backup to restore from.
- OPTIONAL FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
- 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/v1p1alpha1API. The full documentation for this API can be found at: https://cloud.google.com/filestore/ - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. These variants are also available:
gcloud filestore instances restoregcloud beta filestore instances restore
gcloud alpha filestore instances restore
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 2025-06-03 UTC.