Post v1+parentvmwareclusters — gkeonprem

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1331159174.5 KB

projects

Creates a new VMware user cluster in a given project and location.

post/v1/{+parent}/vmwareClusters

Path parameters

parentstring required

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

Query parameters

allowPreflightFailureboolean

Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.

skipValidationsstring[]

Optional. List of validations to skip during cluster creation.

validateOnlyboolean

Validate the request without actually doing any updates.

vmwareClusterIdstring

User provided identifier that is used as part of the resource name; This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format.

Request body

descriptionstring

A human readable description of this VMware user cluster.

onPremVersionstring

Required. The Anthos clusters on the VMware version for your user cluster.

uidstring

Output only. The unique identifier of the VMware user cluster.

enableAdvancedClusterboolean

Enable advanced cluster.

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.

reconcilingboolean

Output only. If set, there are currently changes in flight to the VMware user cluster.

annotationsobject

Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

vmTrackingEnabledboolean

Enable VM tracking.

namestring

Immutable. The VMware user cluster resource name.

localNamestring

Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.

endpointstring

Output only. The DNS name of VMware user cluster's API server.

updateTimestring google-datetime

Output only. The time at which VMware user cluster was last updated.

Output only. The current state of VMware user cluster.

adminClusterNamestring

Output only. The resource name of the VMware admin cluster hosting this user cluster.

etagstring

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

enableControlPlaneV2boolean

Enable control plane V2. Default to false.

deleteTimestring google-datetime

Output only. The time at which VMware user cluster was deleted.

createTimestring google-datetime

Output only. The time at which VMware user cluster was created.

disableBundledIngressboolean

Disable bundled ingress.

Response

Successful response