Auto Discovery Profile - RESTful API – Entuity

Summary:

View, edit and delete a specific Auto Discovery profile. Applicable to Enuity v19.0 upwards.

URL:

http(s)://{server hostname}/api/autodiscoveryProfiles/{id}

Methods summary

GET Method - returns the settings of this profile (XML, JSON).
PUT Method - modifies this profile's settings.
DELETE Method - removes this profile.

GET Method detail

Shows the settings of this Auto Discovery profile.

Response:

Name	Description
id	ID number for the discovery profile.
name	user-specified name of the discovery profile.
description	user-specified description of the discovery profile.
zoneID	zone ID.
includedAddresses	addresses to scan. Comma-separated IP addresses or hostnames.
excludedAddresses	addresses to exclude. Comma-separated IP addresses or hostnames.
flags	a bitflag for flags (note, the API takes decimals): 0 - manage discovered devices after discovery finishes. 1 - allow duplicate IPs. 2 - use all credentials. If this is specified, the 'Credentials' field is ignored. 3 - manage associated devices after discovery. 5 - use management IP. For example, if you wish to allow duplicate IPs, manage associate devices after discovery, and use management IP, you will need to set bits 1, 3, 5 to 1 - 101010. Because the API takes API, you will need to specify "flag":42.
credentials	list of credential IDs to try.
scheduleBitSet	a bitflag for the days on which the schedule should be run. If 0, it does not run. 0: Monday to 6: Sunday.
scheduleHours	hour in which the schedule should be run in 24-hour time.
autoManagementLevel	the level of device management, if automanage is on: 1 - full. 2 - full, management interface only. 3 - full, no interfaces. 4 - basic. 5 - basic, ping only. 6 - web. 7 - none. 8 - CLI (not used).
displayNameUsing	the name to be used in management: 0 - system. 1 - resolved. 2 - resolved FQ. 3 - polled name. 4 - IP address.
pollUsing	the method of polling when managed: 0 - poll using given address. 1 - use resolved name. 2 - use resolved name, fallback to given address.
destinationViewPath	viewPath to which to add, if managed.
viewPathHidden	indicates if the viewPath should be hidden due to permissions. If true, this viewPath will be ignored when editing.
probeBitSet	a bitflag for probes to run: 0 - All. Will override the below flags. 1 - Host detection (ping) 2 - SNMP 3 - WinRM 4 - SSH 5 - HTTP (not in use) 6 - HTTPS (not in use) 7 - DataDomain 8 - iDrac SNMP 9 - HP iLO SSH 10 - iDrac SNMP 11 - naviseccli 12 - naviseccli SSH 13 - NetApp SSH 14 - Nimble 15 - uemcli 16 - VNX Control SSH 17 - Linux (Collection Engine) 18 - WinRM (Collection Engine)
attributes	custom attributes: tcp_ports udp_ports snmp.ports snmp.excluded_sysoids winrm.ports ssh.ports
lastFinished	the time a discovery finished.
nextRun	the time a discovery is next scheduled to run.
lastRunStatus	the status of the last run: 0 or -1 - never ran. 1 - in progress. 2 - complete. 3 - stopped.
credentialStatus	not used.
accessMethods	access method used, choosing from the following: Host Detection WinRM SSH SNMP
lastRan	the time a discovery last ran.
status	current status of this discovery profile: 0 - never ran. 1 - in progress. 2 - complete. 3 - stopped.
percentage	current progress percentage of the discovery, if running.

Examples:

INPUT
curl -u admin:admin https://localhost/api/autodiscoveryProfiles/5?media=json

OUTPUT
{
"id" : 5,
   "name" : "default",
   "description" : "migrated from old discovery: default.cfg",
   "zoneId" : 0,
   "includedAddresses" : "10.55.0-255.0-255",
   "excludedAddresses" : "",
   "flags" : 6,
   "publicServicesBitSet" : 0,
   "credentials" : null,
   "scheduleBitSet" : 1
   "scheduleHours" : 7,
   "autoManagementLevel" : 1,
   "displayNameUsing" : 3,
   "pollUsing" : 1,
   "destinationViewPath" : null,
   "viewPathHidden" : false,
   "probeBitSet" : 6,
   "attributes" : {
   "snmp.excluded_sysoids" : "1.3.6.1.4.1.311.1.1.3.1.2,1.3.6.1.4.1.2.3.1.2.1.1.3,1.3.6.1.4.1.8072.3.2.10,1.3.6.1.4.1.8072.3.2.3,1.3.6.1.4.1.311.1.1.3.1.1,1.3.6.1.4.1.311.1.1.3.1.3,1.3.6.1.4.1.42.2.1.1",
   "snmp.ports" : "161",
   "ssh.ports" : "22",
   "tcp_ports" : "21, 23, 25",
   "winrm.ports" : "5985, 5986"
   },
   "lastFinished" : 1617295096000,
   "nextRun" : 1618207200000,
   "lastRunStatus" : -1,
   "credentalStatus" : null,
   "accessMethods" : [ "Host Detection", "SNMP" ],
   "lastRan" : 1617295095000,
   "status" : 3,
   "percentage" : 0
}

INPUT
curl -u admin:admin https://localhost/api/autodiscoveryProfiles/2?media=xml

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:autoDiscProfile autoManagementLevel="1" description="10.44.XX.XX" destinationViewPath="My Network/local/10.44.XX.XX" displayNameUsing="5" excludedAddresses="" flags="41" id="2" includedAddresses="10.44.0-255.0-255" lastFinished="1662565889000" lastRan="1662565869000" lastRunStatus="-1" name="10.44.XX.XX" percentage="0" pollUsing="2" probeBitSet="30" publicServicesBitSet="0" scheduleBitSet="0" scheduleHours="0" status="3" viewPathHidden="false" zoneId="0" xmlns:ns5="http://www.entuity.com/webrpc" xmlns:ns2="http://www.entuity.com/schemas/webUI" xmlns:ns4="http://www.entuity.com/schemas/eventengine" xmlns:ns3="http://www.entuity.com/schemas/flow">
  <accessMethods>
    <accessMethod>Host Detection</accessMethod>
    <accessMethod>SNMP</accessMethod>
    <accessMethod>WinRM</accessMethod>
    <accessMethod>SSH</accessMethod>
  </accessMethods>
  <attributes>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">https.ports>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">443>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">snmp.excluded_sysoids>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1.3.6.1.4.1.311.1.1.3.1.2, 1.3.6.1.4.1.2.3.1.2.1.1.3, 1.3.6.1.4.1.8072.3.2.10, 1.3.6.1.4.1.8072.3.2.3, 1.3.6.1.4.1.311.1.1.3.1.1, 1.3.6.1.4.1.311.1.1.3.1.3, 1.3.6.1.4.1.42.2.1.1</value>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">collectors>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">oswinrm:oslinuxssh:ossolarisssh:osaixssh:ciscoucscimcsnmp:idracsnmp:dellidracssh:hpinsightsnmp:hpilossh:openmanagesnmp:supermicrorest:datadomainsnmp:datadomain:naviseccli:vnxcontrolssh:uemcli:dellequallogicsnmp:dellisilonrest:dellisilonssh:netappsnmp:netappssh:nimble:purestoragerest>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ssh.ports>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">22>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">restapi.ports>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">80>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">http.ports>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">80>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">snmp.ports>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">161>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">wirnm.ports>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">5985, 5986</value>
    </entries>
    <entries>
      <key xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">tcp_ports>
      <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">21, 23, 25</value>
    </entries>
  </attributes>
  <credentials>
    <credential>1</credential>
    <credential>2</credential>
    <credential>3</credential>
    <credential>4</credential>
    <credential>5</credential>
    <credential>6</credential>
    <credential>8</credential>
    <credential>9</credential>
    <credential>10</credential>
    <credential>11</credential>
    <credential>12</credential>
  </credentials>
</ns2:autoDiscProfile>

PUT Method detail

Modifies the chosen profile with given settings. The name cannot be modified.

Request:

Name	Description
id	ID number for the discovery profile.
name	user-specified name of the discovery profile.
description	user-specified description of the discovery profile.
zoneID	zone ID.
includedAddresses	addresses to scan. Comma-separated IP addresses or hostnames.
excludedAddresses	addresses to exclude. Comma-separated IP addresses or hostnames.
flags	a bitflag for flags: 0 - manage discovered devices after discovery finishes. 1 - allow duplicate IPs. 2 - use all credentials. If this is specified, the 'Credentials' field is ignored. 3 - manage associated devices after discovery. 5 - use management IP.
credentials	list of credential IDs to try.
scheduleBitSet	a bitflag for the days on which the schedule should be run. If 0, it does not run. 0: Monday to 6: Sunday.
scheduleHours	hour in which the schedule should be run in 24-hour time.
autoManagementLevel	the level of device management, if automanage is on: 1 - full. 2 - full, management interface only. 3 - full, no interfaces. 4 - basic. 5 - basic, ping only. 6 - web. 7 - none. 8 - CLI (not used).
displayNameUsing	the name to be used in management: 0 - system. 1 - resolved. 2 - resolved FQ. 3 - polled name. 4 - IP address.
pollUsing	the method of polling when managed: 0 - poll using given address. 1 - use resolved name. 2 - use resolved name, fallback to given address.
destinationViewPath	viewPath to which to add, if managed.
viewPathHidden	indicates if the viewPath should be hidden due to permissions. If true, this viewPath will be ignored when editing.
probeBitSet	a bitflag for probes to run.
attributes	custom attributes: tcp_ports udp_ports snmp.ports snmp.excluded_sysoids winrm.ports ssh.ports
lastFinished	the time a discovery finished.
nextRun	the time a discovery is next scheduled to run.
lastRunStatus	the status of the last run: 0 or -1 - never ran. 1 - in progress. 2 - complete. 3 - stopped.
credentialStatus	not used.
accessMethods	not used.
lastRan	the time a discovery last ran.
status	current status of this discovery profile: 0 - never ran. 1 - in progress. 2 - complete. 3 - stopped.
percentage	current progress percentage of the discovery, if running.

Response:

Shows the settings of the added profile. Uses the parameters shown above.

Example:

Modifying managementLevel:

INPUT
curl -u admin:admin https://localhost/api/autodiscoveryProfiles/5?media=json

OUTPUT
{
  "id" : "5",
  "name" : "default",
  "description" : "migrated from old discovery: default.cfg",
  "zoneId" : 0
  "includedAddresses" : "10.55.0-255.0-255",
  "excludedAddresses" : "",
  "flags" : 6,
  "publicServicesBitSet" : 0,
  "credentials" : null,
  "scheduleBitSet" : 1
  "scheduleHours" : 7,
  "autoManagementLevel" : 5,
  "displayNameUsing" : 3,
  "pollUsing" : 1,
  "destinationViewPath" : null,
  "viewPathHidden" : false, 
  "probeBitSet" : 6,
  "attributes" : {
  "snmp.excluded_sysoids" : "1.3.6.1.4.1.311.1.1.3.1.2,1.3.6.1.4.1.2.3.1.2.1.1.3,1.3.6.1.4.1.8072.3.2.10,1.3.6.1.4.1.8072.3.2.3,1.3.6.1.4.1.311.1.1.3.1.1,1.3.6.1.4.1.311.1.1.3.1.3,1.3.6.1.4.1.42.2.1.1",
  "snmp.ports" : "161",
  "ssh.ports" : "22",
  "tcp_ports" : "21, 23, 25",
  "winrm.ports" : "5985, 5986"
  },
  "lastFinished" : 1617295096000,
  "nextRun" : 1618207200000,
  "lastRunStatus" : -1,
  "credentalStatus" : null,
  "accessMethods" : [ "Host Detection", "SNMP" ],
  "lastRan" : 1617295095000,
  "status" : 3,
  "percentage" : 0
}

DELETE Method detail

Removes the given profile.

Example:

Returns an OK code if successful.

Articles in this section

Auto Discovery Profile - RESTful API

Summary:

URL:

Methods summary

GET Method detail

PUT Method detail

DELETE Method detail

Comments

Articles in this section

Summary:

URL:

Methods summary

GET Method detail

PUT Method detail

DELETE Method detail

Related articles