Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

TechLibrary

Documentation Quick Links

Compliance Advisor

Documentation Archives

Documentation Help

Enterprise MIBs

Feature Explorer

Hardware Compatibility Tool

Junos XML API Explorer

Portable Libraries

SNMP MIB Explorer

System Log Explorer

Navigation

Table of Contents

NETCONF XML Management Protocol Developer Guide

This guide describes how to use the NETCONF XML management protocol and the Junos XML API to configure or request information from the NETCONF server on a device running Junos OS.

Junos OS, Release 13.2

Overview
Installation
Configuration
Administration
Troubleshooting

NETCONF XML Management Protocol Overview

NETCONF XML Management Protocol and Junos XML API Overview

Advantages of Using the NETCONF XML Management Protocol and Junos XML API

Overview of a NETCONF XML Management Protocol Session

Using NETCONF and Junos XML Tags

XML and Junos OS

XML and NETCONF XML Management Protocol Conventions Overview

Mapping Commands to Junos XML Tag Elements

Mapping Configuration Statements to Junos XML Tag Elements

Using NETCONF Configuration Response Tag Elements in NETCONF Requests and Configuration Changes

NETCONF Session Overview

Understanding the Client Application’s Role in a NETCONF Session

NETCONF Session Overview

Generating Well-Formed XML Documents

Understanding the Request Procedure in a NETCONF Session

NETCONF Perl Client Overview
Understanding the NETCONF Perl Distribution and Sample Scripts

Related Documentation

NETCONF Java Toolkit Guide

NETCONF XML Management Protocol Overview

NETCONF XML Management Protocol and Junos XML API Overview

Advantages of Using the NETCONF XML Management Protocol and Junos XML API

Overview of a NETCONF XML Management Protocol Session

Using NETCONF and Junos XML Tags

XML and Junos OS

XML and NETCONF XML Management Protocol Conventions Overview

Mapping Commands to Junos XML Tag Elements

Mapping Configuration Statements to Junos XML Tag Elements

Using NETCONF Configuration Response Tag Elements in NETCONF Requests and Configuration Changes

NETCONF Session Overview

Understanding the Client Application’s Role in a NETCONF Session

NETCONF Session Overview

Generating Well-Formed XML Documents

Understanding the Request Procedure in a NETCONF Session

NETCONF Perl Client Overview
Understanding the NETCONF Perl Distribution and Sample Scripts

Installation
NETCONF Perl Client
Downloading the NETCONF Perl Client and Prerequisites Package
Installing the NETCONF Perl Client and Prerequisites Package
NETCONF Java Toolkit
Downloading and Installing the NETCONF Java Toolkit

Configuring NETCONF Tracing Operations
Example: Configuring NETCONF Tracing Operations

Controlling the NETCONF Session

Establishing an SSH Connection for a NETCONF Session

Connecting to the NETCONF Server

Starting the NETCONF Session

Sending a Request to the NETCONF Server

Parsing the NETCONF Server Response

Using a Standard API to Parse Response Tag Elements

Handling an Error or Warning in a NETCONF Session

Locking and Unlocking the Candidate Configuration Using NETCONF

Terminating a NETCONF Session

Ending a NETCONF Session and Closing the Connection

Sample NETCONF Session

Changing Configuration Information

Editing the Candidate Configuration Using NETCONF

Uploading and Formatting Configuration Data in a NETCONF Session

Setting the Edit Configuration Mode in a NETCONF Session

Handling Errors While Editing the Candidate Configuration in a NETCONF Session

Replacing the Candidate Configuration Using NETCONF

Rolling Back a Configuration Using NETCONF

Deleting the Candidate Configuration Using NETCONF

Changing Individual Configuration Elements Using NETCONF

Merging Configuration Elements Using NETCONF

Creating Configuration Elements Using NETCONF

Deleting Configuration Elements Using NETCONF

Replacing Configuration Elements Using NETCONF

Committing the Configuration

Verifying the Configuration Syntax Using NETCONF

Committing the Candidate Configuration Using NETCONF

Committing the Candidate Configuration Only After Confirmation Using NETCONF

Summary of NETCONF Configuration Statements

connection-limit

port (NETCONF Server)

traceoptions (NETCONF)

Summary of NETCONF Protocol Operations

<close-session/>

<delete-config>

<discard-changes/>

Summary of NETCONF Request and Response Tags

Summary of Junos XML Protocol Elements Supported in NETCONF Sessions

<abort-acknowledgement/>

<checksum-information>

<close-configuration/>

<commit-configuration>

<commit-results>

<database-status>

<database-status-information>

<get-checksum-information>

<get-configuration>

<load-configuration>

<load-configuration-results>

<lock-configuration/>

<open-configuration>

<request-end-session/>

<routing-engine>

<unlock-configuration/>

Summary of Junos XML Protocol Element Attributes Supported in NETCONF Sessions

junos:changed-localtime

junos:changed-seconds

junos:commit-localtime

junos:commit-seconds

junos:commit-user

Requesting Operational Information

Requesting Operational Information Using NETCONF

Specifying the Output Format for Operational Information Requests in a NETCONF Session

Requesting Configuration Information

Requesting Configuration Information Using NETCONF

Requesting Committed or Candidate Configuration Information Using NETCONF

Specifying the Scope of Configuration Information to Return in a NETCONF Response

Requesting the Complete Configuration Using NETCONF

Requesting a Configuration Hierarchy Level or Container Object Without an Identifier Using NETCONF

Requesting All Configuration Objects of a Specified Type Using NETCONF

Requesting Identifiers for Configuration Objects of a Specified Type Using NETCONF

Requesting A Specific Configuration Object Using NETCONF

Requesting Specific Child Tags for a Configuration Object Using NETCONF

Requesting Multiple Configuration Elements Simultaneously Using NETCONF

Requesting a Previous (Rollback) Configuration Using NETCONF

Comparing Two Previous (Rollback) Configurations Using NETCONF

Requesting the Rescue Configuration Using NETCONF

Requesting an XML Schema for the Configuration Hierarchy Using NETCONF

Writing NETCONF Perl Client Applications

Writing Perl Client Applications

Importing Perl Modules and Declaring Constants in NETCONF Perl Client Applications

Connecting to the NETCONF Server in NETCONF Perl Client Applications

Collecting Parameters Interactively in NETCONF Perl Client Applications

Submitting a Request to the NETCONF Server in NETCONF Perl Client Applications

Example: Requesting an Inventory of Hardware Components Using a NETCONF Perl Client Application

Example: Changing the Configuration Using a NETCONF Perl Client Application

Parsing and Formatting the Response from the NETCONF Server in NETCONF Perl Client Applications

Closing the Connection to the NETCONF Server in NETCONF Perl Client Applications

Troubleshooting
Knowledge Base
http://kb.juniper.net/

Supported Platforms

Downloads

Related Documentation

NETCONF Java Toolkit Guide

Previous Page Next Page