Cisco CRS-1 - Carrier Routing System Router Api Manual page 35

Chapter 2 Cisco CRS-1 Series XML Router Configuration and Management
each commit. If a commit operation is performed with a KeepFailedConfig value of false, the user
can then use the <Load> operation to load the failed configuration back into the target configuration
buffer. The use of the KeepFailedConfig attribute makes sense only for the BestEffort commit mode.
In the case of an Atomic commit, if something fails, the entire target configuration is kept intact
(because nothing was committed).
• Label—Use the Label attribute instead of the commit identifier wherever a commit identifier is
expected, such as in the <Rollback> operation. The Label attribute is a unique user-specified label
that is associated with the commit in the Cisco CRS-1 Series commit database. If specified, the label
must begin with an alphabetic character and cannot match any existing label in the Cisco CRS-1
Series commit database.
Comment—Use the Comment attribute as a user-specified comment to be associated with the
•
commit in the Cisco CRS-1 Series router commit database.
If the commit operation is successful, the response will contain just the <Commit/> tag along with any
attributes specified in the request. if the commit operation fails, the failed configuration will be returned
in the response.
The following example shows a request to commit the target configuration using the Atomic option and
specifies that any failed configuration be retained in the target buffer. This request corresponds to the
CLI command commit atomic.
Sample XML Client Request to Commit the Target Configuration Using the Atomic Option
<?xml version="1.0" encoding="UTF-8"?>
<Request MajorVersion="1" MinorVersion="0">
<Commit Mode="Atomic" Label="BGPUpdate1" Comment="BGP config update"/>
</Request>
Sample XML Response from the Cisco CRS-1 Series Router
<?xml version="1.0" encoding="UTF-8"?>
<Response MajorVersion="1" MinorVersion="0">
<Commit Mode="Atomic" Label="BGPUpdate1" Comment="BGP config update"/>
</Response>
The following should be noted with regard to committing the target configuration:
Tip
After each successful commit operation, a commit record is created in the Cisco CRS-1 Series router
•
commit database. The Cisco CRS-1 Series router maintains up to 20 entries in the commit database
corresponding to the last 20 commits. Each commit is assigned a unique identifier, for example,
"1000000075," which is saved with the commit information in the database. The commit identifier
is used in subsequent operations such as <Get> commit changes or <Rollback> to a previous commit
identifier (along with the <CommitID> tag).
• The configuration changes in the target configuration are merged with the running configuration
when committed. If a client application is to perform a replace of the configuration, the client must
first remove the unwanted configuration using a <Delete> operation and then add the new
configuration using a <Set> operation. An explicit replace option is not supported. For more
information on replacing the configuration, see
Applying the configuration for a trial period ("try-and-apply") is not be supported for this release.
•
If the client application never commits, the target configuration will be automatically destroyed
•
when the client session is terminated. No other timeouts are supported.
OL-4596-01
"Replacing the Current Running
Cisco CRS-1 Series Carrier Routing System XML API Guide
Configuration Operations
Configuration".
2-35