imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-15 01:15:34 +00:00
Code Activity

gcloud: Wed Sep 28 10:27:48 UTC 2022

Browse source
This commit is contained in:
Automated 2022-09-28 10:27:48 +00:00
parent 29683b8af4
commit ffb9e43995
Failed to extract signature
198 changed files with 4783 additions and 367 deletions
Download patch file Download diff file Expand all files Collapse all files

3
gcloud/beta/active-directory/domains/help
View file

@ -18,6 +18,9 @@ GROUPS
backups
(BETA) Managed Microsoft AD Backups.
migration
(BETA) Manage Managed Microsoft AD domains.
sql-integrations
(BETA) Discover Cloud SQL integrations with Managed Microsoft AD
domains.

62
gcloud/beta/active-directory/domains/migration/check-permissions Normal file
View file

@ -0,0 +1,62 @@
NAME
gcloud beta active-directory domains migration check-permissions - check
existing permissions on a Managed Microsoft AD domain for domain
migration
SYNOPSIS
gcloud beta active-directory domains migration check-permissions DOMAIN
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Check existing permissions on a Managed Microsoft AD domain for
domain migration.
This command can fail for the following reasons:
▪ The specified domain doesn't exist.
▪ The specified domain is either being created or updated.
▪ The active account doesn't have permission to check migration
permissions on the specified domain.
EXAMPLES
The following command checks migration permissions on the domain
my-domain.com in project my-project.
$ gcloud beta active-directory domains migration check-permissions \
my-domain.com --project=my-project
POSITIONAL ARGUMENTS
Domain resource - Name of the Managed Microsoft AD domain for which you
want to check migration permissions. 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 domain 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.
DOMAIN
ID of the domain or fully qualified identifier for the domain. To set
the domain attribute:
▸ provide the argument domain 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 managedidentities/v1beta1 API. The full documentation
for this API can be found at:
https://cloud.google.com/managed-microsoft-ad/
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha active-directory domains migration check-permissions

66
gcloud/beta/active-directory/domains/migration/disable Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud beta active-directory domains migration disable - disable domain
migration permissions on a Managed Microsoft AD domain
SYNOPSIS
gcloud beta active-directory domains migration disable DOMAIN [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Disable domain migration permissions on a Managed Microsoft AD
domain.
This command can fail for the following reasons:
▪ The specified domain doesn't exist.
▪ The specified domain is either being created or updated.
▪ The active account doesn't have permission to disable migration
permissions on the specified domain.
EXAMPLES
The following command disables migration permissions on the domain
my-domain.com in project my-project.
$ gcloud beta active-directory domains migration disable \
my-domain.com --project=my-project --async
POSITIONAL ARGUMENTS
Domain resource - Name of the Managed Microsoft AD domain on which you
want to disable migration permissions. 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 domain 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.
DOMAIN
ID of the domain or fully qualified identifier for the domain. To set
the domain attribute:
▸ provide the argument domain 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 managedidentities/v1beta1 API. The full documentation
for this API can be found at:
https://cloud.google.com/managed-microsoft-ad/
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha active-directory domains migration disable

81
gcloud/beta/active-directory/domains/migration/enable Normal file
View file

@ -0,0 +1,81 @@
NAME
gcloud beta active-directory domains migration enable - enable domain
migration permissions on a Managed Microsoft AD domain
SYNOPSIS
gcloud beta active-directory domains migration enable DOMAIN
--onprem-domains=[ONPREM_DOMAINS,...] [--async]
[--disable-sid-filtering-domains=[DISABLE_SID_FILTERING_DOMAINS,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Enable domain migration permissions on a Managed Microsoft AD
domain.
This command can fail for the following reasons:
▪ The specified domain doesn't exist.
▪ The specified domain is either being created or updated.
▪ The active account doesn't have permission to enable migration
permissions on the specified domain.
EXAMPLES
The following command enables migration permissions on the domain
my-domain.com in project my-project for two on-premises domains
onprem-domain-1.com and onprem-domain-2.com, with SID Filtering disabled
for onprem-domain-1.com.
$ gcloud beta active-directory domains migration enable \
my-domain.com \
--onprem-domains=onprem-domain-1.com,onprem-domain-2.com \
--disable-sid-filtering-domains=onprem-domain-1.com \
--project=my-project --async
POSITIONAL ARGUMENTS
Domain resource - Name of the Managed Microsoft AD domain on which you
want to enable migration permissions. 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 domain 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.
DOMAIN
ID of the domain or fully qualified identifier for the domain. To set
the domain attribute:
▸ provide the argument domain on the command line.
REQUIRED FLAGS
--onprem-domains=[ONPREM_DOMAINS,...]
List of trusted domains that are being migrated.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--disable-sid-filtering-domains=[DISABLE_SID_FILTERING_DOMAINS,...]
List of migrating domains on which SID Filtering must be disabled. The
list is empty by default.
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 managedidentities/v1beta1 API. The full documentation
for this API can be found at:
https://cloud.google.com/managed-microsoft-ad/
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha active-directory domains migration enable

37
gcloud/beta/active-directory/domains/migration/help Normal file
View file

@ -0,0 +1,37 @@
NAME
gcloud beta active-directory domains migration - manage Managed Microsoft
AD domains
SYNOPSIS
gcloud beta active-directory domains migration COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Managed Microsoft AD domains.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
check-permissions
(BETA) Check existing permissions on a Managed Microsoft AD domain for
domain migration.
disable
(BETA) Disable domain migration permissions on a Managed Microsoft AD
domain.
enable
(BETA) Enable domain migration permissions on a Managed Microsoft AD
domain.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha active-directory domains migration

3
gcloud/beta/asset/help
View file

@ -21,6 +21,9 @@ GROUPS
operations
(BETA) Manage Cloud Asset Inventory operations.
saved-queries
(BETA) Manage Cloud Asset Inventory saved queries.
COMMANDS
COMMAND is one of the following:

79
gcloud/beta/asset/saved-queries/create Normal file
View file

@ -0,0 +1,79 @@
NAME
gcloud beta asset saved-queries create - create a Cloud Asset Inventory
saved query
SYNOPSIS
gcloud beta asset saved-queries create QUERY_ID
--query-file-path=QUERY_FILE_PATH
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID) [--description=DESCRIPTION] [--labels=LABELS]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create a new Cloud Asset Inventory saved query.
EXAMPLES
To create a new saved 'query-id-1' in project 'p1' with the content of the
query stored locally in query.json, run:
$ gcloud beta asset saved-queries create query-id-1 --project=p1 \
--query-file-path=./query-content.json \
--description="This is an example saved query with query id \
query-id-1" --labels="key1=val1"
POSITIONAL ARGUMENTS
QUERY_ID
Saved query identifier being created. It must be unique under the
specified parent resource project/folder/organization.
REQUIRED FLAGS
--query-file-path=QUERY_FILE_PATH
Path to JSON or YAML file that contains the query.
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the saved query.
--organization=ORGANIZATION_ID
Organization of the saved query.
--project=PROJECT_ID
Project of the saved query.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
OPTIONAL FLAGS
--description=DESCRIPTION
A string describing the query.
--labels=LABELS
A key/value pair to attach to the query, which can be used in search
and list operations. You can include up to 10 labels for each saved
query.
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 beta and might change without notice. These
variants are also available:
$ gcloud asset saved-queries create
$ gcloud alpha asset saved-queries create

61
gcloud/beta/asset/saved-queries/delete Normal file
View file

@ -0,0 +1,61 @@
NAME
gcloud beta asset saved-queries delete - delete a Cloud Asset Inventory
saved query
SYNOPSIS
gcloud beta asset saved-queries delete QUERY_ID
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Delete a Cloud Asset Inventory saved query.
EXAMPLES
To delete a saved query with id 'query1' in project 'p1', run:
$ gcloud beta asset saved-queries delete query1 --project=p1
POSITIONAL ARGUMENTS
QUERY_ID
Asset saved query identifier to be deleted. It must be unique under the
specified parent resource project/folder/organization.
REQUIRED FLAGS
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the saved query.
--organization=ORGANIZATION_ID
Organization of the saved query.
--project=PROJECT_ID
Project of the saved query.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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 beta and might change without notice. These
variants are also available:
$ gcloud asset saved-queries delete
$ gcloud alpha asset saved-queries delete

61
gcloud/beta/asset/saved-queries/describe Normal file
View file

@ -0,0 +1,61 @@
NAME
gcloud beta asset saved-queries describe - describe a Cloud Asset Inventory
saved query
SYNOPSIS
gcloud beta asset saved-queries describe QUERY_ID
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe a Cloud Asset Inventory saved query.
EXAMPLES
To describe a saved query with query id 'query1' in project 'p1', run:
$ gcloud beta asset saved-queries describe query1 --project=p1
POSITIONAL ARGUMENTS
QUERY_ID
Asset Saved Query identifier being described. It must be unique under
the specified parent resource: project/folder/organization.
REQUIRED FLAGS
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the saved query.
--organization=ORGANIZATION_ID
Organization of the saved query.
--project=PROJECT_ID
Project of the saved query.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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 beta and might change without notice. These
variants are also available:
$ gcloud asset saved-queries describe
$ gcloud alpha asset saved-queries describe

41
gcloud/beta/asset/saved-queries/help Normal file
View file

@ -0,0 +1,41 @@
NAME
gcloud beta asset saved-queries - manage Cloud Asset Inventory saved
queries
SYNOPSIS
gcloud beta asset saved-queries COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud Asset Inventory saved queries.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(BETA) Create a Cloud Asset Inventory saved query.
delete
(BETA) Delete a Cloud Asset Inventory saved query.
describe
(BETA) Describe a Cloud Asset Inventory saved query.
list
(BETA) List Cloud Asset Inventory saved query.
update
(BETA) Update an existing Cloud Asset Inventory saved query.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud asset saved-queries
$ gcloud alpha asset saved-queries

56
gcloud/beta/asset/saved-queries/list Normal file
View file

@ -0,0 +1,56 @@
NAME
gcloud beta asset saved-queries list - list Cloud Asset Inventory saved
query
SYNOPSIS
gcloud beta asset saved-queries list
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List Cloud Asset Inventory saved queries under a parent resource.
EXAMPLES
To list saved queries in organization 'org1', run:
$ gcloud beta asset saved-queries list --organization=org1
REQUIRED FLAGS
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the saved query.
--organization=ORGANIZATION_ID
Organization of the saved query.
--project=PROJECT_ID
Project of the saved query.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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 beta and might change without notice. These
variants are also available:
$ gcloud asset saved-queries list
$ gcloud alpha asset saved-queries list

102
gcloud/beta/asset/saved-queries/update Normal file
View file

@ -0,0 +1,102 @@
NAME
gcloud beta asset saved-queries update - update an existing Cloud Asset
Inventory saved query
SYNOPSIS
gcloud beta asset saved-queries update QUERY_ID
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID) [--description=DESCRIPTION]
[--query-file-path=QUERY_FILE_PATH] [--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update an existing Cloud Asset Inventory saved query.
EXAMPLES
To update the content of an existing saved query, run:
$ gcloud beta asset saved-queries update query-id-1 --project=p1 \
--query-file-path=./query-content.json \
--description="updating a query with query id query-id-1" \
--update-labels="key1=val1"
POSITIONAL ARGUMENTS
QUERY_ID
Saved query identifier being updated. It must be unique under the
specified parent resource project/folder/organization.
REQUIRED FLAGS
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the saved query.
--organization=ORGANIZATION_ID
Organization of the saved query.
--project=PROJECT_ID
Project of the saved query.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
OPTIONAL FLAGS
--description=DESCRIPTION
A string describing the query.
--query-file-path=QUERY_FILE_PATH
Path to JSON or YAML file that contains the query.
--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 beta asset saved-queries update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud beta asset saved-queries 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 beta and might change without notice. These
variants are also available:
$ gcloud asset saved-queries update
$ gcloud alpha asset saved-queries update

8
gcloud/beta/assured/workloads/help
View file

@ -3,7 +3,7 @@ NAME
resources
SYNOPSIS
gcloud beta assured workloads COMMAND [GCLOUD_WIDE_FLAG ...]
gcloud beta assured workloads GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create, read, update, list and delete Assured Workloads resources.
@ -13,6 +13,12 @@ GCLOUD WIDE FLAGS
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
violations
(BETA) Read and list Assured Workloads Violations.
COMMANDS
COMMAND is one of the following:

76
gcloud/beta/assured/workloads/violations/acknowledge Normal file
View file

@ -0,0 +1,76 @@
NAME
gcloud beta assured workloads violations acknowledge - acknowledge an
existing Assured Workloads compliance violation
SYNOPSIS
gcloud beta assured workloads violations acknowledge
(VIOLATION : --location=LOCATION
--organization=ORGANIZATION --workload=WORKLOAD) --comment=COMMENT
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Acknowledge an existing Assured Workloads compliance violation.
EXAMPLES
To acknowledge an Assured Workloads Violation in the us-central1 region,
belonging to an organization with ID 123, with workload ID 456, with
violation ID 789 and comment as test ack, run:
$ gcloud beta assured workloads violations acknowledge \
organizations/123/locations/us-central1/workloads/456/\
violations/789 --comment="test ack"
POSITIONAL ARGUMENTS
Violation resource - The Assured Workloads violation resource to
acknowledge. The arguments in this group can be used to specify the
attributes of this resource.
This must be specified.
VIOLATION
ID of the violation or fully qualified identifier for the violation.
To set the violation attribute:
▸ provide the argument violation 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 for the violation. To set the location attribute:
▸ provide the argument violation on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--organization=ORGANIZATION
The parent organization for the violation. To set the organization
attribute:
▸ provide the argument violation on the command line with a fully
specified name;
▸ provide the argument --organization on the command line.
--workload=WORKLOAD
The workload for the violation. To set the workload attribute:
▸ provide the argument violation on the command line with a fully
specified name;
▸ provide the argument --workload on the command line.
REQUIRED FLAGS
--comment=COMMENT
Business justification used added to acknowledge a violation.
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 beta and might change without notice. These
variants are also available:
$ gcloud assured workloads violations acknowledge
$ gcloud alpha assured workloads violations acknowledge

72
gcloud/beta/assured/workloads/violations/describe Normal file
View file

@ -0,0 +1,72 @@
NAME
gcloud beta assured workloads violations describe - describe an Assured
Workloads compliance violation
SYNOPSIS
gcloud beta assured workloads violations describe
(VIOLATION : --location=LOCATION
--organization=ORGANIZATION --workload=WORKLOAD)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Obtain details about a given compliance violation.
EXAMPLES
To describe an Assured Workloads Violation in the us-central1 region,
belonging to an organization with ID 123, with workload ID 456, with
violation ID 789, run:
$ gcloud beta assured workloads violations describe \
organizations/123/locations/us-central1/workloads/456/\
violations/789
POSITIONAL ARGUMENTS
Violation resource - The Assured Workloads violation resource to describe.
The arguments in this group can be used to specify the attributes of this
resource.
This must be specified.
VIOLATION
ID of the violation or fully qualified identifier for the violation.
To set the violation attribute:
▸ provide the argument violation 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 for the violation. To set the location attribute:
▸ provide the argument violation on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--organization=ORGANIZATION
The parent organization for the violation. To set the organization
attribute:
▸ provide the argument violation on the command line with a fully
specified name;
▸ provide the argument --organization on the command line.
--workload=WORKLOAD
The workload for the violation. To set the workload attribute:
▸ provide the argument violation on the command line with a fully
specified name;
▸ provide the argument --workload 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 beta and might change without notice. These
variants are also available:
$ gcloud assured workloads violations describe
$ gcloud alpha assured workloads violations describe

36
gcloud/beta/assured/workloads/violations/help Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud beta assured workloads violations - read and list Assured Workloads
Violations
SYNOPSIS
gcloud beta assured workloads violations COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Read and list Assured Workloads Violations.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
acknowledge
(BETA) Acknowledge an existing Assured Workloads compliance violation.
describe
(BETA) Describe an Assured Workloads compliance violation.
list
(BETA) List all Assured Workloads violations that belong to a assured
workloads environment.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud assured workloads violations
$ gcloud alpha assured workloads violations

88
gcloud/beta/assured/workloads/violations/list Normal file
View file

@ -0,0 +1,88 @@
NAME
gcloud beta assured workloads violations list - list all Assured Workloads
violations that belong to a assured workloads environment
SYNOPSIS
gcloud beta assured workloads violations list --location=LOCATION
--organization=ORGANIZATION --workload=WORKLOAD [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List all Violations that belong to the given Assured Workloads
environment.
EXAMPLES
The following example command lists all violations with these properties:
▪ belonging to an organization with ID 123
▪ belonging to the assured workload with ID w123
▪ located in the us-central1 region
▪ returning no more than 30 results
▪ requesting 10 results at a time from the backend
$ gcloud beta assured workloads violations list --organization=123 \
--location=us-central1 --workload=w123 --limit=30 --page-size=10
REQUIRED FLAGS
--location=LOCATION
The location of the Assured Workloads environments. For a current list
of supported LOCATION values, see Assured Workloads locations
(http://cloud/assured-workloads/docs/locations).
--organization=ORGANIZATION
The parent organization of the Assured Workloads environments, provided
as an organization ID.
--workload=WORKLOAD
The parent workload of the Assured Workloads violations, provided as
workload ID.
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 beta and might change without notice. These
variants are also available:
$ gcloud assured workloads violations list
$ gcloud alpha assured workloads violations list

12
gcloud/beta/batch/jobs/delete
View file

@ -18,10 +18,11 @@ EXAMPLES
projects/foo/locations/us-central1/jobs/bar
POSITIONAL ARGUMENTS
Job resource - The Batch job resource. 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:
Job resource - The Batch job resource. If not specified,the current
batch/location is used. 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 JOB on the command line with a fully specified
name;
◆ provide the argument --project on the command line;
@ -41,7 +42,8 @@ POSITIONAL ARGUMENTS
Google Cloud location for the job. To set the location attribute:
▸ provide the argument JOB on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
▸ provide the argument --location on the command line;
▸ set the property batch/location.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

12
gcloud/beta/batch/jobs/describe
View file

@ -18,10 +18,11 @@ EXAMPLES
projects/foo/locations/us-central1/jobs/bar
POSITIONAL ARGUMENTS
Job resource - The Batch job resource. 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:
Job resource - The Batch job resource. If not specified,the current
batch/location is used. 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 JOB on the command line with a fully specified
name;
◆ provide the argument --project on the command line;
@ -41,7 +42,8 @@ POSITIONAL ARGUMENTS
Google Cloud location for the job. To set the location attribute:
▸ provide the argument JOB on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
▸ provide the argument --location on the command line;
▸ set the property batch/location.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

15
gcloud/beta/batch/jobs/list
View file

@ -3,7 +3,7 @@ NAME
project/location
SYNOPSIS
gcloud beta batch jobs list --location=LOCATION [--filter=EXPRESSION]
gcloud beta batch jobs list [--location=LOCATION] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]]
[GCLOUD_WIDE_FLAG ...]
@ -25,18 +25,23 @@ EXAMPLES
$ gcloud beta batch jobs list --project=foo --location=us-central1
FLAGS
Location resource - The Batch location resource. 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:
Location resource - The Batch location resource. If you omit this flag,
the defaultlocation is used if you set the batch/location
property.Otherwise, omitting this flag lists jobs across all locations.
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 batch/location 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.
▸ provide the argument --location on the command line;
▸ set the property batch/location.
LIST COMMAND FLAGS
--filter=EXPRESSION

12
gcloud/beta/batch/jobs/submit
View file

@ -45,10 +45,11 @@ EXAMPLES
EOF
POSITIONAL ARGUMENTS
Job resource - The Batch job resource. 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:
Job resource - The Batch job resource. If not specified,the current
batch/location is used. 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 JOB on the command line with a fully specified
name;
◆ provide the argument --project on the command line;
@ -68,7 +69,8 @@ POSITIONAL ARGUMENTS
Google Cloud location for the job. To set the location attribute:
▸ provide the argument JOB on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
▸ provide the argument --location on the command line;
▸ set the property batch/location.
REQUIRED FLAGS
At least one of these must be specified:

12
gcloud/beta/batch/tasks/describe
View file

@ -20,10 +20,11 @@ EXAMPLES
tasks/0
POSITIONAL ARGUMENTS
Task resource - The Batch task resource. 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:
Task resource - The Batch task resource. If not specified,the current
batch/location is used. 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 TASK on the command line with a fully specified
name;
◆ provide the argument --project on the command line;
@ -49,7 +50,8 @@ POSITIONAL ARGUMENTS
Google Cloud location for the task. To set the location attribute:
▸ provide the argument TASK on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
▸ provide the argument --location on the command line;
▸ set the property batch/location.
--task_group=TASK_GROUP
The task_group ID for the task. To set the task_group attribute:

12
gcloud/beta/batch/tasks/list
View file

@ -23,10 +23,11 @@ EXAMPLES
projects/foo/locations/us-central1/jobs/bar
REQUIRED FLAGS
Job resource - The Batch job resource. 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:
Job resource - The Batch job resource. If not specified,the current
batch/location is used. 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 --job on the command line with a fully specified
name;
◆ provide the argument --project on the command line;
@ -46,7 +47,8 @@ REQUIRED FLAGS
Google Cloud location for the job. To set the location attribute:
▸ provide the argument --job on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
▸ provide the argument --location on the command line;
▸ set the property batch/location.
LIST COMMAND FLAGS
--filter=EXPRESSION

8
gcloud/beta/compute/instance-templates/create
View file

@ -820,11 +820,9 @@ FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
--image-project=IMAGE_PROJECT
The Google Cloud project against which all image and image family

8
gcloud/beta/compute/instance-templates/create-with-container
View file

@ -676,11 +676,9 @@ FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
--image-project=IMAGE_PROJECT
The Google Cloud project against which all image and image family

8
gcloud/beta/compute/instances/bulk/create
View file

@ -746,11 +746,9 @@ OPTIONAL FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
--image-project=IMAGE_PROJECT
The Google Cloud project against which all image and image family

8
gcloud/beta/compute/instances/create
View file

@ -898,11 +898,9 @@ FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
--image-family-scope=IMAGE_FAMILY_SCOPE
Sets the scope for the --image-family flag. By default, when specifying

8
gcloud/beta/compute/instances/create-with-container
View file

@ -766,11 +766,9 @@ FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
--image-project=IMAGE_PROJECT
The Google Cloud project against which all image and image family

8
gcloud/beta/compute/instances/import
View file

@ -261,11 +261,9 @@ OPTIONAL FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
Sole Tenancy.

8
gcloud/beta/compute/instances/set-machine-type
View file

@ -94,11 +94,9 @@ FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

8
gcloud/beta/compute/machine-images/import
View file

@ -257,11 +257,9 @@ OPTIONAL FLAGS
Use the extended custom machine type.
--custom-vm-type=CUSTOM_VM_TYPE
Specifies VM type. n1 - VMs with CPU platforms Skylake and older, n2
- VMs with CPU platform Cascade Lake. n2 offers flexible sizing from
2 to 80 vCPUs, and 1 to 640GBs of memory. It also features a number
of performance enhancements including exposing a more accurate NUMA
topology to the guest OS. The default is n1.
Specifies a custom machine type. The default is n1. For more
information about custom machine types, see:
https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
At most one of these can be specified:

26
gcloud/beta/config/get
View file

@ -528,6 +528,12 @@ AVAILABLE PROPERTIES
Overrides the token endpoint to provision access tokens. It can be
used with Private Service Connect.
batch
location
Default location to use when working with Batch resources. When a
location value is required but not provided, the command will fall
back to this value, if set.
billing
quota_project
The Google Cloud project that is billed and charged quota for
@ -626,6 +632,11 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_bare_metal
location
Default Google Cloud location to use for Anthos clusters on Bare
Metal.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
@ -1038,6 +1049,21 @@ AVAILABLE PROPERTIES
exponential_sleep_multiplier
Used in exponential backoff for retrying operations.
key_store_path
Path to a yaml file containing an encryption key, and multiple
decryption keys for use in storage commands. The file must be
formatted as follows:
encryption_key: {A customer-supplied or customer-managed key.}
decryption_keys:
- {A customer-supplied key}
...
Customer-supplied encryption keys must be RFC 4648 section 4
base64-encoded AES256 strings. Customer-managed encryption keys
must be of the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
max_retries
Max number of retries for operations like copy.

26
gcloud/beta/config/help
View file

@ -560,6 +560,12 @@ AVAILABLE PROPERTIES
Overrides the token endpoint to provision access tokens. It can be
used with Private Service Connect.
batch
location
Default location to use when working with Batch resources. When a
location value is required but not provided, the command will fall
back to this value, if set.
billing
quota_project
The Google Cloud project that is billed and charged quota for
@ -658,6 +664,11 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_bare_metal
location
Default Google Cloud location to use for Anthos clusters on Bare
Metal.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
@ -1070,6 +1081,21 @@ AVAILABLE PROPERTIES
exponential_sleep_multiplier
Used in exponential backoff for retrying operations.
key_store_path
Path to a yaml file containing an encryption key, and multiple
decryption keys for use in storage commands. The file must be
formatted as follows:
encryption_key: {A customer-supplied or customer-managed key.}
decryption_keys:
- {A customer-supplied key}
...
Customer-supplied encryption keys must be RFC 4648 section 4
base64-encoded AES256 strings. Customer-managed encryption keys
must be of the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
max_retries
Max number of retries for operations like copy.

26
gcloud/beta/config/list
View file

@ -566,6 +566,12 @@ AVAILABLE PROPERTIES
Overrides the token endpoint to provision access tokens. It can be
used with Private Service Connect.
batch
location
Default location to use when working with Batch resources. When a
location value is required but not provided, the command will fall
back to this value, if set.
billing
quota_project
The Google Cloud project that is billed and charged quota for
@ -664,6 +670,11 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_bare_metal
location
Default Google Cloud location to use for Anthos clusters on Bare
Metal.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
@ -1076,6 +1087,21 @@ AVAILABLE PROPERTIES
exponential_sleep_multiplier
Used in exponential backoff for retrying operations.
key_store_path
Path to a yaml file containing an encryption key, and multiple
decryption keys for use in storage commands. The file must be
formatted as follows:
encryption_key: {A customer-supplied or customer-managed key.}
decryption_keys:
- {A customer-supplied key}
...
Customer-supplied encryption keys must be RFC 4648 section 4
base64-encoded AES256 strings. Customer-managed encryption keys
must be of the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
max_retries
Max number of retries for operations like copy.

26
gcloud/beta/config/set
View file

@ -575,6 +575,12 @@ AVAILABLE PROPERTIES
Overrides the token endpoint to provision access tokens. It can be
used with Private Service Connect.
batch
location
Default location to use when working with Batch resources. When a
location value is required but not provided, the command will fall
back to this value, if set.
billing
quota_project
The Google Cloud project that is billed and charged quota for
@ -673,6 +679,11 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_bare_metal
location
Default Google Cloud location to use for Anthos clusters on Bare
Metal.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
@ -1085,6 +1096,21 @@ AVAILABLE PROPERTIES
exponential_sleep_multiplier
Used in exponential backoff for retrying operations.
key_store_path
Path to a yaml file containing an encryption key, and multiple
decryption keys for use in storage commands. The file must be
formatted as follows:
encryption_key: {A customer-supplied or customer-managed key.}
decryption_keys:
- {A customer-supplied key}
...
Customer-supplied encryption keys must be RFC 4648 section 4
base64-encoded AES256 strings. Customer-managed encryption keys
must be of the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
max_retries
Max number of retries for operations like copy.

26
gcloud/beta/config/unset
View file

@ -536,6 +536,12 @@ AVAILABLE PROPERTIES
Overrides the token endpoint to provision access tokens. It can be
used with Private Service Connect.
batch
location
Default location to use when working with Batch resources. When a
location value is required but not provided, the command will fall
back to this value, if set.
billing
quota_project
The Google Cloud project that is billed and charged quota for
@ -634,6 +640,11 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_bare_metal
location
Default Google Cloud location to use for Anthos clusters on Bare
Metal.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
@ -1046,6 +1057,21 @@ AVAILABLE PROPERTIES
exponential_sleep_multiplier
Used in exponential backoff for retrying operations.
key_store_path
Path to a yaml file containing an encryption key, and multiple
decryption keys for use in storage commands. The file must be
formatted as follows:
encryption_key: {A customer-supplied or customer-managed key.}
decryption_keys:
- {A customer-supplied key}
...
Customer-supplied encryption keys must be RFC 4648 section 4
base64-encoded AES256 strings. Customer-managed encryption keys
must be of the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
max_retries
Max number of retries for operations like copy.

2
gcloud/beta/dataproc/clusters/create
View file

@ -59,7 +59,7 @@ DESCRIPTION
EXAMPLES
To create a cluster, run:
$ gcloud beta dataproc clusters create my_cluster \
$ gcloud beta dataproc clusters create my-cluster \
--region=us-central1
POSITIONAL ARGUMENTS

2
gcloud/beta/dataproc/clusters/delete
View file

@ -11,7 +11,7 @@ DESCRIPTION
EXAMPLES
To delete a cluster, run:
$ gcloud beta dataproc clusters delete my_cluster \
$ gcloud beta dataproc clusters delete my-cluster \
--region=us-central1
POSITIONAL ARGUMENTS

2
gcloud/beta/dataproc/clusters/describe
View file

@ -11,7 +11,7 @@ DESCRIPTION
EXAMPLES
To view the details of a cluster, run:
$ gcloud beta dataproc clusters describe my_cluster \
$ gcloud beta dataproc clusters describe my-cluster \
--region=us-central1
POSITIONAL ARGUMENTS

2
gcloud/beta/dataproc/clusters/diagnose
View file

@ -12,7 +12,7 @@ DESCRIPTION
EXAMPLES
To diagnose a cluster, run:
$ gcloud beta dataproc clusters diagnose my_cluster \
$ gcloud beta dataproc clusters diagnose my-cluster \
--region=us-central1
POSITIONAL ARGUMENTS

4
gcloud/beta/dataproc/clusters/export
View file

@ -13,12 +13,12 @@ DESCRIPTION
EXAMPLES
To export a cluster to a YAML file, run:
$ gcloud beta dataproc clusters export my_cluster \
$ gcloud beta dataproc clusters export my-cluster \
--region=us-central1 --destination=cluster.yaml
To export a cluster to standard output, run:
$ gcloud beta dataproc clusters export my_cluster \
$ gcloud beta dataproc clusters export my-cluster \
--region=us-central1
POSITIONAL ARGUMENTS

8
gcloud/beta/dataproc/clusters/help
View file

@ -10,22 +10,22 @@ DESCRIPTION
EXAMPLES
To create a cluster, run:
$ gcloud beta dataproc clusters create my_cluster \
$ gcloud beta dataproc clusters create my-cluster \
--region=us-central1
To resize a cluster, run:
$ gcloud beta dataproc clusters update my_cluster \
$ gcloud beta dataproc clusters update my-cluster \
--region=us-central1 --num_workers 5
To delete a cluster, run:
$ gcloud beta dataproc clusters delete my_cluster \
$ gcloud beta dataproc clusters delete my-cluster \
--region=us-central1
To view the details of a cluster, run:
$ gcloud beta dataproc clusters describe my_cluster \
$ gcloud beta dataproc clusters describe my-cluster \
--region=us-central1
To see the list of all clusters, run:

4
gcloud/beta/dataproc/clusters/import
View file

@ -12,12 +12,12 @@ DESCRIPTION
EXAMPLES
To import a cluster from a YAML file, run:
$ gcloud beta dataproc clusters import my_cluster \
$ gcloud beta dataproc clusters import my-cluster \
--region=us-central1 --source=cluster.yaml
To import a cluster from standard output, run:
$ gcloud beta dataproc clusters import my_cluster \
$ gcloud beta dataproc clusters import my-cluster \
--region=us-central1
POSITIONAL ARGUMENTS

2
gcloud/beta/dataproc/clusters/start
View file

@ -11,7 +11,7 @@ DESCRIPTION
EXAMPLES
To start a cluster, run:
$ gcloud beta dataproc clusters start my_cluster --region=us-central1
$ gcloud beta dataproc clusters start my-cluster --region=us-central1
POSITIONAL ARGUMENTS
Cluster resource - The name of the cluster to start. The arguments in this

2
gcloud/beta/dataproc/clusters/stop
View file

@ -11,7 +11,7 @@ DESCRIPTION
EXAMPLES
To stop a cluster, run:
$ gcloud beta dataproc clusters stop my_cluster --region=us-central1
$ gcloud beta dataproc clusters stop my-cluster --region=us-central1
POSITIONAL ARGUMENTS
Cluster resource - The name of the cluster to stop. The arguments in this

10
gcloud/beta/dataproc/clusters/update
View file

@ -18,27 +18,27 @@ DESCRIPTION
EXAMPLES
To resize a cluster, run:
$ gcloud beta dataproc clusters update my_cluster \
$ gcloud beta dataproc clusters update my-cluster \
--region=us-central1 --num-workers=5
To change the number preemptible workers in a cluster, run:
$ gcloud beta dataproc clusters update my_cluster \
$ gcloud beta dataproc clusters update my-cluster \
--region=us-central1 --num-preemptible-workers=5
To add the label 'customer=acme' to a cluster, run:
$ gcloud beta dataproc clusters update my_cluster \
$ gcloud beta dataproc clusters update my-cluster \
--region=us-central1 --update-labels=customer=acme
To update the label 'customer=ackme' to 'customer=acme', run:
$ gcloud beta dataproc clusters update my_cluster \
$ gcloud beta dataproc clusters update my-cluster \
--region=us-central1 --update-labels=customer=acme
To remove the label whose key is 'customer', run:
$ gcloud beta dataproc clusters update my_cluster \
$ gcloud beta dataproc clusters update my-cluster \
--region=us-central1 --remove-labels=customer
POSITIONAL ARGUMENTS

6
gcloud/beta/dataproc/jobs/submit/hadoop
View file

@ -19,18 +19,18 @@ DESCRIPTION
EXAMPLES
To submit a Hadoop job that runs the main class of a jar, run:
$ gcloud beta dataproc jobs submit hadoop --cluster=my_cluster \
$ gcloud beta dataproc jobs submit hadoop --cluster=my-cluster \
--jar=my_jar.jar -- arg1 arg2
To submit a Hadoop job that runs a specific class of a jar, run:
$ gcloud beta dataproc jobs submit hadoop --cluster=my_cluster \
$ gcloud beta dataproc jobs submit hadoop --cluster=my-cluster \
--class=org.my.main.Class --jars=my_jar1.jar,my_jar2.jar \
-- arg1 arg2
To submit a Hadoop job that runs a jar that is already on the cluster, run:
$ gcloud beta dataproc jobs submit hadoop --cluster=my_cluster \
$ gcloud beta dataproc jobs submit hadoop --cluster=my-cluster \
--jar=file:///usr/lib/hadoop-op/hadoop-op-examples.jar \
-- wordcount gs://my_bucket/my_file.txt gs://my_bucket/output

12
gcloud/beta/dataproc/jobs/submit/help
View file

@ -12,32 +12,32 @@ DESCRIPTION
EXAMPLES
To submit a Hadoop MapReduce job, run:
$ gcloud beta dataproc jobs submit hadoop --cluster my_cluster \
$ gcloud beta dataproc jobs submit hadoop --cluster my-cluster \
--jar my_jar.jar -- arg1 arg2
To submit a Spark Scala or Java job, run:
$ gcloud beta dataproc jobs submit spark --cluster my_cluster \
$ gcloud beta dataproc jobs submit spark --cluster my-cluster \
--jar my_jar.jar -- arg1 arg2
To submit a PySpark job, run:
$ gcloud beta dataproc jobs submit pyspark --cluster my_cluster \
$ gcloud beta dataproc jobs submit pyspark --cluster my-cluster \
my_script.py -- arg1 arg2
To submit a Spark SQL job, run:
$ gcloud beta dataproc jobs submit spark-sql --cluster my_cluster \
$ gcloud beta dataproc jobs submit spark-sql --cluster my-cluster \
--file my_queries.q
To submit a Pig job, run:
$ gcloud beta dataproc jobs submit pig --cluster my_cluster \
$ gcloud beta dataproc jobs submit pig --cluster my-cluster \
--file my_script.pig
To submit a Hive job, run:
$ gcloud beta dataproc jobs submit hive --cluster my_cluster \
$ gcloud beta dataproc jobs submit hive --cluster my-cluster \
--file my_queries.q
FLAGS

4
gcloud/beta/dataproc/jobs/submit/hive
View file

@ -18,12 +18,12 @@ DESCRIPTION
EXAMPLES
To submit a Hive job with a local script, run:
$ gcloud beta dataproc jobs submit hive --cluster=my_cluster \
$ gcloud beta dataproc jobs submit hive --cluster=my-cluster \
--file=my_queries.q
To submit a Hive job with inline queries, run:
$ gcloud beta dataproc jobs submit hive --cluster=my_cluster \
$ gcloud beta dataproc jobs submit hive --cluster=my-cluster \
-e="CREATE EXTERNAL TABLE foo(bar int) LOCATION \
'gs://my_bucket/'" -e="SELECT * FROM foo WHERE bar > 2"

4
gcloud/beta/dataproc/jobs/submit/pig
View file

@ -19,12 +19,12 @@ DESCRIPTION
EXAMPLES
To submit a Pig job with a local script, run:
$ gcloud beta dataproc jobs submit pig --cluster=my_cluster \
$ gcloud beta dataproc jobs submit pig --cluster=my-cluster \
--file=my_queries.pig
To submit a Pig job with inline queries, run:
$ gcloud beta dataproc jobs submit pig --cluster=my_cluster \
$ gcloud beta dataproc jobs submit pig --cluster=my-cluster \
-e="LNS = LOAD 'gs://my_bucket/my_file.txt' AS (line)" \
-e="WORDS = FOREACH LNS GENERATE FLATTEN(TOKENIZE(line)) AS \
word" -e="GROUPS = GROUP WORDS BY word" \

4
gcloud/beta/dataproc/jobs/submit/presto
View file

@ -20,12 +20,12 @@ DESCRIPTION
EXAMPLES
To submit a Presto job with a local script, run:
$ gcloud beta dataproc jobs submit presto --cluster=my_cluster \
$ gcloud beta dataproc jobs submit presto --cluster=my-cluster \
--file=my_script.R
To submit a Presto job with inline queries, run:
$ gcloud beta dataproc jobs submit presto --cluster=my_cluster \
$ gcloud beta dataproc jobs submit presto --cluster=my-cluster \
-e="SELECT * FROM foo WHERE bar > 2"
REQUIRED FLAGS

4
gcloud/beta/dataproc/jobs/submit/pyspark
View file

@ -20,13 +20,13 @@ DESCRIPTION
EXAMPLES
To submit a PySpark job with a local script and custom flags, run:
$ gcloud beta dataproc jobs submit pyspark --cluster=my_cluster \
$ gcloud beta dataproc jobs submit pyspark --cluster=my-cluster \
my_script.py -- --custom-flag
To submit a Spark job that runs a script that is already on the cluster,
run:
$ gcloud beta dataproc jobs submit pyspark --cluster=my_cluster \
$ gcloud beta dataproc jobs submit pyspark --cluster=my-cluster \
file:///usr/lib/spark/examples/src/main/python/pi.py -- 100
POSITIONAL ARGUMENTS

6
gcloud/beta/dataproc/jobs/submit/spark
View file

@ -19,18 +19,18 @@ DESCRIPTION
EXAMPLES
To submit a Spark job that runs the main class of a jar, run:
$ gcloud beta dataproc jobs submit spark --cluster=my_cluster \
$ gcloud beta dataproc jobs submit spark --cluster=my-cluster \
--region=us-central1 --jar=my_jar.jar -- arg1 arg2
To submit a Spark job that runs a specific class of a jar, run:
$ gcloud beta dataproc jobs submit spark --cluster=my_cluster \
$ gcloud beta dataproc jobs submit spark --cluster=my-cluster \
--region=us-central1 --class=org.my.main.Class \
--jars=my_jar1.jar,my_jar2.jar -- arg1 arg2
To submit a Spark job that runs a jar that is already on the cluster, run:
$ gcloud beta dataproc jobs submit spark --cluster=my_cluster \
$ gcloud beta dataproc jobs submit spark --cluster=my-cluster \
--region=us-central1 --class=org.apache.spark.examples.SparkPi \
--jars=file:///usr/lib/spark/examples/jars/spark-examples.jar \
-- 1000

4
gcloud/beta/dataproc/jobs/submit/spark-r
View file

@ -18,12 +18,12 @@ DESCRIPTION
EXAMPLES
To submit a SparkR job with a local script, run:
$ gcloud beta dataproc jobs submit spark-r --cluster=my_cluster \
$ gcloud beta dataproc jobs submit spark-r --cluster=my-cluster \
my_script.R
To submit a Spark job that runs a script already on the cluster, run:
$ gcloud beta dataproc jobs submit spark-r --cluster=my_cluster \
$ gcloud beta dataproc jobs submit spark-r --cluster=my-cluster \
file:///.../my_script.R -- gs://my_bucket/data.csv
POSITIONAL ARGUMENTS

4
gcloud/beta/dataproc/jobs/submit/spark-sql
View file

@ -19,12 +19,12 @@ DESCRIPTION
EXAMPLES
To submit a Spark SQL job with a local script, run:
$ gcloud beta dataproc jobs submit spark-sql --cluster=my_cluster \
$ gcloud beta dataproc jobs submit spark-sql --cluster=my-cluster \
--file=my_queries.ql
To submit a Spark SQL job with inline queries, run:
$ gcloud beta dataproc jobs submit spark-sql --cluster=my_cluster \
$ gcloud beta dataproc jobs submit spark-sql --cluster=my-cluster \
-e="CREATE EXTERNAL TABLE foo(bar int) LOCATION \
'gs://my_bucket/'" -e="SELECT * FROM foo WHERE bar > 2"

20
gcloud/beta/monitoring/dashboards/create
View file

@ -5,12 +5,13 @@ NAME
SYNOPSIS
gcloud beta monitoring dashboards create
(--config=CONFIG | --config-from-file=CONFIG_FROM_FILE)
[GCLOUD_WIDE_FLAG ...]
[--validate-only] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create a new Monitoring dashboard. A dashboard can be specified as a
JSON/YAML value passed in as a string through the --config flag or as a
file through the --config-from-file flag.
file through the --config-from-file flag. Validate a dashboard config
without saving by setting the --validate-only flag.
For information about the format of a dashboard:
https://cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards
@ -26,6 +27,17 @@ EXAMPLES
content: Hello World
'''
To validate a dashboard and not save it, run:
$ gcloud beta monitoring dashboards create --validate-only \
--config='''
displayName: New Dashboard
gridLayout:
widgets:
- text:
content: Hello World
'''
To create a dashboard with a JSON config, run:
$ gcloud beta monitoring dashboards create --config='''
@ -86,6 +98,10 @@ REQUIRED FLAGS
--config-from-file=CONFIG_FROM_FILE
Path to a JSON or YAML file containing the dashboard configuration.
OPTIONAL FLAGS
--validate-only
When set, validate the dashboard but do not save it.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

36
gcloud/beta/policy-troubleshoot/iam
View file

@ -3,7 +3,10 @@ NAME
SYNOPSIS
gcloud beta policy-troubleshoot iam RESOURCE --permission=PERMISSION
--principal-email=PRINCIPAL_EMAIL [GCLOUD_WIDE_FLAG ...]
--principal-email=PRINCIPAL_EMAIL [--destination-ip=DESTINATION_IP]
[--destination-port=DESTINATION_PORT] [--request-time=REQUEST_TIME]
[--resource-name=RESOURCE_NAME] [--resource-service=RESOURCE_SERVICE]
[--resource-type=RESOURCE_TYPE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Performs a check on whether a principal is granted a permission on a
@ -34,6 +37,33 @@ REQUIRED FLAGS
Email address that identifies the principal to check. Only Google
Accounts and service accounts are supported.
OPTIONAL FLAGS
--destination-ip=DESTINATION_IP
The request destination IP address to use when checking conditional
bindings. For example, 198.1.1.1.
--destination-port=DESTINATION_PORT
The request destination port to use when checking conditional bindings.
For example, 8080.
--request-time=REQUEST_TIME
The request timestamp to use when checking conditional bindings. This
string must adhere to UTC format (RFC 3339). For
example,2021-01-01T00:00:00Z. See: https://tools.ietf.org/html/rfc3339
--resource-name=RESOURCE_NAME
The resource name value to use when checking conditional bindings. See:
https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name.
--resource-service=RESOURCE_SERVICE
The resource service value to use when checking conditional bindings.
See:
https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-service
--resource-type=RESOURCE_TYPE
The resource type value to use when checking conditional bindings. See:
https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-type
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
@ -43,8 +73,8 @@ GCLOUD WIDE FLAGS
Run $ gcloud help for details.
API REFERENCE
This command uses the policytroubleshooter/v1 API. The full documentation
for this API can be found at: https://cloud.google.com/iam/
This command uses the policytroubleshooter/v2alpha1 API. The full
documentation for this API can be found at: https://cloud.google.com/iam/
NOTES
This command is currently in beta and might change without notice. These

27
gcloud/beta/workstations/clusters/help Normal file
View file

@ -0,0 +1,27 @@
NAME
gcloud beta workstations clusters - manage Cloud Workstations cluster
resources
SYNOPSIS
gcloud beta workstations clusters COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud Workstations cluster resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
list
(BETA) List workstation clusters.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha workstations clusters

77
gcloud/beta/workstations/clusters/list Normal file
View file

@ -0,0 +1,77 @@
NAME
gcloud beta workstations clusters list - list workstation clusters
SYNOPSIS
gcloud beta workstations clusters list --region=REGION
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List all workstation clusters under the specified project and
region.
EXAMPLES
To list workstation clusters, run:
$ gcloud beta workstations clusters list
REQUIRED FLAGS
Region resource - The region of the clusters 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 --region 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.
--region=REGION
ID of the region or fully qualified identifier for the region. To set
the region attribute:
▸ provide the argument --region 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.
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 workstations/v1beta API. The full documentation for
this API can be found at: https://cloud.google.com/workstations
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha workstations clusters list

36
gcloud/beta/workstations/help Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud beta workstations - manage Cloud Workstations resources
SYNOPSIS
gcloud beta workstations GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud Workstations resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
clusters
(BETA) Manage Cloud Workstations cluster resources.
COMMANDS
COMMAND is one of the following:
list
(BETA) List workstations.
start-tcp-tunnel
(BETA) Starts a tunnel through which a local process can forward TCP
traffic to the workstation.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha workstations

97
gcloud/beta/workstations/list Normal file
View file

@ -0,0 +1,97 @@
NAME
gcloud beta workstations list - list workstations
SYNOPSIS
gcloud beta workstations list
(--config=CONFIG : --cluster=CLUSTER --region=REGION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List all workstations under the specified config.
EXAMPLES
To list workstations, run:
$ gcloud beta workstations list
REQUIRED FLAGS
Config resource - The config of the workstations to display. 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 --config 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.
--config=CONFIG
ID of the config or fully qualified identifier for the config. To set
the config attribute:
▸ provide the argument --config on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--cluster=CLUSTER
The name of the cluster containing the config.
To set the cluster attribute:
▸ provide the argument --config on the command line with a fully
specified name;
▸ provide the argument --cluster on the command line.
--region=REGION
The name of the region of the config.
To set the region attribute:
▸ provide the argument --config on the command line with a fully
specified name;
▸ provide the argument --region 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.
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 workstations/v1beta API. The full documentation for
this API can be found at: https://cloud.google.com/workstations
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha workstations list

88
gcloud/beta/workstations/start-tcp-tunnel Normal file
View file

@ -0,0 +1,88 @@
NAME
gcloud beta workstations start-tcp-tunnel - starts a tunnel through which a
local process can forward TCP traffic to the workstation
SYNOPSIS
gcloud beta workstations start-tcp-tunnel
(WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION)
WORKSTATION_PORT
[--local-host-port=LOCAL_HOST_PORT; default="localhost:0"]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Starts a tunnel through which a local process can forward TCP
traffic to the workstation.
EXAMPLES
To start a tunnel to port 22 on a workstation, run:
$ gcloud beta workstations start-tcp-tunnel --project=my-project \
--region=us-central1 --cluster=my-cluster --config=my-config \
my-workstation 22
POSITIONAL ARGUMENTS
Workstation resource - The workstation to which traffic should be sent.
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 workstation 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.
WORKSTATION
ID of the workstation or fully qualified identifier for the
workstation. To set the workstation attribute:
▸ provide the argument workstation on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--cluster=CLUSTER
The cluster for the workstation. To set the cluster attribute:
▸ provide the argument workstation on the command line with a fully
specified name;
▸ provide the argument --cluster on the command line.
--config=CONFIG
The config for the workstation. To set the config attribute:
▸ provide the argument workstation on the command line with a fully
specified name;
▸ provide the argument --config on the command line.
--region=REGION
The region for the workstation. To set the region attribute:
▸ provide the argument workstation on the command line with a fully
specified name;
▸ provide the argument --region on the command line.
WORKSTATION_PORT
The port on the workstation to which traffic should be sent.
FLAGS
--local-host-port=LOCAL_HOST_PORT; default="localhost:0"
LOCAL_HOST:LOCAL_PORT on which gcloud should bind and listen for
connections that should be tunneled.
LOCAL_PORT may be omitted, in which case it is treated as 0 and an
arbitrary unused local port is chosen. The colon also may be omitted in
that case.
If LOCAL_PORT is 0, an arbitrary unused local port is chosen.
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 beta and might change without notice. This
variant is also available:
$ gcloud alpha workstations start-tcp-tunnel