File: //snap/google-cloud-cli/396/help/man/man1/gcloud_filestore_instances_promote-replica.1
.TH "GCLOUD_FILESTORE_INSTANCES_PROMOTE\-REPLICA" 1
.SH "NAME"
.HP
gcloud filestore instances promote\-replica \- promote a Filestore standby replication instance
.SH "SYNOPSIS"
.HP
\f5gcloud filestore instances promote\-replica\fR (\fIINSTANCE\fR\ :\ \fB\-\-zone\fR=\fIZONE\fR) [\fB\-\-async\fR] [\fB\-\-location\fR=\fILOCATION\fR] [\fB\-\-peer\-instance\fR=\fIPEER_INSTANCE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Promote a Filestore standby replication instance to a regular instance. This
command can be called directly on the standby instance or on the active instance
with the standby peer instance parameter. When used on the standby instance
promotes the standby instance to a regular instance even if the active instance
is unavailable. When used on the active instance detaches the standby instance
from the active instance even if the standby instance is unavailable.
This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
The target instance does not exist.
.IP "\(bu" 2m
The instance is not a standby replication member.
.IP "\(bu" 2m
The instance is an active instance and the peer instance parameter is missing or
invalid.
.RE
.sp
.SH "EXAMPLES"
To promote a standby instance with the name \f5\fImy\-replica\-instance\fR\fR
located in \f5\fIus\-central1\fR\fR, run:
.RS 2m
$ gcloud filestore instances promote\-replica my\-replica\-instance \e
\-\-zone=us\-central1
.RE
To promote a standby instance with the name \f5\fImy\-replica\-instance\fR\fR
located in \f5\fIus\-central1\fR\fR, attached to the active peer instance
\f5\fImy\-active\-instance\fR\fR located in \f5\fIus\-west1\fR\fR, run:
.RS 2m
$ gcloud filestore instances promote\-replica my\-active\-instance \e
\-\-zone=us\-west1 \e
\-\-peer\-instance=projects/my\-project/locations/us\-central1/\e
instances/my\-replica\-instance
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Instance resource \- Arguments and flags that specify the Filestore instance to
promote. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp
This must be specified.
.RS 2m
.TP 2m
\fIINSTANCE\fR
ID of the instance or fully qualified identifier for the instance.
To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line.
.RE
.sp
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-zone\fR=\fIZONE\fR
The zone of the Filestore instance.
To set the \f5zone\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-zone\fR on the command line;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5filestore/zone\fR.
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
Location of the Filestore instance to promote.
.TP 2m
\fB\-\-peer\-instance\fR=\fIPEER_INSTANCE\fR
The name of the standby peer instance to promote.
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "API REFERENCE"
This command uses the \fBfile/v1\fR API. The full documentation for this API can
be found at: https://cloud.google.com/filestore/
.SH "NOTES"
This variant is also available:
.RS 2m
$ gcloud beta filestore instances promote\-replica
.RE