Juniper JUNOS OS 10.3 - XML MANAGEMENT PROTOCOL GUIDE 6-30-2010 Manual page 10

Junos 10.3 Junos XML Management Protocol Guide
Part 2
Chapter 3
x
Mapping for Multiple Options on One or More Lines . . . . . . . . . . . . . . . . . . . . 19
Mapping for Comments About Configuration Statements . . . . . . . . . . . . . . . 20
Using the Same Configuration Tag Elements in Requests and Responses . . . . . . 21
Using the Junos XML Management Protocol
Controlling the Junos XML Management Protocol Session . . . . . . . . . . . . . 25
Client Application's Role in a Junos XML Protocol Session . . . . . . . . . . . . . . . . . . 25
Establishing a Junos XML Management Protocol Session . . . . . . . . . . . . . . . . . . . 26
Supported Access Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Prerequisites for Establishing a Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Prerequisites for All Access Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Prerequisites for Clear-Text Connections . . . . . . . . . . . . . . . . . . . . . . . . . 29
Prerequisites for SSH Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Prerequisites for Outbound SSH Connections . . . . . . . . . . . . . . . . . . . . . 31
Prerequisites for SSL Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Prerequisites for Telnet Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Connecting to the Junos XML Protocol Server . . . . . . . . . . . . . . . . . . . . . . . . . 37
Connecting to the Junos XML Protocol Server from the Client
Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Connecting to the Junos XML Protocol Server from the CLI . . . . . . . . . . 38
Starting the Junos XML Protocol Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Emitting the Initialization PI and Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Parsing the Initialization PI and Tag from the Junos XML Protocol
Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Verifying Software Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Supported Software Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Authenticating with the Junos XML Protocol Server . . . . . . . . . . . . . . . . . . . . 43
Submitting an Authentication Request . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Interpreting the Authentication Response . . . . . . . . . . . . . . . . . . . . . . . . 45
Exchanging Information with the Junos XML Protocol Server . . . . . . . . . . . . . . . . 45
Sending a Request to the Junos XML Protocol Server . . . . . . . . . . . . . . . . . . 46
Request Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Including Attributes in the Opening <rpc> Tag . . . . . . . . . . . . . . . . . . . . 48
Parsing the Junos XML Protocol Server Response . . . . . . . . . . . . . . . . . . . . . 48
xmlns:junos Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Junos XML Protocol Server Response Classes . . . . . . . . . . . . . . . . . . . . . 49
Using a Standard API to Parse Response Tag Elements . . . . . . . . . . . . . 50
Handling an Error or Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Halting a Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Locking and Unlocking the Candidate Configuration or Creating a Private
Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Locking the Candidate Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Unlocking the Candidate Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Creating a Private Copy of the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Ending a Junos XML Protocol Session and Closing the Connection . . . . . . . . . . . 55
Displaying CLI Output as XML Tag Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Copyright © 2010, Juniper Networks, Inc.