Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1331159174.5 KB
projects

Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

post/v1/{+parent}/vmwareClusters:enroll

Path parameters

parentstring required

Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/{project}/locations/{location}"

Request body

localNamestring

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

adminClusterMembershipstring

Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.

validateOnlyboolean

Validate the request without actually doing any updates.

vmwareClusterIdstring

User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists. (https://tools.ietf.org/html/rfc1123) format.

Response

Successful response