Get Logical Switch Status Summary

Returns Operational status of all logical switches. The query parameter "source=realtime" is not supported.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/logical-switches/status

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

diagnostic

Optional

Flag to enable showing of transit logical switch.

string

included_fields

Optional

Comma separated list of fields that should be included in query result

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

source

Optional

Data source type.

Possible values are : realtime, cached,

string

switching_profile_id

Optional

Switching Profile identifier

string

transport_type

Optional

Mode of transport supported in the transport zone for this logical switch

Possible values are : OVERLAY, VLAN,

string

transport_zone_id

Optional

Transport zone identifier

string

uplink_teaming_policy_name

Optional

The logical switch's uplink teaming policy name

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LogicalSwitchStatusSummary of type(s) application/json

{
    "last_update_timestamp": 0,
    "total_switches": 0,
    "filters": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "fully_realized_switches": 0
}

integer As int64 As int64

last_update_timestamp

Optional

Timestamp when the data was last updated; unset if data source has never updated the data.

integer As int64 As int64

total_switches

Required

The total number of logical switches.

array of Filter

filters

Optional

The filters used to find the logical switches- TransportZone id, LogicalSwitchProfile id or TransportType

integer As int64 As int64

fully_realized_switches

Required

The number of logical switches that are realized in all transport nodes.

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error