List Distributed Switch Compatibility
Returns Namespaces compatibility information of Distributed Switches in vCenter associated with the vCenter cluster, matching the DistributedSwitchCompatibility.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/distributed-switch-compatibility
Query Parameters
Query Parameters
string
cluster
Required
Identifier of a vCenter Cluster. Only Distributed Switches associated with the vCenter Cluster will be considered by the filter. The parameter must be an identifier for the resource type: ClusterComputeResource.
boolean
compatible
Optional
Compatibility criteria for matching the filter. If true, only Distributed Switches which are compatible with vSphere Namespaces match the filter. If false, only Distributed Switches which are incompatible with vSphere Namespaces match the filter. If unset, both compatible and incompatible Distributed Switches match the filter.
network_provider
Optional
The network provider whose networks will be considered. If unset, this will default to NSXT_CONTAINER_PLUGIN. This field is optional because it was added in a newer version than its parent node.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementDistributedSwitchCompatibilitySummary
of type application/json
Namespaces compatibility information for Distributed Switches matching the the DistributedSwitchCompatibility.FilterSpec.
[
{
"compatible": false,
"compatible_networks": [
"string"
],
"distributed_switch": "string",
"incompatibility_reasons": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"network_provider": "enum"
}
]
boolean
compatible
Required
Compatibility of this switch with vSphere Namespaces.
string
distributed_switch
Required
Identifier of the switch. If DistributedSwitchCompatibility.Summary.network-provider is either unset or is set to NSXT_CONTAINER_PLUGIN, the value of this field will refer to the UUID of a vim.DistributedVirtualSwitch. Otherwise, the value of the field will refer to the ID of a vim.DistributedVirtualSwitch. 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.
array of
string
compatible_networks
Optional
List of compatible (PortGroup) Networks under the distributed switch. 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 contain identifiers for the resource type: Network. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Network.
array of
StdLocalizableMessage
incompatibility_reasons
Optional
List of reasons for incompatibility. If unset, this Distributed Switch is compatible.
network_provider
Optional
The network provider whose networks were considered. If unset, clients clients should assume the value to be NSXT_CONTAINER_PLUGIN.
Possible values are: NSXT_CONTAINER_PLUGIN , VSPHERE_NETWORK
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
404
com.vmware.vapi.std.errors.not_found : if no cluster with the given cluster ID can be found
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.internal_server_error : if the server reports an unknown internal error.
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
Invoke-ListNamespaceManagementDistributedSwitchCompatibility -Cluster "MyCluster" -Compatible $true -NetworkProvider "NSXT_CONTAINER_PLUGIN"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/distributed-switch-compatibility?cluster=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.0.0
