gcloud container vmware clusters enroll Stay organized with collections Save and categorize content based on your preferences.
- 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 named
managed in locationmy-clusterwith admincluster membership ofus-west1,run:projects/my-project/locations/us-west1/memberships/my-admin-cluster-membershipgcloudcontainervmwareclustersenrollmy-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 the
projectattribute:- provide the argument
clusteron the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
CLUSTER- ID of the cluster or fully qualified identifier for the cluster.
To set the
clusterattribute:- provide the argument
clusteron the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- Google Cloud location for the cluster.
To set the
locationattribute:- provide the argument
clusteron the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
container_vmware/location.
- provide the argument
- provide the argument
- 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.
- 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-nameor
gcloudcontainervmwareclustersenroll--admin-cluster-membership-project=example-project-12345--admin-cluster-membership-location=us-west1--admin-cluster-membership=example-admin-cluster-nameTheargumentsinthisgroupcanbeusedtospecifytheattributesofthisresource.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 the
admin_cluster_membershipattribute:- provide the argument
--admin-cluster-membershipon the commandline.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION- Google Cloud location for the admin_cluster_membership.
To set the
locationattribute:- provide the argument
--admin-cluster-membershipon the command linewith a fully specified name; - provide the argument
--admin-cluster-membership-locationon thecommand line.
- provide the argument
--admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT- Google Cloud project for the admin_cluster_membership.
To set the
projectattribute:- provide the argument
--admin-cluster-membershipon the command linewith a fully specified name; - provide the argument
--admin-cluster-membership-projecton thecommand line.
- provide the argument
- Admin cluster membership resource - membership of the admin cluster. Membershipname is the same as the admin cluster name.
- 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 helpfor details. - NOTES
- These variants are also available:
gcloudalphacontainervmwareclustersenrollgcloudbetacontainervmwareclustersenroll
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.