vmware_admin_clusters

Creates, updates, deletes, gets or lists a vmware_admin_clusters resource.

Overview

Name	vmware_admin_clusters
Type	Resource
Id	google.gkeonprem.vmware_admin_clusters

Fields

Name	Datatype	Description
name	string	Immutable. The VMware admin cluster resource name.
description	string	A human readable description of this VMware admin cluster.
addonNode	object	VmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster.
annotations	object	Annotations 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.
antiAffinityGroups	object	Specifies anti affinity group config for the VMware user cluster.
authorization	object	VmwareAdminAuthorizationConfig represents configuration for admin cluster authorization.
autoRepairConfig	object	Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true.
bootstrapClusterMembership	string	The bootstrap cluster this VMware admin cluster belongs to.
controlPlaneNode	object	VmwareAdminControlPlaneNodeConfig contains control plane node configuration for VMware admin cluster.
createTime	string	Output only. The time at which VMware admin cluster was created.
endpoint	string	Output only. The DNS name of VMware admin cluster's API server.
etag	string	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.
fleet	object	Fleet 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. ##
imageType	string	The OS image type for the VMware admin cluster.
loadBalancer	object	VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster.
localName	string	Output 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.
networkConfig	object	VmwareAdminNetworkConfig contains network configuration for VMware admin cluster.
onPremVersion	string	The Anthos clusters on the VMware version for the admin cluster.
platformConfig	object	VmwarePlatformConfig represents configuration for the VMware platform.
preparedSecrets	object	VmwareAdminPreparedSecretsConfig represents configuration for admin cluster prepared secrets.
reconciling	boolean	Output only. If set, there are currently changes in flight to the VMware admin cluster.
state	string	Output only. The current state of VMware admin cluster.
status	object	ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED).
uid	string	Output only. The unique identifier of the VMware admin cluster.
updateTime	string	Output only. The time at which VMware admin cluster was last updated.
validationCheck	object	ValidationCheck represents the result of preflight check.
vcenter	object	VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster.

Methods

Name	Accessible by	Required Params	Description
projects_locations_vmware_admin_clusters_get	SELECT	locationsId, projectsId, vmwareAdminClustersId	Gets details of a single VMware admin cluster.
projects_locations_vmware_admin_clusters_list	SELECT	locationsId, projectsId	Lists VMware admin clusters in a given project and location.
projects_locations_vmware_admin_clusters_patch	UPDATE	locationsId, projectsId, vmwareAdminClustersId	Updates the parameters of a single VMware admin cluster.
projects_locations_vmware_admin_clusters_enroll	EXEC	locationsId, projectsId	Enrolls 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_unenroll	EXEC	locationsId, projectsId, vmwareAdminClustersId	Unenrolls 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.

SELECT examples

Lists VMware admin clusters in a given project and location.

SELECT
name,
description,
addonNode,
annotations,
antiAffinityGroups,
authorization,
autoRepairConfig,
bootstrapClusterMembership,
controlPlaneNode,
createTime,
endpoint,
etag,
fleet,
imageType,
loadBalancer,
localName,
networkConfig,
onPremVersion,
platformConfig,
preparedSecrets,
reconciling,
state,
status,
uid,
updateTime,
validationCheck,
vcenter
FROM google.gkeonprem.vmware_admin_clusters
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

UPDATE example

Updates a vmware_admin_clusters resource.

/*+ update */
UPDATE google.gkeonprem.vmware_admin_clusters
SET 
name = '{{ name }}',
description = '{{ description }}',
etag = '{{ etag }}',
annotations = '{{ annotations }}',
bootstrapClusterMembership = '{{ bootstrapClusterMembership }}',
onPremVersion = '{{ onPremVersion }}',
imageType = '{{ imageType }}',
vcenter = '{{ vcenter }}',
networkConfig = '{{ networkConfig }}',
loadBalancer = '{{ loadBalancer }}',
controlPlaneNode = '{{ controlPlaneNode }}',
addonNode = '{{ addonNode }}',
antiAffinityGroups = '{{ antiAffinityGroups }}',
autoRepairConfig = '{{ autoRepairConfig }}',
platformConfig = '{{ platformConfig }}',
authorization = '{{ authorization }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND vmwareAdminClustersId = '{{ vmwareAdminClustersId }}';