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

gcloud: Wed Nov 13 10:04:10 UTC 2024

Browse source
This commit is contained in:
Automated 2024-11-13 10:04:10 +00:00
parent 7da5872e5c
commit a63704a3af
252 changed files with 4821 additions and 807 deletions
Download patch file Download diff file Expand all files Collapse all files

11
gcloud/alpha/compute/commitments/create
View file

@ -110,11 +110,12 @@ OPTIONAL FLAGS
accelerator-optimized-a3-ultra, compute-optimized,
compute-optimized-c2d, compute-optimized-c3, compute-optimized-c3d,
compute-optimized-h3, general-purpose, general-purpose-c4,
general-purpose-e2, general-purpose-n2, general-purpose-n2d,
general-purpose-n4, general-purpose-t2d, graphics-optimized,
memory-optimized, memory-optimized-m3, memory-optimized-x4,
memory-optimized-x4-16tb, memory-optimized-x4-24tb,
memory-optimized-x4-32tb, storage-optimized-z3.
general-purpose-c4a, general-purpose-e2, general-purpose-n2,
general-purpose-n2d, general-purpose-n4, general-purpose-t2d,
graphics-optimized, memory-optimized, memory-optimized-m3,
memory-optimized-m4, memory-optimized-x4, memory-optimized-x4-16tb,
memory-optimized-x4-24tb, memory-optimized-x4-32tb,
storage-optimized-z3.
Manage the reservations to be created with the commitment.

134
gcloud/alpha/compute/disks/convert Normal file
View file

@ -0,0 +1,134 @@
NAME
gcloud alpha compute disks convert - convert a Compute Engine disk into a
new disk type or new format
SYNOPSIS
gcloud alpha compute disks convert DISK_NAME
--target-disk-type=TARGET_DISK_TYPE
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Convert Compute Engine Persistent Disk volumes to Hyperdisk
volumes.
gcloud alpha compute disks convert converts a Compute Engine Persistent
Disk volume to a Hyperdisk volume. For a comprehensive guide, refer to:
https://cloud.google.com/sdk/gcloud/reference/compute/disks/convert.
EXAMPLES
The following command converts a PD Standard disk to a Hyperdisk
Throughput:
$ gcloud alpha compute disks convert my-disk-1 --zone=ZONE \
--target-disk-type=hyperdisk-throughput
POSITIONAL ARGUMENTS
DISK_NAME
Name of the disk to operate on.
REQUIRED FLAGS
--target-disk-type=TARGET_DISK_TYPE
Specifies the type of disk to convert to. To get a list of available
disk types, run gcloud compute disk-types list.
OPTIONAL 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 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.

4
gcloud/alpha/compute/disks/help
View file

@ -40,6 +40,10 @@ COMMANDS
add-resource-policies
(ALPHA) Add resource policies to a Compute Engine disk.
convert
(ALPHA) Convert a Compute Engine disk into a new disk type or new
format.
create
(ALPHA) Create Compute Engine persistent disks.

9
gcloud/alpha/compute/future-reservations/create
View file

@ -14,8 +14,7 @@ SYNOPSIS
--min-cpu-platform=MIN_CPU_PLATFORM])
(--start-time=START_TIME (--duration=DURATION | --end-time=END_TIME))
[--deployment-type=DEPLOYMENT_TYPE] [--description=DESCRIPTION]
[--[no-]enable-opportunistic-maintenance] [--name-prefix=NAME_PREFIX]
[--planning-status=PLANNING_STATUS]
[--name-prefix=NAME_PREFIX] [--planning-status=PLANNING_STATUS]
[--[no-]require-specific-reservation]
[--reservation-name=RESERVATION_NAME]
[--scheduling-type=SCHEDULING_TYPE] [--zone=ZONE]
@ -180,12 +179,6 @@ OPTIONAL FLAGS
--description=DESCRIPTION
An optional description of the future reservation to create.
--[no-]enable-opportunistic-maintenance
Enable or disable opportunistic maintenance. If enabled, maintenance is
performed on unused reservations whenever possible. Use
--enable-opportunistic-maintenance to enable and
--no-enable-opportunistic-maintenance to disable.
--name-prefix=NAME_PREFIX
A name prefix for the auto-created reservations when capacity is
delivered at the start time. Each auto-created reservation name starts

7
gcloud/alpha/compute/future-reservations/update
View file

@ -6,7 +6,6 @@ SYNOPSIS
gcloud alpha compute future-reservations update FUTURE_RESERVATION
[--[no-]auto-delete-auto-created-reservations]
[--deployment-type=DEPLOYMENT_TYPE] [--description=DESCRIPTION]
[--[no-]enable-opportunistic-maintenance]
[--planning-status=PLANNING_STATUS]
[--[no-]require-specific-reservation]
[--reservation-name=RESERVATION_NAME]
@ -62,12 +61,6 @@ FLAGS
--description=DESCRIPTION
An optional description of the future reservation to create.
--[no-]enable-opportunistic-maintenance
Enable or disable opportunistic maintenance. If enabled, maintenance is
performed on unused reservations whenever possible. Use
--enable-opportunistic-maintenance to enable and
--no-enable-opportunistic-maintenance to disable.
--planning-status=PLANNING_STATUS
The planning status of the future reservation. The default value is
DRAFT. While in DRAFT, any changes to the future reservation's

3
gcloud/alpha/compute/help
View file

@ -114,6 +114,9 @@ GROUPS
network-firewall-policies
(ALPHA) Manage Compute Engine network firewall policies.
network-profiles
(ALPHA) Read Compute Engine network profiles.
networks
(ALPHA) List, create, and delete Compute Engine networks.

6
gcloud/alpha/compute/instance-templates/create
View file

@ -852,6 +852,10 @@ FLAGS
Specifies provisioning model, which determines price, obtainability,
and runtime for the VM instance. PROVISIONING_MODEL must be one of:
RESERVATION_BOUND
Reservation-bound provisioning model for VM instances which are
bound to the lifecycle of the reservation in which it is
provisioned.
SPOT
Spot VMs are spare capacity; Spot VMs are discounted to have much
lower prices than standard VMs but have no guaranteed runtime. Spot
@ -1158,7 +1162,7 @@ FLAGS
practice to use --image-family when the latest version of an image is
needed.
By default, debian-11 is assumed for this flag.
By default, debian-12 is assumed for this flag.
Maintenance Behavior.

2
gcloud/alpha/compute/instance-templates/create-with-container
View file

@ -883,7 +883,7 @@ FLAGS
practice to use --image-family when the latest version of an image is
needed.
By default, debian-11 is assumed for this flag.
By default, debian-12 is assumed for this flag.
Maintenance Behavior.

6
gcloud/alpha/compute/instances/bulk/create
View file

@ -742,6 +742,10 @@ OPTIONAL FLAGS
Specifies provisioning model, which determines price, obtainability,
and runtime for the VM instance. PROVISIONING_MODEL must be one of:
RESERVATION_BOUND
Reservation-bound provisioning model for VM instances which are
bound to the lifecycle of the reservation in which it is
provisioned.
SPOT
Spot VMs are spare capacity; Spot VMs are discounted to have much
lower prices than standard VMs but have no guaranteed runtime. Spot
@ -1027,7 +1031,7 @@ OPTIONAL FLAGS
practice to use --image-family when the latest version of an image is
needed.
By default, debian-11 is assumed for this flag.
By default, debian-12 is assumed for this flag.
--source-snapshot=SOURCE_SNAPSHOT
The name of the source disk snapshot that the instance boot disk will

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

@ -875,6 +875,10 @@ FLAGS
Specifies provisioning model, which determines price, obtainability,
and runtime for the VM instance. PROVISIONING_MODEL must be one of:
RESERVATION_BOUND
Reservation-bound provisioning model for VM instances which are
bound to the lifecycle of the reservation in which it is
provisioned.
SPOT
Spot VMs are spare capacity; Spot VMs are discounted to have much
lower prices than standard VMs but have no guaranteed runtime. Spot
@ -1208,7 +1212,7 @@ FLAGS
practice to use --image-family when the latest version of an image is
needed.
By default, debian-11 is assumed for this flag.
By default, debian-12 is assumed for this flag.
--source-instant-snapshot=SOURCE_INSTANT_SNAPSHOT
The name of the source disk instant snapshot that the instance boot

6
gcloud/alpha/compute/instances/create-with-container
View file

@ -817,6 +817,10 @@ FLAGS
Specifies provisioning model, which determines price, obtainability,
and runtime for the VM instance. PROVISIONING_MODEL must be one of:
RESERVATION_BOUND
Reservation-bound provisioning model for VM instances which are
bound to the lifecycle of the reservation in which it is
provisioned.
SPOT
Spot VMs are spare capacity; Spot VMs are discounted to have much
lower prices than standard VMs but have no guaranteed runtime. Spot
@ -1067,7 +1071,7 @@ FLAGS
practice to use --image-family when the latest version of an image is
needed.
By default, debian-11 is assumed for this flag.
By default, debian-12 is assumed for this flag.
Maintenance Behavior.

11
gcloud/alpha/compute/instances/network-interfaces/add
View file

@ -6,6 +6,7 @@ SYNOPSIS
gcloud alpha compute instances network-interfaces add INSTANCE_NAME
[--aliases=ALIASES] [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS]
[--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH]
[--igmp-query=IGMP_QUERY]
[--internal-ipv6-address=INTERNAL_IPV6_ADDRESS]
[--internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH]
[--ipv6-address=IPV6_ADDRESS] [--ipv6-network-tier=IPV6_NETWORK_TIER]
@ -57,6 +58,16 @@ FLAGS
be used together with --external-ipv6-address. Currently only /96 is
supported and the default value is 96.
--igmp-query=IGMP_QUERY
Determines if the Compute Engine instance can receive and respond to
IGMP query packets on the specified network interface. IGMP_QUERY must
be one of:
IGMP_QUERY_DISABLED
IGMP Query on the network interface is disabled.
IGMP_QUERY_V2
IGMP Query V2 on the network interface is enabled.
--internal-ipv6-address=INTERNAL_IPV6_ADDRESS
Assigns the given internal IPv6 address or range to an instance. The
address must be the first IP address in the range or a /96 IP address

4
gcloud/alpha/compute/instances/set-scheduling
View file

@ -81,6 +81,10 @@ FLAGS
Specifies provisioning model, which determines price, obtainability,
and runtime for the VM instance. PROVISIONING_MODEL must be one of:
RESERVATION_BOUND
Reservation-bound provisioning model for VM instances which are
bound to the lifecycle of the reservation in which it is
provisioned.
SPOT
Spot VMs are spare capacity; Spot VMs are discounted to have much
lower prices than standard VMs but have no guaranteed runtime. Spot

54
gcloud/alpha/compute/network-profiles/describe Normal file
View file

@ -0,0 +1,54 @@
NAME
gcloud alpha compute network-profiles describe - describe a network profile
SYNOPSIS
gcloud alpha compute network-profiles describe NETWORK_PROFILE
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a network profile.
EXAMPLES
To retrieve a single network profile and print its properties, run the
following command: $ gcloud alpha compute network-profiles describe my-network-profile
POSITIONAL ARGUMENTS
Network profile resource - Name of the network profile you want to
inspect. This represents a Cloud resource. (NOTE) Some attributes are not
given arguments in this group but can be set in other ways.
To set the project attribute:
◆ provide the argument network_profile on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
NETWORK_PROFILE
ID of the network_profile or fully qualified identifier for the
network_profile.
To set the network_profile attribute:
▸ provide the argument network_profile on the command line.
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 the compute/alpha API. The full documentation for this
API can be found at: https://cloud.google.com/compute/
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. This variant is also available:
$ gcloud beta compute network-profiles describe

32
gcloud/alpha/compute/network-profiles/help Normal file
View file

@ -0,0 +1,32 @@
NAME
gcloud alpha compute network-profiles - read Compute Engine network
profiles
SYNOPSIS
gcloud alpha compute network-profiles COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Read Compute Engine network profiles.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(ALPHA) Describe a network profile.
list
(ALPHA) List network profiles.
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. This variant is also available:
$ gcloud beta compute network-profiles

68
gcloud/alpha/compute/network-profiles/list Normal file
View file

@ -0,0 +1,68 @@
NAME
gcloud alpha compute network-profiles list - list network profiles
SYNOPSIS
gcloud alpha compute network-profiles list [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List network profiles.
EXAMPLES
The following command lists all network profiles:
$ gcloud alpha compute network-profiles list
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 the compute/alpha API. The full documentation for this
API can be found at: https://cloud.google.com/compute/
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. This variant is also available:
$ gcloud beta compute network-profiles list

12
gcloud/alpha/compute/os-config/policy-orchestrators/create
View file

@ -6,6 +6,8 @@ SYNOPSIS
gcloud alpha compute os-config policy-orchestrators create
(POLICY_ORCHESTRATOR : --folder=FOLDER --organization=ORGANIZATION)
--policy-type=POLICY_TYPE [--action=ACTION; default="upsert"] [--async]
[--include-folders=INCLUDE_FOLDERS]
[--include-locations=INCLUDE_LOCATIONS]
[--include-projects=INCLUDE_PROJECTS] [--policy-file=POLICY_FILE]
[--policy-id=POLICY_ID] [--state=STATE; default="ACTIVE"]
[GCLOUD_WIDE_FLAG ...]
@ -94,8 +96,16 @@ OPTIONAL FLAGS
Return immediately, without waiting for the operation in progress to
complete.
--include-folders=INCLUDE_FOLDERS
Applies policy to selected folders. Comma-separated list of folder
numbers. Can beused together with --include-projects.
--include-locations=INCLUDE_LOCATIONS
Applies policy to selected locations, e.g. us-central1-a.
--include-projects=INCLUDE_PROJECTS
Applies policy to selected projects only.
Applies policy to selected projects. Comma-separated list of project
numbers. Can be used together with --include-folders.
--policy-file=POLICY_FILE
Absolute path to the OS policy assignment file on your local client.

30
gcloud/alpha/compute/os-config/policy-orchestrators/update
View file

@ -7,6 +7,8 @@ SYNOPSIS
(POLICY_ORCHESTRATOR : --folder=FOLDER --organization=ORGANIZATION)
[--action=ACTION] [--async] [--policy-file=POLICY_FILE]
[--policy-id=POLICY_ID] [--state=STATE]
[--clear-folders | --include-folders=INCLUDE_FOLDERS]
[--clear-locations | --include-locations=INCLUDE_LOCATIONS]
[--clear-projects | --include-projects=INCLUDE_PROJECTS]
[GCLOUD_WIDE_FLAG ...]
@ -104,8 +106,32 @@ FLAGS
stopped
Updates the policy orchestrator to STOPPED state.
Projects to include in the policy orchestrator. If include-projects is
set, clear-projects must not be set.
Folders to include in the policy orchestrator. Comma-separated list of
folder numbers. If --include-folders is set, --clear-folders must not be
set.
At most one of these can be specified:
--clear-folders
Clears included folders from policy orchestrator selectors.
--include-folders=INCLUDE_FOLDERS
Applies policy to selected folders only.
Locations to include in the policy orchestrator, e.g. us-central1-a. If
include-locations is set, clear-locations must not be set.
At most one of these can be specified:
--clear-locations
Clears included locations from policy orchestrator selectors.
--include-locations=INCLUDE_LOCATIONS
Applies policy to selected locations only.
Projects to include in the policy orchestrator. Comma separated list of
project numbers. If include-projects is set, clear-projects must not be
set.
At most one of these can be specified:

2
gcloud/alpha/compute/queued-resources/create
View file

@ -1021,7 +1021,7 @@ OPTIONAL FLAGS
practice to use --image-family when the latest version of an image is
needed.
By default, debian-11 is assumed for this flag.
By default, debian-12 is assumed for this flag.
--source-snapshot=SOURCE_SNAPSHOT
The name of the source disk snapshot that the instance boot disk will