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+

VirtualSwitchListRequestParameters (schema)

Name	Description	Type	Notes
cm_local_id	Local Id of the virtual switch	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
discovered_node_id	Discovered node ID All virtual switches connected to this discovered node.	string
display_name	Display name of the virtual switch	string
external_id	External id of the virtual switch	string
included_fields	Comma separated list of fields that should be included in query result	string
origin_id	ID of the compute manager	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
uuid	UUID of the switch	string

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+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Virtual switch list results	array of VirtualSwitch	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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 }

Return the List of Virtual Switches

Request:

VirtualSwitchListRequestParameters (schema)

Example Request:

Successful Response:

VirtualSwitchListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: