Update Clusters
Update configuration on the cluster object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NamespaceManagementClustersUpdateSpec of mimetype application/json
Required
New specification for the Supervisor cluster.
{
"cluster_proxy_config": {
"http_proxy_config": "string",
"https_proxy_config": "string",
"no_proxy_config": [
"string"
],
"proxy_settings_source": "VC_INHERITED",
"tls_root_ca_bundle": "string"
},
"cns_file_config": {
"vsan_clusters": [
"string"
]
},
"default_image_registry": {
"hostname": "string",
"port": 0
},
"default_image_repository": "string",
"default_kubernetes_service_content_library": "string",
"ephemeral_storage_policy": "string",
"floating_IP": "string",
"image_storage": {
"storage_policy": "string"
},
"login_banner": "string",
"master_DNS": [
"string"
],
"master_DNS_search_domains": [
"string"
],
"master_NTP_servers": [
"string"
],
"master_storage_policy": "string",
"ncp_cluster_network_spec": {
"default_ingress_tls_certificate": "string",
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"pod_cidrs": [
{
"address": "string",
"prefix": 0
}
]
},
"network_provider": "NSXT_CONTAINER_PLUGIN",
"size_hint": "enum",
"tls_endpoint_certificate": "string",
"worker_DNS": [
"string"
],
"workload_ntp_servers": [
"string"
]
}
cluster_proxy_config
Optional
Proxy configuration that will be applied to the Supervisor. The proxy should be reachable from the management network and will be used for image pulling and container traffic exiting out of the Supervisor. Modifying these settings will result in a restart of the container runtime. Workloads might fail to pull their images for a short period of time. There will be no effect on the currently running containers. If unset no change will be made to the cluster.
cns_file_config
Optional
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. If unset, configuration for file volumes will remain unchanged.
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, default image registry will not be modified.
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, default image repository will not be modified.
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. Modifying or clearing the Content Library identifier will not affect existing vSphere Kubernetes Service clusters. However, upgrades or scale-out of existing clusters may be affected if the new Content Library doesn’t have the necessary VM Images. If unset, the Content Library will will not be modified. 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. If unset, storage policy associated with ephemeral disks of all the Kubernetes Pods will not be modified. 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.
string
floating_IP
Optional
Optionally, you can edit the floating IP address that is assigned to the Supervisor in case the DHCP server fails during the Supervisor enablement process. The field is only relevant when the DHCP mode of the Supervisor management network is set with Clusters.EnableSpec.master-management-network. Set this floating IP parameter to remediate a supervisor enablement failure in the case where it was detected that the DHCP server does not support DHCP client identifiers. If unset, the existing effective management network floating IP will not be modified.
image_storage
Optional
Specification for storage to be used for container images. If unset, configuration of storage used for container images is not modified.
string
login_banner
Optional
Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, disclaimer to be displayed prior to login via the Kubectl plugin will not be modified.
array of
string
master_DNS
Optional
List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. If set, DNS servers set on Kubernetes API server will be replaced. Otherwise, they will not be modified.
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. If set, DNS search domains on Kubernetes API server will be replaced. Otherwise, they will not be modified.
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 set, NTP servers on Kubernetes API server will be replaced. Otherwise, they will not be modified.
string
master_storage_policy
Optional
Identifier of storage policy associated with Kubernetes API server. If unset, storage policy associated with Kubernetes API server will not be modified. 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.
ncp_cluster_network_spec
Optional
Updated specification for the cluster network configuration. If unset, the existing effective cluster network specification will not be modified.
network_provider
Optional
Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster.
NSXT_CONTAINER_PLUGIN : NSX-T Container Plugin.
VSPHERE_NETWORK : vSphere Networking.
Possible values are: NSXT_CONTAINER_PLUGIN , VSPHERE_NETWORK
size_hint
Optional
This affects the size and resources allocated to the Kubernetes API server. If unset, size and resources allocated to Kubernetes API server will not be modified.
Possible values are: TINY , SMALL , MEDIUM , LARGE
string
tls_endpoint_certificate
Optional
PEM-encoded x509 certificate(s) issued for Kubernetes API Server. Certificate(s) used must be created by signing the Certificate Signing Request obtained from the Namespace Certificate Management API. Because a Kubernetes CertificateSigningRequest is created on an existing Namespaces-enabled cluster, you must use the Clusters.UpdateSpec to specify this Clusters.UpdateSpec.tls-endpoint-certificate on an existing cluster rather than during initially enabling Namespaces on a cluster. In case of providing the trust chain, the certificates should be simply concatenated into a single string. If unset, Kubernetes API Server certificate(s) will not be modified.
array of
string
worker_DNS
Optional
List of DNS server IP addresses to use on the worker nodes, specified in order of preference. If set, DNS servers set on worker nodes will be replaced. Otherwise, they will not be modified.
array of
string
workload_ntp_servers
Optional
List of NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference. If unset, NTP servers for workloads will be unmodified.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if spec contain any errors. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if vSphere Namespaces is being disabled on this Supervisor cluster or if the Supervisor cluster is being restored from a backup. When a Supervisor cluster is restored, there’s a window of time during which the restored Supervisor cluster’s state is being synchronized back to vCenter. During that time, Supervisor cluster’s configuration modifications are not allowed. | com.vmware.vapi.std.errors.unsupported : if the Supervisor cluster’s hosts are not configured with sufficient resources for the new Kubernetes API Server size.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$NamespaceManagementIpv4Cidr = Initialize-NamespaceManagementIpv4Cidr -Address "MyAddress" -Prefix 0
$NamespaceManagementClustersNCPClusterNetworkUpdateSpec = Initialize-NamespaceManagementClustersNCPClusterNetworkUpdateSpec -PodCidrs $NamespaceManagementIpv4Cidr -IngressCidrs $NamespaceManagementIpv4Cidr -EgressCidrs $NamespaceManagementIpv4Cidr -DefaultIngressTlsCertificate "MyDefaultIngressTlsCertificate"
$NamespaceManagementCNSFileConfig = Initialize-NamespaceManagementCNSFileConfig -VsanClusters "MyVsanClusters"
$NamespaceManagementClustersImageStorageSpec = Initialize-NamespaceManagementClustersImageStorageSpec -StoragePolicy "MyStoragePolicy"
$NamespaceManagementClustersImageRegistry = Initialize-NamespaceManagementClustersImageRegistry -Hostname "MyHostname" -Port 0
$NamespaceManagementProxyConfiguration = Initialize-NamespaceManagementProxyConfiguration -ProxySettingsSource "VC_INHERITED" -HttpsProxyConfig "MyHttpsProxyConfig" -HttpProxyConfig "MyHttpProxyConfig" -NoProxyConfig "MyNoProxyConfig" -TlsRootCaBundle "MyTlsRootCaBundle"
$NamespaceManagementClustersUpdateSpec = Initialize-NamespaceManagementClustersUpdateSpec -SizeHint "TINY" -FloatingIP "MyFloatingIP" -NetworkProvider "NSXT_CONTAINER_PLUGIN" -NcpClusterNetworkSpec $NamespaceManagementClustersNCPClusterNetworkUpdateSpec -MasterDNS "MyMasterDNS" -WorkerDNS "MyWorkerDNS" -MasterDNSSearchDomains "MyMasterDNSSearchDomains" -MasterNTPServers "MyMasterNTPServers" -MasterStoragePolicy "MyMasterStoragePolicy" -EphemeralStoragePolicy "MyEphemeralStoragePolicy" -CnsFileConfig $NamespaceManagementCNSFileConfig -LoginBanner "MyLoginBanner" -ImageStorage $NamespaceManagementClustersImageStorageSpec -DefaultImageRegistry $NamespaceManagementClustersImageRegistry -DefaultImageRepository "MyDefaultImageRepository" -TlsEndpointCertificate "MyTlsEndpointCertificate" -DefaultKubernetesServiceContentLibrary "MyDefaultKubernetesServiceContentLibrary" -WorkloadNtpServers "MyWorkloadNtpServers" -ClusterProxyConfig $NamespaceManagementProxyConfiguration
Invoke-UpdateClusterNamespaceManagement -Cluster "MyCluster" -NamespaceManagementClustersUpdateSpec $NamespaceManagementClustersUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cluster_proxy_config":{"http_proxy_config":"string","https_proxy_config":"string","no_proxy_config":["string"],"proxy_settings_source":"VC_INHERITED","tls_root_ca_bundle":"string"},"cns_file_config":{"vsan_clusters":["string"]},"default_image_registry":{"hostname":"string","port":0},"default_image_repository":"string","default_kubernetes_service_content_library":"string","ephemeral_storage_policy":"string","floating_IP":"string","image_storage":{"storage_policy":"string"},"login_banner":"string","master_DNS":["string"],"master_DNS_search_domains":["string"],"master_NTP_servers":["string"],"master_storage_policy":"string","ncp_cluster_network_spec":{"default_ingress_tls_certificate":"string","egress_cidrs":[{"address":"string","prefix":0}],"ingress_cidrs":[{"address":"string","prefix":0}],"pod_cidrs":[{"address":"string","prefix":0}]},"network_provider":"NSXT_CONTAINER_PLUGIN","size_hint":"enum","tls_endpoint_certificate":"string","worker_DNS":["string"],"workload_ntp_servers":["string"]}' https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update
Availability
Added in 7.0.0.0
On This Page
Clusters Operations
get
put
patch
get
post
post
