NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Systems VLANs

Description

Retrieves all VLAN data for all systems available in NEO

Request URL

GET /neo/resources/vlans

Request Data

N/A

Response:

Copy
Copied!
            

[ { "systemIP": "10.224.15.29", "name": "12", "portNames": [], "portIDs": [], "vlanID": 12, "vlanName": "12", "systemName": "switch29", "systemID": "10.224.15.29.system", "id": "10.224.15.29.vlan.12" }, { "systemIP": "10.224.15.29", "name": "8", "portNames": [], "portIDs": [], "vlanID": 8, "vlanName": "8", "systemName": "switch29", "systemID": "10.224.15.29.system", "id": "10.224.15.29.vlan.8" } ]

Description

Retrieves all VLAN data for specific systems in NEO

Request URL

GET /neo/resources/vlans?system_ids=<list of system ids>

Request Data

N/A

Response:

Copy
Copied!
            

[{ "systemIP": "10.224.15.29", "name": "12", "portNames": [], "portIDs": [], "vlanID": 12, "vlanName": "12", "systemName": "switch29", "systemID": "10.224.15.29.system", "id": "10.224.15.29.vlan.12" }, { "systemIP": "10.224.15.29", "name": "8", "portNames": [], "portIDs": [], "vlanID": 8, "vlanName": "8", "systemName": "switch29", "systemID": "10.224.15.29.system", "id": "10.224.15.29.vlan.8" } ]

Description

Retrieves all VLAN data for specific ports in NEO

Request URL

GET /neo/resources/ports/<port_id>/vlans

Request Data

N/A

Response:

Copy
Copied!
            

[ { "systemIP": "10.224.15.29", "name": "", "operationalEndpointMode": 2, "vlanID": 1, "vlanName": "default", "systemID": "10.224.15.29.system", "vlanMode": "Access", "systemName": "switch29", "id": "10.224.15.29.eth1.1.vlan.ep.1" } ]

Description

Retrieves all VLAN data for VLAN IDs provided

Request URL

GET /neo/resources/ports/<port_id>/vlans

Request Data

N/A

Response:

Copy
Copied!
            

[ { "systemIP": "10.224.15.29", "name": "12", "portNames": [], "portIDs": [], "vlanID": 12, "vlanName": "12", "systemName": "switch29", "systemID": "10.224.15.29.system", "id": "10.224.15.29.vlan.12" } ]

Warning

vlans_ids - can be one or more VLAN IDs, separated by comma.

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