Cisco UCS Manager XML API Programmer�s Guide
Method Descriptions
Downloads: This chapterpdf (PDF - 1.19MB) The complete bookPDF (PDF - 2.18MB) | The complete bookePub (ePub - 164.0KB) | Feedback

Method Descriptions

Method Descriptions

This chapter includes the following sections:

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.


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.

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 .

Request Syntax

Response Syntax

Examples

Request

Response

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, 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

Response Syntax

Examples

Request

Response

configConfMo

The configConfMo method configures the specified managed object in a single subtree (for example, DN).

Request Syntax

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

Response

configResolveChildren

The configResolveChildren method retrieves children of managed objects under a specific DN in the managed information tree.

Request Syntax

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

Response

configResolveClass

The configResolveClass method returns requested managed object in a given class. If inHierarchical=true, the results contain children.

Request Syntax

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

Response

configResolveDn

The configResolveDn method retrieves a single managed object for a specified DN.

Request Syntax

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

Response

configResolveParent

For a specified DN, the configResolveParent method retrieves the parent of the managed object.

Request Syntax

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

Response

eventSubscribe

Event subscription allows a client application to register for event notification from . When an event occurs, 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

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

Response

NO RESPONSE OR ACKNOWLEDGMENT.

eventUnsubscribe

Use eventUnsubscribe to unsubscribe from events as shown in the following example:

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

Request Syntax

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

Response

NO RESPONSE OR ACKNOWLEDGMENT.