File: //snap/google-cloud-cli/396/help/man/man1/gcloud_workstations_clusters_describe.1
.TH "GCLOUD_WORKSTATIONS_CLUSTERS_DESCRIBE" 1
.SH "NAME"
.HP
gcloud workstations clusters describe \- describe a cluster
.SH "SYNOPSIS"
.HP
\f5gcloud workstations clusters describe\fR (\fICLUSTER\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Describe a cluster.
.SH "EXAMPLES"
To describe a cluster, run:
.RS 2m
$ gcloud workstations clusters describe CLUSTER
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Cluster resource \- The name of the cluster 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 \f5cluster\fR on the command line 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
This must be specified.
.RS 2m
.TP 2m
\fICLUSTER\fR
ID of the cluster or fully qualified identifier for the cluster.
To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line.
.RE
.sp
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-region\fR=\fIREGION\fR
The name of the region of the cluster.
To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line 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.
.RE
.sp
.RE
.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/v1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/workstations
.SH "NOTES"
These variants are also available:
.RS 2m
$ gcloud alpha workstations clusters describe
.RE
.RS 2m
$ gcloud beta workstations clusters describe
.RE