•  Junos 10.3 NETCONF XML Management Protocol Guide
  •  Copyright and Trademark Information
  •  Table of Contents
  •  List of Tables
  •   About This Guide
    •  Junos Documentation and Release Notes
    •  Objectives
    •  Audience
    •  Supported Platforms
    •  Using the Indexes
    •  Documentation Conventions
    •  Documentation Feedback
    •  Requesting Technical Support
  •   Overview
    •   Introduction to the NETCONF XML Management Protocol and Junos XML API
      •  NETCONF XML Management Protocol and Junos XML API Overview
      •   XML Overview
        •  Junos XML and NETCONF XML Management Protocol Tag Elements
        •  Document Type Definition
      •  Advantages of Using the NETCONF XML Managment Protocol and Junos XML API
      •  Overview of a NETCONF XML Management Protocol Session
    •   Using NETCONF XML Management Protocol and Junos XML Tag Elements
      •   XML and NETCONF 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
        •  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 NETCONF XML Management Protocol
    •   Controlling the NETCONF Session
      •  Client Application’s Role in a NETCONF Session
      •   Establishing a NETCONF Session
        •  Generating Well-Formed XML Documents
        •   Prerequisites for Establishing an SSH Connection
          •   Establishing an SSH Connection
            •  SSH Software Is Installed on the Configuration Management Server
            •  Client Application Can Log In on Devices Running Junos OS
            •   Junos Login Account Has Public/Private Key Pair or Password
              •  Creating a Text-Based Password
              •  Creating a Public/Private Key Pair
            •  Client Application Can Access the Keys or Password
            •  NETCONF Service over SSH Is Enabled
          •   Establishing an Outbound SSH Connection
            •  Configuring the Device Running Junos OS for Outbound SSH
            •  Installing SSH Software on the Client
            •  Receiving and Managing the Outbound SSH Initiation Sequence on the Client
            •  Enabling NETCONF Service over SSH
        •  Connecting to the NETCONF Server
        •   Starting the NETCONF Session
          •  Exchanging <hello> Tag Elements
          •  Verifying Compatibility
      •   Exchanging Information with the NETCONF Server
        •   Sending a Request to the NETCONF Server
          •   Request Classes
            •  Operational Requests
            •  Configuration Information Requests
            •  Configuration Change Requests
          •  Including Attributes in the Opening <rpc> Tag
        •   Parsing the NETCONF Server Response
          •   NETCONF 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
      •   Locking and Unlocking the Candidate Configuration
        •  Locking the Candidate Configuration
        •  Unlocking the Candidate Configuration
      •  Terminating Another NETCONF Session
      •  Ending a NETCONF Session and Closing the Connection
      •  Displaying CLI Output as XML Tag Elements
      •   Example of a NETCONF Session
        •  Exchanging Initialization Tag Elements
        •  Sending an Operational Request
        •  Locking the Configuration
        •  Changing the Configuration
        •  Committing the Configuration
        •  Unlocking the Configuration
        •  Closing the NETCONF Session
    •   Requesting Information
      •  Overview of the Request Procedure
      •   Requesting Operational Information
        •  Parsing the <output> Tag Element
      •   Requesting Configuration Information
        •  Requesting Information from the Committed or Candidate Configuration
        •   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 Identifiers for Configuration Objects of a Specified Type
          •  Requesting One Configuration Object
          •  Requesting Specific Child Tags for a Configuration Object
          •  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
      •   Editing the Candidate Configuration
        •   Formatting the Configuration Data
          •   Delivery Mechanism: Data Files Versus Streaming Data
            •  Referencing Configuration Data Files
            •  Streaming Configuration Data
          •  Data Format: Junos XML versus CLI Configuration Statements
        •   Setting the Edit Configuration Mode
          •  Specifying the merge Data Mode
          •  Specifying the replace Data Mode
          •  Specifying the no-change Data Mode
        •  Handling Errors
      •   Replacing the Candidate Configuration
        •  Using <copy-config>
        •  Using <edit-config>
      •  Rolling Back a Configuration
      •  Deleting the Candidate Configuration
      •   Changing Individual Configuration Elements
        •  Merging Configuration Elements
        •  Replacing Configuration Elements
        •  Creating New Configuration Elements
        •   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
    •   Committing Configurations
      •  Verifying a Configuration Before Committing It
      •   Committing a Configuration
        •  Committing the Candidate Configuration
        •  Committing the Candidate Configuration Only After Confirmation
    •   Summary of NETCONF Tag Elements
      •  ]]>]]>
      •  <close-session/>
      •  <commit>
      •  <copy-config>
      •  <data>
      •  <delete-config>
      •  <discard-changes/>
      •  <edit-config>
      •  <error-info>
      •  <get-config>
      •  <hello>
      •  <kill-session>
      •  <lock>
      •  <ok/>
      •  <rpc>
      •  <rpc-error>
      •  <rpc-reply>
      •  <target>
      •  <unlock>
      •  <validate>
    •   Summary of Attributes in Junos XML Tags
      •  junos:changed-localtime
      •  junos:changed-seconds
      •  junos:commit-localtime
      •  junos:commit-seconds
      •  junos:commit-user
      •  operation
      •  xmlns
  •   Writing NETCONF Client Applications
    •   Writing NETCONF Perl Client Applications
      •  Overview of the NETCONF::Netconf::Manager Perl Module and Sample Scripts
      •  Download the NET::Netconf Module and Sample Scripts
      •   Tutorial: Writing Perl Client Applications
        •  Import Perl Modules and Declare Constants
        •   Connect to the NETCONF Server
          •  Satisfy Protocol Prerequisites
          •  Group Requests
          •   Obtain and Record Parameters Required by the NET::Netconf::Manager Object
            •  Example: Collect Parameters Interactively
          •  Obtain Application-Specific Parameters
          •  Establishing the Connection
        •   Submitting a Request to the NETCONF Server
          •  Providing Method Options or Attributes
          •  Submitting a Request
          •  Example: Get an Inventory of Hardware Components
          •   Example: Edit Configuration Statements
            •  Handling Error Conditions
            •  Locking the Configuration
            •  Reading In the Configuration Data
            •  Editing the Configuration Data
            •  Committing the Configuration
        •   Parsing and Formatting the Response from the NETCONF Server
          •  Parsing and Formatting an Operational Response
        •  Closing the Connection to the NETCONF Server
  •   Index
    •  Index
    •  Index of Statements and Commands

Symbols

#, comments in configuration statements    1

( ), in syntax descriptions    1

< >, in syntax descriptions    1

[ ], in configuration statements    1

]]>]]> character sequence (NETCONF)    1

usage guidelines    1

{ }, in configuration statements    1

| (pipe), in syntax descriptions    1

A

access    

protocols for NETCONF    1

attributes    

in the rpc tag echoed in rpc-reply    1

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

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

authentication    

NETCONF    1

B

bad-element tag (NETCONF)    1

usage guidelines    1

braces, in configuration statements    1

brackets    

angle, in syntax descriptions    1

square, in configuration statements    1

C

candidate tag (NETCONF)    1

locking configuration    

usage guidelines    1

replacing entire configuration    

usage guidelines    1

requesting configuration    

usage guidelines    1

requesting information    1

unlocking configuration    

usage guidelines    1

validating configuration    1

usage guidelines    1

capabilities tag (NETCONF)    1

usage guidelines    1

capability tag (NETCONF)    1

usage guidelines    1

child tags (XML)     See tags (XML)    

CLI configuration data    

in configuration statements    1

client applications    

NETCONF See NETCONF client applications    1

close-session tag (NETCONF)    1

usage guidelines    1

commands    

mapping options to Junos XML tags    

fixed-form    1

variable-form    1

comments    

about configuration, Junos XML mapping    1

NETCONF and XML    1

comments, in configuration statements    1

commit tag (NETCONF)    1

usage guidelines    

confirmed commit    1

regular commit    1

compare tag (Junos XML)    1

compatibility    

between NETCONF server and application    1

config tag (NETCONF)    1

usage guidelines    1

configuration    

adding comments    

Junos XML    1

committing    

confirmation required (NETCONF)    1

immediately (NETCONF)    1

comparing with previous    

NETCONF    1

creating    

element only if new (NETCONF)    1

deleting    

hierarchy level (NETCONF)    1

multiple values from leaf (NETCONF)    1

object (NETCONF)    1

overview (NETCONF)    1

single option (NETCONF)    1

deleting candidate    1

discarding changes    

NETCONF    1

displaying    

candidate or committed (NETCONF)    1

entire (NETCONF)    1

hierarchy level (NETCONF)    1

identifiers (NETCONF)    1

multiple elements at once (NETCONF)    1

objects of specific type (NETCONF)    1

overview (NETCONF)    1

rescue (NETCONF)    1

rollback (NETCONF)    1

single object (NETCONF)    1

specific children of object (NETCONF)    1

XML schema for    1

editing    

individual elements    1

loading    

as a data stream (NETCONF)    1

as data in a file (NETCONF)    1

default mode for NETCONF    1

locking (NETCONF)    1

merge data mode    1

merging current and new (NETCONF)    1

modifying (NETCONF)    1

NETCONF operations on    1

no-change data mode    1

replace data mode    1

replacing    

entire (NETCONF)    1

single element (NETCONF)    1

rescue    

displaying (NETCONF)    1

rolling back to previous    

NETCONF    1

statements     See configuration statements    

unlocking (NETCONF)    1

verifying (NETCONF)    1

configuration data    

data files    1

data format    

CLI configuration data    1

Junos XML    1

streaming data    1

configuration statements    

adding comments about    

Junos XML    1

deleting (NETCONF)    1

mapping to Junos XML tags    

comments    1

hierarchy level or container tag    1

identifiers    1

keywords    1

leaf statements    1

multiple options on one line    1

multiple values for an option    1

configuration tag (Junos XML)    1

configuration tag (NETCONF)    1

requesting information    1

configuration-information tag (Junos XML)    

comparing configurations    1

displaying configuration    1

configuration-output tag (Junos XML)    

comparing configurations    1

displaying configuration    1

confirm-timeout (NETCONF)    1

confirmed tag (NETCONF)    1

usage guidelines    1

confirmed-timeout tag (NETCONF)    

usage guidelines    1

conventions    

for client to comply with    1

text and syntax    1

copy-config tag (NETCONF)    1

usage guidelines    1, 2

create (NETCONF 'operation' attribute)    

usage guidelines    1

curly braces, in configuration statements    1

customer support    1

contacting JTAC    1

D

data files    

configuration data    1

referencing configuration data    1

data tag (NETCONF)    1

usage guidelines    1

default mode for NETCONF configuration changes    1

default-operation tag (NETCONF)    1

usage guidelines    

deleting configuration    1

general    1

replacing configuration    1

delete (NETCONF 'operation' attribute)    

usage guidelines    1

delete-config tag    1

devices    

configuration     See configuration    

discard tag (NETCONF)    

usage guidelines    1

discard-changes tag    1

discard-changes tag (NETCONF)    

changing configuration    1

display xml command    

usage guidelines    1

Document Object Model     See DOM    

document type definition     See DTD    

documentation    

comments on    1

DOM    1

DTD    

defined    1

separate for each Junos OS module    1

E

edit-config tag (NETCONF)    1

usage guidelines    1

entity references, predefined (Junos XML)    1

error messages    

from NETCONF server    1

specifying handling during configuration changes    1

error-info tag (NETCONF)    1

usage guidelines    1

error-message tag (NETCONF)    1

usage guidelines    1

error-option tag (NETCONF)    

usage guidelines    1

error-path tag (NETCONF)    1

usage guidelines    1

error-severity tag (NETCONF)    1

usage guidelines    1

examples, Junos XML    

mapping of configuration statement to tag    

comments in configuration    1

hierarchy levels    1

identifier    1

leaf statement with keyword and value    1

leaf statement with keyword only    1

multiple options on multiple lines    1

multiple options on single line    1

multiple predefined values for option    1

multiple user-defined values for option    1

examples, NETCONF    

committing with confirmation    1

comparing rollback configurations    1

creating configuration elements    1

deleting    

fixed-form option    1

single configuration object    1

value from list of multiple values    1

merging in new configuration data    1

providing configuration data    

in a stream    1

replacing configuration elements    1

requesting    

all objects of a type    1

one configuration level    1

previous (rollback) configuration    1

XML schema    1

session    1

terminating session    1

F

files    

junos.xsd    1

filter tag (NETCONF)    

requesting information    1

usage guidelines    1

font conventions    1

format tag (Junos XML)    1

G

get-config tag (NETCONF)    1

usage guidelines    

all objects of type    1

complete configuration    1

hierarchy level    1

identifiers only    1

multiple elements    1

overview    1

single object    1

specific children    1

get-rescue-information tag (Junos XML)    1

get-rollback-information tag (Junos XML)    

comparing previous configurations    1

displaying previous configuration tag    1

get-xnm-information tag (Junos XML)    1

H

hello tag (NETCONF)    1

usage guidelines    1

I

icons defined, notice    1

identifiers    

Junos XML mapping    1

J

Junos XML    

in configuration statements    1

Junos XML API    

advantages of    1

overview    1

predefined entity references    1

tags     See Junos XML tags    

Junos XML tags    

compare tag    1

configuration    1

attributes used    1

configuration-information tag    

comparing configurations    1

displaying configuration    1

configuration-output tag    

comparing configurations    1

displaying configuration    1

displaying CLI output as    1

format tag    1

get-rescue-information tag    1

get-rollback-information tag    

comparing previous configurations    1

displaying previous configuration    1

get-xnm-information    1

junos:comment tag    1

mapping    

command options, fixed-form    1

command options, variable    1

configuration, comments    1

configuration, hierarchy level    1

configuration, identifier    1

configuration, multiple multi-option lines    1

configuration, multivalue leaf    1

configuration, single-value leaf    1

namespace    1

notational conventions    1

output tag    1

rollback tag    

comparing configurations    1

displaying configuration    1

rollback-information tag    

comparing configurations    1

displaying configuration    1

type    1

undocumented    1

xsd:import    1

xsd:schema    1

junos.xsd file    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 guidelines    1

junos:commit-user attribute (Junos XML)    1

usage guidelines    1

K

keyword in configuration statement, Junos XML mapping    1

kill-session tag (NETCONF)    1

usage guidelines    1

L

leaf statement    

Junos XML mapping    1

lock tag (NETCONF)    1

usage guidelines    1

M

manuals    

comments on    1

merge data mode    

configuration changes    1

N

namespace tag (Junos XML)    1

namespaces     See XML, namespaces    

NET::Netconf module    

about    

NET::Netconf module    1

Net::Netconf module    

downloading    

Net::Netconf module    1

NETCONF client applications    

overview    1

NETCONF server    

classes of responses emitted    1

closing connection to    1

connecting to    1

error message from    1

establishing session with    1

overview    1

parsing output from    1

sending request to    1

verifying compatibility with application    1

warning from    1

NETCONF session    

authentication and security    1

ending    1

establishing    1

example    1

terminating another    1

NETCONF tags    

notational conventions    1

NETCONF XML management protocol    

advantages of    1

comments, treatment of    1

conventions    1

overview    1

server     See NETCONF XML protocol server    

tags    1

white space, treatment of    1

NETCONF XML management protocol session    

brief overview    1

newline character in XML tag sequences    1

no-change data mode    

configuration changes    1

no-change mode (NETCONF)    1

notice icons defined    1

O

ok tag (NETCONF)    1

usage guidelines    1

operation attribute (Junos XML)    1

usage guidelines    

creating element    1

deleting element    1

replacing element    1

operational mode, CLI    

Junos XML mapping    

for requests    1

for responses    1

options in configuration statements, Junos XML mapping    1

outbound SSH    1,  See also SSH service    

configuring device    1

enabling SSH on device    1

initialization sequence    1

installing ssh client    1

NETCONF access protocol    1

prerequisites    1

output from NETCONF server, parsing    1

output tag (Junos XML)    1

overview    

XML    1

P

parentheses, in syntax descriptions    1

passwords, text-based    

SSH service    1

Perl client applications    

tutorial    1

PKI key pair    

SSH service    1

predefined entity references (Junos XML)    1

prerequisites    

NETCONF XML management protocol    1

R

replace (NETCONF 'operation' attribute)    

usage guidelines    1

replace data mode    

configuration changes    1

request tags (XML)     See tags (XML)    

rescue configuration    

displaying (NETCONF)    1

response tags (XML)     See tags (XML)    

rollback tag (Junos XML)    

comparing configurations    1

displaying configuration    1

rollback-information tag (Junos XML)    

comparing configurations    1

displaying configuration    1

rpc tag (NETCONF)    1

usage guidelines    1

rpc-error tag (NETCONF)    1, 2

usage guidelines    1

rpc-reply tag    

NETCONF    

usage guidelines    1

rpc-reply tag (NETCONF)    1

running tag (NETCONF)    

requesting information    1

usage guidelines    1

S

SAX    1

schema     See XML schema    

security    

NETCONF session    1

session     See NETCONF XML management protocol session    

session-id tag (NETCONF)    

initializing session    1

usage guidelines    1

terminating session    1

usage guidelines    1

Simple API for XML     See SAX    

software versions    

compatibility between NETCONF client and server    1

source tag (NETCONF)    

replacing entire configuration    1

usage guidelines    1

requesting configuration    

usage guidelines    1

requesting information    1

validating configuration    1

usage guidelines    1

space character in XML tag sequences    1

SSH service    

client software    1

connecting to device    1

enabling on device    1

logging in    1

NETCONF access protocol    1

passwords, text-based    1

PKI key pair    1

prerequisites    1

streaming data    

configuration data    1

referencing configuration data    1

support, technical     See technical support    

syntax conventions    1

T

tags     See Junos XML tags, NETCONF tags    

tags (XML)    

Junos XML    1

NETCONF    1

request    

children of    1

defined    1

Junos XML    1

NETCONF    1

response    

children of    1

defined    1

Junos XML    1

NETCONF    1

rpc-reply as container for    1

white space in and around    1

target tag (NETCONF)    1, 2

usage guidelines    

locking configuration    1

replacing entire configuration    1

unlocking configuration    1

technical support    

contacting JTAC    1

type tag (Junos XML)    1

U

undocumented tag (Junos XML)    1

unlock tag (NETCONF)    1

usage guidelines    1

url tag (NETCONF)    

changing configuration    

usage guidelines    1

replacing entire configuration    1

usage guidelines    1

V

validate tag (NETCONF)    1

usage guidelines    1

W

warning    

from NETCONF server    1

white space in XML tag sequences    1

X

XML    

namespaces    1

defined for operational response tags    1

overview    1

schema, requesting    1

tags     See Junos XML tags, NETCONF tags    

xmlns attribute    1

configuration tag    

usage guidelines    1

Junos XML operational responses    

usage guidelines    1

NETCONF    

usage guidelines    1

xsd:import tag (Junos XML)    1

xsd:schema tag (Junos XML)    1

Symbols

]]>]]> character sequence (NETCONF)    1

B

bad-element tag (NETCONF)    1

C

candidate tag (NETCONF)    1

requesting information    1

validating configuration    1

capabilities tag (NETCONF)    1

capability tag (NETCONF)    1

close-session tag (NETCONF)    1

commit tag (NETCONF)    1

config tag (NETCONF)    1

configuration tag (NETCONF)    1

requesting information    1

confirm-timeout (NETCONF)    1

confirmed tag (NETCONF)    1

copy-config tag (NETCONF)    1

D

data tag (NETCONF)    1

default-operation tag (NETCONF)    1

delete-config tag    1

discard-changes tag    1

E

edit-config tag (NETCONF)    1

error-info tag (NETCONF)    1

error-message tag (NETCONF)    1

error-path tag (NETCONF)    1

error-severity tag (NETCONF)    1

F

filter tag (NETCONF)    

requesting information    1

G

get-config tag (NETCONF)    1

H

hello tag (NETCONF)    1

K

kill-session tag (NETCONF)    1

L

lock tag (NETCONF)    1

O

ok tag (NETCONF)    1

R

rpc tag (NETCONF)    1

rpc-error tag (NETCONF)    1, 2

rpc-reply tag (NETCONF)    1

running tag (NETCONF)    

requesting information    1

S

session-id tag (NETCONF)    

initializing session    1

terminating session    1

source tag (NETCONF)    

replacing entire configuration    1

requesting information    1

validating configuration    1

T

target tag (NETCONF)    1, 2

U

unlock tag (NETCONF)    1

url tag (NETCONF)    

replacing entire configuration    1

V

validate tag (NETCONF)    1