.TH "GCLOUD_CONTAINER_VMWARE_CLUSTERS_ENROLL" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud container vmware clusters enroll\fR (\fICLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-admin\-cluster\-membership\fR=\fIADMIN_CLUSTER_MEMBERSHIP\fR\ :\ \fB\-\-admin\-cluster\-membership\-location\fR=\fIADMIN_CLUSTER_MEMBERSHIP_LOCATION\fR\ \fB\-\-admin\-cluster\-membership\-project\fR=\fIADMIN_CLUSTER_MEMBERSHIP_PROJECT\fR) [\fB\-\-async\fR] [\fB\-\-local\-name\fR=\fILOCAL_NAME\fR] [\fB\-\-validate\-only\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Enroll an Anthos cluster on VMware.



.SH "EXAMPLES"

To enroll a cluster named \f5\fImy\-cluster\fR\fR managed in location
\f5\fIus\-west1\fR\fR with admin cluster membership of
\f5\fIprojects/my\-project/locations/us\-west1/memberships/my\-admin\-cluster\-membership\fR\fR,
run:

.RS 2m
$ gcloud container vmware clusters enroll my\-cluster \e
    \-\-location=us\-west1 \e
    \-\-admin\-cluster\-membership=projects/my\-project/locations/\e
us\-west1/memberships/my\-admin\-cluster\-membership
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Cluster resource \- cluster to enroll 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 "REQUIRED FLAGS"

.RS 2m
.TP 2m

Admin cluster membership resource \- membership of the admin cluster. Membership
name is the same as the admin cluster name.

Examples:

.RS 2m
$ gcloud container vmware clusters enroll
      \-\-admin\-cluster\-membership=projects/example\-project\-12345/locations/us\-west1/memberships/example\-admin\-cluster\-name
.RE

or

.RS 2m
$ gcloud container vmware clusters enroll
      \-\-admin\-cluster\-membership\-project=example\-project\-12345
      \-\-admin\-cluster\-membership\-location=us\-west1
      \-\-admin\-cluster\-membership=example\-admin\-cluster\-name
.RE

.RS 2m
The arguments in this group can be used to specify the attributes of this resource.
.RE

This must be specified.


.RS 2m
.TP 2m
\fB\-\-admin\-cluster\-membership\fR=\fIADMIN_CLUSTER_MEMBERSHIP\fR

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

To set the \f5admin_cluster_membership\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-admin\-cluster\-membership\fR on the command line.
.RE
.sp

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-admin\-cluster\-membership\-location\fR=\fIADMIN_CLUSTER_MEMBERSHIP_LOCATION\fR

Google Cloud location for the admin_cluster_membership.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-admin\-cluster\-membership\fR on the command line
with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-admin\-cluster\-membership\-location\fR on the
command line.
.RE
.sp

.TP 2m
\fB\-\-admin\-cluster\-membership\-project\fR=\fIADMIN_CLUSTER_MEMBERSHIP_PROJECT\fR

Google Cloud project for the admin_cluster_membership.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-admin\-cluster\-membership\fR on the command line
with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-admin\-cluster\-membership\-project\fR on the
command line.
.RE
.sp


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

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

.TP 2m
\fB\-\-local\-name\fR=\fILOCAL_NAME\fR

The object name of the VMware OnPremUserCluster custom resource on the
associated admin cluster. This field is used to support conflicting resource
names when enrolling existing clusters to the API. When not provided, this field
will resolve to the vmware_cluster_id. Otherwise, it must match the object name
of the VMware OnPremUserCluster custom resource. It is not modifiable outside /
beyond the enrollment operation.

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

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


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

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