gcloud alpha filestore instances restore

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 existingsnapshot or backup.
EXAMPLES
The following command restores an instance named 'my-instance' with a filesharenamed 'vol1' in the zone europe-west3-a from a backup named 'my-backup' in theregion europe-west3.
gcloudalphafilestoreinstancesrestoremy-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 torestore. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.

To set theproject attribute:

  • provide the argumentinstance on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

INSTANCE
ID of the instance or fully qualified identifier for the instance.

To set theinstance attribute:

  • provide the argumentinstance on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--zone=ZONE
The zone of the Filestore instance.To set thezone attribute:
  • provide the argumentinstance on the command line with a fullyspecified name;
  • provide the argument--zone on the command line;
  • set the propertyfilestore/zone.
REQUIRED FLAGS
--file-share=FILE_SHARE
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 groupare 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 groupare 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 groupare specified.

--source-snapshot-region=SOURCE_SNAPSHOT_REGION
Region of the Filestore snapshot to restore from. If unspecified, it is assumedthat the Filestore snapshot is local.
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 help for details.

API REFERENCE
This command uses thefile/v1p1alpha1 API. The full documentationfor this API can be found at:https://cloud.google.com/filestore/
NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudfilestoreinstancesrestore
gcloudbetafilestoreinstancesrestore

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 2026-01-21 UTC.