gcloud filestore instances pause-replica

NAME
gcloud filestore instances pause-replica - pause a Filestore replica instance
SYNOPSIS
gcloud filestore instances pause-replica(INSTANCE :--zone=ZONE)[--async][--location=LOCATION][GCLOUD_WIDE_FLAG]
DESCRIPTION
Pause a Filestore replica instance. This command can be called only on a standbyinstance. After calling the command, the NFS file system of the standby instancebecomes writeable. Any data changed on the standby instance while it is pausedwill be lost when the replica is resumed or promoted.
EXAMPLES
To pause a replica instance with the namemy-replica-instance located inus-central1-c, run:
gcloudfilestoreinstancespause-replicamy-replica-instance--zone=us-central1
POSITIONAL ARGUMENTS
Instance resource - Arguments and flags that specify the Filestore instance topause. The arguments in this group can be used to specify the attributes of thisresource. (NOTE) Some attributes are not given arguments in this group but canbe 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;
  • provide the argument--location on the command line;
  • set the propertyfilestore/zone.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--location=LOCATION
Location of the Filestore instance to pause.
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
This variant is also available:
gcloudbetafilestoreinstancespause-replica

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-12-16 UTC.