/api/space/device-management/modeled-device-management/modeled-instances

The following operations are supported on this resource:

  • GET - Get all modeled instances
  • POST - Create modeled instance and activate now
  • POST - Create modeled instance and activate later
GET /modeled-device-management/modeled-instancesVersion 1

Get all modeled instances.

Sample Usage

GET /modeled-device-management/modeled-instances


  • Sample Output XML:
    <modeled-instances total="Integer" uri="/api/space/device-management/modeled-device-management/modeled-instances">
         <modeled-instance
               href="/api/space/device-management/modeled-device-management/modeled-instances/{id}" uri="/api/space/device-management/modeled-device-management/modeled-instances/{id}">
               <id>Integer</id>
               <name>String</name>
               <description>String</description>
               <device-family>String</device-family>
               <connection-profile-type>Static</connection-profile-type>
               <device-count>Integer</device-count>
         </modeled-instance>
    </modeled-instances>

  • Sample Output JSON:
    {
       "modeled-instances" : {
         "@total" : "Integer" ,
         "@uri" :
         "/api/space/device-management/modeled-device-management/modeled-instances" ,
         "modeled-instance" : {
           "@href" :
           "/api/space/device-management/modeled-device-management/modeled-instances/{id}"
           ,
           "@uri" :
           "/api/space/device-management/modeled-device-management/modeled-instances/{id}"
           ,
           "id" : "Integer" ,
           "name" : "String" ,
           "description" : "String" ,
           "device-family" : "String" ,
           "connection-profile-type" : "Static" ,
           "device-count" : "Integer"
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ViewRapidDeploymentInstance

    POST /modeled-device-management/modeled-instancesVersion 2

    Create modeled instance and activate now, either num-of-devices could be defined or the devices themselves could be defined explicitly.

    Sample Usage

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

    POST /modeled-device-management/modeled-instances?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:
    <modeled-instance>
         <name>String</name>
         <description>String</description>
         <tag-name>String</tag-name>
         <platform>String</platform>
         <number-of-devices>Integer</number-of-devices>
         <template href="/api/space/config-template-management/config-templates/{id}"/>
         <device-image href="/api/space/software-management/packages/{id}"/>
         <activation-parameters>
               <user-name>String</user-name>
               <key-based>Boolean</key-based>
               <password>String</password>
               <serial-number-validation>Boolean</serial-number-validation>
               <host-name-validation>Boolean</host-name-validation>
               <connection-profile href="/api/space/device-management/modeled-device-management/connection-profiles/{id}"/>
               <configuration-update-type>AUTOMATIC</configuration-update-type>
         </activation-parameters>
         <devices>
               <device>
                   <device-name>String</device-name>
                   <platform>String</platform>
                   <os-version>String</os-version>
                   <serial-number>String</serial-number>
                   <static-ip>String</static-ip>
                   <gateway>String</gateway>
               </device>
         </devices>
         <snmp-setting>
               <snmp-v1-setting>
                   <community-name>String</community-name>
               </snmp-v1-setting>
               <snmp-v2c-setting>
                   <community-name>String</community-name>
               </snmp-v2c-setting>
               <snmp-v3-setting>
                   <user-name>String</user-name>
                   <authentication-type>MD5</authentication-type>
                   <authentication-password>String</authentication-password>
                   <privacy-type>AES128</privacy-type>
                   <privacy-password>String</privacy-password>
               </snmp-v3-setting>
         </snmp-setting>
    </modeled-instance>

  • Sample Input JSON:
    {
       "modeled-instance" : {
         "name" : "String" ,
         "description" : "String" ,
         "tag-name" : "String" ,
         "platform" : "String" ,
         "number-of-devices" : "Integer" ,
         "template" : {
           "@href" : "/api/space/config-template-management/config-templates/{id}"
         } ,
         "device-image" : {
           "@href" : "/api/space/software-management/packages/{id}"
         } ,
         "activation-parameters" : {
           "user-name" : "String" ,
           "key-based" : "Boolean" ,
           "password" : "String" ,
           "serial-number-validation" : "Boolean" ,
           "host-name-validation" : "Boolean" ,
           "connection-profile" : {
             "@href" :
             "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
           } ,
           "configuration-update-type" : "AUTOMATIC"
         } ,
         "devices" : {
           "device" : {
             "device-name" : "String" ,
             "platform" : "String" ,
             "os-version" : "String" ,
             "serial-number" : "String" ,
             "static-ip" : "String" ,
             "gateway" : "String"
           }
         } ,
         "snmp-setting" : {
           "snmp-v1-setting" : {
             "community-name" : "String"
           } ,
           "snmp-v2c-setting" : {
             "community-name" : "String"
           } ,
           "snmp-v3-setting" : {
             "user-name" : "String" ,
             "authentication-type" : "MD5" ,
             "authentication-password" : "String" ,
             "privacy-type" : "AES128" ,
             "privacy-password" : "String"
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: AddRapidDeployment

    POST /modeled-device-management/modeled-instancesVersion 2

    Create modeled instance and activate later, either num-of-devices could be defined or the devices themselves could be defined explicitly.

    Sample Usage

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

    POST /modeled-device-management/modeled-instances?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:
    <modeled-instance>
         <name>String</name>
         <description>String</description>
         <tag-name>String</tag-name>
         <number-of-devices>Integer</number-of-devices>
         <platform>String</platform>
         <template href="/api/space/config-template-management/config-templates/{id}"/>
         <device-image href="/api/space/software-management/packages/{id}"/>
         <devices>
               <device>
                   <device-name>String</device-name>
                   <platform>String</platform>
               </device>
         </devices>
         <snmp-setting>
               <snmp-v1-setting>
                   <community-name>String</community-name>
               </snmp-v1-setting>
               <snmp-v2c-setting>
                   <community-name>String</community-name>
               </snmp-v2c-setting>
               <snmp-v3-setting>
                   <user-name>String</user-name>
                   <authentication-type>MD5</authentication-type>
                   <authentication-password>String</authentication-password>
                   <privacy-type>AES128</privacy-type>
                   <privacy-password>String</privacy-password>
               </snmp-v3-setting>
         </snmp-setting>
    </modeled-instance>

  • Sample Input JSON:
    {
       "modeled-instance" : {
         "name" : "String" ,
         "description" : "String" ,
         "tag-name" : "String" ,
         "number-of-devices" : "Integer" ,
         "platform" : "String" ,
         "template" : {
           "@href" : "/api/space/config-template-management/config-templates/{id}"
         } ,
         "device-image" : {
           "@href" : "/api/space/software-management/packages/{id}"
         } ,
         "devices" : {
           "device" : {
             "device-name" : "String" ,
             "platform" : "String"
           }
         } ,
         "snmp-setting" : {
           "snmp-v1-setting" : {
             "community-name" : "String"
           } ,
           "snmp-v2c-setting" : {
             "community-name" : "String"
           } ,
           "snmp-v3-setting" : {
             "user-name" : "String" ,
             "authentication-type" : "MD5" ,
             "authentication-password" : "String" ,
             "privacy-type" : "AES128" ,
             "privacy-password" : "String"
           }
         }
       }
    }