Cisco UCS Rack-Mount Servers CIMC XML API Programmer�s Guide
Notes on Using the configConfMo Method
Downloads: This chapterpdf (PDF - 1.21MB) The complete bookPDF (PDF - 2.69MB) | The complete bookePub (ePub - 207.0KB) | Feedback

Notes on Using the configConfMo Method

This appendix includes the following topics:

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'>                          <== MO level
        </equipmentLocatorLed>
    </inConfig>
</configConfMo>

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'>                                 <== Method level
    <inConfig>
        <equipmentLocatorLed
            adminState='on'
            dn='sys/rack-unit-1/locator-led'>                         <== MO Level
        </equipmentLocatorLed>
    </inConfig>
</configConfMo>


Note


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 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                                             <== Single MO
            order="1"
            status="modified"
            dn="sys/rack-unit-1/boot-policy/lan" >
        </lsbootLan>
    </inConfig>
</configConfMo>

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                                       <== Parent MO
             adminPower="cycle-immediate" 
             usrLbl="Cisco C210 Server" 
             dn="sys/rack-unit-1">
                  <equipmentLocatorLed                          <== Child MO
                      adminState="on" 
                      dn="sys/rack-unit-1/locator-led"/>
                  <solIf                                        <== Child MO
                      dn="sys/rack-unit-1/solif" 
                      adminState="enable" 
                      speed="9600"/>
         </computeRackUnit>
      </inConfig>
</configConfMo>

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.