Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

First Published: September 06, 2011

Last Modified: August 15, 2013

Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883

Text Part Number: OL-25396-03

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version
of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://

www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
2013

Cisco Systems, Inc. All rights reserved.

CONTENTS

Preface

Preface vii
Audience vii
Document Organization vii
Related Documentation vii
Documentation Feedback viii

CHAPTER 1

Cisco CIMC XML API 1

About the Cisco CIMC XML API 1
Cisco UCS Management Information Model 2
Cisco CIMC XML API Sample Flow 3
Object Naming 3
API Method Categories 4
Authentication Methods 4
Query Methods 5
Configuration Methods 6
Event Subscription Methods 6
Success or Failure Response 6
Successful Response 7
Failed Requests 7
Empty Results 7

CHAPTER 2

Using the Cisco CIMC XML API Methods 9

Authentication Methods 9
Login 9
Refreshing the Session 10
Logging Out of the Session 11
Unsuccessful Responses 11

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

iii

Contents

Query Methods 11
Using configResolveChildren 11
Using configResolveClass 12
Using configResolveDn 12
Using configResolveParent 12

CHAPTER 3

Cisco CIMC XML API Method Descriptions 15

aaaGetComputeAuthTokens 15
aaaKeepAlive 16
aaaLogin 17
aaaLogout 19
aaaRefresh 19
configConfMo 21
configResolveChildren 22
configResolveClass 23
configResolveDn 25
configResolveParent 26
eventSubscribe 27
eventUnsubscribe 28

CHAPTER 4

Cisco CIMC XML Schema Definition Files 29

About the Cisco CIMC XML Schema Definition Files 29
Examples of RACK-IN.xsd Usage 30
Examples of RACK-OUT.xsd Usage 32

CHAPTER 5

CIMC XML Object-Access Privileges 35

Privileges Summary Table 35
Privileges 35
admin 35
read-only 36
user 36

APPENDIX A

Examples of Common Server Management Tasks 37

APPENDIX B

Notes on Using the configConfMo Method 81

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

iv

OL-25396-03

Contents

Defining a Distinguished Name using the configConfMo Method 81

Using the Optional inHierarchical Attribute 82
Configuring a Single Managed Object 82

APPENDIX C

The CIMC Visore Utility 85

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

Contents

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

vi

OL-25396-03

Preface
This preface includes the following sections:
Audience, page vii
Document Organization, page vii
Related Documentation, page vii
Documentation Feedback, page viii

Audience
This guide is intended for software engineers with a background in programming and the use of APIs. Engineers
should have knowledge of XML, data systems, networking protocols, and storage protocols.

Document Organization
This XML API Reference Guide is organized into the following chapters:
Cisco CIMC XML API, on page 1
Using the Cisco CIMC XML API Methods, on page 9
Cisco CIMC XML API Method Descriptions, on page 15
CIMC XML Object-Access Privileges, on page 35

Related Documentation
For a complete list of all C-Series documentation, see the Cisco UCS C-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/c-series-doc.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

vii

Preface
Documentation Feedback

Note

The Cisco UCS C-Series Servers Integrated Management Controller GUI Configuration Guide and the
Cisco UCS C-Series Servers Integrated Management Controller CLI Command Reference provide an
overview of CIMC. This is important background information for XML API software developers.

Documentation Feedback
To provide technical feedback on this document, or to report an error or omission, please send your comments
to ucs-docfeedback@cisco.com. We appreciate your feedback.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

viii

OL-25396-03

CHAPTER

Cisco CIMC XML API

This chapter includes the following sections:
About the Cisco CIMC XML API, page 1
Cisco UCS Management Information Model, page 2
Cisco CIMC XML API Sample Flow, page 3
Object Naming, page 3
API Method Categories, page 4
Success or Failure Response, page 6

About the Cisco CIMC XML API

The Cisco CIMC XML API is a programmatic interface to the Cisco Integrated Management Controller
(CIMC) software for a C-Series Rack-Mount 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 CIMC is stored in a hierarchical tree structure known as the
MIT (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 C-Series Rack-Mount 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.
Using the Cisco CIMC XML API, the user has programmatic access to CIMC to configure, administer, and
monitor the server. The API provides most of the 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:
ClassesDefine the properties and states of objects in the MIT.
MethodsActions that the API performs on one or more objects.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

Cisco CIMC XML API

Cisco UCS Management Information Model

TypesObject properties that map values to the object state (for example, equipmentPresence).
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 MIT. 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.

Note

In Release 1.5(1.x), the Cisco CIMC XML API sends event notifications only for fault-related events.

Cisco UCS Management Information Model

All the physical and logical components that comprise Cisco UCS are represented in a hierarchical management
information model, referred to as the MIT. Each node in the tree represents a managed object (MO) or group
of objects that contains its administrative state and its operational state.
The hierarchical structure starts at the top (sys) and contains parent and child nodes. Each node in this tree
is a managed object and each object in Cisco UCS has a unique distinguished name (DN) that describes the
object and its place in the tree. Managed objects are abstractions of the Cisco UCS resources, such as CPUs,
DIMMs, adapter cards, fans, and power supply units..
Configuration policies are the majority of the policies in the system and describe the configurations of different
Cisco UCS components. Policies determine how the system behaves under specific circumstances. Certain
managed objects are not created by users, but are automatically created by the Cisco UCS, for example, power
supply objects and fan objects. By invoking the API, you are reading and writing objects to the management
information model (MIM).
CIMC Management Information Model
The CIMC management information model is a subset of the Cisco UCS management information model. A
C-Series Rack-Mount Server is modeled starting with sys/rack-unit-1 in the MIT as in the following
example:
Figure 1: Illustration of the CIMC MIM Structure
Tree (topRoot):-Distinguished Name:
|sys (sys)
|rack-unit-1(sys/rack-unit-1)
|adaptor-1(sys/rack-unit-1/adaptor-1)
|psu-1(sys/rack-unit-1/psu-1)
|psu-2(sys/rack-unit-1/psu-2)

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

2

OL-25396-03

Cisco CIMC XML API

Cisco CIMC XML API Sample Flow

Cisco CIMC XML API Sample Flow

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 operation is done in a single
transaction.
The following figure shows how CIMC processes a boot server request. The following table describes the
steps involved in a boot server request.
Figure 2: Sample Flow of Boot Server Request

Table 1: Explanation of Boot Server Request

Step

Command/Process

Operational Power State of

MO (Server)

CMD request: boot server

Down

Request queued

Down

State change in management information tree and make persistent

the managed object (MO) state change

Down

Apply boot stimuli

Up

Object Naming
You can identify a specific object by its distinguished name (DN) or by its relative name (RN).

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

Cisco CIMC XML API

API Method Categories

Distinguished Name
The distinguished name enables you to unambiguously identify a target object. The distinguished name has
the following format consisting of a series of relative names:
dn = {rn}/{rn}/{rn}/{rn}...

In the following example, the DN provides a fully qualified path for adaptor-1 from the top of the object tree
to the object. The DN specifies the exact managed object on which the API call is operating.
< dn =sys/rack-unit-1/adaptor-1 />

Relative Name
The relative name identifies an object within the context of its parent object. The distinguished name is
composed of a sequence of relative names.
For example, this distinguished name:
<dn = "sys/rack-unit-1/adaptor-1/host-eth-2"/>

is composed of the following relative names:

topSystem MO: rn="sys"
computeRackUnit MO: rn ="rack-unit-1"
adaptorUnit MO: rn="adaptor-<id>"
adaptorHostEthIf MO: rn="host-eth-<id>"

API Method Categories

Each method corresponds to an XML document.

Note

Several code examples in this guide substitute the term <real_cookie> for an actual cookie (such as
1217377205/85f7ff49-e4ec-42fc-9437-da77a1a2c4bf). The XML API cookie is a 47-character string; it
is not the type of cookie that web browsers store locally to maintain session information.

Authentication Methods
Authentication methods authenticate and maintain the session. For example:
aaaLoginInitial method for logging in.
aaaRefreshRefreshes the current authentication cookie.
aaaLogoutExits the current session and deactivates the corresponding authentication cookie.
Use the aaaLogin method to get a valid cookie. Use aaaRefresh to maintain the session and keep the cookie
active. Use the aaaLogout method to terminate the session (also invalidates the cookie). A maximum of 4
sessions to the Cisco UCS can be opened at any one time.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

4

OL-25396-03

Cisco CIMC XML API

Query Methods

Operations are performed using the HTTP post method (CIMC supports both HTTP and HTTPS requests)
over TCP. HTTP and HTTPS can be configured to use different port numbers, but TCP/443 (or TCP/80 for
non-secure connections) is used by default. The HTTP envelope contains the XML configuration.

Tip

In CIMC, HTTP to HTTPS redirection is enabled by default. To capture HTTP packets between the client
application and CIMC, disable redirection in the CIMC GUI or CLI.

Query Methods
Query methods obtain information on the current configuration state of an object. The following are query
methods supported in Release 1.5(1.x):
configResolveDnRetrieves objects by DN.
configResolveClassRetrieves objects of a given class.
configResolveChildrenRetrieves the child objects of an object.
configResolveParentRetrieves the parent object of an object.
Most query methods have the argument inHierarchical (Boolean true/yes or false/no). If true, the inHierarchical
argument returns all child objects.
<configResolveDn inHierarchical="false"></>
<configResolveDn inHierarchical="true"></>

Because the amount of data returned from CIMC can be quite large, the inHierarchical argument should be
used with care. For example, if the query method is used on a class or DN that refers to a managed object
(MO) that is located high on the management information tree and inHierarchical is set to true, the response
can contain almost the entire CIMC configuration. The resources required for CIMC to process the request
can be high, causing CIMC to take an extended amount of time to respond. To avoid delays, the query method
should be performed on a smaller scale involving fewer MOs.

Tip

If a query method does not respond or is taking a long time to respond, increase the timeout period on the
client application or adjust the query method to involve fewer MOs.
The query API methods might also have an inRecursive argument to specify whether the call should be
recursive (for example, follow objects that point back to other objects or the parent object).

Note

Until a host is powered on at least once, CIMC may not have complete inventory and status information.
For example, if CIMC is reset, it will not have detailed CPU, memory, or adapter inventory information
until the next time the host is powered on. If a query method is performed on a MO corresponding to the
unavailable data, the response will be blank.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

Cisco CIMC XML API

Configuration Methods

Configuration Methods
The Cisco CIMC XML API supports only a single method to make configuration changes to managed objects:
configConfMoAffects a single managed object (for example, a DN).

Event Subscription Methods

Applications get state change information by regular polling or event subscription. For more efficient use of
resources, event subscription is the preferred method of notification. Polling should be used only under very
limited circumstances.
Use eventSubscribe to register for events, as shown the following example:
<eventSubscribe
cookie="<real_cookie>">
</eventSubscribe>

To receive notifications, open an HTTP or HTTPS session over TCP and keep the session open. On receiving
eventSubscribe, CIMC starts sending all new events as they occur. You can unsubscribe from these events
using the eventUnsubscribe method.
Each event has a unique event ID. Event IDs operate as counters and are included in all method responses.
When an event is generated, the event ID counter increments and is assigned as the new event ID. This
sequential numbering enables tracking of events and ensures that no event is missed.
An event channel connection opened by a user will be closed automatically by CIMC after 600 seconds of
inactivity associated with the event channel session cookie. To prevent automatic closing of the event channel
connection by CIMC, the user must either send the aaaKeepAlive request for the same event channel session
cookie within 600 seconds or send any other XML API method to CIMC using the same event channel session
cookie.

Note

In Release 1.5(1.x), the Cisco CIMC XML API sends event notifications only for fault-related events.

Success or Failure Response

When CIMC responds to an XML API request, the response indicates failure if the request is impossible to
complete. A successful response indicates only that the request is valid, not that the operation is complete.
For example, it may take some time for a server to finish a power-on request. The power state changes from
down to up only after the server actually powers on.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

6

OL-25396-03

Cisco CIMC XML API

Successful Response

Successful Response
When a request has executed successfully, CIMC returns an XML document with the information requested
or a confirmation that the changes were made. The following is an example of a configResolveDn query on
the distinguished name sys/rack-unit-1/adaptor-2/ext-eth-0:
<configResolveDn
dn="sys/rack-unit-1/adaptor-2/ext-eth-0"
cookie="<real_cookie>"
inHierarchical="false"/>

The response includes the following information:

<configResolveDn
cookie="<real_cookie>"
response="yes"
dn="sys/rack-unit-1/adaptor-2/ext-eth-0">
<outConfig>
<adaptorExtEthIf
id="0"
ifType="physical"
linkState="up"
mac="00:22:BD:D6:42:DA"
name=""
operState="up"
portId="0"
purpose="general"
transport="CE"
type=""
dn="sys/rack-unit-1/adaptor-2/ext-eth-0" >
</adaptorExtEthIf>
</outConfig>
</configResolveDn>

Failed Requests
The response to a failed request includes XML attributes for errorCode and errorDescr. The following is an
example of a response to a failed request:
<configConfMo dn="sys/rack-unit-1/adaptor-1/ext-eth-0"
cookie="<real_cookie>"
response="yes"
errorCode="103"
invocationResult="unidentified-fail"
errorDescr="can't create; object already exists.">
</configConfMo>

Empty Results
A query request for a nonexistent object is not treated as a failure by CIMC. If the object does not exist, CIMC
returns a success message, but the XML document contains an empty data field (<outConfig> </outConfig>)
to indicate that the requested object was not found. The following example shows the response to an attempt
to resolve the distinguished name on a nonexistent rack-mount server:
<configResolveDn
cookie="<real_cookie>"
response="yes"
dn="sys/rack-unit-1/adaptor-9999">
<outConfig>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

Cisco CIMC XML API

Empty Results

</outConfig>
</configResolveDn>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

8

OL-25396-03

CHAPTER

Using the Cisco CIMC XML API Methods

This chapter includes the following sections:
Authentication Methods, page 9
Query Methods, page 11

Authentication Methods
Authentication allows XML API interaction with the CIMC. It provides a way to set permissions and control
the operations that can be performed.

Note

Most code examples in this guide substitute the term <real_cookie> for an actual cookie (such as
1217377205/85f7ff49-e4ec-42fc-9437-da77a1a2c4bf). The Cisco UCS cookie is a 47-character string; it
is not the type of cookie that web browsers store locally to maintain session information.

Login
To log in, the XML API client establishes a TCP connection to the CIMC HTTP (or HTTPS) server and posts
an XML document containing the aaaLogin method.
In the following example, the Telnet utility is used to establish a TCP connection to port 80 of the CIMC with
IP address 192.0.20.72. The path used is /nuova.
$ telnet 192.0.20.72 80
POST /nuova HTTP/1.1
USER-Agent: lwp-request/2.06
HOST: 192.0.20.72
Content-Length: 62
Content-Type: application/x-www-form-urlencoded

Next, the client specifies the aaaLogin method and provides a user name and password:
<aaaLogin
inName='admin'

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

Using the Cisco CIMC XML API Methods

Refreshing the Session

inPassword='password'>
</aaaLogin>

Note

Do not include XML version or DOCTYPE lines in the XML API document. The inName and inPassword
attributes are parameters.
Each XML API document represents an operation to be performed. When the request is received as an XML
API document, CIMC reads the request and performs the actions as provided in the method. CIMC responds
with a message in XML document format and indicates success or failure of the request.
The following is a typical successful response:
1 <aaaLogin
2
response="yes"
3
outCookie="<real_cookie>"
4
outRefreshPeriod="600"
5
outPriv="admin">
6 </aaaLogin>

Each line in the response should be interpreted as follows:

1 Specifies the method used to login.
2 Confirms that this is a response.
3 Provides the session cookie.
4 Specifies the recommended cookie refresh period. The default login session length is 600 seconds.
5 Specifies the privilege level assigned to the user account (this can be admin, user, or readonly).
6 Closing tag.
Alternatively, you can use the cURL utility to log in to the XML API, as shown in the following example:
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" http://192.0.20.72/nuova

If HTTPS is enabled, you must use HTTPS in the cURL command, as shown in the following example:
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" https://192.0.20.72/nuova

Refreshing the Session

Sessions are refreshed with the aaaRefresh method, using the 47-character cookie obtained either from the
aaaLogin response or a previous refresh.
<aaaRefresh
cookie="<real_cookie>"
inCookie="<real_cookie>"
inName='admin'
inPassword='password'>
</aaaRefresh>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

10

OL-25396-03

Using the Cisco CIMC XML API Methods

Logging Out of the Session

Logging Out of the Session

Use the following method to log out of a session:
<aaaLogout
cookie="<real_cookie>"
inCookie="<real_cookie>"
</aaaLogout>

Unsuccessful Responses
Failed login:
<aaaLogin
cookie=""
response="yes"
errorCode="551"
invocationResult="unidentified-fail"
errorDescr="Authentication failed">
</aaaLogin>

Nonexistent object (blank return indicates no object with the specified DN):
<configResolveDn
cookie="<real_cookie>"
response="yes"
dn="sys/rack-unit-1/adaptor-9999">
<outConfig>
</outConfig>
</configResolveDn>

Bad request:
<configConfMo
cookie="<real_cookie>"
response="yes"
dn="sys/rack-unit-1/adaptor-1/ext-eth-0">
errorCode="103
invocationResult="unidentified-fail
errorDescr="can't create; object already exists.">
</configConfMo>

Query Methods
Using configResolveChildren
When resolving children of objects in the MIT, note the following:
This method obtains all child objects of a named object that are instances of the named class. If a class
name is omitted, all child objects of the named object are returned.
inDn attribute specifies the named object from which the child objects are retrieved (required).
classId attribute specifies the name of the child object class to return (optional).

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

11

Using the Cisco CIMC XML API Methods

Using configResolveClass

Authentication cookie (from aaaLogin or aaaRefresh) is required.

inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Enumerated values, classIds, and bit masks are displayed as strings.
See the example request/response in configResolveChildren, on page 22.

Using configResolveClass
When resolving a class, note the following:
All objects of the specified class type are retrieved.
classId specifies the object class name to return (required).
Authentication cookie (from aaaLogin or aaaRefresh) is required.
inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Enumerated values, classIds, and bit masks are displayed as strings.
Result sets can be large. Be precise when defining result sets. For example, to obtain only a list of adapters,
use adaptorUnit as the attribute value for classId in the query. This example queries for all instances of the
adaptorUnit class:
<configResolveClass
cookie="real_cookie"
inHierarchical="false"
classId="adaptorUnit"/>

See the example request/response in configResolveClass, on page 23.

Using configResolveDn
When resolving a DN, note the following:
The object specified by the DN is retrieved.
Specified DN identifies the object instance to be resolved (required).
Authentication cookie (from aaaLogin or aaaRefresh) is required.
inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Enumerated values, classIds, and bit masks are displayed as strings.
See the example request/response in configResolveDn, on page 25.

Using configResolveParent
When resolving the parent object of an object, note the following:
This method retrieves the parent object of a specified DN.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

12

OL-25396-03

Using the Cisco CIMC XML API Methods

Using configResolveParent

dn attribute is the DN of the child object (required).

Authentication cookie (from aaaLogin or aaaRefresh) is required.
inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Enumerated values, classIds, and bit masks are displayed as strings.
See the example request/response in configResolveParent, on page 26.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

13

Using the Cisco CIMC XML API Methods

Using configResolveParent

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

14

OL-25396-03

CHAPTER

Cisco CIMC XML API Method Descriptions

This chapter includes the following sections:
aaaGetComputeAuthTokens, page 15
aaaKeepAlive, page 16
aaaLogin, page 17
aaaLogout, page 19
aaaRefresh, page 19
configConfMo, page 21
configResolveChildren, page 22
configResolveClass, page 23
configResolveDn, page 25
configResolveParent, page 26
eventSubscribe, page 27
eventUnsubscribe, page 28

aaaGetComputeAuthTokens
The aaaGetComputeAuthTokens method returns authentication tokens that are used to launch the KVM. This
generates two temporary authentication tokens that are valid for 60 seconds. The first is the KVM user name
and the second token is the password. Using the authorization tokens as credentials, you can access the URL
from where you can download the Java Network Launch Protocol (JNLP) file. You can download the JNLP
file from the URL and launch it to start a KVM session.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

15

Cisco CIMC XML API Method Descriptions

aaaKeepAlive

Note

You cannot obtain tokens if the vKVM option is disabled on the CIMC.
You must have user or admin privileges to the CIMC to obtain the authentication tokens. Users with
read-only privileges will not be able to obtain the tokens.
The authorization tokens expire is 60 seconds; you cannot use the tokens after 60 seconds to access
the URL. If you try to access after 60 seconds, the login fails and you get a authentication failure or
timeout message.

Request Syntax
<xs:element name="aaaGetComputeAuthTokens" type="aaaGetComputeAuthTokens"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetComputeAuthTokens" mixed="true">
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
</xs:complexType>

Response Syntax
<xs:element name="aaaGetComputeAuthTokens" type="aaaGetComputeAuthTokens"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetComputeAuthTokens" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="outTokens">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="510"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>

Examples
Request:
<aaaGetComputeAuthTokens
cookie="<real_cookie>" />'

Response:
<aaaGetComputeAuthTokens
cookie="<real_cookie>
outTokens="1957747793,424238335"
response="yes">
</aaaGetComputeAuthTokens>

aaaKeepAlive
The aaaKeepAlive method keeps the session active until the default session time expires, using the same
cookie after the method call.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

16

OL-25396-03

Cisco CIMC XML API Method Descriptions

aaaLogin

Request Syntax
<xs:element name="aaaKeepAlive" type="aaaKeepAlive" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaKeepAlive" mixed="true">
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
</xs:complexType>

Response Syntax
<xs:element name="aaaKeepAlive" type="aaaKeepAlive" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaKeepAlive" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>

Examples
Request
<aaaKeepAlive
cookie="<real_cookie>"
</aaaKeepAlive>

Response
<aaaKeepAlive
cookie="<real_cookie>"
response="yes">
</aaaKeepAlive>

aaaLogin
The aaaLogin method is the login process and is required to begin a session. This action establishes the HTTP
(or HTTPS) session between the client and CIMC.
Request Syntax
<xs:element name="aaaLogin" type="aaaLogin" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogin" mixed="true">
<xs:attribute name="inName" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="[\-\.:_a-zA-Z0-9]{0,16}"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="inPassword" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="510"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="stringMin0Max47"/>
<xs:attribute name="response" type="YesOrNo"/>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

17

Cisco CIMC XML API Method Descriptions

aaaLogin

</xs:complexType>

Response Syntax
<xs:element name="aaaLogin" type="aaaLogin" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogin" mixed="true">
<xs:attribute name="outCookie" type="xs:string"/>
<xs:attribute name="outRefreshPeriod" type="xs:unsignedInt"/>
<xs:attribute name="outPriv">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="(read-only|admin|user){0,1}"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="outDomains" type="xs:string"/>
<xs:attribute name="outChannel">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="outEvtChannel">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="outSessionId">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="32"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="outVersion" type="xs:string"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>

Examples
Request
<aaaLogin
inName='admin'
inPassword='password'>
</aaaLogin>

Response
<aaaLogin
cookie=""
response="yes"
outCookie="<real_cookie>"
outRefreshPeriod="600"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

18

OL-25396-03

Cisco CIMC XML API Method Descriptions

aaaLogout

outPriv="admin">
</aaaLogin>

aaaLogout
The aaaLogout method is a process to close a web session by passing the session cookie as input. It is not
automatic; the user has to explicitly invoke the aaaLogout method to terminate the session.
Request Syntax
<xs:element name="aaaLogout" type="aaaLogout" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogout" mixed="true">
<xs:attribute name="inCookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="cookie" type="stringMin0Max47"/>
<xs:attribute name="response" type="YesOrNo"/>
</xs:complexType>

Response Syntax
<xs:element name="aaaLogout" type="aaaLogout" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogout" mixed="true">
<xs:attribute name="outStatus">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="success"/>
<xs:enumeration value="failure"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>

Examples
Request
<aaaLogout
cookie="<real_cookie>"
inCookie="<real_cookie>"
</aaaLogout>

Response
<aaaLogout
cookie="<real_cookie>"
response="yes"
outStatus="success">
</aaaLogout>

aaaRefresh
The aaaRefresh method keeps sessions active (within the default session time frame) by user activity. There
is a default of 600 seconds that counts down when inactivity begins. If the 600 seconds expire, CIMC enters

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

19

Cisco CIMC XML API Method Descriptions

aaaRefresh

a sleep mode. It requires signing back in, which restarts the countdown. It continues using the same session
ID.

Note

Using this method expires the previous cookie and issues a new cookie.

Request Syntax
<xs:element name="aaaRefresh" type="aaaRefresh" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaRefresh" mixed="true">
<xs:attribute name="inName" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="[\-\.:_a-zA-Z0-9]{0,16}"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="inPassword" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="510"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="inCookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="cookie" type="stringMin0Max47"/>
<xs:attribute name="response" type="YesOrNo"/>
</xs:complexType>

Response Syntax
<xs:element name="aaaRefresh" type="aaaRefresh" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaRefresh" mixed="true">
<xs:attribute name="outCookie" type="xs:string"/>
<xs:attribute name="outRefreshPeriod" type="xs:unsignedInt"/>
<xs:attribute name="outPriv">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="(read-only|admin|user){0,1}"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="outDomains" type="xs:string"/>
<xs:attribute name="outChannel">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="outEvtChannel">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

20

OL-25396-03

Cisco CIMC XML API Method Descriptions

configConfMo

<xs:attribute name="errorCode" type="xs:unsignedInt"/>

<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>

Examples
Request
<aaaRefresh
cookie="<real_cookie>"
inCookie="<real_cookie>"
inName='admin'
inPassword='password'>
</aaaRefresh>

Response
<aaaRefresh
cookie="<real_cookie>"
response="yes"
outCookie="<real_cookie>"
outRefreshPeriod="600"
outPriv="admin">
</aaaRefresh>

configConfMo
The configConfMo method configures the specified managed object in a single subtree (for example, DN).
Request Syntax
<xs:element name="configConfMo" type="configConfMo" substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMo" mixed="true">
<xs:all>
<xs:element name="inConfig" type="configConfig" minOccurs="1"/>
</xs:all>
<xs:attribute name="inHierarchical">
<xs:simpleType>
<xs:union memberTypes="xs:boolean YesOrNo"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject" use="required"/>
</xs:complexType>

Response Syntax
<xs:element name="configConfMo" type="configConfMo" substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMo" mixed="true">
<xs:all>
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
</xs:complexType>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

21

Cisco CIMC XML API Method Descriptions

configResolveChildren

Examples
Request
<configConfMo
cookie="<real_cookie>"
dn='sys/rack-unit-1/locator-led'>
<inConfig>
<equipmentLocatorLed
adminState='on'
dn='sys/rack-unit-1/locator-led'>
</equipmentLocatorLed>
</inConfig>
</configConfMo>

Response
<configConfMo
dn="sys/rack-unit-1/locator-led"
cookie="<real_cookie>"
response="yes">
<outConfig>
<equipmentLocatorLed
dn="sys/rack-unit-1/locator-led"
adminState="inactive"
color="unknown"
id="1"
name=""
operState="off">
</equipmentLocatorLed>
</outConfig>
</configConfMo>

configResolveChildren
The configResolveChildren method retrieves children of managed objects under a specific DN in the managed
information tree.
Request Syntax
<xs:element name="configResolveChildren" type="configResolveChildren"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveChildren" mixed="true">
<xs:attribute name="inDn" type="referenceObject" use="required"/>
<xs:attribute name="inHierarchical">
<xs:simpleType>
<xs:union memberTypes="xs:boolean YesOrNo"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="classId" type="namingClassId"/>
</xs:complexType>

Response Syntax
<xs:element name="configResolveChildren" type="configResolveChildren"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveChildren" mixed="true">
<xs:all>
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
</xs:all>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

22

OL-25396-03

Cisco CIMC XML API Method Descriptions

configResolveClass

<xs:attribute
<xs:attribute
<xs:attribute
<xs:attribute
<xs:attribute
<xs:attribute
</xs:complexType>

name="cookie" type="xs:string"/>
name="response" type="YesOrNo"/>
name="errorCode" type="xs:unsignedInt"/>
name="errorDescr" type="xs:string"/>
name="invocationResult" type="xs:string"/>
name="classId" type="namingClassId"/>

Examples
Request
<configResolveChildren
cookie="<real_cookie>"
inDn='sys/rack-unit-1/boot-policy'
inHierarchical='false'>
</configResolveChildren>

Response
<configResolveChildren
cookie="0000227746/06bc6a70-0035-1035-800c-cdac38e14388"
response="yes"
dn="sys/rack-unit-1/boot-policy">
<outConfig>
<lsbootVirtualMedia
access="read-write"
order="2"
type="virtual-media"
dn="sys/rack-unit-1/boot-policy/vm-read-write">
</lsbootVirtualMedia>
<lsbootLan
access="read-only"
order="1" prot="pxe"
type="lan"
dn="sys/rack-unit-1/boot-policy/lan-read-only">
</lsbootLan>
<lsbootStorage
access="read-write"
order="4"
type="storage"
dn="sys/rack-unit-1/boot-policy/storage-read-write">
</lsbootStorage>
<lsbootEfi
access="read-only"
order="3"
type="efi"
dn="sys/rack-unit-1/boot-policy/efi-read-only">
</lsbootEfi>
</outConfig>
</configResolveChildren>

configResolveClass
The configResolveClass method returns requested managed object in a given class. If inHierarchical=true,
the results contain children.
Request Syntax
<xs:element name="configResolveClass" type="configResolveClass"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveClass" mixed="true">
<xs:attribute name="inHierarchical">

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

23

Cisco CIMC XML API Method Descriptions

configResolveClass

<xs:simpleType>
<xs:union memberTypes="xs:boolean YesOrNo"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="classId" type="namingClassId" use="required"/>
</xs:complexType>

Response Syntax
<xs:element name="configResolveClass" type="configResolveClass"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveClass" mixed="true">
<xs:all>
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="classId" type="namingClassId"/>
</xs:complexType>

Examples
Request
<configResolveClass
cookie="<real_cookie>"
classId='computeRackUnit'
inHierarchical='false'>
</configResolveClass>

Response
<configResolveClass
cookie="<real_cookie>"
response="yes"
classId="computeRackUnit">
<outConfig>
<computeRackUnit
dn="sys/rack-unit-1"
adminPower="policy"
availableMemory="16384"
model="R210-2121605W"
memorySpeed="1067"
name="UCS C210 M2"
numOfAdaptors="2"
numOfCores="8"
numOfCoresEnabled="8"
numOfCpus="2"
numOfEthHostIfs="5"
numOfFcHostIfs="2"
numOfThreads="16"
operPower="on"
originalUuid="00C9DE3C-370D-DF11-1186-6DD1393A608B"
presence="equipped"
serverID="1"
serial="QCI140205Z2"
totalMemory="16384"
usrLbl="C210 Row-B Rack-10"
uuid="00C9DE3C-370D-DF11-1186-6DD1393A608B"
vendor="Cisco Systems Inc" >
</computeRackUnit>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

24

OL-25396-03

Cisco CIMC XML API Method Descriptions

configResolveDn

</outConfig>
</configResolveClass>

configResolveDn
The configResolveDn method retrieves a single managed object for a specified DN.
Request Syntax
<xs:element name="configResolveDn" type="configResolveDn" substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveDn" mixed="true">
<xs:attribute name="inHierarchical">
<xs:simpleType>
<xs:union memberTypes="xs:boolean YesOrNo"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject" use="required"/>
</xs:complexType>

Response Syntax
<xs:element name="configResolveDn" type="configResolveDn"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveDn" mixed="true">
<xs:all>
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
</xs:complexType>

Examples
Request
<configResolveDn
dn='sys/rack-unit-1/adaptor-2/ext-eth-0'
cookie="<real_cookie>"
inHierarchical='false'>
</configResolveDn>

Response
<configResolveDn
cookie="<real_cookie>"
response="yes"
dn="sys/rack-unit-1/adaptor-2/ext-eth-0">
<outConfig>
<adaptorExtEthIf
id="0"
ifType="physical"
linkState="up"
mac="00:22:BD:D6:42:DA"
name=""

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

25

Cisco CIMC XML API Method Descriptions

configResolveParent

operState="up"
portId="0"
purpose="general"
transport="CE"
type=""
dn="sys/rack-unit-1/adaptor-2/ext-eth-0" >
</adaptorExtEthIf>
</outConfig>
</configResolveDn>

configResolveParent
For a specified DN, the configResolveParent method retrieves the parent of the managed object.
Request Syntax
<xs:element name="configResolveParent" type="configResolveParent"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveParent" mixed="true">
<xs:attribute name="inHierarchical">
<xs:simpleType>
<xs:union memberTypes="xs:boolean YesOrNo"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject" use="required"/>
</xs:complexType>

Response Syntax
<xs:element name="configResolveParent" type="configResolveParent"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveParent" mixed="true">
<xs:all>
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
</xs:complexType>

Examples
Request
<configResolveParent
cookie="<real_cookie>"
dn='sys/rack-unit-1/boot-policy/efi-read-only'
inHierarchical='false'>
</configResolveParent>

Response
<configResolveParent
cookie="<real_cookie>"
response="yes"
dn="sys/rack-unit-1/boot-policy/efi-read-only">
<outConfig>
<lsbootDef

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

26

OL-25396-03

Cisco CIMC XML API Method Descriptions

eventSubscribe

dn="sys/rack-unit-1/boot-policy"
name="boot-policy"
purpose="operational"
rebootOnUpdate="no">
</lsbootDef>
</outConfig>
</configResolveParent>

eventSubscribe
The eventSubscribe method allows a client to subscribe to asynchronous System Event Log (SEL) events
generated by CIMC.
Event subscription allows a client application to register for event notification from CIMC. When an event
occurs, CIMC informs the client application of the event and its type. Only the actual change information is
sent. The objects unaffected attributes are not included.
Use eventSubscribe to register for events as shown in the following example:
<eventSubscribe
cookie="<real_cookie>">
</eventSubscribe>

Request Syntax
<xs:element name="eventSubscribe" type="eventSubscribe" substitutionGroup="externalMethod"/>
<xs:complexType name="eventSubscribe" mixed="true">
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
</xs:complexType>

Response Syntax
<xs:element name="eventSubscribe" type="eventSubscribe"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSubscribe" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>

Examples
Request
<eventSubscribe
cookie="<real_cookie>">
</eventSubscribe>

Response
NO RESPONSE OR ACKNOWLEDGMENT.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

27

Cisco CIMC XML API Method Descriptions

eventUnsubscribe

eventUnsubscribe
The eventUnsubscribe method allows a client to unsubscribe from asynchronous System Event Log (SEL)
events generated by CIMC, reversing event subscriptions that resulted from eventUnsubscribe.
Use eventUnsubscribe to unsubscribe from events as shown in the following example:
<eventUnsubscribe
cookie="<real_cookie>">
</eventUnsubscribe>

Request Syntax
<xs:element name="eventUnsubscribe" type="eventUnsubscribe"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventUnsubscribe" mixed="true">
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
</xs:complexType>

Response Syntax
<xs:element name="eventUnsubscribe" type="eventUnsubscribe"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventUnsubscribe" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>

Examples
Request
<eventUnsubscribe
cookie="<real_cookie>">
</eventUnsubscribe>

Response
NO RESPONSE OR ACKNOWLEDGMENT.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

28

OL-25396-03

CHAPTER

Cisco CIMC XML Schema Definition Files

This chapter includes the following sections:
About the Cisco CIMC XML Schema Definition Files, page 29
Examples of RACK-IN.xsd Usage, page 30
Examples of RACK-OUT.xsd Usage, page 32

About the Cisco CIMC XML Schema Definition Files

The C-Series XML API provides users with input XML Schema Definition (xsd) files for every model and
a schema definition file for the output:
RACK-IN.xsd This document defines the XML document structure for a valid XML request that the
CIMC XML API accepts. It also specifies the classes and attributes that you can provide to the XML
API configConfMo (Set) requests.
RACK-OUT.xsd This document defines the XML document structure for a valid XML response that
the CIMC XML API displays. It also specifies the classes and attributes that must appear in the XML
API responses.
You can obtain these files from the CIMC at:
RACK-IN.xsd https://<CIMC-IP>/visore/RACK-IN.xsd
RACK-OUT https://<CIMC-IP>/visore/RACK-OUT.xsd
You also can download these files from the Cisco Developer Network, at: http://developer.cisco.com/web/
unifiedcomputing/c-series-cimc-xml-api.
You can use one of the available open source tools to validate the XML document against the XML schema
files. In the examples used in this section, xmllint available for download at: www.xmlsoft.org is used as the
tool for validation. You also can use the xml schema validation feature of a programming language, for
example xerces in Java, for this validation.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

29

Cisco CIMC XML Schema Definition Files

Examples of RACK-IN.xsd Usage

Examples of RACK-IN.xsd Usage

Validating an XML Request Using RACK-IN.xsd
Example of Use of the RACK-IN.xsd for an Invalid configResolveClass Request
Request:
$cat myXMLRequest.xml
<configResolveClass cookie="1360626069/7189c2b0-d57b-157b-8002-f4759de53d50"
inHierarchical="false"/>

Validating the request:

/usr/bin/xmllint schema ./RACK-IN.xsd myXMLRequest.xml
<configResolveClass cookie="1360626069/7189c2b0-d57b-157b-8002-f4759de53d50"
inHierarchical="false"/>

Response:
myXMLRequest.xml:1: element configResolveClass:
Schemas validity error : Element 'configResolveClass': The attribute 'classId' is required
but missing.

In the preceding example, validation of the XML request fails and displays an error because the 'classId' is
missing in the request.
Example of Use of the RACK-IN.xsd for a Valid configResolveClass Request
Request:
$cat myXMLRequest.xml
<configResolveClass cookie="1360626069/7189c2b0-d57b-157b-8002-f4759de53d50"
inHierarchical="false" classId="topSystem"/>

Request:
/usr/bin/xmllint -schema ./RACK-IN.xsd myXMLRequest.xml
<configResolveClass cookie="1360626069/7189c2b0-d57b-157b-8002-f4759de53d50"
inHierarchical="false" classId="topSystem"/>

In the preceding example, validation of the XML request for a classResolveClass is successful and the response
is displayed.
Example of Use of the RACK-IN.xsd for an Invalid configConfMo Request
Request:
$cat setRackUnit.xml
<configConfMo cookie="1300242644/ad04d239-d1aa-498d-b074-ccb923066003"
dn="sys/rack-unit-1" inHierarchical="false">
<inConfig>
<computeRackUnit adminPower="down" usrLbl="UCS C240 M3 For Demo"
availableMemory="16384" dn="sys/rack-unit-1"/>
</inConfig>
</configConfMo>

Validating the request:

/usr/bin/xmllint -schema ./RACK-IN.xsd /setRackUnit.xml
<configConfMo cookie="1300242644/ad04d239-d1aa-498d-b074-ccb923066003"
dn="sys/rack-unit-1"inHierarchical="false">
<inConfig>
<computeRackUnit adminPower="down" usrLbl="UCS C240 M3 For Demo"
availableMemory="16384" dn="sys/rack-unit-1"/>
</inConfig>
</configConfMo>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

30

OL-25396-03

Cisco CIMC XML Schema Definition Files

Examples of RACK-IN.xsd Usage

Response:
/setRackUnit.xml:3: element computeRackUnit: Schemas validity error :
Element 'computeRackUnit', attribute 'availableMemory': The attribute 'availableMemory' is
not allowed.
/setRackUnit.xml fails to validate

The availableMemory attribute is read-only in the computeRackUnit class. You can view the read/write
attributes in computeRackUnit that can be set using configCongMo XML by looking at the computeRackUnit
definition in RACK-IN.xsd. A sample snippet is as follows:
<!--computeRackUnit-->
<xs:element name="computeRackUnit" type="computeRackUnit"
substitutionGroup="managedObject"/>
<xs:complexType name="computeRackUnit" mixed="true">
<xs:attribute name="adminPower">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="up"/>
<xs:enumeration value="down"/>
<xs:enumeration value="soft-shut-down"/>
<xs:enumeration value="cycle-immediate"/>
<xs:enumeration value="hard-reset-immediate"/>
<xs:enumeration value="bmc-reset-immediate"/>
<xs:enumeration value="bmc-reset-default"/>
<xs:enumeration value="cmos-reset-immediate"/>
<xs:enumeration value="diagnostic-interrupt"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="usrLbl">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="[
!#$%&amp;\(\)\*\+,\-\./:;\?@\[\]_\{\|\}~a-zA-Z0-9]{0,64}"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="dn" type="referenceObject"/>
<xs:attribute name="rn" type="referenceRn"/>
<xs:attribute name="status" type="objectStatus"/>
</xs:complexType>

Example of Use of the RACK-IN.xsd for an Invalid configConfMo Request

Request:
$ cat setBootOrder.xml
<configConfMo cookie="1360205300/79c672f0-d519-1519-8004-30339ee53d50"
inHierarchical="true" dn="sys/rack-unit-1/boot-policy">
<inConfig>
<lsbootDef dn="sys/rack-unit-1/boot-policy"
name="boot-policy" purpose="operational"
rebootOnUpdate="no">
<lsbootVirtualMedia access="read-only" order="2" type="virtual-media"
rn="vm-read-only"/>
<lsbootVirtualMedia access="read-write" order="3" type="virtual-media"
rn="vm-read-write"/>
<lsbootLan rn="lan-read-only" access="read-only" order="4" prot="pxe" type="lan"/>
<lsbootStorage rn="storage-read-write" access="read-write" order="1" type="storage">
<lsbootLocalStorage rn="local-storage"/>
</lsbootStorage>
<lsbootEfi rn="efi-read-only" access="read-only" order="5" type="efi"/>
</lsbootDef>
</inConfig>
</configConfMo>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

31

Cisco CIMC XML Schema Definition Files

Examples of RACK-OUT.xsd Usage

Validating the request:

/usr/bin/xmllint -schema ./RACK-IN.xsd ./setBootOrder.xml
<configConfMo cookie="1360205300/79c672f0-d519-1519-8004-30339ee53d50"
inHierarchical="true" dn="sys/rack-unit-1/boot-policy">
<inConfig>
<lsbootDef dn="sys/rack-unit-1/boot-policy" name="boot-policy" purpose="operational"
rebootOnUpdate="no">
<lsbootVirtualMedia access="read-only" order="2" type="virtual-media"
rn="vm-read-only"/>
<lsbootVirtualMedia access="read-write" order="3" type="virtual-media"
rn="vm-read-write"/>
<lsbootLan rn="lan-read-only" access="read-only" order="4" prot="pxe" type="lan"/>
<lsbootStorage rn="storage-read-write" access="read-write" order="1" type="storage">
<lsbootLocalStorage rn="local-storage"/>
</lsbootStorage>
<lsbootEfi rn="efi-read-only" access="read-only" order="5" type="efi"/>
</lsbootDef>
</inConfig>
</configConfMo>

Response:
./setBootOrder.xml:3: element lsbootDef: Schemas validity error :
Element 'lsbootDef', attribute 'name': The attribute 'name' is not allowed.
./setBootOrder.xml:3: element lsbootDef: Schemas validity error :
Element 'lsbootDef', attribute 'purpose': The attribute 'purpose' is not allowed.
./setBootOrder.xml fails to validate

Name and purpose attributes of class lsBootDef are read-only and cannot be used in the configConMo/set
request.
Example of Use of the RACK-IN.xsd for a Valid configConfMo Request
Request:
usr/bin/xmllint -schema ./RACK-IN.xsd /setRackUnit.xml
<configConfMo cookie="1300242644/ad04d239-d1aa-498d-b074-ccb923066003"
dn="sys/rack-unit-1" inHierarchical="false">
<inConfig>
<computeRackUnit adminPower="down" usrLbl="UCS C240 M3 For Demo" dn="sys/rack-unit-1"/>
</inConfig>
</configConfMo>

xsd file validates the request and completes the configuration.

Examples of RACK-OUT.xsd Usage

Validating an XML Request Using RACK_OUT.xsd
Example of Use of the RACK-OUT.xsd for a configResolveClass Request
Request:
<configResolveClass cookie="1360632361/e892fa10-d57c-157c-8003-f4759de53d50"
inHierarchical="false" classId="computeRackUnit"/>'
https://172.xx.219.xx/nuova | xmllint -format - | xmllint -schema ./RACK-OUT.xsd -

Response:
<configResolveClass cookie="1360632361/e892fa10-d57c-157c-8003-f4759de53d50"
response="yes" classId="computeRackUnit">
<outConfigs>
<computeRackUnit dn="sys/rack-unit-1" adminPower="policy" availableMemory="16384"
model="UCSC-C240-M3L"
memorySpeed="1333" name="UCS C240 M3L" numOfAdaptors="1" numOfCores="16"
numOfCoresEnabled="16" numOfCpus="2"
numOfEthHostIfs="2" numOfFcHostIfs="3" numOfThreads="32" operPower="on"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

32

OL-25396-03

Cisco CIMC XML Schema Definition Files

Examples of RACK-OUT.xsd Usage

originalUuid="2E5D2295-F32D-48C9-BE8E-BAD36BE174FB" presence="equipped" serverId="1"

serial="FCH1551V030"
totalMemory="16384" usrLbl="SL2_=+@#$-;,./\" uuid="2E5D2295-F32D-48C9-BE8E-BAD36BE174FB"
vendor="Cisco Systems Inc"/>
</outConfigs>
</configResolveClass>

Rack-out.xsd validates the output successfully.

Example of Use of the RACK-OUT.xsd for a configResolveClass Request
Request:
$ /usr/bin/curl -k -d'<configResolveClass
cookie="1361150931/a5bacff0-d5f5-15f5-8007-f4759de53d50"
inHierarchical="true" classId="topSystem"/>' https://172.29.219.74/nuova >
C240_complete_MIT.xml
real
0m35.065s
user
0m0.016s
sys
0m0.044s

Validating the response:

$ ls -l C240_complete_MIT.xml
-rw-r--r--. 1 sajaffer eng58 64905 Feb 17 17:46 C240_complete_MIT.xml
$ /usr/bin/xmllint -schema
RACK-OUT.xsd
C240_complete_MIT.xml validates

C240_complete_MIT.xml 1>/dev/null

The preceding XML requests retrieve the complete management information tree of a C-Series server and
validate the response against RACK-OUT.xsd

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

33

Cisco CIMC XML Schema Definition Files

Examples of RACK-OUT.xsd Usage

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

34

OL-25396-03

CHAPTER

CIMC XML Object-Access Privileges

This chapter includes the following sections:
Privileges Summary Table, page 35
Privileges, page 35

Privileges Summary Table

When users are assigned to a role, that role allows certain privileges. Those privileges allow the user access
to specific system resources and authorize permission to perform tasks on those resources. The following
table lists each privilege and the initial default user role that has been given that privilege.
Internal Name

Label

Description

admin, on page 35

ADMIN

Access to everything

read-only, on page 36

READ_ONLY

Read-only access

user, on page 36

USER

Limited configuration access

Privileges
admin
Purpose
System administration
Responsible Role
Administrator

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

35

CIMC XML Object-Access Privileges

read-only

Controlled Objects
This role is system level. The administrator controls all objects.

read-only
Purpose
Read-only access
Responsible Role
This is not a selectable privilege. All roles have read-only access to all objects. Roles that have read-write
privileges on some objects also have read-only access to all other objects.

user
Purpose
Restricted configuration
Responsible Role
Controlled Objects
This role can perform the following tasks:
View all information
Manage the power control options such as power on, power cycle, and power off
Launch the KVM console and virtual media
Clear all logs
Toggle the locator LED

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

36

OL-25396-03

APPENDIX

Examples of Common Server Management Tasks

The examples in this chapter show how to use the Cisco CIMC XML API to perform common server
management tasks. Each example shows the XML API request followed by the response from CIMC.
This chapter includes the following examples:
1. Using CIMC LDAP User Credentials to Establish XML API Session Cookie, on page 40
2. Retrieving Server Summary Information and Host Power State, on page 40
3. Retrieving Current Running Firmware Versions of Server Components, on page 40
4. Retrieving Backup Firmware Version Installed on CIMC, on page 41
5. Activating Firmware Backup Image on CIMC, on page 41
6. Using the inHierarchical Option to Retrieve Configured Boot Order Table, on page 41
7. Retrieving Power Supply Unit Details on Server, on page 42
8. Retrieving Details of Fan Object Identified by DN, on page 42
9. Retrieving SNMP Configuration Details, on page 42
10. Retrieving Status of Local Hard Disk on Server, on page 43
11. Power Cycling the Server, on page 43
12. Configuring EFI as the Second Boot Device in Boot Order Table, on page 43
13. Removing Floppy Disk Drive as a Boot Device From the Boot Order List, on page 44
14. Configuring Boot Order to HDD, CDROM, FDD, PXE, and EFI Without Rebooting the Host, on
page 44
15. Using inHierarchical Option to Change and Retrieve SNMP Configuration of Trap Receivers, on
page 45
16. Retrieving Select Memory RAS BIOS Token, on page 45
17. Configuring Select Memory RAS BIOS Token for Mirroring Mode, on page 46
18. Retrieving C240 Server BIOS Token Values, on page 46
19. Retrieving Default Values of BIOS Tokens, on page 48
20. Configuring BIOS Settings Parameters to Default Values, on page 48

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

37

Examples of Common Server Management Tasks

21. Using Platform-Default to Configure BIOS Parameters to Default Values, on page 49

22. Using TFTP to Export CIMC Configuration Data, on page 50
23. Using TFTP to Import CIMC Configuration Data, on page 51
24. Using TFTP to Export CIMC Technical Support Data, on page 52
25. Retrieving CPU Product ID Details, on page 53
26. Retrieving IMM/ Memory Unit Product ID Details, on page 53
27. Retrieving HDD Product ID Details, on page 54
28. Retrieving PCI Adapter Product ID Details, on page 54
29. Retrieving Firmware Update Details, on page 55
30. Updating CIMC Firmware, on page 55
31. Updating BIOS Firmware, on page 55
32. Using Non-Interactive HUU to Update Firmware on all C-Series Server Components, on page 56
33. Using TFTP to Import VIC Adapter Configuration Data, on page 57
34. Using TFTP to Update VIC Firmware, on page 58
35. Configuring VIC Adapter Parameters, on page 58
36. Retrieving VIC Adapter General Profile Details, on page 59
37. Retrieving VIC Adapter Uplink Port Details, on page 59
38. Setting Uplink Port Speed of a VIC Adapter, on page 60
39. Retrieving Adapter Ethernet Interface Details, on page 60
40. Creating Adapter Ethernet Interface, on page 60
41. Modifying Properties of Ethernet Interface, on page 61
42. Deleting Ethernet Interface, on page 62
43. Retrieving Adapter Fibre Channel Interface Details, on page 62
44. Creating Boot Entry for a Fibre Channel Interface, on page 63
45. Configuring HUU for One-Time Boot, on page 63
46. Mounting Share to the VMedia with Username, on page 63
47. Setting Remotesyslog Primary Server, on page 64
48. Setting Remotesyslog Secondary Server, on page 64
49. Retrieving Syslog Client-Server Details, on page 64
50. Retrieving LOM MAC Address Support Details, on page 65
51. Retrieving MAC Address of Individual Ports of Network Controllers, on page 65
52. Retrieving LOM MAC Address of Individual Ports, on page 65
53. Retrieving LSI Storage Adapter Summary Properties Installed on C-Series Server, on page 66

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

38

OL-25396-03

Examples of Common Server Management Tasks

54. Retrieving LSI Storage Adapter Detailed Properties Installed on C-Series Server, on page 66
55. Retrieving LSI Storage Adapter Details of RAID Battery, on page 66
56. Retrieving Summary Information of Local Disks (HDD), on page 67
57. Retrieving Detailed Information of Local Disks (HDD), on page 67
58. Retrieving Details of All Virtual Drives Configured in LSI Adapters, on page 67
59. Retrieving Details of Physical Disks Usage by Virtual Drives, on page 68
60. Retrieving Network Time Protocol (NTP) Properties, on page 69
61. Configuring Network Time Protocol (NTP) Properties, on page 69
62. Retrieving all CIMC Users, on page 69
63. Setting up ID 11 CIMC User With Username and Password and Enabling Login Access to this
User, on page 70
64. Configuring User ID 3, Deactivating this User and Changing the Password, on page 70
65. Retrieving Memory Unit Statistics, on page 71
66. Retrieving Specific DIMM Memory Unit Statistics, on page 71
67. Retrieving Processor Environment Statistics, on page 71
68. Retrieving Specific DIMM Processor Environment Statistics, on page 72
69. Retrieving Motherboard Temperature Statistics, on page 72
70. Retrieving Specific DIMM Motherboard Temperature Statistics, on page 72
71. Retrieving Motherboard Power Statistics, on page 73
72. Retrieving Specific DIMM Motherboard Power Statistics, on page 73
73. Retrieving iSCSI Parameters, on page 73
74. Removing iSCSI Boot, on page 74
75. Retrieving Fault Objects Identified by CIMC, on page 74
76. Generating Temporary Authentication Tokens and Launching the KVM, on page 75
77. Retrieving usNIC Device Parameters, on page 75
78. Creating Ethernet Interface usNIC Profiles, on page 75
79. Modifying Ethernet Interface usNIC Profiles, on page 76
80. Retrieving LDAP Server Details, on page 76
81. Configuring LDAP Server IP Address and Port Numbers, on page 77
82. Configuring LDAP Parameters, on page 78
83. Querying to Check CIMC for NI-IOD Support, on page 79
84. Triggering Snapshot based on Parameters Provided with Request, on page 79
85. Querying Status of Current or Previous Snapshot Operation, on page 80

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

39

Examples of Common Server Management Tasks

1. Using CIMC LDAP User Credentials to Establish XML API Session Cookie
Request:
<aaaLogin inName="acme@somedept.cisco.com" inPassword="Test123"/>'

Response:
<aaaLogin cookie="" response="yes" outRefreshPeriod="600"
outCookie="1363164000/5a02ef30-d7ca-17ca-8002-30339ee53d50"
outPriv="admin">
</aaaLogin>

2. Retrieving Server Summary Information and Host Power State

Request:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388"
inHierarchical="false" classId="computeRackUnit"/>

Response:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" response="yes"
classId="computeRackUnit">
<outConfig>
<computeRackUnit dn="sys/rack-unit-1" adminPower="policy" availableMemory="49152"
model="R250-2480805W" memorySpeed="1067" name="UCS C250 M2" numOfAdaptors="1"
numOfCores="8" numOfCoresEnabled="8" numOfCpus="2" numOfEthHostIfs="8"
numOfFcHostIfs="2" numOfThreads="16" operPower="on"
originalUuid="100DC440-0EBC-11DF-3B97-8843E1C2615E" presence="equipped" serverId="1"
serial="PGS140601CS" totalMemory="49152" usrLbl="Cisco C250 Server"
uuid="100DC440-0EBC-11DF-3B97-8843E1C2615E" vendor="Cisco Systems Inc"/>
</outConfig>
</configResolveClass>

3. Retrieving Current Running Firmware Versions of Server Components

Request:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388"
inHierarchical="false" classId="firmwareRunning"/>

Response:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" response="yes"
classId="firmwareRunning">
<outConfigs>
<firmwareRunning dn="sys/rack-unit-1/bios/fw-boot-loader" deployment="boot-loader"
type="blade-bios" version="C22M3.1.5.1c.0 (Build Date: 01/31/2013)" >
<firmwareRunning dn="sys/rack-unit-1/mgmt/fw-boot-loader" deployment="boot-loader"
type="blade-controller" version="1.5(0.59).24"
<firmwareRunning dn="sys/rack-unit-1/mgmt/fw-system"
deployment="system" type="blade-controller" version="1.5(1b)" >
<firmwareRunning dn="sys/rack-unit-1/board/storage-SAS-SLOT-4/fw-boot-loader"
deployment="boot-loader" type="storage-controller"
version="4.31.00_4.12.05.00_0x05180000" >
<firmwareRunning dn="sys/rack-unit-1/board/storage-SAS-SLOT-4/fw-system"
deployment="system" type="storage-controller" version="2.130.364-2185" >
</firmwareRunning>
</outConfigs>
</configResolveClass>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

40

OL-25396-03

Examples of Common Server Management Tasks

4. Retrieving Backup Firmware Version Installed on CIMC

Request:
<configResolveDn cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388"
inHierarchical="false" dn="sys/rack-unit-1/mgmt/fw-updatable"/>

Response:
<configResolveDn cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" response="yes"
dn="sys/rack-unit-1/mgmt/fw-updatable">
<outConfig>
<firmwareUpdatable dn="sys/rack-unit-1/mgmt/fw-updatable" adminState="triggered"
deployment="backup" operState="ready" version="1.5(0.73)" protocol="none"
remoteServer="" remotePath="" user="" pwd="" progress="Success"
type="blade-controller">
</outConfig>
</configResolveDn>

5. Activating Firmware Backup Image on CIMC

Request:
<configConfMo cookie='1369391866/63bd7c70-dd74-1d74-8002-233362a70344'
dn='sys/rack-unit-1/mgmt/fw-boot-def/bootunit-combined'>
<inConfig>
<firmwareBootUnit dn='sys/rack-unit-1/mgmt/fw-boot-def/bootunit-combined'
adminState='trigger' image='backup' resetOnActivate='yes' />
</inConfig>
</configConfMo>

Response:
<configConfMocookie="1369391866/63bd7c70-dd74-1d74-8002-233362a70344" response="yes">
dn="sys/rack-unit-1/mgmt/fw-boot-def/bootunit-combined"
<outConfig>
<firmwareBootUnit dn="sys/rack-unit-1/mgmt/fw-boot-def/bootunit-combined"
adminState="triggered"
image="running" resetOnActivate="no" type="combined" version="1.5(1f)"
status="modified">
</firmwareBootUnit>
</outConfig>
</configConfMo>

6. Using the inHierarchical Option to Retrieve Configured Boot Order Table

Request:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388"
inHierarchical="true" classId="lsbootDef"/>

Response:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" response="yes"
classId="lsbootDef">
<outConfig>
<lsbootDef dn="sys/rack-unit-1/boot-policy" name="boot-policy"
purpose="operational" rebootOnUpdate="no" >
<lsbootVirtualMedia access="read-only" order="3"
type="virtual-media" rn="vm-read-only" />
<lsbootVirtualMedia access="read-write" order="5"
type="virtual-media" rn="vm-read-write"/>
<lsbootLan rn="lan-read-only" access="read-only" order="2"
prot="pxe" type="lan" />
<lsbootStorage rn="storage-read-write" access="read-write" order="1"
type="storage" >
<lsbootLocalStorage rn="local-storage" />
</lsbootStorage>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

41

Examples of Common Server Management Tasks

<lsbootEfi rn="efi-read-only" access="read-only" order="4"

type="efi" />
</lsbootDef>
</outConfig>
</configResolveClass>

7. Retrieving Power Supply Unit Details on Server

Request:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388"
inHierarchical="false" classId="equipmentPsu"/>

Response:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" response="yes"
classId="equipmentPsu">
<outConfig>
<equipmentPsu id="1" model="UCSC-PSU-450W" operability="operable" power="on"
presence="equipped" serial="DCB1621010X" thermal="ok"
vendor="Cisco Systems Inc" voltage="unknown" dn="sys/rack-unit-1/psu-1" >
<equipmentPsu id="2" model="" operability="unknown" power="off"
presence="missing" serial="" thermal="unknown" vendor=""
voltage="unknown" dn="sys/rack-unit-1/psu-2" >
</outConfig>
</configResolveClass>

8. Retrieving Details of Fan Object Identified by DN

Request:
<configResolveDn cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388"
inHierarchical="false" dn="sys/rack-unit-1/fan-module-1-2/fan-2"/>

Response:
<configResolveDn cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" response="yes"
dn="sys/rack-unit-1/fan-module-1-2/fan-2">
<outConfig>
<equipmentFan id="2" model="" module="2" operability="operable" power="on"
presence="equipped" serial="" thermal="not-supported" tray="1" vendor=""
voltage="not-supported" dn="sys/rack-unit-1/fan-module-1-2/fan-2"/>
</outConfig>
</configResolveDn>

9. Retrieving SNMP Configuration Details

Request:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388"
inHierarchical="false" classId="commSnmp"/>

Response:
<configResolveClass cookie="1362107065/43d02d50-d6d4-16d4-8009-c979e5e53d50" response="yes"
classId="commSnmp">
<outConfigs>
<commSnmp dn="sys/svc-ext/snmp-svc" descr="SNMP Service" name="snmp" adminState="enabled"
port="161" proto="udp" community="" trapCommunity="public" com2Sec="disabled"
sysContact="who@where" sysLocation="unknown"/>
</outConfigs>
</configResolveClass>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

42

OL-25396-03

Examples of Common Server Management Tasks

10. Retrieving Status of Local Hard Disk on Server

Request:
<configResolveDn cookie="1313146313/b38e04a0-aa4c-1a4c-8008-cdac38e14388"
inHierarchical="false" dn="sys/rack-unit-1/board/disk-4"/>

Response:
<configResolveDn cookie="1313146313/b38e04a0-aa4c-1a4c-8008-cdac38e14388" response="yes"
dn="sys/rack-unit-1/board/disk-4">
<outConfig>
<storageLocalDiskSlotEp id="4" operability="operable" presence="equipped"
dn="sys/rack-unit-1/board/disk-4"/>
</outConfig>
</configResolveDn>

11. Power Cycling the Server

Request:
<configConfMo cookie="1313084260/40ea8058-aa3e-1a3e-8004-5e61c2e14388"
inHierarchical="false" dn="sys/rack-unit-1" >
<inConfig>
<computeRackUnit adminPower="cycle-immediate" dn="sys/rack-unit-1">
</computeRackUnit>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1313084260/40ea8058-aa3e-1a3e-8004-5e61c2e14388" response="yes">
dn="sys/rack-unit-1"
<outConfig>
<computeRackUnit dn="sys/rack-unit-1" adminPower="policy" availableMemory="49152"
model="R250-2480805W" memorySpeed="1067" name="UCS C250 M2" numOfAdaptors="1"
numOfCores="8" numOfCoresEnabled="8" numOfCpus="2" numOfEthHostIfs="0"
numOfFcHostIfs="0" numOfThreads="16" operPower="off"
originalUuid="100DC440-0EBC-11DF-3B97-8843E1C2615E" presence="equipped" serverId="1"
serial="PGS140601CS" totalMemory="49152" usrLbl="Cisco C210 Server"
uuid="100DC440-0EBC-11DF-3B97-8843E1C2615E" vendor="Cisco Systems Inc"
status="modified"/>
</outConfig>
</configConfMo>

12. Configuring EFI as the Second Boot Device in Boot Order Table
Request:
<configConfMo cookie="1313090863/ca79ef88-aa3f-1a3f-8006-5e61c2e14388"
inHierarchical="false"> dn="sys/rack-unit-1/boot-policy/efi-read-only"
<inConfig>
<lsbootEfi order="2" status="modified"
dn="sys/rack-unit-1/boot-policy/efi-read-only"
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1313090863/ca79ef88-aa3f-1a3f-8006-5e61c2e14388" response="yes">
dn="sys/rack-unit-1/boot-policy/efi-read-only"
<outConfig>
<lsbootEfi dn="sys/rack-unit-1/boot-policy/efi-read-only" access="read-only"
order="2" type="efi" status="modified"/>
</outConfig>
</configConfMo>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

43

Examples of Common Server Management Tasks

13. Removing Floppy Disk Drive as a Boot Device From the Boot Order List
Request:
<configConfMo cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388"
inHierarchical="true"> dn="sys/rack-unit-1/boot-policy/vm-read-write"
<inConfig>
<lsbootVirtualMedia order="5" access="read-write" status="deleted"
dn="sys/rack-unit-1/boot-policy/vm-read-write"/>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388" response="yes">
dn="sys/rack-unit-1/boot-policy/vm-read-write"
<outConfig>
</outConfig>
</configConfMo>

14. Configuring Boot Order to HDD, CDROM, FDD, PXE, and EFI Without Rebooting the Host
Request:
<configConfMo cookie="1360205300/79c672f0-d519-1519-8004-30339ee53d50"
inHierarchical="true" dn="sys/rack-unit-1/boot-policy">
<inConfig>
<lsbootDef dn="sys/rack-unit-1/boot-policy" rebootOnUpdate="no">
<lsbootVirtualMedia access="read-only" order="2" type="virtual-media"
rn="vm-read-only"/>
<lsbootVirtualMedia access="read-write" order="3" type="virtual-media"
rn="vm-read-write"/>
<lsbootLan rn="lan-read-only" access="read-only" order="4" prot="pxe" type="lan"/>
<lsbootStorage rn="storage-read-write" access="read-write" order="1" type="storage"
<lsbootLocalStorage rn="local-storage"/> </lsbootStorage>
<lsbootEfi rn="efi-read-only" access="read-only" order="5" type="efi"/>
</lsbootDef>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1360205300/79c672f0-d519-1519-8004-30339ee53d50" response="yes"
dn="sys/rack-unit-1/boot-policy">
<outConfig>
<lsbootDef dn="sys/rack-unit-1/boot-policy" name="boot-policy" purpose="operational"
rebootOnUpdate="no" status="modified">
<lsbootVirtualMedia access="read-only" order="2" type="virtual-media" rn="vm-read-only"
status="modified"/>
<lsbootVirtualMedia access="read-write" order="3" type="virtual-media"
rn="vm-read-write"
status="modified"/>
<lsbootLan rn="lan-read-only" access="read-only" order="4" prot="pxe" type="lan"
status="modified"/>
<lsbootStorage rn="storage-read-write" access="read-write" order="1" type="storage"
status="modified">
<lsbootLocalStorage rn="local-storage" status="modified"/>
</lsbootStorage>
<lsbootEfi rn="efi-read-only" access="read-only" order="5" type="efi"
status="modified"/>
</lsbootDef>
</outConfig>
</configConfMo>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

44

OL-25396-03

Examples of Common Server Management Tasks

15. Using inHierarchical Option to Change and Retrieve SNMP Configuration of Trap Receivers
Request:
<configConfMo cookie="1362115258/2c1b1380-d6d6-16d6-800b-c979e5e53d50"
inHierarchical="true" dn="sys/svc-ext/snmp-svc">
<inConfig>
<commSnmp dn="sys/svc-ext/snmp-svc" adminState="enabled" community="Top$ecrt"
trapCommunity="Dar$Good" com2Sec="full" sysContact="snmpadmin@cisco"
sysLocation="San Jose"/>
</inConfig>

Response:
<configConfMo cookie="1362115258/2c1b1380-d6d6-16d6-800b-c979e5e53d50" response="yes">
dn="sys/svc-ext/snmp-svc"
<outConfig>
<commSnmp dn="sys/svc-ext/snmp-svc" descr="SNMP Service" name="snmp"
adminState="enabled" port="161"
proto="udp" community="Top$ecrt" trapCommunity="Dar$Good"
com2Sec="full" sysContact="snmpadmin@cisco" sysLocation="San Jose"
status="modified">
<commSnmpTrap id="1" adminState="enabled" version="v2c" notificationType="informs"
hostname="20.40.59.222" user="unknown" rn="snmp-trap-1" status="modified"/>
<commSnmpTrap id="2" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-2" status="modified"/>
<commSnmpTrap id="3" adminState="enabled" version="v3" notificationType="traps"
hostname="129.33.200.98" user="stester4" rn="snmp-trap-3" status="modified"/>
<commSnmpTrap id="4" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-4" status="modified"/>
<commSnmpTrap id="5" adminState="enabled" version="v1" notificationType="traps"
hostname="12.44.75.33" user="unknown" rn="snmp-trap-5" status="modified"/>
<commSnmpTrap id="6" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-6" status="modified"/>
<commSnmpTrap id="7" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-7" status="modified"/>
<commSnmpTrap id="8" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0"user="unknown" rn="snmp-trap-8" status="modified"/>
<commSnmpTrap id="9" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-9" status="modified"/>
<commSnmpTrap id="10" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-10" status="modified"/>
<commSnmpTrap id="11" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-11" status="modified"/>
<commSnmpTrap id="12" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-12" status="modified"/>
<commSnmpTrap id="13" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-13" status="modified"/>
<commSnmpTrap id="14" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-14" status="modified"/>
<commSnmpTrap id="15" adminState="disabled" version="v3" notificationType="traps"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-15" status="modified"/>
<commSnmpUser id="2" name="stester4" securityLevel="noauthnopriv" auth=""
authPwd="" privacy="" privacyPwd="" rn="snmpv3-user-stester4" status="modified"/>
<commSnmpUser id="4" name="deer.koh-12" securityLevel="authpriv" auth="SHA"
authPwd="" privacy="AES" privacyPwd="" rn="snmpv3-user-deer.koh-12"
status="modified"/>
</commSnmp>
</outConfig>

16. Retrieving Select Memory RAS BIOS Token

Request:
<configResolveClass cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388"
inHierarchical="false" classId="biosVfSelectMemoryRASConfiguration"/>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

45

Examples of Common Server Management Tasks

Response:
<configResolveClass cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388" response="yes"
classId="biosVfSelectMemoryRASConfiguration">
<outConfig>
<biosVfSelectMemoryRASConfiguration
dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration"
vpSelectMemoryRASConfiguration="maximum-performance" >
</biosVfSelectMemoryRASConfiguration>
</outConfig>
</configResolveClass>

17. Configuring Select Memory RAS BIOS Token for Mirroring Mode
Request:
<configConfMo cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388"
inHierarchical="false"
dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration">
<inConfig>
<biosVfSelectMemoryRASConfiguration
dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration"
vpSelectMemoryRASConfiguration="mirroring">
</biosVfSelectMemoryRASConfiguration>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388" response="yes">
dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration"
<outConfig>
<biosVfSelectMemoryRASConfiguration
dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration"
vpSelectMemoryRASConfiguration="mirroring" status="modified"/>
</outConfig>
</configConfMo>

Note

After configuring the BIOS tokens, reboot the host for the configured tokens to reflect on the host side.

18. Retrieving C240 Server BIOS Token Values

Request:
<configResolveClass cookie="1360207841/1133b530-d51a-151a-8005-30339ee53d50"
inHierarchical="true" classId="biosSettings"/>

Response:
<configResolveClass cookie="1362115258/2c1b1380-d6d6-16d6-800b-c979e5e53d50" response="yes"
classId="biosSettings">
<outConfigs>
<biosSettings dn="sys/rack-unit-1/bios/bios-settings">
<biosVfIntelVTForDirectedIO rn="Intel-VT-for-directed-IO"
vpIntelVTDATSSupport="enabled" vpIntelVTDCoherencySupport="disabled"
vpIntelVTForDirectedIO="enabled"/>
<biosVfSelectMemoryRASConfiguration rn="SelectMemory-RAS-configuration"
vpSelectMemoryRASConfiguration="maximum-performance"/>
<biosVfProcessorC6Report rn="Processor-C6-Report" vpProcessorC6Report="enabled"/>
<biosVfIntelHyperThreadingTech rn="Intel-HyperThreading-Tech"
vpIntelHyperThreadingTech="enabled"/>
<biosVfEnhancedIntelSpeedStepTech rn="Enhanced-Intel-SpeedStep-Tech"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

46

OL-25396-03

Examples of Common Server Management Tasks

vpEnhancedIntelSpeedStepTech="enabled"/>
<biosVfIntelVirtualizationTechnolog rn="Intel-Virtualization-Technology"
vpIntelVirtualizationTechnology="enabled"/>
<biosVfMemoryMappedIOAbove4GB rn="Memory-mapped-IO-above-4GB"
vpMemoryMappedIOAbove4GB="disabled"/>
<biosVfCPUPerformance rn="CPU-Performance" vpCPUPerformance="enterprise"/>
<biosVfLvDIMMSupport rn="LvDIMM-Support" vpLvDDRMode="performance-mode"/>
<biosVfNUMAOptimized rn="NUMA-optimized" vpNUMAOptimized="enabled"/>
<biosVfConsoleRedirection rn="Console-redirection" vpBaudRate="115200"
vpConsoleRedirection="disabled" vpFlowControl="none" vpTerminalType="vt100"
vpPuttyKeyPad="ESCN" vpRedirectionAfterPOST="Always Enable"/>
<biosVfCoreMultiProcessing rn="Core-MultiProcessing" vpCoreMultiProcessing="all"/>
<biosVfIntelTurboBoostTech rn="Intel-Turbo-Boost-Tech"
vpIntelTurboBoostTech="enabled"/>
<biosVfDirectCacheAccess rn="Direct-Cache-Access" vpDirectCacheAccess="enabled"/>
<biosVfExecuteDisableBit rn="Execute-Disable-Bit" vpExecuteDisableBit="enabled"/>
<biosVfOSBootWatchdogTimer rn="OS-Boot-Watchdog-Timer-Param"
vpOSBootWatchdogTimer="disabled"/>
<biosVfOSBootWatchdogTimerPolicy rn="OS-Boot-Watchdog-Timer-Policy"
vpOSBootWatchdogTimerPolicy="power-off"/>
<biosVfOSBootWatchdogTimerTimeOut rn="OS-Boot-Watchdog-Timer-Time-Out"
vpOSBootWatchdogTimerPolicy="10-minutes"/>
<biosVfHardwarePrefetch rn="Hardware-Prefetch" vpHardwarePrefetch="enabled"/>
<biosVfAdjacentCacheLinePrefetch rn="Adjacent-Cache-Line-Prefetch"
vpAdjacentCacheLinePrefetch="enabled"/>
<biosVfFRB2Enable rn="FRB2-Enable" vpFRB2Enable="enabled"/>
<biosVfProcessorC1E rn="Processor-C1E" vpProcessorC1E="enabled"/>
<biosVfPatrolScrub rn="Patrol-Scrub-Param" vpPatrolScrub="enabled"/>
<biosVfTPMSupport rn="TPM-Support" vpTPMSupport="disabled"/>
<biosVfDCUPrefetch rn="DCU-Prefetch" vpStreamerPrefetch="enabled"
vpIPPrefetch="enabled"/>
<biosVfCPUPowerManagement rn="CPU-PowerManagement"
vpCPUPowerManagement="energy-efficient"/>
<biosVfCPUFrequencyFloor rn="CPU-FreqFloor" vpCPUFrequencyFloor="disabled"/>
<biosVfCPUEnergyPerformance rn="CPU-EngPerfBias"
vpCPUEnergyPerformance="balanced-performance"/>
<biosVfMemoryInterleave rn="Memory-Interleave" vpChannelInterLeave="auto"
vpRankInterLeave="auto"/>
<biosVfDemandScrub rn="Demand-Scrub-Param" vpDemandScrub="enabled"/>
<biosVfAltitude rn="Altitude-Param" vpAltitude="300-m"/>
<biosVfDRAMClockThrottling rn="DRAM-Clock-Throttling"
vpDRAMClockThrottling="Balanced"/>
<biosVfASPMSupport rn="ASPM-Support" vpASPMSupport="Disabled"/>
<biosVfVgaPriority rn="VgaPriority" vpVgaPriority="Onboard"/>
<biosVfUSBPortsConfig rn="USB-Ports-Config" vpAllUsbDevices="enabled"
vpUsbPortRear="enabled" vpUsbPortFront="enabled" vpUsbPortInternal="enabled"
vpUsbPortKVM="enabled" vpUsbPortVMedia="enabled" vpUsbPortSDCard="enabled"/>
<biosVfQPIConfig rn="QPI-Config" vpQPILinkFrequency="auto"/>
<biosVfLegacyUSBSupport rn="LegacyUSB-Support" vpLegacyUSBSupport="enabled"/>
<biosVfUCSMBootOrderRuleControl rn="Boot-Order-Rules"
vpUCSMBootOrderRule="Loose"/>
<biosVfPCIOptionROMs rn="PCI-OptionROMs" vpPCIOptionROMs="Enabled"/>
<biosVfLOMPortOptionROM rn="LOMPort-OptionROM" vpLOMPortsAllState="Enabled"
vpLOMPort0State="Enabled" vpLOMPort1State="Enabled" vpLOMPort2State="Enabled"
vpLOMPort3State="Enabled"/>
<biosVfPCISlotOptionROMEnable rn="PCI-Slot-OptionROM-Enable"
vpSlot1State="Enabled" vpSlot2State="Enabled" vpSlot3State="Enabled"
vpSlot4State="Enabled" vpSlot5State="Enabled" vpSlot6State="Enabled"
vpSlot7State="Enabled" vpSlot1LinkSpeed="GEN3" vpSlot2LinkSpeed="GEN3"
vpSlot3LinkSpeed="GEN3" vpSlot4LinkSpeed="GEN3" vpSlot5LinkSpeed="GEN3"
vpSlot6LinkSpeed="GEN3" vpSlot7LinkSpeed="GEN3"/>
<biosVfPStateCoordType rn="p-state-coord" vpPStateCoordType="HW ALL"/>
<biosVfDramRefreshRate rn="dram-refresh-rate" vpDramRefreshRate="2x"/>
</biosSettings>
</outConfigs>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

47

Examples of Common Server Management Tasks

19. Retrieving Default Values of BIOS Tokens

Request:
<configResolveClass cookie='1307953743/b63ff130-a593-1593-8004-2e4ac2e14388'
classId='biosPlatformDefaults' inHierarchical='true'>

Response:
<configResolveClass cookie="1370842491/23c0a810-dec6-1ec6-8002-1ec9e1a85750"
response="yes" classId="biosPlatformDefaults">
<outConfigs>
<biosPlatformDefaults dn="sys/rack-unit-1/bios/bios-defaults" >
<biosVfIntelVTForDirectedIO rn="Intel-VT-for-directed-IO"
vpIntelVTDATSSupport="enabled"
vpIntelVTDCoherencySupport="disabled"
vpIntelVTForDirectedIO="enabled" >
</biosVfIntelVTForDirectedIO>
<biosVfSelectMemoryRASConfiguration rn="SelectMemory-RAS-configuration"
vpSelectMemoryRASConfiguration="maximum-performance" >
</biosVfSelectMemoryRASConfiguration>
<biosVfProcessorC6Report rn="Processor-C6-Report"
vpProcessorC6Report="enabled" >
</biosVfProcessorC6Report><biosVfIntelHyperThreadingTech rn="Intel-HyperThreading-Tech"
vpIntelHyperThreadingTech="enabled" >
</biosVfIntelHyperThreadingTech>
<biosVfEnhancedIntelSpeedStepTech rn="Enhanced-Intel-SpeedStep-Tech"
vpEnhancedIntelSpeedStepTech="enabled" >
</biosVfEnhancedIntelSpeedStepTech>
<biosVfIntelVirtualizationTechnology rn="Intel-Virtualization-Technology"
vpIntelVirtualizationTechnology="enabled" >
</biosVfIntelVirtualizationTechnology>
.
.
.
</biosVfLOMPortOptionROM><biosVfPCISlotOptionROMEnable rn="PCI-Slot-OptionROM-Enable"
vpSlot1State="Enabled"
vpSlot2State="Enabled"
vpSlotMezzState="Enabled"
vpSlot2LinkSpeed="GEN3" >
</biosVfPCISlotOptionROMEnable><biosVfPStateCoordType rn="p-state-coord"
vpPStateCoordType="HW ALL" >
</biosVfPStateCoordType>
<biosVfDramRefreshRate rn="dram-refresh-rate"
vpDramRefreshRate="2x" >
</biosVfDramRefreshRate>
</biosPlatformDefaults>
</outConfigs>
</configResolveClass>

20. Configuring BIOS Settings Parameters to Default Values

Request:
<configConfMo cookie="0000020175/b2909140-0004-1004-8002-cdac38e14388"
dn="sys/rack-unit-1/bios/bios-settings" inHierarchical="true">

Response:
<configConfMo cookie="1370842491/23c0a810-dec6-1ec6-8002-1ec9e1a85750"
response="yes" dn="sys/rack-unit-1/bios/bios-settings">
<outConfigs>
<biosPlatformDefaults dn="sys/rack-unit-1/bios/bios-defaults" status="modified">
<biosVfIntelVTForDirectedIO rn="Intel-VT-for-directed-IO"
vpIntelVTDATSSupport="enabled"
vpIntelVTDCoherencySupport="disabled"
vpIntelVTForDirectedIO="enabled" status="modified">
</biosVfIntelVTForDirectedIO>
<biosVfSelectMemoryRASConfiguration rn="SelectMemory-RAS-configuration"
vpSelectMemoryRASConfiguration="maximum-performance" status="modified">
</biosVfSelectMemoryRASConfiguration>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

48

OL-25396-03

Examples of Common Server Management Tasks

<biosVfProcessorC6Report rn="Processor-C6-Report"
vpProcessorC6Report="enabled" status="modified">
</biosVfProcessorC6Report>
<biosVfIntelHyperThreadingTech rn="Intel-HyperThreading-Tech"
vpIntelHyperThreadingTech="enabled" status="modified">
</biosVfIntelHyperThreadingTech>
<biosVfEnhancedIntelSpeedStepTech rn="Enhanced-Intel-SpeedStep-Tech"
vpEnhancedIntelSpeedStepTech="enabled" status="modified">
</biosVfEnhancedIntelSpeedStepTech>
<biosVfIntelVirtualizationTechnology rn="Intel-Virtualization-Technology"
vpIntelVirtualizationTechnology="enabled" status="modified">
</biosVfIntelVirtualizationTechnology>
.
.
.
</biosVfLOMPortOptionROM><biosVfPCISlotOptionROMEnable rn="PCI-Slot-OptionROM-Enable"
vpSlot1State="Enabled"
vpSlot2State="Enabled"
vpSlotMezzState="Enabled"
vpSlot2LinkSpeed="GEN3" status="modified">
</biosVfPCISlotOptionROMEnable><biosVfPStateCoordType rn="p-state-coord"
vpPStateCoordType="HW ALL" status="modified">
</biosVfPStateCoordType>
<biosVfDramRefreshRate rn="dram-refresh-rate"
vpDramRefreshRate="2x" status="modified">
</biosVfDramRefreshRate>
</biosPlatformDefaults>
</outConfigs>
</configResolveClass>

21. Using Platform-Default to Configure BIOS Parameters to Default Values

Request:
<configConfMo cookie="0000020175/b2909140-0004-1004-8002-cdac38e14388"
inHierarchical="true" dn="sys/rack-unit-1/bios/bios-settings" >
<inConfig>
<biosSettings>
<biosVfIntelVTForDirectedIO
dn="sys/rack-unit-1/bios/bios-settings/Intel-VT-for-directed-IO"
vpIntelVTDATSSupport="platform-default" vpIntelVTDCoherencySupport="platform-default"
vpIntelVTForDirectedIO="platform-default"/>
<biosVfSelectMemoryRASConfiguration
dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration"
vpSelectMemoryRASConfiguration="platform-default"/>
<biosVfProcessorC6Report
dn="sys/rack-unit-1/bios/bios-settings/Processor-C6-Report"
.
.
.
vpSlot2State="platform-default" vpSlotMezzState="platform-default"
vpSlot1LinkSpeed="platform-default" vpSlot2LinkSpeed="platform-default"/>
<biosVfPStateCoordType dn="sys/rack-unit-1/bios/bios-settings/p-state-coord"
vpPStateCoordType="platform-default"/>
</biosSettings>
</inConfig>

Response:
<configConfMo cookie="1347919470/f5335af8-c9ec-19ec-8007-1ec9e1a85750" response="yes">
dn="sys/rack-unit-1/mgmt/fw-updatable"
<outConfig>
<biosSettings dn="sys/rack-unit-1/bios/bios-settings" status="modified" >
<biosVfIntelVTForDirectedIO rn="Intel-VT-for-directed-IO"
vpIntelVTDATSSupport="enabled" vpIntelVTDCoherencySupport="disabled"
vpIntelVTForDirectedIO="enabled" status="modified" >
</biosVfIntelVTForDirectedIO>
<biosVfSelectMemoryRASConfiguration rn="SelectMemory-RAS-configuration"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

49

Examples of Common Server Management Tasks

vpSelectMemoryRASConfiguration="maximum-performance" status="modified" >

.
.
.
vpSlot1State="enabled" vpSlot2State="enabled" vpSlotMezzState="enabled"
vpSlot1LinkSpeed="GEN3" vpSlot2LinkSpeed="GEN3" status="modified"
</biosVfPCISlotOptionROMEnable>
<biosVfPStateCoordType rn="p-state-coord" vpPStateCoordType="HW_ALL"
status="modified" >
</biosVfPStateCoordType>
</biosSettings>
</outConfig>
</configConfMo>

Note

The request and response in the preceding example is not the complete output, only a part of it has been
included.
This will set the BIOS parameters such as the Processor, Memory, QPI, PCI, Serial, LOM and PCIe slots
configuration settings to platform-default values. Similarly, you can configure the BIOS parameters by
changing the platform-default input parameter in the example to what you want to configure.
22. Using TFTP to Export CIMC Configuration Data
Request:
<configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false"> dn="sys/export-config"
<inConfig>
<mgmtBackup dn="sys/export-config" adminState="enabled" hostname="198.xx.210.xx"
remoteFile="/tftpserver/c250_config_export.cfg"/>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes">
dn="sys/export-config"
<outConfig>
<mgmtBackup dn="sys/export-config" adminState="disabled"
fsmStageDescr="Completed successfully" fsmRmtInvErrCode=""
fsmRmtInvErrDescr="NONE"
fsmDescr="export-config" proto="tftp" hostname="" remoteFile=""
status="modified"/>
</outConfig>
</configConfMo>

The preceding request launches the export operation, which executes as a background task.
The exported configuration file resembles the following example:
[root]# cat /tftpserver/c250_config_export.cfg
<root><cimc>
<version>1.4(0.22)</version>
<network>
<hostname>ucs-c250-M2</hostname>
<mode>dedicated</mode>
<redundancy>active-standby</redundancy>
<dns-use-dhcp>no</dns-use-dhcp>
<preferred-dns-server>0.0.0.0</preferred-dns-server>
<alternate-dns-server>0.0.0.0</alternate-dns-server>
<vlan-enabled>no</vlan-enabled>
.
.
.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

50

OL-25396-03

Examples of Common Server Management Tasks

TFTP used in the preceding example is the default protocol. You can also export the CIMC configuration
using the other available protocols such as the ftp, sftp, scp and http. Exporting using the ftp, sftp and scp
requires user credentials, as shown in the following example:
Request:
configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false" dn="sys/export-config"
<inConfig>
<mgmtBackup dn="sys/export-config" adminState="enabled"
hostname="bxxxa-xxx-fileserver.cisco.com" proto="ftp"
user="username" pwd="password" remoteFile="/home/xxxxx/ppapi.xml" >
/inConfig>

Response:
<configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes">
dn="sys/export-config"
<outConfig>
<mgmtBackup dn="sys/export-config" adminState="disabled"
fsmStageDescr="Completed successfully" fsmRmtInvErrCode=""
fsmRmtInvErrDescr="NONE"
fsmDescr="export-config" proto="ftp" hostname="" remoteFile=""
User="" pwd="" status="modified"/>
</outConfig>
</configConfMo>

23. Using TFTP to Import CIMC Configuration Data

Request:
<configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false"> dn="sys/import-config"
<inConfig>
<mgmtImporter dn="sys/import-config" adminState="enabled"
hostname="198.29.210.14" remoteFile="/tftpserver/c250_config_export.cfg"/>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes">
dn="sys/import-config"
<outConfig>
<mgmtImporter dn="sys/import-config" adminState="disabled"
fsmStageDescr="Error" fsmRmtInvErrCode="" fsmRmtInvErrDescr="NONE"
fsmDescr="import-config" proto="tftp" hostname="" remoteFile=""
status="modified"/>
</outConfig>
</configConfMo>

The preceding request launches the import operation, which executes as a background task. You can
periodically query for the completion status by sending the following requests:
Status request:
<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false" classId="mgmtImporter"/>

Status response before completion:

<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes"
classId="mgmtImporter">
<outConfig>
<mgmtImporter dn="sys/import-config" adminState="enabled"
fsmStageDescr="Applying configuration" fsmRmtInvErrCode=""
fsmRmtInvErrDescr="NONE" fsmDescr="import-config" proto="none" hostname=""

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

51

Examples of Common Server Management Tasks

remoteFile="" user="" pwd=""/>

</outConfig>
</configResolveClass>

Repeated status request:

<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false" classId="mgmtImporter"/>

Status response after completion:

<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes"
classId="mgmtImporter">
<outConfig>
<mgmtImporter dn="sys/import-config" adminState="disabled"
fsmStageDescr="Completed successfully" fsmRmtInvErrCode=""
fsmRmtInvErrDescr="NONE" fsmDescr="import-config" proto="none" hostname=""
remoteFile="" user="" pwd=""/>
</outConfig>
</configResolveClass>

24. Using TFTP to Export CIMC Technical Support Data

Request:
<configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false">
dn="sys/rack-unit-1/tech-support"
<inConfig>
<sysdebugTechSupportExport dn="sys/rack-unit-1/tech-support" adminState="enabled"
remoteFile="/tftpserver/c250_techsupport_archive.tgz" proto="tftp"
hostname="198.xx.xxx.14"/>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes">
dn="sys/rack-unit-1/tech-support"
<outConfig>
<sysdebugTechSupportExport dn="sys/rack-unit-1/tech-support" adminState="disabled"
hostname="198.xx.xxx.14" proto="tftp"
remoteFile="/tftpserver/c250_techsupport_archive.tgz" fsmStageDescr="none"
fsmProgr="0" fsmStatus="nop" status="modified"/>
</outConfig>
</configConfMo>

The preceding request launches the technical support generation, after technical support data is generated,
it is uploaded to the remote location. You can periodically query for the completion status by sending the
following requests:
Status request:
<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false" classId="sysdebugTechSupportExport"/>

Status response before completion:

<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes"
classId="sysdebugTechSupportExport">
<outConfig>
<sysdebugTechSupportExport dn="sys/rack-unit-1/tech-support" adminState="enabled"
hostname="198.29.210.14" proto="tftp"
remoteFile="/tftpserver/c250_techsupport_archive.tgz"
fsmStageDescr="collecting" fsmProgr="0" fsmStatus="exporting"/>
</outConfig>
</configResolveClass>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

52

OL-25396-03

Examples of Common Server Management Tasks

Repeated status request:

<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388"
inHierarchical="false" classId="sysdebugTechSupportExport"/>

Status response after completion:

<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes"
classId="sysdebugTechSupportExport">
<outConfig>
<sysdebugTechSupportExport dn="sys/rack-unit-1/tech-support" adminState="disabled"
hostname="198.29.210.14" proto="tftp"
remoteFile="/tftpserver/c250_techsupport_archive.tgz"
fsmStageDescr="completed" fsmProgr="100" fsmStatus="success"/>
</outConfig>
</configResolveClass>

The exported technical support file resembles the following example:

[root]# tar tvfz /tftpserver/c250_techsupport_archive.tgz | more
drwxr-xr-x root/root
0 2011-08-11 13:01:10 obfl/
-rw-r--r-- root/root
76910 2011-08-11 13:00:56 obfl/obfl-log.1
-rw-r--r-- root/root
76835 1970-01-01 09:38:26 obfl/obfl-log.2
-rw-r--r-- root/root
76881 2011-08-08 21:20:55 obfl/obfl-log.3
-rw-r--r-- root/root
76916 1969-12-31 16:07:28 obfl/obfl-log.4
-rw-r--r-- root/root
76846 2011-08-03 21:38:49 obfl/obfl-log.5
-rw-r--r-- root/root
14598 2011-08-11 20:49:57 obfl/obfl-log
.
.
.

25. Retrieving CPU Product ID Details

Request:
configResolveClass cookie='1357782291/53277080-d2e5-12e5-8003-3e02e2a85750
inHierarchical='true' classId='pidCatalogCpu'

Response:
<configResolveClass cookie="1357782291/53277080-d2e5-12e5-8003-3e02e2a85750" response="yes"
classId="pidCatalogCpu">
<outConfigs>
<pidCatalogCpu id="1" socketdesignation="CPU1" description=" Intel(R) Xeon(R) E5-2690
2.90GHz 8-core 135W 20MB Cache DDR3 1600MHz "
pid=" UCS-CPU-E5-2690 " model=" Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz"
signature=" Type 0, Family 6, Model 45, Stepping 7 " currentspeed="2900"
operState=" Enabled" dn="sys/rack-unit-1/board/pid/pid-cpu-1" >
</pidCatalogCpu>
</outConfigs>
</configResolveClass>

26. Retrieving IMM/ Memory Unit Product ID Details

Request:
configResolveClass cookie="1357782291/53277080-d2e5-12e5-8003-3e02e2a85750"
inHierarchical='true' classId='pidCatalogDimm'

Response:
<configResolveClass cookie="1357782291/53277080-d2e5-12e5-8003-3e02e2a85750" response="yes"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

53

Examples of Common Server Management Tasks

classId="pidCatalogDimm">
<outConfigs>
<pidCatalogDimm name="DIMM_A1"
description="8GB DDR3-1600-MHz RDIMM/PC3-12800/dual rank/1.35v "
pid=" UCS-MR-1X082RY-A " mfgid=" 0xCE00" manufacturer=" Samsung Electronics, Inc."
serialnumber=" 334 CEB5E " model=" M393B1K70DH0-YK0 " capacity=" 8192 MB " speed="1600"
datawidth=" 64 bits " operability=" Operable "
dn="sys/rack-unit-1/board/pid/pid-dimm-DIMM_A1"
</pidCatalogDimm>
</outConfigs>
</configResolveClass>

27. Retrieving HDD Product ID Details

Request:
configResolveClass cookie="1357782291/53277080-d2e5-12e5-8003-3e02e2a85750"
inHierarchical='true' classId='pidCatalogHdd'

Response:
<configResolveClass cookie="1347487081/48d138e8-c988-1988-8005-1ec9e1a85750" response="yes"
classId="pidCatalogHdd">
<outConfigs>
<pidCatalogHdd disk="0" controller=" SLOT-MEZZ "
description=" 100GB 7mm Z SATA SSD/hot plug/sled mounted "
pid=" UCS-SD100G0KA2-E " vendor=" ATA " model=" INTEL SSDSA2BZ10 "
serialnumber=" CVLV1402017C100AGN " dn="sys/rack-unit-1/board/pid/pid-hdd-0" >
</pidCatalogHdd>
<pidCatalogHdd disk="1" controller=" SLOT-MEZZ "
description=" 100GB 7mm Z SATA SSD/hot plug/sled mounted"
pid=" UCS-SD100G0KA2-E " vendor=" ATA " model=" INTEL SSDSA2BZ10 "
serialnumber=" CVLV1373008M100AGN " dn="sys/rack-unit-1/board/pid/pid-hdd-1" >
</pidCatalogHdd>
</outConfigs>
</configResolveClass>

28. Retrieving PCI Adapter Product ID Details

Request:
<configResolveClass cookie='1307953743/b63ff130-a593-1593-8004-2e4ac2e14388'
inHierarchical='true' classId='pidCatalogPCIAdapter'>

Response:
<configResolveClass cookie="1347487081/48d138e8-c988-1988-8005-1ec9e1a85750" response="yes"
classId="pidCatalogPCIAdapter">
<outConfigs>
<pidCatalogPCIAdapter slot="1"
description=" Cisco UCS P81E Dual Port 10Gb Ethernet and 4G Fibre Channel CNA "
pid=" N2XX-ACPCI01 " vendor="0x1137" device="0x0042" subvendor="0x1137"
subdevice="0x0047" dn="sys/rack-unit-1/board/pid/pid-pciadapter-1" >
</pidCatalogPCIAdapter>
<pidCatalogPCIAdapter slot="M"
description=" Cisco UCSC RAID SAS 2008M-8i Mezzanine card (RAID 0,1,5,10) "
pid=" UCSC-RAID-11-C220 " vendor="0x1000" device="0x0073" subvendor="0x1137"
subdevice="0x00b0" dn="sys/rack-unit-1/board/pid/pid-pciadapter-M" >
</pidCatalogPCIAdapter>
</outConfigs>
</configResolveClass>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

54

OL-25396-03

Examples of Common Server Management Tasks

29. Retrieving Firmware Update Details

Request:
configResolveClass cookie="1357782291/53277080-d2e5-12e5-8003-3e02e2a85750"
inHierarchical='true' classId='firmwareUpdatable'

Response:
<configResolveClass cookie="1359503102/fb784cf0-d475-1475-8003-ca489ee53d50" response="yes"
classId="firmwareUpdatable">
<outConfigs>
<firmwareUpdatable dn="sys/rack-unit-1/bios/fw-updatable" adminState="triggered"
deployment="primary" operState="ready" version="C22M3.1.5.1c.0(Build Date: 01/31/2013)"
protocol="none" remoteServer="" remotePath="" user="" pwd=""
progress="None, OK" type="blade-bios" >
<firmwareUpdatable dn="sys/rack-unit-1/mgmt/fw-updatable" adminState="triggered"
deployment="backup" operState="ready" version="1.5(1b)" protocol="none"
remoteServer="" remotePath="" user="" pwd="" progress="Success"
type="blade-controller"
</firmwareUpdatable>
</outConfigs>
</configResolveClass>

30. Updating CIMC Firmware

Request:
<configConfMo cookie="0000020175/b2909140-0004-1004-8002-cdac38e14388"
inHierarchical="true"> dn="sys/rack-unit-1/mgmt/fw-updatable"
<inConfig>
<firmwareUpdatable adminState='trigger' dn='sys/rack-unit-1/mgmt/fw-updatable'
protocol='tftp' remoteServer='10.xxx.196.xxx' remotePath='HP-SL2.bin'
type='blade-controller' />
</inConfig>

Response:
<configConfMo cookie="1347919470/f5335af8-c9ec-19ec-8007-1ec9e1a85750" response="yes">
dn="sys/rack-unit-1/mgmt/fw-updatable"
<outConfig>
<firmwareUpdatable dn="sys/rack-unit-1/mgmt/fw-updatable" adminState="triggered"
deployment="backup" operState="updating" version="1.5(0.10)"
protocol="" remoteServer="" remotePath="" user="" pwd="" progress="0"
type="blade-controller" status="modified" >
</firmwareUpdatable>
</outConfig>
</configConfMo>

31. Updating BIOS Firmware

Request:
<configConfMo cookie="0000020175/b2909140-0004-1004-8002-cdac38e14388"
inHierarchical="true" dn="sys/rack-unit-1/bios/fw-updatable">
<inConfig>
<firmwareUpdatable adminState='trigger' dn='sys/rack-unit-1/bios/fw-updatable'
protocol='tftp' remoteServer='10.xxx.196.xxx' remotePath='HP-SL2.cap'
type='blade-bios' />
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1347919470/f5335af8-c9ec-19ec-8007-1ec9e1a85750" response="yes">
dn="sys/rack-unit-1/mgmt/fw-updatable"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

55

Examples of Common Server Management Tasks

<outConfig>
<firmwareUpdatable dn="sys/rack-unit-1/bios/fw-updatable" adminState="triggered"
deployment="primary" operState="updating" version="C220M3.1.5.0.3
(Build Date: 10/02/2013)" protocol="none" remoteServer="" remotePath="" user=""
pwd="" progress="Image Header Download (0 %)" type="blade-bios" >
</firmwareUpdatable>
</outConfig>
</configConfMo>

The preceding CIMC and BIOS firmware upgrade examples use tftp as the protocol, similarly you can use
other available protocols, such as ftp, sftp, scp and http. When you use the sftp, ftp or scp protocol while
updating, username and password has to be specified in the input parameters.

Note

BIOS firmware update using the XML APIs is supported only for the following servers:
Cisco UCS C22 M3 Server
Cisco UCS C24 M3 Server
Cisco UCS C220 M3 Server
Cisco UCS C240 M3 Server
Cisco UCS C420 M3 Server

32. Using Non-Interactive HUU to Update Firmware on all C-Series Server Components
Request:
<configConfMo cookie="0000020175/b2909140-0004-1004-8002-cdac38e14388"
inHierarchical="true" dn='sys/huu/firmwareUpdater'>
<inConfig>
<huuFirmwareUpdater dn='sys/huu/firmwareUpdater' adminState='trigger'
remoteIp='10.xxx.xxx.99' remoteShare='/home/xxxxxx/ucs-c220-huu-1.5.0.67.iso'
mapType='cifs' username='user' password='pwd' stopOnError='yes'
timeOut='25' verifyUpdate='yes' updateComponent='all' />
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1350352739/7f611c78-cc23-1c23-8004-1ec9e1a85750" response="yes">
dn="sys/huu/firmwareUpdater"
<outConfigs>
<huuFirmwareUpdater dn="sys/huu/firmwareUpdater" adminState="triggered"
remoteIp="10.xxx.xxx.99" remoteSharePath="/home/xxxxx/ucs-c220-huu-1.5.0.67.iso"
remoteShareFile="ucs-c220-huu-1.5.0.67.iso" mapType="cifs" username="user"
password="pwd" stopOnError="yes" timeOut="25" verifyUpdate="no"
updateComponent="all" >
<huuFirmwareUpdateStatus rn="updateStatus" overallStatus="Rebooting host in to HUU."
currentTime="Tue Feb
</outConfigs>
</configResolveClass>

5 02:33:01 2013 " updateStartTime="NA" updateEndTime="NA" >

The preceding example initiates and updates the firmware on all components of the server, you can periodically
run the following request to check the status of the update:
Status request:
<configResolveClass cookie="1360030993/e4404760-d4f0-14f0-8004-1ec9e1a85750"
inHierarchical="true" classId="huuFirmwareUpdater">

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

56

OL-25396-03

Examples of Common Server Management Tasks

Response:
<configResolveClass cookie="1360030993/e4404760-d4f0-14f0-8004-1ec9e1a85750" response="yes"
classId="huuFirmwareUpdater">
<outConfigs>
<huuFirmwareUpdater dn="sys/huu/firmwareUpdater" adminState="triggered"
remoteIp="http://10.xxx.xxx.99" remoteSharePath="/home/xxxx/ucs-c220-huu-1.5.0.67.iso"
remoteShareFile="ucs-c220-huu-1.5.0.67.iso" mapType="cifs"username="user"
password="pwd" stopOnError="yes" timeOut="25" verifyUpdate="no" updateComponent="all"
>
<huuFirmwareUpdateStatus rn="updateStatus"
overallStatus="CIMC,LOM,PCI,STORAGE update successful. BIOS update in progress."
currentTime="Tue Feb 5 02:48:42 2013" updateStartTime="Tue Feb 5 02:28:06 2013"
updateEndTime="NA" >
<huuUpdateComponentStatus component="CIMC" description="CIMC" slot="NA"
runningVersion="1.5(0.69)" newVersion="1.5(0.67)" macAddr="NA"
vendorId="NA" deviceId="NA" subVendorId="NA" subDeviceId="NA" cntrlId="0"
updateStatus="Completed" errorDescription="NA" verifyStatus="NA"
rn="component-CIMC" >
<huuUpdateComponentStatus component="LOM" description="I350" slot="NA"
runningVersion="1.61-02.12-2.7.111-1.3.98-5.1.01-2.7.111"
newVersion="1.61-02.12-2.7.111-1.3.98-5.1.01-2.7.111" macAddr="5057A8E1C922"
vendorId="8086" deviceId="1521" subVendorId="1137" subDeviceId="008A"
cntrlId="0" updateStatus="Completed" errorDescription="NA"
verifyStatus="NA" rn="component-LOM" >
<huuUpdateComponentStatus component="STORAGE" description="2008M-8i" slot="M"
runningVersion="2.130.364-2185" newVersion="2.130.364-2185" macAddr="NA"
vendorId="NA" deviceId="NA" subVendorId="NA" subDeviceId="NA" cntrlId="0"
updateStatus="Completed" errorDescription="NA" verifyStatus="NA"
rn="component-STORAGE" >
<huuUpdateComponentStatus component="PCI" description="UCS VIC 1225" slot="1"
runningVersion="2.1(1.110)-uboot-2.1(1.110)" newVersion="2.1(1.108)-uboot-2.1(1.108)"
macAddr="0200544D474D" vendorId="1137" deviceId="0042" subVendorId="1137"
subDeviceId="0085" cntrlId="0" updateStatus="Completed" errorDescription="NA"
verifyStatus="NA" rn="component-PCI" >
<huuUpdateComponentStatus component="BIOS" description="BIOS" slot="NA"
runningVersion="C220M3.1.5.1c.0.013120130456"
newVersion="C220M3.1.5.1b.0.012720130527" macAddr="NA" vendorId="NA" deviceId="NA"
subVendorId="NA" subDeviceId="NA" cntrlId="0" updateStatus="InProgress"
errorDescription="NA" verifyStatus="NA" rn="component-BIOS" >
</huuFirmwareUpdateStatus>
</huuFirmwareUpdater>
</outConfigs>
</configResolveClass>

Note

You can choose a specific components in the updateComponent ' ' parameter to update the firmware only
for that component.

33. Using TFTP to Import VIC Adapter Configuration Data

Request:
<configConfMo cookie='1310455827/46139440-a7da-17da-8003-304ac2e14388'
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/import-config">
<inConfig>
<adpatorCfgImporter dn="sys/rack-unit-1/adaptor-1/import-config"
adminState="enabled" proto="tftp" hostname="10.xxx.236.xx"
remoteFile="/tftpserver/tftpapi.xml" >
</adpatorCfgImporter>
</inConfig>
</configConfMo>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

57

Examples of Common Server Management Tasks

Response:
<configConfMo
cookie="1347919470/f5335af8-c9ec-19ec-8007-1ec9e1a85750" response="yes">
dn="sys/rack-unit-1/adaptor-1/import-config"
<outConfig>
<adpatorCfgImporter dn="sys/rack-unit-1/adaptor-1/import-config"
adminState="triggered" descr="import-config" proto="none"
hostname="" remoteFile="" user="" pwd="" status="modified"
</adpatorCfgImporter>
</outConfig>

34. Using TFTP to Update VIC Firmware

Request:
<configConfMo cookie="0000020175/b2909140-0004-1004-8002-cdac38e14388"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/mgmt/fw-updatable" >
<inConfig>
<firmwareUpdatable adminState='trigger'
dn='sys/rack-unit-1/adaptor-1/mgmt/fw-updatable'
protocol='tftp' remoteServer='10.xxx.236.xx'
remotePath='/home/xxxx/ftp/upd-pkg-ucs-p81e-vic-2.1.0.410.bin' type='adaptor' />
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1347919470/f5335af8-c9ec-19ec-8007-1ec9e1a85750" response="yes">
dn="sys/rack-unit-1/adaptor-1/mgmt/fw-updatable"
<outConfig>
<firmwareUpdatable dn="sys/rack-unit-1/adaptor-1/mgmt/fw-updatable"
adminState="triggered" deployment="backup" version="2.x(0.xxx)"
protocol="none" remoteServer="" remotePath="" user="" pwd="" progress=""
type="adaptor" status="modified"
</firmwareUpdatable>
</outConfig>

The preceding example initiates and updates the firmware on VIC, you can periodically run the following
request to check the status of the update:
Status request:
<configResolveDn cookie="1350860496/b80c15e8-cc99-1c99-8011-1fc9e1a85750"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/mgmt/fw-updatable"/>

Status response after completion:

<configResolveDn cookie="1350860496/b80c15e8-cc99-1c99-8011-1fc9e1a85750" response="yes"
dn="sys/rack-unit-1/adaptor-1/mgmt/fw-updatable">
<outConfig>
<firmwareUpdatable dn="sys/rack-unit-1/adaptor-1/mgmt/fw-updatable" adminState="triggered"
deployment="backup" version="2.x(0.xxx)" protocol="tftp" remoteServer="" remotePath=""
user="" pwd="" progress="Successful" type="adaptor" >
</firmwareUpdatable>
</outConfig>
</configResolveDn>

35. Configuring VIC Adapter Parameters

Request:
<configConfMo cookie="1351062607/c6c74fd8-ccc8-1cc8-8005-1ec9e1a85750"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1" >
<inConfig>
<adaptorUnit id="1" description="SL1-PP-System" adminState="adaptor-reset-default"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

58

OL-25396-03

Examples of Common Server Management Tasks

dn="sys/rack-unit-1/adaptor-1" ><adaptorGenProfile
dn="sys/rack-unit-1/adaptor-1/general"
fipMode="enabled" vntagMode="enabled" numOfVMFexIfs="10" />
</adaptorUnit>
</inConfig>
</configConfMo

Response:
<configConfMo cookie="1351062607/c6c74fd8-ccc8-1cc8-8005-1ec9e1a85750" response="yes">
dn="sys/rack-unit-1/adaptor-1"
<outConfig>
<adaptorGenProfile dn="sys/rack-unit-1/adaptor-1/general" pciSlot="1"
productName="UCS VIC P81E" model="N2XX-ACPCI01" serial="QCI1417A0R1"
revision="4" fipMode="Enabled" vntagMode="Enabled"
iscsiBootSupported="True" configurationPending="yes"
numOfVMFexIfs="10" vendorId="V00" vendor="Cisco Systems Inc"
status="modified" >
</adaptorGenProfile>
</outConfig>
</configConfMo>

36. Retrieving VIC Adapter General Profile Details

Request:
<configResolveClass cookie='1301262014/6a0d66ca-3b1a-49e1-b5d4-334749717158'
inHierarchical='true' classId='adaptorGenProfile' >

Response:
<configResolveClass cookie="1351041725/ea270770-ccc3-1cc3-8003-1ec9e1a85750" response="yes"
classId="adaptorGenProfile">
<outConfigs>
<adaptorGenProfile dn="sys/rack-unit-1/adaptor-1/general" pciSlot="1" productName="UCS
VIC P81E" model="N2XX-ACPCI01" serial="QCI1417A0R1" revision="4"
fipMode="Enabled" vntagMode="Disabled" iscsiBootSupported="True"
configurationPending="no" numOfVMFexIfs="0" vendorId="V00"
vendor="Cisco Systems Inc" >
</adaptorGenProfile>
</outConfigs>
</configResolveClass>

37. Retrieving VIC Adapter Uplink Port Details

Request:
<configResolveClass cookie='1301262014/6a0d66ca-3b1a-49e1-b5d4-334749717158'
inHierarchical='true' classId='adaptorExtEthIf' >

Response:
<configResolveClass cookie="1351068944/40861218-ccca-1cca-8008-1ec9e1a85750" response="yes"
classId="adaptorExtEthIf">
<outConfigs>
<adaptorExtEthIf portId="0" ifType="physical" linkState="up"
mac="00:22:BD:D6:40:3F" transport="CE" adminSpeed="10Gbps"
operSpeed="10Gbps" dn="sys/rack-unit-1/adaptor-1/ext-eth-0" >
</adaptorExtEthIf>
<adaptorExtEthIf portId="1" ifType="physical" linkState="up"
mac="00:22:BD:D6:40:40" transport="CE" adminSpeed="10Gbps"
operSpeed="10Gbps" dn="sys/rack-unit-1/adaptor-1/ext-eth-1" >
</adaptorExtEthIf>
</outConfigs>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

59

Examples of Common Server Management Tasks

38. Setting Uplink Port Speed of a VIC Adapter

Request:
<configConfMo cookie="1351178995/e00e6970-cce3-1ce3-8008-fe9beabd2200"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/ext-eth-0">
<inConfig>
<adaptorExtEthIf portId="0" adminSpeed="10Gbps"
dn="sys/rack-unit-1/adaptor-1/ext-eth-0" >
</adaptorExtEthIf>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1351178995/e00e6970-cce3-1ce3-8008-fe9beabd2200" response="yes"
dn="sys/rack-unit-1/adaptor-1/ext-eth-0"
<outConfig>
<adaptorExtEthIf portId="0" ifType="physical" linkState="up" mac="00:22:BD:F0:8A:00"
transport="CE" adminSpeed="10Gbps" operSpeed="10Gbps"
dn="sys/rack-unit-1/adaptor-5/ext-eth-0" status="modified"/>
</outConfig>
</configConfMo>

Note

Configuring the speed of an uplink port is supported only for the Cisco UCS VIC1225T Virtual Interface
Cards.

39. Retrieving Adapter Ethernet Interface Details

Request:
<configResolveClass cookie='1301262014/6a0d66ca-3b1a-49e1-b5d4-334749717158'
inHierarchical='true' classId='adaptorHostEthIf' >

Response:
<configResolveClass cookie="1351125788/7cb208c0-ccd7-1cd7-8009-1ec9e1a85750" response="yes"
classId="adaptorHostEthIf">
<outConfigs>
<adaptorHostEthIf name="eth0" ifType="virtual" mac="00:22:BD:D6:40:42"
mtu="1500" pxeBoot="disabled" iscsiBoot="disabled" uplinkPort="0"
classOfService="N/A" channelNumber="1" portProfile="" uplinkFailover="Disabled"
uplinkFailbackTimeout="" dn="sys/rack-unit-1/adaptor-1/host-eth-eth0" >
</adaptorHostEthIf>
<adaptorHostEthIf name="eth1" ifType="virtual" mac="00:22:BD:D6:40:43"
mtu="1500" pxeBoot="disabled" iscsiBoot="disabled" uplinkPort="1"
classOfService="N/A" channelNumber="2" portProfile="" uplinkFailover="Disabled"
uplinkFailbackTimeout="" dn="sys/rack-unit-1/adaptor-1/host-eth-eth1" >
</adaptorHostEthIf>
</outConfigs>
</configResolveClass>

40. Creating Adapter Ethernet Interface

Request:
<configConfMo cookie="1351128320/1399c368-ccd8-1cd8-800c-1ec9e1a85750"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/host-eth-eth2">
<inConfig>
<adaptorHostEthIf name="eth2" mac="AUTO" mtu="1500" pxeBoot="disabled" uplinkPort="0"
classOfService="0" dn="sys/rack-unit-1/adaptor-1/host-eth-eth2" status="created">

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

60

OL-25396-03

Examples of Common Server Management Tasks

<adaptorEthGenProfile rn="general" order="ANY" trustedClassOfService="disabled"

rateLimit="OFF" vlan="NONE" vlanMode="TRUNK" />
<adaptorEthCompQueueProfile rn="eth-comp-q" count="5" />
<adaptorEthOffloadProfile rn="eth-offload" largeReceive="enabled"
tcpRxChecksum="enabled" tcpSegment="enabled" tcpTxChecksum="enabled" />
<adaptorEthRecvQueueProfile rn="eth-rcv-q" count="4" ringSize="512" />
<adaptorIpV4RssHashProfile rn="ipv4-rss-hash" ipHash="enabled" tcpHash="enabled" />
<adaptorExtIpV6RssHashProfile rn="ext-ipv6-rss-hash"
ipHash="disabled" tcpHash="disabled"/>
<adaptorEthWorkQueueProfile rn="eth-work-q" count="1" ringSize="256" />
<adaptorIpV6RssHashProfile rn="ipv6-rss-hash" ipHash="enabled" tcpHash="enabled" />
<adaptorRssProfile rn="rss" receiveSideScaling="enabled" />
<adaptorEthInterruptProfile rn="eth-int" coalescingType="MIN" coalescingTime="125"
count="8" mode="MSIx" />
</adaptorHostEthIf>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1351128320/1399c368-ccd8-1cd8-800c-1ec9e1a85750" response="yes"
dn="sys/rack-unit-1/adaptor-1/host-eth-eth2" >
<outConfig>
<adaptorHostEthIf name="eth2" ifType="virtual" mac="00:22:BD:D6:40:46" mtu="1500"
pxeBoot="disabled" iscsiBoot="disabled" uplinkPort="0" classOfService="0"
channelNumber="N/A" portProfile="N/A" uplinkFailover="N/A" uplinkFailbackTimeout="N/A"
dn="sys/rack-unit-1/adaptor-1/host-eth-eth2" status="created" >
<adaptorEthGenProfile rn="general" order="ANY" trustedClassOfService="disabled" r
ateLimit="OFF" vlan="NONE" vlanMode="TRUNK" status="created" >
</adaptorEthGenProfile>
<adaptorEthCompQueueProfile rn="eth-comp-q" count="5" ringSize="1" status="created" >
</adaptorEthCompQueueProfile>
<adaptorEthOffloadProfile rn="eth-offload" largeReceive="enabled" tcpRxChecksum="enabled"
tcpSegment="enabled" tcpTxChecksum="enabled" status="created" >
</adaptorEthOffloadProfile>
<adaptorEthRecvQueueProfile rn="eth-rcv-q" count="4" ringSize="512" status="created">
</adaptorEthRecvQueueProfile>
<adaptorIpV4RssHashProfile rn="ipv4-rss-hash" ipHash="enabled" tcpHash="enabled"
status="created" >
</adaptorIpV4RssHashProfile>
<adaptorExtIpV6RssHashProfile rn="ext-ipv6-rss-hash" ipHash="disabled" tcpHash="disabled"
status="created"
</adaptorExtIpV6RssHashProfile>
<adaptorEthWorkQueueProfile rn="eth-work-q" count="1" ringSize="256" status="created"
>
</adaptorEthWorkQueueProfile>
<adaptorIpV6RssHashProfile rn="ipv6-rss-hash" ipHash="enabled" tcpHash="enabled"
status="created">
</adaptorIpV6RssHashProfile>
<adaptorRssProfile rn="rss" receiveSideScaling="enabled" status="created" >
</adaptorRssProfile>
<adaptorEthInterruptProfile rn="eth-int" coalescingType="MIN" coalescingTime="125"
count="8" mode="MSIx" status="created" >
</adaptorEthInterruptProfile>
</adaptorHostEthIf>
</outConfig>

41. Modifying Properties of Ethernet Interface

Request:
<configConfMo cookie="1351128320/1399c368-ccd8-1cd8-800c-1ec9e1a85750"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/host-eth-eth2">
<inConfig>
<adaptorHostEthIf name="eth2" mac="AUTO" mtu="2222" pxeBoot="

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

61

Examples of Common Server Management Tasks

enabled" uplinkPort="0" classOfService="2"

dn="sys/rack-unit-1/adaptor-1/host-eth-eth2" >
<adaptorEthGenProfile rn="general" order="ANY" trustedClassOfService="disabled"
rateLimit="OFF" vlan="NONE" vlanMode="TRUNK" />
<adaptorEthCompQueueProfile rn="eth-comp-q" count="5" />
<adaptorEthOffloadProfile rn="eth-offload" largeReceive="disabled"
tcpRxChecksum="enabled" tcpSegment="enabled" tcpTxChecksum="enabled" />
<adaptorEthRecvQueueProfile rn="eth-rcv-q" count="4" ringSize="256" />
<adaptorIpV4RssHashProfile rn="ipv4-rss-hash" ipHash="enabled"
tcpHash="enabled" />
<adaptorExtIpV6RssHashProfile rn="ext-ipv6-rss-hash" ipHash="disabled"
tcpHash="disabled" />
<adaptorEthWorkQueueProfile rn="eth-work-q" count="1" ringSize="256" />
<adaptorIpV6RssHashProfile rn="ipv6-rss-hash" ipHash="enabled"
tcpHash="disabled" />
<adaptorRssProfile rn="rss" receiveSideScaling="enabled" />
<adaptorEthInterruptProfile rn="eth-int" coalescingType="MIN"
coalescingTime="125" count="8" mode="MSIx" />
</adaptorHostEthIf>
</inConfig>
</configConfMo>

Response: The highlighted changes should be done, verify the changes in the CIMC or Web user interface.
42. Deleting Ethernet Interface
Request:
<configConfMo cookie="1351128320/1399c368-ccd8-1cd8-800c-1ec9e1a85750"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/host-eth-eth2">
<inConfig>
<adaptorHostEthIf name="eth2" mac="AUTO" mtu="2222" pxeBoot="enabled"
uplinkPort="0" classOfService="2" dn="sys/rack-unit-1/adaptor-1/host-eth-eth2"
status="deleted">
</adaptorHostEthIf>
</inConfig>

This deletes the chosen ethernet interface.

43. Retrieving Adapter Fibre Channel Interface Details
Request:
<configResolveClass cookie='1301262014/6a0d66ca-3b1a-49e1-b5d4-334749717158'
inHierarchical='true' classId='adaptorHostFcIf' >

Response:
<configResolveClass cookie="1351196321/e8c9a378-cce7-1ce7-8011-1ec9e1a85750" response="yes"
classId="adaptorHostFcIf">
<outConfigs>
<adaptorHostFcIf name="fc0" ifType="virtual" wwnn="10:00:00:22:BD:D6:40:44"
wwpn="20:00:00:22:BD:D6:40:44" uplinkPort="0" sanBoot="disabled"
channelNumber="N/A" portProfile="N/A" adminPersistentBindings="policy"
dn="sys/rack-unit-1/adaptor-1/host-fc-fc0" >
<adaptorFcGenProfile rn="general" mac="00:22:BD:D6:40:44" order="ANY"
classOfService="3" rateLimit="OFF" persistentLunBind="disabled"
vlan="NONE" maxDataFieldSize="2112" >
</adaptorFcGenProfile>
<adaptorFcErrorRecoveryProfile rn="fc-err-rec" errorDetectTimeout="2000"
fcpErrorRecovery="disabled" linkDownTimeout="30000" portDownIoRetryCount="8"
portDownTimeout="10000" resourceAllocationTimeout="10000"
</adaptorFcErrorRecoveryProfile>
<adaptorFcInterruptProfile rn="fc-int" mode="MSIx"
</adaptorFcInterruptProfile>
<adaptorFcPortFLogiProfile rn="fc-port-flogi" retries="INFINITE" timeout="2000" >
</adaptorFcPortFLogiProfile>
<adaptorFcPortPLogiProfile rn="fc-port-plogi" retries="8" timeout="2000" >
</adaptorFcPortPLogiProfile>
<adaptorFcPortProfile rn="fc-port" ioThrottleCount="512" lunsPerTarget="256" >

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

62

OL-25396-03

Examples of Common Server Management Tasks

</adaptorFcPortProfile>
<adaptorFcRecvQueueProfile rn="fc-rcv-q" ringSize="64" >
</adaptorFcRecvQueueProfile>
<adaptorFcWorkQueueProfile rn="fc-work-q" ringSize="64" >
</adaptorFcWorkQueueProfile>
<adaptorFcCdbWorkQueueProfile rn="fc-cdb-work-q" count="1" ringSize="512" >
</adaptorFcCdbWorkQueueProfile>
</adaptorHostFcIf>
</outConfigs>
</configResolveClass>

44. Creating Boot Entry for a Fibre Channel Interface

Request:
<configConfMo cookie="1351372958/09297e58-cd11-1d11-8013-1ec9e1a85750"
inHierarchical="true" dn="sys/rack-unit-1/adaptor-1/host-fc-fc0/fcboot-0">
<inConfig>
<adaptorFcBootTable dn="sys/rack-unit-1/adaptor-1/host-fc-fc0/fcboot-0"
targetWwpn="20:11:22:33:44:55:66:78" bootLun="1" status="created">
</adaptorFcBootTable>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1351372958/09297e58-cd11-1d11-8013-1ec9e1a85750" response="yes"
dn="sys/rack-unit-1/adaptor-1/host-fc-fc0/fcboot-0" >
<outConfig>
<adaptorFcBootTable index="0" targetWwpn="20:11:22:33:44:55:66:78" bootLun="1"
dn="sys/rack-unit-1/adaptor-1/host-fc-fc0/fcboot-0" status="created" >
</adaptorFcBootTable>
</outConfig>
</configConfMo>

45. Configuring HUU for One-Time Boot

Request:
<configConfMo cookie='1342064443/ba6bccf0-c499-1499-8002-134c9ee53d50'
inHierarchical='false' dn='sys/rack-unit-1/boot-one-time' >
<inConfig>
<oneTimeBootDevice device='huu' dn='sys/rack-unit-1/boot-one-time'>
</oneTimeBootDevice>
</inConfig>
</configConfMo>

You can verify this in the user interface. Similar to this example, you can also set SCU and HV as one-time
boot devices.
46. Mounting Share to the VMedia with Username
Request:
<configConfMo cookie='1349668135/19ca0068-cb84-1b84-8007-6ddd29114ca4'
inHierarchical='false' dn='sys/svc-ext/vmedia-svc/vmmap-WIN7'>
<inConfig>
<commVMediaMap map='nfs' dn='sys /svc-ext/vmedia-svc/vmmap-WIN7' volumeName='WIN7'
remoteShare='10.xxx.27.xxx:/nfs' remoteFile='sl1huu.iso'/>
</inConfig>

Response:
<configConfMo cookie="1349668135/19ca0068-cb84-1b84-8007-6ddd29114ca4" response="yes"
dn="sys/svc-ext/vmedia-svc/vmmap-WIN7" >
<outConfig>
<commVMediaMap volumeName="WIN7" map="nfs" driveType="CD" remoteShare="10.xxx.27.xxx:/nfs"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

63

Examples of Common Server Management Tasks

remoteFile="sl1huu.iso" mountOptions="nolock," mappingStatus="OK"

dn="sys/svc-ext/vmedia-svc/vmmap-WIN7" status="created">
</commVMediaMap>
</outConfig>

47. Setting Remotesyslog Primary Server

Request:
<configConfMo cookie='1341566532/cc99ace0-c425-1425-8003-ee409ee53d50'
inHierarchical='false' dn='sys/svc-ext/syslog/client-primary' >
<inConfig>
<commSyslogClient
name='primary' adminState='enabled' hostname='10.xxx.196.xxx'
dn='sys/svc-ext/syslog/client-primary'>
</commSyslogClient>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1347888634/c73c7708-c9e5-19e5-8008-0877e1a85750" response="yes"
dn="sys/svc-ext/syslog/client-primary" >
<outConfig>
<commSyslogClient adminState="enabled" hostname="10.xxx.196.xxx" name="primary"
dn="sys/svc-ext/syslog/client-primary" status="modified" >
</commSyslogClient>
</outConfig>
</configConfMo>

48. Setting Remotesyslog Secondary Server

Request:
<configConfMo cookie='1341566532/cc99ace0-c425-1425-8003-ee409ee53d50'
inHierarchical='false' dn='sys/svc-ext/syslog/client-secondary'>
<inConfig>
<commSyslogClient
name='secondary' adminState='enabled' hostname='10.xxx.196.xxx'
dn='sys/svc-ext/syslog/client-secondary'>
</commSyslogClient>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1347888634/c73c7708-c9e5-19e5-8008-0877e1a85750" response="yes">
dn="sys/svc-ext/syslog/client-secondary"
<outConfig>
<commSyslogClient adminState="enabled" hostname="10.xxx.196.xxx" name="secondary"
dn="sys/svc-ext/syslog/client-secondary" status="modified" >
</commSyslogClient>
</outConfig>
</configConfMo>

49. Retrieving Syslog Client-Server Details

Request:
<configResolveClass cookie='1347891777/8291d110-c9e6-19e6-800b-0877e1a85750'
inHierarchical='false' classId='commSyslogClient'

Response:
<configResolveClass cookie="1347891777/8291d110-c9e6-19e6-800b-0877e1a85750" response="yes"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

64

OL-25396-03

Examples of Common Server Management Tasks

classId="commSyslogClient">
<outConfigs>
<commSyslogClient adminState="disabled" hostname="10.xxx.196.xxx" name="primary"
dn="sys/svc-ext/syslog/client-primary" >
</commSyslogClient>
<commSyslogClient adminState="enabled" hostname="10.xxx.196.xxx" name="secondary"
dn="sys/svc-ext/syslog/client-secondary" >
</commSyslogClient>
</outConfigs>
</configResolveClass>

50. Retrieving LOM MAC Address Support Details

Request:
<configResolveClass cookie='1347541314/e95cea30-c994-1994-80ac-0877e1a85750'
classId='networkAdapterUnit' inHierarchical='false'>

Response:
<configResolveClass cookie="1270945253/00566da0-83eb-13eb-8002-98219ee53d50" response="yes"
classId="networkAdaptorUnit">
<outConfigs>
<networkAdaptorUnit slot="1" model="Broadcom 57712-S" numIntf="2"
dn="sys/rack-unit-1/network-adaptor-1" > </networkAdaptorUnit>
<networkAdaptorUnit slot="2" model="Broadcom 57711 1" numIntf="2"
dn="sys/rack-unit-1/network-adaptor-2" > </networkAdaptorUnit>
<networkAdaptorUnit slot="L" model="Intel Onboard 1Gbps Ethernet Adapter" numIntf="2"
dn="sys/rack-unit-1/network-adaptor-L" >
</networkAdaptorUnit>
</outConfigs>

51. Retrieving MAC Address of Individual Ports of Network Controllers

Request:
<configResolveClass cookie='1347541314/e95cea30-c994-1994-80ac-0877e1a85750'
inHierarchical='true' classId='networkAdapterEthIf'>

Response:
<configResolveClass cookie='1347541314/e95cea30-c994-1994-80ac-0877e1a85750'response="yes"
dn="sys/rack-unit-1/network-adaptor-1">
<outConfigs>
<networkAdaptorEthIf id="1" mac="00:10:18:bf:62:0c" linkStateAtPOST="Down"
dn="sys/rack-unit-1/network-adaptor-1/eth-1" > </networkAdaptorEthIf>
<networkAdaptorEthIf id="2" mac="00:10:18:bf:62:0e" linkStateAtPOST="Down"
dn="sys/rack-unit-1/network-adaptor-1/eth-2" >
</networkAdaptorEthIf>
</outConfigs>
</configResolveChildren>

52. Retrieving LOM MAC Address of Individual Ports

Request:
<configResolveDn cookie='1351526025/aca57e38-cd34-1d34-8002-c2139ee53d50'
inHierarchical='true' dn='sys/rack-unit-1/network-adapter-L'>

Response:
<configResolveDn cookie="1270945253/00566da0-83eb-13eb-8002-98219ee53d50" response="yes"
dn="sys/rack-unit-1/network-adaptor-L/eth-1">

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

65

Examples of Common Server Management Tasks

<outConfig>
<networkAdaptorEthIf id="1" mac="50:3D:E5:9E:21:9C"
dn="sys/rack-unit-1/network-adaptor-L/eth-1" >
</networkAdaptorEthIf>
</outConfig>
</configResolveDn>

linkStateAtPOST="Up"

53. Retrieving LSI Storage Adapter Summary Properties Installed on C-Series Server
Request:
<configResolveClass cookie='1347541314/e95cea30-c994-1994-80ac-0877e1a85750'
inHierarchical='true' classId="storageController">

Response:
<configResolveClass cookie="1347526745/85048f00-c991-1991-80a5-0877e1a85750" response="yes"
classId="storageControllerProps">
<outConfigs>
<storageController id="SLOT-3" model="LSI MegaRAID SAS 9261-8i" pciSlot="SLOT-3"
presence="equipped" raidSupport="yes" serial="SV11605114" type="SAS"
vendor="LSI Logic" dn="sys/rack-unit-1/board/storage-SAS-SLOT-3"/>
</outConfigs>

54. Retrieving LSI Storage Adapter Detailed Properties Installed on C-Series Server
Request:
<configResolveClass cookie='1347541314/e95cea30-c994-1994-80ac-0877e1a85750'
inHierarchical='true' classId="storageControllerProps"/>

Response:
<configResolveClass cookie="1347526745/85048f00-c991-1991-80a5-0877e1a85750" response="yes"
classId="storageControllerProps">
<outConfigs>
<storageControllerProps dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/controller-props"
pciSlot="SLOT-3" health="Severe Fault" controllerStatus="Optimal" bbuPresent="true"
backendPortCount="8"

memorySize="512 MB" cacheMemorySize="346 MB" virtualDriveCount="8"

degradedVirtualDriveCount="0" physicalDriveCount="1" criticalPhysicalDriveCount="0"

offlineVirtualDriveCount="0" failedPhysicalDriveCount="0" memoryCorrectableErrors="0"
memoryUncorrectableErrors="0" bootDrive="65535"/>
</outConfigs>

55. Retrieving LSI Storage Adapter Details of RAID Battery

Request:
<configResolveClass cookie='1362107110/46742048-d6d4-16d4-8006-4a45b42d542c'
inHierarchical='true' classId='storageRaidBattery' >

Response:
<configResolveClass cookie="1362107110/46742048-d6d4-16d4-8006-4a45b42d542c" response="yes"
classId="storageRaidBattery">
<outConfigs>
<storageRaidBattery dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/raid-battery"
batteryType="iBBU" health="Severe Fault" batteryPresent="true"
batteryStatus="Battery Replacement Needed" temperature="25 degrees C"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

66

OL-25396-03

Examples of Common Server Management Tasks

chargingState="fully charged" retentionTime="24 hours" temperatureHigh="false"

designVoltage="3.700 V" voltage="4.028 V" current="0.000 A" learnMode="Auto"
completedChargeCycles="45" learnCycleStatus="Successful" learnCycleRequested="false"
nextLearnCycle="2013-03-03 13:15" designCapacity="1215 mAh" fullCapacity="0
mAh" remainingCapacity="0 mAh" relativeStateOfCharge="96 %" absoluteStateOfCharge="29
%"
expectedMarginOfError="2 %" manufacturer="LS1191002A" dateOfManufacture="2011-03-04"
serialNumber="1735" firmwareVersion=""/>
</outConfigs>

56. Retrieving Summary Information of Local Disks (HDD)

Request:
<configResolveClass cookie='1362107110/46742048-d6d4-16d4-8006-4a45b42d542c'
inHierarchical='false' classId="storageLocalDisk">

Response:
<configResolveClass cookie="1362107110/46742048-d6d4-16d4-8006-4a45b42d542c" response="yes"
classId="storageLocalDisk">
<outConfigs>
<storageLocalDisk id="5" pdStatus="Online" health="Good"
predictiveFailureCount="0" linkSpeed="3.0 Gb/s" interfaceType="SATA"
mediaType="HDD" coercedSize="475883 MB" vendor="ATA" productId="ST9500530NS"
driveFirmware="CC04" driveSerialNumber="9SP2J8N5" driveState="online"
online="true" dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/pd-5"/>
</outConfigs>

57. Retrieving Detailed Information of Local Disks (HDD)

Request:
<configResolveClass cookie="1362107110/46742048-d6d4-16d4-8006-4a45b42d542c"
inHierarchical="false" classId="storageLocalDiskProps"/>

Response:
<configResolveClass cookie="1362107110/46742048-d6d4-16d4-8006-4a45b42d542c" response="yes"
classId="storageLocalDiskProps">
<outConfigs>
<storageLocalDiskProps dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/pd-5/general-props"
physicalDrive="5" enclosureDeviceId="252" deviceId="9" sequenceNumber="2"
mediaErrorCount="0" otherErrorCount="0" predictiveFailureCount="0"
linkSpeed="3.0 Gb/s" interfaceType="SATA" mediaType="HDD" blockSize="512"
blockCount="976773168" rawSize="476940 MB" nonCoercedSize="476428 MB"
coercedSize="475883 MB" powerState="active" sasAddress0="4433221107000000"
sasAddress1="0x0"/>
</outConfigs>

58. Retrieving Details of All Virtual Drives Configured in LSI Adapters

Request:
<configResolveClass cookie='1347541314/e95cea30-c994-1994-80ac-0877e1a85750'
inHierarchical='true' classId='storageVirtualDrive'>

Response:
<configResolveClass cookie="1347528176/da43f028-c991-1991-80a8-0877e1a85750" response="yes"
classId="storageVirtualDrive">
<outConfigs>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

67

Examples of Common Server Management Tasks

<storageVirtualDrive id="10" name="VD_OS_1" raidLevel="RAID 0" size="102400 MB"

vdStatus="Optimal" health="Good" stripSize="64 KB" drivesPerSpan="1"
spanDepth="1" accessPolicy="Read-Write" cachePolicy="Direct" readAheadPolicy="Always"
diskCachePolicy="Disable" allowBackgroundInit="true" autoSnapshot="false"
autoDeleteOldest="true" driveState="Optimal"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-10"/>
<storageVirtualDrive id="11" name="VD_OS_2" raidLevel="RAID 0" size="12288 MB"
health="Good" stripSize="64 KB" drivesPerSpan="1" spanDepth="1"
accessPolicy="Read-Write" vdStatus="Optimal" cachePolicy="Direct"
readAheadPolicy="Always" diskCachePolicy="Disable" allowBackgroundInit="true"
autoSnapshot="false" autoDeleteOldest="true" driveState="Optimal"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-11"/>
.
.
.
.
<storageVirtualDrive id="15" name="VD_OS_6" raidLevel="RAID 0" size="12288 MB"
vdStatus="Optimal" health="Good" stripSize="64 KB" drivesPerSpan="1"
spanDepth="1" accessPolicy="Read-Write" cachePolicy="Direct" readAheadPolicy="Always"
diskCachePolicy="Disable" allowBackgroundInit="true" autoSnapshot="false"
autoDeleteOldest="true" driveState="Optimal"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-15"/>
<storageVirtualDrive id="16" name="VD_OS_7" raidLevel="RAID 0" size="12288 MB"
vdStatus="Optimal" health="Good" stripSize="64 KB" drivesPerSpan="1"
spanDepth="1" accessPolicy="Read-Write" cachePolicy="Direct" readAheadPolicy="Always"
diskCachePolicy="Disable" allowBackgroundInit="true" autoSnapshot="false"
autoDeleteOldest="true" driveState="Optimal"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-16"/>
<storageVirtualDrive id="17" name="VD_DATA_1" raidLevel="RAID 0" size="300063 MB"
vdStatus="Optimal" health="Good" stripSize="64 KB" drivesPerSpan="1"
spanDepth="1" accessPolicy="Read-Write" cachePolicy="Direct" readAheadPolicy="Always"
diskCachePolicy="Disable" allowBackgroundInit="true" autoSnapshot="false"
autoDeleteOldest="true" driveState="Optimal"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-17"/>
</outConfigs>

59. Retrieving Details of Physical Disks Usage by Virtual Drives

Request:
<configResolveClass cookie="1362107110/46742048-d6d4-16d4-8006-4a45b42d542c"
inHierarchical="false" classId="storageLocalDiskUsage"/>

Response:
<configResolveClass cookie="1362107110/46742048-d6d4-16d4-8006-4a45b42d542c" response="yes"
classId="storageLocalDiskUsage">
<outConfigs>
<storageLocalDiskUsage startingBlock="0" numberOfBlocks="209715200"
virtualDrive="10" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-10/pd-5"/>
<storageLocalDiskUsage startingBlock="209715200" numberOfBlocks="25165824"
virtualDrive="11" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-11/pd-5"/>
<storageLocalDiskUsage startingBlock="234881024" numberOfBlocks="25165824"
virtualDrive="12" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-12/pd-5"/>
<storageLocalDiskUsage startingBlock="260046848" numberOfBlocks="25625088"
virtualDrive="13" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-13/pd-5"/>
<storageLocalDiskUsage startingBlock="285671936" numberOfBlocks="25165824"
virtualDrive="14" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-14/pd-5"/>
<storageLocalDiskUsage startingBlock="310837760" numberOfBlocks="25165824"
virtualDrive="15" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-15/pd-5"/>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

68

OL-25396-03

Examples of Common Server Management Tasks

<storageLocalDiskUsage startingBlock="336003584" numberOfBlocks="25165824"

virtualDrive="16" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-16/pd-5"/>
<storageLocalDiskUsage startingBlock="361169408" numberOfBlocks="614530560"
virtualDrive="17" physicalDrive="5" state="online" span="0"
dn="sys/rack-unit-1/board/storage-SAS-SLOT-3/vd-17/pd-5"/>
</outConfigs>

60. Retrieving Network Time Protocol (NTP) Properties

Request:
<configResolveClass cookie='1357785728/200df7e0-d2e6-12e6-8004-3e02e2a85750'
classId='commNtpProvider' inHierarchical='false'>

Response:
<configResolveClass cookie="1357785728/200df7e0-d2e6-12e6-8004-3e02e2a85750" response="yes"
classId="commNtpProvider">
<outConfigs>
<commNtpProvider dn="sys/svc-ext/ntp-svc" description="Network Time Protocol"
ntpEnable="no" ntpServer1="0. pool.ntp.org" ntpServer2="1.pool.ntp.org"
ntpServer3="2.pool.ntp.org" ntpServer4="3.pool.ntp.org" >
</commNtpProvider>
</outConfigs>

61. Configuring Network Time Protocol (NTP) Properties

Request:
<configConfMo cookie="1360482215/f33512f0-d559-1559-8007-30339ee53d50"
dn="sys/svc-ext/ntp-svc">
<inConfig>
<commNtpProvider dn="sys/svc-ext/ntp-svc" ntpEnable="yes" ntpServer1="172.29.xxx.187"
ntpServer2="ntpserver.cisco.com" ntpServer3="ntp.globalcomp.net"
ntpServer4="170.xx.198.25"/>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1360482215/f33512f0-d559-1559-8007-30339ee53d50" response="yes"
dn="sys/svc-ext/ntp-svc" >
<outConfig>
<commNtpProvider dn="sys/svc-ext/ntp-svc" description="Network Time Protocol"
ntpEnable="yes" ntpServer1="172.xx.xxx.187" ntpServer2="ntpserver.cisco.com"
ntpServer3="ntp.globalcomp.net" ntpServer4="170.xx.198.25"
status="modified"/>
</outConfig>
</configConfMo>

62. Retrieving all CIMC Users

Request:
<configResolveClass cookie="1360213362/5a499e50-d51b-151b-8008-30339ee53d50"
inHierarchical="false" classId="aaaUser"/>

Response:
<configResolveClass cookie="1360213362/5a499e50-d51b-151b-8008-30339ee53d50" response="yes"
classId="aaaUser">
<outConfigs>
<aaaUser id="1" accountStatus="active" name="admin" priv="admin" pwd=""
dn="sys/user-ext/user-1"/>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

69

Examples of Common Server Management Tasks

<aaaUser id="2" accountStatus="inactive" name="" priv="" pwd=""

dn="sys/user-ext/user-2"/>
<aaaUser id="3" accountStatus="active" name="server.monitor" priv="read-only" pwd=""
dn="sys/user-ext/user-3"/>
<aaaUser id="4" accountStatus="active" name="acme" priv="user" pwd=""
dn="sys/user-ext/user-4"/>
<aaaUser id="5" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-5"/>
<aaaUser id="6" accountStatus="active" name="msgDept" priv="admin" pwd=""
dn="sys/user-ext/user-6"/>
<aaaUser id="7" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-7"/>
<aaaUser id="8" accountStatus="inactive" name="john_srvadmin" priv="admin" pwd=""
dn="sys/user-ext/user-8"/>
<aaaUser id="9" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-9"/>
<aaaUser id="10" accountStatus="inactive" name="qa.manager-dept" priv="read-only"
pwd=""
dn="sys/user-ext/user-10"/>
<aaaUser id="11" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-11"/>
<aaaUser id="12" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-12"/>
<aaaUser id="13" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-13"/>
<aaaUser id="14" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-14"/>
<aaaUser id="15" accountStatus="inactive" name="" priv="" pwd=""
dn="sys/user-ext/user-15"/>
</outConfigs>

63. Setting up ID 11 CIMC User With Username and Password and Enabling Login Access to this User
Request:
<configConfMo cookie="1360213362/5a499e50-d51b-151b-8008-30339ee53d50"
inHierarchical="false" dn="sys/user-ext/user-11">
<inConfig>
<aaaUser id="11" accountStatus="active" name="master.work" priv="admin"
pwd="password" dn="sys/user-ext/user-11"/>
</inConfig>

Response:
<configConfMo cookie="1360213362/5a499e50-d51b-151b-8008-30339ee53d50" response="yes">
dn="sys/user-ext/user-11"
<outConfig>
<aaaUser id="11" accountStatus="active" name="master.work"
priv="admin" pwd="" dn="sys/user-ext/user-11" status="modified"/>
</outConfig>
</configConfMo>

64. Configuring User ID 3, Deactivating this User and Changing the Password
Request:
<configConfMo cookie="1360213362/5a499e50-d51b-151b-8008-30339ee53d50"
inHierarchical="false" dn="sys/user-ext/user-3">
<inConfig>
<aaaUser id="3" accountStatus="inactive" name="server.monitor" priv="user"
pwd="Game(hang#" dn="sys/user-ext/user-3"/>
</inConfig>
</configConfMo>

Response:
<configConfMo cookie="1360213362/5a499e50-d51b-151b-8008-30339ee53d50" response="yes">
dn="sys/user-ext/user-3"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

70

OL-25396-03

Examples of Common Server Management Tasks

<outConfig>
<aaaUser id="3" accountStatus="inactive" name="server.monitor" priv="user"
pwd="" dn="sys/user-ext/user-3" status="modified"/>
</outConfig>

65. Retrieving Memory Unit Statistics

Request:
<configResolveClass cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
inHierarchical='false' classId='memoryUnitEnvStats' >

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="memoryUnitEnvStats">
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58"
response="yes" classId="memoryUnitEnvStats">
<outConfigs>
<memoryUnitEnvStats dn="sys/rack-unit-1/board/memarray-1/mem-9/dimm-env-stats"
id="9" description="CPU1_B0_DIMM_1" temperature="16.0"
timeCollected="2013-2-5T19:33:41">
</memoryUnitEnvStats>
<memoryUnitEnvStats dn="sys/rack-unit-1/board/memarray-1/mem-13/dimm-env-stats"
id="13" description="CPU1_B1_DIMM_1" temperature="18.0"
timeCollected="2013-2-5T19:33:42">
</memoryUnitEnvStats>
</outConfigs>
</configResolveClass>

66. Retrieving Specific DIMM Memory Unit Statistics

Request:
<configResolveDn cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
inHierarchical='false' dn='sys/rack-unit-1/board/memarray-1/mem-45/dimm-env-stats' >

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="memoryUnitEnvStats">
<outConfigs>
<memoryUnitEnvStats dn="sys/rack-unit-1/board/memarray-1/mem-9/dimm-env-stats"
id="9" description="CPU1_B0_DIMM_1" temperature="16.0" timeCollected="2013-2-5T19:33:41"
</memoryUnitEnvStats>
</outConfigs>
</configResolveClass>

67. Retrieving Processor Environment Statistics

Request:
<configResolveClass cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
inHierarchical='false' classId='processorEnvStats'

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="processorEnvStats">
<outConfigs>
<processorEnvStats dn="sys/rack-unit-1/board/cpu-1/env-stats"
id="1" description="P1_TEMP_SENS" temperature="36.0" timeCollected="2013-2-9T19:40:37">
</processorEnvStats>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

71

Examples of Common Server Management Tasks

<processorEnvStats dn="sys/rack-unit-1/board/cpu-2/env-stats"
id="2" description="P2_TEMP_SENS" temperature="35.0" timeCollected="2013-2-9T19:40:37">
</processorEnvStats>
</outConfigs>
</configResolveClass>

68. Retrieving Specific DIMM Processor Environment Statistics

Request:
<configResolveDn cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
inHierarchical='false' dn='sys/rack-unit-1/board/cpu-2/env-stats' >

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="processorEnvStats">
<outConfigs>
<processorEnvStats dn="sys/rack-unit-1/board/cpu-1/env-stats"
id="1" description="P1_TEMP_SENS" temperature="36.0" timeCollected="2012-11-29T19:40:37"
>
</processorEnvStats>
<processorEnvStats dn="sys/rack-unit-1/board/cpu-2/env-stats"
id="2" description="P2_TEMP_SENS" temperature="35.0" timeCollected="2012-11-29T19:40:37"
>
</processorEnvStats>
</outConfigs>
</configResolveClass>

69. Retrieving Motherboard Temperature Statistics

Request:
<configResolveClass cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
classId='computeRackUnitMbTempStats' inHierarchical='false'>

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="computeRackUnitMbTempStats">
<outConfigs>
<computeRackUnitMbTempStats dn="sys/rack-unit-1/board/temp-stats" ambientTemp="18.0"
frontTemp="18.0" ioh1Temp="46.0" ioh2Temp="53.0"
rearTemp="32.0" timeCollected="2013-2-9T19:41:29" >
</computeRackUnitMbTempStats>
</outConfigs>
</configResolveClass>

70. Retrieving Specific DIMM Motherboard Temperature Statistics

Request:
<configResolveDn cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
inHierarchical='false'dn='sys/rack-unit-1/board/temp-stats' >

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="computeRackUnitMbTempStats">
<outConfigs>
<computeRackUnitMbTempStats dn="sys/rack-unit-1/board/temp-stats"
ambientTemp="18.0" frontTemp="18.0" ioh1Temp="46.0" ioh2Temp="53.0" rearTemp="32.0"
timeCollected="2013-2-9T19:41:29" >

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

72

OL-25396-03

Examples of Common Server Management Tasks

</computeRackUnitMbTempStats>
</outConfigs>
</configResolveClass>

71. Retrieving Motherboard Power Statistics

Request:
<configResolveClass cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
classId='computeMbPowerStats' inHierarchical='false'>

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="computeMbPowerStats">
<outConfigs>
<computeMbPowerStats dn="sys/rack-unit-1/board/power-stats"
consumedPower="280" inputCurrent="" inputVoltage="" timeCollected="2012-11-29T19:49:49"
>
</computeMbPowerStats>
</outConfigs>
</configResolveClass>

72. Retrieving Specific DIMM Motherboard Power Statistics

Request:
<configResolveDn cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
inHierarchical='false'dn='sys/rack-unit-1/board/power-stats' >

Response:
<configResolveClass cookie="1354217286/484b4498-cfa7-1fa7-8002-aab825098d58" response="yes"
classId="computeMbPowerStats">
<outConfigs>
<computeMbPowerStats dn="sys/rack-unit-1/board/power-stats"
consumedPower="280" inputCurrent="" inputVoltage="" timeCollected="2013-2-9T19:49:49"
>
</computeMbPowerStats>
</outConfigs>
</configResolveClass>

73. Retrieving iSCSI Parameters

Request:
<configResolveDn cookie='1350453563/f8f69e20-cc3a-1c3a-8003-6cdd29114ca4'
inHierarchical='false' dn='sys/rack-unit-1/adaptor-1/host-eth-adad/ethiscsi'>

Response:
<configResolveClass cookie="1350515994/821a1d18-cc49-1c49-8007-6cdd29114ca4" response="yes"
classId="adaptorEthISCSIProfile">
<outConfigs>
<adaptorEthISCSIProfile dn="sys/rack-unit-1/adaptor-2/host-eth-eth0/ethiscsi"
linkupTimeout="15" linkBusyRetryCount="15" ipVer="IPv4" dhcpId="" dhcpTimeout="60"
dhcpNetworkSettings="enabled" dhcpISCSI="enabled" initiatorName="test"
initiatorTCPTimeout="15"
primaryTargetName="test.com" primaryTargetIPAddress="192.xxx.1.1"
primaryTargetPort="3260"
primaryTargetBootLun="0" >
</adaptorEthISCSIProfile>
</outConfigs>
</configResolveClass>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

73

Examples of Common Server Management Tasks

74. Removing iSCSI Boot

Request:
<configConfMo cookie='1350517826/ef4dd140-cc49-1c49-8008-6cdd29114ca4'
inHierarchical='false' dn='sys/rack-unit-1/adaptor-2/host-eth-eth1/ethiscsi' >
<inConfig>
<adaptorEthISCSIProfile linkupTimeout='85' linkBusyRetryCount='135' dhcpId='vendrocisco'
dhcpTimeout='88' dhcpNetworkSettings='enabled' dhcpISCSI='enabled' status='removed'
dn='sys/rack-unit-1/adaptor-2/host-eth-eth1/ethiscsi'>
</adaptorEthISCSIProfile>
</inConfig>
</configConfMo>

Response: Verify that the iSCSI boot is disabled in the web user interface or CLI.
<configConfMo cookie="1350517826/ef4dd140-cc49-1c49-8008-6cdd29114ca4" "response="yes"
dn="sys/rack-unit-1/adaptor-2/host-eth-eth1/ethiscsi" >
<outConfig>
</outConfig>
</configConfMo>

75. Retrieving Fault Objects Identified by CIMC

Request:
<configResolveClass cookie="1360461607/26daf980-d555-1555-8004-0834b6fdd0d0"
inHierarchical="false" classId="faultInst"/>

Response:
<configResolveClass cookie="1360461607/26daf980-d555-1555-8004-0834b6fdd0d0" response="yes"
classId="faultInst">
<outConfigs>
<faultInst ack="yes" cause="powerproblem" code="F0883"
created="Sat Feb 9 00:30:40 2013"
descr="Power supply 4 is in a degraded state, or has bad input voltage"
affectedDN="sys/rack-unit-1/psu-4" highestSeverity="critical" id="167773192"
lastTransition="Sat Feb 9 00:24:08 2013" lc="flapping" occur="16"
origSeverity="cleared"
prevSeverity="cleared" rule="fltEquipmentPsuInputError" severity="critical"
tags="server" type="server" dn="sys/rack-unit-1/fault-F0883"/>
<faultInst ack="yes" cause="psuRedundancyFail" code="F0743"
created="Sat Feb 9 00:30:40 2013"
descr="Power Supply redundancy is lost : Reseat or replace Power Supply "
affectedDN="sys/rack-unit-1/psu" highestSeverity="critical" id="352321544"
lastTransition="Sat Feb 9 00:24:08 2013" lc="flapping" occur="16"
origSeverity="cleared"
prevSeverity="cleared" rule="fltPowerChassisMemberChassisPsuRedundanceFailure"
severity="major" tags="server" type="server" dn="sys/rack-unit-1/fault-F0743"/>
<faultInst ack="yes" cause="equipmentDegraded" code="F0969"
created="Fri Feb 8 23:57:44 2013" descr="Storage Raid Battery 11 Degraded:
please check the battery or the storage controller"
affectedDN="sys/rack-unit-1/board/storage-SAS-SLOT-SAS/raid-battery-11"
highestSeverity="critical" id="3539995392" lastTransition="Fri Feb 8 23:11:08 2013"
lc="flapping" occur="2" origSeverity="cleared" prevSeverity="cleared"
rule="fltStorageRaidBatteryDegraded" severity="major" tags="storage" type="server"
dn="sys/rack-unit-1/fault-F0969"/>
<faultInst ack="yes" cause="equipmentInoperable" code="F0531"
created="Fri Feb 8 23:57:44 2013"
descr="Storage Raid Battery 11 is inoperable: Check Controller battery"
affectedDN="sys/rack-unit-1/board/storage-SAS-SLOT-SAS/raid-battery-11"
highestSeverity="critical" id="3539995392" lastTransition="Fri Feb 8 23:11:08 2013"
lc="flapping" occur="2" origSeverity="cleared" prevSeverity="cleared"
rule="fltStorageRaidBatteryInoperable" severity="major" tags="storage"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

74

OL-25396-03

Examples of Common Server Management Tasks

type="server" dn="sys/rack-unit-1/fault-F0531"/>
</outConfigs>
</configResolveClass>

76. Generating Temporary Authentication Tokens and Launching the KVM

Launching the KVM console using the XML APIs include the following:
Retrieving a session cookie.
Generating temporary authentication tokens.
Accessing the URL to download the JNLP file using the tokens.
Launching the KVM.
Request for obtaining authentication tokens:
<aaaGetComputeAuthTokens

cookie="1363034734/412ce290-d7ac-17ac-8006-c979e5e53d50" />'

Response for obtaining authentication tokens:

<aaaGetComputeAuthTokens cookie="1363034734/412ce290-d7ac-17ac-8006-c979e5e53d50"
outTokens="1957747793,424238335" response="yes">
</aaaGetComputeAuthTokens>

To access the URL, use the tokens in the tkn1 and tkn2 parts of the following URL within 60 seconds of
generation:
javaws http://<CIMC IP address>/kvm.jnlp?cimcAddr=<CIMC IP
address>&tkn1=1957747793&tkn2=424238335
Download the JNLP file from the URL and launch it to start a KVM session.
77. Retrieving usNIC Device Parameters
Request:
<configResolveClass cookie='1301262014/6a0d66ca-3b1a-49e1-b5d4-334749717158'
classId='adaptorEthUSNICProfile' inHierarchical='true'>

Response:
<configResolveClass cookie="1369708188/0a09aa88-ddbe-1dbe-8003-1fc9e1a85750"
response="yes" classId="adaptorEthUSNICProfile">
<outConfigs>
<adaptorEthUSNICProfile dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic"
usnicCount="1" transmitQueueCount="2" transmitQueueRingSize="256"
receiveQueueCount="2"
receiveQueueRingSize="512"
completionQueueCount="4" interruptCount="4" coalescingType="MIN"
coalescingTime="125" classOfService="0" tcpSegment="disabled"
largeReceive="disabled" tcpTxChecksum="disabled"
tcpRxChecksum="disabled" >
</adaptorEthUSNICProfile>
</outConfigs>
</configResolveClass>

78. Creating Ethernet Interface usNIC Profiles

Request:
<configConfMo cookie="1364563172/1f244b38-d910-1910-8002-02249ee53d50"
dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic">
<inConfig>
<adaptorEthUSNICProfile dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic"
usnicCount="3"/>
</inConfig>
</configConfMo>"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

75

Examples of Common Server Management Tasks

Response:
<configConfMo dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic"
cookie="1364563172/1f244b38-d910-1910-8002-02249ee53d50" response="yes">
<outConfig>
<adaptorEthUSNICProfile dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic"
usnicCount="3" transmitQueueCount="2" transmitQueueRingSize="256"
receiveQueueCount="2" receiveQueueRingSize="512" completionQueueCount="4"
interruptCount="4" coalescingType="MIN" coalescingTime="125"
classOfService="0" tcpSegment="disabled" largeReceive="disabled"
tcpTxChecksum="disabled" tcpRxChecksum="disabled" status="modified" >
</adaptorEthUSNICProfile>
</outConfig>
</configConfMo>

79. Modifying Ethernet Interface usNIC Profiles

Request:
<configConfMo cookie="1364563172/1f244b38-d910-1910-8002-02249ee53d50"
dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic">
<inConfig>
<adaptorEthUSNICProfile dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic"
transmitQueueCount="9"
transmitQueueRingSize="3024" receiveQueueCount="11" receiveQueueRingSize="4024"
completionQueueCount="12"
interruptCount="13" coalescingType="IDLE" coalescingTime="1400" classOfService="5"
tcpSegment="enabled"
largeReceive="enabled" tcpTxChecksum="enabled" tcpRxChecksum="enabled"/>
</inConfig>
</configConfMo>

Response:
<configConfMo dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic"
cookie="1364563172/1f244b38-d910-1910-8002-02249ee53d50" response="yes">
<outConfig>
<adaptorEthUSNICProfile dn="sys/rack-unit-1/adaptor-1/host-eth-eth0/ethusnic"
usnicCount="3"
transmitQueueCount="9" transmitQueueRingSize="3024" receiveQueueCount="11"
receiveQueueRingSize="4024"
completionQueueCount="12" interruptCount="13" coalescingType="IDLE" coalescingTime="1400"
classOfService="5"
tcpSegment="enabled" largeReceive="enabled" tcpTxChecksum="enabled"
tcpRxChecksum="enabled" status="modified"/>
</outConfig>
</configConfMo>

80. Retrieving LDAP Server Details

Request:
<configResolveClass cookie="1370404868/3f5f79b8-de60-1e60-8002-1ec9e1a85750"
response="yes" classId="aaaLdap">

Response:
<outConfigs
<aaaLdap dn="sys/ldap-ext" adminState="enabled" basedn="1.2.3.4"
domain="tfb.com" filter="sAMAccountName" attribute="CiscoAvPair"
timeout="1800" encryption="disabled" locateDirectoryUsingDNS="yes"
dnsDomainSource="extracted-domain" dnsSearchDomain="" dnsSearchForest=""
ldapServer1="172.26.53.36" ldapServerPort1="636"
ldapServer2="0.0.0.0" ldapServerPort2="636"
ldapServer3="ServThree.com" ldapServerPort3="9636"
ldapServer4="myfinance.com" ldapServerPort4="3269"
ldapServer5="199.22.44.253" ldapServerPort5="9269"
ldapServer6="" ldapServerPort6="3269"
bindMethod="login-credentials" bindDn="someDn" password=""
groupAuth="enabled" groupAttribute="memberOf" >
<aaaLdapRoleGroup id="1" name="" domain="" role="admin" rn="rolegroup-1" >

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

76

OL-25396-03

Examples of Common Server Management Tasks

</aaaLdapRoleGroup>
<aaaLdapRoleGroup id="2"
</aaaLdapRoleGroup>
<aaaLdapRoleGroup id="3"
</aaaLdapRoleGroup>
<aaaLdapRoleGroup id="4"
</aaaLdapRoleGroup>
<aaaLdapRoleGroup id="5"
</aaaLdapRoleGroup>
<aaaLdapRoleGroup id="6"
</aaaLdapRoleGroup>
<aaaLdapRoleGroup id="7"
</aaaLdapRoleGroup>
<aaaLdapRoleGroup id="8"
</aaaLdapRoleGroup>
</aaaLdap>
</outConfigs>

name="" domain="" role="user" rn="rolegroup-2" >

name="" domain="" role="read-only" rn="rolegroup-3">
name="" domain="" role="" rn="rolegroup-4" >
name="" domain="" role="" rn="rolegroup-5" >
name="" domain="" role="" rn="rolegroup-6" >
name="" domain="" role="" rn="rolegroup-7" >
name="" domain="" role="" rn="rolegroup-8" >

81. Configuring LDAP Server IP Address and Port Numbers

Request:
<configConfMo cookie="1351062607/c6c74fd8-ccc8-1cc8-8005-1ec9e1a85750"
inHierarchical="true" dn="sys/ldap-ext">
<inConfig>
<aaaLdap dn="sys/ldap-ext" adminState="disabled" basedn="" domain="tfb.com"
filter="sAMAccountName" attribute="CiscoAvPair" timeout="60"
encryption="disabled" locateDirectoryUsingDNS="yes"
dnsDomainSource="extracted-domain"
ldapServer1="172.26.53.36" ldapServerPort1="636"
ldapServer2="0.0.0.0" ldapServerPort2="636"
ldapServer3="ServThree.com" ldapServerPort3="9636"
ldapServer4="myfinance.com" ldapServerPort4="3269"
ldapServer5="199.22.44.253" ldapServerPort5="9269"
ldapServer6="" ldapServerPort6="3269"
bindMethod="login-credentials" bindDn="" password=""
groupAuth=disabled" groupAttribute="memberOf">
</inConfig>

Response:
<outConfigs
<aaaLdap dn="sys/ldap-ext" adminState="disabled" basedn="" domain="tfb.com"
filter="sAMAccountName" attribute="CiscoAvPair" timeout="60"
encryption="disabled" locateDirectoryUsingDNS="yes"
dnsDomainSource="extracted-domain"
ldapServer1="172.26.53.36" ldapServerPort1="636"
ldapServer2="0.0.0.0" ldapServerPort2="636"
ldapServer3="ServThree.com" ldapServerPort3="9636"
ldapServer4="myfinance.com" ldapServerPort4="3269"
ldapServer5="199.22.44.253" ldapServerPort5="9269"
ldapServer6="" ldapServerPort6="3269"
bindMethod="login-credentials" bindDn="someDn" password=""
groupAuth="disabled" groupAttribute="memberOf" status="modified">
<aaaLdapRoleGroup id="1" name="" domain="" role="admin" rn="rolegroup-1" >
status="modified" </aaaLdapRoleGroup>
<aaaLdapRoleGroup id="2" name="" domain="" role="user" rn="rolegroup-2" >
status="modified" </aaaLdapRoleGroup>
<aaaLdapRoleGroup id="3" name="" domain="" role="read-only" rn="rolegroup-3">
status="modified" </aaaLdapRoleGroup>
<aaaLdapRoleGroup id="4" name="" domain="" role="" rn="rolegroup-4" >
status="modified" </aaaLdapRoleGroup>
<aaaLdapRoleGroup id="5" name="" domain="" role="" rn="rolegroup-5" >
status="modified" </aaaLdapRoleGroup>
<aaaLdapRoleGroup id="6" name="" domain="" role="" rn="rolegroup-6" >
status="modified" </aaaLdapRoleGroup>
<aaaLdapRoleGroup id="7" name="" domain="" role="" rn="rolegroup-7" >
status="modified" </aaaLdapRoleGroup>
<aaaLdapRoleGroup id="8" name="" domain="" role="" rn="rolegroup-8" >
status="modified" </aaaLdapRoleGroup>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

77

Examples of Common Server Management Tasks

</aaaLdap>
</outConfigs>

Note

82. Configuring LDAP Parameters

You can configure LDAP parameters such as, LDAP status, encryption, timeout, domain, base Dn, binding
parameters, DNS parameters, group authorization parameters, LDAP role groups and so on. The following
example shows configuring LDAP parameters:
Request:
<configConfMo cookie="1351062607/c6c74fd8-ccc8-1cc8-8005-1ec9e1a85750"
inHierarchical="true" dn="sys/ldap-ext">
<inConfig>
<aaaLdap dn="sys/ldap-ext" adminState="enabled" basedn="ExampleDn"
domain="Example.com" filter="MysAMAccountNameYes" attribute="CiscoAviator"
timeout="160" encryption="enabled" locateDirectoryUsingDNS="no"
dnsDomainSource="extracted-domain" dnsSearchDomain="child.cp.com"
dnsSearchForest="cp.com"
ldapServer1="172.26.53.36" ldapServerPort1="636"
ldapServer2="0.0.0.0" ldapServerPort2="636"
ldapServer3="ServThree.com" ldapServerPort3="9636"
ldapServer4="myfinance.com" ldapServerPort4="3269"
ldapServer5="199.22.44.253" ldapServerPort5="9269"
ldapServer6="" ldapServerPort6="3269"
bindMethod="anonymous" bindDn="myexampleDn"
password="magic@#$%(!#&$" groupAuth=enabled"
groupAttribute="memberOfExample">
<aaaLdapRoleGroup id="1" name="name1"
domain="name1.cisco.com" role="user" rn="rolegroup-1"/>
<aaaLdapRoleGroup id="2" name="" domain="" role="read-only"
rn="rolegroup-2"/>
<aaaLdapRoleGroup id="3" name="" domain="" role="admin"
rn="rolegroup-3"/>
<aaaLdapRoleGroup id="4" name="name2"
domain="sjssjsj.djdjdjd.cook.com" role="user" rn="rolegroup-4"/>
<aaaLdapRoleGroup id="5" name="" domain="" role="" rn="rolegroup-5"/>
<aaaLdapRoleGroup id="6" name="" domain="" role="" rn="rolegroup-6"/>
<aaaLdapRoleGroup id="7" name="" domain="domainname.com"
role="admin" rn="rolegroup-7"/>
<aaaLdapRoleGroup id="8" name="" domain="" role="" rn="rolegroup-8"/>
<aaaLdapRoleGroup id="9" name="" domain="" role="" rn="rolegroup-9"/>
<aaaLdapRoleGroup id="10" name="name3"
domain="dorm.ucs.com" role="read-only" rn="rolegroup-10"/>
</aaaLdap>
</inConfig>
</configMo>"

Response:
<configConfMo cookie="1370760204/fb173e00-deb2-1eb2-8002-1ec9e1a85750"
response="yes" dn="sys/ldap-ext" >
<outConfig>
<aaaLdap dn="sys/ldap-ext" adminState="enabled" basedn="ExampleDn"
domain="Example.com" filter="MysAMAccountNameYes" attribute="CiscoAviator"
timeout="160" encryption="enabled" locateDirectoryUsingDNS="yes"
dnsDomainSource="configured-domain" dnsSearchDomain="child.cp.com"
dnsSearchForest="cp.com"
ldapServer1="172.26.53.36" ldapServerPort1="636"
ldapServer2="0.0.0.0" ldapServerPort2="636"
ldapServer3="ServThree.com" ldapServerPort3="9636"
ldapServer4="myfinance.com" ldapServerPort4="3269"
ldapServer5="199.22.44.253" ldapServerPort5="9269"
ldapServer6="" ldapServerPort6="3269"
bindMethod="anonymous" bindDn="myexampleDn" password=""
groupAuth="enabled" groupAttribute="memberOfExample"
status="modified">

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

78

OL-25396-03

Examples of Common Server Management Tasks

<aaaLdapRoleGroup id="1" name="name1"

domain="name1.cisco.com" role="user" rn="rolegroup-1"
status="modified" />
<aaaLdapRoleGroup id="2" name="" domain="" role="read-only"
rn="rolegroup-2" anonymous status="modified"/>
<aaaLdapRoleGroup id="3" name="" domain="" role="admin"
rn="rolegroup-3" status="modified"/>
<aaaLdapRoleGroup id="4" name="name2"
domain="sjssjsj.djdjdjd.cook.com" role="user"
rn="rolegroup-4" status="modified"/>
<aaaLdapRoleGroup id="5" name="" domain="" role="" rn="rolegroup-5"
status="modified"/>
<aaaLdapRoleGroup id="6" name="" domain="" role="" rn="rolegroup-6"
status="modified"/>
<aaaLdapRoleGroup id="7" name="" domain="domainname.com"
role="admin" rn="rolegroup-7" status="modified"/>
<aaaLdapRoleGroup id="8" name="" domain="" role="" rn="rolegroup-8"
status="modified"/>
<aaaLdapRoleGroup id="9" name="" domain="" role="" rn="rolegroup-9"
status="modified"/>
<aaaLdapRoleGroup id="10" name="name3"
domain="dorm.ucs.com" role="read-only"
rn="rolegroup-10" status="modified"/>
</aaaLdap>
</inConfig>
</configMo>"

83. Querying to Check CIMC for NI-IOD Support

Request
<configResolveClass cookie="1375699222/ef7afa00-e330-1330-8004-22bcaa4c93a4"
inHierarchical="false" classId="iodController"/>
</configMo>"

Response
<configResolveClass cookie="1375699222/ef7afa00-e330-1330-8004-22bcaa4c93a4" response="yes"
classId="iodController">
<outConfigs>
<iodController dn="sys/iod" description="Non-Interactive Offline Diagnostics
(IOD)"/>
</outConfigs>
</configResolveClass>

84. Triggering Snapshot based on Parameters Provided with Request

Request
<configConfMo cookie="1375699222/ef7afa00-e330-1330-8004-22bcaa4c93a4" inHierarchical="true"
dn="sys/iod/snapshotStart">
<inConfig>
<iodSnapshotStart dn="sys/iod/snapshotStart" adminState="trigger"
isoShareIp="10.104.255.229"
isoShare="/home/sriparim/xfer/ucs-cxx-scu-3.1.2.iso"
isoShareType="nfs" username="none" password="none" timeOut="30"
remoteShareIp="10.104.255.229"
remoteSharePath="/home/sriparim/xfer" remoteShareFile=""
remoteShareType="scp" remoteShareUsername="root" remoteSharePassword="topspin123" />
</inConfig>
</configConfMo>

Response
<configConfMo dn="sys/iod/snapshotStart"
cookie="1375699222/ef7afa00-e330-1330-8004-22bcaa4c93a4"
response="yes">
<outConfig>
<iodSnapshotStart dn="sys/iod/snapshotStart" adminState="triggered"
isoShareIp="10.104.255.229"
isoSharePath="/home/sriparim/xfer"

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

79

Examples of Common Server Management Tasks

isoShareFile="ucs-cxx-scu-3.1.2.iso" isoShareType="nfs" username="none" password=""

remoteShareIp="10.104.255.229" remoteSharePath="/home/sriparim/xfer"
remoteShareFile="" remoteShareType="scp" remoteShareUsername="root" remoteSharePassword=""
timeOut="30"
status="modified" />
</outConfig>
</configConfMo>

85. Querying Status of Current or Previous Snapshot Operation

Request
<configResolveClass cookie="1375695710/1e1ff5c8-e330-1330-8002-22bcaa4c93a4"
inHierarchical="false"
classId="iodSnapshotStatus"/>

Response: Host Booting

<configResolveClass cookie="1375695710/1e1ff5c8-e330-1330-8002-22bcaa4c93a4" response="yes"
classId="iodSnapshotStatus">
<outConfigs>
<iodSnapshotStatus dn="sys/iod/snapshotStatus" currentStatus="SCU (NI-IOD) booting
in progress"
currentTime="Mon Aug 5 09:46:00 2013 "
startTime="Mon Aug 5 09:46:00 2013 " runningTime="NA" snapshotReport="yes"
remoteShareIp="NA"
remoteSharePath="NA" remoteShareFile="NA" />
</outConfigs>
</configResolveClass>

Response: IOD Tests in Progress

<configResolveClass cookie="1375699222/ef7afa00-e330-1330-8004-22bcaa4c93a4" response="yes"
classId="iodSnapshotStatus">
<outConfigs>
<iodSnapshotStatus dn="sys/iod/snapshotStatus"
currentStatus="SCU Non-interactive IOD tests is in progress"
currentTime="Mon Aug 5 10:48:54 2013
"startTime="Mon Aug 5 10:40:29 2013" runningTime="0 Hours 8 Minutes 49 Seconds"
snapshotReport="yes" remoteShareIp="NA" remoteSharePath="NA"remoteShareFile="NA" />
</outConfigs>
</configResolveClass>

Response: IOD Tests Completed

<configResolveClass cookie="1375699222/ef7afa00-e330-1330-8004-22bcaa4c93a4" response="yes"
classId="iodSnapshotStatus">
<outConfigs>
<iodSnapshotStatus dn="sys/iod/snapshotStatus" currentStatus="Snapshot completed
on this CIMC"
currentTime="Mon Aug 5 11:11:24 2013"
startTime="Mon Aug 5 10:40:29 2013 " runningTime="0 Hours 31 Minutes 0 Seconds"
snapshotReport="yes" remoteShareIp="10.104.255.229" remoteSharePath="/home/sriparim/xfer"
remoteShareFile="" />
</outConfigs>
</configResolveClass>

Response: No Session in Progress

<configResolveClass cookie="1375710321/850e6910-e333-1333-8006-22bcaa4c93a4" response="yes"
classId="iodSnapshotStatus">
<outConfigs>
<iodSnapshotStatus dn="sys/iod/snapshotStatus" currentStatus="NI-IOD session not
found"
currentTime="Sat Jan 3 00:26:05 1970"
startTime="NA"
runningTime="NA" snapshotReport="no" remoteShareIp="NA" remoteSharePath="NA"
remoteShareFile="NA" />
</outConfigs>
</configResolveClass>

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

80

OL-25396-03

APPENDIX

Notes on Using the configConfMo Method

This appendix includes the following topics:
Defining a Distinguished Name using the configConfMo Method, page 81
Using the Optional inHierarchical Attribute, page 82
Configuring a Single Managed Object, page 82

Defining a Distinguished Name using the configConfMo Method

The configConfMo method is used to configure one or more properties in a Managed Object (MO). The MO
to be configured is uniquely identified by a Distinguished Name (DN). This chapter shows two ways to provide
a DN using the configConfMo method.
At the Managed Object Level
You can provide a DN at the Managed Object level. In the following example, the DN
"sys/rack-unit-1/locator-led" is defined within the "equipmentLocatorLed" MO.
<configConfMo
cookie="<real_cookie>">
<inConfig>
<equipmentLocatorLed
adminState='on'
dn='sys/rack-unit-1/locator-led'>
</equipmentLocatorLed>
</inConfig>
</configConfMo>

<== MO level

At the Method and Managed Object Level

You can provide a DN at the Method and Managed Object level. In the following example, the DN
"sys/rack-unit-1/locator-led" is defined at the configConfMo method level and within the
"equipmentLocatorLed" MO.
<configConfMo
cookie="<real_cookie>"
dn='sys/rack-unit-1/locator-led'>
<inConfig>

<== Method level

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

81

Notes on Using the configConfMo Method

Using the Optional inHierarchical Attribute

<equipmentLocatorLed
adminState='on'
dn='sys/rack-unit-1/locator-led'>
</equipmentLocatorLed>
</inConfig>
</configConfMo>

Note

<== MO Level

Specifying a DN at the Method level is optional, and is supported in the Cisco CIMC XML API
implementation to be consistent with the Cisco UCS Manager XML API implementation.

Using the Optional inHierarchical Attribute

When a configConfMo request is sent to CIMC, the response contains only the immediate properties of the
MO being configured.
When the optional inHierarchical attribute is included in the configConfMo request, the response will be
similar to that of the configResolveDn request with the inHierarchical attribute set to true. The response
contains the properties for the MO being configured along with the properties of any children MOs.
Request:
<configConfMo
cookie="<real_cookie>"
inHierarchical="true"
dn='sys/rack-unit-1/locator-led'>
<inConfig>
<equipmentLocatorLed
adminState='on'
dn='sys/rack-unit-1/locator-led'>
</equipmentLocatorLed>
</inConfig>
</configConfMo>

Response:
<configConfMo
dn="sys/rack-unit-1/locator-led"
cookie="<real_cookie>"
response="yes">
<outConfig>
<equipmentLocatorLed
dn="sys/rack-unit-1/locator-led"
adminState="inactive"
color="unknown"
id="1"
name=""
operState="on">
</equipmentLocatorLed>
</outConfig>
</configConfMo>

Configuring a Single Managed Object

In Release 1.5(1x), the Cisco CIMC XML API implementation accepts only configConfMo methods that
operate on a single Managed Object (MO). It is invalid to specify a configConfMo method that contains

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

82

OL-25396-03

Notes on Using the configConfMo Method

Configuring a Single Managed Object

multiple MOs even if they are defined in a containment relationship in the CIMC management information
model.
The following example shows a valid configConfMo method to configure a single MO, "lsbootLan." In this
example, the host is configured to use PXE Boot as the first boot option:
<configConfMo
cookie="<real_cookie>">
<inConfig>
<lsbootLan
order="1"
status="modified"
dn="sys/rack-unit-1/boot-policy/lan" >
</lsbootLan>
</inConfig>
</configConfMo>

<== Single MO

The configConfMo method in the following example is invalid because a Parent and Child MOs are specified
at the same time. The "equipmentLocatorLed" and "solIf" MOs are child objects of the "computeRackUnit"
MO in the management information tree. The Cisco CIMC XML API implementation does not allow a
configConfMo method to perform subtree configurations.
Request:
<configConfMo
cookie="1313084260/40ea8058-aa3e-1a3e-8004-5e61c2e14388"
dn="sys/rack-unit-1" inHierarchical="false">
<inConfig>
<computeRackUnit
adminPower="cycle-immediate"
usrLbl="Cisco C210 Server"
dn="sys/rack-unit-1">
<equipmentLocatorLed
adminState="on"
dn="sys/rack-unit-1/locator-led"/>
<solIf
dn="sys/rack-unit-1/solif"
adminState="enable"
speed="9600"/>
</computeRackUnit>
</inConfig>
</configConfMo>

<== Parent MO

<== Child MO
<== Child MO

Response:
XML PARSING ERROR: Element 'equipmentLocatorLed': This element is not expected.

Note

This method is valid in the Cisco UCS Manager XML API implementation but is not supported in the
Cisco CIMC XML API implementation.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

83

Notes on Using the configConfMo Method

Configuring a Single Managed Object

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

84

OL-25396-03

APPENDIX

The CIMC Visore Utility

Visore is a utility built into CIMC that allows a user to easily browse Managed Objects (MOs) using an
HTML browser. The Visore utility uses the Cisco CIMC XML API query methods to browse the MOs active
in CIMC. The Visore utility cannot be used to perform configuration operations.
Accessing Visore
To access Visore, open a browser and enter one of the following URLs:
http://<CIMC IP Address>/visore.html
https://<CIMC IP Address>/visore.html
When prompted, log in using the same credentials you would use to log in to the CIMC CLI or GUI user
interfaces.

Note

In CIMC Release 1.5(1x), only the Firefox and Chrome browsers are supported for Visore access.

Using Visore to Query a Class

To query for a particular class, enter the class name in the Class or DN field and click Run Query. Visore
sends a configResolveClass method to CIMC and the requested MO is displayed in a tabular format..
Use the < and > buttons to retrieve the Parent and Child class of the displayed MO. For example, clicking
> sends a configResolveChildren method to CIMC to query for the child of the MO. Clicking < sends a
configResolveParent method to CIMC to query for the parent of the MO.
Using Visore to Query a Distinguished Name(DN)
To query for a particular DN, enter the DN in the Class or DN field and click Run Query. Visore sends a
configResolveDn method to CIMC.

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

85

The CIMC Visore Utility

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

86

OL-25396-03

INDEX

API 3, 6, 7
empty results example 7
failed request example 7
flow 3
response to success or failure example 6
successful request example 7
authentication methods 4
description 4

failed request 7

H
HTTP in API communication 1
HTTPS in API communication 1

C
configResolveChildren 11
example 11
configResolveDn 12
example 12
configResolveParent 12
example 12
configuration methods 6
cookie 4, 9
cURL utility 9

management information tree (MIT) 2, 3

place in API flow 3
structure 2

Q
query methods 5, 11, 12
configResolveChildren 11
configResolveDn 12
configResolveParent 12

D
distinguished name 3, 12
description 3
resolving 12

E
empty results 7
event subscription 6
eventSubscribe method 6
examples 11, 12
resolving a distinguished name 12
resolving children 11
resolving parents 12

R
RACK-IN.xsd 29
RACK-OUT.xsd 29
relative name 3
example 3
resolving children example 11
resolving parents 12
example 12

S
successful request 7

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

OL-25396-03

IN-1

Index

UCS API 2
model documentation 2
UCS Manager 2
information model 2

Visore utility 85
using 85

X
XML 3
API flow 3
XML Schema Files 29

Cisco UCS Rack-Mount Servers CIMC XML API Programmers Guide

IN-2

OL-25396-03