•  SRC PE 4.10.x NETCONF API Guide
  • Copyright and Trademark Information
  • Table of Contents
  • List of Tables
  •  About the Documentation
    • SRC Documentation and Release Notes
    • Audience
    • Documentation Conventions
    • Documentation Feedback
    • Requesting Technical Support
  •  Using the SRC XML and NETCONF APIs
    •  Introduction to the SRC XML and NETCONF APIs
      •  About XML
        • XML and NETCONF Tag Elements
        • Document Type Definition
      • Advantages of Using the NETCONF and SRC XML APIs
      • NETCONF Session Overview
    •  Using NETCONF and SRC XML Tag Elements
      •  Complying with XML and NETCONF Conventions
        • 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 SRC XML Tag Elements
        • Mapping for Command Options with Variable Values
        • Mapping for Fixed-Form Command Options
      •  Mapping Configuration Statements to SRC 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
      • Using the Same Configuration Tag Elements in Requests and Responses
    •  Controlling the NETCONF Session
      • Client Application’s Role in a NETCONF Session
      •  Establishing a NETCONF Session
        • Generating Well-Formed XML Documents
        •  Prerequisites for Establishing a Connection
          • Client Application Can Access SSH Software
          • Client Application Can Log In on C Series Controllers
          •  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
        • 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
      • Request Procedure Overview
      •  Requesting Operational Information
        • Parsing the <output> Tag Element
      •  Requesting Configuration Information
        • Requesting Information from the 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
    •  Changing Configuration Information
      • Configuration Changes Overview
      • Changing the Candidate Configuration
      •  Defining the New Configuration Data
        • Providing Configuration Data in a File
        • Providing Configuration Data as a Data Stream
      • Setting the Default Mode for Incorporating New Configuration Data
      •  Replacing the Entire Candidate Configuration
        •  Replacing the Candidate Configuration with Newly Defined Data
          • Replacing the Configuration with the Contents of a File
          • Setting Replace Mode as the Default Mode
        • Replacing the Candidate Configuration with the Running 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
    •  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>
    •  Summary of Attributes in SRC XML Tags
      • operation
      • sdx:changed-localtime
      • sdx:changed-seconds
      • xmlns
  •  Index
    • Index

Symbols

<bad-element> tag (NETCONF)    

usage guidelines

<candidate/> tag (NETCONF)    

usage guidelines    

changing configuration

locking configuration

replacing entire configuration

requesting configuration

unlocking configuration

<capabilities> tag (NETCONF)    

usage guidelines

<capability> tag (NETCONF)    

usage guidelines

<close-session/> tag (NETCONF)    

usage guidelines

<commit> tag (NETCONF)    

usage guidelines    

regular commit

<config> tag (NETCONF)    

usage guidelines

<configuration> tag (SRC XML)

<copy-config> tag (NETCONF)    

usage guidelines

<data> tag (NETCONF)    

usage guidelines

<default-operation> tag (NETCONF)    

usage guidelines    

deleting configuration

general

replacing configuration

<discard-changes> tag (NETCONF)    

usage guidelines

<edit-config> tag (NETCONF)    

usage guidelines

<error-info> tag (NETCONF)    

usage guidelines

<error-message> tag (NETCONF)    

usage guidelines

<error-path> tag (NETCONF)    

usage guidelines

<error-severity> tag (NETCONF)    

usage guidelines

<filter> tag (NETCONF)    

usage guidelines

<get-config> tag (NETCONF)    

usage guidelines    

all objects of type

complete configuration

hierarchy level

identifiers only

multiple elements

overview

single object

specific children

<hello> tag (NETCONF)    

usage guidelines

<kill-session> tag (NETCONF)    

usage guidelines

<lock> tag (NETCONF)    

usage guidelines

<ok/> tag (NETCONF)    

usage guidelines

<output> tag (SRC XML)

<rpc-error> tag (NETCONF)    

usage guidelines

<rpc-reply> tag (NETCONF)    

usage guidelines

<rpc> tag (NETCONF)    

usage guidelines

<session-id> tag (NETCONF)    

usage guidelines    

initializing session

terminating session

<source> tag (NETCONF)    

usage guidelines    

replacing entire configuration

requesting configuration

<target> tag (NETCONF)    

usage guidelines    

changing configuration

locking configuration

replacing entire configuration

unlocking configuration

<unlock> tag (NETCONF)    

usage guidelines

<url> tag (NETCONF)    

usage guidelines    

changing configuration

replacing entire configuration

]]>]]> character sequence (NETCONF)    

usage guidelines

A

access    

protocols for NETCONF

attributes    

NETCONF tags    

For usage guidelines, see names of individual attributes

in <rpc> echoed in <rpc-reply>

SRC XML tags    

For usage guidelines, see names of individual attributes

authentication    

NETCONF

C

child tags (XML).     See tags (XML)    

commands    

mapping options to SRC XML tags    

fixed-form

variable-form

comments    

NETCONF and XML

compatibility    

between NETCONF server and application

configuration    

changing    

NETCONF (overview)

committing    

immediately (NETCONF)

creating    

element only if new (NETCONF)

deleting    

hierarchy level (NETCONF)

multiple values from leaf (NETCONF)

object (NETCONF)

overview (NETCONF)

single option (NETCONF)

discarding changes    

NETCONF

displaying    

candidate (NETCONF)

entire (NETCONF)

hierarchy level (NETCONF)

identifiers (NETCONF)

multiple elements at once (NETCONF)

objects of specific type (NETCONF)

overview (NETCONF)

single object (NETCONF)

specific children of object (NETCONF)

loading    

as a data stream (NETCONF)

as data in a file (NETCONF)

default mode for NETCONF

locking    

NETCONF

merging current and new    

NETCONF

modifying    

NETCONF

NETCONF operations on

replacing    

entire (NETCONF)

single element (NETCONF)

rolling back to previous    

NETCONF

statements.     See configuration statements    

unlocking    

NETCONF

verifying    

NETCONF

configuration statements    

deleting    

NETCONF

mapping to Junos XML tags    

multiple options on one line

mapping to SRC XML tags    

hierarchy level or container tag

identifiers

keywords

leaf statements

multiple values for an option

conventions    

NETCONF    

for client to comply with

notice icons

text

create (NETCONF 'operation' attribute)    1

usage guidelines

customer support    1

contacting JTAC

D

default mode for NETCONF configuration changes

delete (NETCONF 'operation' attribute)    1

usage guidelines

display xml command    

usage guidelines

Document Object Model.     See DOM    

document type definition.     See DTD    

documentation    

comments on

DOM

DTD    

defined

separate for each SRC software module

E

entity references, predefined (SRC XML)

error messages    

from NETCONF server

examples, Junos XML    

mapping of configuration statement to tag    

multiple options on multiple lines

multiple options on single line

examples, NETCONF    

creating configuration elements

deleting    

fixed-form option

hierarchy level

single configuration object

value from list of multiple values

merging in new configuration data

providing configuration data    

in a file

in a stream

replacing configuration elements

requesting    

all objects of a type

identifiers only

one configuration level

one configuration object

specific children of object

session

terminating session

examples, SRC XML    

mapping of configuration statement to tag    

hierarchy levels

identifier

leaf statement with keyword and value

leaf statement with keyword only

multiple predefined values for option

multiple user-defined values for option

Extensible Markup Language.     See XML    

I

identifiers    

SRC XML mapping

J

Junos XML tags    

mapping    

configuration, multiple multioption lines

K

keyword in configuration statement, SRC XML mapping

L

leaf statement    

SRC XML mapping

M

manuals    

comments on

N

namespaces.     See XML, namespaces    

NETCONF API    

comments, treatment of

conventions

overview

server.     See NETCONF server    

session.     See NETCONF session    

tags    

For usage guidelines, see names of individual tags

white space, treatment of

NETCONF server    

classes of responses emitted

closing connection to

connecting to

error message from

establishing session with

overview

parsing output from

sending request to

verifying compatibility with application

warning from

NETCONF session    

authentication and security

brief overview

ending

establishing

example

terminating another

NETCONF tags    

For usage guidelines, see names of individual tags

notational conventions

newline character in XML tag sequences

no-change mode (NETCONF)

notice icons

O

operation attribute (SRC XML with NETCONF)    1

usage guidelines    

creating element

deleting element

replacing element

operational mode, CLI    

SRC XML mapping    

for requests

for responses

options in configuration statements, SRC XML mapping

output from NETCONF server, parsing

P

predefined entity references (SRC XML)

prerequisites    

NETCONF API

R

replace (NETCONF 'operation' attribute)    1

usage guidelines

replace mode (NETCONF)

request tags (XML).     See tags (XML)    

response tags (XML).     See tags (XML)    

routers    

configuration.     See configuration    

S

SAX (Simple API for XML)

sdx:changed-localtime attribute (SRC XML)    

usage guidelines

sdx:changed-seconds attribute (SRC XML)    

usage guidelines

security    

NETCONF session

session, NETCONF.     See NETCONF session    

Simple API for XML.     See SAX    

software versions    

compatibility between NETCONF client and server

space character in XML tag sequences

SRC XML API    

overview

predefined entity references

tags.     See SRC XML tags    

SRC XML tags    

<configuration>    1

attributes in

<output>

displaying CLI output as

mapping    

command options, fixed-form

command options, variable

configuration, hierarchy level

configuration, identifier

configuration, multivalue leaf

configuration, single-value leaf

notational conventions

ssh service    

NETCONF access protocol

support, technical     See technical support    

T

tags (XML)    

NETCONF    

For usage guidelines, see names of individual tags

request    

children of

defined

NETCONF

SRC XML

response    

<rpc-reply> as container for

children of

defined

NETCONF

SRC XML

SRC XML     See SRC XML tags    

white space in and around

technical support    

contacting JTAC

text conventions defined

W

warning    

from NETCONF server

white space in XML tag sequences

X

XML    

namespaces    1

defined for operational response tags

overview

tags.     See tags (XML)    

xmlns attribute    

<configuration> tag    

usage guidelines

NETCONF    

usage guidelines

SRC XML operational responses    

usage guidelines