
Junos 10.3 Junos XML Management Protocol Guide
Copyright and Trademark Information
Table of Contents
List of Tables
About This Guide
Overview
Introduction to the Junos XML Management Protocol and Junos
XML API
Using Junos XML Management Protocol and Junos XML Tag Elements
XML and Junos XML Management Protocol Conventions Overview
Mapping Commands to Junos XML Tag Elements
Mapping Configuration Statements to Junos XML Tag Elements
Mapping for Hierarchy Levels and Container Statements
Mapping for Objects That Have an Identifier
Mapping for Single-Value and Fixed-Form Leaf Statements
Mapping for Leaf Statements with Multiple Values
Mapping for Multiple Options on One or More Lines
Mapping for Comments About Configuration Statements
Using the Same Configuration Tag Elements in Requests and Responses
Using the Junos XML Management Protocol
Controlling the Junos XML Management Protocol Session
Client Application’s Role in a Junos XML Protocol Session
Establishing a Junos XML Management Protocol Session
Exchanging Information with the Junos XML Protocol Server
Locking and Unlocking the Candidate Configuration or Creating
a Private Copy
Ending a Junos XML Protocol Session and Closing the Connection
Displaying CLI Output as XML Tag Elements
Example of a Junos XML Protocol Session
Requesting Information
Overview of the Request Procedure
Requesting Operational Information
Requesting Configuration Information
Specifying the Source and Output Format of Configuration Information
Specifying the Scope of Configuration Information to Return
Requesting the Complete Configuration
Requesting a Hierarchy Level or Container Object Without an
Identifier
Requesting All Configuration Objects of a Specified Type
Requesting a Specified Number of Configuration Objects
Requesting Identifiers Only
Requesting One Configuration Object
Requesting a Subset of Objects by Using Regular Expressions
Requesting Multiple Configuration Elements Simultaneously
Requesting an XML Schema for the Configuration Hierarchy
Requesting a Previous (Rollback) Configuration
Comparing Two Previous (Rollback) Configurations
Requesting the Rescue Configuration
Changing Configuration Information
Overview of Configuration Changes
Specifying the Source and Format of New Configuration Data
Replacing the Entire Configuration
Creating, Modifying, or Deleting Configuration Elements
Reordering Elements in Configuration Objects
Renaming a Configuration Object
Changing a Configuration Element’s Activation State
Changing a Configuration Element’s Activation State Simultaneously with Other Changes
Committing a Configuration
Verifying a Configuration Before Committing It
Committing the Candidate Configuration
Committing a Private Copy of the Configuration
Committing a Configuration at a Specified Time
Committing the Candidate Configuration Only After Confirmation
Committing and Synchronizing a Configuration on Redundant Control
Planes
Logging a Message About a Commit Operation
Summary of Junos XML Protocol Tag Elements
<abort/>
<abort-acknowledgement/>
<authentication-response>
<challenge>
<checksum-information>
<close-configuration/>
<commit-configuration>
<commit-results>
<database-status>
<database-status-information>
<end-session/>
<get-checksum-information>
<get-configuration>
<junoscript>
<load-configuration>
<load-configuration-results>
<lock-configuration/>
<open-configuration>
<reason>
<request-end-session/>
<request-login>
<routing-engine>
<rpc>
<rpc-reply>
<unlock-configuration/>
<?xml?>
<xnm:error>
<xnm:warning>
Summary of Attributes in Junos XML Tags
Writing Junos XML Protocol Client Applications
Writing Junos XML Protocol Perl Client Applications
Overview of the Junos::Device Perl Module and Sample Scripts
Downloading the Junos XML Protocol Perl Client and Prerequisites
Package
Unpacking the Junos XML Protocol Perl Client and Sample Scripts
Installing the Prerequisites Package and the Junos XML Protocol
Perl Client
Tutorial: Writing Perl Client Applications
Mapping CLI Commands to Perl Methods
Writing Junos XML Protocol
C Client Applications
IndexSymbols
- #, comments in configuration statements 1
- $
- regular expression operator
- Junos XML protocol requests 1
- ( ), in syntax descriptions 1
- *
- regular expression operator
- Junos XML protocol requests 1
- +
- regular expression operator
- Junos XML protocol requests 1
- . (period)
- regular expression operator
- Junos XML protocol requests 1
- < >, in syntax descriptions 1
- <?xml?> tag (Junos XML protocol) 1
- <checksum-information> (Junos XML protocol) 1
- <checksum> attribute
- <checksum-information> tag 1
- <computation-method> attribute
- <checksum-information> tag 1
- <file-checksum> attribute
- <checksum-information> tag 1
- <input-file> attribute
- <checksum-information> tag 1
- ?
- regular expression operator
- Junos XML protocol requests 1
- [ ], in configuration statements 1
- ^
- regular expression operator
- Junos XML protocol requests 1
- { }, in configuration statements 1
- | (pipe)
- regular expression operator
- Junos XML protocol requests 1
- | (pipe), in syntax descriptions 1
A
- abort tag (Junos XML protocol) 1, 2, 3
- usage guidelines 1
- abort-acknowledgement tag (Junos XML protocol) 1
- usage guidelines 1
- access
- action attribute (Junos XML protocol)
- active attribute (Junos XML with Junos XML protocol) 1
- ASCII, formatted, in Junos XML protocol
- at-time tag (Junos XML protocol) 1
- usage guidelines 1
- attributes
- Junos XML protocol tags See Index of Tag Elements and Attributes for list See names of individual attributes for usage guidelines
- in the rpc tag echoed in the rpc-reply tag 1
- Junos XML tags See Index of Tag Elements and Attributes for list See names of individual attributes for usage guidelines
- authentication
- authentication-response tag (Junos XML protocol) 1
- usage guidelines 1
B
C
- C-language Junos XML protocol client applications 1
- candidate (Junos XML protocol 'database' attribute)
- usage guidelines 1
- challenge tag (Junos XML protocol) 1, 2
- usage guidelines 1
- challenge-response tag (Junos XML protocol) 1
- usage guidelines 1
- changed attribute (Junos XML protocol)
- check tag (Junos XML protocol) 1
- child tags See tags (XML)
- clear-text (Junos XML protocol-specific access protocol) 1
- CLI
- connecting to Junos XML protocol server from 1
- client applications, sample JUNOS XML Protocol
- Perl See Perl client applications
- client applications, sample Junos XML protocol
- C-language 1
- close-configuration tag (Junos XML protocol) 1
- usage guidelines 1
- column tag (Junos XML protocol) 1, 2
- commands
- comments
- comments, in configuration statements 1
- commit tag (Junos XML protocol)
- usage guidelines 1
- commit-at tag (Junos XML protocol) 1
- commit-check tag (Junos XML protocol)
- usage guidelines
- syntax check 1
- commit-check-success tag (Junos XML protocol) 1
- commit-configuration tag (Junos XML protocol) 1
- commit-information tag (Junos XML) 1
- commit-results tag (Junos XML protocol) 1
- commit-success tag (Junos XML protocol) 1
- committed (Junos XML protocol 'database' attribute)
- usage guidelines 1
- compare tag (Junos XML) 1
- compatibility
- between Junos XML protocol server and application 1
- configuration
- adding comments
- Junos XML 1
- changing
- Junos XML protocol (overview) 1
- committing
- confirmation required (Junos XML protocol) 1
- force-synchronizing on Routing Engines (Junos XML protocol) 1
- immediately (Junos XML protocol) 1
- logging message about (Junos XML protocol) 1
- private copy (Junos XML protocol)] 1
- scheduling for later (Junos XML protocol) 1
- synchronizing on Routing Engines (Junos XML protocol) 1
- comparing with previous
- Junos XML protocol 1
- creating
- deactivating statement or identifier
- Junos XML protocol 1
- deleting
- discarding changes
- Junos XML protocol 1
- displaying
- candidate or committed (Junos XML protocol) 1
- changed elements (Junos XML protocol) 1
- entire (Junos XML protocol) 1
- group data as inherited (Junos XML protocol) 1
- hierarchy level (Junos XML protocol) 1
- identifier indicator (Junos XML protocol) 1
- identifiers (Junos XML protocol) 1
- multiple elements at once (Junos XML protocol) 1
- objects of specific type (Junos XML protocol) 1
- overview (Junos XML protocol) 1
- rescue (Junos XML protocol) 1
- rollback (Junos XML protocol) 1
- single object (Junos XML protocol) 1
- source group for inherited statements (Junos XML protocol) 1
- specified number of objects (Junos XML protocol) 1
- tags or formatted ASCII (Junos XML protocol) 1
- using regular expressions (Junos XML protocol) 1
- XML schema for 1
- groups See configuration groups
- Junos XML management protocol operations on 1
- loading
- locking, with Junos XML protocol 1
- merging current and new, with Junos XML protocol 1
- modifying, with Junos XML protocol 1
- overriding, with Junos XML protocol 1
- reactivating statement or identifier
- Junos XML protocol 1
- renaming elements, with Junos XML protocol 1
- reordering elements, with Junos XML protocol 1
- replacing
- rescue
- rolling back to previous, with Junos XML protocol 1
- statements See configuration statements
- unlocking, with Junos XML protocol 1
- verifying, with Junos XML protocol 1
- configuration groups
- configuration statements
- configuration tag (Junos XML) 1
- configuration-information tag (Junos XML)
- configuration-output tag (Junos XML)
- configuration-text tag (Junos XML)
- configure-exclusive tag (Junos XML protocol) 1
- confirm-timeout tag (Junos XML protocol) 1
- Junos XML protocol
- usage guidelines 1
- confirmed tag (Junos XML protocol) 1
- Junos XML protocol
- usage guidelines 1
- conventions
- count attribute (Junos XML with Junos XML protocol) 1
- usage guidelines 1
- curly braces, in configuration statements 1
- customer support 1
- contacting JTAC 1
D
- daemon tag (Junos XML protocol) 1
- database attribute (Junos XML protocol)
- database-status tag (Junos XML protocol) 1
- database-status-information tag (Junos XML protocol) 1
- defaults (Junos XML protocol 'inherit' attribute)
- usage guidelines 1
- delete attribute (Junos XML with Junos XML protocol) 1
- usage guidelines 1
- devices
- configuration See configuration
- display xml command
- usage guidelines 1
- Document Object Model See DOM
- document type definition See DTD
- documentation
- comments on 1
- DOM 1
- DTD
E
- echo attribute (Junos XML protocol)
- challenge tag 1
- edit-path tag (Junos XML protocol) 1, 2, 3
- encoding attribute (Junos XML protocol)
- encoding attribute (Junos XML protocol))
- <?xml?> tag 1
- end-session tag (Junos XML protocol) 1
- usage guidelines 1
- entity references, predefined (Junos XML) 1
- error messages
- from Junos XML protocol server 1
- examples, Junos XML
- mapping of configuration statement to tag
- examples, Junos XML protocol
- client applications
- committing configuration
- comparing configurations 1
- creating private copy of configuration 1
- deactivating
- deleting
- force-synchronizing configuration 1
- logging message for commit 1
- merging in new configuration element
- overriding current configuration 1
- renaming configuration elements 1
- reordering configuration elements 1
- replacing configuration elements
- requesting
- candidate configuration 1
- change indicator 1
- committed configuration 1
- configuration as formatted ASCII text 1
- identifier indicator 1
- identifiers only 1
- objects identified by regular expression 1
- one configuration object 1
- one hierarchy level 1
- previous (rollback) configuration 1
- specific number of configuration objects 1
- XML schema 1
- scheduling commit operation 1
- synchronizing configuration 1
- viewing commit log 1
- exclusive tag (Junos XML protocol) 1
F
G
- get-checksum-information tag (Junos XML protocol) 1
- get-commit-information tag (Junos XML) 1
- get-configuration tag (Junos XML protocol) 1
- get-rescue-information tag (Junos XML) 1
- get-rollback-information tag (Junos XML)
- get-xnm-information tag (Junos XML) 1
- groups See configuration groups
- groups attribute (Junos XML protocol)
H
I
J
- Junos XML API
- Junos XML management protocol
- Junos XML management protocol session
- brief overview 1
- Junos XML management protocol tags
- notational conventions 1
- Junos XML protocol command
- Junos XML protocol server 1
- Junos XML protocol session
- Junos XML protocol tag
- Junos XML tags
- commit-information tag 1
- compare tag 1
- configuration 1
- configuration tag
- attributes in 1
- configuration-information tag
- configuration-output tag
- configuration-text tag
- displaying CLI output as 1
- format tag 1
- get-commit-information tag 1
- get-rescue-information 1
- get-rollback-information tag
- get-xnm-information tag 1
- junos:comment tag 1
- mapping
- namespace tag 1
- notational conventions 1
- output tag 1
- rollback tag
- rollback-information
- displaying configuration 1
- rollback-information tag
- comparing configurations 1
- type tag 1
- undocumented tag 1
- xsd:import tag 1
- xsd:schema tag 1
- junos.xsd file 1
- JUNOS::Device module
- junos:changed attribute (Junos XML with Junos XML protocol)
- usage guidelines 1
- junos:changed attribute (Junos XML) 1
- junos:changed-localtime attribute (Junos XML) 1
- usage guidelines 1
- junos:changed-seconds attribute (Junos XML) 1
- usage guidelines 1
- junos:comment tag (Junos XML) 1
- junos:commit-localtime attribute (Junos XML) 1
- usage guidelines) 1
- junos:commit-seconds attribute (Junos XML) 1
- usage gudelines 1
- junos:commit-user attribute (Junos XML) 1
- usage guidelines 1
- junos:defaults group,
- displaying (Junos XML protocol) 1
- junos:group attribute (Junos XML with Junos XML protocol) 1
- junos:groups attribute (Junos XML with Junos XML protocol)
- usage guidelines 1
- junos:key attribute (JUNO XML with Junos XML protocol) 1
- junos:key attribute (Junos XML with Junos XML protocol)
- junos:key attribute(Junos XML protocol)
- junoscript tag 1
- junos:position attribute (JUNO XML with Junos XML protocol) 1
- junos:position attribute (Junos XML with Junos XML protocol)
- usage guidelines 1
- junos:total attribute (Junos XML with Junos XML protocol) 1
- usage guidelines 1
- junoscript tag (Junos XML protocol) 1
K
- keyword in configuration statement, Junos XML mapping 1
L
- leaf statement
- Junos XML mapping 1
- line-number tag (Junos XML protocol) 1, 2
- load-configuration tag (Junos XML protocol) 1
- attributes, usage guidelines
- usage guidelines
- load-configuration-results tag (Junos XML protocol) 1
- usage guidelines 1
- load-error-count tag (Junos XML protocol) 1
- load-success tag (Junos XML protocol) 1, 2
- usage guidelines 1
- lock-configuration tag (Junos XML protocol) 1
- usage guidelines 1
- log tag (Junos XML protocol) 1
- usage guidelines 1
- log-in tag (Junos XML protocol)
- usage guidelines 1
- login-name tag (Junos XML protocol) 1
M
N
O
- open-configuration tag (Junos XML protocol) 1
- usage guidelines 1
- operational mode, CLI
- operators, regular expression
- Junos XML protocol requests 1
- options in configuration statements, Junos XML mapping 1
- os attribute (Junos XML protocol)
- outbound-ssh tag 1
- output from Junos XML protocol server, parsing 1
- output tag (Junos XML) 1
- override (value of Junos XML protocol 'action' attribute)
- usage guidelines 1
- overview
- XML 1
P
- parentheses, in syntax descriptions 1
- parse tag (Junos XML protocol) 1
- path attribute (Junos XML protocol)
- get-checksum-information tag 1
- Perl client applications (Junos XML Protocol)
- Perl client applications (Junos XML protocol)
- pid tag (Junos XML protocol) 1
- PIs, XML See XML PIs
- predefined entity references (Junos XML) 1
- prerequisites
- Junos XML management protocol 1
- private tag (Junos XML protocol)
- usage guidelines 1
- process-disabled tag (Junos XML protocol) 1
- process-not-configured tag (Junos XML protocol) 1
- process-not-running tag (Junos XML protocol) 1
- processing instructions, XML 1
R
- re-name tag (Junos XML protocol) 1
- reason tag (Junos XML protocol) 1
- recurse attribute (Junos XML with Junos XML protocol) 1
- usage guidelines 1
- regular expression operators
- Junos XML protocol requests 1
- release attribute (Junos XML protocol)
- rename attribute (Junos XML with Junos XML protocol) 1
- replace (value of Junos XML protocol 'action' attribute)
- replace attribute (Junos XML with Junos XML protocol) 1
- usage guidelines 1
- request tags (XML) See tags (XML)
- request-end-session tag (Junos XML protocol) 1
- usage guidelines 1
- request-login tag (Junos XML protocol) 1
- usage guidelines 1
- rescue attribute (Junos XML protocol)
- rescue configuration
- displaying (Junos XML protocol) 1
- response tags (XML) See tags (XML)
- rollback attribute (Junos XML protocol)
- rollback tag (Junos XML)
- rollback-information tag (Junos XML)
- routing-engine tag (Junos XML protocol) 1, 2
- rpc tag (Junos XML protocol) 1
- usage guidelines 1
- rpc-reply tag (Junos XML protocol) 1
- usage guidelines 1
S
- SAX 1
- schema See XML schema
- schemaLocation attribute (Junos XML protocol)
- security
- Junos XML protocol session 1
- server See Junos XML protocol server
- session See Junos XML management protocol session
- Simple API for XML See SAX
- software versions
- source-daemon tag (Junos XML protocol) 1, 2
- space character in XML tag sequences 1
- ssh service
- Junos XML protocol access protocol 1
- SSH service, outbound
- Junos XML protocol access protocol 1
- SSL (Junos XML protocol access protocol) 1
- start attribute (Junos XML with Junos XML protocol) 1
- usage guidelines 1
- start-time tag (Junos XML protocol) 1
- statement tag (Junos XML protocol) 1, 2
- status tag (Junos XML protocol) 1
- usage guidelines 1
- success tag (Junos XML protocol) 1
- support, technical See technical support
- supported Junos XML protocol software versions 1
- synchronize tag (Junos XML protocol) 1
- usage guidelines 1
- syntax conventions 1
T
- tags See Junos XML tags, Junos XML management protocol tags
- tags (XML)
- TCP
- as Junos XML protocol-specific access protocol See clear-text
- technical support
- contacting JTAC 1
- Telnet
- Junos XML protocol access protocol 1
- terminal tag (Junos XML protocol) 1
- text
- token tag (Junos XML protocol) 1, 2
- type tag (Junos XML) 1
U
V
W
X
- XML
- xml (Junos XML protocol 'format' attribute)
- XML PIs
- xmlns attribute (Junos XML protocol) 1
- xmlns:junos attribute (Junos XML protocol)
- xmn:error tag (Junos XML protocol)
- usage guidelines 1
- xnm-clear-text statement
- usage guidelines 1
- xnm-ssl statement
- usage guidelines 1
- xnm:error tag (Junos XML protocol) 1
- xnm:warning tag (Junos XML protocol) 1
- usage guidelines 1
- xsd:import tag (Junos XML) 1
- xsd:schema tag (Junos XML) 1
Symbols
- <?xml?> tag (Junos XML protocol) 1
A
C
- challenge tag (Junos XML protocol) 1, 2
- challenge-response tag (Junos XML protocol) 1
- changed attribute (Junos XML protocol)
- get-configuration tag 1
- check tag (Junos XML protocol) 1
- close-configuration tag (Junos XML protocol) 1
- column tag (Junos XML protocol) 1, 2
- commit-at tag (Junos XML protocol) 1
- commit-check-success tag (Junos XML protocol) 1
- commit-configuration tag (Junos XML protocol) 1
- commit-results tag (Junos XML protocol) 1
- commit-success tag (Junos XML protocol) 1
- configure-exclusive tag (Junos XML protocol) 1
- confirm-timeout tag (Junos XML protocol) 1
- confirmed tag (Junos XML protocol) 1
- count attribute (Junos XML with Junos XML protocol) 1
D
E
F
G
H
- hostname attribute (Junos XML protocol)
- junoscript tag 1
I
J
- junos:changed attribute (Junos XML) 1
- junos:changed-localtime attribute (Junos XML) 1
- junos:changed-seconds attribute (Junos XML) 1
- junos:commit-localtime attribute (Junos XML) 1
- junos:commit-seconds attribute (Junos XML) 1
- junos:commit-user attribute (Junos XML) 1
- junos:group attribute (Junos XML with Junos XML protocol) 1
- junos:key attribute (JUNO XML with Junos XML protocol) 1
- junos:key attribute(Junos XML protocol)
- junoscript tag 1
- junos:position attribute (JUNO XML with Junos XML protocol) 1
- junos:total attribute (Junos XML with Junos XML protocol) 1
- junoscript tag (Junos XML protocol) 1
L
- line-number tag (Junos XML protocol) 1, 2
- load-configuration tag (Junos XML protocol) 1
- load-configuration-results tag (Junos XML protocol) 1
- load-error-count tag (Junos XML protocol) 1
- load-success tag (Junos XML protocol) 1, 2
- lock-configuration tag (Junos XML protocol) 1
- log tag (Junos XML protocol) 1
- login-name tag (Junos XML protocol) 1
M
N
- name tag (Junos XML protocol) 1
O
P
R
- re-name tag (Junos XML protocol) 1
- reason tag (Junos XML protocol) 1
- recurse attribute (Junos XML with Junos XML protocol) 1
- release attribute (Junos XML protocol)
- junoscript tag 1
- rename attribute (Junos XML with Junos XML protocol) 1
- replace attribute (Junos XML with Junos XML protocol) 1
- request-end-session tag (Junos XML protocol) 1
- request-login tag (Junos XML protocol) 1
- rescue attribute (Junos XML protocol)
- load-configuration tag 1
- rollback attribute (Junos XML protocol)
- load-configuration tag 1
- routing-engine tag (Junos XML protocol) 1, 2
- rpc tag (Junos XML protocol) 1
- rpc-reply tag (Junos XML protocol) 1
S
- schemaLocation attribute (Junos XML protocol)
- junoscript tag 1
- source-daemon tag (Junos XML protocol) 1, 2
- start attribute (Junos XML with Junos XML protocol) 1
- start-time tag (Junos XML protocol) 1
- statement tag (Junos XML protocol) 1, 2
- status tag (Junos XML protocol) 1
- success tag (Junos XML protocol) 1
- synchronize tag (Junos XML protocol) 1
T
U
V
X