Locking The Candidate Configuration - Juniper JUNOS OS 10.3 - XML MANAGEMENT PROTOCOL GUIDE 6-30-2010 Manual

Locking the Candidate Configuration

Copyright © 2010, Juniper Networks, Inc.
Change the candidate configuration without locking it. We do not recommend this
method, because of the potential for conflicts with changes made by other applications
or users that are editing the configuration at the same time.
If an application is simply requesting configuration information and not changing it, locking
the configuration or creating a private copy is not required. However, it is appropriate to
lock the configuration if it is important that the information being returned not change
during the session. The information from a private copy is guaranteed not to change, but
can diverge from the candidate configuration if other users or applications are changing
the candidate.
The restrictions on, and interactions between, operations on the locked regular candidate
configuration and a private copy are the same as for the CLI
commands. For more information, see "Committing a Private Copy of
configure private
the Configuration" on page 135 and the Junos CLI User Guide.
For more information about locking and unlocking the candidate configuration or creating
a private copy, see the following sections:
Locking the Candidate Configuration on page 53
Unlocking the Candidate Configuration on page 54
Creating a Private Copy of the Configuration on page 54
To lock the candidate configuration, a client application emits the
tag within an <rpc> tag element:
<rpc>
<lock-configuration/>
</rpc>
Emitting this tag prevents other users or applications from changing the candidate
configuration until the lock is released (equivalent to the CLI
command). Locking the configuration is recommended, particularly on devices where
multiple users are authorized to change the configuration. A commit operation applies
to all changes in the candidate configuration, not just those made by the user or
application that requests the commit. Allowing multiple users or applications to make
changes simultaneously can lead to unexpected results.
When the Junos XML protocol server locks the configuration, it returns an opening
and closing
<rpc-reply> </rpc-reply>
<rpc-reply xmlns:junos="URL">
</rpc-reply>
If the Junos XML protocol server cannot lock the configuration, the
instead encloses an
<xnm:error>
for the failure can include the following:
Another user or application has already locked the candidate configuration. The error
message reports the login identity of the user or application.
Chapter 3: Controlling the Junos XML Management Protocol Session
tag with nothing between them:
tag element explaining the reason for the failure. Reasons
and
configure exclusive
<lock-configuration/>
configure exclusive
<rpc-reply> tag element
53