SRC–PE 3.1.0 NETCONF API Guide DVD Home Techpubs Home Report an Error Collapse TOC List of Figures List of Tables Index Entire manual as PDF		About This Guide SRC Guides and Release Notes Audience Documentation Conventions Related Juniper Networks Documentation Obtaining Documentation Documentation Feedback Requesting Technical Support 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 Overview of a NETCONF Session 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 Overview of the Request Procedure 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 Overview of Configuration Changes 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