Cisco UCS ラックマウント サーバ CIMC XML API プログラマ ガイド
Cisco CIMC XML API メソッドの説明
Cisco CIMC XML API メソッドの説明
発行日;2013/01/24   |   ドキュメントご利用ガイド   |   ダウンロード ;   この章 pdf   ,   ドキュメント全体 pdf    |   フィードバック

Cisco CIMC XML API メソッドの説明

この章の内容は、次のとおりです。

aaaKeepAlive

aaaKeepAlive メソッドは、メソッド呼び出し後に同じ Cookie を使用して、デフォルトのセッション時間が経過するまでセッションをアクティブなままにします。

要求構文

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

応答構文

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

要求

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

応答

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

aaaLogin

aaaLogin メソッドはログイン プロセスで、セッションを開始するために必要です。 この動作は、クライアントと CIMC の間の HTTP(または HTTPS)セッションを確立します。

要求構文

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

応答構文

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

要求

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

応答

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

aaaLogout

aaaLogout メソッドは、入力としてセッションの Cookie を渡すことによって Web セッションを閉じるプロセスです。 これは自動では行われません。ユーザはセッションを終了するために、aaaLogout メソッドを明示的に呼び出す必要があります。

要求構文

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

応答構文

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

要求

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

応答

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

aaaRefresh

aaaRefresh メソッドは、ユーザ アクティビティによってセッションをアクティブなままにします(デフォルトのセッション期間中)。 デフォルトでは、アクティビティがない時点から 600 秒カウントダウンされます。 600 秒を超えると、CIMC はスリープ モードに入ります。 戻るためにはサインインが必要で、その後カウントダウンが再開されます。 これは同じセッション ID を引き続き使用します。


(注)  


このメソッドを使用すると、以前の Cookie の有効期限が切れ、新しい Cookie が発行されます。


要求構文

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

応答構文

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

要求

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

応答

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

configConfMo

configConfMo メソッドは 1 つのサブツリーで指定の管理対象オブジェクトを設定します(DN など)。

要求構文

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

応答構文

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

要求

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

応答

<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

configResolveChildren メソッドは、管理情報ツリーの特定の DN 下の管理対象オブジェクトの子を取得します。 返される子の数を減らすためにフィルタを使用できます。

要求構文

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

応答構文

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

要求

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

応答

<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

configResolveClass メソッドは、特定のクラスの要求された管理対象オブジェクトを返します。 inHierarchical=true の場合、結果には子が含まれます。

要求構文

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

応答構文

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

要求

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

応答

<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>
    </outConfig>
</configResolveClass>

configResolveDn

configResolveDn メソッドは、指定された DN の 1 つの管理対象オブジェクトを取得します。

要求構文

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

応答構文

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

要求

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

応答

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

configResolveParent

指定された DN について、configResolveParent メソッドは管理対象オブジェクトの親を取得します。

要求構文

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

応答構文

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

要求

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

応答

<configResolveParent
    cookie="<real_cookie>"
    response="yes"
    dn="sys/rack-unit-1/boot-policy/efi-read-only">
    <outConfig>
        <lsbootDef
            dn="sys/rack-unit-1/boot-policy"
            name="boot-policy"
            purpose="operational"
            rebootOnUpdate="no">
        </lsbootDef>
    </outConfig>
</configResolveParent>

eventSubscribe

eventSubscribe メソッドによって、CIMC が生成した非同期のシステム イベント ログ(SEL)イベントをクライアントがサブスクライブできるようになります。

イベント サブスクリプションでは、クライアント アプリケーションが CIMC からのイベント通知を受けるように登録できます。 イベントが発生したときに、CIMC はクライアント アプリケーションにイベントとそのタイプを通知します。 実際の変更情報だけが送信されます。 オブジェクトの影響を受けない属性は含まれません。

次の例に示すように、イベントに登録するために eventSubscribe を使用します。

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

要求構文

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

応答構文

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

要求

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

応答

NO RESPONSE OR ACKNOWLEDGMENT.