vcenter namespace management clusters: info
The
info structure contains detailed information about the cluster statistics and status related to vSphere Namespaces.Representation:
{
"stat_summary" : {
"cpu_used" : 1,
"storage_capacity" : 1,
"memory_used" : 1,
"cpu_capacity" : 1,
"memory_capacity" : 1,
"storage_used" : 1
},
"master_DNS_search_domains" : [
"string",
"string"
],
"api_server_cluster_endpoint" : "string",
"api_servers" : [
"string",
"string"
],
"ncp_cluster_network_info" : {
"default_ingress_tls_certificate" : "string",
"nsx_edge_cluster" : "obj-103",
"pod_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"egress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"cluster_distributed_switch" : "obj-103",
"ingress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
]
},
"api_server_management_endpoint" : "string",
"config_status" : "CONFIGURING",
"tls_management_endpoint_certificate" : "string",
"service_cidr" : {
"address" : "string",
"prefix" : 1
},
"worker_DNS" : [
"string",
"string"
],
"master_DNS" : [
"string",
"string"
],
"kubernetes_status" : "READY",
"kubernetes_status_messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"tls_endpoint_certificate" : "string",
"messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"default_kubernetes_service_content_library" : "obj-103"
}
"stat_summary" : {
"cpu_used" : 1,
"storage_capacity" : 1,
"memory_used" : 1,
"cpu_capacity" : 1,
"memory_capacity" : 1,
"storage_used" : 1
},
"master_DNS_search_domains" : [
"string",
"string"
],
"api_server_cluster_endpoint" : "string",
"api_servers" : [
"string",
"string"
],
"ncp_cluster_network_info" : {
"default_ingress_tls_certificate" : "string",
"nsx_edge_cluster" : "obj-103",
"pod_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"egress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"cluster_distributed_switch" : "obj-103",
"ingress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
]
},
"api_server_management_endpoint" : "string",
"config_status" : "CONFIGURING",
"tls_management_endpoint_certificate" : "string",
"service_cidr" : {
"address" : "string",
"prefix" : 1
},
"worker_DNS" : [
"string",
"string"
],
"master_DNS" : [
"string",
"string"
],
"kubernetes_status" : "READY",
"kubernetes_status_messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"tls_endpoint_certificate" : "string",
"messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"default_kubernetes_service_content_library" : "obj-103"
}
{
"stat_summary" : {
"cpu_used" : 1,
"storage_capacity" : 1,
"memory_used" : 1,
"cpu_capacity" : 1,
"memory_capacity" : 1,
"storage_used" : 1
},
"master_DNS_search_domains" : [
"string",
"string"
],
"api_server_cluster_endpoint" : "string",
"api_servers" : [
"string",
"string"
],
"ncp_cluster_network_info" : {
"default_ingress_tls_certificate" : "string",
"nsx_edge_cluster" : "obj-103",
"pod_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"egress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"cluster_distributed_switch" : "obj-103",
"ingress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
]
},
"api_server_management_endpoint" : "string",
"config_status" : "CONFIGURING",
"tls_management_endpoint_certificate" : "string",
"service_cidr" : {
"address" : "string",
"prefix" : 1
},
"worker_DNS" : [
"string",
"string"
],
"master_DNS" : [
"string",
"string"
],
"kubernetes_status" : "READY",
"kubernetes_status_messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"tls_endpoint_certificate" : "string",
"messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"default_kubernetes_service_content_library" : "obj-103"
}
"stat_summary" : {
"cpu_used" : 1,
"storage_capacity" : 1,
"memory_used" : 1,
"cpu_capacity" : 1,
"memory_capacity" : 1,
"storage_used" : 1
},
"master_DNS_search_domains" : [
"string",
"string"
],
"api_server_cluster_endpoint" : "string",
"api_servers" : [
"string",
"string"
],
"ncp_cluster_network_info" : {
"default_ingress_tls_certificate" : "string",
"nsx_edge_cluster" : "obj-103",
"pod_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"egress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
],
"cluster_distributed_switch" : "obj-103",
"ingress_cidrs" : [
{
"address" : "string",
"prefix" : 1
},
{
"address" : "string",
"prefix" : 1
}
]
},
"api_server_management_endpoint" : "string",
"config_status" : "CONFIGURING",
"tls_management_endpoint_certificate" : "string",
"service_cidr" : {
"address" : "string",
"prefix" : 1
},
"worker_DNS" : [
"string",
"string"
],
"master_DNS" : [
"string",
"string"
],
"kubernetes_status" : "READY",
"kubernetes_status_messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"tls_endpoint_certificate" : "string",
"messages" : [
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"severity" : "INFO",
"details" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"default_kubernetes_service_content_library" : "obj-103"
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.stat_summary | stats | Basic runtime statistics for the cluster. |
| -.stat_summary.cpu_used | long | Overall CPU usage of the cluster, in MHz. This is the sum of CPU usage across all worker nodes in the cluster. |
| -.stat_summary.cpu_capacity | long | Total CPU capacity in the cluster available for vSphere Namespaces, in MHz. This is the sum of CPU capacities from all worker nodes in the cluster. |
| -.stat_summary.memory_used | long | Overall memory usage of the cluster, in mebibytes. This is the sum of memory usage across all worker nodes in the cluster. |
| -.stat_summary.memory_capacity | long | Total memory capacity of the cluster available for vSphere Namespaces, in mebibytes. This is the sum of memory capacities from all worker nodesin the cluster. |
| -.stat_summary.storage_used | long | Overall storage used by the cluster, in mebibytes. This is the sum of storage used across all worker nodes in the cluster. |
| -.stat_summary.storage_capacity | long | Overall storage capacity of the cluster available for vSphere Namespaces, in mebibytes. This is the sum of total storage available from all worker nodes in the cluster. |
| -.config_status | string | Current setting for config_status. Describes the status of reaching the desired state configuration for the cluster. Value is one of:CONFIGURING: The Namespace configuration is being applied to the cluster. REMOVING: The Namespace configuration is being removed from the cluster. RUNNING: The cluster is configured correctly with the Namespace configuration. ERROR: Failed to apply the Namespace configuration to the cluster, user intervention needed. |
| -.messages | message[] | Current set of messages associated with the object. |
| -.messages[].severity | string | Type of the message. Represents the severity of the message. Value is one of: INFO: Informational message. This may be accompanied by vCenter event. WARNING: Warning message. This may be accompanied by vCenter event. ERROR: Error message. This is accompanied by vCenter event and/or alarm. |
| -.messages[].details.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.messages[].details.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.messages[].details.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| -.kubernetes_status | string | Current setting for kubernetes_status. Describes the cluster's ability to deploy pods. Value is one of:READY: The cluster is able to accept pods. WARNING: The cluster may be able to accept pods, but has warning messages. ERROR: The cluster may not be able to accept pods and has error messages. |
| -.kubernetes_status_messages | message[] | Current set of messages associated with the object. |
| -.api_server_management_endpoint | string | 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. |
| -.api_server_cluster_endpoint | 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. |
| -.api_servers | string[] | Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network. |
| -.network_provider | string | The provider of cluster networking for this vSphere Namespaces cluster. Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster. Value is one of: NSXT_CONTAINER_PLUGIN: NSX-T Container Plugin. |
| -.ncp_cluster_network_info.pod_cidrs | ipv4_cidr[] | CIDR blocks from which Kubernetes allocates pod IP addresses. |
| -.ncp_cluster_network_info.ingress_cidrs | ipv4_cidr[] | CIDR blocks from which NSX assigns IP addresses for Kubernetes Ingresses and Kubernetes Services of type LoadBalancer. |
| -.ncp_cluster_network_info.egress_cidrs | ipv4_cidr[] | CIDR blocks from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs. |
| -.ncp_cluster_network_info.cluster_distributed_switch | string | vSphere Distributed Switch used to connect this cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: vSphereDistributedSwitch. When operations return a value of this structure as a result, the field will be an identifier for the resource type: vSphereDistributedSwitch. |
| -.ncp_cluster_network_info.nsx_edge_cluster | string | NSX Edge Cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: NSXEdgeCluster. When operations return a value of this structure as a result, the field will be an identifier for the resource type: NSXEdgeCluster. |
| -.ncp_cluster_network_info.default_ingress_tls_certificate | string | PEM-encoded x509 certificate used by NSX as a default fallback certificate for Kubernetes Ingress services. |
| -.service_cidr | ipv4_cidr | CIDR block from which Kubernetes allocates service cluster IP addresses. |
| -.service_cidr.address | string | The IPv4 address. |
| -.service_cidr.prefix | long | The CIDR prefix. |
| Optional | ||
| -.messages[].details | localizable_message | Details about the message. Optional. If unset, message details are not required for taking actions. |
| -.tls_management_endpoint_certificate | string | 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. Optional. |
| -.tls_endpoint_certificate | string | 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. Optional. |
| -.ncp_cluster_network_info | NCP_cluster_network_info | Specification for the NSX Container Plugin cluster network. Optional. It is only relevant when network_provider has value NSXT_CONTAINER_PLUGIN. This field is optional and it is only relevant when the value of network_provider is NSXT_CONTAINER_PLUGIN. |
| -.master_DNS | string[] | List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. Optional. |
| -.worker_DNS | string[] | 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). Optional. |
| -.master_DNS_search_domains | string[] | 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. Optional. |
| -.default_kubernetes_service_content_library | 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. Optional. 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. |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| stat_summary | stats | Basic runtime statistics for the cluster. |
| stat_summary.cpu_used | long | Overall CPU usage of the cluster, in MHz. This is the sum of CPU usage across all worker nodes in the cluster. |
| stat_summary.cpu_capacity | long | Total CPU capacity in the cluster available for vSphere Namespaces, in MHz. This is the sum of CPU capacities from all worker nodes in the cluster. |
| stat_summary.memory_used | long | Overall memory usage of the cluster, in mebibytes. This is the sum of memory usage across all worker nodes in the cluster. |
| stat_summary.memory_capacity | long | Total memory capacity of the cluster available for vSphere Namespaces, in mebibytes. This is the sum of memory capacities from all worker nodesin the cluster. |
| stat_summary.storage_used | long | Overall storage used by the cluster, in mebibytes. This is the sum of storage used across all worker nodes in the cluster. |
| stat_summary.storage_capacity | long | Overall storage capacity of the cluster available for vSphere Namespaces, in mebibytes. This is the sum of total storage available from all worker nodes in the cluster. |
| config_status | string | Current setting for config_status. Describes the status of reaching the desired state configuration for the cluster. Value is one of:CONFIGURING: The Namespace configuration is being applied to the cluster. REMOVING: The Namespace configuration is being removed from the cluster. RUNNING: The cluster is configured correctly with the Namespace configuration. ERROR: Failed to apply the Namespace configuration to the cluster, user intervention needed. |
| messages | message[] | Current set of messages associated with the object. |
| messages[].severity | string | Type of the message. Represents the severity of the message. Value is one of: INFO: Informational message. This may be accompanied by vCenter event. WARNING: Warning message. This may be accompanied by vCenter event. ERROR: Error message. This is accompanied by vCenter event and/or alarm. |
| messages[].details.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| messages[].details.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| messages[].details.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| kubernetes_status | string | Current setting for kubernetes_status. Describes the cluster's ability to deploy pods. Value is one of:READY: The cluster is able to accept pods. WARNING: The cluster may be able to accept pods, but has warning messages. ERROR: The cluster may not be able to accept pods and has error messages. |
| kubernetes_status_messages | message[] | Current set of messages associated with the object. |
| api_server_management_endpoint | string | 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. |
| api_server_cluster_endpoint | 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. |
| api_servers | string[] | Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network. |
| network_provider | string | The provider of cluster networking for this vSphere Namespaces cluster. Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster. Value is one of: NSXT_CONTAINER_PLUGIN: NSX-T Container Plugin. |
| ncp_cluster_network_info.pod_cidrs | ipv4_cidr[] | CIDR blocks from which Kubernetes allocates pod IP addresses. |
| ncp_cluster_network_info.ingress_cidrs | ipv4_cidr[] | CIDR blocks from which NSX assigns IP addresses for Kubernetes Ingresses and Kubernetes Services of type LoadBalancer. |
| ncp_cluster_network_info.egress_cidrs | ipv4_cidr[] | CIDR blocks from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs. |
| ncp_cluster_network_info.cluster_distributed_switch | string | vSphere Distributed Switch used to connect this cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: vSphereDistributedSwitch. When operations return a value of this structure as a result, the field will be an identifier for the resource type: vSphereDistributedSwitch. |
| ncp_cluster_network_info.nsx_edge_cluster | string | NSX Edge Cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: NSXEdgeCluster. When operations return a value of this structure as a result, the field will be an identifier for the resource type: NSXEdgeCluster. |
| ncp_cluster_network_info.default_ingress_tls_certificate | string | PEM-encoded x509 certificate used by NSX as a default fallback certificate for Kubernetes Ingress services. |
| service_cidr | ipv4_cidr | CIDR block from which Kubernetes allocates service cluster IP addresses. |
| service_cidr.address | string | The IPv4 address. |
| service_cidr.prefix | long | The CIDR prefix. |
| Optional | ||
| messages[].details | localizable_message | Details about the message. Optional. If unset, message details are not required for taking actions. |
| tls_management_endpoint_certificate | string | 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. Optional. |
| tls_endpoint_certificate | string | 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. Optional. |
| ncp_cluster_network_info | NCP_cluster_network_info | Specification for the NSX Container Plugin cluster network. Optional. It is only relevant when network_provider has value NSXT_CONTAINER_PLUGIN. This field is optional and it is only relevant when the value of network_provider is NSXT_CONTAINER_PLUGIN. |
| master_DNS | string[] | List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. Optional. |
| worker_DNS | string[] | 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). Optional. |
| master_DNS_search_domains | string[] | 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. Optional. |
| default_kubernetes_service_content_library | 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. Optional. 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. |