Halting A Request; Copy - Juniper JUNOS OS 10.3 - XML MANAGEMENT PROTOCOL GUIDE 6-30-2010 Manual

Junos 10.3 Junos XML Management Protocol Guide

Halting a Request

Locking and Unlocking the Candidate Configuration or Creating a Private Copy
52
Opening, locking, committing, or closing a configuration as requested by a client
application (discussed in "Exchanging Information with the Junos XML Protocol Server"
on page 45, "Committing a Configuration" on page 133, and "Ending a Junos XML Protocol
Session and Closing the Connection" on page 55)
Parsing configuration data submitted by a client application in a
tag element (discussed in "Changing Configuration Information" on page 103)
If the Junos XML protocol server encounters a less serious problem, it can emit an
tag element instead. The usual response for the client application in this
<xnm:warning>
case is to log the warning or pass it to the user, but to continue parsing the server's
response.
For a description of the child tag elements that can appear within an
tag element to specify the nature of the problem, see "<xnm:error>" on
<xnm:warning>
page 179 and "<xnm:warning>" on page 181.
To request that the Junos XML protocol server stop processing the current request, a
client application emits the
operation to be halted:
<rpc>
<!-- tag elements for the request -->
</rpc>
<abort/>
The Junos XML protocol server responds with the
<rpc-reply xmlns:junos="URL">
<abort-acknowledgement/>
</rpc-reply>
Depending on the operation being performed, response tag elements already sent by
the Junos XML protocol server for the halted request are possibly invalid. The application
can include logic for deciding whether to discard or retain them as appropriate.
For more information, see "<abort/>" on page 149 and "<abort-acknowledgement/>" on
page 150.
When a client application is requesting or changing configuration information, it can use
one of three methods to access the configuration:
Lock the candidate configuration, which prevents other users or applications from
changing the configuration until the application releases the lock (equivalent to the
CLI configure exclusive command).
Create a private copy of the candidate configuration, which enables the application
to view or change configuration data without affecting the candidate or active
configuration until the private copy is committed (equivalent to the CLI
command).
<abort/> tag directly after the closing
<abort-acknowledgement/>
<load-configuration>
<xnm:error>
</rpc> tag for the
tag:
configure private
Copyright © 2010, Juniper Networks, Inc.
or