Switch Ports Details
GET {{base_url}}/monitoring/v1/switches/:serial/ports?slot=<string>
Get switch ports details. Possible error_codes for the error responses are 1. 0001 - General Error.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
slot | string | Slot name of the ports to be queried {For chassis type switches only}. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":"\u003cinteger\u003e","ports":[{"admin_state":"\u003cstring\u003e","allowed_vlan":["\u003cinteger\u003e","\u003cinteger\u003e"],"has_poe":"\u003cboolean\u003e","mode":"\u003cstring\u003e","mux":"\u003cboolean\u003e","oper_state":"\u003cstring\u003e","poe_state":"\u003cstring\u003e","port_number":"\u003cstring\u003e","power_consumption":"\u003cinteger\u003e","rx_usage":"\u003cnumber\u003e","speed":"\u003cstring\u003e","status":"\u003cstring\u003e","trusted":"\u003cboolean\u003e","tx_usage":"\u003cnumber\u003e","type":"\u003cstring\u003e","vlan":"\u003cinteger\u003e","slot":"\u003cstring\u003e","alignment":"\u003cstring\u003e","internal":"\u003cstring\u003e","phy_type":"\u003cstring\u003e","sub_type":"\u003cstring\u003e","duplex_mode":"\u003cstring\u003e","macaddr":"\u003cstring\u003e","is_uplink":"\u003cboolean\u003e","port":"\u003cstring\u003e","out_errors":"\u003cinteger\u003e","in_errors":"\u003cinteger\u003e"},{"admin_state":"\u003cstring\u003e","allowed_vlan":["\u003cinteger\u003e","\u003cinteger\u003e"],"has_poe":"\u003cboolean\u003e","mode":"\u003cstring\u003e","mux":"\u003cboolean\u003e","oper_state":"\u003cstring\u003e","poe_state":"\u003cstring\u003e","port_number":"\u003cstring\u003e","power_consumption":"\u003cinteger\u003e","rx_usage":"\u003cnumber\u003e","speed":"\u003cstring\u003e","status":"\u003cstring\u003e","trusted":"\u003cboolean\u003e","tx_usage":"\u003cnumber\u003e","type":"\u003cstring\u003e","vlan":"\u003cinteger\u003e","slot":"\u003cstring\u003e","alignment":"\u003cstring\u003e","internal":"\u003cstring\u003e","phy_type":"\u003cstring\u003e","sub_type":"\u003cstring\u003e","duplex_mode":"\u003cstring\u003e","macaddr":"\u003cstring\u003e","is_uplink":"\u003cboolean\u003e","port":"\u003cstring\u003e","out_errors":"\u003cinteger\u003e","in_errors":"\u003cinteger\u003e"}]}