DiscoveryAPI- Scoped

The DiscoveryAPI class provides methods that launch a quick discovery of a single IPv4 address and return summaries of previously launched discovery statuses for a single configuration item (CI) or for all scanned CIs.

This class runs is in the sn_discovery namespace.

Parent Topic:Server API reference

DiscoveryAPI - discoverIpAddress(String ipAddress, String application, String source)

Discovers a specified IPv4 address.

A MID Server is selected automatically, based on the IP address provided or the application specified.

var sysid = sn_discovery.DiscoveryAPI.discoverIpAddress("11.23.125.39");

DiscoveryAPI - reportCiIpAddressStatus(Object ipAddress, Object discoveryStatusSysId)

Used to return a summary of a configuration item's Discovery status given the specific status sys_id and IPv4 address.

The following exceptions can be thrown:

• DiscoveryStatusNotFoundException: Displays this message: Discovery Status with sys id '<invalid value>' does not exist
• DiscoveryDeviceHistoryNotFoundException: Device History with Discovery Status sys id '<invalid value>' and ipAddress '<invalid value>' does not exist
• IllegalArgumentException (invalid input arguments): This argument exception prevents input values from being null.
  • Discovery Status sys id can not be null
  • ipAddress can not be null
• IllegalArgumentException (values stored in database): This argument exception prevents erroneous data from being returned to the caller in the case of bad attribute values.
  • Discovery Status 'state' property can not be null
  • Device history 'source' property can not be null
  • Device history 'issues' property is not an integer: <invalid value>
  • Device history 'issues' property can not be less than 0: <invalid value>

var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);

DiscoveryAPI - reportCiStatus(Object discoveryStatusSysId)

Used to return a summary of a CI Discovery status given a specific Discovery Status sys_id.

The following exceptions can be thrown:

• DiscoveryStatusNotFoundException: Discovery Status with sys id '<invalid value>' does not exist
• DiscoveryDeviceHistoryNotFoundException: Device History with Discovery Status sys id '<invalid value>' and ipAddress '<invalid value>' does not exist
• IllegalArgumentException (invalid input arguments): This argument exception prevents input values from being null.
  • Discovery Status sys id can not be null
  • ipAddress can not be null
• IllegalArgumentException (values stored in database): This argument exception imposes post conditions on database access values.
  • Discovery Status 'state' property can not be null
  • Device history 'source' property can not be null
  • Device history 'issues' property is not an integer: <invalid value>
  • Device history 'issues' property can not be less than 0: <invalid value>

var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
for(var idx=0; idx < ipResultObjArray.length; idx++) {    
var ipResultObj = ipResultObjArray[idx];