The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Contents
This appendix includes the following topic:
The following examples 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.
Request:
<configResolveClass cookie="1357577156/9028d030-d2b5-12b5-8007-f289f4c42400" inHierarchical="false" classId="computeRackUnit"/>
Response:
<configResolveClass cookie="1357577156/9028d030-d2b5-12b5-8007-f289f4c42400" 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>
Request:
<configResolveClass cookie="1357577156/9028d030-d2b5-12b5-8007-f289f4c42400" inHierarchical="false" classId="firmwareRunning"/>
Response:
<configResolveClass cookie="1357577156/9028d030-d2b5-12b5-8007-f289f4c42400" response="yes" classId="firmwareRunning"> <outConfigs> <firmwareRunning dn="sys/rack-unit-1/bios/fw-boot-loader" deployment="boot-loader" type="blade-bios" version="4.6.4.9" > </firmwareRunning> <firmwareRunning dn="sys/rack-unit-1/mgmt/fw-boot-loader" deployment="boot-loader" type="blade-controller" version="1.0(1.20130103121559).23"> </firmwareRunning> <firmwareRunning dn="sys/rack-unit-1/mgmt/fw-system"> deployment="system" type="blade-controller"> version="1.0(1.20130103121559)" > </firmwareRunning> </outConfigs> > </configResolveClass>
Request:
<configResolveDn cookie="1357577156/9028d030-d2b5-12b5-8007-f289f4c42400" inHierarchical="false" dn="sys/rack-unit-1/mgmt/fw-updatable"/>
Response:
<configResolveDn cookie="1357577156/9028d030-d2b5-12b5-8007-f289f4c42400" 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.0(1.20121206-pha2) #1" protocol="none" remoteServer="" remotePath="" user="" pwd="" progress="0" type="blade-controller"> </firmwareUpdatable> </outConfig> </configResolveDn>
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" childAction="deleteNonPresent"> <lsbootVirtualMedia access="read-only" order="3" type="virtual-media" rn="vm-read-only" childAction="deleteNonPresent"/> <lsbootVirtualMedia access="read-write" order="5" type="virtual-media" rn="vm-read-write" childAction="deleteNonPresent"/> <lsbootLan rn="lan-read-only" access="read-only" order="2" prot="pxe" type="lan" childAction="deleteNonPresent"/> <lsbootStorage rn="storage-read-write" access="read-write" order="1" type="storage" childAction="deleteNonPresent"> <lsbootLocalStorage rn="local-storage" childAction="deleteNonPresent"/> </lsbootStorage> <lsbootEfi rn="efi-read-only" access="read-only" order="4" type="efi" childAction="deleteNonPresent"/> </lsbootDef> </outConfig> </configResolveClass>
Request:
<configResolveClass cookie="1363615849/8e4ceb60-d833-1833-8002-f289f4c42400" inHierarchical="false" classId="hostImage"/>
Response:
<configResolveClass cookie="1363615849/8e4ceb60-d833-1833-8002-f289f4c42400" response="yes" classId="hostImage"> <outConfig> <hostImage index="1" name="linux.iso" date="Fri, 15 Mar 2013 04:34:10 GMT" size="336222208" md5sum="72869d19c2fdea60138d315156b6e7fe" dn="sys/rack-unit-1/host-image-mapping/host-image-1"/> </hostImage> </outConfig> </configResolveClass>
Request:
<configConfMo cookie="1357578468/de622490-d2b5-12b5-8009-f289f4c42400" dn="sys/rack-unit-1"> <inConfig> <computeRackUnit dn="sys/rack-unit-1"adminPower="cycle-immediate"> </computeRackUnit> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/rack-unit-1" cookie="1357578468/de622490-d2b5-12b5-8009-f289f4c42400" response="yes"> <outConfig> <computeRackUnit dn="sys/rack-unit-1" adminPower="policy" availableMemory="24576" lowVoltageMemory="NOTINCP-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="NOTINCP-operable" operPower="on" operState="NOTINCP-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" status="modified" > </computeRackUnit> </outConfig> </configConfMo>
Request:
<configConfMo cookie="1313090863/ca79ef88-aa3f-1a3f-8006-5e61c2e14388" dn="sys/rack-unit-1/boot-policy/efi-read-only" inHierarchical="false"> <inConfig> <lsbootEfi order="2" status="modified" dn="sys/rack-unit-1/boot-policy/efi-read-only"/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/rack-unit-1/boot-policy/efi-read-only" cookie="1313090863/ca79ef88-aa3f-1a3f-8006-5e61c2e14388" response="yes"> <outConfig> <lsbootEfi dn="sys/rack-unit-1/boot-policy/efi-read-only" access="read-only" order="2" type="efi" status="modified"/> </outConfig> </configConfMo>
Request:
<configConfMo cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388" dn="sys/rack-unit-1/boot-policy/vm-read-write" inHierarchical="true"> <inConfig> <lsbootVirtualMedia order="5" access="read-write" status="deleted" dn="sys/rack-unit-1/boot-policy/vm-read-write"/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/rack-unit-1/boot-policy/vm-read-write" cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388" response="yes"> <outConfig> </outConfig> </configConfMo>
Request:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" inHierarchical="false" classId="commSnmp"/>
Response:
<configResolveClass cookie="1313086522/c7c08988-aa3e-1a3e-8005-5e61c2e14388" response="yes" classId="commSnmp"> <outConfig> <commSnmp dn="sys/svc-ext/snmp-svc" adminState="enabled" community="topSecret" descr="SNMP Service" name="snmp" port="161" proto="udp" sysContact="demo@demo.com" sysLocation="San Jose"/> </outConfig> </configResolveClass>
Request:
<configConfMo cookie="1313090863/ca79ef88-aa3f-1a3f-8006-5e61c2e14388" inHierarchical="true" dn="sys/svc-ext/snmp-svc"> <inConfig> <commSnmp dn="sys/svc-ext/snmp-svc" sysContact="TheAdmin@ITDept.com" community="demoPrivate" sysLocation="SanJoseCalifornia"/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/svc-ext/snmp-svc" cookie="1313090863/ca79ef88-aa3f-1a3f-8006-5e61c2e14388" response="yes"> <outConfig> <commSnmp dn="sys/svc-ext/snmp-svc" adminState="enabled" community="demoPrivate" descr="SNMP Service" name="snmp" port="161" proto="udp" sysContact="TheAdmin@ITDept.com" sysLocation="SanJoseCalifornia" status="modified" childAction="deleteNonPresent"> <commSnmpTrap adminState="disabled" community="demoPublic" hostname="11.22.33.44" id="1" notificationType="informs" version="v1" rn="snmp-trap-1" status="modified" childAction="deleteNonPresent"/> <commSnmpTrap adminState="disabled" community="demoPublic" hostname="50.60.70.80" id="2" notificationType="informs" version="v1" rn="snmp-trap-2" status="modified" childAction="deleteNonPresent"/> <commSnmpTrap adminState="disabled" community="demoPublic" hostname="0.0.0.0" id="3" notificationType="informs" version="v1" rn="snmp-trap-3" status="modified" childAction="deleteNonPresent"/> <commSnmpTrap adminState="enabled" community="demoPublic" hostname="138.148.198.218" id="4" notificationType="informs" version="v1" rn="snmp-trap-4" status="modified" childAction="deleteNonPresent"/> </commSnmp> </outConfig> </configConfMo>
Request:
<configResolveClass cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388" inHierarchical="false" classId="biosVfSelectMemoryRASConfiguration"/>
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>
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 dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration" cookie="1313092854/412183f8-aa40-1a40-8007-5e61c2e14388" response="yes"> <outConfig> <biosVfSelectMemoryRASConfiguration dn="sys/rack-unit-1/bios/bios-settings/SelectMemory-RAS-configuration" vpSelectMemoryRASConfiguration="mirroring" status="modified"/> </outConfig> </configConfMo>
Request:
<configConfMo dn="sys/export-config" cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" inHierarchical="false"> <inConfig> <mgmtBackup dn="sys/export-config" adminState="enabled" hostname="198.29.210.14" remoteFile="/tftpserver/c250_config_export.cfg"/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/export-config" cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes"> <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. You can periodically query for the completion status by sending the following request:
Status request:
<configResolveClass cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" inHierarchical="false" classId=" mgmtBackup"/>
Status response after completion:
<configResolveClass cookie="1313122298/1c207238-aa47-1a47-8009-5e61c2e14388" response="yes" classId="mgmtBackup"> <outConfig> <mgmtBackup dn="sys/export-config" adminState="disabled" fsmStageDescr="Completed successfully" fsmRmtInvErrCode="" fsmRmtInvErrDescr="NONE" fsmDescr="export-config" proto="tftp" hostname="" remoteFile=""/> </outConfig> </configResolveClass>
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> . . .
Request:
<configConfMo dn="sys/import-config" cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" inHierarchical="false"> <inConfig> <mgmtImporter dn="sys/import-config" adminState="enabled" hostname="198.29.210.14" remoteFile="/tftpserver/c250_config_export.cfg"/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/import-config" cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes"> <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="tftp" hostname="" remoteFile=""/> </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="tftp" hostname="" remoteFile=""/> </outConfig> </configResolveClass>
Request:
<configConfMo dn="sys/rack-unit-1/tech-support" cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" inHierarchical="false"> <inConfig> <sysdebugTechSupportExport dn="sys/rack-unit-1/tech-support" adminState="enabled" remoteFile="/tftpserver/c250_techsupport_archive.tgz" hostname="198.29.210.14"/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/rack-unit-1/tech-support" cookie="1313118253/2b07f100-aa46-1a46-8008-5e61c2e14388" response="yes"> <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="none" fsmProgr="0" fsmStatus="nop" status="modified"/> </outConfig> </configConfMo>
The preceding request launches the export 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="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>
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 . . .