Vcenter NamespaceManagement Supervisors enableOnZones
Enable a Supervisor on a set of vSphere Zones. The cluster control plane and its workloads will be eligible for placement across the zones. Enabling on multiple zones enables fault tolerance for applications deployed on more than one zone in case of a zone failure.
To verify if the Supervisor is compatible with the provided Zones use: GET /vcenter/namespace-management/cluster-compatibility.
This operation was added in vSphere API 8.0.0.1.
Specification for configuring the Supervisor and Workloads.
Show optional properties
{
"zones": [
{}
],
"name": "string",
"control_plane": {},
"workloads": {}
}{
"zones": [
"string"
],
"name": "string",
"control_plane": {
"network": {
"network": "string",
"backing": {
"backing": "string",
"network": "string",
"network_segment": {
"networks": [
"string"
]
}
},
"services": {
"dns": {
"servers": [
"string"
],
"search_domains": [
"string"
]
},
"ntp": {
"servers": [
"string"
]
}
},
"ip_management": {
"dhcp_enabled": false,
"gateway_address": "string",
"ip_assignments": [
{
"assignee": "string",
"ranges": [
{
"address": "string",
"count": 0
}
]
}
]
},
"floating_ip_address": "string",
"proxy": {
"proxy_settings_source": "string",
"https_proxy_config": "string",
"http_proxy_config": "string",
"no_proxy_config": [
"string"
],
"tls_root_ca_bundle": "string"
}
},
"login_banner": "string",
"size": "string",
"storage_policy": "string",
"count": 0
},
"workloads": {
"network": {
"network": "string",
"network_type": "string",
"nsx": {
"dvs": "string",
"namespace_subnet_prefix": 0
},
"vsphere": {
"dvpg": "string"
},
"nsx_vpc": {
"nsx_project": "string",
"vpc_connectivity_profile": "string",
"default_private_cidrs": [
{
"address": "string",
"prefix": 0
}
]
},
"services": {
"dns": {
"servers": [
"string"
],
"search_domains": [
"string"
]
},
"ntp": {
"servers": [
"string"
]
}
},
"ip_management": {
"dhcp_enabled": false,
"gateway_address": "string",
"ip_assignments": [
{
"assignee": "string",
"ranges": [
{
"address": "string",
"count": 0
}
]
}
]
}
},
"edge": {
"id": "string",
"load_balancer_address_ranges": [
{
"address": "string",
"count": 0
}
],
"haproxy": {
"servers": [
{
"host": "string",
"port": 0
}
],
"username": "string",
"password": "string",
"certificate_authority_chain": "string"
},
"nsx": {
"edge_cluster_id": "string",
"default_ingress_tls_certificate": "string",
"routing_mode": "string",
"egress_ip_ranges": [
{
"address": "string",
"count": 0
}
],
"t0_gateway": "string",
"load_balancer_size": "string"
},
"nsx_advanced": {
"server": {
"host": "string",
"port": 0
},
"username": "string",
"password": "string",
"certificate_authority_chain": "string",
"cloud_name": "string"
},
"foundation": {
"deployment_target": {
"zones": [
"string"
],
"storage_policy": "string",
"deployment_size": "string",
"availability": "string"
},
"interfaces": [
{
"personas": [
"string"
],
"network": {
"network_type": "string",
"dvpg_network": {
"name": "string",
"network": "string",
"ipam": "string",
"ip_config": {
"ip_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string"
}
}
}
}
],
"network_services": {
"dns": {
"servers": [
"string"
],
"search_domains": [
"string"
]
},
"ntp": {
"servers": [
"string"
]
},
"syslog": {
"endpoint": "string",
"certificate_authority_pem": "string"
}
}
},
"provider": "string"
},
"kube_api_server_options": {
"security": {
"certificate_dns_names": [
"string"
]
}
},
"images": {
"registry": {
"hostname": "string",
"port": 0,
"username": "string",
"password": "string",
"certificate_chain": "string"
},
"repository": "string",
"kubernetes_content_library": "string",
"content_libraries": [
{
"content_library": "string",
"supervisor_services": [
"string"
],
"resource_naming_strategy": "string"
}
]
},
"storage": {
"cloud_native_file_volume": {
"vsan_clusters": [
"string"
]
},
"ephemeral_storage_policy": "string",
"image_storage_policy": "string"
}
}
}Vcenter NamespaceManagement Supervisors EnableOnZonesSpec.zones describe consumption fault domain zones available to the Supervisor and its workloads. Only one or three zones are supported.
This property was added in vSphere API 8.0.0.1.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone.
A Vcenter NamespaceManagement Supervisors EnableSpec.name is a user-friendly identifier for this Supervisor.
This property was added in vSphere API 8.0.0.1.
Vcenter NamespaceManagement Supervisors EnableSpec.control_plane specifies configuration for the Supervisor control plane.
This property was added in vSphere API 8.0.0.1.
Vcenter NamespaceManagement Supervisors EnableSpec.workloads specifies configuration for compute, network, and storage for workloads.
This property was added in vSphere API 8.0.0.1.
ID of the Supervisor object being enabled.
The response will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
Vapi Std Errors AlreadyExists if one or more zones already host a another Supervisor.
Vapi Std Errors InvalidArgument if spec contains any errors.
Vapi Std Errors Unsupported if the zones are not supported for the Supervisor, the zones' hosts do not have the required ESX version, or for any other incompatibilities.
"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.
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 Namespaces.Manage privilege.
"Vapi Std Errors Unauthorized Object"if the provided zones could not be located.
"Vapi Std Errors NotFound Object"Vapi Std Errors Error if the system reports an error while responding to the request.
Vapi Std Errors UnableToAllocateResource if the one or more zones are not licensed.
"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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"control_plane":"{}","name:"string","workloads":"{}","zones":["string"]}' https://{api_host}/api/vcenter/namespace-management/supervisors?action=enable_on_zones