Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Requesting Configuration Changes Using the Junos XML Protocol

 

In a Junos XML protocol session with a device running Junos OS, you can use Junos XML protocol operations along with Junos XML, command-line interface (CLI) configuration statements, set commands, or JSON data to change the configuration on a routing, switching, or security platform. The Junos XML protocol <load-configuration> operation and its attributes offer functionality that is analogous to configuration mode commands in the Junos OS CLI. The Junos XML tag elements described here correspond to configuration statements, which are described in the Junos OS configuration guides.

To change the configuration on a device running Junos OS, the client application performs the procedures described in the indicated sections:

  1. Establishes a connection to the Junos XML protocol server on the routing, switching, or security platform, as described in Connecting to the Junos XML Protocol Server.

  2. Starts a Junos XML protocol session, as described in Starting Junos XML Protocol Sessions.

  3. Optionally locks the candidate configuration, creates a private copy of the candidate configuration, or opens an instance of the ephemeral configuration database.

    Locking the configuration prevents other users or applications from changing it at the same time. Creating a private copy enables the application to make changes without affecting the candidate configuration until the copy is committed. For more information, see Locking and Unlocking the Candidate Configuration or Creating a Private Copy Using the Junos XML Protocol.

    For information about the ephemeral configuration database, see Understanding the Ephemeral Configuration Database and Enabling and Configuring Instances of the Ephemeral Configuration Database.

  4. Encloses the <load-configuration> tag element in an <rpc> tag element. By including various attributes in the <load-configuration> tag, the application can provide the configuration data either in a file or as a directly loaded tag stream, and as Junos XML tag elements, formatted ASCII text, JSON-formatted data, or Junos OS configuration mode set commands. The client application can specify that the configuration data completely replace the existing candidate configuration, or the application can specify the manner in which the Junos XML protocol server loads the data into the existing candidate configuration, private copy, or open instance of the ephemeral configuration database. The basic syntax is as follows:

  5. Accepts the tag stream emitted by the Junos XML protocol server in response to each request and extracts its content, as described in Parsing the Junos XML Protocol Server Response.

    The Junos XML protocol server confirms that it incorporated the configuration data by returning the <load-configuration-results> tag element and <load-success/> tag in the <rpc-reply> tag element:

    If the load operation fails, the <load-configuration-results> tag element instead encloses the <load-error-count> tag element, which indicates the number of errors that occurred. In this case, the application or an administrator must eliminate the errors before committing the configuration.

  6. (Optional) Verifies the syntactic correctness of the candidate configuration or a private copy before attempting to commit it, as described in Verifying Configuration Syntax Using the Junos XML Protocol.

  7. Commits changes made to the candidate configuration or private copy, as described in Committing the Candidate Configuration Using the Junos XML Protocol, or commits changes made to an open instance of the ephemeral configuration database, as described in Committing and Synchronizing Ephemeral Configuration Data Using the NETCONF or Junos XML Protocol.

  8. Unlocks the candidate configuration if it is locked, or closes a private copy of the configuration or an open instance of the ephemeral configuration database.

    Other users and applications cannot change the configuration while it remains locked. For more information, see Locking and Unlocking the Candidate Configuration or Creating a Private Copy Using the Junos XML Protocol.

  9. Ends the Junos XML protocol session and closes the connection to the device, as described in Ending a Junos XML Protocol Session and Closing the Connection.