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

gcloud: Wed May 1 09:26:55 UTC 2024

This commit is contained in:
Automated 2024-05-01 09:26:55 +00:00
parent 3740758467
commit 48fac7efd4
454 changed files with 11765 additions and 12790 deletions

View file

@ -33,6 +33,9 @@ GROUPS
service-bindings
Manage Network Services Bindings.
service-lb-policies
Manage Network Services ServiceLbPolicies.
tcp-routes
Manage Network Services TcpRoutes.

View file

@ -0,0 +1,118 @@
NAME
gcloud network-services service-lb-policies create - create a service LB
policy
SYNOPSIS
gcloud network-services service-lb-policies create
(SERVICE_LB_POLICY : --location=LOCATION) [--async]
[--auto-capacity-drain] [--description=DESCRIPTION]
[--failover-health-threshold=FAILOVER_HEALTH_THRESHOLD]
[--load-balancing-algorithm=LOAD_BALANCING_ALGORITHM;
default="waterfall-by-region"] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a new service LB policy with the given name.
EXAMPLES
Create a service LB policy with the name 'my-service-lb-policy', load
balancing algorithm 'waterfall-by-region', and location 'global'.
$ gcloud network-services service-lb-policies create \
my-service-lb-policy \
--load-balancing-algorithm=waterfall-by-region \
--location="global"
POSITIONAL ARGUMENTS
Service lb policy resource - Name of the service LB policy to be created.
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 service_lb_policy on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
SERVICE_LB_POLICY
ID of the service lb policy or fully qualified identifier for the
service lb policy.
To set the service_lb_policy attribute:
▸ provide the argument service_lb_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument service_lb_policy on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--auto-capacity-drain
If specified, an unhealthy MIG/NEG will be removed from Global load
balancing and traffic routing for the service. A MIG/NEG is considered
to be unhealthy if less than 25% of the instance/endpoints in the
MIG/NEG are healthy. autoCapacityDrain will never drain more than 50%
of the configured MIGs/NEGs of a Backend Service.
--description=DESCRIPTION
The description for the service LB policy.
--failover-health-threshold=FAILOVER_HEALTH_THRESHOLD
The percentage threshold that a load balancer will begin to send
traffic to failover backends. If the percentage of endpoints in a
MIG/NEG is smaller than this value, traffic would be sent to failover
backends if possible. This field should be set to a value between 1 and
99. The default value is 50 for Global external HTTP(S) load balancer
(classic) and Proxyless service mesh, and 70 for others.
--load-balancing-algorithm=LOAD_BALANCING_ALGORITHM; default="waterfall-by-region"
The global load balancing algorithm to be used.
LOAD_BALANCING_ALGORITHM must be one of:
spray-to-region
Spread the traffic from each client to all the MIGs/NEGs in a
region.
spray-to-world
Balance traffic across all backends across the world proportionally
based on capacity.
waterfall-by-region
Direct traffic to the nearest region with endpoints and capacity
before spilling over to other regions.
waterfall-by-zone
Attempt to keep traffic in a single zone closest to the client,
before spilling over to other zones.
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 networkservices/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/networking
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies create
$ gcloud beta network-services service-lb-policies create

View file

@ -0,0 +1,74 @@
NAME
gcloud network-services service-lb-policies delete - delete service LB
policy
SYNOPSIS
gcloud network-services service-lb-policies delete
(SERVICE_LB_POLICY : --location=LOCATION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete the specified service LB policy.
EXAMPLES
To delete a service LB policy named my-service-lb-policy, run:
$ gcloud network-services service-lb-policies delete \
my-service-lb-policy --location=global
POSITIONAL ARGUMENTS
Service lb policy resource - Name of the service LB policy you want to
delete. 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 service_lb_policy on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
SERVICE_LB_POLICY
ID of the service lb policy or fully qualified identifier for the
service lb policy.
To set the service_lb_policy attribute:
▸ provide the argument service_lb_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument service_lb_policy on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 networkservices/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/networking
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies delete
$ gcloud beta network-services service-lb-policies delete

View file

@ -0,0 +1,68 @@
NAME
gcloud network-services service-lb-policies describe - describe a service
LB policy
SYNOPSIS
gcloud network-services service-lb-policies describe
(SERVICE_LB_POLICY : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Show details of a service LB policy.
EXAMPLES
Show details about a service LB policy named 'my-service-lb-policy'.
$ gcloud network-services service-lb-policies describe \
my-service-lb-policy --location=global
POSITIONAL ARGUMENTS
Service lb policy resource - Name of the service LB policy to be
described. 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 service_lb_policy on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
SERVICE_LB_POLICY
ID of the service lb policy or fully qualified identifier for the
service lb policy.
To set the service_lb_policy attribute:
▸ provide the argument service_lb_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument service_lb_policy on the command line with a
fully specified name;
▸ provide the argument --location 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 networkservices/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/networking
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies describe
$ gcloud beta network-services service-lb-policies describe

View file

@ -0,0 +1,79 @@
NAME
gcloud network-services service-lb-policies export - export service LB
policy
SYNOPSIS
gcloud network-services service-lb-policies export
(SERVICE_LB_POLICY : --location=LOCATION) [--destination=DESTINATION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Export a service LB policy.
EXAMPLES
To export a service LB policy named my-service-lb-policy to a YAML file,
run:
$ gcloud network-services service-lb-policies export \
my-service-lb-policy --destination=my-service-lb-policy.yaml \
--location=global
POSITIONAL ARGUMENTS
Service lb policy resource - Name of the service LB policy to export. 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 service_lb_policy on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
SERVICE_LB_POLICY
ID of the service lb policy or fully qualified identifier for the
service lb policy.
To set the service_lb_policy attribute:
▸ provide the argument service_lb_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument service_lb_policy on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--destination=DESTINATION
Path to a YAML file where the configuration will be exported. The
exported data will not contain any output-only fields. Alternatively,
you may omit this flag to write to standard output. For a schema
describing the export/import format, see
$CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
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 networkservices/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/networking
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies export
$ gcloud beta network-services service-lb-policies export

View file

@ -0,0 +1,46 @@
NAME
gcloud network-services service-lb-policies - manage Network Services
ServiceLbPolicies
SYNOPSIS
gcloud network-services service-lb-policies COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Network Services ServiceLbPolicies.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a service LB policy.
delete
Delete service LB policy.
describe
Describe a service LB policy.
export
Export service LB policy.
import
Import service LB policy.
list
List ServiceLbPolicies.
update
Update a service LB policy.
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies
$ gcloud beta network-services service-lb-policies

View file

@ -0,0 +1,86 @@
NAME
gcloud network-services service-lb-policies import - import service LB
policy
SYNOPSIS
gcloud network-services service-lb-policies import
(SERVICE_LB_POLICY : --location=LOCATION) [--async] [--source=SOURCE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Import a service LB policy.
EXAMPLES
To import a service LB policy named my-service-lb-policy from a YAML file,
run:
$ gcloud network-services service-lb-policies import \
my-service-lb-policy --source=my-service-lb-policy.yaml \
--location=global
POSITIONAL ARGUMENTS
Service lb policy resource - Name of the service LB policy to import. 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 service_lb_policy on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
SERVICE_LB_POLICY
ID of the service lb policy or fully qualified identifier for the
service lb policy.
To set the service_lb_policy attribute:
▸ provide the argument service_lb_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument service_lb_policy on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--source=SOURCE
Path to a YAML file containing the configuration export data. The YAML
file must not contain any output-only fields. Alternatively, you may
omit this flag to read from standard input. For a schema describing the
export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
$CLOUDSDKROOT is can be obtained with the following command:
$ gcloud info --format='value(installation.sdk_root)'
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 networkservices/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/networking
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies import
$ gcloud beta network-services service-lb-policies import

View file

@ -0,0 +1,87 @@
NAME
gcloud network-services service-lb-policies list - list ServiceLbPolicies
SYNOPSIS
gcloud network-services service-lb-policies list --location=LOCATION
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List all ServiceLbPolicies in the specified location of the current
project.
EXAMPLES
To list service lb policies in the current project, run:
$ gcloud network-services service-lb-policies list --location=global
REQUIRED FLAGS
Location resource - The project of the service LB policies to display.
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 --location on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line.
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 networkservices/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/networking
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies list
$ gcloud beta network-services service-lb-policies list

View file

@ -0,0 +1,117 @@
NAME
gcloud network-services service-lb-policies update - update a service LB
policy
SYNOPSIS
gcloud network-services service-lb-policies update
(SERVICE_LB_POLICY : --location=LOCATION) [--async]
[--auto-capacity-drain] [--description=DESCRIPTION]
[--failover-health-threshold=FAILOVER_HEALTH_THRESHOLD]
[--load-balancing-algorithm=LOAD_BALANCING_ALGORITHM;
default="waterfall-by-region"] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update the detail of a service LB Policy.
EXAMPLES
Update load-balancing-algorithm of a service LB policy named
my-service-lb-policy:
$ gcloud network-services service-lb-policies update \
my-service-lb-policy \
--load-balancing-algorithm=waterfall-by-zone
POSITIONAL ARGUMENTS
Service lb policy resource - Name of the service LB policy to be updated.
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 service_lb_policy on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
SERVICE_LB_POLICY
ID of the service lb policy or fully qualified identifier for the
service lb policy.
To set the service_lb_policy attribute:
▸ provide the argument service_lb_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location Id.
To set the location attribute:
▸ provide the argument service_lb_policy on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--auto-capacity-drain
If specified, an unhealthy MIG/NEG will be removed from Global load
balancing and traffic routing for the service. A MIG/NEG is considered
to be unhealthy if less than 25% of the instance/endpoints in the
MIG/NEG are healthy. autoCapacityDrain will never drain more than 50%
of the configured MIGs/NEGs of a Backend Service.
--description=DESCRIPTION
The description for the service LB policy.
--failover-health-threshold=FAILOVER_HEALTH_THRESHOLD
The percentage threshold that a load balancer will begin to send
traffic to failover backends. If the percentage of endpoints in a
MIG/NEG is smaller than this value, traffic would be sent to failover
backends if possible. This field should be set to a value between 1 and
99. The default value is 50 for Global external HTTP(S) load balancer
(classic) and Proxyless service mesh, and 70 for others.
--load-balancing-algorithm=LOAD_BALANCING_ALGORITHM; default="waterfall-by-region"
The global load balancing algorithm to be used.
LOAD_BALANCING_ALGORITHM must be one of:
spray-to-region
Spread the traffic from each client to all the MIGs/NEGs in a
region.
spray-to-world
Balance traffic across all backends across the world proportionally
based on capacity.
waterfall-by-region
Direct traffic to the nearest region with endpoints and capacity
before spilling over to other regions.
waterfall-by-zone
Attempt to keep traffic in a single zone closest to the client,
before spilling over to other zones.
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 networkservices/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/networking
NOTES
These variants are also available:
$ gcloud alpha network-services service-lb-policies update
$ gcloud beta network-services service-lb-policies update