REST Resources

/api/space/device-management/discover-devices

The following operations are supported on this resource:

  • POST - Discover devices by providing the rules
  • POST - Discover devices by providing rules for discovery
  • POST - This API will trigger discovery process on discovery rule
POST /discover-devices
(Deprecated) 		Version 1

This API is used to discover devices.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /discover-devices?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:

    <systemDiscoveryRule>
    nbsp; <ruleName>TestRuleName12121</ruleName>
        <hostNameDiscoveryTarget>
          <hostName>DWUS2B038</hostName>
        </hostNameDiscoveryTarget>
      <usePing>true</usePing>
      <useSnmp>true</useSnmp>
      <snmpV1Setting>
        <communityName>testCommunityName</communityName>
      </snmpV1Setting>
      <manageDiscoveredSystemsFlag>true</manageDiscoveredSystemsFlag>
      <sshCredential>
        <userName>mbharti</userName>
        <password>password12</password>
      </sshCredential>
      <tagNewlyManagedDiscoveredSystemsFlag>
        true
      </tagNewlyManagedDiscoveredSystemsFlag>
      <tagForNewlyManagedDiscoveredSystems>
        true
      </tagForNewlyManagedDiscoveredSystems>
    </systemDiscoveryRule>

  • Sample Output XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <task>
        <id>720908</id>
      </task>

  • Sample Input JSON:

    {
      "systemDiscoveryRule":{
         "ipAddressDiscoveryTarget": { "exclude":false,"ipAddress":"192.168.1.1" },
         "usePing":true,
         "useSnmp":true,
         "snmpV2CSetting": { "communityName":"public" },
         "manageDiscoveredSystemsFlag":true,
         "sshCredential": { "userName":"test","password":"test" },
         "tagNewlyManagedDiscoveredSystemsFlag":false
      }
    }

  • Sample Output JSON:
    {"task":{"id":720908}}

    • Access Control

    The following capabilities are required to access this API: DiscoverDevices

    POST /discover-devices
    (Deprecated)     		Version 2

    This API is used to discover devices. This API does not need a discovery rule name.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /discover-devices?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
      schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:

    Sample input using an IP address
    <discover-devices>
         <ipAddressDiscoveryTarget>
                <ipAddress>192.168.1.2</ipAddress>
             </ipAddressDiscoveryTarget>
      <manageDiscoveredSystemsFlag>true</manageDiscoveredSystemsFlag>
         <usePing>true</usePing>
    </discover-devices>

    Sample input using an IP address range
    <discover-devices>
         <ipRangeDiscoveryTarget>
                 <upperIp>192.168.1.4</upperIp>
                 <lowerIp>192.168.1.1</lowerIp>
         </ipRangeDiscoveryTarget>
      <manageDiscoveredSystemsFlag>true</manageDiscoveredSystemsFlag>
         <usePing>true</usePing>
    </discover-devices>

    Sample input using a host name
    <discover-devices>
        <hostNameDiscoveryTarget>
          <hostName>DWUS2B038</hostName>
        </hostNameDiscoveryTarget>
      <usePing>true</usePing>
      <useSnmp>true</useSnmp>
      <snmpV1Setting>
        <communityName>testCommunityName</communityName>
      </snmpV1Setting>
      <manageDiscoveredSystemsFlag>true</manageDiscoveredSystemsFlag>
      <sshCredential>
        <userName>test</userName>
        <password>password12</password>
      </sshCredential>
      <device-fingerprints>
        <device-fingerprint>
          <host>DWUS2B038</host>
          <fingerprint>43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8</fingerprint>
        </device-fingerprint>
      </device-fingerprints>
    </discover-devices>

    Sample input using snmpV3Setting
    <discover-devices>
      <ipAddressDiscoveryTarget>
        <exclude>false</exclude>
        <ipAddress>192.168.21.9</ipAddress>
      </ipAddressDiscoveryTarget>
      <usePing>false</usePing>
      <useSnmp>true</useSnmp>
      <snmpV3Setting>
        <userName>test</userName>
        <authenticationType>MD5</authenticationType>
        <privacyType>AES128</privacyType>
        <authenticationPassword>password12</authenticationPassword>
        <privacyPassword>password12</privacyPassword>
      </snmpV3Setting>
      <manageDiscoveredSystemsFlag>true</manageDiscoveredSystemsFlag>
      <sshCredential>
        <userName>test</userName>
        <password>password12</password>
      </sshCredential>
    </discover-devices>

  • Sample Output XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <task>
        <id>720908</id>
      </task>

  • Sample Input JSON:

    Sample input using an IP address
    {
      "discover-devices":{
         "ipAddressDiscoveryTarget": { "exclude":false, "ipAddress":"192.168.1.1" },
         "usePing":true,
         "useSnmp":true,
         "snmpV2CSetting": { "communityName":"public" },
         "manageDiscoveredSystemsFlag":true,
         "sshCredential": { "userName":"test", "password":"password12" }
      }
    }
    Sample input using an IP address range
    {
       "discover-devices": {
         "ipRangeDiscoveryTarget": {
             "upperIp": "192.168.1.4",
             "lowerIp": "192.168.1.1"
         },
         "usePing": "true"
       }
    }

    Sample Input using snmpV3Setting
    {
      "discover-devices":{
         "ipAddressDiscoveryTarget": { "exclude":false, "ipAddress":"192.168.1.1" },
         "usePing":false,
         "useSnmp":true,
         "snmpV3Setting":{
            "userName":"test","authenticationType":"MD5", "privacyType":"AES128",
            "authenticationPassword": "password12", "privacyPassword":"password12"
         },
         "manageDiscoveredSystemsFlag":true,
         "sshCredential": { "userName":"test",
    "password":"password12"},
       }
    }

  • Sample Output JSON:

    {
         "task": {
         "href": "/api/space/job-management/jobs/163889",
         "id": "163889"
         }
    }

    • Access Control

    The following capabilities are required to access this API: DiscoverDevices

    POST /discover-devicesVersion 6

    This API will trigger discovery process on discovery rule.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /discover-devices?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
      schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
    <discover-devices-request>
         <device-discovery-rules>
               <device-discovery-rule href="/api/space/device-management/device-discovery-rules/295601"/>
         </device-discovery-rules>
    </discover-devices-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/1081364">
      <id>1081364</id>
    </task>

  • Sample Input JSON:
    {
       "discover-devices-request" : {
         "device-discovery-rules" : {
           "device-discovery-rule" : {
             "@href" : "/api/space/device-management/device-discovery-rules/295601"
           }
         }
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href":"/api/space/job-management/jobs/1081364",
        "id":1081364
      }
    }

    • Access Control

    The following capabilities are required to access this API: RunNowDiscoveryProfile