imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 12:22:03 +00:00
Code Activity

gcloud: Wed Jun 28 10:42:37 UTC 2023

Browse source
This commit is contained in:
Automated 2023-06-28 10:42:37 +00:00
parent dc0d916cee
commit 0248e53b76
139 changed files with 3939 additions and 162 deletions
Download patch file Download diff file Expand all files Collapse all files

18
gcloud/alpha/compute/addresses/create
View file

@ -19,8 +19,8 @@ DESCRIPTION
EXAMPLES
To reserve three IP addresses in the 'us-central1' region, run:
$ gcloud alpha compute addresses create ADDRESS-1 ADDRESS-2 \
ADDRESS-3 --region=us-central1
$ gcloud alpha compute addresses create address-1 address-2 \
address-3 --region=us-central1
To reserve ephemeral IP addresses '162.222.181.198' and '23.251.146.189'
which are being used by virtual machine instances in the 'us-central1'
@ -31,36 +31,36 @@ EXAMPLES
In the above invocation, the two addresses will be assigned random names.
To reserve an IP address from the subnet 'default' in the 'us-central1'
region, run:
To reserve an IP address named subnet-address-1 from the subnet 'default'
in the 'us-central1' region, run:
$ gcloud alpha compute addresses create SUBNET-ADDRESS-1 \
$ gcloud alpha compute addresses create subnet-address-1 \
--region=us-central1 --subnet=default
To reserve an IP address that can be used by multiple internal load
balancers from the subnet 'default' in the 'us-central1' region, run:
$ gcloud alpha compute addresses create SHARED-ADDRESS-1 \
$ gcloud alpha compute addresses create shared-address-1 \
--region=us-central1 --subnet=default \
--purpose=SHARED_LOADBALANCER_VIP
To reserve an IP range '10.110.0.0/16' from the network 'default' for
'VPC_PEERING', run:
$ gcloud alpha compute addresses create IP-RANGE-1 --global \
$ gcloud alpha compute addresses create ip-range-1 --global \
--addresses=10.110.0.0 --prefix-length=16 \
--purpose=VPC_PEERING --network=default
To reserve any IP range with prefix length '16' from the network 'default'
for 'VPC_PEERING', run:
$ gcloud alpha compute addresses create IP-RANGE-1 --global \
$ gcloud alpha compute addresses create ip-range-1 --global \
--prefix-length=16 --purpose=VPC_PEERING --network=default
To reserve an address from network 'default' for PRIVATE_SERVICE_CONNECT,
run:
$ gcloud alpha compute addresses create PSC-ADDRESS-1 --global \
$ gcloud alpha compute addresses create psc-address-1 --global \
--addresses=10.110.0.10 --purpose=PRIVATE_SERVICE_CONNECT \
--network=default

2
gcloud/alpha/compute/addresses/delete
View file

@ -17,7 +17,7 @@ EXAMPLES
To release two addresses with the names 'address-name1' and
'address-name2', run:
$ gcloud alpha compute addresses delete addressname1 address-name2
$ gcloud alpha compute addresses delete address-name1 address-name2
POSITIONAL ARGUMENTS
NAME [NAME ...]

4
gcloud/alpha/compute/addresses/describe
View file

@ -13,11 +13,11 @@ DESCRIPTION
EXAMPLES
To get details about a global address, run:
$ gcloud alpha compute addresses describe ADDRESS --global
$ gcloud alpha compute addresses describe my-address-name --global
To get details about a regional address, run:
$ gcloud alpha compute addresses describe ADDRESS \
$ gcloud alpha compute addresses describe my-address-name \
--region=us-central1
POSITIONAL ARGUMENTS

19
gcloud/alpha/compute/backend-services/add-backend
View file

@ -13,7 +13,8 @@ SYNOPSIS
| --network-endpoint-group-zone=NETWORK_ENDPOINT_GROUP_ZONE])
[--balancing-mode=BALANCING_MODE] [--capacity-scaler=CAPACITY_SCALER]
[--description=DESCRIPTION] [--failover]
[--max-utilization=MAX_UTILIZATION] [--global | --region=REGION]
[--max-utilization=MAX_UTILIZATION] [--preference=PREFERENCE]
[--global | --region=REGION]
[--max-connections=MAX_CONNECTIONS
| --max-connections-per-endpoint=MAX_CONNECTIONS_PER_ENDPOINT
| --max-connections-per-instance=MAX_CONNECTIONS_PER_INSTANCE
@ -232,6 +233,22 @@ OPTIONAL FLAGS
capacity. For usage guidelines, see Balancing mode combinations
(https://cloud.google.com/load-balancing/docs/backend-service#balancing-mode-combos).
--preference=PREFERENCE
Defines whether this backend should be fully utilized before sending
traffic to backends with default preference. This cannot be used with
regional managed instance groups and when the endpoint type of an
attached network endpoint group is INTERNET_IP_PORT,
INTERNET_FQDN_PORT, or SERVERLESS. PREFERENCE must be one of:
DEFAULT
If preferred backends don't have enough capacity, backends in this
layer would be used and traffic would be assigned based on the load
balancing algorithm you use. This is the default.
PREFERRED
Backends with this preference level will be filled up to their
capacity limits first, based on RTT.
At most one of these can be specified:
--global

19
gcloud/alpha/compute/backend-services/update-backend
View file

@ -11,7 +11,8 @@ SYNOPSIS
: --network-endpoint-group-zone=NETWORK_ENDPOINT_GROUP_ZONE])
[--balancing-mode=BALANCING_MODE] [--capacity-scaler=CAPACITY_SCALER]
[--description=DESCRIPTION] [--failover]
[--max-utilization=MAX_UTILIZATION] [--global | --region=REGION]
[--max-utilization=MAX_UTILIZATION] [--preference=PREFERENCE]
[--global | --region=REGION]
[--max-connections=MAX_CONNECTIONS
| --max-connections-per-endpoint=MAX_CONNECTIONS_PER_ENDPOINT
| --max-connections-per-instance=MAX_CONNECTIONS_PER_INSTANCE
@ -201,6 +202,22 @@ OPTIONAL FLAGS
capacity. For usage guidelines, see Balancing mode combinations
(https://cloud.google.com/load-balancing/docs/backend-service#balancing-mode-combos).
--preference=PREFERENCE
Defines whether this backend should be fully utilized before sending
traffic to backends with default preference. This cannot be used with
regional managed instance groups and when the endpoint type of an
attached network endpoint group is INTERNET_IP_PORT,
INTERNET_FQDN_PORT, or SERVERLESS. PREFERENCE must be one of:
DEFAULT
If preferred backends don't have enough capacity, backends in this
layer would be used and traffic would be assigned based on the load
balancing algorithm you use. This is the default.
PREFERRED
Backends with this preference level will be filled up to their
capacity limits first, based on RTT.
At most one of these can be specified:
--global

12
gcloud/alpha/compute/disks/create
View file

@ -3,8 +3,8 @@ NAME
SYNOPSIS
gcloud alpha compute disks create DISK_NAME [DISK_NAME ...]
[--architecture=ARCHITECTURE] [--csek-key-file=FILE]
[--description=DESCRIPTION] [--enable-confidential-compute]
[--architecture=ARCHITECTURE] [--confidential-compute]
[--csek-key-file=FILE] [--description=DESCRIPTION]
[--erase-windows-vss-signature]
[--guest-os-features=[GUEST_OS_FEATURE,...]] [--interface=INTERFACE]
[--labels=[KEY=VALUE,...]] [--licenses=[LICENSE,...]] [--multi-writer]
@ -68,6 +68,10 @@ FLAGS
https://cloud.google.com/compute/docs/cpu-platforms. ARCHITECTURE must
be one of: ARM64, X86_64.
--confidential-compute
Create the disk in confidential compute mode, CMEK layer is required
and only applicable to HyperDisk series.
--csek-key-file=FILE
Path to a Customer-Supplied Encryption Key (CSEK) key file that maps
Compute Engine resources to user managed keys to be used when creating,
@ -80,10 +84,6 @@ FLAGS
--description=DESCRIPTION
An optional, textual description for the disks being created.
--enable-confidential-compute
Create the disk in confidential compute mode, CMEK layer is required
and only applicable to HyperDisk series.
--erase-windows-vss-signature
Specifies whether the disk restored from a source snapshot should erase
Windows specific VSS signature. See

95
gcloud/alpha/compute/instances/add-partner-metadata Normal file
View file

@ -0,0 +1,95 @@
NAME
gcloud alpha compute instances add-partner-metadata - add or update or
patch partner metadata
SYNOPSIS
gcloud alpha compute instances add-partner-metadata INSTANCE_NAME
[--partner-metadata=[KEY=VALUE,...]]
[--partner-metadata-from-file=LOCAL_FILE_PATH] [--zone=ZONE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute instances add-partner-metadata can be used to
add or update or patch partner metadata of a virtual machine instance.
Every instance has access to a metadata server that can be used to query
partner metadata that has been set through this tool. For information on
metadata, see
Only Namespaces keys that are provided are mutated. Existing Namespaces
entries will remain unaffected.
In order to retrieve partner metadata, run:
$ gcloud compute instances describe example-instance --zone
us-central1-a --format="value(partnerMetadata)"
where example-instance is the name of the virtual machine instance you're
querying partner metadata from.
EXAMPLES
To add partner metadata under namespace gcar.googleapis.com/engine to
instance TEST_INSTANCE run:
$ gcloud alpha compute instances add-partner-metadata \
TEST_INSTANCE \
--partner-metadata=gcar.googleapis.com/engine="{ "engine": { \
"type": V8 } }"
To add partner metadata from a file:
$ gcloud alpha compute instances add-partner-metadata \
TEST_INSTANCE --partner-metadata-from-file=examples/engine.json
POSITIONAL ARGUMENTS
INSTANCE_NAME
Name of the instance to set partner metadata on. For details on valid
instance names, refer to the criteria documented under the field 'name'
at: https://cloud.google.com/compute/docs/reference/rest/v1/instances
FLAGS
--partner-metadata=[KEY=VALUE,...]
Partner Metadata assigned to the instance. A map from a
subdomain(namespace) to entries map.
--partner-metadata-from-file=LOCAL_FILE_PATH
path to json local file which including the definintion of partner
metadata.
--zone=ZONE
Zone of the instance to set partner metadata on. If not specified, you
might be prompted to select a zone (interactive mode only). gcloud
attempts to identify the appropriate zone by searching for resources in
your currently active project. If the zone cannot be determined, gcloud
prompts you for a selection with all available Google Cloud Platform
zones.
To avoid prompting when this flag is omitted, the user 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 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.

18
gcloud/alpha/compute/instances/create
View file

@ -69,7 +69,9 @@ SYNOPSIS
: --custom-extensions --custom-vm-type=CUSTOM_VM_TYPE]
[--image-family-scope=IMAGE_FAMILY_SCOPE
--image-project=IMAGE_PROJECT --image=IMAGE
| --image-family=IMAGE_FAMILY | --source-snapshot=SOURCE_SNAPSHOT]
| --image-family=IMAGE_FAMILY
| --source-instant-snapshot=SOURCE_INSTANT_SNAPSHOT
| --source-snapshot=SOURCE_SNAPSHOT]
[--instance-kms-key=INSTANCE_KMS_KEY
: --instance-kms-keyring=INSTANCE_KMS_KEYRING
--instance-kms-location=INSTANCE_KMS_LOCATION
@ -383,6 +385,13 @@ FLAGS
source snapshot. Must be specified with
source-snapshot-csek-required.
source-instant-snapshot
The source disk instant snapshot that will be used to create the
disk. You can provide this as a full URL to the instant snapshot.
For example, the following is a valid value:
▸ https://compute.googleapis.com/compute/v1/projects/myproject/zones/myzone/instantSnapshots/instantSnapshot
image-csek-required
Specifies the name of the CSK protected image that the disk will be
initialized with. A new disk will be created based on the given
@ -1082,6 +1091,13 @@ FLAGS
By default, debian-11 is assumed for this flag.
--source-instant-snapshot=SOURCE_INSTANT_SNAPSHOT
The name of the source disk instant snapshot that the instance boot
disk will be created from. You can provide this as a full URL to the
instant snapshot. For example, the following is a valid value:
▸ https://compute.googleapis.com/compute/v1/projects/myproject/zones/my-zone/instantSnapshots/instant-snapshot
--source-snapshot=SOURCE_SNAPSHOT
The name of the source disk snapshot that the instance boot disk will
be created from. You can provide this as a full URL to the snapshot

9
gcloud/alpha/compute/instances/help
View file

@ -59,6 +59,9 @@ COMMANDS
add-metadata
(ALPHA) Add or update instance metadata.
add-partner-metadata
(ALPHA) add or update or patch partner metadata.
add-resource-policies
(ALPHA) Add resource policies to Compute Engine VM instances.
@ -115,6 +118,9 @@ COMMANDS
(ALPHA) Move an instance and its attached persistent disks between
zones.
patch-partner-metadata
(ALPHA) patch partner metadata.
perform-maintenance
(ALPHA) Perform maintenance of Google Compute Engine instance.
@ -128,6 +134,9 @@ COMMANDS
remove-metadata
(ALPHA) Remove instance metadata.
remove-partner-metadata
(ALPHA) remove partner metadata namespace.
remove-resource-policies
(ALPHA) Remove resource policies from Compute Engine VM instances.

95
gcloud/alpha/compute/instances/patch-partner-metadata Normal file
View file

@ -0,0 +1,95 @@
NAME
gcloud alpha compute instances patch-partner-metadata - patch partner
metadata
SYNOPSIS
gcloud alpha compute instances patch-partner-metadata INSTANCE_NAME
[--partner-metadata=[KEY=VALUE,...]]
[--partner-metadata-from-file=LOCAL_FILE_PATH] [--zone=ZONE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute instances patch-partner-metadata can be used
to add or patch partner metadata of a virtual machine instance. Every
instance has access to a metadata server that can be used to query partner
metadata that has been set through this tool. For information on metadata,
see
Only Namespaces keys that are provided are mutated. Existing Namespaces
entries will remain unaffected.
In order to retrieve partner metadata, run:
$ gcloud compute instances describe example-instance --zone
us-central1-a --format="value(partnerMetadata)"
where example-instance is the name of the virtual machine instance you're
querying partner metadata from.
EXAMPLES
To add partner metadata under namespace gcar.googleapis.com/engine to
instance TEST_INSTANCE run:
$ gcloud alpha compute instances patch-partner-metadata \
TEST_INSTANCE \
--partner-metadata=gcar.googleapis.com/engine="{ "engine": { \
"type": V8 } }"
To add partner metadata from a file:
$ gcloud alpha compute instances add-partner-metadata \
TEST_INSTANCE --partner-metadata-from-file=examples/engine.json
POSITIONAL ARGUMENTS
INSTANCE_NAME
Name of the instance to set partner metadata on. For details on valid
instance names, refer to the criteria documented under the field 'name'
at: https://cloud.google.com/compute/docs/reference/rest/v1/instances
FLAGS
--partner-metadata=[KEY=VALUE,...]
Partner Metadata assigned to the instance. A map from a
subdomain(namespace) to entries map.
--partner-metadata-from-file=LOCAL_FILE_PATH
path to json local file which including the definintion of partner
metadata.
--zone=ZONE
Zone of the instance to set partner metadata on. If not specified, you
might be prompted to select a zone (interactive mode only). gcloud
attempts to identify the appropriate zone by searching for resources in
your currently active project. If the zone cannot be determined, gcloud
prompts you for a selection with all available Google Cloud Platform
zones.
To avoid prompting when this flag is omitted, the user 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 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.

77
gcloud/alpha/compute/instances/remove-partner-metadata Normal file
View file

@ -0,0 +1,77 @@
NAME
gcloud alpha compute instances remove-partner-metadata - remove partner
metadata namespace
SYNOPSIS
gcloud alpha compute instances remove-partner-metadata INSTANCE_NAME
[--zone=ZONE] [--all | --keys=KEY,[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute instances remove-partner-metadata can be used
to remove instance metadata entries.
EXAMPLES
To remove partner metadata namespace gcar.googleapis.com/engine and
gcar.googleapis.com/body along with their data from an instance named
INSTANCE_NAME, run:
$ gcloud alpha compute instances remove-partner-metadata \
INSTANCE_NAME \
--keys=gcar.googleapis.com/engine,gcar.googleapis.com/body
To remove all namespaces, run: $ gcloud alpha compute instances remove-partner-metadata \
INSTANCE_NAME --all
POSITIONAL ARGUMENTS
INSTANCE_NAME
Name of the instance to set partner metadata on. For details on valid
instance names, refer to the criteria documented under the field 'name'
at: https://cloud.google.com/compute/docs/reference/rest/v1/instances
FLAGS
--zone=ZONE
Zone of the instance to set partner metadata on. If not specified, you
might be prompted to select a zone (interactive mode only). gcloud
attempts to identify the appropriate zone by searching for resources in
your currently active project. If the zone cannot be determined, gcloud
prompts you for a selection with all available Google Cloud Platform
zones.
To avoid prompting when this flag is omitted, the user 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.
At most one of these can be specified:
--all
If provided, all partner metadata namespaces are removed.
--keys=KEY,[KEY,...]
The namespaces partner metadata to remove.
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 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.

7
gcloud/alpha/compute/tpus/queued-resources/create
View file

@ -17,8 +17,8 @@ SYNOPSIS
[--reservation-host-organization=RESERVATION_HOST_ORGANIZATION]
[--reservation-host-project=RESERVATION_HOST_PROJECT] [--reserved]
[--scopes=[SCOPES,...]] [--service-account=SERVICE_ACCOUNT]
[--shielded-secure-boot] [--subnetwork=SUBNETWORK] [--tags=[TAGS,...]]
[--valid-after-duration=VALID_AFTER_DURATION]
[--shielded-secure-boot] [--spot] [--subnetwork=SUBNETWORK]
[--tags=[TAGS,...]] [--valid-after-duration=VALID_AFTER_DURATION]
[--valid-after-time=VALID_AFTER_TIME]
[--valid-until-duration=VALID_UNTIL_DURATION]
[--valid-until-time=VALID_UNTIL_TIME] [GCLOUD_WIDE_FLAG ...]
@ -232,6 +232,9 @@ OPTIONAL FLAGS
Specifies that the TPU instances are created with secure boot enabled.
This implicitly makes them Shielded VM instances.
--spot
If provided, the Node requested here will be created as Spot VMs.
--subnetwork=SUBNETWORK
Subnetwork that this TPU will be a part of.

33
gcloud/alpha/compute/tpus/tpu-vm/update
View file

@ -2,9 +2,10 @@ NAME
gcloud alpha compute tpus tpu-vm update - update a Cloud TPU VM node
SYNOPSIS
gcloud alpha compute tpus tpu-vm update (TPU : --zone=ZONE) [--async]
[--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
gcloud alpha compute tpus tpu-vm update (TPU : --zone=ZONE)
[--add-tags=[TAGS,...]] [--async] [--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]]
[--clear-tags | --remove-tags=[TAG,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update a Cloud TPU VM node.
@ -64,6 +65,12 @@ POSITIONAL ARGUMENTS
▸ set the property compute/zone.
FLAGS
--add-tags=[TAGS,...]
Tags to add to the TPU Node. Tags are used to identify valid sources or
targets for network firewalls. See
https://cloud.google.com/vpc/docs/add-remove-network-tags for more
details.
--async
Return immediately, without waiting for the operation in progress to
complete.
@ -95,6 +102,26 @@ FLAGS
silently ignored. If --update-labels is also specified then
--update-labels is applied first.
At most one of these can be specified:
--clear-tags
Remove all tags. If --add-tags is also specified then --clear-tags is
applied first.
For example, to remove all tags:
$ gcloud alpha compute tpus tpu-vm update --clear-tags
To remove all existing tags and create two new tags, 'foo' and 'bar':
$ gcloud alpha compute tpus tpu-vm update --clear-tags \
--add-tags foo,bar
--remove-tags=[TAG,...]
List of tags to remove. If a tag does not exist it is silently
ignored. If --add-tags is also specified then --add-tags is applied
first.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,