Mapping Commands to Junos XML Tag Elements
The Junos XML API defines tag-element equivalents for many commands in CLI operational mode. For example, the <get-interface-information> tag corresponds to the show interfaces command.
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
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 show interfaces command, t3-5/1/0:0 is the name of the interface. In the show bgp neighbor command, 10.168.1.222 is the IP address for the BGP peer of interest.
Mapping for Fixed-Form Command Options
Some CLI commands include options that have a fixed form, such as the brief and detail 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 show isis adjacency command, which has a fixed-form option called detail.
