gcloud-help/gcloud/beta/container/vmware/clusters/enroll

NAME
    gcloud beta container vmware clusters enroll - enroll an Anthos cluster on
        VMware

SYNOPSIS
    gcloud beta 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
    (BETA) Enroll an Anthos cluster on VMware.

EXAMPLES
    To enroll a cluster named my-cluster managed in location us-west1 with
    admin cluster membership of
    projects/my-project/locations/us-west1/memberships/my-admin-cluster-membership,
    run:

        $ gcloud beta container vmware clusters enroll my-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 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 project attribute:
      ◆ provide the argument cluster on the command line with a fully
        specified name;
      ◆ provide the argument --project on 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 cluster attribute:
          ▸ provide the argument cluster on the command line.

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

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

          To set the location attribute:
          ▸ provide the argument cluster on the command line with a fully
            specified name;
          ▸ provide the argument --location on the command line;
          ▸ set the property container_vmware/location.

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

     Examples:

         $ gcloud beta container vmware clusters enroll
               --admin-cluster-membership=projects/example-project-12345/locations/us-west1/memberships/example-admin-cluster-name

     or

         $ gcloud beta container vmware clusters enroll
               --admin-cluster-membership-project=example-project-12345
               --admin-cluster-membership-location=us-west1
               --admin-cluster-membership=example-admin-cluster-name

         The arguments in this group can be used to specify the attributes of this resource.

     This must be specified.

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

          To set the admin_cluster_membership attribute:
          ▸ provide the argument --admin-cluster-membership on the command
            line.

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

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

          To set the location attribute:
          ▸ provide the argument --admin-cluster-membership on the command
            line with a fully specified name;
          ▸ provide the argument --admin-cluster-membership-location on the
            command line.

       --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT
          Google Cloud project for the admin_cluster_membership.

          To set the project attribute:
          ▸ provide the argument --admin-cluster-membership on the command
            line with a fully specified name;
          ▸ provide the argument --admin-cluster-membership-project on the
            command 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 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.

     --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
    This command is currently in beta and might change without notice. This
    variant is also available:

        $ gcloud alpha container vmware clusters enroll