Vcenter NamespaceManagement Clusters get
Returns information about a specific cluster.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
ClusterComputeResourcereferenced by the parameter cluster requiresSystem.Read.
Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Information about the desired state of the specified cluster.
{
"size_hint": "string",
"stat_summary": {
"cpu_used": 0,
"cpu_capacity": 0,
"memory_used": 0,
"memory_capacity": 0,
"storage_used": 0,
"storage_capacity": 0
},
"config_status": "string",
"conditions": [
{
"type": "string",
"description": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"status": "string",
"last_transition_time": "string",
"reason": "string",
"severity": "string",
"messages": [
{
"severity": "string",
"details": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"kb_article_link": "string",
"id": "string"
}
]
}
],
"messages": [
{
"severity": "string",
"details": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"kb_article_link": "string",
"id": "string"
}
],
"kubernetes_status": "string",
"kubernetes_status_messages": [
{
"severity": "string",
"details": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"kb_article_link": "string",
"id": "string"
}
],
"api_server_management_endpoint": "string",
"api_server_cluster_endpoint": "string",
"api_servers": [
"string"
],
"tls_management_endpoint_certificate": "string",
"tls_endpoint_certificate": "string",
"network_provider": "string",
"ncp_cluster_network_info": {
"pod_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"cluster_distributed_switch": "string",
"nsx_edge_cluster": "string",
"default_ingress_tls_certificate": "string",
"nsx_tier0_gateway": "string",
"namespace_subnet_prefix": 0,
"routed_mode": false
},
"vpc_network": {
"nsx_project": "string",
"vpc_connectivity_profile": "string",
"default_private_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"auto_created": false
},
"workload_networks": {
"supervisor_primary_workload_network": {
"network": "string",
"network_provider": "string",
"vsphere_network": {
"portgroup": "string",
"ip_assignment_mode": "string",
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"subnet_mask": "string",
"mode": "string"
},
"nsx_network": {
"namespace_network_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"nsx_tier0_gateway": "string",
"subnet_prefix_length": 0,
"routed_mode": false,
"load_balancer_size": "string"
},
"namespaces": [
"string"
]
},
"network_list": [
{
"network": "string",
"network_provider": "string",
"vsphere_network": {
"portgroup": "string",
"ip_assignment_mode": "string",
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"subnet_mask": "string",
"mode": "string"
},
"nsx_network": {
"namespace_network_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"nsx_tier0_gateway": "string",
"subnet_prefix_length": 0,
"routed_mode": false,
"load_balancer_size": "string"
},
"namespaces": [
"string"
]
}
]
},
"supervisor_primary_workload_network": "string",
"workload_ntp_servers": [
"string"
],
"load_balancers": [
{
"id": "string",
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"provider": "string",
"ha_proxy_info": {
"servers": [
{
"host": "string",
"port": 0
}
],
"username": "string",
"certificate_authority_chain": "string"
},
"avi_info": {
"server": {
"host": "string",
"port": 0
},
"username": "string",
"certificate_authority_chain": "string",
"cloud_name": "string"
}
}
],
"service_cidr": {
"address": "string",
"prefix": 0
},
"master_management_network": {
"floating_ip": "string",
"network": "string",
"network_segment": {
"networks": [
"string"
]
},
"mode": "string",
"address_range": {
"starting_address": "string",
"address_count": 0,
"subnet_mask": "string",
"gateway": "string"
}
},
"master_dns": [
"string"
],
"worker_dns": [
"string"
],
"master_storage_policy": "string",
"ephemeral_storage_policy": "string",
"cns_file_config": {
"vsan_clusters": [
"string"
]
},
"login_banner": "string",
"master_dns_names": [
"string"
],
"image_storage": {
"storage_policy": "string"
},
"default_image_registry": {
"hostname": "string",
"port": 0
},
"default_image_repository": "string",
"master_dns_search_domains": [
"string"
],
"master_ntp_servers": [
"string"
],
"default_kubernetes_service_content_library": "string",
"cluster_proxy_config": {
"proxy_settings_source": "string",
"https_proxy_config": "string",
"http_proxy_config": "string",
"no_proxy_config": [
"string"
],
"tls_root_ca_bundle": "string"
},
"content_libraries": [
{
"content_library": "string",
"supervisor_services": [
"string"
],
"resource_naming_strategy": "string"
}
],
"count": 0,
"supervisor_image_source": {
"source_type": "string",
"library": "string"
},
"vsphere_pods_enabled": false,
"supervisor_services_enabled": false,
"max_concurrent_dns_forwards": 0
}Current setting for Vcenter NamespaceManagement SizingHint. This affects the size and resources allocated to the Kubernetes API server.
For more information see: Vcenter NamespaceManagement SizingHint.
This property was added in vSphere API 7.0.1.0.
This property is optional because it was added in a newer version than its parent node.
Basic runtime statistics for the cluster.
This property was added in vSphere API 7.0.0.0.
Current setting for Vcenter NamespaceManagement Clusters ConfigStatus.
For more information see: Vcenter NamespaceManagement Clusters ConfigStatus.
This property was added in vSphere API 7.0.0.0.
The conditions that need to be met for the cluster to reach the desired state.
This property was added in vSphere API 8.0.0.1.
This property is optional because it was added in a newer version than its parent node.
Current set of messages associated with the object.
This property was added in vSphere API 7.0.0.0.
Current setting for Vcenter NamespaceManagement Clusters KubernetesStatus.
For more information see: Vcenter NamespaceManagement Clusters KubernetesStatus.
This property was added in vSphere API 7.0.0.0.
Current set of messages associated with the object.
This property was added in vSphere API 7.0.0.0.
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.
This property was added in vSphere API 7.0.0.0.
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.
This property was added in vSphere API 7.0.0.0.
Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network.
This property was added in vSphere API 7.0.0.0.
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 property was added in vSphere API 7.0.0.0.
set only when Vcenter NamespaceManagement Clusters Info.api_server_management_endpoint is used.
PEM-encoded x509 certificate(s) used by TLS endpoint on Kubernetes API servers when accessed via the load balancer, e.g. devops user on corporate network.
In case of a certificates chain, the order of the certificates in this field is important. The first certificate must be the leaf certificate for your domain name, the second the intermediate certificate(s) and the last one must be the root certificate.
This property was added in vSphere API 7.0.0.0.
set only when Vcenter NamespaceManagement Clusters Info.api_server_management_endpoint is used.
The provider of cluster networking for this vSphere Namespaces cluster.
For more information see: Vcenter NamespaceManagement Clusters NetworkProvider.
This property was added in vSphere API 7.0.0.0.
Specification for the NSX Container Plugin cluster network.
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of network_provider is Vcenter NamespaceManagement Clusters NetworkProvider.NSXT_CONTAINER_PLUGIN.
Specification for the NSX VPC network.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of network_provider is Vcenter NamespaceManagement Clusters NetworkProvider.NSX_VPC.
Information about workload networks associated with the cluster.
This property was added in vSphere API 7.0.1.0.
This property is optional and it is only relevant when the value of network_provider is Vcenter NamespaceManagement Clusters NetworkProvider.VSPHERE_NETWORK.
Identifier of the Supervisor Primary workload network configuration. The Supervisor Primary workload network configuration refers to a network configuration used by Supervisor Kubernetes control plane VMs to expose Kubernetes API server to users and other workloads.
This property was added in vSphere API 9.0.0.0.
This property will always be set. It is marked optional for API backward compatibility.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network.
Information about NTP server DNS names or IP addresses to use for workloads such as Kubernetes Cluster VMs, specified in order of preference.
This property was added in vSphere API 7.0.1.0.
missing or null when NTP server for Kubernetes API servers is used.
Information related to the Load balancer used for provisioning virtual servers in the namespace.
This property was added in vSphere API 7.0.1.0.
This property is optional and it is only relevant when the value of network_provider is Vcenter NamespaceManagement Clusters NetworkProvider.VSPHERE_NETWORK.
CIDR block from which Kubernetes allocates service cluster IP addresses.
This property was added in vSphere API 7.0.0.0.
Specification for the management network on Kubernetes API server.
This property was added in vSphere API 7.0.1.0.
This property is optional because it was added in a newer version than its parent node.
List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference.
This property was added in vSphere API 7.0.0.0.
If missing or null, no default DNS servers are set.
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).
This property was added in vSphere API 7.0.0.0.
If missing or null, no default DNS servers are set.
Identifier of storage policy associated with Kubernetes API server.
This property was added in vSphere API 7.0.1.0.
This property is optional because it was added in a newer version than its parent node.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this schema as a response, the property will be an identifier for the resource type: SpsStorageProfile.
Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster.
This property was added in vSphere API 7.0.1.0.
This property is optional because it was added in a newer version than its parent node.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this schema as a response, the property will be an identifier for the resource type: SpsStorageProfile.
Specification for configuring Cloud Native Storage file volume support on Supervisor. This feature provides support for provisioning ReadWriteMany persistent volumes on this cluster and/or external clusters.
This property was added in vSphere API 7.0.3.0.
If missing or null, it means the file volume support is not enabled on this Supervisor.
Disclaimer to be displayed prior to login via the Kubectl plugin.
This property was added in vSphere API 7.0.1.0.
If missing or null, just skip it.
List of DNS names to associate with the Kubernetes API server. These DNS names are embedded in the TLS certificate presented by the API server.
This property was added in vSphere API 7.0.1.0.
If missing or null, no DNS names are embedded in the TLS certificate.
Specification for storage to be used for container images.
This property was added in vSphere API 7.0.1.0.
This property is optional because it was added in a newer version than its parent node.
Default image registry to use when Kubernetes Pod container specification does not specify it as part of the container image name.
This property was added in vSphere API 7.0.1.0.
If missing or null, 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.
This property was added in vSphere API 7.0.1.0.
If missing or null, defaults to Docker Hub official repository in case of Docker Hub image registry, otherwise defaults to empty 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.
This property was added in vSphere API 7.0.0.0.
If missing or null, no default DNS search domains are set.
List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference.
This property was added in vSphere API 7.0.1.0.
If missing or null, VMware Tools based time synchronization is enabled.
This property is deprecated as of vSphere API 9.0.0.0. Use Vcenter NamespaceManagement Clusters Info.content_libraries instead.
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.
This property was added in vSphere API 7.0.0.0.
If missing or null, no Content Library set for vSphere Kubernetes Service.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library.
Proxy configuration that is applied to the Supervisor. The proxy should be reachable from the management network and is used for image pulling and container traffic exiting out of the Supervisor.
Note that the proxy password will be removed from the URLs as per Section 3.2.1 of RFC3986 security recommendation.
This property was added in vSphere API 7.0.3.00100.
This property is optional because it was added in a newer version than its parent node.
List of Content Libraries associated with a Supervisor. This list refers to existing Content Libraries in the vSphere inventory. These Content Libraries and the Content Library items belonging to them are read-only across all vSphere Namespaces. If Vcenter NamespaceManagement Clusters Info.default_kubernetes_service_content_library is set, the Content Library identifier will be migrated to this property.
This property was added in vSphere API 8.0.2.0.
If missing or null, no Content Libraries will be set for the Supervisor.
Number of control planes associated with the Supervisor.
This property was added in vSphere API 9.0.0.0.
If missing or null, defaults to 3.
Information about the source of this Supervisor image.
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.
Information about whether vSphere Pod support is enabled.
This property was added in vSphere API 9.0.0.0.
If missing or null, defaults to False.
Information about whether Supervisor Service support is enabled.
This property was added in vSphere API 9.0.0.0.
If missing or null, defaults to False.
Limit of concurrent DNS requests the DNS forwarder on each Supervisor control planes will forward to the upstream Vcenter NamespaceManagement Clusters Info.worker_DNS. The maximum number of concurrent DNS requests that can be sent to upstream worker DNS servers from the Supervisor is calculated by multiplying this value by the Vcenter NamespaceManagement Clusters Info.count value. A value of 0 indicates there is no limit on the maximum number of concurrent requests that can be forwarded.
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the specified cluster does not have vSphere Namespaces enabled.
"Vapi Std Errors Unsupported Object"if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have System.Read privilege.
"Vapi Std Errors Unauthorized Object"if cluster could not be located.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}