Check Networks NSX Distributed Switches Compatibility
Returns a list of Distributed Switches matching the given filter and their compatibility information.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/networks/nsx/distributed-switches?action=check_compatibility
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
NamespaceManagementNetworksNsxDistributedSwitchesFilterSpec of mimetype application/json
Optional
Specification of matching Distributed Switches for which information should be returned. If unset, the behavior is equivalent to a filter with all fields unset which means all Distributed Switches and their compatibility information will be returned.
{
"zones": [
"string"
]
}
array of
string
zones
Required
Zone compatibility criteria. If zones are specified, the common distributed switches across the given zones will returned. A distributed switch is considered common if it is present in all of the vSphere clusters in a given zone. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone.
boolean
compatible
Optional
Compatibility criteria. If true, only Distributed Switches compatible with the vSphere Namespaces will be returned. If false, only Distributed Switches incompatible with the vSphere Namespaces will be returned. If unset, both compatible and incompatible Distributed Switches will be returned.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementNetworksNsxDistributedSwitchesCompatibilitySummary
of type application/json
List of Distributed Switches compatibility summaries matching the given filter.
[
{
"compatible": false,
"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"
}
}
}
],
"name": "string"
}
]
boolean
compatible
Required
Compatibility of this Distributed Switch with the vSphere Namespaces.
string
distributed_switch
Required
Identifier of the switch. The value of this field refers to the UUID 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
StdLocalizableMessage
incompatibility_reasons
Required
List of reasons for incompatibility. If empty, this Distributed Switch is compatible.
string
name
Required
Human-readable identifier of the switch.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if one or more fields of the given filter is incorrect.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read 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
Invoke-CheckCompatibilityNsxDistributedSwitches
PowerCLI Client SDK All Parameters Example
$NamespaceManagementNetworksNsxDistributedSwitchesFilterSpec = Initialize-NamespaceManagementNetworksNsxDistributedSwitchesFilterSpec -Compatible $false -Zones "MyZones"
Invoke-CheckCompatibilityNsxDistributedSwitches -NamespaceManagementNetworksNsxDistributedSwitchesFilterSpec $NamespaceManagementNetworksNsxDistributedSwitchesFilterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"compatible":false,"zones":["string"]}' https://{api_host}/api/vcenter/namespace-management/networks/nsx/distributed-switches?action=check_compatibility
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: check
Availability
Added in 8.0.0.1
