Add IPs as seeds to a discovery task

Method

URL

Required authentication

POST

/V1/CMDB/Discovery/Tasks/{task}/Seeds

Yes

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

task*required
(path)

Input the name or ID of the scheduled discovery task. Get a task ID by using the API Get all discovery tasks in a domain.

Request*required
(body)

The body contains the following parameters:

▪seeds* (list): a list of IP entries. The following is the information of each seed.

omgmtIP* (string): the management IP address of a device.

ocliType (integer): the access method to the device. When it is null, the SNMP method will be used.

➢0: Telnet

➢1: SSH

ouserName (string): the username to access the device.

opassword (string): the password to access the device.

oprivilegeUsername (string): the username to enter the privileged mode of the device.

oprivilegePassword (string): the password to enter the privileged mode of the device.

odesignatedCredentials (bool): determine whether the API only uses the credentials you have specified. If false, the API will use credentials in network settings.

osnmpCommunityString (string): the SNMP community string to access the device.

ofrontServerOrGroupAlias(string): the alias of NetBrain Front Server to access your live network.

Example:

{
  "seeds": [
    {
      "mgmtIP": "string",
      "cliType": 0,
      "userName": "NetBrain",
      "password": "NetBrain",
      "privilegeUsername": "string",
      "privilegePassword": "string",
      "designatedCredentials": true,
      "snmpCommunityString": "string",
      "frontServerOrGroupAlias": "string"
    }
  ]
}

statusCode

integer

The returned status code of executing the API.

{
  "statusCode": 790200,
  "statusDescription": "success"
}

statusDescription

string

The explanation of the status code.