Cisco IMC XML API is a programmatic interface to the
Cisco Integrated Management Controller (Cisco IMC)
software for a
Server. 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
is stored in a hierarchical tree structure known as the MIT (Management
Information Tree), which is completely accessible through the XML API.
Cisco IMC 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
Cisco IMC XML API is limited to a single
Server, in contrast to the
Cisco UCS Manager XML API, which controls an entire
Cisco UCS domain consisting of switches, FEX modules, servers, and other devices.
Cisco IMC XML API, the user has programmatic access to
to configure, administer, and monitor the server. The API provides most of the
functions that are accessible through the
CLI and GUI interfaces.
Operation of the API
is transactional and terminates on a single data model maintained in
The API model includes
the following programmatic entities:
properties and states of objects in the MIT.
that the API performs on one or more objects.
properties that map values to the object state (for example,
A typical request
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 MIT. This
complete operation is done in a single transaction.
Event subscription is
supported. Up to four
Cisco IMC XML API clients can subscribe to receive event notifications from
The event subscription operation establishes a connection session allowing a
client to receive XML-formatted event notification messages that are sent
In Release 1.5(1.x),
Cisco IMC XML API sends event notifications only for fault-related events.