1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 06:47:12 +00:00

gcloud: Fri Jun 2 10:25:45 UTC 2023

This commit is contained in:
Automated 2023-06-02 10:25:45 +00:00
parent d0919dce4f
commit daa9cea776
199 changed files with 7828 additions and 401 deletions

View file

@ -173,7 +173,11 @@ FLAGS
this field.
--no-client-ttl
Clears client TTL value.
(DEPRECATED) Clears client TTL value.
The --no-client-ttl option is deprecated and will be removed in an
upcoming release. If you're currently using this argument, you should
remove it from your workflows.
At most one of these can be specified:
@ -245,7 +249,11 @@ FLAGS
omit this field.
--no-max-ttl
Clears max TTL value.
(DEPRECATED) Clears max TTL value.
The --no-max-ttl option is deprecated and will be removed in an
upcoming release. If you're currently using this argument, you should
remove it from your workflows.
At most one of these can be specified:
@ -334,9 +342,8 @@ FLAGS
(DEPRECATED) Clears serve while stale value.
The --no-serve-while-stale option is deprecated and will be removed
in an upcoming release; use --serve-while-stale instead. If you're
currently using this argument, you should remove it from your
workflows.
in an upcoming release. If you're currently using this argument, you
should remove it from your workflows.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

View file

@ -561,7 +561,11 @@ FLAGS
this field.
--no-client-ttl
Clears client TTL value.
(DEPRECATED) Clears client TTL value.
The --no-client-ttl option is deprecated and will be removed in an
upcoming release. If you're currently using this argument, you should
remove it from your workflows.
At most one of these can be specified:
@ -680,7 +684,11 @@ FLAGS
omit this field.
--no-max-ttl
Clears max TTL value.
(DEPRECATED) Clears max TTL value.
The --no-max-ttl option is deprecated and will be removed in an
upcoming release. If you're currently using this argument, you should
remove it from your workflows.
At most one of these can be specified:
@ -769,9 +777,8 @@ FLAGS
(DEPRECATED) Clears serve while stale value.
The --no-serve-while-stale option is deprecated and will be removed
in an upcoming release; use --serve-while-stale instead. If you're
currently using this argument, you should remove it from your
workflows.
in an upcoming release. If you're currently using this argument, you
should remove it from your workflows.
At most one of these can be specified:

View file

@ -200,14 +200,15 @@ OPTIONAL FLAGS
Manage the properties of a shared reservation.
--share-setting=SHARE_SETTING
Specify if this reservation is shared, and if so, the type of
Specify if this future reservation is shared, and if so, the type of
sharing. If you omit this flag, this value is local (not shared) by
default. SHARE_SETTING must be one of: local, projects.
--share-with=PROJECT,[PROJECT,...]
If this reservation is shared (--share-setting is not local), provide
a list of all of the specific projects that this reservation is
shared with. List must contain project IDs or project numbers.
If this future reservation is shared (--share-setting is not local),
provide a list of all of the specific projects that this future
reservation is shared with. List must contain project IDs or project
numbers.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

View file

@ -11,6 +11,8 @@ SYNOPSIS
--machine-type=MACHINE_TYPE
--maintenance-interval=MAINTENANCE_INTERVAL
--min-cpu-platform=MIN_CPU_PLATFORM]
[--clear-share-settings
| --share-setting=SHARE_SETTING --share-with=PROJECT,[PROJECT,...]]
[--start-time=START_TIME --duration=DURATION | --end-time=END_TIME]
[GCLOUD_WIDE_FLAG ...]
@ -125,6 +127,27 @@ FLAGS
--min-cpu-platform=MIN_CPU_PLATFORM
Optional minimum CPU platform of the reservation to create.
Manage the properties of a shared future reservation.
At most one of these can be specified:
--clear-share-settings
Clear share settings on future reservation. This will result in
non-shared future reservation.
Manage the share settings of a future reservation.
--share-setting=SHARE_SETTING
Specify if this future reservation is shared, and if so, the type
of sharing. If you omit this flag, this value is local (not shared)
by default. SHARE_SETTING must be one of: local, projects.
--share-with=PROJECT,[PROJECT,...]
If this future reservation is shared (--share-setting is not
local), provide a list of all of the specific projects that this
future reservation is shared with. List must contain project IDs or
project numbers.
Manage the time specific properties for requesting future capacity
--start-time=START_TIME

View file

@ -46,12 +46,18 @@ FLAGS
This flag allows you to atomically setup complex autoscalers.
--cool-down-period=COOL_DOWN_PERIOD
The time period that the autoscaler should wait before it starts
collecting information from a new instance. This prevents the
autoscaler from collecting information when the instance is
initializing, during which the collected usage would not be reliable.
The default is 60s. See $ gcloud topic datetimes for information on
duration formats.
The number of seconds that your application takes to initialize on a VM
instance. This is referred to as the initialization period
(https://cloud.google.com/compute/docs/autoscaler#cool_down_period).
Specifying an accurate initialization period improves autoscaler
decisions. For example, when scaling out, the autoscaler ignores data
from VMs that are still initializing because those VMs might not yet
represent normal usage of your application. The default initialization
period is 60 seconds. See $ gcloud topic datetimes for information on
duration formats. Initialization periods might vary because of numerous
factors. We recommend that you test how long your application may take
to initialize. To do this, create a VM and time your application's
startup process.
--cpu-utilization-predictive-method=CPU_UTILIZATION_PREDICTIVE_METHOD
Indicates whether to use a predictive algorithm when scaling based on

View file

@ -0,0 +1,69 @@
NAME
gcloud alpha compute routers get-nat-ip-info - display NAT IP information
in a router
SYNOPSIS
gcloud alpha compute routers get-nat-ip-info NAME [--nat-name=NAT_NAME]
[--region=REGION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) $ gcloud alpha compute routers get-nat-ip-info
shows a mapping of IP:[usage, mode] allocated to each NAT via the specified
router.
EXAMPLES
To show NAT IP information from all NATs in router 'r1' in region
'us-central1', run:
$ gcloud alpha compute routers get-nat-ip-info r1 \
--region=us-central1
To show NAT IP information for a specific NAT 'nat1' in router 'r1' in
region 'us-central1', run:
$ gcloud alpha compute routers get-nat-ip-info r1 \
--region=us-central1 --nat-name="nat1"
POSITIONAL ARGUMENTS
NAME
Name of the router to get NAT IP info.
FLAGS
--nat-name=NAT_NAME
The NAT name to filter out NAT IP information
--region=REGION
Region of the router to get NAT IP info. 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.
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.

View file

@ -44,6 +44,9 @@ COMMANDS
describe
(ALPHA) Describe a Compute Engine router.
get-nat-ip-info
(ALPHA) Display NAT IP information in a router.
get-nat-mapping-info
(ALPHA) Display NAT Mapping information in a router.

View file

@ -5,7 +5,7 @@ NAME
SYNOPSIS
gcloud alpha compute security-policies rules add-preconfig-waf-exclusion
PRIORITY --target-rule-set=TARGET_RULE_SET
PRIORITY --target-rule-set=TARGET_RULE_SET [--region=REGION]
[--request-cookie-to-exclude=[op=OP],[val=VAL]]
[--request-header-to-exclude=[op=OP],[val=VAL]]
[--request-query-param-to-exclude=[op=OP],[val=VAL]]
@ -60,6 +60,18 @@ REQUIRED FLAGS
target for associating request field exclusions. See --target-rule-ids.
OPTIONAL FLAGS
--region=REGION
Region of the security policy to add the exclusion configuration for
preconfigured WAF evaluation. If not specified, you might be prompted
to select a region (interactive mode only).
A list of regions can be fetched by running:
$ gcloud compute regions list
Overrides the default compute/region property value for this command
invocation.
--request-cookie-to-exclude=[op=OP],[val=VAL]
Adds a request cookie to the request field exclusions associated with
the rule set and rule IDs (if given). This specifies a request cookie

View file

@ -31,6 +31,7 @@ SYNOPSIS
[--rate-limit-threshold-count=RATE_LIMIT_THRESHOLD_COUNT]
[--rate-limit-threshold-interval-sec=RATE_LIMIT_THRESHOLD_INTERVAL_SEC]
[--redirect-target=REDIRECT_TARGET] [--redirect-type=REDIRECT_TYPE]
[--region=REGION]
[--request-headers-to-add=[REQUEST_HEADERS_TO_ADD,...]]
[--security-policy=SECURITY_POLICY] [GCLOUD_WIDE_FLAG ...]
@ -259,6 +260,17 @@ OPTIONAL FLAGS
while --redirect-target is given. REDIRECT_TYPE must be one of:
google-recaptcha, external-302.
--region=REGION
Region of the security policy to add. If not specified, you might be
prompted to select a region (interactive mode only).
A list of regions can be fetched by running:
$ gcloud compute regions list
Overrides the default compute/region property value for this command
invocation.
--request-headers-to-add=[REQUEST_HEADERS_TO_ADD,...]
A comma-separated list of header names and header values to add to
requests that match this rule.

View file

@ -4,7 +4,8 @@ NAME
SYNOPSIS
gcloud alpha compute security-policies rules delete [PRIORITY ...]
[--security-policy=SECURITY_POLICY] [GCLOUD_WIDE_FLAG ...]
[--region=REGION] [--security-policy=SECURITY_POLICY]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute security-policies rules delete is used to
@ -23,6 +24,17 @@ POSITIONAL ARGUMENTS
2147483647 is the lowest priority.
FLAGS
--region=REGION
Region of the security policy to delete. If not specified, you might be
prompted to select a region (interactive mode only).
A list of regions can be fetched by running:
$ gcloud compute regions list
Overrides the default compute/region property value for this command
invocation.
--security-policy=SECURITY_POLICY
The security policy that this rule belongs to.

View file

@ -4,7 +4,8 @@ NAME
SYNOPSIS
gcloud alpha compute security-policies rules describe PRIORITY
[--security-policy=SECURITY_POLICY] [GCLOUD_WIDE_FLAG ...]
[--region=REGION] [--security-policy=SECURITY_POLICY]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute security-policies rules describe displays all
@ -23,6 +24,17 @@ POSITIONAL ARGUMENTS
2147483647 is the lowest priority.
FLAGS
--region=REGION
Region of the security policy to describe. If not specified, you might
be prompted to select a region (interactive mode only).
A list of regions can be fetched by running:
$ gcloud compute regions list
Overrides the default compute/region property value for this command
invocation.
--security-policy=SECURITY_POLICY
The security policy that this rule belongs to.

View file

@ -5,7 +5,7 @@ NAME
SYNOPSIS
gcloud alpha compute security-policies rules remove-preconfig-waf-exclusion
PRIORITY --target-rule-set=TARGET_RULE_SET
PRIORITY --target-rule-set=TARGET_RULE_SET [--region=REGION]
[--request-cookie-to-exclude=[op=OP],[val=VAL]]
[--request-header-to-exclude=[op=OP],[val=VAL]]
[--request-query-param-to-exclude=[op=OP],[val=VAL]]
@ -87,6 +87,18 @@ REQUIRED FLAGS
to remove request field exclusions regardless of the target.
OPTIONAL FLAGS
--region=REGION
Region of the security policy to remove the exclusion configuration for
preconfigured WAF evaluation. If not specified, you might be prompted
to select a region (interactive mode only).
A list of regions can be fetched by running:
$ gcloud compute regions list
Overrides the default compute/region property value for this command
invocation.
--request-cookie-to-exclude=[op=OP],[val=VAL]
Removes a request cookie from the existing request field exclusions
associated with the rule set and rule IDs (if given).

View file

@ -21,6 +21,7 @@ SYNOPSIS
[--rate-limit-threshold-count=RATE_LIMIT_THRESHOLD_COUNT]
[--rate-limit-threshold-interval-sec=RATE_LIMIT_THRESHOLD_INTERVAL_SEC]
[--redirect-target=REDIRECT_TARGET] [--redirect-type=REDIRECT_TYPE]
[--region=REGION]
[--request-headers-to-add=[REQUEST_HEADERS_TO_ADD,...]]
[--security-policy=SECURITY_POLICY]
[--expression=EXPRESSION --network-dest-ip-ranges=[DEST_IP_RANGE,...]
@ -209,6 +210,17 @@ FLAGS
while --redirect-target is given. REDIRECT_TYPE must be one of:
google-recaptcha, external-302.
--region=REGION
Region of the security policy to update. If not specified, you might be
prompted to select a region (interactive mode only).
A list of regions can be fetched by running:
$ gcloud compute regions list
Overrides the default compute/region property value for this command
invocation.
--request-headers-to-add=[REQUEST_HEADERS_TO_ADD,...]
A comma-separated list of header names and header values to add to
requests that match this rule.

View file

@ -13,7 +13,7 @@ SYNOPSIS
[--domain-names=[DOMAIN_NAMES,...]] [--enable-proxy-protocol]
[--nat-subnets-region=NAT_SUBNETS_REGION]
[--producer-forwarding-rule-region=PRODUCER_FORWARDING_RULE_REGION]
[--region=REGION] [GCLOUD_WIDE_FLAG ...]
[--reconcile-connections] [--region=REGION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute service-attachments create is used to create
@ -127,6 +127,20 @@ OPTIONAL FLAGS
Alternatively, the region can be stored in the environment variable
CLOUDSDK_COMPUTE_REGION.
--reconcile-connections
Determines whether to apply changes to consumer accept or reject lists
to existing connections or only to new connections.
If false, existing endpoints with a connection status of ACCEPTED or
REJECTED are not updated.
If true, existing endpoints with a connection status of ACCEPTED or
REJECTED are updated based on the connection policy update. For
example, if a project or network is removed from the
--consumer-accept-list and added to --consumer-reject-list, all the
endpoints in that project or network with the ACCEPTED state are set to
REJECTED.
--region=REGION
Region of the service attachment to create. If not specified, you might
be prompted to select a region (interactive mode only).

View file

@ -9,8 +9,8 @@ SYNOPSIS
[--consumer-reject-list=[REJECT_LIST,...]] [--description=DESCRIPTION]
[--[no-]enable-proxy-protocol]
[--nat-subnets=NAT_SUBNETS,[NAT_SUBNETS,...]]
[--nat-subnets-region=NAT_SUBNETS_REGION] [--region=REGION]
[GCLOUD_WIDE_FLAG ...]
[--nat-subnets-region=NAT_SUBNETS_REGION]
[--[no-]reconcile-connections] [--region=REGION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute service-attachments update is used to update
@ -93,6 +93,23 @@ FLAGS
set to the region of the service attachment. Overrides the default
compute/region property value for this command invocation.
--[no-]reconcile-connections
Determines whether to apply changes to consumer accept or reject lists
to existing connections or only to new connections.
If false, existing endpoints with a connection status of ACCEPTED or
REJECTED are not updated.
If true, existing endpoints with a connection status of ACCEPTED or
REJECTED are updated based on the connection policy update. For
example, if a project or network is removed from the
--consumer-accept-list and added to --consumer-reject-list, all the
endpoints in that project or network with the ACCEPTED state are set to
REJECTED.
Use --reconcile-connections to enable and --no-reconcile-connections to
disable.
--region=REGION
Region of the service attachment to update. If not specified, you might
be prompted to select a region (interactive mode only).

View file

@ -64,6 +64,9 @@ COMMANDS
stop
(ALPHA) Stop a Cloud TPU VM node.
update
(ALPHA) Update a Cloud TPU VM node.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct

View file

@ -0,0 +1,115 @@
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 ...]
DESCRIPTION
(ALPHA) Update a Cloud TPU VM node.
EXAMPLES
To modify a TPU VM node with ID my-tpu in the default user project, network
and compute/zone (with other defaults supplied by API) by adding labels k0,
with value value0 and label k1 with value value1 and removing labels with
key k2, run:
$ gcloud alpha compute tpus tpu-vm update my-tpu \
--update-labels=k0=value0,k1=value1 --remove-labels=k2
Labels can be used to identify the TPU VM node. To list TPU VM nodes with
the k1:value1 label, run:
$ gcloud alpha compute tpus tpu-vm list --filter='labels.k1=value1'
To list only the labels when describing a resource, use --format to filter
the result:
$ gcloud alpha compute tpus tpu-vm describe my-tpu \
--format="default(labels)"
POSITIONAL ARGUMENTS
Tpu resource - Name of the Cloud TPU VM node to update. The arguments in
this group can be used to specify the attributes of this 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 tpu 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.
TPU
ID of the tpu or fully qualified identifier for the tpu.
To set the tpu attribute:
▸ provide the argument tpu on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--zone=ZONE
Zone of the Cloud TPU.
If not specified, will use default compute/zone.
To set the zone attribute:
▸ provide the argument tpu on the command line with a fully
specified name;
▸ provide the argument --zone on the command line;
▸ set the property compute/zone.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--update-labels=[KEY=VALUE,...]
Resource labels to update that represent user-provided metadata. If a
label exists, its value is modified. Otherwise, a new label is created.
See https://cloud.google.com/compute/docs/labeling-resources for
details.
At most one of these can be specified:
--clear-labels
Remove all labels. If --update-labels is also specified then
--clear-labels is applied first.
For example, to remove all labels:
$ gcloud alpha compute tpus tpu-vm update --clear-labels
To remove all existing labels and create two new labels, 'foo' and
'baz':
$ gcloud alpha compute tpus tpu-vm 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-labels is also specified then
--update-labels is applied first.
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 tpu/v2alpha1 API. The full documentation for this API
can be found at: https://cloud.google.com/tpu/
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.