Get Clusters
Released in v7.0.0.0 DescriptionReturns information about a specific cluster.
Request
URLURL
Parameters
Parameters
Header Parameters
Header Parameters
Response
Response BodyResponse Body
Information about the desired state of the specified cluster.
{
"Master_DNS_names": [
"string"
],
"api_server_cluster_endpoint": "string",
"api_server_management_endpoint": "string",
"api_servers": [
"string"
],
"config_status": "enum",
"default_image_registry": {
"hostname": "string",
"port": 0
},
"default_image_repository": "string",
"default_kubernetes_service_content_library": "string",
"ephemeral_storage_policy": "string",
"image_storage": {
"storage_policy": "string"
},
"kubernetes_status": "enum",
"kubernetes_status_messages": [
{
"severity": "enum"
}
],
"load_balancers": [
{
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"ha_proxy_info": {
"certificate_authority_chain": "string",
"servers": [
{
"host": "string",
"port": 0
}
],
"username": "string"
},
"id": "string",
"provider": "enum"
}
],
"login_banner": "string",
"master_DNS": [
"string"
],
"master_DNS_search_domains": [
"string"
],
"master_NTP_servers": [
"string"
],
"master_management_network": {
"address_range": {
"address_count": 0,
"gateway": "string",
"starting_address": "string",
"subnet_mask": "string"
},
"floating_IP": "string",
"mode": "enum",
"network": "string"
},
"master_storage_policy": "string",
"messages": [
{
"severity": "enum"
}
],
"ncp_cluster_network_info": {
"cluster_distributed_switch": "string",
"default_ingress_tls_certificate": "string",
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"nsx_edge_cluster": "string",
"pod_cidrs": [
{
"address": "string",
"prefix": 0
}
]
},
"network_provider": "enum",
"service_cidr": {
"address": "string",
"prefix": 0
},
"size_hint": "enum",
"stat_summary": {
"cpu_capacity": 0,
"cpu_used": 0,
"memory_capacity": 0,
"memory_used": 0,
"storage_capacity": 0,
"storage_used": 0
},
"tls_endpoint_certificate": "string",
"tls_management_endpoint_certificate": "string",
"worker_DNS": [
"string"
],
"workload_networks": {
"network_list": [
{
"network": "string",
"network_provider": "enum",
"vsphere_network": {
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"portgroup": "string",
"subnet_mask": "string"
}
}
],
"supervisor_primary_workload_network": {
"network": "string",
"network_provider": "enum",
"vsphere_network": {
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"portgroup": "string",
"subnet_mask": "string"
}
}
},
"workload_ntp_servers": [
"string"
]
}
Kubernetes API Server IP address via cluster network. This is the IP address of the Kubernetes LoadBalancer type service fronting the apiservers. This endpoint is the one configured in kubeconfig after login, and used for most human and application interaction with Kubernetes.
Kubernetes API Server IP address on the management network. This is a floating IP and assigned to one of the control plane VMs on the management network. This endpoint is used by vSphere components.
Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network.
Current setting for Clusters.ConfigStatus.
Possible values are:
Current setting for Clusters.KubernetesStatus.
Possible values are:
Current set of messages associated with the object.
Current set of messages associated with the object.
The provider of cluster networking for this vSphere Namespaces cluster.
Possible values are:
CIDR block from which Kubernetes allocates service cluster IP addresses.
List of additional DNS names to associate with the Kubernetes API server. These DNS names are embedded in the TLS certificate presented by the API server. If unset, no additional DNS names are embedded in the TLS certificate.
Default image registry to use when Kubernetes Pod container specification does not specify it as part of the container image name. If unset, defaults to Docker Hub.
Default image repository to use when Kubernetes Pod container specification does not specify it as part of the container image name. If unset, defaults to Docker Hub official repository in case of Docker Hub image registry, otherwise defaults to empty string.
Identifier of the Content Library which holds the VM Images for vSphere Kubernetes Service. This Content Library should be subscribed to VMware’s hosted vSphere Kubernetes Service Repository. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.
Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. This field is optional because it was added in a newer version than its parent node. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.
Specification for storage to be used for container images. This field is optional because it was added in a newer version than its parent node.
Information related to the Load balancer used for provisioning virtual servers in the namespace. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is VSPHERE_NETWORK.
Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, just skip it.
List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference.
List of domains (for example “vmware.com”) to be searched when trying to lookup a host name on Kubernetes API server, specified in order of preference.
List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference. If unset, VMware Tools based time synchronization is enabled.
Specification for the management network on Kubernetes API server. This field is optional because it was added in a newer version than its parent node.
Identifier of storage policy associated with Kubernetes API server. This field is optional because it was added in a newer version than its parent node. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.
Specification for the NSX Container Plugin cluster network. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is NSXT_CONTAINER_PLUGIN.
Current setting for SizingHint. This affects the size and resources allocated to the Kubernetes API server. This field is optional because it was added in a newer version than its parent node.
PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API servers when accessed via the load balancer, e.g. devops user on corporate network. This certificate is only valid for use with the apiServerClusterEndpoint.
PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API servers when accessed from the management network, e.g. from ESX servers or VCSA. This certificate is only valid for use with the apiServerManagementEndpoint.
List of DNS server IP addresses to use for pods that execute on the worker nodes (which are native pods on ESXi hosts in the vSphere Namespaces Supervisor).
Information about workload networks associated with the cluster. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is VSPHERE_NETWORK.
Information about NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference. This field is optional because it was added in a newer version than its parent node.