File: //snap/google-cloud-cli/current/help/man/man1/gcloud_workstations_configs_update.1
.TH "GCLOUD_WORKSTATIONS_CONFIGS_UPDATE" 1
.SH "NAME"
.HP
gcloud workstations configs update \- updates a workstation configuration
.SH "SYNOPSIS"
.HP
\f5gcloud workstations configs update\fR (\fICONFIG\fR\ :\ \fB\-\-cluster\fR=\fICLUSTER\fR\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-allowed\-ports\fR=[\fIALLOWED_PORTS\fR,...]] [\fB\-\-async\fR] [\fB\-\-boot\-disk\-size\fR=\fIBOOT_DISK_SIZE\fR] [\fB\-\-container\-args\fR=[\fICONTAINER_ARGS\fR,...]] [\fB\-\-container\-command\fR=[\fICONTAINER_COMMAND\fR,...]] [\fB\-\-container\-env\fR=[\fICONTAINER_ENV\fR,...]] [\fB\-\-container\-run\-as\-user\fR=\fICONTAINER_RUN_AS_USER\fR] [\fB\-\-container\-working\-dir\fR=\fICONTAINER_WORKING_DIR\fR] [\fB\-\-disable\-public\-ip\-addresses\fR] [\fB\-\-enable\-audit\-agent\fR] [\fB\-\-enable\-confidential\-compute\fR] [\fB\-\-enable\-nested\-virtualization\fR] [\fB\-\-grant\-workstation\-admin\-role\-on\-create\fR] [\fB\-\-idle\-timeout\fR=\fIIDLE_TIMEOUT\fR] [\fB\-\-labels\fR=[\fILABELS\fR,...]] [\fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR] [\fB\-\-max\-usable\-workstations\-count\fR=\fIMAX_USABLE_WORKSTATIONS_COUNT\fR] [\fB\-\-network\-tags\fR=[\fINETWORK_TAGS\fR,...]] [\fB\-\-pool\-size\fR=\fIPOOL_SIZE\fR] [\fB\-\-running\-timeout\fR=\fIRUNNING_TIMEOUT\fR] [\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR] [\fB\-\-service\-account\-scopes\fR=[\fISERVICE_ACCOUNT_SCOPES\fR,...]] [\fB\-\-shielded\-integrity\-monitoring\fR] [\fB\-\-shielded\-secure\-boot\fR] [\fB\-\-shielded\-vtpm\fR] [\fB\-\-vm\-tags\fR=[\fIVM_TAGS\fR,...]] [\fB\-\-accelerator\-count\fR=\fIACCELERATOR_COUNT\fR\ :\ \fB\-\-accelerator\-type\fR=\fIACCELERATOR_TYPE\fR] [\fB\-\-container\-custom\-image\fR=\fICONTAINER_CUSTOM_IMAGE\fR\ |\ \fB\-\-container\-predefined\-image\fR=\fICONTAINER_PREDEFINED_IMAGE\fR] [\fB\-\-disable\-ssh\-to\-vm\fR\ |\ \fB\-\-enable\-ssh\-to\-vm\fR] [\fB\-\-disable\-tcp\-connections\fR\ |\ \fB\-\-enable\-tcp\-connections\fR] [\fB\-\-pd\-source\-snapshot\fR=\fIPD_SOURCE_SNAPSHOT\fR\ |\ \fB\-\-pd\-disk\-size\fR=\fIPD_DISK_SIZE\fR\ \fB\-\-pd\-disk\-type\fR=\fIPD_DISK_TYPE\fR;\ default="pd\-standard"] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Updates a workstation configuration.
.SH "EXAMPLES"
To update a configuration with the 'e2\-standard\-8' machine type and a IntelliJ
image, run:
.RS 2m
$ gcloud workstations configs update CONFIG \e
\-\-machine\-type=e2\-standard\-8 \e
\-\-container\-predefined\-image=intellij
.RE
To update a configuration to disable Secure Boot, virtual trusted platform
module (vTPM) and integrity monitoring, run:
.RS 2m
$ gcloud workstations configs update CONFIG \e
\-\-no\-shielded\-secure\-boot \-\-no\-shielded\-vtpm \e
\-\-no\-shielded\-integrity\-monitoring
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Config resource \- The group of arguments defining a config 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 \f5config\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
\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 \f5config\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\-\-cluster\fR=\fICLUSTER\fR
The cluster for the config.
To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5config\fR on the command line 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.
.RE
.sp
.TP 2m
\fB\-\-region\fR=\fIREGION\fR
The region for the config.
To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5config\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 "FLAGS"
.RS 2m
.TP 2m
\fB\-\-allowed\-ports\fR=[\fIALLOWED_PORTS\fR,...]
A Single or Range of ports externally accessible in the workstation. If not
specified defaults to ports 22, 80 and ports 1024\-65535.
To specify a single port, both first and last should be same.
Example:
.RS 2m
$ gcloud workstations configs update \e
\-\-allowed\-ports=first=9000,last=9090
$ gcloud workstations configs update \-\-allowed\-ports=first=80,last=80
.RE
Sets \f5allowed_ports\fR value.
.RS 2m
.TP 2m
\fBfirst\fR
Required, sets \f5first\fR value.
.TP 2m
\fBlast\fR
Required, sets \f5last\fR value.
.RE
.sp
\fBShorthand Example:\fR
.RS 2m
\-\-allowed\-ports=first=int,last=int
.RE
\fBJSON Example:\fR
.RS 2m
\-\-allowed\-ports='{"first": int, "last": int}'
.RE
\fBFile Example:\fR
.RS 2m
\-\-allowed\-ports=path_to_file.(yaml|json)
.RE
.TP 2m
\fB\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.TP 2m
\fB\-\-boot\-disk\-size\fR=\fIBOOT_DISK_SIZE\fR
Size of the boot disk in GB.
.TP 2m
\fB\-\-container\-args\fR=[\fICONTAINER_ARGS\fR,...]
Arguments passed to the entrypoint.
Example:
.RS 2m
$ gcloud workstations configs update \-\-container\-args=arg_1,arg_2
.RE
.TP 2m
\fB\-\-container\-command\fR=[\fICONTAINER_COMMAND\fR,...]
If set, overrides the default ENTRYPOINT specified by the image.
Example:
.RS 2m
$ gcloud workstations configs update \e
\-\-container\-command=executable,parameter_1,parameter_2
.RE
.TP 2m
\fB\-\-container\-env\fR=[\fICONTAINER_ENV\fR,...]
Environment variables passed to the container.
Example:
.RS 2m
$ gcloud workstations configs update \e
\-\-container\-env=key1=value1,key2=value2
.RE
.TP 2m
\fB\-\-container\-run\-as\-user\fR=\fICONTAINER_RUN_AS_USER\fR
If set, overrides the USER specified in the image with the given uid.
.TP 2m
\fB\-\-container\-working\-dir\fR=\fICONTAINER_WORKING_DIR\fR
If set, overrides the default DIR specified by the image.
.TP 2m
\fB\-\-disable\-public\-ip\-addresses\fR
Default value is false. If set, instances will have no public IP address.
.TP 2m
\fB\-\-enable\-audit\-agent\fR
Whether to enable Linux \f5auditd\fR logging on the workstation. When enabled, a
service account must also be specified that has \f5logging.buckets.write\fR
permission on the project.
.TP 2m
\fB\-\-enable\-confidential\-compute\fR
Default value is false. If set, instances will have confidential compute
enabled.
.TP 2m
\fB\-\-enable\-nested\-virtualization\fR
Default value is false. If set, instances will have nested virtualization
enabled.
.TP 2m
\fB\-\-grant\-workstation\-admin\-role\-on\-create\fR
Default value is false. If set, creator of a workstation will get
\f5roles/workstations.policyAdmin\fR role along with
\f5roles/workstations.user\fR role on the workstation created by them.
.TP 2m
\fB\-\-idle\-timeout\fR=\fIIDLE_TIMEOUT\fR
How long (in seconds) to wait before automatically stopping an instance that
hasn't received any user traffic. A value of 0 indicates that this instance
should never time out due to idleness.
.TP 2m
\fB\-\-labels\fR=[\fILABELS\fR,...]
Labels that are applied to the configuration and propagated to the underlying
Compute Engine resources.
Example:
.RS 2m
$ gcloud workstations configs update \e
\-\-labels=label1=value1,label2=value2
.RE
.TP 2m
\fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR
Machine type determines the specifications of the Compute Engine machines that
the workstations created under this configuration will run on.
.TP 2m
\fB\-\-max\-usable\-workstations\-count\fR=\fIMAX_USABLE_WORKSTATIONS_COUNT\fR
Maximum number of workstations under this configuration a user can have
\f5workstations.workstation.use\fR permission on.
If not specified, defaults to \f50\fR, which indicates a user can have unlimited
number of workstations under this configuration.
.TP 2m
\fB\-\-network\-tags\fR=[\fINETWORK_TAGS\fR,...]
Network tags to add to the Google Compute Engine machines backing the
Workstations.
Example:
.RS 2m
$ gcloud workstations configs update \-\-network\-tags=tag_1,tag_2
.RE
.TP 2m
\fB\-\-pool\-size\fR=\fIPOOL_SIZE\fR
Number of instances to pool for faster Workstation startup.
.TP 2m
\fB\-\-running\-timeout\fR=\fIRUNNING_TIMEOUT\fR
How long (in seconds) to wait before automatically stopping a workstation after
it started. A value of 0 indicates that workstations using this config should
never time out.
.TP 2m
\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR
Email address of the service account that will be used on VM instances used to
support this config. This service account must have permission to pull the
specified container image. If not set, VMs will run without a service account,
in which case the image must be publicly accessible.
.TP 2m
\fB\-\-service\-account\-scopes\fR=[\fISERVICE_ACCOUNT_SCOPES\fR,...]
Scopes to grant to the service_account. Various scopes are automatically added
based on feature usage. When specified, users of workstations under this
configuration must have iam.serviceAccounts.actAs\f5 on the service account.
.TP 2m
\fB\-\-shielded\-integrity\-monitoring\fR
Default value is false. If set, instances will have integrity monitoring
enabled.
.TP 2m
\fB\-\-shielded\-secure\-boot\fR
Default value is false. If set, instances will have Secure Boot enabled.
.TP 2m
\fB\-\-shielded\-vtpm\fR
Default value is false. If set, instances will have vTPM enabled.
.TP 2m
\fB\-\-vm\-tags\fR=[\fIVM_TAGS\fR,...]
Resource manager tags to be bound to the instance. Tag keys and values have the
same definition as
https://cloud.google.com/resource\-manager/docs/tags/tags\-overview
Example:
.RS 2m
$ gcloud workstations configs update \e
\-\-vm\-tags=tagKeys/key1=tagValues/value1,tagKeys/key2=tagValues/\e
value2
.RE
.TP 2m
Accelerator settings
.RS 2m
.TP 2m
\fB\-\-accelerator\-count\fR=\fIACCELERATOR_COUNT\fR
The number of accelerator cards exposed to the instance.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-accelerator\-type\fR=\fIACCELERATOR_TYPE\fR
The type of accelerator resource to attach to the instance, for example,
"nvidia\-tesla\-p100".
.RE
.sp
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-container\-custom\-image\fR=\fICONTAINER_CUSTOM_IMAGE\fR
A docker image for the workstation. This image must be accessible by the service
account configured in this configuration (\-\-service\-account). If no service
account is defined, this image must be public.
.TP 2m
\fB\-\-container\-predefined\-image\fR=\fICONTAINER_PREDEFINED_IMAGE\fR
Code editor on base images. \fICONTAINER_PREDEFINED_IMAGE\fR must be one of:
.RS 2m
.TP 2m
\fBbase\-image\fR
Base image \- no IDE
.TP 2m
\fBclion\fR
CLion
.TP 2m
\fBcodeoss\fR
Code OSS
.TP 2m
\fBcodeoss\-cuda\fR
Code OSS + CUDA toolkit
.TP 2m
\fBgoland\fR
GoLand
.TP 2m
\fBintellij\fR
IntelliJ IDEA Ultimate
.TP 2m
\fBphpstorm\fR
PhpStorm
.TP 2m
\fBpycharm\fR
PyCharm Professional
.TP 2m
\fBrider\fR
Rider
.TP 2m
\fBrubymine\fR
RubyMine
.TP 2m
\fBwebstorm\fR
WebStorm
.RE
.sp
.RE
.sp
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-disable\-ssh\-to\-vm\fR
If set, workstations disable SSH connections to the root VM.
.TP 2m
\fB\-\-enable\-ssh\-to\-vm\fR
If set, workstations enable SSH connections to the root VM.
.RE
.sp
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-disable\-tcp\-connections\fR
If set, workstations don't allow plain TCP connections.
.TP 2m
\fB\-\-enable\-tcp\-connections\fR
If set, workstations allow plain TCP connections.
.RE
.sp
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-pd\-source\-snapshot\fR=\fIPD_SOURCE_SNAPSHOT\fR
Name of the snapshot to use as the source for the persistent directory.
.TP 2m
\-\-pd\-source\-snapshot cannot be specified when \-\-pd\-disk\-size or
\-\-pd\-disk\-type is specified.
.RS 2m
.TP 2m
\fB\-\-pd\-disk\-size\fR=\fIPD_DISK_SIZE\fR
Size of the persistent directory in GB. \fIPD_DISK_SIZE\fR must be one of:
\fB10\fR, \fB50\fR, \fB100\fR, \fB200\fR, \fB500\fR, \fB1000\fR.
.TP 2m
\fB\-\-pd\-disk\-type\fR=\fIPD_DISK_TYPE\fR; default="pd\-standard"
Type of the persistent directory. \fIPD_DISK_TYPE\fR must be one of:
\fBpd\-standard\fR, \fBpd\-balanced\fR, \fBpd\-ssd\fR.
\fR
.RE
.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 "NOTES"
These variants are also available:
.RS 2m
$ gcloud alpha workstations configs update
.RE
.RS 2m
$ gcloud beta workstations configs update
.RE