gcloud alpha compute target-pools set-backup

NAME
gcloud alpha compute target-pools set-backup - set a backup pool for a target pool
SYNOPSIS
gcloud alpha compute target-pools set-backupNAME(--backup-pool=BACKUP_POOL    |--no-backup-pool)[--failover-ratio=FAILOVER_RATIO][--region=REGION][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA)gcloud alpha compute target-pools set-backupis used to set a backup target pool for a primary target pool, which defines thefallback behavior of the primary pool. If the ratio of the healthy instances inthe primary pool is at or below the specified--failover-ratiovalue, then traffic arriving at the load-balanced IP addresswill be directed to the backup pool.
EXAMPLES
To causeTARGET-POOL (in regionus-central1) to failover toBACKUP-POOL when more than half of theTARGET-POOL instances are unhealthy, run:
gcloudalphacomputetarget-poolsset-backupTARGET-POOL--backup-pool=BACKUP-POOL--failover-ratio=0.5--region=us-central1

To removeBACKUP-POOL as a backup toTARGET-POOL, run:

gcloudalphacomputetarget-poolsset-backupTARGET-POOL--backup-pool=''--region=us-central1
POSITIONAL ARGUMENTS
NAME
The name of the target pool for which to set the backup pool.
REQUIRED FLAGS
Exactly one of these must be specified:
--backup-pool=BACKUP_POOL
Name of the target pool that will serve as backup.
--no-backup-pool
Unsets the backup pool. This disables failover.
OPTIONAL FLAGS
--failover-ratio=FAILOVER_RATIO
The new failover ratio value for the target pool. This must be a float in therange of [0, 1].
--region=REGION
Region of the target pool to set a backup pool for. If not specified, you mightbe prompted to select a region (interactive mode only).

To avoid prompting when this flag is omitted, you can set thecompute/region property:

gcloudconfigsetcompute/regionREGION

A list of regions can be fetched by running:

gcloudcomputeregionslist

To unset the property, run:

gcloudconfigunsetcompute/region

Alternatively, the region can be stored in the environment variableCLOUDSDK_COMPUTE_REGION.

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.

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:
gcloudcomputetarget-poolsset-backup
gcloudbetacomputetarget-poolsset-backup

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.