Connect to the Junos XML Protocol Server

The Junos XML management protocol and Junos XML API are primarily intended for use by client applications. However, for testing purposes you can establish an interactive Junos XML protocol session and type commands in a shell window.

To connect to the Junos XML protocol server from the CLI operational mode, issue the junoscript interactive command. The interactive option causes the Junos XML protocol server to echo what you type.

To begin a Junos XML protocol session over the connection, emit the initialization PI and tag that are described in Start a Junos XML Protocol Session. You can then enter tag element sequences that represent operational and configuration operations. To eliminate typing errors, save complete tag element sequences in a file and use a cut-and-paste utility to copy the sequences to the shell window.

Note:

When you close the connection to the Junos XML protocol server (for example, by emitting the <request-end-session/> and </junoscript> tags), the device completely closes the connection instead of returning to the CLI operational mode prompt. For more information about ending a Junos XML protocol session, see End a Junos XML Protocol Session and Close the Connection.

For a client application to connect to the Junos XML protocol server and open a session, you must first satisfy the prerequisites described in Satisfy the Prerequisites for Establishing a Connection to the Junos XML Protocol Server.

A client application connects to the Junos XML protocol server by opening a socket or other communications channel to the Junos XML protocol server device, invoking one of the remote-connection routines appropriate for the programming language and access protocol that the application uses.

What the client application does next depends on which access protocol it is using:

• If using the clear-text or SSL protocol, the client application performs the following steps:

  1. Emits the initialization PI and tag, as described in Start a Junos XML Protocol Session.

  2. Authenticates with the Junos XML protocol server, as described in Authenticate with the Junos XML Protocol Server for Cleartext or SSL Connections.

• If using the SSH or Telnet protocol, the client application performs the following steps:

  1. Uses the protocol’s built-in authentication mechanism to authenticate.

  2. Issues the junoscript command to request that the Junos XML protocol server convert the connection into a Junos XML protocol session.

     For a C programming language example, see Establish a Junos XML Protocol Session Using C Client Applications and Access and Edit Device Configurations Using Junos XML Protocol C Client Applications.

  3. Emits the initialization PI and tag, as described in Start a Junos XML Protocol Session.