- Preface
- Cisco IMC XML API
- Using the Cisco IMC XML API Methods
- Cisco IMC XML API Method Descriptions
- Cisco IMC XML Schema Definition Files
- Cisco IMC XML Object-Access Privileges
- Managing Chassis and Dynamic Storage
- Managing the Server
- Managing Remote Presence
- Configuring Network-Related Settings
- Managing Storage Adapters
- Configuring Communication Services
- Configuring Platform Event Filters
- Managing Certificates
- Managing Firmware
- Server Utilities
- Notes on Using the configConfMo Method
- The Cisco IMC Visore Utility
- Index
Managing Storage
Adapters
This chapter includes the following sections:
Server RAID Management Tasks
The examples in this section show how to use the Cisco IMC XML API to retrieve and perform server RAID management tasks. Each example shows the XML API request followed by the response from Cisco IMC.
This section includes the following examples:
Retrieving Storage Controller Using DN
Request:
<configResolveDn cookie="1422613813/9657c746-dc0d-1ddc-8004-91fabb1b0ff4" inHierarchical="false" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ"/>
Response:
<configResolveDn cookie="1422613813/9657c746-dc0d-1ddc-8004-91fabb1b0ff4" response="yes"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ"/>
<outConfig>
<storageController id="SLOT-MEZZ"
model="RAID controller for UCS C3X60 Storage Servers"
pciSlot="SLOT-MEZZ" presence="equipped" raidSupport="yes"
serial="" type="SAS"
vendor="LSI Logic" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ"/>
</outConfig>
</configResolveDn>
Retrieving Storage Controller Properties
Request:
<configResolveClass cookie="1422613813/9657c746-dc0d-1ddc-8004-91fabb1b0ff4" classId="storageControllerProps" inHierarchical="false"/>
Response:
<configResolveClass cookie="1422613813/9657c746-dc0d-1ddc-8004-91fabb1b0ff4"
response="yes" classId="storageControllerProps">
<outConfigs>
<storageControllerProps
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/controller-props"
pciSlot="SLOT-MEZZ" health="Severe Fault"
controllerStatus="Optimal" batteryStatus="Optimal"
bbuPresent="true" raidChipTempCentigrade="82" backendPortCount="8"
memorySize="4095 MB" cacheMemorySize="3534 MB"
virtualDriveCount="1" degradedVirtualDriveCount="0"
offlineVirtualDriveCount="0" physicalDriveCount="60"
criticalPhysicalDriveCount="0" failedPhysicalDriveCount="5"
memoryCorrectableErrors="0" memoryUncorrectableErrors="0" bootDrive="0"
bootDriveIsPhysicalDrive="false" supportsRaid0="true" supportsRaid1="true"
supportsRaid5="true" supportsRaid6="true" supportsRaid00="true"
supportsRaid10="true" supportsRaid50="true" supportsRaid60="true"supportsRaid1e="false"
supportsRaid1erlq0="true" supportsRaid1e0rlq0="true" supportsRaidsrl03="true"
dateOfManufacture="N/A" revision="N/A" prebootCliVersion="01.07-05:#%0000"
webBiosVersion="5.08-0007" nvdataVersion="3.1411.00-0011"
bootBlockVersion="3.06.00.00-0001" bootVersion="N/A"
nvramPresent="true" serialDebuggerPresent="true" flashPresent="true"
sasAddress0="500e004aaaaabb7f" sasAddress1="500e004aaaaaaa7f"
sasAddress2="0000000000000000" sasAddress3="0000000000000000"
sasAddress4="0000000000000000" sasAddress5="0000000000000000"
sasAddress6="0000000000000000" sasAddress7="0000000000000000"
serial="" firmwarePackageBuild="24.7.0-0030" ttyLogStatus="Not Downloaded"/>
</outConfigs>
</configResolveClass>
Retrieving Storage Raid Battery Properties
Request:
<configResolveDn cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4" inHierarchical="false" dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/raid-battery'/>
Response:
<configResolveDn cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4" response="yes"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/raid-battery">
<outConfig>
<storageRaidBattery dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/raid-battery"
batteryType="TMM-C SuperCap" health="Good" batteryStatus="Optimal"
batteryPresent="true" chargingState="N/A" retentionTime="N/A"
temperature="36 degrees C" temperatureHigh="false"
designVoltage="9.500 V" voltage="9.464 V" current="0.000 A" learnMode="Auto"
completedChargeCycles="N/A" learnCycleStatus="Successful" learnCycleRequested="false"
nextLearnCycle="2015-02-09 09:02" designCapacity="288 Joules" fullCapacity="N/A"
remainingCapacity="N/A" relativeStateOfCharge="N/A" absoluteStateOfCharge="N/A"
expectedMarginOfError="N/A" manufacturer="LSI" dateOfManufacture="2013-08-15"
serialNumber="6582" firmwareVersion="26535-02" adminAction="no-op"/>
</outConfig>
</configResolveDn>
Retrieving Storage Virtual Drive Properties
Request:
<configResolveClass cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4" classId="storageVirtualDrive" inHierarchical="false"/>
Response:
<configResolveClass cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4" response="yes" classId="storageVirtualDrive"> <outConfigs> <storageVirtualDrive id="0" name="junk_vd" raidLevel="RAID 5" size="399999 MB" vdStatus="Optimal" health="Good" bootDrive="true" stripSize="64 KB" drivesPerSpan="4" spanDepth="1" accessPolicy="Read-Write" cachePolicy="Direct" readAheadPolicy="None" requestedWriteCachePolicy="Write Through" currentWriteCachePolicy="Write Through" diskCachePolicy="Unchanged" allowBackgroundInit="true" autoSnapshot="false" autoDeleteOldest="true" driveState="Optimal" adminAction="no-op" targetId="0" physicalDrivesList="Physical drives to be used for virtual drive reconstruction. pd_id1,pd_id2,...pd_idN" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-0"/> </outConfigs> </configResolveClass>
Retrieving Storage Virtual Drive Properties using DN
Request:
<configResolveDn cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4" inHierarchical="false" dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-0'/>
Response:
<configResolveDn cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4" response="yes"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-0">
<outConfig>
<storageVirtualDrive id="0" name="junk_vd" raidLevel="RAID 5"
size="399999 MB" vdStatus="Optimal" health="Good" bootDrive="true"
stripSize="64 KB" drivesPerSpan="4" spanDepth="1" accessPolicy="Read-Write"
cachePolicy="Direct" readAheadPolicy="None" requestedWriteCachePolicy="Write Through"
currentWriteCachePolicy="Write Through" diskCachePolicy="Unchanged"
allowBackgroundInit="true" autoSnapshot="false" autoDeleteOldest="true"
driveState="Optimal" adminAction="no-op" targetId="0"
physicalDrivesList="Physical drives to be used for virtual drive reconstruction.
...pd_id1,pd_id2,...pd_idN"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-0"/>
</outConfig>
</configResolveDn>
Retrieving Storage Controller Settings using DN
Request:
<configResolveDn cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4"inHierarchical="false" dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/controller-settings'/>
Response:
<configResolveDn cookie="1422614651/60391de0-dc0d-1ddc-8005-91fabb1b0ff4" response="yes" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/controller-settings"> <outConfig> <storageControllerSettings dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/controller-settings" pciSlot="SLOT-MEZZ" predictiveFailPollInterval="300 sec" rebuildRate="30 %" patrolReadRate="30 %" consistencyCheckRate="30 %" reconstructionRate="30 %" cacheFlushInterval="4 sec" spinupDriveCount="4" spinupDelay="6 sec" physDriveCoercionMode="1 GB" clusterEnable="false" batteryWarning="true" eccBucketLeakRate="1440 min" exposeEnclosureDevices="true" maintainPdFailHistory="false" enableCopybackOnSmart="true" enableCopybackToSsdOnSmartError="true" ncqStatus="enabled" enableJbod="false" spinDownUnconfigured="true" enableSsdPatrolRead="false" autoEnhancedImport="true"/> </outConfig> </configResolveDn>
Retrieving Storage Local Disk Properties
Request:
<configResolveClass cookie="1422618600/f24b2a39-dd0d-1ddd-8006-91fabb1b0ff4" classId="storageLocalDisk" inHierarchical="true"/>
Response:
<configResolveClass cookie="1422618600/f24b2a39-dd0d-1ddd-8006-91fabb1b0ff4"
response="yes" classId="storageLocalDisk">
<outConfigs>
<storageLocalDisk id="1" pdStatus="Online" health="Good" predictiveFailureCount="0"
linkSpeed="6.0 Gb/s" interfaceType="SAS" mediaType="HDD" coercedSize="3814697
MB" vendor="WD" productId="WD4001FYYG-01SL3" driveFirmware="VR07"
driveSerialNumber="WMC1F1927484" driveState="online" online="true"
dedicatedHotSpareForVDId="" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-1">
<storageLocalDiskProps rn="general-props" physicalDrive="1"
pdStatus="Online" health="Good" enclosureDeviceId="103"
deviceId="43" sequenceNumber="2"
mediaErrorCount="0" otherErrorCount="0" predictiveFailureCount="0"
linkSpeed="6.0 Gb/s" interfaceType="SAS" mediaType="HDD"
blockSize="512" blockCount="7814037168"
bootDrive="false" rawSize="3815447 MB"
nonCoercedSize="3814935 MB"
coercedSize="3814697 MB" powerState="active" sasAddress0="50000c0f01e85d26"
sasAddress1="50000c0f01e85d27"/>
<storageOperation rn="storage-operation" lropInProgress="false"
currentLrop="No operation in progress" progressPercent="0" elapsedSeconds="0"/>
</storageLocalDisk>
...
<storageLocalDisk id="60" pdStatus="Unconfigured Good"
health="Good" predictiveFailureCount="0" linkSpeed="6.0 Gb/s"
interfaceType="SAS" mediaType="HDD" coercedSize="3814697 MB" vendor="WD"
productId="WD4001FYYG-01SL3" driveFirmware="VR07"
driveSerialNumber="WMC1F1926558" driveState="unconfigured good" online="true"
dedicatedHotSpareForVDId="" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-60">
<storageLocalDiskProps rn="general-props" physicalDrive="60" pdStatus="Unconfigured Good"
health="Good" enclosureDeviceId="103" deviceId="102" sequenceNumber="1"
mediaErrorCount="0" otherErrorCount="0" predictiveFailureCount="0"
linkSpeed="6.0 Gb/s" interfaceType="SAS" mediaType="HDD" blockSize="512"
blockCount="7814037168" bootDrive="false" rawSize="3815447 MB"
nonCoercedSize="3814935 MB" coercedSize="3814697 MB" powerState="active"
sasAddress0="50000c0f012eb1f6" sasAddress1="50000c0f012eb1f7"/>
<storageOperation rn="storage-operation" lropInProgress="false"
currentLrop="No operation in progress" progressPercent="0" elapsedSeconds="0"/>
</storageLocalDisk>
</outConfigs>
</configResolveClass>
Retrieving Storage Local Disk Properties using DN
Request:
<configResolveDn cookie="1422619590/3ebc17b5-dd0d-1ddd-8007-91fabb1b0ff4" inHierarchical="true" dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-25'/>
Response:
<configResolveDn cookie="1422619590/3ebc17b5-dd0d-1ddd-8007-91fabb1b0ff4" response="yes"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-25">
<outConfig>
<storageLocalDisk id="25" pdStatus="Unconfigured Good" health="Good"
predictiveFailureCount="0" linkSpeed="6.0 Gb/s" interfaceType="SAS" mediaType="HDD"
coercedSize="3814697 MB" vendor="TOSHIBA" productId="MG03SCA400"
driveFirmware="5702" driveSerialNumber="14O0A0C8FVU4" driveState="unconfigured good" online="true"
dedicatedHotSpareForVDId="" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-25">
<storageLocalDiskProps rn="general-props" physicalDrive="25"
pdStatus="Unconfigured Good" health="Good" enclosureDeviceId="103" deviceId="67" sequenceNumber="1"
mediaErrorCount="0" otherErrorCount="0" predictiveFailureCount="0"
linkSpeed="6.0 Gb/s" interfaceType="SAS" mediaType="HDD" blockSize="512" blockCount="7814037168"
bootDrive="false" rawSize="3815447 MB" nonCoercedSize="3814935 MB"
coercedSize="3814697 MB" powerState="active" sasAddress0="5000039548e07caa"
sasAddress1="5000039548e07cab"/>
<storageOperation rn="storage-operation" lropInProgress="false"
currentLrop="No operation in progress" progressPercent="0" elapsedSeconds="0"/>
</storageLocalDisk>
</outConfig>
</configResolveDn>
Retrieving Unused Local Disk Details
Request:
<configResolveClass cookie="1422693427/17670951-ef0d-1def-8002-91fabb1b0ff4" classId="storageUnusedLocalDisk" inHierarchical="false"> </configResolveClass>
Response:
<configResolveClass cookie="1422693427/17670951-ef0d-1def-8002-91fabb1b0ff4" response="yes"
classId="storageUnusedLocalDisk">
<outConfigs>
<storageUnusedLocalDisk id="5" pdStatus="Unconfigured Good" coercedSize="381
4697 MB" health="Good" mediaType="HDD" vendor="WD"
dn="sys/chassis-1/server-1/bord/storage-SAS-SLOT-MEZZ/virtual-drive-create/pd-5"/>
<storageUnusedLocalDisk
id="6" pdStatus="Unconfigured Good" coercedSize="3814697 MB"
health="Good" mediaType="HDD" vendor="WD"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/virtual-drive-create/pd-6"/>
…
<storageUnusedLocalDisk id="59" pdStatus="Unconfigured Good" coercedSize="3814697 MB"
health="Good" mediaType="HDD" vendor="WD"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/virtual-drive-create/pd-59"/>
<storageUnusedLocalDisk id="60" pdStatus="Unconfigured Good"
coercedSize="3814697 MB" health="Good" mediaType="HDD" vendor="WD"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/virtual-drive-create/pd-60"/>
</outConfigs>
</configResolveClass>
Retrieving Storage Virtual Drive with Drive Group Space
Request:
<configResolveClass cookie="1422693427/17670951-ef0d-1def-8002-91fabb1b0ff4" inHierarchical="false"classId="storageVirtualDriveWithDriveGroupSpace"> </configResolveClass>
Response:
<configResolveClass cookie="1422693427/17670951-ef0d-1def-8002-91fabb1b0ff4"
response="yes" classId="storageVirtualDriveWithDriveGroupSpace">
<outConfigs>
<storageVirtualDriveWithDriveGroupSpace id="0" name="junk_vd" raidLevel="5"
usedPhysicalDriveIds="1,2,3,4" maxAvailableSpace="11044089 MB"
vdStatus="Optimal" health="Good"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/virtual-drive-carve/vd-0"/>
</outConfigs>
</configResolveClass>
Retrieving Storage Firmware Boot Loader Version
Request:
<configResolveDn cookie="1422620517/18f4158f-de0d-1dde-8008-91fabb1b0ff4" inHierarchical="false" dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-boot-loader'/>
Response:
<configResolveDn cookie="1422620517/18f4158f-de0d-1dde-8008-91fabb1b0ff4"
response="yes" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-boot-loader">
<outConfig>
<firmwareRunning dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-boot-loader"
description="LSI Storage controller currently running boot loader firmware version"
deployment="boot-loader" type="storage-controller" version="6.22.03.0_4.16.08.00_0x060B0200"/>
</outConfig>
</configResolveDn>
Retrieving Storage Firmware Running Version
Request:
<configResolveDn cookie="1422621263/953322c7-de0d-1dde-8009-91fabb1b0ff4" inHierarchical="false"dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-system' />
Response:
<configResolveDn cookie="1422621263/953322c7-de0d-1dde-8009-91fabb1b0ff4" response="yes"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-system">
<outConfig>
<firmwareRunning dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-system"
description="LSI Storage controller currently running firmware version" deployment="system"
type="storage-controller" version="4.270.00-3995"/>
</outConfig>
</configResolveDn>
Retrieving Storage Firmware Boot Definition
Request:
<configResolveDn cookie="1422621263/953322c7-de0d-1dde-8009-91fabb1b0ff4" inHierarchical="true"dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-boot-def'/>
Response:
<configResolveDn cookie="1422621263/953322c7-de0d-1dde-8009-91fabb1b0ff4" response="yes"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-boot-def">
<outConfig>
<firmwareBootDefinition dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/fw-boot-def"
type="storage-controller"> <firmwareBootUnit rn="bootunit-combined"
description="LSI Storage controller startup BIOS firmware version"
adminState="triggered" image="running" resetOnActivate="no"
type="combined" version="6.22.03.0_4.16.08.00_0x060B0200"/>
</firmwareBootDefinition>
</outConfig>
</configResolveDn>
Creating a Virtual Drive from Unused Physical Drive
Request:
<configConfMo cookie="cookiecutter" inHierarchical="false" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/virtual-drive-create">
Response:
<configConfMo cookie="1422704637/95968593-f10d-1df1-8002-91fabb1b0ff4" response="yes">
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/virtual-drive-create"
<outConfig>
<storageVirtualDriveCreatorUsingUnusedPhysicalDrive
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/virtual-drive-create"
description="Create a new virtual drive from unused physical drive(s) available in the rack server.
Children objects of this object, lists all currently available unused physical drives."
minRequiredPhysicalDrives="RAID 0 at least 1 physical drive, RAID 1 at least 2
physical drives, RAID 5 at least 3 physical drives, RAID 6 at least 3 physical drives,
RAID 10 at least 4 physical drives, RAID 50 or RAID 60 at least 6 physical drives"
virtualDriveName="" raidLevel="" size=""
driveGroup="[span1_pd_id1,span1_pd_id2,span1_pd_id3...,span1_pd_idN]
[span2_pd_id1,span2_pd_id2,span2_pd_id3...,span2_pd_idN]..."
writePolicy="" createdVirtualDriveDn="" operStatus=""
adminState="triggered" status="modified"/>
</outConfig>
</configConfMo>
Deleting a Virtual Drive
Request:
<configConfMo cookie="1422880823/ae111d8a-1a0e-1e1a-8002-91fabb1b0ff4" inHierarchical="false" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-0">
Response:
<configConfMo cookie="1422880823/ae111d8a-1a0e-1e1a-8002-91fabb1b0ff4" response="yes"> dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-0" <outConfig> </outConfig> </configConfMo>
Modifying a Virtual Drive
Request:
<configConfMo cookie="1424262372/b1fdd9a1-5c0f-1f5c-8002-91fabb1b0ff4" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3"> <inConfig> <storageVirtualDrive dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3" id="3" adminAction="set-boot-drive"/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3" cookie="1424262372/b1fdd9a1-5c0f-1f5c-8002-91fabb1b0ff4" response="yes"> <outConfig> <storageVirtualDrive id="3" name="jchambers_vd" raidLevel="RAID 5" size="6000 MB" vdStatus="Optimal" health="Good" bootDrive="true" stripSize="64 KB" drivesPerSpan="4" spanDepth="1" accessPolicy="Read-Write" cachePolicy="Direct" readAheadPolicy="None" requestedWriteCachePolicy="Always Write Back" currentWriteCachePolicy="Write Back" diskCachePolicy="Unchanged" allowBackgroundInit="true" autoSnapshot="false" autoDeleteOldest="true" driveState="Optimal" adminAction="no-op" targetId="3" physicalDrivesList="Physical drives to be used for virtual drive reconstruction. pd_id1,pd_id2,...pd_idN" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3" status="modified" ></storageVirtualDrive> </outConfig> </configConfMo>
Setting up a Virtual Drive as Transport Ready with Exclude-All Options
Request:
<configConfMo dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0' inHierarchical='true' cookie='1390285111/1af97ad2-f075-1075-8003-bcbec261b284'> <inConfig> <storageVirtualDrive dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0' id='0' adminAction='set-transport-ready' hotspareAction='exclude-all'/> </inConfig> </configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0"
cookie="1390285111/1af97ad2-f075-1075-8003-bcbec261b284" response="yes">
<outConfig>
<storageVirtualDrive id="0" name="RAID1_12" raidLevel="RAID 1"
size="952720 MB" vdStatus="Optimal" health="Good" bootDrive="false" stripSize="64k"
drivesPerSpan="2" spanDepth="1" accessPolicy="Transport Ready" cachePolicy="direct-io"
readPolicy="no-read-ahead" requestedWriteCachePolicy="write-through"
currentWriteCachePolicy="write-through" diskCachePolicy="unchanged" allowBackgroundInit="true"
autoSnapshot="false" autoDeleteOldest="true" driveState="Optimal" fdeCapable="no" fdeEnabled="no"
adminAction="no-op" hotspareAction="no-op" targetId="0"
physicalDrivesList="Physical drives to be used for virtual drive reconstruction. pd_id1,pd_id2,...pd_idN"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0" status="modified">
<storageLocalDiskUsage startingBlock="0" numberOfBlocks="1951170560" virtualDrive="0"
physicalDrive="1" state="online" span="0" rn="pd-1" status="modified"/>
<storageLocalDiskUsage startingBlock="0" numberOfBlocks="1951170560" virtualDrive="0"
physicalDrive="2" state="online" span="0" rn="pd-2" status="modified"/>
<storageOperation rn="storage-operation" lropInProgress="false"
currentLrop="No operation in progress" progressPercent="0" elapsedSeconds="0" status="modified"/>
</storageVirtualDrive>
</outConfig>
</configConfMo>
![]() Note | You can also set a Virtual Drive as Transport Ready using the include-all and include-dhsp hotspareAction values. |
Clearing a Virtual Drive as Transport Ready
Request:
<configConfMo dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0'
inHierarchical='true' cookie='1390285111/1af97ad2-f075-1075-8003-bcbec261b284'>
<inConfig>
<storageVirtualDrive dn='sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0' id='0'
adminAction='clear-transport-ready'/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0"
cookie="1390285111/1af97ad2-f075-1075-8003-bcbec261b284" response="yes">
<outConfig>
<storageVirtualDrive id="0" name="RAID1_12" raidLevel="RAID 1" size="952720 MB" vdStatus="Optimal"
health="Good" bootDrive="false" stripSize="64k" drivesPerSpan="2"
spanDepth="1" accessPolicy="read-write" cachePolicy="direct-io" readPolicy="no-read-ahead"
requestedWriteCachePolicy="write-through" currentWriteCachePolicy="write-through"
diskCachePolicy="unchanged" allowBackgroundInit="true" autoSnapshot="false"
autoDeleteOldest="true" driveState="Optimal" fdeCapable="no" fdeEnabled="no"
adminAction="no-op" hotspareAction="no-op" targetId="0"
physicalDrivesList="Physical drives to be used for virtual drive reconstruction.
pd_id1,pd_id2,...pd_idN" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-HBA/vd-0"
status="modified">
<storageLocalDiskUsage startingBlock="0" numberOfBlocks="1951170560" virtualDrive="0"
physicalDrive="1" state="online" span="0" rn="pd-1" status="modified"/>
<storageLocalDiskUsage startingBlock="0" numberOfBlocks="1951170560" virtualDrive="0"
physicalDrive="2" state="online" span="0" rn="pd-2" status="modified"/>
<storageOperation rn="storage-operation" lropInProgress="false"
currentLrop="No operation in progress" progressPercent="0" elapsedSeconds="0" status="modified"/>
</storageVirtualDrive>
</outConfig>
</configConfMo>
Retrieving NVMe Storage Controller Details
Request:
<configResolveClass cookie='1472022403/94a78a4a-3acc-1acc-8003-95542a2fa074' inHierarchical='true' classId='storageControllerNVMe'/>"
Response:
<configResolveClass cookie="1472022403/94a78a4a-3acc-1acc-8003-95542a2fa074" response="yes" classId="storageControllerNVMe"> <outConfigs> <storageControllerNVMe id="SLOT-5" model="Cisco UCS (SN150) HHHL 3800 GB NVMe based PCIe SSD" vendor="HGST" serial="STM0001A7BD9" health="Good" controllerStatus="Optimal" controllerChipTempCelsius="39" driveLifeUsed="0" performanceLevel="100" ledFaultStatus="Healthy" percentageTotalPowerOnHour="6" dn="sys/chassis-1/server-1/board/storage-NVMe-SLOT-5" > <firmwareRunning rn="fw-boot-loader" description="NVMe Storage controller currently running boot loader firmware version" deployment="boot-loader" type="storage-controller-NVMe" version="N/A" > </firmwareRunning> <firmwareRunning rn="fw-system" description="NVMe Storage controller currently running firmware version" deployment="system" type="storage-controller-NVMe" version="KMCCP105" > </firmwareRunning> </storageControllerNVMe> <storageControllerNVMe id="SLOT-4" model="Cisco UCS (P3700) HHHL 800 GB NVMe based PCIe SSD" vendor="Intel" serial="CVFT6024002U800CGN" health="Good" controllerStatus="Optimal" controllerChipTempCelsius="24" driveLifeUsed="0" performanceLevel="100" ledFaultStatus="Healthy" percentageTotalPowerOnHour="5" dn="sys/chassis-1/server-1/board/storage-NVMe-SLOT-4" > <firmwareRunning rn="fw-boot-loader" description="NVMe Storage controller currently running boot loader firmware version" deployment="boot-loader" type="storage-controller-NVMe" version="N/A" > </firmwareRunning> <firmwareRunning rn="fw-system" description="NVMe Storage controller currently running firmware version" deployment="system" type="storage-controller-NVMe" version="8DV1CP01" > </firmwareRunning> </storageControllerNVMe> <storageControllerNVMe id="SLOT-2" model="Cisco UCS (P3700) HHHL 1600 GB NVMe based PCIe SSD" vendor="Intel" serial="CVFT5433007S1P6DGN" health="Good" controllerStatus="Optimal" controllerChipTempCelsius="27" driveLifeUsed="0" performanceLevel="100" ledFaultStatus="Healthy" percentageTotalPowerOnHour="3" dn="sys/chassis-1/server-1/board/storage-NVMe-SLOT-2" > <firmwareRunning rn="fw-boot-loader" description="NVMe Storage controller currently running boot loader firmware version" deployment="boot-loader" type="storage-controller-NVMe" version="N/A" > </firmwareRunning> <firmwareRunning rn="fw-system" description="NVMe Storage controller currently running firmware version" deployment="system" type="storage-controller-NVMe" version="8DV1CP01" > </firmwareRunning> </storageControllerNVMe> </outConfigs> </configResolveClass>
Retrieving Firmware Version of a NVMe Controller
Request:
<configResolveDn cookie='1405200895/c56a2fcc-fe06-1e06-8062-f4f25b78ac58' inHierarchical='false' dn='sys/chassis-1/server-1/board/storage-NVMe-FrontPCIe1/fw-system'/>
Response:
<configResolveDn cookie="1405200895/c56a2fcc-fe06-1e06-8062-f4f25b78ac58" response="yes" dn="sys/chassis-1/server-1/board/storage-NVMe-FrontPCIe1/fw-system"> <outConfig> <firmwareRunning dn="sys/chassis-1/server-1/board/storage-NVMe-FrontPCIe1/fw-system" description="NVMe Storage controller currently running firmware version" deployment="system" type="storage-controller-NVMe" version="KMCCP105" > </firmwareRunning> </outConfig> </configResolveDn>
Managing Storage Controllers
The examples in this section show how to use the Cisco IMC XML API to manage storage adapters. Each example shows the XML API request followed by the response from Cisco IMC.
This section includes the following examples:
Modifying Virtual Drive Write Policy
Request:
<configConfMo cookie='1424263006/67c0160e-5d0f-1f5d-8003-91fabb1b0ff4' dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3"> <inConfig> <storageVirtualDrive dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3" id="3" requestedWriteCachePolicy="Write Through"/> </inConfig> </configConfMo>
Response:
<configConfMo cookie="1424263006/67c0160e-5d0f-1f5d-8003-91fabb1b0ff4" response="yes"> dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3" <outConfig> <storageVirtualDrive id="3" name="jchambers_vd" raidLevel="RAID 5" size="6000 MB" vdStatus="Optimal" health="Good" bootDrive="true" stripSize="64 KB" drivesPerSpan="4" spanDepth="1" accessPolicy="Read-Write" cachePolicy="Direct" readAheadPolicy="None" requestedWriteCachePolicy=" Write Through" currentWriteCachePolicy="Write Through" diskCachePolicy="Unchanged" allowBackgroundInit="true" autoSnapshot="false" autoDeleteOldest="true" driveState="Optimal" adminAction="no-op" targetId="3" physicalDrivesList="Physical drives to be used for virtual drive reconstruction. pd_id1,pd_id2,...pd_idN" dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/vd-3" status="modified"> </storageVirtualDrive> </outConfig> </configConfMo>
Making a Global Hot Spare
Request:
<configConfMo cookie=''1424263731/c78680e7-5c0f-1f5c-8004-91fabb1b0ff4"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6">
<inConfig>
<storageLocalDisk dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
id="6" adminAction="make-global-hot-spare"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
cookie="1424263731/c78680e7-5c0f-1f5c-8004-91fabb1b0ff4" response="yes">
<outConfig>
<storageLocalDisk id="6" pdStatus="Global Hot Spare" health="Good"
predictiveFailureCount="0" linkSpeed="6.0 Gb/s" interfaceType="SAS"
mediaType="HDD" coercedSize="3814697 MB" vendor="WD" productId="WD4001FYYG-01SL3"
driveFirmware="VR07" driveSerialNumber="WMC1F1928912" driveState="hot spare"
online="false" dedicatedHotSpareForVDId="" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
status="modified">
</storageLocalDisk>
</outConfig>
</configConfMo>
Removing Physical Disk from Hot Spare
Request:
<configConfMocookie='1424264173/880690ac-5c0f-1f5c-8005-91fabb1b0ff4'
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6">
<inConfig>
<storageLocalDisk
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6" id="6"
adminAction="remove-hot-spare"/>
</inConfig>
</configConfMo>
Response:
<configConfMo cookie="1424264173/880690ac-5c0f-1f5c-8005-91fabb1b0ff4" response="yes">
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
<outConfig>
<storageLocalDisk id="6" pdStatus="Unconfigured Good" health="Good"
predictiveFailureCount="0" linkSpeed="6.0 Gb/s" interfaceType="SAS"
mediaType="HDD" coercedSize="3814697 MB" vendor="WD" productId="WD4001FYYG-01SL3"
driveFirmware="VR07" driveSerialNumber="WMC1F1928912" driveState="unconfigured good"
online="true" dedicatedHotSpareForVDId="" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
status="modified">
</storageLocalDisk>
</outConfig>
</configConfMo>
Making a Dedicated Hot Spare
Request:
<configConfMo cookie='1424264173/880690ac-5c0f-1f5c-8005-91fabb1b0ff4' dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"> <inConfig>
Response:
<configConfMo cookie="1424264173/880690ac-5c0f-1f5c-8005-91fabb1b0ff4" response="yes">
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
<outConfig>
<storageLocalDisk id="6" pdStatus="Dedicated Hot Spare" health="Good"
predictiveFailureCount="0" linkSpeed="6.0 Gb/s" interfaceType="SAS"
mediaType="HDD" coercedSize="3814697 MB" vendor="WD" productId="WD4001FYYG-01SL3"
driveFirmware="VR07" driveSerialNumber="WMC1F1928912" driveState="hot spare"
online="false" dedicatedHotSpareForVDId="" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
status="modified" >
</storageLocalDisk>
</outConfig>
</configConfMo>
Removing a Drive from Hot Spare Pools
Request:
<configConfMo cookie='1424264173/880690ac-5c0f-1f5c-8005-91fabb1b0ff4'
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6">
<inConfig>
<storageLocalDisk dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
adminAction="prepare-for-removal"/>
</inConfig>
</configConfMo>
Response:
<configConfMo cookie="1424264173/880690ac-5c0f-1f5c-8005-91fabb1b0ff4" response="yes">
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
<outConfig>
<storageLocalDisk id="6" pdStatus="Ready to Remove" health="Moderate Fault"
predictiveFailureCount="0"predictiveFailureCount="0" linkSpeed="6.0 Gb/s"
interfaceType="SAS" mediaType="HDD"
coercedSize="3814697 MB" vendor="WD" productId="WD4001FYYG-01SL3" driveFirmware="VR07"
driveSerialNumber="WMC1F1928912" driveState="unconfigured good" online="true"
dedicatedHotSpareForVDId="" adminAction="no-op"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ/pd-6"
status="modified">
</storageLocalDisk>
</outConfig>
</configConfMo>
Enabling JBOD
Request:
<configConfMo cookie='cookiecutter'
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ">
<inConfig>
<storageController dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ"
adminAction="enable-jbod"/>
</inConfig>
</configConfMo>
Response:
<configConfMo cookie="1424337949/70faa56b-6e0f-1f6e-8004-91fabb1b0ff4"
response="yes" errorCode="2003"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ"
invocationResult="unidentified-fail" errorDescr="Operation failed.
Changing JBOD mode is not allowed on controller">
</configConfMo>
Disabling JBOD
Request:
<configConfMo cookie='1424337112/0c6e0e69-6d0f-1f6d-8003-91fabb1b0ff4'
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ">
<inConfig>
<storageController
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ" adminAction="disable-jbod"/>
</inConfig>
</configConfMo
Response:
<configConfMo cookie="1424337112/0c6e0e69-6d0f-1f6d-8003-91fabb1b0ff4"
response="yes" errorCode="2003"
dn="sys/chassis-1/server-1/board/storage-SAS-SLOT-MEZZ"
invocationResult="unidentified-fail" errorDescr="Operation failed.
Changing JBOD mode is not allowed on controller">
</configConfMo>

Feedback