NSX-T Data Center REST API

Return the List of Virtual Switches

Returns information about all virtual switches based on the
request parameters.

Request:

Method:
GET
URI Path(s):
/api/v1/fabric/virtual-switches
Request Headers:
n/a
Query Parameters:
VirtualSwitchListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/virtual-switches

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VirtualSwitchListResult+

Example Response:

{ "results" : [ { "uuid" : "50 20 7e d8 ed 6e 2c c8-66 ae d8 12 f7 a0 a4 b1", "origin_properties" : [ { "key" : "maxMtu", "value" : "1500" }, { "key" : "productInfo.vendor", "value" : "VMware, Inc." }, { "key" : "policy.autoUpgradeAllowed", "value" : "true" }, { "key" : "policy.partialUpgradeAllowed", "value" : "true" }, { "key" : "productInfo.forwardingClass", "value" : "cswitch" }, { "key" : "multicastFilteringMode", "value" : "snooping" }, { "key" : "productInfo.version", "value" : "7.0.0" }, { "key" : "productInfo.name", "value" : "DVS" }, { "key" : "productInfo.bundleUrl", "value" : "" }, { "key" : "lacpApiVersion", "value" : "multipleLag" }, { "key" : "productInfo.bundleId", "value" : "" }, { "key" : "policy.autoPreInstallAllowed", "value" : "true" }, { "key" : "productInfo.build", "value" : "00000" } ], "uplink_port_names" : [ "Uplink 1", "Uplink 2", "Uplink 3", "Uplink 4" ], "lacp_group_configs" : [ ], "discovered_nodes" : [ { "external_id" : "748f7736-4807-4007-ad5c-6ef082975719:host-16", "ip_addresses" : [ "10.160.132.101", "fd01:0:101:2604:0:9ff:feb2:ca8a", "fd01:0:101:2604:0:a:0:45b" ], "origin_id" : "748f7736-4807-4007-ad5c-6ef082975719", "cm_local_id" : "host-16", "node_type" : "HostNode", "display_name" : "10.160.132.101" } ], "uplink_portgroup" : { "overall_status" : "GREEN", "key" : "dvportgroup-3002", "display_name" : "DSwitch-DVUplinks-3001", "external_id" : "748f7736-4807-4007-ad5c-6ef082975719:dvportgroup-3002", "cm_local_id" : "dvportgroup-3002", "origin_type" : "DistributedVirtualPortgroup" }, "display_name" : "DSwitch", "external_id" : "748f7736-4807-4007-ad5c-6ef082975719:dvs-3001", "origin_id" : "748f7736-4807-4007-ad5c-6ef082975719", "cm_local_id" : "dvs-3001", "origin_type" : "VmwareDistributedVirtualSwitch" } ], "result_count" : 1 }

Required Permissions:

read

Feature:

compute_managers_inventory

Additional Errors: