Get Logical Switch Statistics

Returns statistics of a specified logical switch. The query parameter "source=realtime" is not supported.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/logical-switches/{lswitch-id}/statistics

COPY

Path Parameters

string

lswitch-id

Required

lswitch-id

Query Parameters

string

source

Optional

Data source type.

Possible values are : realtime, cached,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LogicalSwitchStatistics of type(s) application/json

This response body class contains all of the following: AggregatedDataCounterEx , InlineLogicalSwitchStatistics1

{
    "tx_bytes": {
        "total": 0,
        "multicast_broadcast": 0,
        "dropped": 0
    },
    "rx_packets": {
        "total": 0,
        "multicast_broadcast": 0,
        "dropped": 0
    },
    "tx_packets": {
        "total": 0,
        "multicast_broadcast": 0,
        "dropped": 0
    },
    "rx_bytes": {
        "total": 0,
        "multicast_broadcast": 0,
        "dropped": 0
    },
    "mac_learning": {
        "macs_learned": 0,
        "mac_not_learned_packets_dropped": 0,
        "mac_not_learned_packets_allowed": 0
    },
    "dropped_by_security_packets": {
        "spoof_guard_dropped": [
            {
                "counter": 0,
                "packet_type": "string"
            }
        ],
        "dhcp_server_dropped_ipv4": 0,
        "dhcp_server_dropped_ipv6": 0,
        "dhcp_client_dropped_ipv4": 0,
        "bpdu_filter_dropped": 0,
        "dhcp_client_dropped_ipv6": 0
    },
    "last_update_timestamp": 0,
    "logical_switch_id": "string"
}

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