/api/space/device-management/unmanaged-device-management/unmanaged-devices

The following operation is supported on this resource:

  • POST - Add Unmanaged Device
POST /unmanaged-device-management/unmanaged-devicesVersion 7

Add Unmanaged Device.

Sample Usage

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

POST /unmanaged-device-management/unmanaged-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:
    <unmanaged-device-request>
         <devices>
               <device>
                   <ip-address>String</ip-address>
                   <hostname>String</hostname>
                   <username>String</username>
                   <password>String</password>
                   <vendor>String</vendor>
                   <domain-name>String</domain-name>
                   <loopback-name>String</loopback-name>
                   <loopback-address>String</loopback-address>
                   <snmp-version>String</snmp-version>
                   <snmp-v1-v2-community>String</snmp-v1-v2-community>
                   <community>String</community>
                   <snmp-v3-username>String</snmp-v3-username>
                   <snmp-v3-auth-type>String</snmp-v3-auth-type>
                   <snmp-v3-auth-password>String</snmp-v3-auth-password>
                   <snmp-v3-privacy-type>String</snmp-v3-privacy-type>
                   <snmp-v3-privacy-password>String</snmp-v3-privacy-password>
                   <unreachable>Boolean</unreachable>
                   <advanced-properties total="Integer">
                         <unmanaged-device-attr>
                             <value>String</value>
                             <key>String</key>
                         </unmanaged-device-attr>
                   </advanced-properties>
               </device>
         </devices>
    </unmanaged-device-request>

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

  • Sample Input JSON:
    {
       "unmanaged-device-request" : {
         "devices" : {
           "device" : {
             "ip-address" : "String" ,
             "hostname" : "String" ,
             "username" : "String" ,
             "password" : "String" ,
             "vendor" : "String" ,
             "domain-name" : "String" ,
             "loopback-name" : "String" ,
             "loopback-address" : "String" ,
             "snmp-version" : "String" ,
             "snmp-v1-v2-community" : "String" ,
             "community" : "String" ,
             "snmp-v3-username" : "String" ,
             "snmp-v3-auth-type" : "String" ,
             "snmp-v3-auth-password" : "String" ,
             "snmp-v3-privacy-type" : "String" ,
             "snmp-v3-privacy-password" : "String" ,
             "unreachable" : "Boolean" ,
             "advanced-properties" : {
               "@total" : "Integer" ,
               "unmanaged-device-attr" : {
                 "value" : "String" ,
                 "key" : "String"
               }
             }
           }
         }
       }
    }

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

  • Access Control

    The following capabilities are required to access this API: AddUnmanagedDevices