NamespaceManagementClustersInfo

The Clusters.Info structure contains detailed information about the cluster statistics and status related to vSphere Namespaces.


Properties

array of string
Master_DNS_names Optional

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.


string
api_server_cluster_endpoint Required

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.


string
api_server_management_endpoint Required

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.


array of string
api_servers Required

Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network.


config_status Required

Current setting for Clusters.ConfigStatus.


default_image_registry Optional

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.


string
default_image_repository Optional

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.


string
default_kubernetes_service_content_library Optional

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.


string
ephemeral_storage_policy Optional

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.


image_storage Optional

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.


kubernetes_status Required

Current setting for Clusters.KubernetesStatus.


kubernetes_status_messages Required

Current set of messages associated with the object.


load_balancers Optional

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.


string
login_banner Optional

Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, just skip it.


array of string
master_DNS Optional

List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference.


array of string
master_DNS_search_domains Optional

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.


array of string
master_NTP_servers Optional

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.


master_management_network Optional

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.


string
master_storage_policy Optional

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.


messages Required

Current set of messages associated with the object.


ncp_cluster_network_info Optional

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.


network_provider Required

The provider of cluster networking for this vSphere Namespaces cluster.


service_cidr Required

CIDR block from which Kubernetes allocates service cluster IP addresses.


size_hint Optional

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.


stat_summary Required

Basic runtime statistics for the cluster.


string
tls_endpoint_certificate Optional

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.


string
tls_management_endpoint_certificate Optional

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.


array of string
worker_DNS Optional

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


workload_networks Optional

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.


array of string
workload_ntp_servers Optional

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.

Returned By

Get Clusters

JSON Example

{
    "api_server_cluster_endpoint": "string",
    "api_server_management_endpoint": "string",
    "api_servers": [
        "string"
    ],
    "config_status": "enum",
    "kubernetes_status": "enum",
    "kubernetes_status_messages": [
        {
            "severity": "enum"
        }
    ],
    "messages": [
        {
            "severity": "enum"
        }
    ],
    "network_provider": "enum",
    "service_cidr": {
        "address": "string",
        "prefix": 0
    },
    "stat_summary": {
        "cpu_capacity": 0,
        "cpu_used": 0,
        "memory_capacity": 0,
        "memory_used": 0,
        "storage_capacity": 0,
        "storage_used": 0
    }
}
Feedback

Was this page helpful?