Articles in this section

See more

Auto Discovery Profiles - RESTful API

Avatar
Stuart Hill
  • Updated
Follow

Summary:

View and create Auto Discovery profiles. Applicable to Enuity v19.0 upwards.

URL:

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

 

Auto Discovery

 

Methods summary

GET Method details

POST Method details

 

 

Methods summary

  • GET Method - lists available Auto Discovery profiles (XML, JSON).
  • POST Method - creates a new Auto Discovery profile.

 

 

GET Method details

Lists all Auto Discovery profiles.

Response:

Name Description
items a list of profiles on this server.
count number of profiles.

Example:

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

OUTPUT
{
   "settings" : [ {
   "id" : 1,
   "name" : "Default",
   "description" : "Migrated from old discovery: Default.cfg",
   "status" : 0,
   "percentage" : 0
   }, {
   "id" : 2,
   "name" : "Custom Discovery",
   "description" : "",
   "status" : 2,
   "percentage" : 100
   }, {
   "id" : 3,
   "name" : "checking test",
   "description" : "",
   "status" : 2,
   "percentage" : 100
   } ]
}

 

 

 

POST Method details

Create a new profile with given settings. If some settings are not given, then they wil be filled with default values. The "profile" value must be unique.

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 - managed 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:

Displays the list of available profiles, updated with the new profile.

Example:

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

OUTPUT
{
  "id" : 2,
  "name" : "Checking poseidon",
  "description" : "",
  "zoneId" : 0,
  "includedAddresses" : "poseidon",
  "excludedAddresses" : "",
  "flags" : 0,
  "publicServicesBitSet" : 0,
  "credentials" : [ 7 ],
  "scheduleBitSet" : 0,
  "scheduleHours" : 0,
  "autoManagementLevel" : 1,
  "displayNameUsing" : 5, 
  "pollUsing" : 2,
  "destinationViewPath" : null,
  "viewPathHidden" : null,
  "probeBitSet" : 30,
  "attributes" : {
  "collectors" : "oswinrm:oslinuxssh",
  "http.ports" : "80",
  "https.ports" : "443",
  "snmp.excluded_sysoids" : "1.3.6.1.4.1.311.1.1.3.1.2,\n1.3.6.1.4.1.2.3.1.2.1.1.3,\n1.3.6.1.4.1.8072.3.2.10,\n1.3.6.1.4.1.8072.3.2.3,\n1.3.6.1.4.1.311.1.1.3.1.1,\n1.3.6.1.4.1.311.1.1.3.1.3,\n1.3.6.1.4.1.42.2.1.1",
  "snmp.ports" : "161",
  "ssh.ports" : "22",
  "tcp_ports" : "21, 23, 25",
  "wirnm.ports" : "5985, 5986"
  },
  "lastFinished" : null,
  "nextRun" : null,
  "lastRunStatus" : null,
  "credentialStatus" : null,
  "accessMethods" : [ "Host Detection", "SNMP", "WinRM", "SSH" ],
  "lastRan" : null,
  "status" : null,
  "percentage" : null
  testuser@testlaptop:/mnt/c/Users/testuser curl -sku admin:admin'https://localhost/api/autodiscoveryProfiles'
  {
  "settings" : [ {
  "id" : 1,
  "name" : "Default",
  "description" : "Migrated from old discovery: Default.cfg",
  "status" : 2,
  "percentage" : 100
  }, {
  "id" : 2,
  "name" : "Checking poseidon",
  "description" : "",
  "status" : 0,
  "percentage" : 0
  } ]
}

  

Related articles

Comments

0 comments

Please sign in to leave a comment.