Create a Discovery Job
post
/discovery/request/create
Creates a new job to discover devices.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
The payload for a discovery request.
Show Source
-
Data: object
Data
The discovery request data.
-
Type: string
Allowed Values:
[ "discovery" ]
The type of discovery. -
Version: string
The discovery version.Example:
1.0.0
Nested Schema : Data
Type:
object
The discovery request data.
Show Source
-
Configuration: object
Configuration
The ICMP, SNMP and REST Configuration for discovery.
-
InventoryEngine: string
Discovery inventory engine name.Example:
inventory-engine-name
-
IPList: array
IPList
List of IP Addresses.
-
IPranges: array
IPranges
List of IP Ranges. Supports CIDR ranges.
-
Level: array
Level
Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
Nested Schema : Configuration
Type:
object
The ICMP, SNMP and REST Configuration for discovery.
Show Source
-
ContextExpiryTimeM: integer
Minimum Value:
0
Maximum Value:2147483647
The number of minutes before the discovery expires.Example:60
-
ForcedProtocolDiscovery: boolean
Allowed Values:
[ true, false ]
Whether to discover every protocol regardless of ICMP result (true) or not (false). -
ICMPConfiguration: array
ICMPConfiguration
The list of ICMP configurations.
-
RESTConfiguration: array
RESTConfiguration
The list of REST configurations.
-
SNMPConfiguration: array
SNMPConfiguration
The list of SNMP configurations.
Nested Schema : IPList
Type:
array
List of IP Addresses.
Show Source
Example:
[
"203.0.113.0",
"203.0.113.1"
]
Nested Schema : IPranges
Type:
array
List of IP Ranges. Supports CIDR ranges.
Show Source
Example:
[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
]
Nested Schema : Level
Type:
array
Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
Show Source
-
Array of:
integer
Allowed Values:
[ 1, 2, 3 ]
Example:
[
1,
2,
3
]
Nested Schema : ICMPConfiguration
Type:
array
The list of ICMP configurations.
Show Source
-
Array of:
object ICMPConfiguration
The ICMP payload configuration.
Nested Schema : RESTConfiguration
Type:
array
The list of REST configurations.
Show Source
-
Array of:
object RESTConfiguration
REST configurations for Juniper MIST and VMWare connections.
Nested Schema : SNMPConfiguration
Type:
array
The list of SNMP configurations.
Show Source
-
Array of:
object SNMPConfiguration
The SNMP payload configuration.
Nested Schema : ICMPConfiguration
Type:
object
The ICMP payload configuration.
Show Source
-
CascadeMs: integer
Minimum Value:
0
Maximum Value:2147483647
The number of milliseconds between two successful pings.Example:5
-
Count: integer
Minimum Value:
0
Maximum Value:2147483647
The number of ping requests to send.Example:5
-
Mode(required): integer
Allowed Values:
[ 0, 1 ]
The ICMP mode. Possible values are 0 for synchronous and 1 for asynchronous.Example:1
-
Timeouts: integer
Minimum Value:
0
Maximum Value:2147483647
The number of milliseconds to wait for the ping message corresponding to a given ping message.Example:10
Nested Schema : RESTConfiguration
Type:
object
REST configurations for Juniper MIST and VMWare connections.
Show Source
-
APIAccessID: string
The base64-encoded API access ID for the REST API URL.Example:
dGVzdA==
-
APIAccessKey: string
The base64-encoded API access key for the REST API URL.Example:
dGVzdA==
-
APIType(required): string
Allowed Values:
[ "vmware" ]
The REST API type.Example:vmware
-
Port: integer
Minimum Value:
0
Maximum Value:65535
The port number for the REST API URL.Example:8080
-
Protocol(required): string
Allowed Values:
[ "http", "https" ]
The protocol used for the REST API.Example:https
-
Url: string
The REST API URL for VMWare or Mist.Example:
192.0.2.0
Nested Schema : SNMPConfiguration
Type:
object
The SNMP payload configuration.
Show Source
-
CustomSNMPAccessProfiles: array
CustomSNMPAccessProfiles
The list of custom SNMP access profiles.
-
ExponentialTimeout: boolean
Allowed Values:
[ true, false ]
The status is enabled to timeout exponentially if the request fails.Example:false
-
IsTCP: boolean
Allowed Values:
[ true, false ]
Whether SNMP is implemented over TCP (true) or not (false).Example:false
-
MaxOids: integer
Minimum Value:
0
Maximum Value:128
The maximum SNMP OID value.Example:100
-
MaxRepetitions: integer
Minimum Value:
0
Maximum Value:2147483647
The maximum number of repetitions.Example:50
-
Method: string
Allowed Values:
[ "BULK", "GET" ]
The SNMP method.Example:BULK
-
NonRepeaters: integer
Minimum Value:
0
Maximum Value:2147483647
The number of non repeaters.Example:1
-
Retries: integer
Minimum Value:
0
Maximum Value:2147483647
The number of times to retry the request.Example:3
-
Timeout: string
Allowed Values:
[ "1s", "2m", "3h", "4d" ]
The number of seconds, minutes, hours, or days before the request times out.Example:5s
Nested Schema : CustomSNMPAccessProfiles
Type:
array
The list of custom SNMP access profiles.
Show Source
-
Array of:
object CustomSNMPAccessProfile
A custom SNMP access profile.
Nested Schema : CustomSNMPAccessProfile
Type:
object
A custom SNMP access profile.
Show Source
-
Auth: object
CustomSNMPAccessProfileAuth
Custom SNMP access profile authentication information.
-
MTU: integer
Minimum Value:
0
Maximum Value:2147483647
The MTU for the custom SNMP access profile.Example:1456
-
Port: integer
Minimum Value:
0
Maximum Value:65535
The custom SNMP access profile port.Example:161
-
Priority: integer
Minimum Value:
0
Maximum Value:2147483647
The custom SNMP access profile priority.Example:1
-
ProfileID: integer
Minimum Value:
0
Maximum Value:4.294967295E9
The custom SNMP access profile ID.Example:1
-
UUID: string
(uuid)
The custom SNMP access profile UUID.Example:
df29b366-c3a4-4a89-8ec8-2f1527276c75
-
Version(required): integer
Allowed Values:
[ 1, 2, 3 ]
The custom SNMP access profile version.Example:2
Nested Schema : CustomSNMPAccessProfileAuth
Type:
object
Custom SNMP access profile authentication information.
Show Source
-
AuthEngineID: string
The custom SNMP access profile authentication engine ID.Example:
80001adc802417e202b8613f5400000000
-
AuthPassphrase: string
The custom SNMP access profile authentication passphrase.Example:
QXV0aFBhc3N3b3Jk
-
AuthProtocol: string
The custom SNMP access profile authentication protocol.Example:
SHA256
-
AuthType: string
Allowed Values:
[ "NOAUTHNOPRIV", "AUTHNOPRIV", "AUTHPRIV" ]
The custom SNMP access profile authentication type.Example:AUTHPRIV
-
Community: string
The custom SNMP access profile community string.Example:
public
-
PrivPassphrase: string
The custom SNMP access profile private passphrase.Example:
UHJpdlBhc3N3b3Jk
-
PrivProtocol: string
The custom SNMP access profile private protocol.Example:
AES
-
Username: string
The custom SNMP access profile user name.Example:
user
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : DiscoveryCreateResponse
Type:
Show Source
object
-
DiscoveryContextID: string
The ID obtained from discovery request.Example:
disco-01f107bd-655f-42e0-ae1c-ac4740e734e7
-
time-valid: integer
The number of seconds the discovery result is valid.Example:
3600
400 Response
Bad request
401 Response
Unauthorized operation
500 Response
Internal server error