Skip to main content

vmware_admin_clusters

Overview

Namevmware_admin_clusters
TypeResource
Idgoogle.gkeonprem.vmware_admin_clusters

Fields

NameDatatypeDescription
namestringImmutable. The VMware admin cluster resource name.
descriptionstringA human readable description of this VMware admin cluster.
addonNodeobjectVmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster.
annotationsobjectAnnotations on the VMware admin 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.
antiAffinityGroupsobjectSpecifies anti affinity group config for the VMware user cluster.
autoRepairConfigobjectSpecifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true.
bootstrapClusterMembershipstringThe bootstrap cluster this VMware admin cluster belongs to.
controlPlaneNodeobjectVmwareAdminControlPlaneNodeConfig contains control plane node configuration for VMware admin cluster.
createTimestringOutput only. The time at which VMware admin cluster was created.
endpointstringOutput only. The DNS name of VMware admin cluster's API server.
etagstringThis 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.
fleetobjectFleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See Anthos Fleets for more details on Anthos multi-cluster capabilities using Fleets. ##
imageTypestringThe OS image type for the VMware admin cluster.
loadBalancerobjectVmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster.
localNamestringOutput only. The object name of the VMware OnPremAdminCluster custom resource. 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.
networkConfigobjectVmwareAdminNetworkConfig contains network configuration for VMware admin cluster.
onPremVersionstringThe Anthos clusters on the VMware version for the admin cluster.
platformConfigobjectVmwarePlatformConfig represents configuration for the VMware platform.
reconcilingbooleanOutput only. If set, there are currently changes in flight to the VMware admin cluster.
statestringOutput only. The current state of VMware admin cluster.
statusobjectResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED).
uidstringOutput only. The unique identifier of the VMware admin cluster.
updateTimestringOutput only. The time at which VMware admin cluster was last updated.
vcenterobjectVmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_vmware_admin_clusters_getSELECTlocationsId, projectsId, vmwareAdminClustersIdGets details of a single VMware admin cluster.
projects_locations_vmware_admin_clusters_listSELECTlocationsId, projectsIdLists VMware admin clusters in a given project and location.
_projects_locations_vmware_admin_clusters_listEXEClocationsId, projectsIdLists VMware admin clusters in a given project and location.
projects_locations_vmware_admin_clusters_enrollEXEClocationsId, projectsIdEnrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.
projects_locations_vmware_admin_clusters_patchEXEClocationsId, projectsId, vmwareAdminClustersIdUpdates the parameters of a single VMware admin cluster.
projects_locations_vmware_admin_clusters_unenrollEXEClocationsId, projectsId, vmwareAdminClustersIdUnenrolls an existing VMware admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.