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

gcloud: Wed Aug 14 09:38:18 UTC 2024

This commit is contained in:
Automated 2024-08-14 09:38:18 +00:00
parent 7fe34c472b
commit d35819d273
105 changed files with 5241 additions and 346 deletions

View file

@ -0,0 +1,187 @@
NAME
gcloud alpha network-security mirroring-deployments create - create a
Mirroring Deployment
SYNOPSIS
gcloud alpha network-security mirroring-deployments create
(MIRRORING_DEPLOYMENT : --location=LOCATION)
(--forwarding-rule=FORWARDING_RULE
: --forwarding-rule-location=FORWARDING_RULE_LOCATION)
(--mirroring-deployment-group=MIRRORING_DEPLOYMENT_GROUP
: --mirroring-deployment-group-location=MIRRORING_DEPLOYMENT_GROUP_LOCATION)
[--async] [--labels=[KEY=VALUE,...]]
[--max-wait=MAX_WAIT; default="20m"] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a mirroring deployment. Successful creation of a deployment
results in a deployment in ACTIVE state. Check the progress of deployment
creation by using gcloud network-security mirroring-deployments list.
For more examples, refer to the EXAMPLES section below.
EXAMPLES
To create a mirroring deployment called my-deployment, in project ID
my-project and zone us-central1-a, run: $ gcloud alpha network-security mirroring-deployments create \
my-deployment --project=my-project --location=us-central1-a \
--deployment-group-location=global \
--forwarding-rule=my-forwarding-rule \
--forwarding-rule-location=us-central1 \
--mirroring-deployment-group=my-deployment-group
OR
$ gcloud alpha network-security mirroring-deployments create \
my-deployment --project=my-project --location=us-central1-a \
--forwarding-rule=projects/my-project/regions/us-central1/\
forwardingRules/my-forwarding-rule \
--mirroring-deployment-group=projects/my-project/locations/\
global/mirroringDeploymentGroups/my-deployment-group
OR
$ gcloud alpha network-security mirroring-deployments create \
projects/my-project/locations/us-central1/mirroringDeployments/\
my-deployment \
--forwarding-rule=projects/my-project/regions/us-central1/\
forwardingRules/my-forwarding-rule \
--mirroring-deployment-group=projects/my-project/locations/\
global/mirroringDeploymentGroups/my-deployment-group
POSITIONAL ARGUMENTS
Mirroring deployment resource - Mirroring Deployment. 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 MIRRORING_DEPLOYMENT 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.
MIRRORING_DEPLOYMENT
ID of the mirroring deployment or fully qualified identifier for the
mirroring deployment.
To set the deployment-id attribute:
▸ provide the argument MIRRORING_DEPLOYMENT on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the mirroring deployment.
To set the location attribute:
▸ provide the argument MIRRORING_DEPLOYMENT on the command line
with a fully specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
ForwardingRule resource - Mirroring Deployment Forwarding Rule. 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 --forwarding-rule 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.
--forwarding-rule=FORWARDING_RULE
ID of the forwardingRule or fully qualified identifier for the
forwardingRule.
To set the forwarding-rule-id attribute:
▸ provide the argument --forwarding-rule on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--forwarding-rule-location=FORWARDING_RULE_LOCATION
The Cloud region for the forwardingRule.
To set the forwarding-rule-location attribute:
▸ provide the argument --forwarding-rule on the command line with a
fully specified name;
▸ provide the argument --forwarding-rule-location on the command
line.
Mirroring deployment group resource - Mirroring Deployment Group. 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 --mirroring-deployment-group 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.
--mirroring-deployment-group=MIRRORING_DEPLOYMENT_GROUP
ID of the mirroring deployment group or fully qualified identifier
for the mirroring deployment group.
To set the id attribute:
▸ provide the argument --mirroring-deployment-group on the command
line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--mirroring-deployment-group-location=MIRRORING_DEPLOYMENT_GROUP_LOCATION
Location of the mirroring deployment group.
To set the location attribute:
▸ provide the argument --mirroring-deployment-group on the command
line with a fully specified name;
▸ provide the argument --mirroring-deployment-group-location on the
command line;
▸ provide the argument --location on the command line;
▸ provide the argument
networksecurity.projects.locations.mirroringDeployments on the
command line with a fully specified name.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete. The default is True. Enabled by default, use --no-async to
disable.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--max-wait=MAX_WAIT; default="20m"
Time to synchronously wait for the operation to complete, after which
the operation continues asynchronously. Ignored if --no-async isn't
specified. See $ gcloud topic datetimes for information on time
formats.
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. This variant is also available:
$ gcloud beta network-security mirroring-deployments create

View file

@ -0,0 +1,82 @@
NAME
gcloud alpha network-security mirroring-deployments delete - delete a
Mirroring Deployment
SYNOPSIS
gcloud alpha network-security mirroring-deployments delete
(MIRRORING_DEPLOYMENT : --location=LOCATION) [--async]
[--max-wait=MAX_WAIT; default="20m"] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a mirroring deployment. Check the progress of deployment
deletion by using gcloud network-security mirroring-deployments list.
For more examples, refer to the EXAMPLES section below.
EXAMPLES
To delete a mirroring deployment called my-deployment in location
us-central1, run:
$ gcloud alpha network-security mirroring-deployments delete \
my-deployment --location=us-central1-a --project=my-project
POSITIONAL ARGUMENTS
Mirroring deployment resource - Mirroring Deployment. 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 MIRRORING_DEPLOYMENT 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.
MIRRORING_DEPLOYMENT
ID of the mirroring deployment or fully qualified identifier for the
mirroring deployment.
To set the deployment-id attribute:
▸ provide the argument MIRRORING_DEPLOYMENT on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the mirroring deployment.
To set the location attribute:
▸ provide the argument MIRRORING_DEPLOYMENT 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. The default is True. Enabled by default, use --no-async to
disable.
--max-wait=MAX_WAIT; default="20m"
Time to synchronously wait for the operation to complete, after which
the operation continues asynchronously. Ignored if --no-async isn't
specified. See $ gcloud topic datetimes for information on time
formats.
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. This variant is also available:
$ gcloud beta network-security mirroring-deployments delete

View file

@ -0,0 +1,74 @@
NAME
gcloud alpha network-security mirroring-deployments describe - describe a
Mirroring Deployment
SYNOPSIS
gcloud alpha network-security mirroring-deployments describe
(MIRRORING_DEPLOYMENT : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a mirroring deployment.
For more examples, refer to the EXAMPLES section below.
EXAMPLES
To get a description of a mirroring deployment called my-deployment in zone
us-central1-a, run:
$ gcloud alpha network-security mirroring-deployments describe \
my-deployment --location=us-central1-a --project=my-project
OR
$ gcloud alpha network-security mirroring-deployments describe \
projects/my-project/locations/us-central1-a/\
mirroringDeployments/my-deployment
POSITIONAL ARGUMENTS
Mirroring deployment resource - Mirroring Deployment. 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 MIRRORING_DEPLOYMENT 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.
MIRRORING_DEPLOYMENT
ID of the mirroring deployment or fully qualified identifier for the
mirroring deployment.
To set the deployment-id attribute:
▸ provide the argument MIRRORING_DEPLOYMENT on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the mirroring deployment.
To set the location attribute:
▸ provide the argument MIRRORING_DEPLOYMENT 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.
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 network-security mirroring-deployments describe

View file

@ -0,0 +1,45 @@
NAME
gcloud alpha network-security mirroring-deployments - manage Mirroing
Deployment resources
SYNOPSIS
gcloud alpha network-security mirroring-deployments COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) This class provides commands for managing Mirroring Deployments.
Attributes: category (str): The category under which this command group
falls.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) Create a Mirroring Deployment.
delete
(ALPHA) Delete a Mirroring Deployment.
describe
(ALPHA) Describe a Mirroring Deployment.
list
(ALPHA) List Mirroring Deployments.
update
(ALPHA) Update a Mirroring Deployment.
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 network-security mirroring-deployments

View file

@ -0,0 +1,95 @@
NAME
gcloud alpha network-security mirroring-deployments list - list Mirroring
Deployments
SYNOPSIS
gcloud alpha network-security mirroring-deployments list
[--location=LOCATION] [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List mirroring deployments.
For more examples, refer to the EXAMPLES section below.
EXAMPLES
To list mirroring deployments in project my-project and zone us-central1-a,
run:
$ gcloud alpha network-security mirroring-deployments list \
--project=my-project --location=us-central1-a
To list mirroring deployments from all zones, run:
$ gcloud alpha network-security mirroring-deployments list \
--project=my-project --location=-
FLAGS
Location resource - Zone of the deployment 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;
◆ Location of the Mirroring Deployment. Defaults to a wildcard with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--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;
▸ Location of the Mirroring Deployment. Defaults to a wildcard.
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.
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 network-security mirroring-deployments list

View file

@ -0,0 +1,125 @@
NAME
gcloud alpha network-security mirroring-deployments update - update a
Mirroring Deployment
SYNOPSIS
gcloud alpha network-security mirroring-deployments update
(MIRRORING_DEPLOYMENT : --location=LOCATION) [--async]
[--max-wait=MAX_WAIT; default="20m"] [--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update a mirroring deployment. Check the progress of deployment
update by using gcloud network-security mirroring-deployments list.
For examples refer to the EXAMPLES section below.
EXAMPLES
To update labels k1 and k2, run:
$ gcloud alpha network-security mirroring-deployments update \
my-deployment --project=my-project --location=us-central1-a \
--update-labels=k1=v1,k2=v2
To remove labels k3 and k4, run:
$ gcloud alpha network-security mirroring-deployments update \
my-deployment --project=my-project --location=us-central1-a \
--remove-labels=k3,k4
To clear all labels from the mirroring deployment, run:
$ gcloud alpha network-security mirroring-deployments update \
my-deploymen --project=my-project --location=us-central1-a \
--clear-labels
POSITIONAL ARGUMENTS
Mirroring deployment resource - Mirroring Deployment. 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 MIRRORING_DEPLOYMENT 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.
MIRRORING_DEPLOYMENT
ID of the mirroring deployment or fully qualified identifier for the
mirroring deployment.
To set the deployment-id attribute:
▸ provide the argument MIRRORING_DEPLOYMENT on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the mirroring deployment.
To set the location attribute:
▸ provide the argument MIRRORING_DEPLOYMENT 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. The default is True. Enabled by default, use --no-async to
disable.
--max-wait=MAX_WAIT; default="20m"
Time to synchronously wait for the operation to complete, after which
the operation continues asynchronously. Ignored if --no-async isn't
specified. See $ gcloud topic datetimes for information on time
formats.
--update-labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to update. If a label exists, its value
is modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
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 network-security mirroring-deployments update \
--clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud alpha network-security mirroring-deployments 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.
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 network-security mirroring-deployments update