The examples in
this section show how to use the Cisco IMC XML API to retrieve and perform
power management tasks. Each example shows the XML API request followed by the
response from Cisco IMC.
This section
includes the following examples:
Disabling Power
Capping
Request:
<configConfMo cookie='1472715713/d2304f05-6e3b-1b6e-8002-ddf0c322e470'
dn='sys/chassis-1/budget'>
<inConfig>
<chassisPowerBudget dn='sys/chassis-1/budget' adminState='disabled'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/budget" cookie="1472715713/d2304f05-6e3b-1b6e-8002-ddf0c322e470"
response="yes">
<outConfig>
<chassisPowerBudget dn="sys/chassis-1/budget" adminState="disabled" minPower="712"
maxPower="1023" budget="1023" capBudget="551" powerCharStatus="Completed successfully"
autoMinBudget="901" adminAction="no-op" status="modified" >
</chassisPowerBudget>
</outConfig>
</configConfMo>
Enabling Power
Capping and Setting Chassis Budget
Request:
<configConfMo cookie='1472715713/d2304f05-6e3b-1b6e-8002-ddf0c322e470'
dn='sys/chassis-1/budget'>
<inConfig>
<chassisPowerBudget dn='sys/chassis-1/budget' adminState='enabled' budget='900'/>
</inConfig></configConfMo>"
Response:
<configConfMo dn="sys/chassis-1/budget" cookie="1472715713/d2304f05-6e3b-1b6e-8002-ddf0c322e470"
response="yes">
<outConfig>
<chassisPowerBudget dn="sys/chassis-1/budget" adminState="enabled" minPower="712"
maxPower="1023" budget="900" capBudget="551" powerCharStatus="Completed successfully"
autoMinBudget="901" adminAction="no-op" status="modified" >
</chassisPowerBudget>
</outConfig>
</configConfMo>
Running Power
Characterization
Request:
<configConfMo cookie='1452562357/3e4c4620-1929-1919-800f-00f8c322e470'
dn='sys/chassis-1/budget'>
<inConfig>
<chassisPowerBudget dn='sys/chassis-1/budget' adminAction='start-power-char'
status='modified'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/budget" cookie="1452562357/3e4c4620-1929-1919-800f-00f8c322e470"
response="yes">
<outConfig>
<chassisPowerBudget dn="sys/chassis-1/budget" adminState="disabled" minPower="421"
maxPower="421" budget="421" capBudget="-1" runPowCharAtBoot="yes"
powerCharStatus="Completed successfully" adminAction="no-op" status="modified" >
</chassisPowerBudget>
</outConfig>
</configConfMo>
Resetting Power
Profiles to Default
Request:
<configConfMo cookie='1452562357/3e4c4620-1929-1919-800f-00f8c322e470'
dn='sys/chassis-1/budget'>
<inConfig>
<chassisPowerBudget dn='sys/chassis-1/budget'
adminAction='reset-power-profile-default' status='modified'/>
</inCo nfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/budget" cookie="1453845128/57ec2969-442a-1a44-8003-6b47145daae4"
response="yes">
<outConfig>
<chassisPowerBudget dn="sys/chassis-1/budget" adminState="enabled" minPower="N/A"
maxPower="N/A" budget="N/A" capBudget="N/A" runPowCharAtBoot="yes"
powerCharStatus="Running" adminAction="no-op" status="modified">
</chassisPowerBudget>
</outConfig>
</configConfMo>
Retrieving
Global Power Capping Details
Request:
<configResolveDn cookie='1453596884/fd2963e6-092a-1a09-8009-6b47145daae4'
inHierarchical='false' dn='sys/chassis-1/budget'/>
Response:
<configResolveDn cookie="1472719025/9c73f130-6e3b-1b6e-8003-ddf0c322e470"
response="yes" dn="sys/chassis-1/budget">
<outConfig>
<chassisPowerBudget dn="sys/chassis-1/budget" adminState="enabled" minPower="712"
maxPower="1023" budget="900" capBudget="435" powerCharStatus="Completed successfully"
autoMinBudget="901" adminAction="no-op" >
</chassisPowerBudget>
</outConfig>
</configResolveDn>
Enabling Custom
Profiles
Request:
<configConfMo cookie='1452505509/a4e30f9d-0c29-190c-8008-00f8c322e470'
dn='sys/chassis-1/server-1/budget/cust-prof'>
<inConfig>
<customPowerProfile dn='sys/chassis-1/server-1/budget/cust-prof' profileEnabled='yes'
allowThrottle='yes' suspendPeriod='10:30-22:30|Mo,Tu' corrAction='alert' corrTime='3'
powerLimit='250'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/budget/cust-prof"
cookie="1452505509/a4e30f9d-0c29-190c-8008-00f8c322e470" response="yes">
<outConfig>
<customPowerProfile dn="sys/chassis-1/server-1/budget/cust-prof"
profileType="custom" profileEnabled="yes" allowThrottle="yes" powerLimit="250"
suspendPeriod="10:30-22:30|Mo,Tu" corrAction="alert" corrTime="3" status="modified" >
</customPowerProfile>
</outConfig>
</configConfMo>
Retrieving
Custom Profile Details
Request:
<configResolveClass cookie='1452506619/f5fd0476-0c29-190c-8009-00f8c322e470'
inHierarchical='true' classId='customPowerProfile'/>
Response:
<configResolveClass cookie="1452506619/f5fd0476-0c29-190c-8009-00f8c322e470"
response="yes" classId="customPowerProfile">
<customPowerProfile dn="sys/chassis-1/server-1/budget/cust-prof" profileType="custom"
profileEnabled="yes" allowThrottle="yes" powerLimit="250" suspendPeriod="10:30-22:30|Mo,Tu"
corrAction="alert" corrTime="3" >
</customPowerProfile>
</outConfigs>
</configResolveClass>
Disabling
Custom Profile
Request:
<configConfMo cookie='1452505509/a4e30f9d-0c29-190c-8008-00f8c322e470'
dn='sys/chassis-1/server-1/budget/cust-prof'>
<inConfig>
<customPowerProfile dn='sys/chassis-1/server-1/budget/cust-prof' profileEnabled='no'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/budget/cust-prof"
cookie="1452505509/a4e30f9d-0c29-190c-8008-00f8c322e470" response="yes">
<outConfig>
<customPowerProfile dn="sys/chassis-1/server-1/budget/cust-prof" profileType="custom"
profileEnabled="no" allowThrottle="yes" powerLimit="250" suspendPeriod="10:30-22:30|Mo,Tu"
corrAction="alert" corrTime="3" status="modified" >
</customPowerProfile>
</outConfig>
</configConfMo>
Enabling
Auto-Balance Profile with Priority Type Dynamic
Request:
<configConfMo cookie='1453492545/55992822-f229-19f2-8003-6b47145daae4'
dn='sys/chassis-1/budget/auto-prof'>
<inConfig>
<autoPowerProfile dn='sys/chassis-1/budget/auto-prof' profileEnabled='yes'
priority='dynamic' allowThrottle='yes' corrAction='alert' corrTime='1'
suspendPeriod='10:30-22:30|Mo,Tu'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/budget/auto-prof"
cookie="1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470" response="yes">
<outConfig>
<autoPowerProfile dn="sys/chassis-1/budget/auto-prof" profileType="auto_balance"
profileEnabled="yes" priority="dynamic" priorServerId="1" powerLimitServer1="223"
powerLimitServer2="1163" allowThrottle="yes" suspendPeriod="10:30-22:30|Mo,Tu"
corrAction="alert" corrTime="1" status="modified" >
</autoPowerProfile>
</outConfig>
</configConfMo>
Enabling
Auto-Balance Profile with Priority Type Manual
Request:
<configConfMo cookie='1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470'
dn='sys/chassis-1/budget/auto-prof'>
<inConfig>
<autoPowerProfile dn='sys/chassis-1/budget/auto-prof' profileEnabled='yes'
priority='manual' priorServerId='2' allowThrottle='yes' corrAction='alert'
corrTime='1' suspendPeriod='10:30-22:30|Mo,Tu'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/budget/auto-prof"
cookie="1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470" response="yes">
<outConfig>
<autoPowerProfile dn="sys/chassis-1/budget/auto-prof" profileType="auto_balance"
profileEnabled="yes" priority="manual" priorServerId="2" powerLimitServer1="201"
powerLimitServer2="329" allowThrottle="yes" suspendPeriod="10:30-22:30|Mo,Tu"
corrAction="alert" corrTime="1" status="modified" >
</autoPowerProfile>
</outConfig>
</configConfMo>
Disabling
Auto-Balance Profile
Request:
<configConfMo cookie='1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470'
dn='sys/chassis-1/budget/auto-prof'>
<inConfig>
<autoPowerProfile dn='sys/chassis-1/budget/auto-prof' profileEnabled='no'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/budget/auto-prof"
cookie="1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470" response="yes">
<outConfig>
<autoPowerProfile dn="sys/chassis-1/budget/auto-prof" profileType="auto_balance"
profileEnabled="no" priority="manual" priorServerId="2" powerLimitServer1="201"
powerLimitServer2="329" allowThrottle="yes" suspendPeriod="10:30-22:30|Mo,Tu"
corrAction="alert" corrTime="1" status="modified" >
</autoPowerProfile>
</outConfig>
</configConfMo>
Enabling
Thermal Profile
Request:
<configConfMo cookie='1452550587/731da901-1729-1917-800b-00f8c322e470'
dn='sys/chassis-1/server-2/budget/thermal-prof'>
<inConfig>
<thermalPowerProfile dn='sys/chassis-1/server-2/budget/thermal-prof'
profileEnabled='yes' temperature ='25'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-2/budget/thermal-prof"
cookie="1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470" response="yes">
<outConfig>
<thermalPowerProfile dn="sys/chassis-1/server-2/budget/thermal-prof"
profileType="thermal" profileEnabled="yes" temperature="25" powerLimit="150"
status="modified" >
</thermalPowerProfile>
</outConfig>
</configConfMo>
Disabling
Thermal Profile
Request:
<configConfMo cookie='1452550587/731da901-1729-1917-800b-00f8c322e470'
dn='sys/chassis-1/server-2/budget/thermal-prof'>
<inConfig>
<thermalPowerProfile dn='sys/chassis-1/server-2/budget/thermal-prof'
profileEnabled='no' />
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-2/budget/thermal-prof"
cookie="1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470" response="yes">
<outConfig>
<thermalPowerProfile dn="sys/chassis-1/server-2/budget/thermal-prof"
profileType="thermal" profileEnabled="no" temperature="40" powerLimit="150"
status="modified" >
</thermalPowerProfile>
</outConfig>
</configConfMo>
Retrieving the
CPU Power Utilization for Server Nodes
Request:
<configResolveClass cookie='1453435371/7a33a835-e529-19e5-8002-00f8c322e470'
inHierarchical='true' classId='serverUtilization'/>
Response:
<configResolveClass cookie="1472719802/6298eaac-6e3b-1b6e-8005-ddf0c322e470"
response="yes" classId="serverUtilization">
<outConfigs>
<serverUtilization dn="sys/chassis-1/server-1/utilization" overallUtilization="0"
cpuUtilization="0" memoryUtilization="0" ioUtilization="0" >
</serverUtilization>
<serverUtilization dn="sys/chassis-1/server-2/utilization" overallUtilization="96"
cpuUtilization="100" memoryUtilization="4" ioUtilization="0" >
</serverUtilization></outConfigs>
</configResolveClass>
Retrieving
Power Monitoring Details of Chassis and Server Nodes
Request:
<configResolveClass cookie='1453489912/722ed3e2-f129-19f1-8002-6b47145daae4'
inHierarchical='true' classId='powerMonitor'/>
Response:
<configResolveClass cookie="1453489912/722ed3e2-f129-19f1-8002-6b47145daae4"
response="yes" classId="powerMonitor">
<outConfigs>
<powerMonitor domain="Platform" current="220" minimum="90" maximum="342" average="184"
period="0days 1:58:1" dn="sys/chassis-1/server-1/pwrmonitor-Platform" >
</powerMonitor>
<powerMonitor domain="CPU" current="158" minimum="46" maximum="259" average="127"
period="0days 1:58:1" dn="sys/chassis-1/server-1/pwrmonitor-CPU" >
</powerMonitor>
<powerMonitor domain="Memory" current="18" minimum="8" maximum="33" average="15"
period="0days 1:58:1" dn="sys/chassis-1/server-1/pwrmonitor-Memory" >
</powerMonitor><powerMonitor domain="Platform" current="132" minimum="96" maximum="366"
average="118" period="0days 1:58:3" dn="sys/chassis-1/server-2/pwrmonitor-Platform" >
</powerMonitor><powerMonitor domain="CPU" current="74" minimum="42" maximum="251" average="62"
period="0days 1:58:3" dn="sys/chassis-1/server-2/pwrmonitor-CPU" >
</powerMonitor>
<powerMonitor domain="Memory" current="22" minimum="16" maximum="64" average="20"
period="0days 1:58:3" dn="sys/chassis-1/server-2/pwrmonitor-Memory" >
</powerMonitor>
</outConfigs>
</configResolveClass>
Retrieving
Chassis Power Budget Details
Request:
<configResolveClass cookie='1453489912/722ed3e2-f129-19f1-8002-6b47145daae4'
inHierarchical='true' classId='chassisPowerBudget'/>
Response:
<configResolveClass cookie="1453489912/722ed3e2-f129-19f1-8002-6b47145daae4"
response="yes" classId="chassisPowerBudget">
<outConfigs>
<chassisPowerBudget dn="sys/chassis-1/budget" adminState="enabled" minPower="888"
maxPower="1361" budget="1200" capBudget="740" runPowCharAtBoot="yes"
powerCharStatus="Completed successfully" adminAction="no-op" >
<autoPowerProfile rn="auto-prof" profileType="auto_balance" profileEnabled="no"
priority="manual" priorServerId="1" powerLimitServer1="499" powerLimitServer2="415"
allowThrottle="no" suspendPeriod="" corrAction="none" corrTime="1" >
</autoPowerProfile>
</chassisPowerBudget></outConfigs>
</configResolveClass>