•  Junos OS 13.1 Junos XML Management Protocol Guide
  •  Copyright and Trademark Information
  •  Table of Contents
  •  List of Tables
  •   About This Guide
    •  Junos OS Documentation and Release Notes
    •  Objectives
    •  Audience
    •  Supported Platforms
    •  Using the Indexes
    •  Documentation Conventions
    •  Documentation Feedback
    •  Requesting Technical Support
  •   Overview
    •   Introduction to the Junos XML Management Protocol and Junos XML API
      •  XML and Junos OS
      •  Junos XML API and Junos XML Management Protocol Overview
      •   XML Overview
        •  Tag Elements
        •  Attributes
        •  Namespaces
        •  Document Type Definition
      •   Advantages of Using the Junos XML Management Protocol and Junos XML API
        •  Parsing Device Output
        •  Displaying Device Output
      •  Overview of a Junos XML Protocol Session
    •   Using Junos XML Management Protocol and Junos XML Tag Elements
      •   XML and Junos XML Management Protocol Conventions Overview
        •  Request and Response Tag Elements
        •  Child Tag Elements of a Request Tag Element
        •  Child Tag Elements of a Response Tag Element
        •  Spaces, Newline Characters, and Other White Space
        •  XML Comments
        •  XML Processing Instructions
        •  Predefined Entity References
      •   Mapping Commands to Junos XML Tag Elements
        •  Mapping for Command Options with Variable Values
        •  Mapping for Fixed-Form Command Options
      •   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
        •  Supported Access Protocols
        •   Prerequisites for Establishing a Connection
          •  Prerequisites for All Access Protocols
          •  Prerequisites for Clear-Text Connections
          •  Prerequisites for SSH Connections
          •  Prerequisites for Outbound SSH Connections
          •  Prerequisites for SSL Connections
          •  Prerequisites for Telnet Connections
        •   Connecting to the Junos XML Protocol Server
          •  Connecting to the Junos XML Protocol Server from the Client Application
          •  Connecting to the Junos XML Protocol Server from the CLI
        •   Starting the Junos XML Protocol Session
          •   Emitting the Initialization PI and Tag
            •  Emitting the <?xml?> PI
            •  Emitting the Opening <junoscript> Tag
          •   Parsing the Initialization PI and Tag from the Junos XML Protocol Server
            •  Parsing the Junos XML Protocol Server’s <?xml?> PI
            •  Parsing the Junos XML Protocol Server’s Opening <junoscript> Tag
          •  Verifying Software Compatibility
          •  Supported Software Versions
        •   Authenticating with the Junos XML Protocol Server
          •   Submitting an Authentication Request
            •  Providing the Password with the Username
            •  Providing Only the Username
          •   Interpreting the Authentication Response
            •  Server Response When Authentication Succeeds
            •  Server Response When Authentication Fails
      •   Exchanging Information with the Junos XML Protocol Server
        •   Sending a Request to the Junos XML Protocol Server
          •   Request Classes
            •  Operational Requests
            •  Configuration Information Requests
            •  Configuration Change Requests
          •  Including Attributes in the Opening <rpc> Tag
        •   Parsing the Junos XML Protocol Server Response
          •  xmlns:junos Attribute
          •   Junos XML Protocol Server Response Classes
            •  Operational Responses
            •  Configuration Information Responses
            •  Configuration Change Responses
          •  Using a Standard API to Parse Response Tag Elements
        •  Handling an Error or Warning
        •  Halting a Request
      •   Locking and Unlocking the Candidate Configuration or Creating a Private Copy
        •  Locking the Candidate Configuration
        •  Unlocking the Candidate Configuration
        •  Terminating Another Junos XML Protocol Session
        •  Creating a Private Copy of the Configuration
      •  Ending a Junos XML Protocol Session and Closing the Connection
      •  Displaying CLI Output as XML Tag Elements
      •  Displaying the RPC Tags for a Command
      •   Example of a Junos XML Protocol Session
        •  Exchanging Initialization PIs and Tag Elements
        •  Sending an Operational Request
        •  Locking the Configuration
        •  Changing the Configuration
        •  Committing the Configuration
        •  Unlocking the Configuration
        •  Closing the Junos XML Protocol Session
    •   Requesting Information
      •  Overview of the Request Procedure
      •  Requesting Operational Information
      •  Specifying the Output Format for Operational Information Requests in a Junos XML Protocol Session
      •  Requesting Configuration Information
      •   Specifying the Source and Output Format of Configuration Information
        •  Requesting Information from the Committed or Candidate Configuration
        •  Requesting Output as Formatted ASCII Text or Junos XML Tag Elements
        •  Requesting an Indicator for Identifiers
        •  Requesting a Change Indicator for Configuration Elements
        •  Displaying Commit-Script-Style XML Data
        •   Specifying the Output Format for Configuration Groups and Interface Ranges
          •  Specifying Whether Configuration Groups and Interface Ranges Are Displayed Separately
          •  Displaying the Source Group for Inherited Configuration Elements
          •  Examples: Specifying Output Format for Configuration Groups
          •  Displaying the Source Interface Range for Inherited Configuration Elements
        •  Comparing Configuration Changes with a Prior Version
      •   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
        •  Creating the junos.xsd File
        •  Example: Requesting an XML Schema
      •  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
        •  Providing Configuration Data in a File
        •  Providing Configuration Data as a Data Stream
        •  Defining the Configuration Data Format
      •   Replacing the Entire Configuration
        •  Replacing the Configuration with New Data
        •  Rolling Back to a Previous or Rescue Configuration
      •   Creating, Modifying, or Deleting Configuration Elements
        •  Merging Configuration Elements
        •  Replacing Configuration Elements
        •  Creating New Configuration Elements
        •  Replacing Configuration Elements Only If They Have Changed
        •   Deleting Configuration Elements
          •  Deleting a Hierarchy Level or Container Object
          •  Deleting a Configuration Object That Has an Identifier
          •  Deleting a Single-Value or Fixed-Form Option from a Configuration Object
          •  Deleting Values from a Multivalue Option of a Configuration Object
      •  Reordering Elements in Configuration Objects
      •  Renaming a Configuration Object
      •  Protecting or Unprotecting a Configuration Object
      •   Changing a Configuration Element’s Activation State
        •  Deactivating a Newly Created Element
        •  Deactivating or Reactivating an Existing Element
      •   Changing a Configuration Element’s Activation State Simultaneously with Other Changes
        •   Replacing an Element and Setting Its Activation State
          •  Using Junos XML Tag Elements for the Replacement Element
          •  Using Formatted ASCII Text for the Replacement Element
        •  Reordering an Element and Setting Its Activation State
        •  Renaming an Object and Setting Its Activation State
        •  Example: Replacing an Object and Deactivating It
    •   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
        •   Synchronizing the Configuration on Both Routing Engines
          •  Example: Synchronizing the Configuration on Both Routing Engines
        •   Forcing a Synchronized Commit Operation
          •  Example: Forcing a Synchronization
        •   Synchronizing Configurations Simultaneously with Other Operations
          •  Verifying the Configuration on Both Routing Engines
          •  Scheduling Synchronization for a Specified Time
          •  Synchronizing Configurations but Requiring Confirmation
          •  Logging a Message About Synchronized Configurations
      •  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>
      •  <kill-session>
      •  <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
      •  active
      •  count
      •  delete
      •  inactive
      •  insert
      •  junos:changed
      •  junos:changed-localtime
      •  junos:changed-seconds
      •  junos:commit-localtime
      •  junos:commit-seconds
      •  junos:commit-user
      •  junos:group
      •  junos:interface-range
      •  junos:key
      •  junos:position
      •  junos:total
      •  matching
      •  protect
      •  recurse
      •  rename
      •  replace
      •  start
      •  unprotect
      •  xmlns
  •   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
      •   Installing the Junos XML Protocol Perl Client and Prerequisites Package
        •  Verifying Installation and Version of Perl
        •  Extracting the Junos XML Protocol Perl Client and Sample Scripts
        •  Extracting and Installing the Junos XML Protocol Perl Client Prerequisites Package
        •  Installing the Junos XML Protocol Perl Client
      •   Tutorial: Writing Perl Client Applications
        •  Import Perl Modules and Declare Constants
        •   Connect to the Junos XML Protocol Server
          •  Satisfying Protocol Prerequisites
          •  Group Requests
          •   Obtain and Record Parameters Required by the JUNOS::Device Object
            •  Example: Collecting Parameters Interactively
          •  Obtaining Application-Specific Parameters
          •  Converting Disallowed Characters
          •  Establishing the Connection
        •   Submitting a Request to the Junos XML Protocol Server
          •  Providing Method Options or Attributes
          •  Submitting a Request
          •  Example: Getting an Inventory of Hardware Components
          •   Example: Loading Configuration Statements
            •  Handling Error Conditions
            •  Locking the Configuration
            •  Reading In and Parsing the Configuration Data
            •  Loading the Configuration Data
            •  Committing the Configuration
        •   Parsing and Formatting the Response from the Junos XML Protocol Server
          •  Parsing and Formatting an Operational Response
          •  Parsing and Outputting Configuration Data
        •  Closing the Connection to the Junos XML Protocol Server
      •  Mapping CLI Commands to Perl Methods
    •   Writing Junos XML Protocol C Client Applications
      •  Establishing a Junos XML Protocol Session
      •  Accessing and Editing Device Configurations
  •   Index
    •  Index
    •  Index of Statements and Commands

Symbols

#, comments in configuration statements

$    

regular expression operator    

Junos XML protocol requests

( ), in syntax descriptions

*    

regular expression operator    

Junos XML protocol requests

+    

regular expression operator    

Junos XML protocol requests

. (period)    

regular expression operator    

Junos XML protocol requests

< >, in syntax descriptions

<?xml?> tag (Junos XML protocol)    1

usage guidelines    

client

server

<checksum-information> (Junos XML protocol)

<checksum> attribute    

<checksum-information> tag

<computation-method> attribute    

<checksum-information> tag

<file-checksum> attribute    

<checksum-information> tag

<input-file> attribute    

<checksum-information> tag

?    

regular expression operator    

Junos XML protocol requests

[ ], in configuration statements

^    

regular expression operator    

Junos XML protocol requests

{ }, in configuration statements

| (pipe)    

regular expression operator    

Junos XML protocol requests

| (pipe), in syntax descriptions

A

abort tag (Junos XML protocol)    1

usage guidelines

abort-acknowledgement tag (Junos XML protocol)    1

usage guidelines

access    

protocols for Junos XML management protocol    

prerequisites for all

protocols for Junos XML protocol    

clear-text

SSH

SSH, outbound

SSL

Telnet

action attribute (Junos XML protocol)    

load-configuration tag

usage guidelines    

merging configuration

overwriting configuration

replacing configuration

updating configuration

active attribute (Junos XML with Junos XML protocol)    1

usage guidelines    

general

when renaming element

when reordering element

when replacing element

ASCII, formatted, in Junos XML protocol    

loading configuration as

requesting configuration as

at-time tag (Junos XML protocol)    1

usage guidelines

attributes    

Junos XML protocol tags    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

Junos XML tags     See Index of Tag Elements and Attributes for list     See names of individual attributes for usage guidelines    

authentication    

Junos XML protocol    

overview

procedures

authentication-response tag (Junos XML protocol)    1

usage guidelines

B

braces, in configuration statements

brackets    

angle, in syntax descriptions

square, in configuration statements

C

C-language Junos XML protocol client applications

candidate (Junos XML protocol 'database' attribute)    

usage guidelines

challenge tag (Junos XML protocol)    1, 2

usage guidelines

challenge-response tag (Junos XML protocol)    1

usage guidelines

changed attribute (Junos XML protocol)    

get-configuration tag

usage guidelines

check tag (Junos XML protocol)

child tags     See tags (XML)    

clear-text (Junos XML protocol-specific access protocol)

CLI    

connecting to Junos XML protocol server from

client applications, sample JUNOS XML Protocol    

Perl     See Perl client applications    

client applications, sample Junos XML protocol    

C-language

close-configuration tag (Junos XML protocol)    1

usage guidelines

column tag (Junos XML protocol)    1, 2

command output    

RPC, displaying    1, 2

commands    

Junos XML equivalents

Junos XML protocol     See Junos XML protocol command    

mapping options to Junos XML tags    

fixed-form

variable-form

comments    

about configuration, Junos XML mapping

Junos XML management protocol and XML

comments, in configuration statements

commit tag (Junos XML protocol)    

usage guidelines

commit-at tag (Junos XML protocol)

commit-check tag (Junos XML protocol)    

usage guidelines    

syntax check

commit-check-success tag (Junos XML protocol)    1

usage guidelines    

scheduled commit

synchronized commit

commit-configuration tag (Junos XML protocol)    1

usage guidelines    

commit of private copy

confirmed commit

immediate commit

logged commit

scheduled commit

synchronized commit

syntax check

commit-information tag (Junos XML)

commit-results tag (Junos XML protocol)    1

usage guidelines    

commit of private copy

confirmed commit

immediate commit

logged commit

scheduled commit

synchronized commit

syntax check

commit-scripts attribute (Junos XML protocol)    

get-configuration tag

usage guidelines

commit-success tag (Junos XML protocol)    1

usage guidelines    

commit of private copy

confirmed commit

immediate commit

logged commit

synchronized commit

committed (Junos XML protocol 'database' attribute)    

usage guidelines

compare attribute (Junos XML protocol)    

get-configuration tag

usage guidelines

compare tag (Junos XML)

comparing    

configurations

compatibility    

between Junos XML protocol server and application

configuration    

adding comments    

Junos XML

changing    

Junos XML protocol (overview)

committing    

confirmation required (Junos XML protocol)

force-synchronizing on Routing Engines (Junos XML protocol)

immediately (Junos XML protocol)

logging message about (Junos XML protocol)

private copy (Junos XML protocol)]

scheduling for later (Junos XML protocol)

synchronizing on Routing Engines (Junos XML protocol)

comparing to prior version

comparing with previous    

Junos XML protocol

creating    

new elements (Junos XML protocol)

private copy (Junos XML protocol)

deactivating statement or identifier    

Junos XML protocol

deleting    

hierarchy level (Junos XML protocol)

multiple values from leaf (Junos XML protocol)

object (Junos XML protocol)

overview (Junos XML protocol)

single option (Junos XML protocol)

discarding changes    

Junos XML protocol

displaying    

candidate or committed (Junos XML protocol)

changed elements (Junos XML protocol)

commit-scripts-style XML (Junos XML protocol)

comparison(Junos XML protocol)

entire (Junos XML protocol)

group data as inherited (Junos XML protocol)

hierarchy level (Junos XML protocol)

identifier indicator (Junos XML protocol)

identifiers (Junos XML protocol)

interface-range data as inherited (Junos XML protocol)

multiple elements at once (Junos XML protocol)

objects of specific type (Junos XML protocol)

overview (Junos XML protocol)

rescue (Junos XML protocol)

rollback (Junos XML protocol)

single object (Junos XML protocol)

source group for inherited statements (Junos XML protocol)

source interface range for inherited statements (Junos XML protocol)

specified number of objects (Junos XML protocol)

tags or formatted ASCII (Junos XML protocol)

using regular expressions (Junos XML protocol)

XML schema for

groups     See configuration groups    

interface ranges     See interface ranges    

Junos XML management protocol operations on

loading    

as a data stream (Junos XML protocol)

as data in a file (Junos XML protocol)

as text, tags, or commands (Junos XML protocol)

locking, with Junos XML protocol

merging current and new, with Junos XML protocol

modifying, with Junos XML protocol

overriding, with Junos XML protocol

protecting elements, with Junos XML protocol

reactivating statement or identifier    

Junos XML protocol

renaming elements, with Junos XML protocol

reordering elements, with Junos XML protocol

replacing    

entire (Junos XML protocol)

only changed elements (Junos XML protocol)

single element (Junos XML protocol)

rescue    

displaying (Junos XML protocol)

reverting to (Junos XML protocol)

rolling back to previous, with Junos XML protocol

statements     See configuration statements    

unlocking, with Junos XML protocol

unprotecting elements, with Junos XML protocol

verifying, with Junos XML protocol

configuration groups    

displaying    

as inheritance source (Junos XML protocol)

as inherited or separately (Junos XML protocol)

configuration mode commands, in Junos XML protocol    

loading configuration as

configuration statements    

adding comments about    

Junos XML

deactivating    

Junos XML protocol

mapping to Junos XML tags    

comments

hierarchy level or container tag

identifiers

keywords

leaf statements

multiple options on one line

multiple values for an option

reactivating    

Junos XML protocol

configuration tag (Junos XML)    1

configuration data to load

configuration-information tag (Junos XML)    

comparing configurations

displaying configuration

configuration-output tag (Junos XML)    

comparing configurations

displaying configuration

configuration-set tag (Junos XML)    

configuration data to load

configuration-text tag (Junos XML)    

configuration data to load

Junos XML protocol server response

configure-exclusive tag (Junos XML protocol)

confirm-timeout tag (Junos XML protocol)    1

Junos XML protocol    

usage guidelines

confirmed tag (Junos XML protocol)    1

Junos XML protocol    

usage guidelines

conventions    

Junos XML management protocol    

for client to comply with

text and syntax

count attribute (Junos XML with Junos XML protocol)    1

usage guidelines

curly braces, in configuration statements

customer support    1

contacting JTAC

D

daemon tag (Junos XML protocol)

database attribute (Junos XML protocol)    

get-configuration tag

usage guidelines

database-status tag (Junos XML protocol)

database-status-information tag (Junos XML protocol)

defaults (Junos XML protocol 'inherit' attribute)    

usage guidelines

delete attribute (Junos XML with Junos XML protocol)    1

usage guidelines

devices    

configuration     See configuration    

display xml command    

usage guidelines    1, 2

display xml filter    1, 2

display xml rpc command    

usage guidelines

Document Object Model     See DOM    

document type definition     See DTD    

documentation    

comments on

DOM

DTD    

defined

separate for each Junos OS module

E

echo attribute (Junos XML protocol)    

challenge tag

edit-path tag (Junos XML protocol)    1, 2, 3

encoding attribute (Junos XML protocol)    

usage guidelines    

client

server

encoding attribute (Junos XML protocol))    

<?xml?> tag

end-session tag (Junos XML protocol)    1

usage guidelines

entity references, predefined (Junos XML)

error messages    

from Junos XML protocol server

examples, Junos XML    

mapping of configuration statement to tag    

comments in configuration

hierarchy levels

identifier

leaf statement with keyword and value

leaf statement with keyword only

multiple options on multiple lines

multiple options on single line

multiple predefined values for option

multiple user-defined values for option

examples, Junos XML protocol    

client applications    

C language

Perl

committing configuration    

at scheduled time

confirmation required

force-synchronizing on Routing Engines

synchronizing on Routing Engines

comparing configurations

creating private copy of configuration

deactivating    

level of configuration hierarchy

single object using formatted ASCII

single object using Junos XML tags

deleting    

fixed-form option

level of configuration hierarchy

single configuration object

value from list of multiple values

force-synchronizing configuration

logging message for commit

merging in new configuration element    

using configuration mode commands

using formatted ASCII

using Junos XML tags

overriding current configuration

renaming configuration elements

reordering configuration elements

replacing configuration elements    

only those that have changed

using formatted ASCII

using Junos XML tags

requesting    

candidate configuration

change indicator

committed configuration

configuration as formatted ASCII text

identifier indicator

identifiers only

objects identified by regular expression

one configuration object

one hierarchy level

previous (rollback) configuration

specific number of configuration objects

XML schema

scheduling commit operation

synchronizing configuration

viewing commit log

exclusive tag (Junos XML protocol)

F

fail tag (Junos XML protocol)

false (Junos XML protocol 'recurse' attribute)    

usage guidelines

filename tag (Junos XML protocol)    1, 2

files    

junos.xsd

font conventions

force-synchronize tag (Junos XML protocol)    1

usage guidelines

format attribute (Junos XML protocol)    

get-configuration tag    1

usage guidelines

load-configuration tag    1

usage guidelines

format tag (Junos XML)

G

get-checksum-information tag (Junos XML protocol)

get-commit-information tag (Junos XML)

get-configuration tag (Junos XML protocol)    1

attributes, usage guidelines    

changed

commit-scripts

compare

database

format

groups

inherit

overview

usage guidelines for requesting    

all objects of type

complete configuration

hierarchy level

identifiers only

multiple elements

single object

specified number of objects

using regular expression

get-rescue-information tag (Junos XML)

get-rollback-information tag (Junos XML)    

comparing previous configurations

displaying previous configuration

get-xnm-information tag (Junos XML)

groups     See configuration groups    

groups attribute (Junos XML protocol)    

get-configuration tag

usage guidelines

H

hostname attribute (Junos XML protocol)    

junoscript tag

usage guidelines    

client

server

I

icons defined, notice

identifiers    

Junos XML mapping

idle-time tag (Junos XML protocol)

inactive attribute (Junos XML with Junos XML protocol)    1

usage guidelines for setting    

on existing element

on new element

when renaming element

when reordering element

when replacing element

inherit attribute (Junos XML protocol)    

get-configuration tag

usage guidelines

insert attribute (Junos XML with Junos XML protocol)    1

usage guidelines    

general

when changing activation state

interface ranges    1

displaying    

as inheritance source (Junos XML protocol)

as inherited or separately (Junos XML protocol)

interface-range attribute (Junos XML protocol)    

usage guidelines

interface-ranges attribute (Junos XML protocol)    

get-configuration tag

J

Junos OS    

XML

Junos XML API    

advantages of

overview

predefined entity references

tags Junos XML tags     See Junos XML tags    

Junos XML management protocol    

advantages of

comments, treatment of

conventions

overview

software versions supported

white space, treatment of

Junos XML management protocol session    

brief overview

Junos XML management protocol tags    

notational conventions

Junos XML protocol command    

issued by client application

issued in CLI operational mode

JUNOS XML protocol Perl client    

downloading

extracting

Junos XML protocol server    1

classes of responses emitted

closing connection to

connecting to    1

from CLI

directing to halt operation

error message from

establishing session with

parsing output from

sending request to

verifying compatibility with application

warning from

Junos XML protocol session    

authentication and security    

overview

procedures

ending

establishing

example

terminating another

Junos XML protocol tag    

usage guidelines    

client

junos:key attribute

server

Junos XML tags    

commit-information tag

compare tag

configuration

configuration tag    

attributes in

configuration-information tag    

comparing configurations

displaying configuration

configuration-output tag    

comparing configurations

displaying configuration

configuration-text tag    

Junos XML protocol server response

displaying CLI output as    1, 2

format tag

get-commit-information tag

get-rescue-information

get-rollback-information tag    

comparing previous configurations

displaying previous configuration

get-xnm-information tag

junos:comment tag

loading configuration as

mapping    

command options, fixed-form

command options, variable

configuration, comments

configuration, hierarchy level

configuration, identifier

configuration, multiple multi-option lines

configuration, multivalue leaf

configuration, single-value leaf

namespace tag

notational conventions

output tag

rollback tag    

comparing configurations

displaying configuration

rollback-information    

displaying configuration

rollback-information tag    

comparing configurations

type tag

undocumented tag

xsd:import tag

xsd:schema tag

junos.xsd file

JUNOS::Device module    

about

downloading

junos:changed attribute (Junos XML with Junos XML protocol)    

usage guidelines

junos:changed attribute (Junos XML)

junos:changed-localtime attribute (Junos XML)    1

usage guidelines

junos:changed-seconds attribute (Junos XML)    1

usage guidelines

junos:comment tag (Junos XML)

junos:commit-localtime attribute (Junos XML)    1

usage guidelines)

junos:commit-seconds attribute (Junos XML)    1

usage gudelines

junos:commit-user attribute (Junos XML)    1

usage guidelines

junos:defaults group,    

displaying (Junos XML protocol)

junos:group attribute (Junos XML with Junos XML protocol)

junos:groups attribute (Junos XML with Junos XML protocol)    

usage guidelines

junos:interface-range attribute (Junos XML with Junos XML protocol)    1

usage guidelines

junos:key attribute (JUNO XML with Junos XML protocol)

junos:key attribute (Junos XML with Junos XML protocol)    

usage

usage guidelines

junos:key attribute(Junos XML protocol)    

junoscript tag

junos:position attribute (JUNO XML with Junos XML protocol)

junos:position attribute (Junos XML with Junos XML protocol)    

usage guidelines

junos:total attribute (Junos XML with Junos XML protocol)    1

usage guidelines

junoscript tag (Junos XML protocol)

K

keyword in configuration statement, Junos XML mapping

kill-session tag (Junos XML protocol)    1

usage guidelines

L

leaf statement    

Junos XML mapping

line-number tag (Junos XML protocol)    1, 2

load-configuration tag (Junos XML protocol)    1

attributes, usage guidelines    

action="merge"

action="override"

action="replace"

action="update"

format

rescue

rollback

url

usage guidelines    

data provided as stream

data provided as text, tags, or commands

data provided in file

merging configuration

overriding configuration

replacing configuration

reverting to previous or rescue configuration

updating configuration

load-configuration-results tag (Junos XML protocol)    1

usage guidelines

load-error-count tag (Junos XML protocol)    1

usage guidelines    

changing configuration

commit of private copy

load-success tag (Junos XML protocol)    1, 2

usage guidelines

lock-configuration tag (Junos XML protocol)    1

usage guidelines

log tag (Junos XML protocol)    1

usage guidelines

log-in tag (Junos XML protocol)    

usage guidelines

login-name tag (Junos XML protocol)

M

manuals    

comments on

matching attribute (Junos XML with Junos XML protocol)    1

usage guidelines

merge (value of Junos XML protocol 'action' attribute)    

usage guidelines

message tag (Junos XML protocol)    1, 2, 3

in authentication response    

usage guidelines

N

name tag (Junos XML protocol)    1

usage guidelines    

commit of private copy

confirmed commit

immediate commit

logged commit

scheduled commit

synchronized commit    1, 2

syntax check

namespace tag (Junos XML)

namespaces     See XML namespaces    

newline character in XML tag sequences

notice icons defined

O

open-configuration tag (Junos XML protocol)    1

usage guidelines

operational mode, CLI    

Junos XML mapping    

for requests

for responses

operational request    

format

operators, regular expression    

Junos XML protocol requests

options in configuration statements, Junos XML mapping

os attribute (Junos XML protocol)    

junoscript tag

usage guidelines

outbound-ssh tag

output from Junos XML protocol server, parsing

output tag (Junos XML)

override (value of Junos XML protocol 'action' attribute)    

usage guidelines

overview    

XML

P

parentheses, in syntax descriptions

parse tag (Junos XML protocol)

path attribute (Junos XML protocol)    

get-checksum-information tag

Perl client applications (Junos XML Protocol)    

installing

overview

prerequisite modules

Perl client applications (Junos XML protocol)    

installing

tutorial

pid tag (Junos XML protocol)

PIs, XML     See XML PIs    

predefined entity references (Junos XML)

prerequisites    

Junos XML management protocol

private tag (Junos XML protocol)    

usage guidelines

process-disabled tag (Junos XML protocol)

process-not-configured tag (Junos XML protocol)

process-not-running tag (Junos XML protocol)

processing instructions, XML

protect attribute (Junos XML with Junos XML protocol)    1

usage guidelines    

general

R

re-name tag (Junos XML protocol)

reason tag (Junos XML protocol)

recurse attribute (Junos XML with Junos XML protocol)    1

usage guidelines

regular expression operators    

Junos XML protocol requests

release attribute (Junos XML protocol)    

junoscript tag

usage guidelines    

client

server

rename attribute (Junos XML with Junos XML protocol)    1

usage guidelines    

general

when changing activation state

replace (value of Junos XML protocol 'action' attribute)    

usage guidelines    

general

when changing activation state

replace attribute (Junos XML with Junos XML protocol)    1

usage guidelines

request tags (XML)     See tags (XML)    

request-end-session tag (Junos XML protocol)    1

usage guidelines

request-login tag (Junos XML protocol)    1

usage guidelines

rescue attribute (Junos XML protocol)    

load-configuration tag

usage guidelines

rescue configuration    

displaying (Junos XML protocol)

response tags (XML)     See tags (XML)    

rollback attribute (Junos XML protocol)    

load-configuration tag

usage guidelines

rollback tag (Junos XML)    

comparing configurations

displaying configuration

rollback-information tag (Junos XML)    

comparing configurations

displaying configuration

routing-engine tag (Junos XML protocol)    1, 2

usage guidelines    

commit of private copy

confirmed commit

immediate commit

logged commit

scheduled commit

synchronized commit

syntax check

RPC    

displaying command output in    1, 2

rpc tag (Junos XML protocol)    1

usage guidelines

rpc-error tag (Junos XML protocol)

rpc-reply tag (Junos XML protocol)    1

usage guidelines

S

SAX

schema     See XML schema    

schemaLocation attribute (Junos XML protocol)    

junoscript tag

usage guidelines

security    

Junos XML protocol session

server     See Junos XML protocol server    

session     See Junos XML management protocol session    

session-id tag (Junos XML protocol)    

terminating session    1

usage guidelines

Simple API for XML     See SAX    

software versions    

compatibility between Junos XML protocol client and server

supported by Junos XML management protocol

source-daemon tag (Junos XML protocol)    1, 2

space character in XML tag sequences

ssh service    

Junos XML protocol access protocol

SSH service, outbound    

Junos XML protocol access protocol

SSL (Junos XML protocol access protocol)

start attribute (Junos XML with Junos XML protocol)    1

usage guidelines

start-time tag (Junos XML protocol)

statement tag (Junos XML protocol)    1, 2

status tag (Junos XML protocol)    1

usage guidelines

success tag (Junos XML protocol)

support, technical     See technical support    

supported Junos XML protocol software versions

synchronize tag (Junos XML protocol)    1

usage guidelines

syntax conventions

T

tags     See Junos XML tags, Junos XML management protocol tags    

tags (XML)    

Junos XML

Junos XML management protocol

request    

children of

defined

Junos XML    1, 2

Junos XML protocol

response    

children of

defined

Junos XML

Junos XML protocol

rpc-reply as container for

white space in and around

TCP    

as Junos XML protocol-specific access protocol     See clear-text    

technical support    

contacting JTAC

Telnet    

Junos XML protocol access protocol

terminal tag (Junos XML protocol)

text    

formatted ASCII in Junos XML protocol    

loading configuration as

requesting configuration as

token tag (Junos XML protocol)    1, 2

type tag (Junos XML)

U

undocumented tag (Junos XML)

unlock-configuration tag (Junos XML protocol)    1

usage guidelines

unprotect attribute (Junos XML with Junos XML protocol)    1

usage guidelines    

general

update (value of Junos XML protocol 'action' attribute)    

usage guidelines

url attribute (Junos XML protocol)    

load-configuration tag

usage guidelines

user tag (Junos XML protocol)

username tag (Junos XML protocol)    1

usage guidelines

V

version attribute (Junos XML protocol)    

<?xml?> tag    1

usage guidelines for client

usage guidelines for server

Junos XML protocol tag    

usage guidelines for client

usage guidelines for server

junoscript tag

W

warning    

from Junos XML protocol server

white space in XML tag sequences

X

XML    

attributes     See Junos XML tags, Junos XML management protocol tags    

namespaces    1, namespaces     See Junos XML tags, Junos XML management protocol tags    

defined by Junos XML protocol tag

defined by xmlns:junos attribute

overview

PIs     See XML PIs    

schema, requesting

tags     See Junos XML tags, Junos XML management protocol tags    

xml (Junos XML protocol 'format' attribute)    

get-configuration tag    

usage guidelines

load-configuration tag    

usage guidelines

XML PIs    

<?xml?> tag (Junos XML protocol)    

usage guidelines for client

usage guidelines for server

usage guidelines

xmlns attribute (Junos XML protocol)    1

configuration tag    

usage guidelines

junoscript tag

usage guidelines

xmlns:junos attribute (Junos XML protocol)    

Junos XML protocol tag    

usage guidelines

junoscript tag

rpc-reply tag    1

usage guidelines

xmn:error tag (Junos XML protocol)    

usage guidelines

xnm-clear-text statement    

usage guidelines

xnm-ssl statement    

usage guidelines

xnm:error tag (Junos XML protocol)

xnm:warning tag (Junos XML protocol)    1

usage guidelines

xsd:import tag (Junos XML)

xsd:schema tag (Junos XML)