REST Resources

/api/space/device-management/device-discovery-rules/{id}

The following operations are supported on this resource:

  • GET - This API will return individual discovery rule
  • PUT - update DiscoveryDeviceTargetEntity
  • PATCH - Partial updates to a devicediscoveryrule
GET /device-discovery-rules/{id}Version 6

This API will return individual discovery rule.

Sample Usage

GET /device-discovery-rules/{id}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPathID Y
  • Sample Output XML:
    <device-discovery-rule
         href="/api/space/device-management/device-discovery-rules/{id}" uri="/api/space/device-management/device-discovery-rules/{id}">
         <id>Integer</id>
         <discovery-profile-name>String</discovery-profile-name>
         <target-details>String</target-details>
         <use-nat>Boolean</use-nat>
         <use-ping>Boolean</use-ping>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <discovery-job-details href="/api/space/job-management/jobs/{id}" uri="/api/space/device-management/device-discovery-rules/{id}">
               <id>Integer</id>
               <name>String</name>
               <scheduled-start-time-string>String</scheduled-start-time-string>
               <schedule-string>String</schedule-string>
               <supports-recurrence>Boolean</supports-recurrence>
         </discovery-job-details>
         <discovery-type>IMPORT_BY_CSV</discovery-type>
         <device-targets>
               <device-target>
                   <id>Integer</id>
                   <ip-address>String</ip-address>
                   <host-name>String</host-name>
                   <base-ip>String</base-ip>
                   <subnet-mask>String</subnet-mask>
                   <lower-ip>String</lower-ip>
                   <upper-ip>String</upper-ip>
                   <tags>
                         <tag>String</tag>
                   </tags>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <id>Integer</id>
                             <username>String</username>
                             <password>String</password>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <pass-phrase>String</pass-phrase>
                             <private-key>String</private-key>
                         </device-ssh-credential>
                   </device-ssh-credentials>
                   <device-fingerprints total="Integer">
                         <device-fingerprint>
                             <host-name>String</host-name>
                             <id>Integer</id>
                             <fingerprint>String</fingerprint>
                         </device-fingerprint>
                   </device-fingerprints>
               </device-target>
         </device-targets>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <device-snmp-details>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <authentication-password>String</authentication-password>
               <privacy-type>AES128</privacy-type>
               <id>Integer</id>
               <privacy-password>String</privacy-password>
         </device-snmp-details>
         <domain-id>Integer</domain-id>
         <domain-name>String</domain-name>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
         <is-run-now>Boolean</is-run-now>
    </device-discovery-rule>

  • Sample Output JSON:
    {
       "device-discovery-rule" : {
         "@href" : "/api/space/device-management/device-discovery-rules/{id}" ,
         "@uri" : "/api/space/device-management/device-discovery-rules/{id}" ,
         "id" : "Integer" ,
         "discovery-profile-name" : "String" ,
         "target-details" : "String" ,
         "use-ping" : "Boolean" ,
         "use-snmp" : "Boolean" ,
         "use-nat" : "Boolean" ,
         "discovery-type" : "IMPORT_BY_CSV" ,
         "device-targets" : {
           "device-target" : {
             "id" : "Integer" ,
             "ip-address" : "String" ,
             "host-name" : "String" ,
             "base-ip" : "String" ,
             "subnet-mask" : "String" ,
             "lower-ip" : "String" ,
             "upper-ip" : "String" ,
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "id" : "Integer" ,
                 "username" : "String" ,
                 "password" : "String" ,
                 "keybased" : "Boolean"
               }
             } ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "id" : "Integer" ,
                 "fingerprint" : "String"
               }
             }
           }
         } ,
         "device-snmp-version" : "NOT_APPLICABLE" ,
         "device-snmp-details" : {
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "authentication-password" : "String" ,
           "privacy-type" : "AES128" ,
           "id" : "Integer" ,
           "privacy-password" : "String"
         } ,
         "domain-id" : "Integer" ,
         "domain-name" : "String" ,
         "is-run-now" : "Boolean"
       }
    }

  • Access Control

    The following capabilities are required to access this API: DiscoverDevices, ReadDeviceDiscoveryProfiles

    PUT /device-discovery-rules/{id}Version 6

    update DiscoveryDeviceTargetEntity.

    Sample Usage

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

    PUT /device-discovery-rules/{id}?queue=<queue>&schedule=<schedule>


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


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathID Y
      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:
    <device-discovery-rule>
         <discovery-profile-name>String</discovery-profile-name>
         <target-details>String</target-details>
         <use-nat>Boolean</use-nat>
         <use-ping>Boolean</use-ping>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <discovery-type>IMPORT_BY_CSV</discovery-type>
         <device-targets>
               <device-target>
                   <ip-address>String</ip-address>
                   <host-name>String</host-name>
                   <base-ip>String</base-ip>
                   <subnet-mask>String</subnet-mask>
                   <lower-ip>String</lower-ip>
                   <upper-ip>String</upper-ip>
                   <tags>
                         <tag>String</tag>
                   </tags>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <username>String</username>
                             <password>String</password>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <pass-phrase>String</pass-phrase>
                             <private-key>String</private-key>
                         </device-ssh-credential>
                   </device-ssh-credentials>
                   <device-fingerprints total="Integer">
                         <device-fingerprint>
                             <host-name>String</host-name>
                             <fingerprint>String</fingerprint>
                         </device-fingerprint>
                   </device-fingerprints>
               </device-target>
         </device-targets>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <device-snmp-details>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <authentication-password>String</authentication-password>
               <privacy-type>AES128</privacy-type>
               <id>Integer</id>
               <privacy-password>String</privacy-password>
         </device-snmp-details>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
    </device-discovery-rule>

  • Sample Input JSON:
    {
       "device-discovery-rule" : {
         "discovery-profile-name" : "String" ,
         "target-details" : "String" ,
         "use-ping" : "Boolean" ,
         "use-snmp" : "Boolean" ,
         "use-nat" : "Boolean" ,<br/
         "discovery-type" : "IMPORT_BY_CSV" ,
         "device-targets" : {
           "device-target" : {
             "ip-address" : "String" ,
             "host-name" : "String" ,
             "base-ip" : "String" ,
             "subnet-mask" : "String" ,
             "lower-ip" : "String" ,
             "upper-ip" : "String" ,
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "username" : "String" ,
                 "password" : "String" ,
                 "pass-phrase" : "String" ,
                 "private-key" : "String" ,
                 "keybased" : "Boolean"
               }
             } ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "fingerprint" : "String"
               }
             }
           }
         } ,
         "device-snmp-version" : "NOT_APPLICABLE" ,
         "device-snmp-details" : {
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "authentication-password" : "String" ,
           "privacy-type" : "AES128" ,
           "id" : "Integer" ,
           "privacy-password" : "String"
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: DiscoverDevices, ModifyDeviceDiscoveryProfile

    PATCH /device-discovery-rules/{id}Version 6

    Partial updates to a devicediscoveryrule.

    Sample Usage

    PATCH /device-discovery-rules/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathID Y
  • Sample Patch XML:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <diff>
       <!--What you see below are just samples of patch operations that may be performed on this DTO.-->
       <!--For more information about patch document format please look at http://http://www.rfc-editor.org/rfc/rfc5261.txt-->
       <replace sel="device-discovery-rule/discovery-profile-name">
           <discovery-profile-name>String</discovery-profile-name>
       </replace>
       <replace sel="device-discovery-rule/target-details">
           <target-details>String</target-details>
       </replace>
       <replace sel="device-discovery-rule/use-nat">
           <use-nat>Boolean</use-nat>
       </replace>
       <replace sel="device-discovery-rule/use-ping">
           <use-ping>Boolean</use-ping>
       </replace>
       <replace sel="device-discovery-rule/sharable">
           <sharable>Boolean</sharable>
       </replace>
       <replace sel="device-discovery-rule/use-snmp">
           <use-snmp>Boolean</use-snmp>
       </replace>
       <replace sel="device-discovery-rule/discovery-type">
           <discovery-type>IMPORT_BY_CSV</discovery-type>
       </replace>
       <replace sel="device-discovery-rule/device-targets">
           <device-targets>
             <device-target>
                 <device-ssh-credentials>
                   <device-ssh-credential>
                       <id>Integer</id>
                       <username>String</username>
                       <password>String</password>
                   </device-ssh-credential>
                 </device-ssh-credentials>
             </device-target>
           </device-targets>
       </replace>
       <replace sel="device-discovery-rule/device-snmp-version">
           <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
       </replace>
       <replace sel="device-discovery-rule/device-snmp-details">
           <device-snmp-details>
             <snmpv1v2c-community>String</snmpv1v2c-community>
             <user-name>String</user-name>
             <snmp-auth-type>MD5</snmp-auth-type>
             <authentication-password>String</authentication-password>
             <privacy-type>AES128</privacy-type>
             <privacy-password>String</privacy-password>
           </device-snmp-details>
       </replace>
       <replace sel="device-discovery-rule/discovery-action-additional-params">
           <discovery-action-additional-params>
             <discovery-action-additional-param>
                 <parameter>String</parameter>
                 <parameter-value>String</parameter-value>
             </discovery-action-additional-param>
           </discovery-action-additional-params>
       </replace>
    </diff>

  • Sample Output XML:
    <device-discovery-rule
         href="/api/space/device-management/device-discovery-rules/{id}" uri="/api/space/device-management/device-discovery-rules/{id}">
         <id>Integer</id>
         <discovery-profile-name>String</discovery-profile-name>
         <target-details>String</target-details>
         <use-nat>Boolean</use-nat>
         <use-ping>Boolean</use-ping>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <discovery-type>IMPORT_BY_CSV</discovery-type>
         <device-targets>
               <device-target>
                   <id>Integer</id>
                   <ip-address>String</ip-address>
                   <host-name>String</host-name>
                   <base-ip>String</base-ip>
                   <subnet-mask>String</subnet-mask>
                   <lower-ip>String</lower-ip>
                   <upper-ip>String</upper-ip>
                   <tags>
                         <tag>String</tag>
                   </tags>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <id>Integer</id>
                             <username>String</username>
                             <password>String</password>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <pass-phrase>String</pass-phrase>
                             <private-key>String</private-key>
                         </device-ssh-credential>
                   </device-ssh-credentials>
                   <device-fingerprints total="Integer">
                         <device-fingerprint>
                             <host-name>String</host-name>
                             <id>Integer</id>
                             <fingerprint>String</fingerprint>
                         </device-fingerprint>
                   </device-fingerprints>
               </device-target>
         </device-targets>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <device-snmp-details>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <authentication-password>String</authentication-password>
               <privacy-type>AES128</privacy-type>
               <id>Integer</id>
               <privacy-password>String</privacy-password>
         </device-snmp-details>
         <domain-id>Integer</domain-id>
         <domain-name>String</domain-name>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
    </device-discovery-rule>

  • Sample Output JSON:
    {
       "device-discovery-rule" : {
         "@href" : "/api/space/device-management/device-discovery-rules/{id}" ,
         "@uri" : "/api/space/device-management/device-discovery-rules/{id}" ,
         "id" : "Integer" ,
         "discovery-profile-name" : "String" ,
         "target-details" : "String" ,
         "use-ping" : "Boolean" ,
         "use-snmp" : "Boolean" ,
         "use-nat" : "Boolean" ,<br/
         "discovery-type" : "IMPORT_BY_CSV" ,
         "device-targets" : {
           "device-target" : {
             "id" : "Integer" ,
             "ip-address" : "String" ,
             "host-name" : "String" ,
             "base-ip" : "String" ,
             "subnet-mask" : "String" ,
             "lower-ip" : "String" ,
             "upper-ip" : "String" ,
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "id" : "Integer" ,
                 "username" : "String" ,
                 "password" : "String" ,
                 "keybased" : "Boolean"
               }
             } ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "id" : "Integer" ,
                 "fingerprint" : "String"
               }
             }
           }
         } ,
         "device-snmp-version" : "NOT_APPLICABLE" ,
         "device-snmp-details" : {
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "authentication-password" : "String" ,
           "privacy-type" : "AES128" ,
           "id" : "Integer" ,
           "privacy-password" : "String"
         } ,
         "domain-id" : "Integer" ,
         "domain-name" : "String"
       }
    }