List Networks NSX Distributed Switches
Returns basic information of the Distributed Switches matching the DistributedSwitches.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/networks/nsx/distributed-switches
Query Parameters
Query Parameters
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.
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.
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
NamespaceManagementNetworksNsxDistributedSwitchesSummary
of type application/json
List of Distributed Switches summaries matching the DistributedSwitches.FilterSpec.
[
{
"distributed_switch": "string",
"name": "string"
}
]
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.
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 DistributedSwitches.FilterSpec 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-ListNetworksNsxDistributedSwitches -Zones "MyZones" -Compatible $true
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/networks/nsx/distributed-switches?zones=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 8.0.0.1
