Enable On Compute Cluster Supervisors
Enable the Supervisor on a single vSphere cluster. This operation sets up the Kubernetes instance for the cluster along with worker nodes. A #com.vmware.vcenter.consumption-domains.Zones zone will automatically be created if the specified cluster is not already associated with a vSphere Zone.
To verify if the Supervisor is compatible with this vSphere cluster use: ClusterCompatibility.list.
A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster.
To call this API on a Supervisor with multiple vSphere Clusters, use Topology.get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisors/{cluster}?action=enable_on_compute_cluster
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster used to enable the Supervisor Cluster. 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
NamespaceManagementSupervisorsEnableOnComputeClusterSpec of mimetype application/json
Required
Specification for configuring the Supervisor and Workloads.
{
"control_plane": {
"network": {
"backing": {
"backing": "NETWORK"
}
}
},
"name": "string",
"workloads": {
"edge": {},
"network": {
"network_type": "NSXT"
}
}
}
control_plane
Required
Supervisors.EnableSpec.control-plane specifies configuration for the Supervisor control plane.
string
name
Required
A Supervisors.EnableSpec.name is a user-friendly identifier for this Supervisor.
workloads
Required
Supervisors.EnableSpec.workloads specifies configuration for compute, network, and storage for workloads.
string
zone
Optional
Supervisors.EnableOnComputeClusterSpec.zone describes consumption fault domain zone available to the Supervisor and its workloads. Zone will be created and associated with the cluster. If unset, the zone name will be generated based on the cluster managed object ID. The zone can be managed with the zone api #com.vmware.vcenter.consumption-domains.Zones When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string
of type application/json
ID of the Supervisor object being enabled. The result will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
Errors
400
com.vmware.vapi.std.errors.already_exists : if the cluster already has the Supervisor enabled. | com.vmware.vapi.std.errors.invalid_argument : if spec contains any errors. | com.vmware.vapi.std.errors.unsupported : if the specified cluster is not supported for the Supervisor, the cluster’s hosts do not have the required ESX version, or for any other incompatibilities.
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. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the specified cluster is not licensed.
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
$NamespaceManagementSupervisorsNetworksManagementNetworkBacking = Initialize-NamespaceManagementSupervisorsNetworksManagementNetworkBacking -Backing "NETWORK"
$NamespaceManagementSupervisorsNetworksManagementNetwork = Initialize-NamespaceManagementSupervisorsNetworksManagementNetwork -Backing $NamespaceManagementSupervisorsNetworksManagementNetworkBacking
$NamespaceManagementSupervisorsControlPlane = Initialize-NamespaceManagementSupervisorsControlPlane -Network $NamespaceManagementSupervisorsNetworksManagementNetwork
$NamespaceManagementSupervisorsNetworksWorkloadNetwork = Initialize-NamespaceManagementSupervisorsNetworksWorkloadNetwork -NetworkType "NSXT"
$NamespaceManagementNetworksEdgesEdge = Initialize-NamespaceManagementNetworksEdgesEdge
$NamespaceManagementSupervisorsWorkloads = Initialize-NamespaceManagementSupervisorsWorkloads -Network $NamespaceManagementSupervisorsNetworksWorkloadNetwork -Edge $NamespaceManagementNetworksEdgesEdge
$NamespaceManagementSupervisorsEnableOnComputeClusterSpec = Initialize-NamespaceManagementSupervisorsEnableOnComputeClusterSpec -Name "MyName" -ControlPlane $NamespaceManagementSupervisorsControlPlane -Workloads $NamespaceManagementSupervisorsWorkloads
Invoke-EnableOnComputeClusterClusterSupervisors -Cluster "MyCluster" -NamespaceManagementSupervisorsEnableOnComputeClusterSpec $NamespaceManagementSupervisorsEnableOnComputeClusterSpec
PowerCLI Client SDK All Parameters Example
$NamespaceManagementSupervisorsNetworksManagementNetworkBacking = Initialize-NamespaceManagementSupervisorsNetworksManagementNetworkBacking -Backing "NETWORK" -Network "MyNetwork"
$NamespaceManagementNetworksServiceDNS = Initialize-NamespaceManagementNetworksServiceDNS -Servers "MyServers" -SearchDomains "MySearchDomains"
$NamespaceManagementNetworksServiceNTP = Initialize-NamespaceManagementNetworksServiceNTP -Servers "MyServers"
$NamespaceManagementNetworksServices = Initialize-NamespaceManagementNetworksServices -Dns $NamespaceManagementNetworksServiceDNS -Ntp $NamespaceManagementNetworksServiceNTP
$NamespaceManagementNetworksIPRange = Initialize-NamespaceManagementNetworksIPRange -Address "MyAddress" -Count 0
$NamespaceManagementNetworksIPAssignment = Initialize-NamespaceManagementNetworksIPAssignment -Assignee "POD" -Ranges $NamespaceManagementNetworksIPRange
$NamespaceManagementNetworksIPManagement = Initialize-NamespaceManagementNetworksIPManagement -DhcpEnabled $false -GatewayAddress "MyGatewayAddress" -IpAssignments $NamespaceManagementNetworksIPAssignment
$NamespaceManagementSupervisorsNetworksManagementProxyConfiguration = Initialize-NamespaceManagementSupervisorsNetworksManagementProxyConfiguration -ProxySettingsSource "VC_INHERITED" -HttpsProxyConfig "MyHttpsProxyConfig" -HttpProxyConfig "MyHttpProxyConfig" -NoProxyConfig "MyNoProxyConfig" -TlsRootCaBundle "MyTlsRootCaBundle"
$NamespaceManagementSupervisorsNetworksManagementNetwork = Initialize-NamespaceManagementSupervisorsNetworksManagementNetwork -Network "MyNetwork" -Backing $NamespaceManagementSupervisorsNetworksManagementNetworkBacking -Services $NamespaceManagementNetworksServices -IpManagement $NamespaceManagementNetworksIPManagement -FloatingIPAddress "MyFloatingIPAddress" -Proxy $NamespaceManagementSupervisorsNetworksManagementProxyConfiguration
$NamespaceManagementSupervisorsControlPlane = Initialize-NamespaceManagementSupervisorsControlPlane -Network $NamespaceManagementSupervisorsNetworksManagementNetwork -LoginBanner "MyLoginBanner" -Size "TINY" -StoragePolicy "MyStoragePolicy"
$NamespaceManagementSupervisorsNetworksWorkloadNsxNetwork = Initialize-NamespaceManagementSupervisorsNetworksWorkloadNsxNetwork -Dvs "MyDvs" -NamespaceSubnetPrefix 0
$NamespaceManagementSupervisorsNetworksWorkloadVSphereNetwork = Initialize-NamespaceManagementSupervisorsNetworksWorkloadVSphereNetwork -Dvpg "MyDvpg"
$NamespaceManagementSupervisorsNetworksWorkloadNetwork = Initialize-NamespaceManagementSupervisorsNetworksWorkloadNetwork -Network "MyNetwork" -NetworkType "NSXT" -Nsx $NamespaceManagementSupervisorsNetworksWorkloadNsxNetwork -Vsphere $NamespaceManagementSupervisorsNetworksWorkloadVSphereNetwork -Services $NamespaceManagementNetworksServices -IpManagement $NamespaceManagementNetworksIPManagement
$NamespaceManagementNetworksEdgesServer = Initialize-NamespaceManagementNetworksEdgesServer -VarHost "MyVarHost" -Port 0
$NamespaceManagementNetworksEdgesHAProxyConfig = Initialize-NamespaceManagementNetworksEdgesHAProxyConfig -Servers $NamespaceManagementNetworksEdgesServer -Username "MyUsername" -Password "MyPassword" -CertificateAuthorityChain "MyCertificateAuthorityChain"
$NamespaceManagementNetworksEdgesNSXConfig = Initialize-NamespaceManagementNetworksEdgesNSXConfig -EdgeClusterID "MyEdgeClusterID" -DefaultIngressTLSCertificate "MyDefaultIngressTLSCertificate" -RoutingMode "ROUTED" -EgressIPRanges $NamespaceManagementNetworksIPRange -T0Gateway "MyT0Gateway" -LoadBalancerSize "SMALL"
$NamespaceManagementNetworksEdgesNSXAdvancedLBConfig = Initialize-NamespaceManagementNetworksEdgesNSXAdvancedLBConfig -Server $NamespaceManagementNetworksEdgesServer -Username "MyUsername" -Password "MyPassword" -CertificateAuthorityChain "MyCertificateAuthorityChain"
$NamespaceManagementNetworksEdgesEdge = Initialize-NamespaceManagementNetworksEdgesEdge -Id "MyId" -LoadBalancerAddressRanges $NamespaceManagementNetworksIPRange -Haproxy $NamespaceManagementNetworksEdgesHAProxyConfig -Nsx $NamespaceManagementNetworksEdgesNSXConfig -NsxAdvanced $NamespaceManagementNetworksEdgesNSXAdvancedLBConfig -Provider "HAPROXY"
$NamespaceManagementSupervisorsKubeAPIServerSecurity = Initialize-NamespaceManagementSupervisorsKubeAPIServerSecurity -CertificateDnsNames "MyCertificateDnsNames"
$NamespaceManagementSupervisorsKubeAPIServerOptions = Initialize-NamespaceManagementSupervisorsKubeAPIServerOptions -Security $NamespaceManagementSupervisorsKubeAPIServerSecurity
$NamespaceManagementSupervisorsImageRegistry = Initialize-NamespaceManagementSupervisorsImageRegistry -Hostname "MyHostname" -Port 0
$NamespaceManagementSupervisorsImageSyncConfig = Initialize-NamespaceManagementSupervisorsImageSyncConfig -Registry $NamespaceManagementSupervisorsImageRegistry -Repository "MyRepository" -KubernetesContentLibrary "MyKubernetesContentLibrary"
$NamespaceManagementSupervisorsCNSFileConfig = Initialize-NamespaceManagementSupervisorsCNSFileConfig -VsanClusters "MyVsanClusters"
$NamespaceManagementSupervisorsWorkloadsStorageConfig = Initialize-NamespaceManagementSupervisorsWorkloadsStorageConfig -CloudNativeFileVolume $NamespaceManagementSupervisorsCNSFileConfig -EphemeralStoragePolicy "MyEphemeralStoragePolicy" -ImageStoragePolicy "MyImageStoragePolicy"
$NamespaceManagementSupervisorsWorkloads = Initialize-NamespaceManagementSupervisorsWorkloads -Network $NamespaceManagementSupervisorsNetworksWorkloadNetwork -Edge $NamespaceManagementNetworksEdgesEdge -KubeAPIServerOptions $NamespaceManagementSupervisorsKubeAPIServerOptions -Images $NamespaceManagementSupervisorsImageSyncConfig -Storage $NamespaceManagementSupervisorsWorkloadsStorageConfig
$NamespaceManagementSupervisorsEnableOnComputeClusterSpec = Initialize-NamespaceManagementSupervisorsEnableOnComputeClusterSpec -Zone "MyZone" -Name "MyName" -ControlPlane $NamespaceManagementSupervisorsControlPlane -Workloads $NamespaceManagementSupervisorsWorkloads
Invoke-EnableOnComputeClusterClusterSupervisors -Cluster "MyCluster" -NamespaceManagementSupervisorsEnableOnComputeClusterSpec $NamespaceManagementSupervisorsEnableOnComputeClusterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"control_plane":{"login_banner":"string","network":{"backing":{"backing":"NETWORK","network":"string"},"floating_IP_address":"string","ip_management":{"dhcp_enabled":false,"gateway_address":"string","ip_assignments":[{"assignee":"POD","ranges":[{"address":"string","count":0}]}]},"network":"string","proxy":{"http_proxy_config":"string","https_proxy_config":"string","no_proxy_config":["string"],"proxy_settings_source":"VC_INHERITED","tls_root_ca_bundle":"string"},"services":{"dns":{"search_domains":["string"],"servers":["string"]},"ntp":{"servers":["string"]}}},"size":"TINY","storage_policy":"string"},"name":"string","workloads":{"edge":{"haproxy":{"certificate_authority_chain":"string","password":"string","servers":[{"host":"string","port":0}],"username":"string"},"id":"string","load_balancer_address_ranges":[{"address":"string","count":0}],"nsx":{"default_ingress_TLS_certificate":"string","edge_cluster_ID":"string","egress_IP_ranges":[{"address":"string","count":0}],"load_balancer_size":"SMALL","routing_mode":"ROUTED","t0_gateway":"string"},"nsx_advanced":{"certificate_authority_chain":"string","password":"string","server":{"host":"string","port":0},"username":"string"},"provider":"HAPROXY"},"images":{"kubernetes_content_library":"string","registry":{"hostname":"string","port":0},"repository":"string"},"kube_API_server_options":{"security":{"certificate_dns_names":["string"]}},"network":{"ip_management":{"dhcp_enabled":false,"gateway_address":"string","ip_assignments":[{"assignee":"POD","ranges":[{"address":"string","count":0}]}]},"network":"string","network_type":"NSXT","nsx":{"dvs":"string","namespace_subnet_prefix":0},"services":{"dns":{"search_domains":["string"],"servers":["string"]},"ntp":{"servers":["string"]}},"vsphere":{"dvpg":"string"}},"storage":{"cloud_native_file_volume":{"vsan_clusters":["string"]},"ephemeral_storage_policy":"string","image_storage_policy":"string"}},"zone":"string"}' https://{api_host}/api/vcenter/namespace-management/supervisors/{cluster}?action=enable_on_compute_cluster
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: enable_on_compute_cluster
Availability
Added in 8.0.0.1
