Get Logical Port Status Summary

Get Logical Port Status Summary

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

Request
URI
GET
https://nsxmanager.your.domain/api/v1/logical-ports/status
COPY
Query Parameters
string
attachment_id
Optional

Logical Port attachment Id

string
attachment_type
Optional

Type of attachment for logical port; for query only.

Possible values are : VIF, LOGICALROUTER, BRIDGEENDPOINT, DHCP_SERVICE, METADATA_PROXY, L2VPN_SESSION, NONE,
string
bridge_cluster_id
Optional

Bridge Cluster identifier

boolean
container_ports_only
Optional

Only container VIF logical ports will be returned if true

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 port.

string
included_fields
Optional

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

string
logical_switch_id
Optional

Logical Switch identifier

integer
page_size
Optional

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

string
parent_vif_id
Optional

ID of the VIF of type PARENT

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

Network Profile identifier

string
transport_node_id
Optional

Transport node identifier

string
transport_zone_id
Optional

Transport zone identifier

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LogicalPortStatusSummary of type(s) application/json 
{
    "total_ports": 0,
    "last_update_timestamp": 0,
    "up_ports": 0,
    "filters": [
        {
            "name": "string",
            "value": "string"
        }
    ]
}
integer As int64 As int64
total_ports
Required

The total number of logical ports.

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
up_ports
Required

The number of logical ports whose Operational status is UP

array of Filter
filters
Optional

The filters used to find the logical ports- TransportZone id, LogicalSwitch id or LogicalSwitchProfile id


400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Logical Switching Operations
POST
Create Logical Port
POST
Create Logical Switch
POST
Create Switching Profile
DELETE
Delete Logical Port
DELETE
Delete Logical Switch
DELETE
Delete Switching Profile
GET
Get Logical Port
GET
Get Logical Port Mac Table
GET
Get Logical Port Mac Table In Csv Format Csv
GET
Get Logical Port Operational Status
GET
Get Logical Port State
GET
Get Logical Port Statistics
GET
Get Logical Port Status Summary
GET
Get Logical Switch
GET
Get Logical Switch Mac Table
GET
Get Logical Switch Mac Table In Csv Format Csv
GET
Get Logical Switch State
GET
Get Logical Switch Statistics
GET
Get Logical Switch Status
GET
Get Logical Switch Status Summary
GET
Get Logical Switch Vtep Table
GET
Get Logical Switch Vtep Table In Csv Format Csv
GET
Get Switching Profile
GET
Get Switching Profile Status
GET
List Logical Ports
GET
List Logical Switches
GET
List Logical Switches By State
GET
List Switching Profiles
PUT
Update Logical Port
PUT
Update Logical Switch
PUT
Update Switching Profile