About the Cisco CIMC XML API
The Cisco Integrated Management Controller (CIMC) XML API is a programmatic interface to the CIMC for the Cisco UCS E-Series Servers (E-Series Servers) and Cisco UCS E-Series Network Compute Engine (NCE). The API accepts XML documents through HTTP or HTTPS. Developers can use any programming language to generate XML documents that contain the API methods. Configuration and state information for CIMC is stored in a hierarchical tree structure known as the management information tree, which is completely accessible through the XML API.
The Cisco CIMC XML API implements a subset of the methods and management information model available in the Cisco UCS Manager XML API. The behavior of both APIs is similar in syntax and semantics, and you can use the same client development tools and techniques for both. The scope of the Cisco CIMC XML API is limited to a single E-Series Server or NCE, in contrast to the Cisco UCS Manager XML API, which controls an entire UCS environment consisting of switches, FEX modules, servers, and other devices.
Using the Cisco CIMC XML API, the user has programmatic access to CIMC to configure, administer, and monitor the server. The API provides the same functions that are accessible through the CIMC CLI and GUI interfaces.
Operation of the API is transactional and terminates on a single data model maintained in CIMC.
The API model includes the following programmatic entities:
Classes—Define the properties and states of objects in the management information tree.
Methods—Actions that the API performs on one or more objects.
Types—Object properties that map values to the object state (for example,
A typical request comes into CIMC and is placed in the transactor queue in FIFO order. The transactor gets the request from the queue, interprets the request, and performs an authorization check. After the request is confirmed, the transactor updates the management information tree. This complete operation is done in a single transaction.
Event subscription is supported. Up to four Cisco CIMC XML API clients can subscribe to receive event notifications from CIMC. The event subscription operation establishes a connection session allowing a client to receive XML-formatted event notification messages that are sent asynchronously by CIMC.
The Cisco CIMC XML API sends event notifications only for fault-related events.