gcloud container vmware clusters enroll

NAME
gcloud container vmware clusters enroll - enroll an Anthos cluster on VMware
SYNOPSIS
gcloud container vmware clusters enroll(CLUSTER :--location=LOCATION)(--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP :--admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION--admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT)[--async][--local-name=LOCAL_NAME][--validate-only][GCLOUD_WIDE_FLAG]
DESCRIPTION
Enroll an Anthos cluster on VMware.
EXAMPLES
To enroll a cluster namedmy-clustermanaged in locationus-west1 with admincluster membership ofprojects/my-project/locations/us-west1/memberships/my-admin-cluster-membership,run:
gcloudcontainervmwareclustersenrollmy-cluster--location=us-west1--admin-cluster-membership=projects/my-project/locations/us-west1/memberships/my-admin-cluster-membership
POSITIONAL ARGUMENTS
Cluster resource - cluster to enroll The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentcluster on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

CLUSTER
ID of the cluster or fully qualified identifier for the cluster.

To set thecluster attribute:

  • provide the argumentcluster on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--location=LOCATION
Google Cloud location for the cluster.

To set thelocation attribute:

  • provide the argumentcluster on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertycontainer_vmware/location.
REQUIRED FLAGS
Admin cluster membership resource - membership of the admin cluster. Membershipname is the same as the admin cluster name.

Examples:

gcloudcontainervmwareclustersenroll--admin-cluster-membership=projects/example-project-12345/locations/us-west1/memberships/example-admin-cluster-name

or

gcloudcontainervmwareclustersenroll--admin-cluster-membership-project=example-project-12345--admin-cluster-membership-location=us-west1--admin-cluster-membership=example-admin-cluster-name
Theargumentsinthisgroupcanbeusedtospecifytheattributesofthisresource.

This must be specified.

--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP
ID of the admin_cluster_membership or fully qualified identifier for theadmin_cluster_membership.

To set theadmin_cluster_membership attribute:

  • provide the argument--admin-cluster-membership on the commandline.

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

--admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION
Google Cloud location for the admin_cluster_membership.

To set thelocation attribute:

  • provide the argument--admin-cluster-membership on the command linewith a fully specified name;
  • provide the argument--admin-cluster-membership-location on thecommand line.
--admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT
Google Cloud project for the admin_cluster_membership.

To set theproject attribute:

  • provide the argument--admin-cluster-membership on the command linewith a fully specified name;
  • provide the argument--admin-cluster-membership-project on thecommand line.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--local-name=LOCAL_NAME
The object name of the VMware OnPremUserCluster custom resource on theassociated admin cluster. This field is used to support conflicting resourcenames when enrolling existing clusters to the API. When not provided, this fieldwill resolve to the vmware_cluster_id. Otherwise, it must match the object nameof the VMware OnPremUserCluster custom resource. It is not modifiable outside /beyond the enrollment operation.
--validate-only
If set, only validate the request, but do not actually perform the operation.
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$gcloud help for details.

NOTES
These variants are also available:
gcloudalphacontainervmwareclustersenroll
gcloudbetacontainervmwareclustersenroll

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-22 UTC.