Overview Of The Request Procedure; Requesting Operational Information - Juniper JUNOS OS 10.3 - XML MANAGEMENT PROTOCOL GUIDE 6-30-2010 Manual

Junos 10.3 Junos XML Management Protocol Guide

Overview of the Request Procedure

Requesting Operational Information

62
To request information from the Junos XML protocol server, a client application performs
the procedures described in the indicated sections:
Establishes a connection to the Junos XML protocol server on the routing, switching,
1.
or security platform, as described in "Connecting to the Junos XML Protocol Server"
on page 37.
Opens a Junos XML protocol session, as described in "Starting the Junos XML Protocol
2.
Session" on page 38.
If making configuration requests, optionally locks the candidate configuration or
3.
creates a private copy, as described in "Locking the Candidate Configuration" on
page 53 and "Creating a Private Copy of the Configuration" on page 54.
Makes any number of requests one at a time, freely intermingling operational and
4.
configuration requests. See "Requesting Operational Information" on page 62 and
"Requesting Configuration Information" on page 64.
The application can also intermix requests with configuration changes, which are
described in "Changing Configuration Information" on page 103.
Accepts the tag stream emitted by the Junos XML protocol server in response to
5.
each request and extracts its content, as described in "Parsing the Junos XML Protocol
Server Response" on page 48.
Unlocks the candidate configuration if it is locked, as described in "Unlocking the
6.
Candidate Configuration" on page 54. Other users and applications cannot change
the configuration while it remains locked.
Ends the Junos XML protocol session and closes the connection to the device, as
7.
described in "Ending a Junos XML Protocol Session and Closing the Connection" on
page 55.
To request information about the current status of a device, a client application emits
the specific tag element from the Junos XML API that returns the desired information.
For example, the <get-interface-information>
command, the
show interfaces
information as the
show chassis hardware
tag element requests the same information as the
For complete information about the operational request tag elements available in the
current Junos OS Release, see the chapters in the Junos XML API Operational Reference
that are titled "Mapping Between Operational Tag Elements, Perl Methods, and CLI
Commands" and "Summary of Operational Request Tag Elements."
The application encloses the request tag element in an
depends on whether the corresponding CLI command has any options:
<rpc>
tag element corresponds to the
tag element requests the same
<get-chassis-inventory>
command, and the
show software information
<rpc>
Copyright © 2010, Juniper Networks, Inc.
<get-system-inventory>
command.
tag element. The syntax