REST Resources

/api/space/device-management/device-discovery-rules

The following operations are supported on this resource:

  • GET - This API will return all available discovery rules
  • POST - This method is used to add the device discovery target with IP
  • POST - This method is used to add the device discovery targets with Host-name
  • POST - This method is used to add the device discovery targets with IP Range
  • POST - This method is used to add the device discovery targets with IP Sub-net
  • POST - This method is used to add the device discovery targets from CSV file
  • POST - This method is used to add the device discovery targets with IP Address and Hostname
  • PATCH - Multiple adds/deletes to the devicediscoveryrules collection
GET /device-discovery-rulesVersion 6

This API will return all available discovery rules.

Sample Usage

GET /device-discovery-rules


  • Sample Output XML:
    <device-discovery-rules total="Integer" uri="/api/space/device-management/device-discovery-rules">
         <device-discovery-rule
               href="/api/space/device-management/device-discovery-rules/{id}" uri="/api/space/device-management/device-discovery-rules">
               <id>Integer</id>
               <discovery-profile-name>String</discovery-profile-name>
               <discovery-type>IMPORT_BY_CSV</discovery-type>
               <sharable>Boolean</sharable>
               <profile-owner>String</profile-owner>
               <discovery-job-details
                   href="/api/space/job-management/jobs/{id}" uri="/api/space/device-management/device-discovery-rules">
                   <id>Integer</id>
                   <name>String</name>
                   <scheduled-start-time-string>String</scheduled-start-time-string>
                   <schedule-string>String</schedule-string>
               </discovery-job-details>
               <target-details>String</target-details>
               <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
               <device-targets total="Integer">
                   <device-target>
                         <id>Integer</id>
                         <device-ssh-credentials total="Integer">
                             <device-ssh-credential>
                                   <id>Integer</id>
                                   <username>String</username>
                                   <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-target>
               </device-targets>
               <domain-name>String</domain-name>
               <domain-id>Integer</domain-id>
         </device-discovery-rule>
    </device-discovery-rules>

  • Sample Output JSON:
    {
       "device-discovery-rules" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/device-management/device-discovery-rules" ,
         "device-discovery-rule" : {
           "@href" : "/api/space/device-management/device-discovery-rules/{id}" ,
           "@uri" : "/api/space/device-management/device-discovery-rules" ,
           "id" : "Integer" ,
           "discovery-profile-name" : "String" ,
           "discovery-type" : "IMPORT_BY_CSV" ,
           "discovery-job-details" : {
             "@href" : "/api/space/job-management/jobs/{id}" ,
             "@uri" : "/api/space/device-management/device-discovery-rules" ,
             "id" : "Integer" ,
             "name" : "String" ,
             "scheduled-start-time-string" : "String" ,
             "schedule-string" : "String"
           } ,
           "target-details" : "String" ,
           "device-snmp-version" : "NOT_APPLICABLE" ,
           "device-targets" : {
             "@total" : "Integer" ,
             "device-target" : {
               "id" : "Integer" ,
               "device-ssh-credentials" : {
                 "@total" : "Integer" ,
                 "device-ssh-credential" : {
                   "id" : "Integer" ,
                   "username" : "String" ,
                   "keybased" : "Boolean" ,
                   "credential-type" : "CREDENTIAL_BASED"
                 }
               }
             }
           } ,
           "domain-name" : "String" ,
           "domain-id" : "Integer"
         }
       }
    }

  • Access Control

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

    POST /device-discovery-rulesVersion 6

    This method is used to add the device discovery target with IP.

    Sample Usage

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

    POST /device-discovery-rules?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:
    <add-device-discovery-rule-by-ip-request>
         <discovery-profile-name>String</discovery-profile-name>
         <use-ping>Boolean</use-ping>
         <use-nat>Boolean</use-nat>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <device-targets>
               <device-target>
                   <ip-address>String</ip-address>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <username>String</username>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <password>String</password>
                             <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-details>
               <authentication-password>String</authentication-password>
               <privacy-password>String</privacy-password>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <privacy-type>AES128</privacy-type>
         </device-snmp-details>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
    </add-device-discovery-rule-by-ip-request>

  • Sample Input JSON:
    {
       "add-device-discovery-rule-by-ip-request" : {
         "discovery-profile-name" : "String" ,
         "use-ping" : "Boolean" ,
         "use-nat" : "Boolean" ,
         "use-snmp" : "Boolean" ,
           "sharable" : "Boolean" ,
         "device-targets" : {
           "device-target" : {
             "ip-address" : "String" ,
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "username" : "String" ,
                 "keybased" : "Boolean" ,
                 "credential-type" : "CREDENTIAL_BASED" ,
                 "password" : "String"
                 "pass-phrase" : "String" ,
                 "private-key" : "String" ,
               }
             } ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "fingerprint" : "String"
               }
             }
           }
         } ,
         "device-snmp-details" : {
           "authentication-password" : "String" ,
           "privacy-password" : "String" ,
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "privacy-type" : "AES128"
         } ,
         "device-snmp-version" : "NOT_APPLICABLE"
       }
    }

  • Access Control

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

    POST /device-discovery-rulesVersion 6

    This method is used to add the device discovery targets with Host-name.

    Sample Usage

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

    POST /device-discovery-rules?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:
    <add-device-discovery-rule-by-host-name-request>
         <discovery-profile-name>String</discovery-profile-name>
         <use-ping>Boolean</use-ping>
         <use-nat>Boolean</use-nat>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <device-targets>
               <device-target>
                   <host-name>String</host-name>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <username>String</username>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <password>String</password>
                             <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-details>
               <authentication-password>String</authentication-password>
               <privacy-password>String</privacy-password>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <privacy-type>AES128</privacy-type>
         </device-snmp-details>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
    </add-device-discovery-rule-by-host-name-request>

  • Sample Input JSON:
    {
       "add-device-discovery-rule-by-host-name-request" : {
         "discovery-profile-name" : "String" ,
         "use-ping" : "Boolean" ,
         "use-snmp" : "Boolean" ,
         "use-nat" : "Boolean" ,
           "sharable" : "Boolean" ,
         "device-targets" : {
           "device-target" : {
             "host-name" : "String" ,
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "username" : "String" ,
                 "keybased" : "Boolean" ,
                 "credential-type" : "CREDENTIAL_BASED" ,
                 "pass-phrase" : "String" ,
                 "private-key" : "String" ,
                 "password" : "String"
               }
             } ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "fingerprint" : "String"
               }
             }
           }
         } ,
         "device-snmp-details" : {
           "authentication-password" : "String" ,
           "privacy-password" : "String" ,
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "privacy-type" : "AES128"
         } ,
         "device-snmp-version" : "NOT_APPLICABLE"
       }
    }

  • Access Control

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

    POST /device-discovery-rulesVersion 6

    This method is used to add the device discovery targets with IP Range.

    Sample Usage

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

    POST /device-discovery-rules?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:
    <add-device-discovery-rule-by-ip-range-request>
         <discovery-profile-name>String</discovery-profile-name>
         <use-ping>Boolean</use-ping>
         <use-nat>Boolean</use-nat>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <device-targets>
               <device-target>
                   <lower-ip>String</lower-ip>
                   <upper-ip>String</upper-ip>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <username>String</username>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <password>String</password>
                             <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-details>
               <authentication-password>String</authentication-password>
               <privacy-password>String</privacy-password>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <privacy-type>AES128</privacy-type>
         </device-snmp-details>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
    </add-device-discovery-rule-by-ip-range-request>

  • Sample Input JSON:
    {
       "add-device-discovery-rule-by-ip-range-request" : {
         "discovery-profile-name" : "String" ,
         "use-ping" : "Boolean" ,
         "use-snmp" : "Boolean" ,
         "use-nat" : "Boolean" ,
           "sharable" : "Boolean" ,
         "device-targets" : {
           "device-target" : {
             "lower-ip" : "String" ,
             "upper-ip" : "String" ,
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "username" : "String" ,
                 "keybased" : "Boolean" ,
                 "password" : "String"
                 "credential-type" : "CREDENTIAL_BASED" ,
                 "pass-phrase" : "String" ,
                 "private-key" : "String" ,
               }
             } ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "fingerprint" : "String"
               }
             }
           }
         } ,
         "device-snmp-details" : {
           "authentication-password" : "String" ,
           "privacy-password" : "String" ,
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "privacy-type" : "AES128"
         } ,
         "device-snmp-version" : "NOT_APPLICABLE"
       }
    }

  • Access Control

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

    POST /device-discovery-rulesVersion 6

    This method is used to add the device discovery targets with IP Sub-net.

    Sample Usage

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

    POST /device-discovery-rules?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:
    <add-device-discovery-rule-by-ip-subnet-request>
         <discovery-profile-name>String</discovery-profile-name>
         <use-ping>Boolean</use-ping>
         <use-nat>Boolean</use-nat>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <device-targets>
               <device-target>
                   <base-ip>String</base-ip>
                   <subnet-mask>String</subnet-mask>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <username>String</username>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <password>String</password>
                             <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-details>
               <authentication-password>String</authentication-password>
               <privacy-password>String</privacy-password>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <privacy-type>AES128</privacy-type>
         </device-snmp-details>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
    </add-device-discovery-rule-by-ip-subnet-request>

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

  • Access Control

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

    POST /device-discovery-rulesVersion 6

    This method is used to add the device discovery targets from CSV file.

    Sample Usage

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

    POST /device-discovery-rules?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:
    <add-device-discovery-rule-by-csv-request>
         <discovery-profile-name>String</discovery-profile-name>
         <target-details>String</target-details>
         <use-ping>Boolean</use-ping>
         <use-nat>Boolean</use-nat>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <device-targets>
               <device-target>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <username>String</username>
                             <keybased>Boolean</keybased>
                             <password>String</password>
                         </device-ssh-credential>
                   </device-ssh-credentials>
                   <upper-ip>String</upper-ip>
                   <device-fingerprints total="Integer">
                         <device-fingerprint>
                             <host-name>String</host-name>
                             <fingerprint>String</fingerprint>
                         </device-fingerprint>
                   </device-fingerprints>
                   <lower-ip>String</lower-ip>
                   <host-name>String</host-name>
                   <subnet-mask>String</subnet-mask>
                   <base-ip>String</base-ip>
                   <tags>
                         <tag>String</tag>
                   </tags>
                   <ip-address>String</ip-address>
               </device-target>
         </device-targets>
         <device-snmp-details>
               <authentication-password>String</authentication-password>
               <privacy-password>String</privacy-password>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <privacy-type>AES128</privacy-type>
         </device-snmp-details>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <discovery-action-additional-params>
               <discovery-action-additional-param>
                   <parameter>String</parameter>
                   <parameter-value>String</parameter-value>
               </discovery-action-additional-param>
         </discovery-action-additional-params>
    </add-device-discovery-rule-by-csv-request>

  • Sample Input JSON:
    {
       "add-device-discovery-rule-by-csv-request" : {
         "discovery-profile-name" : "String" ,
         "target-details" : "String" ,
         "use-ping" : "Boolean" ,
         "use-snmp" : "Boolean" ,
           "sharable" : "Boolean" ,
         "use-nat" : "Boolean" ,
         "device-targets" : {
           "device-target" : {
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "username" : "String" ,
                 "keybased" : "Boolean" ,
                 "password" : "String"
               }
             } ,
             "upper-ip" : "String" ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "fingerprint" : "String"
               }
             } ,
             "lower-ip" : "String" ,
             "host-name" : "String" ,
             "subnet-mask" : "String" ,
             "base-ip" : "String" ,
             "ip-address" : "String" ,
               "tags" : {
                  "tag" : "String"
               }
           }
         } ,
         "device-snmp-details" : {
           "authentication-password" : "String" ,
           "privacy-password" : "String" ,
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "privacy-type" : "AES128"
         } ,
         "device-snmp-version" : "NOT_APPLICABLE"
       }
    }

  • Access Control

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

    POST /device-discovery-rulesVersion 6

    This method is used to add the device discovery targets with IP Address and Hostname.

    Sample Usage

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

    POST /device-discovery-rules?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:
    <add-device-discovery-rule-by-ip-hostname-request>
         <discovery-profile-name>String</discovery-profile-name>
         <use-ping>Boolean</use-ping>
         <use-nat>Boolean</use-nat>
         <sharable>Boolean</sharable>
         <use-snmp>Boolean</use-snmp>
         <device-targets>
               <device-target>
                   <base-ip>String</base-ip>
                   <subnet-mask>String</subnet-mask>
                   <ip-address>String</ip-address>
                   <host-name>String</host-name>
                   <device-ssh-credentials total="Integer">
                         <device-ssh-credential>
                             <username>String</username>
                             <keybased>Boolean</keybased>
                             <credential-type>CREDENTIAL_BASED</credential-type>
                             <password>String</password>
                             <pass-phrase>String</pass-phrase>
                             <private-key>String</private-key>
                         </device-ssh-credential>
                   </device-ssh-credentials>
                   <lower-ip>String</lower-ip>
                   <upper-ip>String</upper-ip>
                   <device-fingerprints total="Integer">
                         <device-fingerprint>
                             <fingerprint>String</fingerprint>
                             <host-name>String</host-name>
                         </device-fingerprint>
                   </device-fingerprints>
               </device-target>
         </device-targets>
         <device-snmp-version>NOT_APPLICABLE</device-snmp-version>
         <device-snmp-details>
               <authentication-password>String</authentication-password>
               <privacy-password>String</privacy-password>
               <snmpv1v2c-community>String</snmpv1v2c-community>
               <user-name>String</user-name>
               <snmp-auth-type>MD5</snmp-auth-type>
               <privacy-type>AES128</privacy-type>
         </device-snmp-details>
    </add-device-discovery-rule-by-ip-hostname-request>

  • Sample Input JSON:
    {
       "add-device-discovery-rule-by-ip-hostname-request" : {
         "discovery-profile-name" : "String" ,
         "use-ping" : "Boolean" ,
         "use-snmp" : "Boolean" ,
         "use-nat" : "Boolean" ,
         "sharable" : "Boolean" ,
         "device-targets" : {
           "device-target" : {
             "host-name" : "String" ,
             "device-ssh-credentials" : {
               "@total" : "Integer" ,
               "device-ssh-credential" : {
                 "username" : "String" ,
                 "keybased" : "Boolean" ,
                 "credential-type" : "CREDENTIAL_BASED" ,
                 "pass-phrase" : "String" ,
                 "private-key" : "String" ,
                 "password" : "String"
               }
             } ,
             "device-fingerprints" : {
               "@total" : "Integer" ,
               "device-fingerprint" : {
                 "host-name" : "String" ,
                 "fingerprint" : "String"
               }
             }
           }
         } ,
         "device-snmp-details" : {
           "authentication-password" : "String" ,
           "privacy-password" : "String" ,
           "snmpv1v2c-community" : "String" ,
           "user-name" : "String" ,
           "snmp-auth-type" : "MD5" ,
           "privacy-type" : "AES128"
         } ,
         "device-snmp-version" : "NOT_APPLICABLE"
       }
    }

  • Access Control

    The following capabilities are required to access this API: AddDeviceDiscoveryProfile, CloneDeviceDiscoveryProfile

    PATCH /device-discovery-rulesVersion 6

    Multiple adds/deletes to the devicediscoveryrules collection.

    Sample Usage

    PATCH /device-discovery-rules


    • Content-Type Headers:
      application/vnd.net.juniper.space.device-management.device-discovery-rules_patch+xml;version=6;charset=UTF-8

  • 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-->
       <add sel="device-discovery-rules">
           <device-discovery-rule>
             <discovery-profile-name>String</discovery-profile-name>
             <device-targets>
                 <device-target>
                   <id>Integer</id>
                 </device-target>
             </device-targets>
           </device-discovery-rule>
       </add>
       <!-- or -->
       <remove sel="device-discovery-rules/device-discovery-rule[@some attribute='some value']"/>
       <!-- or using element selection-->
       <remove sel="device-discovery-rules/device-discovery-rule[some element='some value']"/>
    </diff>