Discovery - NVIDIA Docs

Discovery Settings REST API

Description	Set or get discovery settings flags
Request URL	neo/app/settings/discovery

Response/Request Data:

Copy
Copied!

            
            {
	"auto_discovery": true,
	"lldp_discovery_all": true,
	"lldp_discovery": true,
	"support_no_ip": false
}

Discovery Ranges

Add Discovery Range

Description	Adds a new range to NEO
Request URL	POST /neo/app/discovery/allowed/ranges
Options	discovery_methods": [lldp", "agent" , "range_scan"] "device_types": ["mlnxos_switch", "arista_switch", "brocade_switch", "hp_switch", "cumulus_switch", " juniper_switch", "cisco_switch", "linux_host", "windows_host"] "init": ["lldp", "snmp", "snmp_traps"] – initialize added devices with predefined configurations: lldp – initialize LLDP on switches (Onyx/Cumulus) snmp – initialize SNMP v2c on switches (Cumulus) snmp_traps – register to SNMP traps on switches (Onyx/Cumulus)
Response	HTTP response location header will contain an ID created for the new range

Request Data:

Copy
Copied!

            
            {
	"active": "<true | false>",
	"start_address": "10.0.0.1",
	"end_address": "10.0.0.255",
	"discovery_methods": ["lldp", "agent"],
	"device_types": ["mlnxos_switch"],
	"init": ["lldp", "snmp_traps"]
}

Update Discovery Range

Description	Updates a range to NEO using its ID
Request URL	PUT /neo/app/discovery/allowed/ranges/<ID>
Options	discovery_methods": \[lldp", "agent", "range_scan"\] "device_types": \["mlnxos_switch", "arista_switch", "brocade_switch", "hp_switch", "cumulus_switch", " juniper_switch", "cisco_switch", "linux_host", "windows_host"\] "init": ["lldp", "snmp", "snmp_traps"] – initialize added devices with predefined configurations: snmp – initialize SNMP v2c on switches (Cumulus) snmp_traps – register to SNMP traps on switches (Onyx/Cumulus) lldp – initialize LLDP on switches (Onyx/Cumulus)
Response	HTTP response location header will contain an ID created for the new range

Request Data:

Copy
Copied!

            
            {
	"active": "<true | false>",
	"discovery_methods": ["lldp", "agent"],
	"device_types": ["mlnxos_switch"],
	"init": ["lldp", "snmp_traps"]
}

Delete Discovery Range

Description	Deletes a range to NEO using its ID
Request URL	DELETE /neo/app/discovery/allowed/ranges/<ID>
Response	HTTP response location header will contain a URI with a job ID created for the existing systems removal: /neo/app/jobs/<job_ID>
Status Codes	Note: Status code 409 CONFLICT means that "scan is in progress, please wait until scan is completed" in case of update when scan is running.

Get Discovery Ranges

Description	Gets the ranges information
Request URL	GET /neo/app/discovery/allowed/ranges/

Response:

Copy
Copied!

            
            {
	"ranges": [{
			"id": "<ID>",
			"active": "<true | false>",
			"start_address": "10.0.0.1",
			"end_address": "10.0.0.255",
			"discovery_methods": ["lldp", "agent"],
			"device_types": ["mlnxos_switch"],
			"init": ["lldp", "snmp_traps"]
		}
	],
	"subnets": [{
			"id": "<ID>",
			"active": "<true | false>",
			"subnet_address": "10.0.0.0",
			"subnet_mask": "/24",
			"discovery_methods": ["range_scan"],
			"device_types": ["mlnxos_switch ", "cisco_switch", "linux_host"],
			"init": []
		}
	]
	"addresses": [{
			"type": "<added | discovered>",
			"address": "10.0.0.1",
			"device_type": "mlnxos_switch"
		}, {
			"type": "<added | discovered>",
			"address": "10.0.0.2",
			"device_type": "mlnxos_switch"
		}, {
			"type": "<added | discovered>",
			"address": "10.0.0.3",
			"device_type": "linux_host"
		}
 
	]
}

Warning

The response retrieves all discovery ranges as well as all discovery subnets in NEO

Discovery Subnets

Add Discovery Subnet

Description	Adds a new subnet to NEO
Request URL	POST /neo/app/discovery/allowed/subnets
Options	discovery_methods": \[lldp", "agent" , "range_scan"\] "device_types": \["mlnxos_switch", "arista_switch", "brocade_switch", "hp_switch", "cumulus_switch", " juniper_switch", "cisco_switch", "linux_host", "windows_host", nutanix_host"\] "init": ["lldp", "snmp", "snmp_traps"] – initialize added devices with predefined configurations: lldp – initialize LLDP on switches (Onyx/Cumulus) snmp – initialize SNMP v2c on switches (Cumulus) snmp_traps – register to SNMP traps on switches (Onyx/Cumulus)
Response	HTTP response location header will contain an ID created for the new subnet

Request Data:

Copy
Copied!

            
            {
	"active": "<true|false>",
	"subnet_address": "1.2.3.4",
	"subnet_mask": "/24",
	"discovery_methods": ["range_scan"],
	"discovery_methods": ["lldp", "agent"]
	"device_types": ["mlnxos_switch "],
	"init": ["lldp", "snmp_traps"]
}

Update Discovery Subnet

Description	Updates a subnet to NEO using its ID
Request URL	PUT /neo/app/discovery/allowed/subnets/<ID>
Options	discovery_methods": [lldp", "agent", "range_scan"] "device_types": ["mlnxos_switch", "arista_switch", "brocade_switch", "hp_switch", "cumulus_switch", " juniper_switch", "cisco_switch", "linux_host", "windows_host", nutanix_host"] "init": ["lldp", "snmp", "snmp_traps"] – initialize added devices with predefined configurations: lldp – initialize LLDP on switches (Onyx/Cumulus) snmp – initialize SNMP v2c on switches (Cumulus) snmp_traps – register to SNMP traps on switches (Onyx/Cumulus)
Response	HTTP response location header will contain an ID created for the new subnet

Request Data:

Copy
Copied!

            
            {
	"active": "<true|false>",
	"discovery_methods": ["lldp", "agent"]
	"device_types": ["mlnxos_switch "],
	"init": ["lldp", "snmp_traps"]
}

Delete Discovery Subnet

Description	Deletes a subnet to NEO using its ID
Request URL	DELETE /neo/app/discovery/allowed/subnets/<ID>
Response	HTTP response location header will contain a URI with a job ID created for the existing systems removal: /neo/app/jobs/<job_ID>
Status Codes	Note: status code 409 CONFLICT means that "scan is in progress, please wait until scan is completed" in case of update when scan is running.

Get All Discovery Subnets

Description	Retrieves all subnets in NEO
Request URL	GET /neo/app/discovery/allowed

Response:

Copy
Copied!

            
            {
	"ranges": [{
			"id": "<ID>",
			"active": "<true | false>",
			"start_address": "10.0.0.1",
			"end_address": "10.0.0.255",
			"discovery_methods": ["lldp", "agent"],
			"device_types": ["mlnxos_switch"],
			"init": ["lldp", "snmp_traps"]
		}
	],
	"subnets": [{
			"id": "<ID>",
			"active": "<true | false>",
			"subnet_address": "10.0.0.0",
			"subnet_mask": "/24",
			"discovery_methods": ["range_scan"],
			"device_types": ["mlnxos_switch", "cisco_switch", "linux_host"],
			"init": ["lldp", "snmp_traps"]
		}
	]
	"addresses": [{
			"type": "<added | discovered>",
			"address": "10.0.0.1",
			"device_type": "mlnxos_switch"
		}, {
			"type": "<added | discovered>",
			"address": "10.0.0.2",
			"device_type": "mlnxos_switch"
		}, {
			"type": "<added | discovered>",
			"address": "10.0.0.3",
			"device_type": "linux_host"
		}
 
	]
}

Warning

The response retrieves all discovery subnets as well as all discovery ranges in NEO

Discovery Scan Ranges/Subnets

Scan Specific Discovery Range/Subnet

Description	Scans a specific range/subnet in NEO using its ID
Request URL	POST /neo/app/discovery/allowed/<ID>/scan
Request Content Type	application/json
Response	HTTP response location header will contain a URI with a job ID created for the existing systems removal: /neo/app/jobs/<job_ID>
Status Codes	Note: Status code 403 FORBIDDEN means "Auto Discovery is not enabled." This occurs in case of activation while auto-discovery is turned off. Status code 409 CONFLICT means that "scan is in progress, please wait until scan is completed" in case of update when scan is running.

Scan All Discovery Ranges/Subnets

Description	Scans all ranges/subnets in NEO
Request URL	POST /neo/app/discovery/allowed/scan
Status Codes	Note: Status code 403 FORBIDDEN means "Auto Discovery is not enabled." This occurs in case of activation while auto-discovery is turned off. Status code 409 CONFLICT means that "scan is in progress, please wait until scan is completed" in case of update when scan is running.

Description

Scans all ranges/subnets in NEO

Request URL

POST /neo/app/discovery/allowed/scan

Status Codes

Note:

Status code 403 FORBIDDEN means "Auto Discovery is not enabled." This occurs in case of activation while auto-discovery is turned off.

Status code 409 CONFLICT means that "scan is in progress, please wait until scan is completed" in case of update when scan is running.

Discovery Blacklist

Add Discovery Blacklist

Description	Adds systems to a blacklist, in order for NEO to avoid discovering them
Request URL	POST /neo/app/discovery/blacklist
Request Content Type	application/json
Request Data	{ "addresses": ["10.0.0.34","192.168.5.67"] }
Status Codes	Note: Status code 409 CONFLICT means that "scan is in progress, please wait until scan is completed" in case of update when scan is running.

Get Discovery Blacklist

Description	Retrieves systems of a blacklist in NEO
Request URL	GET /neo/app/discovery/blacklist
Request Data	{ "addresses": ["10.0.0.34","192.168.5.67"] }
Response	{ "addresses": ["10.0.0.34","192.168.5.67"] }
Status Codes	Note: Status code 409 CONFLICT means that "scan is in progress, please wait until scan is completed" in case of update when scan is running.

On This Page