NSX-T Data Center REST API

Get Status Summary of All Logical Switches in the System (Deprecated)

Returns Operational status of all logical switches.
The query parameter "source=realtime" is not supported.
Deprecated: This API is now deprecated Please use new API - GET policy/api/v1/infra/segments/state?configuration_state=success to get segment in success state. And use new api - GET policy/api/v1/infra/segments to get all segment.

Request:

Method:

GET

URI Path(s):

/api/v1/logical-switches/status

Request Headers:

n/a

Query Parameters:

LogicalSwitchListWithSourceParameters+

LogicalSwitchListWithSourceParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
diagnostic	Flag to enable showing of transit logical switch.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	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
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
switch_type	Logical Switch type	string	Enum: DEFAULT, SERVICE_PLANE, DHCP_RELAY, GLOBAL, INTER_ROUTER, EVPN, DVPG
switching_profile_id	Switching Profile identifier	string
transport_type	Mode of transport supported in the transport zone for this logical switch	TransportType
transport_zone_id	Transport zone identifier	string
uplink_teaming_policy_name	The logical switch's uplink teaming policy name	string
vlan	Return VLAN logical switches whose "vlan" field matches this value	VlanID
vni	VNI of the OVERLAY LogicalSwitch(es) to return.	int

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalSwitchStatusSummary+

Name	Description	Type	Notes
filters	The filters used to find the logical switches- TransportZone id, LogicalSwitchProfile id or TransportType	array of Filter
fully_realized_switches	The number of logical switches that are realized in all transport nodes.	integer	Required
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
total_switches	The total number of logical switches.	integer	Required

Example Response:

{ "total_switches": 6, "fully_realized_switches": 6 }

Required Permissions:

read

Feature:

aggregation_service_health_monitoring