Locking The Running Configuration; Browsing The Target Or Running Configuration - Cisco CRS-1 - Carrier Routing System Router Api Manual

Chapter 2 Cisco CRS-1 Series XML Router Configuration and Management
•
•
Each of these options are described in a separate section at the end of this chapter.

Locking the Running Configuration

The client application uses the <Lock> operation to obtain an exclusive lock on the running
configuration in order to prevent modification by other users or applications.
If the lock operation is successful, the response will contain just the <Lock/> tag. If the lock operation
fails, the response will also contain ErrorCode and ErrorMsg attributes indicating the cause of the lock
failure.
The following example shows a request to lock the running configuration. This request corresponds to
the command-line interface (CLI) command configure exclusive.
Sample XML Request from the Client Application
<?xml version="1.0" encoding="UTF-8"?>
<Request MajorVersion="1" MinorVersion="0">
<Lock/>
</Request>
Sample XML Response from the Cisco CRS-1 Series Router
<?xml version="1.0" encoding="UTF-8"?>
<Response MajorVersion="1" MinorVersion="0">
<Lock/>
</Response>
The following should be noted with regard to locking the running configuration:
•
•
•
•
•
•
•

Browsing the Target or Running Configuration

The client application browses the target or current running configuration using the <Get> operation
along with the <Configuration> request type tag. The client application optionally uses CLI commands
encoded within XML tags to browse the configuration.
The <Configuration> tag supports the optional Source attribute, which is used to specify the source of
the configuration information returned from a <Get> operation.
OL-4596-01
"Getting Configuration Session Information"
"Replacing the Current Running Configuration"
The scope of the lock is the entire configuration "namespace."
Only one client application can hold the lock on the running configuration at a time. If a client
application attempts to lock the configuration while another application holds the lock, an error will
be returned.
If a client application has locked the running configuration, all other client applications can only
read the running configuration, but cannot modify it (that is, they cannot commit changes to it).
No mechanism is currently provided to allow a client application to break the lock of another user.
If a client session is terminated, any outstanding locks will be automatically released.
The Cisco CRS-1 Series XML API does not currently support timeouts for locks.
The <GetConfigurationSessions> operation can be used to identify the user session currently
holding the lock.
Cisco CRS-1 Series Carrier Routing System XML API Guide
Configuration Operations
2-27