gcloud redis instances failover

NAME
gcloud redis instances failover - failover a standard tier Cloud Memorystore for Redis instance from the master node to its replica
SYNOPSIS
gcloud redis instances failover(INSTANCE :--region=REGION)[--async][--data-protection-mode=DATA_PROTECTION_MODE][GCLOUD_WIDE_FLAG]
DESCRIPTION
Failover a standard tier Cloud Memorystore for Redis instance from the masternode to its replica.
EXAMPLES
To failover an instance with the name 'my-redis-instance' in region'us-central-1', run:
gcloudredisinstancesfailovermy-redis-instance--region=us-central1

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

gcloudredisinstancesfailovermy-redis-instance--region=us-central1--data-protection-mode=force-data-loss
POSITIONAL ARGUMENTS
Instance resource - Arguments and flags that specify the standard tier CloudMemorystore for Redis instance you want to failover. The arguments in this groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare not given arguments in this group but can 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.

--region=REGION
The name of the Redis region of the instance. Overrides the default redis/regionproperty value for this command invocation.To set theregion attribute:
  • provide the argumentinstance on the command line with a fullyspecified name;
  • provide the argument--region on the command line;
  • set the propertyredis/region.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--data-protection-mode=DATA_PROTECTION_MODE
Data protection mode to use for the failover. If not specified, defaults to'limited-data-loss'.DATA_PROTECTION_MODE must be oneof:
force-data-loss
Failover without data loss protection. Can cause significant data loss.
limited-data-loss
Failover with data loss protection that ensures loss is within systemthresholds.
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 theredis/v1 API. The full documentation for thisAPI can be found at:https://cloud.google.com/memorystore/docs/redis/
NOTES
These variants are also available:
gcloudalpharedisinstancesfailover
gcloudbetaredisinstancesfailover

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-05-07 UTC.