.TH "GCLOUD_ALPHA_WORKSTATIONS_LIST" 1



.SH "NAME"
.HP
gcloud alpha workstations list \- list workstations



.SH "SYNOPSIS"
.HP
\f5gcloud alpha workstations list\fR [\fB\-\-cluster\fR=\fICLUSTER\fR\ \fB\-\-config\fR=\fICONFIG\fR\ \fB\-\-region\fR=\fIREGION\fR] [\fB\-\-filter\fR=\fIEXPRESSION\fR] [\fB\-\-limit\fR=\fILIMIT\fR] [\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR] [\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR List all workstations under the specified configuration.



.SH "EXAMPLES"

To list workstations, run:

.RS 2m
$ gcloud alpha workstations list
.RE



.SH "FLAGS"

.RS 2m
.TP 2m

Config resource \- The configuration 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-config\fR on the command line with a fully specified
name;
.IP "\(em" 2m
set the property \f5workstations/config\fR with a fully specified name;
.IP "\(em" 2m
default is all configs with a fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-cluster\fR=\fICLUSTER\fR

The name of the cluster containing the config.


To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-config\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
set the property \f5workstations/config\fR with a fully specified name;
.IP "\(bu" 2m
default is all configs with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-cluster\fR on the command line;
.IP "\(bu" 2m
set the property \f5workstations/cluster\fR;
.IP "\(bu" 2m
default is all clusters .
.RE
.sp

.TP 2m
\fB\-\-config\fR=\fICONFIG\fR

ID of the config or fully qualified identifier for the config.

To set the \f5config\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-config\fR on the command line;
.IP "\(bu" 2m
set the property \f5workstations/config\fR;
.IP "\(bu" 2m
default is all configs .
.RE
.sp

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The name of the region of the config.


To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-config\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
set the property \f5workstations/config\fR with a fully specified name;
.IP "\(bu" 2m
default is all configs with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5workstations/region\fR;
.IP "\(bu" 2m
default is all regions .
.RE
.sp


.RE
.RE
.sp

.SH "LIST COMMAND FLAGS"

.RS 2m
.TP 2m
\fB\-\-filter\fR=\fIEXPRESSION\fR

Apply a Boolean filter \fIEXPRESSION\fR to each resource item to be listed. If
the expression evaluates \f5True\fR, 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: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-limit\fR=\fILIMIT\fR

Maximum number of resources to list. The default is \fBunlimited\fR. This flag
interacts with other flags that are applied in this order: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR

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 \fBunlimited\fR (no paging). Paging may
be applied before or after \fB\-\-filter\fR and \fB\-\-limit\fR depending on the
service.

.TP 2m
\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]

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:
\fB\-\-flatten\fR, \fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBworkstations/v1beta\fR API. The full documentation for
this API can be found at: https://cloud.google.com/workstations



.SH "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. These variants are also available:

.RS 2m
$ gcloud workstations list
.RE

.RS 2m
$ gcloud beta workstations list
.RE