[Contents] [Prev] [Next] [Index] [Report an Error]

Emitting the Opening <junoscript> Tag

The client application then emits its opening <junoscript> tag, which has the following syntax (and appears here on two lines only for legibility):



<junoscript version="version" hostname="hostname" junos:key="key"

     release="release-code">

The attributes are as follows. For a list of the attribute values that are acceptable in the current version of the JUNOScript API, see Supported Software Versions.

version—(Required) Specifies the version of the JUNOScript API that the client application is using.
hostname—(Optional) Names the machine on which the client application is running. The information is used only when diagnosing problems. The JUNOScript API does not include support for establishing trusted-host relationships or otherwise altering JUNOScript server behavior depending on the client hostname.
junos:key—(Optional) Requests that the JUNOScript server indicate whether a child configuration element is an identifier for its parent element. The only acceptable value is key. For more information, see Requesting an Indicator for Identifiers.
release—(Optional) Identifies the JUNOS software release (and by implication, the JUNOS XML API) for which the client application is designed. It indicates that the client application can interoperate successfully with a JUNOScript server that also supports that version of the JUNOS XML API. In other words, it indicates that the client application emits request tag elements from that API, and knows how to parse response tag elements from it. If the application does not include this attribute, the JUNOScript server emits tag elements from the JUNOS XML API that it supports. For more information, see Verifying Software Compatibility.
For the value of the release attribute, use the standard notation for JUNOS software version numbers. For example, the value 9.4R1 represents the initial version of JUNOS Release 9.4.

In the following example of a client application’s opening <junoscript> tag, the version="1.0" attribute indicates that it is using JUNOScript version 1.0. The hostname="client1" attribute indicates that the client application is running on the machine called client1. The release="9.4R1" attribute indicates that the routing platform is running the initial version of JUNOS Release 9.4.



<junoscript version="1.0" hostname="client1" release="9.4R1">

Note: If the application fails to emit the <?xml?> PI before emitting the opening <junoscript> tag, the JUNOScript server emits an error message similar to the following and immediately closes the session and connection:



<rpc-reply>
    <xnm:error xmlns="http://xml.juniper.net/xnm/1.1/xnm" \
            xmlns:xnm="http://xml.juniper.net/xnm/1.1/xnm">
        <message>
            communication error while exchanging credentials
        </message>
    </xnm:error>
</rpc-reply>
<!- - session end at YYYY-MM-DD hh:mm:ss TZ - ->
</junoscript>

For more information about the <xnm:error> tag, see Handling an Error or Warning.

[Contents] [Prev] [Next] [Index] [Report an Error]