HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/394/help/man/man1/gcloud_beta_redis_instances_failover.1
.TH "GCLOUD_BETA_REDIS_INSTANCES_FAILOVER" 1



.SH "NAME"
.HP
gcloud beta redis instances failover \- failover a standard tier Cloud Memorystore for Redis instance from the master node to its replica



.SH "SYNOPSIS"
.HP
\f5gcloud beta redis instances failover\fR (\fIINSTANCE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-async\fR] [\fB\-\-data\-protection\-mode\fR=\fIDATA_PROTECTION_MODE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Failover a standard tier Cloud Memorystore for Redis instance from
the master node to its replica.



.SH "EXAMPLES"

To failover an instance with the name 'my\-redis\-instance' in region
\'us\-central\-1', run:

.RS 2m
$ gcloud beta redis instances failover my\-redis\-instance \e
    \-\-region=us\-central1
.RE

To failover an instance with the name 'my\-redis\-instance' in region
\'us\-central\-1' without attempting to limit data loss, run:

.RS 2m
$ gcloud beta redis instances failover my\-redis\-instance \e
    \-\-region=us\-central1 \-\-data\-protection\-mode=force\-data\-loss
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Instance resource \- Arguments and flags that specify the standard tier Cloud
Memorystore for Redis instance you want to failover. 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\-\-region\fR=\fIREGION\fR

The name of the Redis region of the instance. Overrides the default redis/region
property value for this command invocation.


To set the \f5region\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\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5redis/region\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\-\-data\-protection\-mode\fR=\fIDATA_PROTECTION_MODE\fR

Data protection mode to use for the failover. If not specified, defaults to
\'limited\-data\-loss'. \fIDATA_PROTECTION_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBforce\-data\-loss\fR
Failover without data loss protection. Can cause significant data loss.
.TP 2m
\fBlimited\-data\-loss\fR
Failover with data loss protection that ensures loss is within system
thresholds.
.RE
.sp



.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 \fBredis/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/memorystore/docs/redis/



.SH "NOTES"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud redis instances failover
.RE

.RS 2m
$ gcloud alpha redis instances failover
.RE