List logical switches by realized state

Returns a list of logical switches states that have realized state as provided
as query parameter.

Request:

Method:

GET

URI Path(s):

/api/v1/logical-switches/state

Request Headers:

n/a

Query Parameters:

LogicalSwitchStateParameters+

Name	Description	Type	Notes
status	Realized state of logical switches	string	Enum: PENDING, IN_PROGRESS, PARTIAL_SUCCESS, SUCCESS

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/logical-switches/state?status=IN_PROGRESS

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalSwitchStateListResult+

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	Logical Switch State Results	array of LogicalSwitchState	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "state" : "in_progress", "logical_switch_id": "cc5ff938-6f09-4841-8f0f-294e86415472", "details": [ { "state" : "in_progress", "sub_system_id" : "366048ba-89d9-435e-ac2e-2c7cf6ed0f33", "sub_system_type" : "TransportNode" } ] }

Required Permissions:

read

Feature:

switching_switches

Additional Errors:

404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable