vcenter namespace management clusters: get
Returns information about a specific cluster.
Request:
HTTP request
GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| cluster | string | Identifier for the cluster on which vSphere Namespaces are enabled. |
Response:
HTTP Status Code: 200
Response Body Structure:
{
"workload_ntp_servers" : [
"string",
"string"
],
"image_storage" : {
"storage_policy" : "obj-103"
},
"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",
"master_NTP_servers" : [
"string",
"string"
],
"ephemeral_storage_policy" : "obj-103",
"default_image_repository" : "string",
"service_cidr" : {
"address" : "string",
"prefix" : 1
},
"size_hint" : "TINY",
"worker_DNS" : [
"string",
"string"
],
"default_image_registry" : {
"hostname" : "string",
"port" : 1
},
"master_DNS" : [
"string",
"string"
],
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"master_storage_policy" : "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",
"master_management_network" : {
"mode" : "DHCP",
"floating_IP" : "string",
"address_range" : {
"subnet_mask" : "string",
"starting_address" : "string",
"gateway" : "string",
"address_count" : 1
},
"network" : "obj-103"
},
"load_balancers" : [
{
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"provider" : "HA_PROXY",
"id" : "obj-103",
"ha_proxy_info" : {
"servers" : [
{
"port" : 1,
"host" : "string"
},
{
"port" : 1,
"host" : "string"
}
],
"certificate_authority_chain" : "string",
"username" : "string"
}
},
{
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"provider" : "HA_PROXY",
"id" : "obj-103",
"ha_proxy_info" : {
"servers" : [
{
"port" : 1,
"host" : "string"
},
{
"port" : 1,
"host" : "string"
}
],
"certificate_authority_chain" : "string",
"username" : "string"
}
}
],
"config_status" : "CONFIGURING",
"tls_management_endpoint_certificate" : "string",
"Master_DNS_names" : [
"string",
"string"
],
"login_banner" : "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" : {}
}
}
}
}
}
}
}
}
],
"workload_networks" : {
"network_list" : [
{
"vsphere_network" : {
"portgroup" : "obj-103",
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"subnet_mask" : "string",
"gateway" : "string"
},
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"network" : "obj-103"
},
{
"vsphere_network" : {
"portgroup" : "obj-103",
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"subnet_mask" : "string",
"gateway" : "string"
},
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"network" : "obj-103"
}
],
"supervisor_primary_workload_network" : {
"vsphere_network" : {
"portgroup" : "obj-103",
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"subnet_mask" : "string",
"gateway" : "string"
},
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"network" : "obj-103"
}
},
"default_kubernetes_service_content_library" : "obj-103"
}
"workload_ntp_servers" : [
"string",
"string"
],
"image_storage" : {
"storage_policy" : "obj-103"
},
"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",
"master_NTP_servers" : [
"string",
"string"
],
"ephemeral_storage_policy" : "obj-103",
"default_image_repository" : "string",
"service_cidr" : {
"address" : "string",
"prefix" : 1
},
"size_hint" : "TINY",
"worker_DNS" : [
"string",
"string"
],
"default_image_registry" : {
"hostname" : "string",
"port" : 1
},
"master_DNS" : [
"string",
"string"
],
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"master_storage_policy" : "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",
"master_management_network" : {
"mode" : "DHCP",
"floating_IP" : "string",
"address_range" : {
"subnet_mask" : "string",
"starting_address" : "string",
"gateway" : "string",
"address_count" : 1
},
"network" : "obj-103"
},
"load_balancers" : [
{
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"provider" : "HA_PROXY",
"id" : "obj-103",
"ha_proxy_info" : {
"servers" : [
{
"port" : 1,
"host" : "string"
},
{
"port" : 1,
"host" : "string"
}
],
"certificate_authority_chain" : "string",
"username" : "string"
}
},
{
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"provider" : "HA_PROXY",
"id" : "obj-103",
"ha_proxy_info" : {
"servers" : [
{
"port" : 1,
"host" : "string"
},
{
"port" : 1,
"host" : "string"
}
],
"certificate_authority_chain" : "string",
"username" : "string"
}
}
],
"config_status" : "CONFIGURING",
"tls_management_endpoint_certificate" : "string",
"Master_DNS_names" : [
"string",
"string"
],
"login_banner" : "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" : {}
}
}
}
}
}
}
}
}
],
"workload_networks" : {
"network_list" : [
{
"vsphere_network" : {
"portgroup" : "obj-103",
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"subnet_mask" : "string",
"gateway" : "string"
},
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"network" : "obj-103"
},
{
"vsphere_network" : {
"portgroup" : "obj-103",
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"subnet_mask" : "string",
"gateway" : "string"
},
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"network" : "obj-103"
}
],
"supervisor_primary_workload_network" : {
"vsphere_network" : {
"portgroup" : "obj-103",
"address_ranges" : [
{
"address" : "string",
"count" : 1
},
{
"address" : "string",
"count" : 1
}
],
"subnet_mask" : "string",
"gateway" : "string"
},
"network_provider" : "NSXT_CONTAINER_PLUGIN",
"network" : "obj-103"
}
},
"default_kubernetes_service_content_library" : "obj-103"
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Information about the desired state of the specified cluster. |
| -.size_hint | string | Current setting for sizing_hint. This affects the size and resources allocated to the Kubernetes API server. This attribute was added in vSphere API 7.0.1.0. Determines the configuration of Kubernetes API server and the worker nodes. It also determines the default values associated with the maximum number of pods and services. Use get to get information associated with a sizing_hint. Value is one of:TINY: Cluster size of 'tiny'. SMALL: Cluster size of 'small'. MEDIUM: Cluster size of 'medium'. LARGE: Cluster size of 'large'.Optional. This field is optional because it was added in a newer version than its parent node. |
| -.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 | localizable_message | Details about the message. Optional. If unset, message details are not required for taking actions. |
| -.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. |
| -.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. |
| -.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. VSPHERE_NETWORK: vSphere Networking. This constant was added in vSphere API 7.0.1.0. |
| -.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. |
| -.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. |
| -.workload_networks | workload_networks_info | Information about workload networks associated with the cluster. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when network_provider has value VSPHERE_NETWORK. This field is optional and it is only relevant when the value of network_provider is VSPHERE_NETWORK. |
| -.workload_networks.supervisor_primary_workload_network | info | vSphere Namespaces network used by Kubernetes control plane VMs to access load-balanced services on the various workload networks. This attribute was added in vSphere API 7.0.1.0. |
| -.workload_networks.supervisor_primary_workload_network.network | string | Identifier of the network. This attribute was added in vSphere API 7.0.1.0. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. |
| -.workload_networks.supervisor_primary_workload_network.network_provider | string | The network provider that will manage the vSphere Namespaces network object. This attribute was added in vSphere API 7.0.1.0. Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster. Value is one of: NSXT_CONTAINER_PLUGIN: NSX-T Container Plugin. VSPHERE_NETWORK: vSphere Networking. This constant was added in vSphere API 7.0.1.0. |
| -.workload_networks.supervisor_primary_workload_network.vsphere_network | vsphere_DVPG_network_info | Updated configuration specification for a DVPG-backed Namespaces network object, supported by VSPHERE_NETWORK network provider. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when network_provider has value VSPHERE_NETWORK. This field is optional and it is only relevant when the value of network_provider is VSPHERE_NETWORK. |
| -.workload_networks.supervisor_primary_workload_network.vsphere_network.portgroup | string | Identifier of the vSphere Distributed Portgroup backing the vSphere network object. This attribute was added in vSphere API 7.0.1.0. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network. |
| -.workload_networks.supervisor_primary_workload_network.vsphere_network.address_ranges | IP_range[] | Usable IP pools on this network. This attribute was added in vSphere API 7.0.1.0. |
| -.workload_networks.supervisor_primary_workload_network.vsphere_network.gateway | string | Gateway for the network. This attribute was added in vSphere API 7.0.1.0. |
| -.workload_networks.supervisor_primary_workload_network.vsphere_network.subnet_mask | string | Subnet mask of the network. This attribute was added in vSphere API 7.0.1.0. |
| -.workload_networks.network_list | info[] | List of vSphere Namespaces networks associated with this cluster. This attribute was added in vSphere API 7.0.1.0. Optional. |
| -.workload_ntp_servers | string[] | 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 attribute was added in vSphere API 7.0.1.0. Optional. This field is optional because it was added in a newer version than its parent node. |
| -.load_balancers | info[] | Information related to the Load balancer used for provisioning virtual servers in the namespace. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when network_provider has value VSPHERE_NETWORK. This field is optional and it is only relevant when the value of network_provider is VSPHERE_NETWORK. |
| -.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. |
| -.master_management_network | network_spec | Specification for the management network on Kubernetes API server. This attribute was added in vSphere API 7.0.1.0. Optional. This field is optional because it was added in a newer version than its parent node. |
| -.master_management_network.floating_IP | string | Optionally specify the Floating IP used by the HA master cluster in the DHCP case. Optional. It is only relevant when mode has value DHCP. This field is optional and it is only relevant when the value of mode is DHCP. |
| -.master_management_network.network | string | Identifier for the network. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network. |
| -.master_management_network.mode | string | The address assignment mode. Defines various IPv4 address assignment modes. Value is one of: DHCP: The address is automatically assigned by a DHCP server. STATICRANGE: The address is static. |
| -.master_management_network.address_range | ipv4_range | Settings for the interfaces on the network. Optional. It is only relevant when mode has value STATICRANGE. This field is optional and it is only relevant when the value of mode is STATICRANGE. |
| -.master_management_network.address_range.starting_address | string | The IPv4 address denoting the start of the range. |
| -.master_management_network.address_range.address_count | long | The number of IP addresses in the range. Addresses are derived by incrementing vcenter.namespace_management.clusters.ipv4_range.starting_address. |
| -.master_management_network.address_range.subnet_mask | string | Subnet mask to be set. |
| -.master_management_network.address_range.gateway | string | The IPv4 address of the gateway associated with the range indicated by vcenter.namespace_management.clusters.ipv4_range.starting_address and vcenter.namespace_management.clusters.ipv4_range.address_count. |
| -.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_storage_policy | string | Identifier of storage policy associated with Kubernetes API server. This attribute was added in vSphere API 7.0.1.0. Optional. 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. |
| -.ephemeral_storage_policy | string | Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. This attribute was added in vSphere API 7.0.1.0. Optional. 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. |
| -.login_banner | string | Disclaimer to be displayed prior to login via the Kubectl plugin. This attribute was added in vSphere API 7.0.1.0. Optional. If unset, just skip it. |
| -.Master_DNS_names | string[] | 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. This attribute was added in vSphere API 7.0.1.0. Optional. If unset, no additional DNS names are embedded in the TLS certificate. |
| -.image_storage | image_storage_spec | Specification for storage to be used for container images. This attribute was added in vSphere API 7.0.1.0. Optional. This field is optional because it was added in a newer version than its parent node. |
| -.image_storage.storage_policy | string | Identifier of the storage policy. 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. |
| -.default_image_registry | image_registry | Default image registry to use when Kubernetes Pod container specification does not specify it as part of the container image name. This attribute was added in vSphere API 7.0.1.0. Optional. If unset, defaults to Docker Hub. |
| -.default_image_registry.hostname | string | IP address or the hostname of container image registry. |
| -.default_image_registry.port | long | Port number of the container image registry. Optional. If unset, defaults to 443. |
| -.default_image_repository | string | Default image repository to use when Kubernetes Pod container specification does not specify it as part of the container image name. This attribute was added in vSphere API 7.0.1.0. Optional. If unset, defaults to Docker Hub official repository in case of Docker Hub image registry, otherwise defaults to empty string. |
| -.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. |
| -.master_NTP_servers | string[] | List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference. This attribute was added in vSphere API 7.0.1.0. Optional. If unset, VMware Tools based time synchronization is enabled. |
| -.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. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if cluster could not be located. |
| 400 | unsupported | if the specified cluster does not have vSphere Namespaces enabled. |
| 500 | error | if the system reports an error while responding to the request. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user does not have System.Read privilege. |