Sending A Request To The Junos Xml Protocol Server; Request Classes - Juniper JUNOS OS 10.3 - XML MANAGEMENT PROTOCOL GUIDE 6-30-2010 Manual

Junos 10.3 Junos XML Management Protocol Guide

Sending a Request to the Junos XML Protocol Server

46
session initialization except in response to the client application's requests. The following
sections describe the exchange of tagged data:
Sending a Request to the Junos XML Protocol Server on page 46
Parsing the Junos XML Protocol Server Response on page 48
Handling an Error or Warning on page 51
Halting a Request on page 52
To initiate a request to the Junos XML protocol server, a client application emits the
opening tag, followed by one or more tag elements that represent the particular
<rpc>
request, and the closing </rpc>
<rpc>
<!--tag elements representing a request-->
</rpc>
The application encloses each request in a separate pair of opening
tags. The tag element can occur only within the
</rpc> <rpc>
For an example of emitting an
protocol session, see "Example of a Junos XML Protocol Session" on page 56.
The Junos XML protocol server ignores any newline characters, spaces, or other white
space characters that occur between tag elements in the tag stream, but does preserve
white space within tag elements. For more information, see "Spaces, Newline Characters,
and Other White Space" on page 11.
See the following sections for further information:
Request Classes on page 46
Including Attributes in the Opening <rpc> Tag on page 48

Request Classes

A client application can make three classes of requests:
Operational Requests on page 46
Configuration Information Requests on page 47
Configuration Change Requests on page 47
NOTE: Although operational and configuration requests conceptually belong to separate
classes, a Junos XML protocol session does not have distinct modes that correspond
to CLI operational and configuration modes. Each request tag element is enclosed
within its own tag element, so a client application can freely alternate operational
<rpc>
and configuration requests.
Operational Requests
Operational requests are requests for information about the status of a device running
Junos OS. Operational requests correspond to the CLI operational mode commands
listed in the Junos OS command references. The Junos XML API defines a request tag
tag, in that order:
<rpc> tag element in the context of a complete Junos XML
Copyright © 2010, Juniper Networks, Inc.
and closing
<rpc>
tag element.
<junoscript>