- NAME
-
- gcloud alpha compute forwarding-rules update - update a Compute Engine forwarding rule
- SYNOPSIS
-
-
gcloud alpha compute forwarding-rules updateNAME[--allow-global-access] [--allow-psc-global-access] [--external-managed-backend-bucket-migration-testing-percentage=EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_TESTING_PERCENTAGE] [--load-balancing-scheme=LOAD_BALANCING_SCHEME] [--network-tier=NETWORK_TIER] [--source-ip-ranges=SOURCE_IP_RANGE,[…]] [--update-labels=[KEY=VALUE,…]] [--clear-external-managed-backend-bucket-migration-state|--external-managed-backend-bucket-migration-state=EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE] [--clear-labels|--remove-labels=[KEY,…]] [--global|--region=REGION] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)gcloud alpha compute forwarding-rules updateupdates labels, global access and network tier for a Compute Engine forwarding rule. - EXAMPLES
-
To update the forwarding rule to allow global access, run:
gcloud alpha compute forwarding-rules update example-fr --allow-global-access --region=us-central1To add/update labels
andk0and remove labels with keyk1, run:k3gcloud alpha compute forwarding-rules update example-fr --region=us-central1 --update-labels=k0=value1,k1=value2 --remove-labels=k3Labels can be used to identify the forwarding rule and to filter them as in
gcloud alpha compute forwarding-rules list --filter='labels.k1:value2'To list existing labels, run:
gcloud alpha compute forwarding-rules describe example-fr --format="default(labels)" - POSITIONAL ARGUMENTS
-
NAME- Name of the forwarding rule to operate on.
- FLAGS
-
--allow-global-access- If True, then clients from all regions can access this internal forwarding rule. This can only be specified for forwarding rules with the LOAD_BALANCING_SCHEME set to INTERNAL or INTERNAL_MANAGED. For forwarding rules of type INTERNAL, the target must be either a backend service or a target instance.
--allow-psc-global-access- If specified, clients from all regions can access this Private Service Connect forwarding rule. This can only be specified if the forwarding rule's target is a service attachment (--target-service-attachment).
--external-managed-backend-bucket-migration-testing-percentage=EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_TESTING_PERCENTAGE-
Determines the fraction of requests that should be processed by the Global
external Application Load Balancer.
The value of this field must be in the range [0, 100].
--load-balancing-scheme=LOAD_BALANCING_SCHEME-
Only for the Global external Application Load Balancer migration.
The value of this field must be EXTERNAL or EXTERNAL_MANAGED.
LOAD_BALANCING_SCHEMEmust be one of:EXTERNAL,EXTERNAL_MANAGED. --network-tier=NETWORK_TIER-
Update the network tier of a forwarding rule. It does not allow to change from
PREMIUMtoSTANDARDand visa versa. --source-ip-ranges=SOURCE_IP_RANGE,[…]- List of comma-separated IP addresses or IP ranges. If set, this forwarding rule only forwards traffic when the packet's source IP address matches one of the IP ranges set here.
--update-labels=[KEY=VALUE,…]-
List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers. -
At most one of these can be specified:
--clear-external-managed-backend-bucket-migration-state- Clears current state of external managed migration.
--external-managed-backend-bucket-migration-state=EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE-
Specifies the migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE,
and TEST_ALL_TRAFFIC.
To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using the --external-managed-backend-bucket-migration-testing-percentage flag.
EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATEmust be one of:PREPARE,TEST_BY_PERCENTAGE,TEST_ALL_TRAFFIC.
-
At most one of these can be specified:
--clear-labels-
Remove all labels. If
--update-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloud alpha compute forwarding-rules update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud alpha compute forwarding-rules update --clear-labels --update-labels foo=bar,baz=qux --remove-labels=[KEY,…]-
List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labelsis also specified then--update-labelsis applied first.
-
At most one of these can be specified:
--global- If set, the forwarding rule is global.
--region=REGION-
Region of the forwarding rule to operate on. If not specified, you might be
prompted to select a region (interactive mode only).
To avoid prompting when this flag is omitted, you can set the
property:compute/regiongcloud config set compute/region REGIONA list of regions can be fetched by running:
gcloud compute regions listTo unset the property, run:
gcloud config unset compute/regionAlternatively, the region can be stored in the environment variable
.CLOUDSDK_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 helpfor details. - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. These variants are also available:
gcloud compute forwarding-rules updategcloud beta compute forwarding-rules update
gcloud alpha compute forwarding-rules update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-09 UTC.