.TH "GCLOUD_ALPHA_CONTAINER_VMWARE_CLUSTERS_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha container vmware clusters update \- update an Anthos cluster on VMware



.SH "SYNOPSIS"
.HP
\f5gcloud alpha container vmware clusters update\fR (\fICLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-admin\-users\fR=\fIADMIN_USERS\fR] [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-metal\-lb\-config\-address\-pools\fR=[\fIaddresses\fR=\fIADDRESSES\fR],[\fIavoid\-buggy\-ips\fR=\fIAVOID\-BUGGY\-IPS\fR],[\fImanual\-assign\fR=\fIMANUAL\-ASSIGN\fR],[\fIpool\fR=\fIPOOL\fR]] [\fB\-\-static\-ip\-config\-ip\-blocks\fR=[\fIgateway\fR=\fIGATEWAY\fR],[\fIips\fR=\fIIPS\fR],[\fInetmask\fR=\fINETMASK\fR]] [\fB\-\-upgrade\-policy\fR=[\fIcontrol\-plane\-only\fR=\fICONTROL\-PLANE\-ONLY\fR]] [\fB\-\-validate\-only\fR] [\fB\-\-version\fR=\fIVERSION\fR] [\fB\-\-add\-annotations\fR=[\fIKEY1\fR=\fIVALUE1\fR,\fIKEY2\fR=\fIVALUE2\fR,...]\ |\ \fB\-\-remove\-annotations\fR=[\fIKEY1\fR,\fIKEY2\fR,...]] [\fB\-\-cpus\fR=\fICPUS\fR\ \fB\-\-memory\fR=\fIMEMORY\fR\ \fB\-\-disable\-auto\-resize\fR\ |\ \fB\-\-enable\-auto\-resize\fR] [\fB\-\-disable\-aag\-config\fR\ |\ \fB\-\-enable\-aag\-config\fR] [\fB\-\-disable\-auto\-repair\fR\ |\ \fB\-\-enable\-auto\-repair\fR] [\fB\-\-disable\-vsphere\-csi\fR\ |\ \fB\-\-enable\-vsphere\-csi\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update an Anthos cluster on VMware.



.SH "EXAMPLES"

To update a cluster named \f5\fImy\-cluster\fR\fR managed in location
\f5\fIus\-west1\fR\fR, run:

.RS 2m
$ gcloud alpha container vmware clusters update my\-cluster \e
    \-\-location=us\-west1
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Cluster resource \- cluster to update 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\-\-location\fR=\fILOCATION\fR

Google Cloud location for the cluster.

To set the \f5location\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\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5container_vmware/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m

User cluster authorization configurations to bootstrap onto the admin cluster


.RS 2m
.TP 2m
\fB\-\-admin\-users\fR=\fIADMIN_USERS\fR

Users that will be granted the cluster\-admin role on the cluster, providing
full access to the cluster.

To add multiple users, specify one in each flag. When updating, the update
command overwrites the whole grant list. Specify all existing and new users that
you want to be cluster administrators.

Examples:

.RS 2m
$ gcloud alpha container vmware clusters update
    \-\-admin\-users alice@example.com
    \-\-admin\-users bob@example.com
.RE

.RE
.sp
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description for the resource.

.TP 2m

Anthos on VMware cluster load balancer configurations


.RS 2m
.TP 2m

Populate one of the load balancers.


.RS 2m
.TP 2m

MetalLB Configuration

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-metal\-lb\-config\-address\-pools\fR=[\fIaddresses\fR=\fIADDRESSES\fR],[\fIavoid\-buggy\-ips\fR=\fIAVOID\-BUGGY\-IPS\fR],[\fImanual\-assign\fR=\fIMANUAL\-ASSIGN\fR],[\fIpool\fR=\fIPOOL\fR]

MetalLB load balancer configurations.

Examples:

To specify MetalLB load balancer configurations for two address pools
\f5pool1\fR and \f5pool2\fR,

.RS 2m
$ gcloud gcloud alpha container vmware clusters update
    \-\-metal\-lb\-config\-address\-pools 'pool=pool1,avoid\-buggy\-ips=True,manual\-assign=True,addresses=192.168.1.1/32;192.168.1.2\-192.168.1.3'
    \-\-metal\-lb\-config\-address\-pools 'pool=pool2,avoid\-buggy\-ips=False,manual\-assign=False,addresses=192.168.2.1/32;192.168.2.2\-192.168.2.3'
.RE

Use quote around the flag value to escape semicolon in the terminal.

.RE
.RE
.RE
.sp
.TP 2m

VMware User Cluster network configurations


.RS 2m
.TP 2m

IP configuration used by the VMware User Cluster


.RS 2m
.TP 2m

Static IP configuration group

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-static\-ip\-config\-ip\-blocks\fR=[\fIgateway\fR=\fIGATEWAY\fR],[\fIips\fR=\fIIPS\fR],[\fInetmask\fR=\fINETMASK\fR]

Static IP configurations.

Expect an individual IP address, an individual IP address with an optional
hostname, or a CIDR block.

Example:

To specify two Static IP blocks,

.RS 2m
$ gcloud gcloud alpha container vmware clusters update
    \-\-static\-ip\-config\-ip\-blocks 'gateway=192.168.0.1,netmask=255.255.255.0,ips=192.168.1.1;0.0.0.0 localhost;192.168.1.2/16'
    \-\-static\-ip\-config\-ip\-blocks 'gateway=192.168.1.1,netmask=255.255.0.0,ips=8.8.8.8;4.4.4.4'
.RE

Use quote around the flag value to escape semicolon in the terminal.

.RE
.RE
.RE
.sp
.TP 2m

Upgrade policy for the cluster.


.RS 2m
.TP 2m
\fB\-\-upgrade\-policy\fR=[\fIcontrol\-plane\-only\fR=\fICONTROL\-PLANE\-ONLY\fR]

If not specified, control\-plane\-only is set to False. In the next upgrade
operation, all worker node pools will be upgraded together with the control
plane.

Example:

.RS 2m
To upgrade the control plane only and keep worker node pools version unchanged, first specify the policy:
.RE

.RS 2m
$ gcloud alpha container vmware clusters update CLUSTER \e
  \-\-upgrade\-policy control\-plane\-only=True
.RE

.RS 2m
Then to start the upgrade operation using the specified policy, run:
.RE

.RS 2m
$ gcloud alpha container vmware clusters upgrade CLUSTER \e
  \-\-version=VERSION
.RE

.RS 2m
After upgrading only the cluster control plane, to upgrade an individual node pool, run:
.RE

.RS 2m
$ gcloud alpha container vmware node\-pools update NODE_POOL \e
  \-\-version=VERSION
.RE

Example:

.RS 2m
Alternatively, to upgrade both the control plane and all worker node pools, first specify the policy:
.RE

.RS 2m
$ gcloud alpha container vmware clusters update CLUSTER \e
  \-\-upgrade\-policy control\-plane\-only=False
.RE

.RS 2m
Then to start the upgrade operation using the specified policy, run:
.RE

.RS 2m
$ gcloud alpha container vmware clusters upgrade CLUSTER \e
  \-\-version=VERSION
.RE

.RE
.sp
.TP 2m
\fB\-\-validate\-only\fR

If set, only validate the request, but do not actually perform the operation.

.TP 2m
\fB\-\-version\fR=\fIVERSION\fR

Anthos Cluster on VMware version for the cluster resource

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-add\-annotations\fR=[\fIKEY1\fR=\fIVALUE1\fR,\fIKEY2\fR=\fIVALUE2\fR,...]

Add the given key\-value pairs to the current annotations, or update its value
if the key already exists.

.TP 2m
\fB\-\-remove\-annotations\fR=[\fIKEY1\fR,\fIKEY2\fR,...]

Remove annotations of the given keys.

.RE
.sp
.TP 2m

Control plane node configurations


.RS 2m
.TP 2m
\fB\-\-cpus\fR=\fICPUS\fR

Number of CPUs for each admin cluster node that serve as control planes for this
VMware user cluster. (default: 4 CPUs)

.TP 2m
\fB\-\-memory\fR=\fIMEMORY\fR

Megabytes of memory for each admin cluster node that serves as a control plane
for this VMware User Cluster (default: 8192 MB memory).

.TP 2m

Auto resize configurations


.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-auto\-resize\fR

Disable controle plane node auto resize.

.TP 2m
\fB\-\-enable\-auto\-resize\fR

Enable controle plane node auto resize.

.RE
.RE
.RE
.sp
.TP 2m

Anti\-affinity group configurations


.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-aag\-config\fR

If set, spread nodes across at least three physical hosts (requires at least
three hosts). Enabled by default.

.TP 2m
\fB\-\-enable\-aag\-config\fR

If set, enable anti\-affinity group config.

.RE
.RE
.sp
.TP 2m

Auto\-repair configurations


.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-auto\-repair\fR

If set, disables auto repair.

.TP 2m
\fB\-\-enable\-auto\-repair\fR

If set, deploy the cluster\-health\-controller.

.RE
.RE
.sp
.TP 2m

Storage configurations


.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-vsphere\-csi\fR

If set, vSphere CSI components are not deployed in the VMware User Cluster.
Enabled by default.

.TP 2m
\fB\-\-enable\-vsphere\-csi\fR

If set, vSphere CSI components are deployed in the VMware User Cluster.


.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"

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 container vmware clusters update
.RE

.RS 2m
$ gcloud beta container vmware clusters update
.RE