REST Resources
-
/modeled-device-management -
/modeled-device-management /connection-profiles -
/modeled-device-management /connection-profiles /{id} -
/modeled-device-management /create-connection-profile -
/modeled-device-management /modeled-instances -
/modeled-device-management /modeled-instances /{id} -
/modeled-device-management /modeled-instances /{id} /add-more-devices -
/modeled-device-management /modeled-instances /{id} /configlets -
/modeled-device-management /modeled-instances /{id} /devices
/api/space/device-management/modeled-device-management/modeled-instances
The following operations are supported on this resource:
| GET /modeled-device-management/modeled-instances | Version 1 |
Get all modeled instances.
Sample Usage
GET /modeled-device-management/modeled-instances
-
Accept Headers:
application/vnd.net.juniper.space.device-management.modeled-device-management.modeled-instances+xml;version=1
application/vnd.net.juniper.space.device-management.modeled-device-management.modeled-instances+json;version=1
<modeled-instances total="1" uri="/api/space/device-management/modeled-device-management/modeled-instances">
<modeled-instance
href="/api/space/device-management/modeled-device-management/modeled-instances/851973" uri="/api/space/device-management/modeled-device-management/modeled-instances/851973">
<id>851973</id>
<name>Modeled_Instance</name>
<description>DHCP Modeled Instance</description>
<device-family>JUNOS</device-family>
<connection-profile-type>DHCP</connection-profile-type>
<device-count>2</device-count>
</modeled-instance>
</modeled-instances>
{
"modeled-instances" : {
"@total" : "1" ,
"@uri" : "/api/space/device-management/modeled-device-management/modeled-instances" ,
"modeled-instance" : {
"@href" : "/api/space/device-management/modeled-device-management/modeled-instances/851973" ,
"@uri" : "/api/space/device-management/modeled-device-management/modeled-instances/851973" ,
"id" : 851973 ,
"name" : "Modeled_Instance" ,
"description" : "DHCP Modeled Instance" ,
"device-family" : "JUNOS" ,
"connection-profile-type" : "DHCP" ,
"device-count" : 2
}
}
}
Access Control
The following capabilities are required to access this API: ViewRapidDeploymentInstance
| POST /modeled-device-management/modeled-instances | Version 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:
Name Type URI Type Description Required queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
-
Content-Type Headers:
application/vnd.net.juniper.space.device-management.modeled-device-management.modeled-instance-activate-now+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.device-management.modeled-device-management.modeled-instance-activate-now+json;version=2;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<modeled-instance>
<name>Modeled_device</name>
<description>Test Description</description>
<tag-name>Modeled</tag-name>
<platform>EX4200-24T</platform>
<number-of-devices>1</number-of-devices>
<template href="/api/space/config-template-management/config-templates/327698"/>
<device-image href="/api/space/software-management/packages/321698"/>
<activation-parameters>
<user-name>root</user-name>
<key-based>false</key-based>
<password>*********</password>
<serial-number-validation>false</serial-number-validation>
<host-name-validation>false</host-name-validation>
<connection-profile href="/api/space/device-management/modeled-device-management/connection-profiles/3276"/>
<configuration-update-type>AUTOMATIC</configuration-update-type>
</activation-parameters>
<devices>
<device>
<device-name>Ex_Device</device-name>
<platform>ex4300-24P</platform>
<os-version>15.1R1.8</os-version>
<serial-number>0208144601</serial-number>
<static-ip>192.168.1.1</static-ip>
<gateway>192.168.1.10</gateway>
</device>
</devices>
<snmp-setting>
<snmp-v1-setting>
<community-name>public</community-name>
</snmp-v1-setting>
</snmp-setting>
</modeled-instance>
<task href="/api/space/job-management/jobs/688132">
<id>688132</id>
</task>
{
"modeled-instance" : {
"name" : "Modeled_device" ,
"description" : "Test Description" ,
"tag-name" : "Modeled" ,
"platform" : "EX4200-24T" ,
"number-of-devices" : "1" ,
"template" : {
"@href" : "/api/space/config-template-management/config-templates/327698"
} ,
"device-image" : {
"@href" : "/api/space/software-management/packages/321698"
} ,
"activation-parameters" : {
"user-name" : "root" ,
"key-based" : "false" ,
"password" : "********" ,
"serial-number-validation" : "false" ,
"host-name-validation" : "false" ,
"connection-profile" : {
"@href" :
"/api/space/device-management/modeled-device-management/connection-profiles/3276"
} ,
"configuration-update-type" : "AUTOMATIC"
} ,
"devices" : {
"device" : {
"device-name" : "Ex_Device" ,
"platform" : "ex4300-24P" ,
"os-version" : "15.1R1.8" ,
"serial-number" : "0208144601" ,
"static-ip" : "192.168.1.1" ,
"gateway" : "192.168.1.1"
}
} ,
"snmp-setting" : {
"snmp-v1-setting" : {
"community-name" : "public"
}
}
}
}
{
"task":{
"@href":"/api/space/job-management/jobs/688132",
"id":688132
}
}
Access Control
The following capabilities are required to access this API: AddRapidDeployment
| POST /modeled-device-management/modeled-instances | Version 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:
Name Type URI Type Description Required queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
-
Content-Type Headers:
application/vnd.net.juniper.space.device-management.modeled-device-management.modeled-instance-activate-later+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.device-management.modeled-device-management.modeled-instance-activate-later+json;version=2;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<modeled-instance>
<name>Modeled_device</name>
<description>Test Description</description>
<tag-name>Modeled</tag-name>
<number-of-devices>1</number-of-devices>
<platform>EX4200-24T</platform>
<template href="/api/space/config-template-management/config-templates/327698"/>
<device-image href="/api/space/software-management/packages/321698"/>
<devices>
<device>
<device-name>Ex_Device</device-name>
<platform>ex4300-24P</platform>
</device>
</devices>
<snmp-setting>
<snmp-v3-setting>
<user-name>root</user-name>
<authentication-type>MD5</authentication-type>
<authentication-password>********</authentication-password>
<privacy-type>AES128</privacy-type>
<privacy-password>********</privacy-password>
</snmp-v3-setting>
</snmp-setting>
</modeled-instance>
<task href="/api/space/job-management/jobs/688128">
<id>688128</id>
</task>
{
"modeled-instance" : {
"name" : "Modeled_device" ,
"description" : "Test Description" ,
"tag-name" : "Modeled" ,
"number-of-devices" : "1" ,
"platform" : "EX4200-24T" ,
"template" : {
"@href" : "/api/space/config-template-management/config-templates/327698"
} ,
"device-image" : {
"@href" : "/api/space/software-management/packages/321698"
} ,
"devices" : {
"device" : {
"device-name" : "root" ,
"platform" : "ex4300-24P"
}
} ,
"snmp-setting" : {
"snmp-v3-setting" : {
"user-name" : "root" ,
"authentication-type" : "MD5" ,
"authentication-password" : "********" ,
"privacy-type" : "AES128" ,
"privacy-password" : "********"
}
}
}
}
{
"task":{
"@href":"/api/space/job-management/jobs/688128",
"id":688128
}
}
Access Control
The following capabilities are required to access this API: AddRapidDeployment