Mapping Commands To Junos Xml Tag Elements; Mapping For Command Options With Variable Values; Mapping For Fixed-Form Command Options - Juniper JUNOS OS 10.3 - XML MANAGEMENT PROTOCOL GUIDE 6-30-2010 Manual

Junos 10.3 Junos XML Management Protocol Guide

Mapping Commands to Junos XML Tag Elements

Mapping for Command Options with Variable Values

Mapping for Fixed-Form Command Options

14
The Junos XML API defines tag-element equivalents for many commands in CLI
operational mode. For example, the
to the command.
show interfaces
Information about the available command equivalents in the current release of the Junos
OS can be found in the Junos XML API Operational Reference. For the mapping between
commands and Junos XML tag elements, see the Junos XML API Operational Reference
"Mapping Between Operational Tag Elements, Perl Methods, and CLI Commands" chapter.
For detailed information about a specific operation, see the Junos XML API Operational
Reference "Summary of Operational Request Tags" chapter.
The following sections describe the tag elements that map to command options:
Mapping for Command Options with Variable Values on page 14
Mapping for Fixed-Form Command Options on page 14
Many CLI commands have options that identify the object that the command affects or
reports about, distinguishing the object from other objects of the same type. In some
cases, the CLI does not precede the identifier with a fixed-form keyword, but XML
convention requires that the Junos XML API define a tag element for every option. To
learn the names for each identifier (and any other child tag elements) for an operational
request tag element, consult the tag element's entry in the appropriate DTD or in the
Junos XML API Operational Reference.
The following example shows the Junos XML tag elements for two CLI operational
commands that have variable-form options. In the
is the name of the interface. In the
address for the BGP peer of interest.
Some CLI commands include options that have a fixed form, such as the
strings, which specify the amount of detail to include in the output. The Junos XML API
usually maps such an option to an empty tag whose name matches the option name.
The following example shows the Junos XML tag elements for the
command, which has a fixed-form option called
<get-interface-information>
show interfaces
command,
show bgp neighbor
.
detail
Copyright © 2010, Juniper Networks, Inc.
tag element corresponds
command,
t3-5/1/0:0
is the IP
10.168.1.222
and
brief detail
show isis adjacency