Symbols
- <bad-element> tag (NETCONF)
- <candidate/> tag (NETCONF)
- <capabilities> tag (NETCONF)
- <capability> tag (NETCONF)
- <close-session/> tag (NETCONF)
- <commit> tag (NETCONF)
- usage guidelines
- <config> tag (NETCONF)
- <configuration> tag (SRC XML)
- <copy-config> tag (NETCONF)
- <data> tag (NETCONF)
- <default-operation> tag (NETCONF)
- usage guidelines
- <discard-changes> tag (NETCONF)
- <edit-config> tag (NETCONF)
- <error-info> tag (NETCONF)
- <error-message> tag (NETCONF)
- <error-path> tag (NETCONF)
- <error-severity> tag (NETCONF)
- <filter> tag (NETCONF)
- <get-config> tag (NETCONF)
- <hello> tag (NETCONF)
- <kill-session> tag (NETCONF)
- <lock> tag (NETCONF)
- <ok/> tag (NETCONF)
- <output> tag (SRC XML)
- <rpc-error> tag (NETCONF)
- <rpc-reply> tag (NETCONF)
- <rpc> tag (NETCONF)
- <session-id> tag (NETCONF)
- usage guidelines
- <source> tag (NETCONF)
- usage guidelines
- <target> tag (NETCONF)
- <unlock> tag (NETCONF)
- <url> tag (NETCONF)
- usage guidelines
- ]]>]]> character sequence (NETCONF)
A
- access
- attributes
- authentication
C
- child tags (XML). See tags (XML)
- commands
- mapping options to SRC XML tags
- comments
- compatibility
- configuration
- changing
- committing
- creating
- deleting
- discarding changes
- displaying
- loading
- locking
- merging current and new
- modifying
- NETCONF operations on
- replacing
- rolling back to previous
- statements. See configuration statements
- unlocking
- verifying
- configuration statements
- deleting
- mapping to Junos XML tags
- mapping to SRC XML tags
- conventions
- create (NETCONF 'operation' attribute) 1
- customer support 1
D
- default mode for NETCONF configuration changes
- delete (NETCONF 'operation' attribute) 1
- display xml command
- Document Object Model. See DOM
- document type definition. See DTD
- documentation
- DOM
- DTD
E
- entity references, predefined (SRC XML)
- error messages
- examples, Junos XML
- mapping of configuration statement to tag
- examples, NETCONF
- creating configuration elements
- deleting
- merging in new configuration data
- providing configuration data
- replacing configuration elements
- requesting
- session
- terminating session
- examples, SRC XML
- Extensible Markup Language. See XML
I
- identifiers
J
- Junos XML tags
K
L
- leaf statement
M
- manuals
N
- namespaces. See XML, namespaces
- NETCONF API
- comments, treatment of
- conventions
- overview
- server. See NETCONF server
- session. See NETCONF session
- tags
- white space, treatment of
- NETCONF server
- NETCONF session
- NETCONF tags
- newline character in XML tag sequences
- no-change mode (NETCONF)
- notice icons
O
- operation attribute (SRC XML with NETCONF) 1
- usage guidelines
- operational mode, CLI
- SRC XML mapping
- options in configuration statements, SRC XML mapping
- output from NETCONF server, parsing
P
- predefined entity references (SRC XML)
- prerequisites
R
- replace (NETCONF 'operation' attribute) 1
- 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)
- sdx:changed-seconds attribute (SRC XML)
- security
- session, NETCONF. See NETCONF session
- Simple API for XML. See SAX
- software versions
- space character in XML tag sequences
- SRC XML API
- overview
- predefined entity references
- tags. See SRC XML tags
- SRC XML tags
- ssh service
- support, technical See technical support
T
- tags (XML)
- NETCONF
- request
- response
- SRC XML See SRC XML tags
- white space in and around
- technical support
- text conventions defined
W
X
Download This Guide
Introduction to the SRC XML and NETCONF APIs
The NETCONF API (application programming interface) is an Extensible Markup Language (XML) application that client applications use to request and change configuration information on a C Series Controller that runs the SRC software. The operations defined in the API are equivalent to configuration mode commands in the SRC command-line interface (CLI). Applications use the API to display, edit, and commit configuration statements (among other operations), just as administrators use CLI configuration mode commands such as show, set, and commit to perform those operations.
The SRC XML API is an XML representation of SRC CLI configuration statements and operational mode commands. SRC XML configuration tag elements are the content to which the operations in the NETCONF API apply. SRC XML operational tag elements are equivalent in function to operational mode commands in the CLI, which administrators use to retrieve and change status information for a C Series Controller.
The NETCONF API is described in RFC 4741, NETCONF Configuration Protocol, available at http://www.ietf.org/rfc/rfc4741.txt.
Client applications request or change information on the C Series Controller by encoding the request with tag elements from the NETCONF and SRC XML APIs and sending it to the NETCONF server on the C Series Controller. (The NETCONF server is integrated into the SRC software and does not appear as a separate entry in process listings.) The NETCONF server directs the request to the appropriate software modules within the C Series Controller, encodes the response in NETCONF and SRC XML tag elements, and returns the result to the client application. For example, to request information about the status of a C Series Controller’s interfaces, a client application sends the <get-interfaces> tag element from the SRC XML API. The NETCONF server gathers the information from the interface process and returns it in the <output> tag element.
This manual explains how to use the NETCONF and SRC XML APIs to configure Juniper Networks C Series Controllers or request information about configuration or operation. The main focus is on writing client applications to interact with the NETCONF server, but you can also use the NETCONF API to build custom end-user interfaces for configuration and information retrieval and display, such as a Web browser–based interface.
This chapter includes the following topics:
