CIMC XML API Programmer’s Guide for Cisco UCS E-Series Servers and the Cisco UCS E-Series Network Compute Engine

aaaKeepAlive

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

Request Syntax

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

Response

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"/>
        </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"
    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

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

Response

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 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"/>
            <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>

Examples

Request


<configConfMo 
					cookie="<real_cookie>"
					dn="sys/rack-unit-1/sol-if">
					<inConfig><solIf 
					dn="sys/rack-unit-1/sol-if"
					adminState="enable"></solIf></inConfig></configConfMo>

Response


<configConfMo 
					dn="sys/rack-unit-1/sol-if" 
					cookie="<real_cookie>"
					response="yes">
					<outConfig>
							<solIf dn="sys/rack-unit-1/sol-if" 
											adminState="enable" 
											name="SoLInterface"
											speed="115200" 
											comport="com0" 
											status="modified" >
						</solIf>
			</outConfig> 
</configConfMo>

configResolveChildren

The configResolveChildren method retrieves children of managed objects under a specific DN in the managed information tree. A filter can be used to reduce the number of children being returned.

Request Syntax


<xs:element name="configResolveChildren" type="configResolveChildren" substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveChildren" mixed="true">
            <xs:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <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>
            <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


<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:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </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="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>" 
				inHierarchical="false"
				classId="computeRackUnit"/>

Response


<configResolveClass cookie="<real_cookie>" 
				response="yes"
				classId="computeRackUnit"> <outConfigs> <computeRackUnit 
				dn="sys/rack-unit-1" 
				adminPower="policy" 
				availableMemory="24576"
				lowVoltageMemory="regular-voltage" 
				model="UCS-E160DP-M1/K9"
				memorySpeed="1334" 
				name="E160DP" 
				numOfAdaptors="0" 
				numOfCores="6"
				numOfCoresEnabled="6" 
				numOfCpus="1" 
				numOfEthHostIfs="0" 
				numOfFcHostIfs="0"
				numOfThreads="12" 
				operability="operable" 
				operPower="off" 
				operState="ok"
				originalUuid="0024C4F4-89F2-0000-A7D1-770BCA4B8924" 
				presence="equipped"
				serverId="1" 
				serial="FHH16150031" 
				totalMemory="24576" usrLbl=""
				uuid="0024C4F4-89F2-0000-A7D1-770BCA4B8924" 
				vendor="Cisco Systems Inc">
			</computeRackUnit>
		</outConfigs> 
</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 
				cookie="<real_cookie>" 
				inHierarchical="false"
				dn="sys/rack-unit-1"/>

Response


<configResolveDn
    cookie="<real_cookie>"
    response="yes"
				dn="sys/rack-unit-1"> <outConfig> 
				<computeRackUnit 
								dn="sys/rack-unit-1"
								adminPower="policy" 
								availableMemory="24576"
								lowVoltageMemory="regular-voltage" 
								model="UCS-E160DP-M1/K9"
								memorySpeed="1334" 
								name="E160DP" 
								numOfAdaptors="0" 
								numOfCores="6"
								numOfCoresEnabled="6" 
								numOfCpus="1" 
								numOfEthHostIfs="0" 
								numOfFcHostIfs="0"
								numOfThreads="12" 
								operability="operable" 
								operPower="off" 
								operState="ok"
								originalUuid="0024C4F4-89F2-0000-A7D1-770BCA4B8924" 
								presence="equipped"
								serverId="1" 
								serial="FHH16150031" 
								totalMemory="24576" usrLbl=""
								uuid="0024C4F4-89F2-0000-A7D1-770BCA4B8924" 
								vendor="Cisco Systems Inc">
					</computeRackUnit>
			</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>" 
				inHierarchical="false"
				dn="sys/rack-unit-1"/>

Response


<configResolveParent
    cookie="<real_cookie>"
    response="yes"
				dn="sys/rack-unit-1"> 
				<outConfig> 
						<topSystem 
								dn="sys"
								address="172.25.209.108" 
								currentTime="Mon Jan 7 15:48:57 2013 "
								mode="stand-alone" 
								name="ucs-e160dp-m1" >
					</topSystem>
				</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 object’s 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:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <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.

Bias-Free Language

Results

Chapter: Using CIMC XML API Method Descriptions

Using CIMC XML API Method Descriptions

aaaKeepAlive

Request Syntax

Response Syntax

Examples

aaaLogin

Request Syntax

Response Syntax

Examples

aaaLogout

Request Syntax

Response Syntax

Examples

aaaRefresh

Request Syntax

Response Syntax

Examples

configConfMo

Request Syntax

Response Syntax

Examples

configResolveChildren

Request Syntax

Response Syntax

Examples

configResolveClass

Request Syntax

Response Syntax

Examples

configResolveDn

Request Syntax

Response Syntax

Examples

configResolveParent

Request Syntax

Response Syntax

Examples

eventSubscribe

Request Syntax

Response Syntax

Examples

Was this Document Helpful?

Contact Cisco