REST Resources

/api/space/device-management/devices/{device-id}/configlet

The following operation is supported on this resource:

  • GET - Get device configlet data
GET /devices/{device-id}/configletVersion 1

Sample Usage

GET /devices/{device-id}/configlet


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-idIntegerPath   Y
  • Sample Output XML:
    <configlet uri="/api/space/device-management/devices/884746/configlet">
         <xml-configlet-data>
            <configlet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xml.juniper.net/dmi/configlet_v1.xsd">
            <header>
                <validation-information>
                    <auto>
                        <platform>ACX1000</platform>
                    </auto>
                </validation-information>
            </header>
            <data>
                <configuration>
                    <system>
                        <root-authentication>
                            <ssh-rsa>
                                <name>$RSA_KEY$</name>
                            </ssh-rsa>
                        </root-authentication>
                        <services>
                            <outbound-ssh>
                                <client>
                                    <name>cluster_228.168.26.26</name>
                                    <device-id>A6D04D</device-id>
                                    <secret>$OTP$</secret>
                                    <services>netconf</services>
                                    <servers>
                                        <name>192.168.26.27</name>
                                        <port>7804</port>
                                    </servers>
                                    <servers>
                                        <name>192.168.26.160</name>
                                        <port>7804</port>
                                    </servers>
                                </client>
                            </outbound-ssh>
                            <ssh>
                                <protocol-version>v2</protocol-version>
                            </ssh>
                        </services>
                    </system>
                    <interfaces>
                        <interface>
                            <name>ge-0/0/0</name>
                            <unit>
                                <name>0</name>
                                <family>
                                    <inet>
                                        <dhcp-client>
                                            <retransmission-attempt>4</retransmission-attempt>
                                            <retransmission-interval>4</retransmission-interval>
                                        </dhcp-client>
                                    </inet>
                                </family>
                            </unit>
                        </interface>
                    </interfaces>
                </configuration>
            </data>
          </configlet>
     
         </xml-configlet-data>
         <curly-braces-configlet-data>
               system { services { ssh    { protocol-version v2; } } }
          system { services { outbound-ssh { client cluster_228.168.26.26 { device-id A6D04D; secret $OTP$; services netconf; 192.168.26.27 port 7804 } } } }
          system { services { outbound-ssh { client cluster_228.168.26.26 { device-id A6D04D; secret $OTP$; services netconf; 192.168.26.160 port 7804 } } } }
          system  { root-authentication { ssh-rsa $RSA_KEY$;  } }
          interfaces ge-0/0/0 { unit 0 { family inet { dhcp-client; } } }
          interfaces ge-0/0/0 { unit 0 { family inet { dhcp-client { retransmission-attempt 4; } } } }
          interfaces ge-0/0/0 { unit 0 { family inet { dhcp-client { retransmission-interval 4; } } } }
     
         </curly-braces-configlet-data>
         <cli-configlet-data>
               set system services ssh protocol-version v2
          set system services outbound-ssh client cluster_228.168.26.26 device-id A6D04D secret $OTP$ services netconf 192.168.26.27 port 7804
          set system services outbound-ssh client cluster_228.168.26.26 device-id A6D04D secret $OTP$ services netconf 192.168.26.160 port 7804
          set system root-authentication ssh-rsa $RSA_KEY$ 
          set interfaces ge-0/0/0 unit 0 family inet dhcp-client
          set interfaces ge-0/0/0 unit 0 family inet dhcp-client retransmission-attempt 4
          set interfaces ge-0/0/0 unit 0 family inet dhcp-client retransmission-interval 4
          commit
     
         </cli-configlet-data>
    </configlet>

  • Sample Output JSON:
    {
       "configlet" : {
         "@uri" : "/api/space/device-management/devices/884746/configlet" ,
         "xml-configlet-data" :
     
           "<configlet xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://xml.juniper.net
           /dmi/configlet_v1.xsd\">\n    <header>\n        <validation-information>\n            <auto>\n               
           <platform>ACX1000</platform>\n            </auto>\n        </validation-information>\n    </header>\n   
            <data>\n        <configuration>\n            <system>\n                <root-authentication>\n                
                <ssh-rsa>\n                        <name>$RSA_KEY$</name>\n                    </ssh-rsa>\n                
                </root-authentication>\n                <services>\n                    <outbound-ssh>\n                       
                 <client>\n                            <name>cluster_228.168.26.26</name>\n                            <devi
                 ce-id>A6D04D</device-id>\n                            <secret>$OTP$</secret>\n                            &t;
                services>netconf</services>\n                            <servers>\n                                <name>
                 192.168.26.27</name>\n                                <port>7804</port>\n                            </servers
                 >\n                            <servers>\n                                <name>192.168.26.160</name>\n,       
                                        <port>7804</port>\n                            </servers>\n                        </client>\n
                                                            </outbound-ssh>\n                    <ssh>\n                        
                 <protocol-version>v2</protocol-version>\n                    </ssh>\n                </services>\n  
                           </system>\n            <interfaces>\n                <interface>\n                    <name>ge-0/0/0<
                           /name>\n                    <unit>\n                        <name>0</name>\n                       
                   <family>\n                            <inet>\n                                <dhcp-client>\n                           
                            <retransmission-attempt>4</retransmission-attempt>\n                                    <retransmission-interval>
                            4</retransmission-interval>\n                                </dhcp-client>\n                            </inet>\n 
                                                   </family>\n                    </unit>\n                </interface>\n           
                                                    </interfaces>\n        </configuration>\n    </data>\n</configlet>",
        
         "curly-braces-configlet-data" :
            "system { services { ssh\t{ protocol-version v2; } } }\nsystem { services { outbound-ssh { client cluster_228.168.26.26 
            { device-id A6D04D; secret $OTP$; services netconf; 192.168.26.27 port 7804 } } } }\nsystem { services { outbound-ssh { client
            cluster_228.168.26.26 { device-id A6D04D; secret $OTP$; services netconf; 192.168.26.160 port 7804 } } } }\nsystem  { root-
            authentication { ssh-rsa $RSA_KEY$;  } }\ninterfaces ge-0/0/0 { unit 0 { family inet { dhcp-client; } } }\ninterfaces ge-0/0/0
            { unit 0 { family inet { dhcp-client { retransmission-attempt 4; } } } }\ninterfaces ge-0/0/0 { unit 0 { family inet { dhcp-client 
            { retransmission-interval 4; } } } }\n",
     
         "cli-configlet-data" :
            "edit\nset system services ssh protocol-version v2\nset system services outbound-ssh client cluster_228.168.26.26 device-id 
            A6D04D secret $OTP$ services netconf 192.168.26.27 port 7804\nset system services outbound-ssh client cluster_228.168.26.26 device-id 
            A6D04D secret $OTP$ services netconf 192.168.26.160 port 7804\nset system root-authentication ssh-rsa $RSA_KEY$ \nset interfaces 
            ge-0/0/0 unit 0 family inet dhcp-client\nset interfaces ge-0/0/0 unit 0 family inet dhcp-client retransmission-attempt 4\nset interfaces 
            ge-0/0/0 unit 0 family inet dhcp-client retransmission-interval 4\ncommit\n"
     
       }
    }

  • Access Control

    The following capabilities are required to access this API: ViewConfiglets