|
Description |
This interface is used to retrieve information on all/specific available systems in NEO (that are currently discovered by NEO). |
|
|
Request URL |
GET /neo/resources/systems or GET /neo/resources/systems/<sys_id1>,<sys_id2> |
|
|
Filters |
Specific systems can be filtered for using the following filter attributes: |
|
|
Filter Attributes |
Description |
|
|
interconnected_system=<sys_id> |
Returns only systems that are linked to the system with the specified ID |
|
|
min_num_of_links=<number> |
Returns only systems that have at least the specified number of links. If used in conjunction with the interconnected_system filter attribute, returns only systems that have at least the specified number of links to the system with the specified ID. |
|
|
Request Data |
N/A |
|
|
MLAG Attributes |
peerIplIp |
The IP of the peer in the IPL |
peerMgmtIp |
The management IP of the peer system |
|
iplLag |
IPL LAG identifier |
|
localIplIp |
The IP of the device in the IPL |
|
role |
The role of the system in the MLAG Can be either master/standby |
|
Response:
[{
"status": "Communication OK",
"profile": "Eth Single Switch",
"healthState": "OK",
"mlag": {
"peerIplIp": "10.10.10.2",
"peerMgmtIp": "10.224.15.90",
"iplLag": "",
"macAddress": "00:00:5E:00:01:5D",
"virtualIp": "10.10.10.254/24",
"localIplIp": "10.10.10.1",
"adminState": "Disabled",
"role": "master",
"vlanInterface": "4000",
"operationalState": "Down",
"id": "10.224.15.89.mlag.1",
"name": ""
},
"vendor": "Mellanox",
"name": "ufm-switch19",
"ipAddress": "10.224.15.89",
"swVersion": "X86_64 3.6.3130 2017-02-27 18:57:09 x86_64",
"id": "10.224.15.89.system",
"caption": "Mellanox Onyx",
"model": "MSN2700",
"sysType": "Mellanox Switch",
"isManagement": true
}, {
"status": "Communication OK",
"profile": "Eth Single Switch",
"healthState": "OK",
"mlag": null,
"vendor": "Mellanox",
"name": "ufm-switch20",
"ipAddress": "10.224.15.90",
"swVersion": "X86_64 3.6.1002 2016-06-09 20:24:31 x86_64",
"id": "10.224.15.90.system",
"caption": "Mellanox Onyx",
"model": "MSN2700",
"sysType": "Mellanox Switch",
"isManagement": true
}
]
If a certain system is not part of an MLAG, the "mlag" attribute value will be "null."
|
Description |
This interface is used to add new systems to NEO. |
|
Request URL |
POST /neo/resources/systems |
|
Options |
|
|
Response |
HTTP response location header will contain an ID created for the new system |
Request Data:
[{
"iPv4Address": "<system_IP>"
"device_type": "mlnxos_switch"
"init": ["lldp", "snmp_traps"]
}, ..
]
|
Description |
This interface is used to remove existing systems from NEO |
|
Request URL |
DELETE /neo/resources/systems/system_IP, system_IP… |
|
Request Data |
N/A |
|
Response |
HTTP response location header will contain a URI with a job ID created for the existing systems removal: /neo/app/jobs/ |