imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +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

29
gcloud/alpha/workstations/clusters/help Normal file
View file

@ -0,0 +1,29 @@
NAME
gcloud alpha workstations clusters - manage Cloud Workstations cluster
resources
SYNOPSIS
gcloud alpha workstations clusters COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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
(ALPHA) List workstation clusters.
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 workstations clusters

79
gcloud/alpha/workstations/clusters/list Normal file
View file

@ -0,0 +1,79 @@
NAME
gcloud alpha workstations clusters list - list workstation clusters
SYNOPSIS
gcloud alpha workstations clusters list --region=REGION
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List all workstation clusters under the specified project and
region.
EXAMPLES
To list workstation clusters, run:
$ gcloud alpha 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 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 workstations clusters list

38
gcloud/alpha/workstations/help Normal file
View file

@ -0,0 +1,38 @@
NAME
gcloud alpha workstations - manage Cloud Workstations resources
SYNOPSIS
gcloud alpha workstations GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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
(ALPHA) Manage Cloud Workstations cluster resources.
COMMANDS
COMMAND is one of the following:
list
(ALPHA) List workstations.
start-tcp-tunnel
(ALPHA) Starts a tunnel through which a local process can forward TCP
traffic to the workstation.
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 workstations

99
gcloud/alpha/workstations/list Normal file
View file

@ -0,0 +1,99 @@
NAME
gcloud alpha workstations list - list workstations
SYNOPSIS
gcloud alpha workstations list
(--config=CONFIG : --cluster=CLUSTER --region=REGION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List all workstations under the specified config.
EXAMPLES
To list workstations, run:
$ gcloud alpha 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 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 workstations list

90
gcloud/alpha/workstations/start-tcp-tunnel Normal file
View file

@ -0,0 +1,90 @@
NAME
gcloud alpha workstations start-tcp-tunnel - starts a tunnel through which
a local process can forward TCP traffic to the workstation
SYNOPSIS
gcloud alpha 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
(ALPHA) 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 alpha 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 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 workstations start-tcp-tunnel