Ports

Description

Retrieves all port data for all systems available in the NEO

Request URL

GET /neo/resources/ports

Request Data

N/A

Response:

Copy
Copied!
            

[ { "macAddress": "24:8A:07:81:B0:9C", "protocol": "Ethernet", "supportedSpeeds": "1G,10G,25G,40G,50G,56G,100G", "adapter_id": null, "portNumber": 2, "id": "10.209.36.162.network_port.eth1.2", "lagMode": null, "allowedVlans": [], "lagMembership": null, "adminState": "Enabled", "health": "OK", "systemName": "r-ufm-sw75", "systemIP": "10.209.36.162", "description": "", "systemID": "10.209.36.162.system", "vlans": [ 1 ], "maxSpeed": "100 Gbps", "name": "Eth1/2", "mtu": 1500, "activeSpeed": "100 Gbps", "vlanMode": "Access", "accessVlan": 1, "peerMacAddress": "24:8A:07:81:AD:9C", "operationalState": "UP" }, … ]

Description

Retrieved port data for specific systems in the NEO. Users can use this API to get ports for one system or more, by specifying systems instanceID's in Request URL

Request URL

GET /neo/resources/ports?system_ids=<list of system systems>

list_of_systems: can be one or more instanceID for systems separated by comma such as <system1_IP>.system,<system2_IP>.system …

Request Data

N/A

Response:

Copy
Copied!
            

[ { "macAddress": "24:8A:07:81:B0:9C", "protocol": "Ethernet", "supportedSpeeds": "1G,10G,25G,40G,50G,56G,100G", "adapter_id": null, "portNumber": 2, "id": "10.209.36.162.network_port.eth1.2", "lagMode": null, "allowedVlans": [], "lagMembership": null, "adminState": "Enabled", "health": "OK", "systemName": "r-ufm-sw75", "systemIP": "10.209.36.162", "description": "", "systemID": "10.209.36.162.system", "vlans": [ 1 ], "maxSpeed": "100 Gbps", "name": "Eth1/2", "mtu": 1500, "activeSpeed": "100 Gbps", "vlanMode": "Access", "accessVlan": 1, "peerMacAddress": "24:8A:07:81:AD:9C", "operationalState": "UP" }, … ]

Warning
  • Inventory items include all hardware components, such as CPU, FAN, PS etc.

  • If an invalid or non-existing system is specified, a NOT FOUND error (404) will be received.

Description

Retrieves all port information filtered by adapters

Request URL

GET /neo/resources/ports?adapter_ids=<adapter_id1>,<adapter_id2>

Request Data

N/A

Response:

Copy
Copied!
            

[ { "systemID": < system_id > , "systemIP": < system_ip > , "vlans": [], "protocol": "Ethernet", "name": < port_name > , "adapter_id": < adapter_id > , "lagMembership": null, "mtu": "N/A", "vlanMode": null, "adminState": "Enabled", "health": "OK", "permanentAddress": "<original_base_mac>" "portNumber": < number_in_adapter > , "activeSpeed": < port_speed > , "operationalState": "UP", "systemName": "r-smg34", "id": < port_id > , "lagMode": null } ]

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.