1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00

gcloud: Wed Apr 8 12:08:12 UTC 2026

This commit is contained in:
Automated 2026-04-08 12:08:12 +00:00
parent 89a3bc9276
commit 5b03e16435
766 changed files with 29847 additions and 8950 deletions

View file

@ -4,7 +4,7 @@ NAME
SYNOPSIS
gcloud beta compute backend-services add-backend BACKEND_SERVICE_NAME
([--instance-group=INSTANCE_GROUP
(--service=SERVICE | [--instance-group=INSTANCE_GROUP
: --instance-group-region=INSTANCE_GROUP_REGION
| --instance-group-zone=INSTANCE_GROUP_ZONE]
| [--network-endpoint-group=NETWORK_ENDPOINT_GROUP
@ -49,6 +49,11 @@ POSITIONAL ARGUMENTS
REQUIRED FLAGS
Exactly one of these must be specified:
Service Group
--service=SERVICE
The name or URI of a Google Cloud service to use as a backend.
Instance Group
--instance-group=INSTANCE_GROUP

View file

@ -4,7 +4,7 @@ NAME
SYNOPSIS
gcloud beta compute backend-services remove-backend BACKEND_SERVICE_NAME
([--instance-group=INSTANCE_GROUP
(--service=SERVICE | [--instance-group=INSTANCE_GROUP
: --instance-group-region=INSTANCE_GROUP_REGION
| --instance-group-zone=INSTANCE_GROUP_ZONE]
| [--network-endpoint-group=NETWORK_ENDPOINT_GROUP
@ -28,6 +28,11 @@ POSITIONAL ARGUMENTS
REQUIRED FLAGS
Exactly one of these must be specified:
Service Group
--service=SERVICE
The name or URI of a Google Cloud service to use as a backend.
Instance Group
--instance-group=INSTANCE_GROUP

View file

@ -4,7 +4,7 @@ NAME
SYNOPSIS
gcloud beta compute backend-services update-backend BACKEND_SERVICE_NAME
([--instance-group=INSTANCE_GROUP
(--service=SERVICE | [--instance-group=INSTANCE_GROUP
: --instance-group-region=INSTANCE_GROUP_REGION
| --instance-group-zone=INSTANCE_GROUP_ZONE]
| [--network-endpoint-group=NETWORK_ENDPOINT_GROUP
@ -50,6 +50,11 @@ POSITIONAL ARGUMENTS
REQUIRED FLAGS
Exactly one of these must be specified:
Service Group
--service=SERVICE
The name or URI of a Google Cloud service to use as a backend.
Instance Group
--instance-group=INSTANCE_GROUP

View file

@ -114,8 +114,8 @@ OPTIONAL FLAGS
general-purpose-c4d, general-purpose-e2, general-purpose-n2,
general-purpose-n2d, general-purpose-n4, general-purpose-n4a,
general-purpose-n4d, general-purpose-t2d, graphics-optimized,
graphics-optimized-g4, memory-optimized, memory-optimized-m3,
memory-optimized-m4, memory-optimized-m4-6tb,
graphics-optimized-g4, graphics-optimized-g4-vgpu, memory-optimized,
memory-optimized-m3, memory-optimized-m4, memory-optimized-m4-6tb,
memory-optimized-x4-1440-24t, memory-optimized-x4-16tb,
memory-optimized-x4-1920-32t, memory-optimized-x4-24tb,
memory-optimized-x4-32tb, memory-optimized-x4-480-6t,

View file

@ -0,0 +1,40 @@
NAME
gcloud beta compute composite-health-checks get-health - get health status
of a composite health check
SYNOPSIS
gcloud beta compute composite-health-checks get-health
COMPOSITE_HEALTH_CHECK [--region=REGION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Get health status of a composite health check.
EXAMPLES
To get health of a composite health check, run:
$ gcloud beta compute composite-health-checks get-health \
COMPOSITE_HEALTH_CHECK --region=REGION
POSITIONAL ARGUMENTS
COMPOSITE_HEALTH_CHECK
Name of the composite health check to operate on.
FLAGS
--region=REGION
Region of the composite health check to operate on. Overrides the
default compute/region property value for this command invocation.
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 beta and might change without notice. This
variant is also available:
$ gcloud alpha compute composite-health-checks get-health

View file

@ -25,6 +25,9 @@ COMMANDS
describe
(BETA) Describe a composite health check.
get-health
(BETA) Get health status of a composite health check.
list
(BETA) List composite health checks.

View file

@ -90,6 +90,9 @@ COMMANDS
update
(BETA) Update a Compute Engine persistent disk.
update-kms-key
(BETA) Update the KMS key of a persistent disk.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:

View file

@ -0,0 +1,134 @@
NAME
gcloud beta compute disks update-kms-key - update the KMS key of a
persistent disk
SYNOPSIS
gcloud beta compute disks update-kms-key DISK_NAME
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) * gcloud beta compute disks update-kms-key * updates the KMS key of
a Compute Engine persistent disk by rotating it to the primary version of
the key or to the primary version of a new KMS key.
EXAMPLES
To rotate the KMS key of a disk named example-disk-1 to the primary
version, run:
$ gcloud beta compute disks update-kms-key example-disk-1 \
--zone=us-central1-a
To change the KMS key of a disk named example-disk-2 to a new KMS key named
example-key in a key ring named example-key-ring in the global scope, run:
$ gcloud beta compute disks update-kms-key example-disk-2 \
--zone=us-central1-a --kms-key=example-key \
--kms-keyring=example-key-ring --kms-location=global
POSITIONAL ARGUMENTS
DISK_NAME
Name of the disk to operate on.
FLAGS
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the disk. The 'Compute Engine Service Agent' service
account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'.
The arguments in this group can be used to specify the attributes of this
resource.
--kms-key=KMS_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
◆ provide the argument --kms-key on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--kms-keyring=KMS_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-keyring on the command line.
--kms-location=KMS_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-location on the command line;
◆ provide the argument --region on the command line.
--kms-project=KMS_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-project on the command line;
◆ set the property core/project.
At most one of these can be specified:
--region=REGION
Region of the disk 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
compute/region property:
$ gcloud config set compute/region REGION
A list of regions can be fetched by running:
$ gcloud compute regions list
To unset the property, run:
$ gcloud config unset compute/region
Alternatively, the region can be stored in the environment variable
CLOUDSDK_COMPUTE_REGION.
--zone=ZONE
Zone of the disk to operate on. If not specified and the compute/zone
property isn't set, you might be prompted to select a zone
(interactive mode only).
To avoid prompting when this flag is omitted, you can set the
compute/zone property:
$ gcloud config set compute/zone ZONE
A list of zones can be fetched by running:
$ gcloud compute zones list
To unset the property, run:
$ gcloud config unset compute/zone
Alternatively, the zone can be stored in the environment variable
CLOUDSDK_COMPUTE_ZONE.
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 beta and might change without notice. These
variants are also available:
$ gcloud compute disks update-kms-key
$ gcloud alpha compute disks update-kms-key

View file

@ -185,8 +185,7 @@ OPTIONAL FLAGS
◆ 2600:1901::/96
◆ https://compute.googleapis.com/compute/v1/projects/project-1/regions/us-central1/addresses/address-1
◆ projects/project-1/regions/us-central1/addresses/address-1
◆ regions/us-central1/addresses/address-1
◆ global/addresses/address-1
◆ projects/project-1/global/addresses/address-1
◆ address-1
The load-balancing-scheme (EXTERNAL, EXTERNAL_MANAGED, INTERNAL,

View file

@ -0,0 +1,40 @@
NAME
gcloud beta compute health-sources get-health - get health status of a
health source
SYNOPSIS
gcloud beta compute health-sources get-health HEALTH_SOURCE
[--region=REGION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Get health status of a health source.
EXAMPLES
To get health status of a single health source, run:
$ gcloud beta compute health-sources get-health HEALTH_SOURCE \
--region=REGION
POSITIONAL ARGUMENTS
HEALTH_SOURCE
Name of the health source to operate on.
FLAGS
--region=REGION
Region of the health source to operate on. Overrides the default
compute/region property value for this command invocation.
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 beta and might change without notice. This
variant is also available:
$ gcloud alpha compute health-sources get-health

View file

@ -24,6 +24,9 @@ COMMANDS
describe
(BETA) Describe a health source.
get-health
(BETA) Get health status of a health source.
list
(BETA) List health sources.

View file

@ -14,8 +14,7 @@ EXAMPLES
The following command updates a new health source named "my-health-source":
$ gcloud beta compute health-sources update <HEALTH_SOURCE_NAME> \
--region=<REGION> --source-type=BACKEND_SERVICE \
--sources=my-backend-service \
--region=<REGION> --sources=my-backend-service \
--health-aggregation-policy=my-health-aggregation-policy
POSITIONAL ARGUMENTS

View file

@ -774,6 +774,12 @@ FLAGS
Specifies the network attachment that this interface should connect
to. Mutually exclusive with --network and --subnet flags.
service-class-id
The regional Service Class ID for the producer service associated
with this network interface. Can only be used with
network_attachment. It is not possible to use on its own; however,
network_attachment can be used without service_class_id.
vlan
VLAN ID of a Dynamic Network Interface, must be an integer in the
range from 2 to 255 inclusively.

View file

@ -673,6 +673,12 @@ FLAGS
Specifies the network attachment that this interface should connect
to. Mutually exclusive with --network and --subnet flags.
service-class-id
The regional Service Class ID for the producer service associated
with this network interface. Can only be used with
network_attachment. It is not possible to use on its own; however,
network_attachment can be used without service_class_id.
vlan
VLAN ID of a Dynamic Network Interface, must be an integer in the
range from 2 to 255 inclusively.

View file

@ -843,6 +843,12 @@ FLAGS
Specifies the network attachment that this interface should connect
to. Mutually exclusive with --network and --subnet flags.
service-class-id
The regional Service Class ID for the producer service associated
with this network interface. Can only be used with
network_attachment. It is not possible to use on its own; however,
network_attachment can be used without service_class_id.
vlan
VLAN ID of a Dynamic Network Interface, must be an integer in the
range from 2 to 255 inclusively.

View file

@ -776,6 +776,12 @@ FLAGS
Specifies the network attachment that this interface should connect
to. Mutually exclusive with --network and --subnet flags.
service-class-id
The regional Service Class ID for the producer service associated
with this network interface. Can only be used with
network_attachment. It is not possible to use on its own; however,
network_attachment can be used without service_class_id.
vlan
VLAN ID of a Dynamic Network Interface, must be an integer in the
range from 2 to 255 inclusively.

View file

@ -11,7 +11,8 @@ SYNOPSIS
[--ipv6-network-tier=IPV6_NETWORK_TIER] [--network=NETWORK]
[--network-attachment=NETWORK_ATTACHMENT] [--network-tier=NETWORK_TIER]
[--parent-nic-name=PARENT_NIC_NAME]
[--private-network-ip=PRIVATE_NETWORK_IP] [--stack-type=STACK_TYPE]
[--private-network-ip=PRIVATE_NETWORK_IP]
[--service-class-id=SERVICE_CLASS_ID] [--stack-type=STACK_TYPE]
[--subnetwork=SUBNETWORK] [--vlan=VLAN] [--zone=ZONE]
[--address=ADDRESS | --no-address] [GCLOUD_WIDE_FLAG ...]
@ -109,6 +110,12 @@ FLAGS
Specifies the RFC1918 IP to assign to the network interface. The IP
should be in the subnet IP range.
--service-class-id=SERVICE_CLASS_ID
The regional Service Class ID for the producer service associated with
this network interface. Can only be used with network_attachment. It is
not possible to use on its own; however, network_attachment can be used
without service_class_id.
--stack-type=STACK_TYPE
The stack type for the network interface. Determines if IPv6 is enabled
on the network interface. STACK_TYPE must be one of:

View file

@ -12,7 +12,8 @@ SYNOPSIS
--min-cpu-platform=MIN_CPU_PLATFORM])
: --require-specific-reservation --resource-policies=[KEY=VALUE,...])
[--description=DESCRIPTION]
[--reservation-sharing-policy=RESERVATION_SHARING_POLICY] [--zone=ZONE]
[--reservation-sharing-policy=RESERVATION_SHARING_POLICY]
[--resource-manager-tags=[KEY=VALUE,...]] [--zone=ZONE]
[--delete-after-duration=DELETE_AFTER_DURATION
| --delete-at-time=DELETE_AT_TIME]
[--share-setting=SHARE_SETTING
@ -134,6 +135,9 @@ OPTIONAL FLAGS
The reservation won't be shared with Google Cloud services. If you
omit this flag during creation, the default value is DISALLOW_ALL.
--resource-manager-tags=[KEY=VALUE,...]
Resource manager tags to be bound to the reservation.
--zone=ZONE
Zone of the reservation to create. If not specified and the
compute/zone property isn't set, you might be prompted to select a zone

View file

@ -0,0 +1,80 @@
NAME
gcloud beta compute reservations slots get-version - get the version of a
reservation slot
SYNOPSIS
gcloud beta compute reservations slots get-version RESERVATION
--block-name=BLOCK_NAME --slot-name=SLOT_NAME
--sub-block-name=SUB_BLOCK_NAME [--current] [--target] [--zone=ZONE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Get the version of a reservation slot.
EXAMPLES
To get the current version of a reservation slot in reservation exr-1 in
ZONE with block name block-1, sub-block name sub-block-1 and slot name
slot-1, run:
$ gcloud beta compute reservations slots get-version exr-1 \
--zone=ZONE --block-name=block-1 --sub-block-name=sub-block-1 \
--slot-name=slot-1 --current
POSITIONAL ARGUMENTS
RESERVATION
Name of the reservation to get-version.
REQUIRED FLAGS
--block-name=BLOCK_NAME
The name of the reservation block.
--slot-name=SLOT_NAME
The name of the reservation slot.
--sub-block-name=SUB_BLOCK_NAME
The name of the reservation sub block.
OPTIONAL FLAGS
--current
Whether to get the current version.
--target
Whether to get the target version.
--zone=ZONE
Zone of the reservation to get-version. If not specified and the
compute/zone property isn't set, you might be prompted to select a zone
(interactive mode only).
To avoid prompting when this flag is omitted, you can set the
compute/zone property:
$ gcloud config set compute/zone ZONE
A list of zones can be fetched by running:
$ gcloud compute zones list
To unset the property, run:
$ gcloud config unset compute/zone
Alternatively, the zone can be stored in the environment variable
CLOUDSDK_COMPUTE_ZONE.
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 beta and might change without notice. These
variants are also available:
$ gcloud compute reservations slots get-version
$ gcloud alpha compute reservations slots get-version

View file

@ -19,6 +19,9 @@ COMMANDS
describe
(BETA) Describe a Compute Engine reservation slot.
get-version
(BETA) Get the version of a reservation slot.
list
(BETA) List Compute Engine reservation slots.

View file

@ -0,0 +1,75 @@
NAME
gcloud beta compute reservations sub-blocks get-version - get the version
of a reservation sub-block
SYNOPSIS
gcloud beta compute reservations sub-blocks get-version RESERVATION
--block-name=BLOCK_NAME --sub-block-name=SUB_BLOCK_NAME [--current]
[--target] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Get the version of a reservation sub-block.
EXAMPLES
To get the current version of a reservation sub-block in reservation exr-1
in ZONE with block name block-1 and sub-block name sub-block-1, run:
$ gcloud beta compute reservations sub-blocks get-version exr-1 \
--zone=ZONE --block-name=block-1 --sub-block-name=sub-block-1 \
--current
POSITIONAL ARGUMENTS
RESERVATION
Name of the reservation to get-version.
REQUIRED FLAGS
--block-name=BLOCK_NAME
The name of the reservation block.
--sub-block-name=SUB_BLOCK_NAME
The name of the reservation sub block.
OPTIONAL FLAGS
--current
Whether to get the current version.
--target
Whether to get the target version.
--zone=ZONE
Zone of the reservation to get-version. If not specified and the
compute/zone property isn't set, you might be prompted to select a zone
(interactive mode only).
To avoid prompting when this flag is omitted, you can set the
compute/zone property:
$ gcloud config set compute/zone ZONE
A list of zones can be fetched by running:
$ gcloud compute zones list
To unset the property, run:
$ gcloud config unset compute/zone
Alternatively, the zone can be stored in the environment variable
CLOUDSDK_COMPUTE_ZONE.
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 beta and might change without notice. These
variants are also available:
$ gcloud compute reservations sub-blocks get-version
$ gcloud alpha compute reservations sub-blocks get-version

View file

@ -19,6 +19,9 @@ COMMANDS
describe
(BETA) Describe a Compute Engine reservation sub-block.
get-version
(BETA) Get the version of a reservation sub-block.
list
(BETA) List Compute Engine reservation sub-blocks.

View file

@ -55,6 +55,9 @@ COMMANDS
update
(BETA) Update a Compute Engine snapshot.
update-kms-key
(BETA) Update the KMS key of a Compute Engine snapshot.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:

View file

@ -0,0 +1,94 @@
NAME
gcloud beta compute snapshots update-kms-key - update the KMS key of a
Compute Engine snapshot
SYNOPSIS
gcloud beta compute snapshots update-kms-key SNAPSHOT_NAME
[--region=REGION]
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) * gcloud beta compute snapshots update-kms-key updates the KMS key
of a Compute Engine persistent snapshot by rotating it to the primary
version of the key or to the primary version of a new KMS key.
EXAMPLES
To update the KMS key of a snapshot named example-snapshot-1, run:
$ gcloud beta compute snapshots update-kms-key example-snapshot-1
To update the KMS key of a snapshot named example-snapshot-2 to a new KMS
key named example-key in a key ring named example-key-ring in the global
scope, run:
$ gcloud beta compute snapshots update-kms-key example-snapshot-2 \
--kms-key=example-key --kms-keyring=example-key-ring \
--kms-location=global
POSITIONAL ARGUMENTS
SNAPSHOT_NAME
Name of the snapshot to update the KMS key for.
FLAGS
--region=REGION
The region of the snapshot to update.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the snapshot. The 'Compute Engine Service Agent'
service account must hold permission 'Cloud KMS CryptoKey
Encrypter/Decrypter'. The arguments in this group can be used to specify
the attributes of this resource.
--kms-key=KMS_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
◆ provide the argument --kms-key on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--kms-keyring=KMS_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-keyring on the command line.
--kms-location=KMS_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-location on the command line;
◆ provide the argument --region on the command line.
--kms-project=KMS_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-project on the command line;
◆ set the property core/project.
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 beta and might change without notice. These
variants are also available:
$ gcloud compute snapshots update-kms-key
$ gcloud alpha compute snapshots update-kms-key

View file

@ -99,8 +99,7 @@ OPTIONAL FLAGS
Currently only local-ssd is allowed.
size
The size of the disk in GiB. Currently you can specify only 375 GiB
or no value at all.
The size of the disk in GiB.
count
Specifies the number of such disks. Set to 16 or 24.