The examples in
this section show how to use the Cisco IMC XML API to retrieve and upload PID
catalog. Each example shows the XML API request followed by the response from
Cisco IMC.
This section
includes the following examples:
Uploading PID
Catalog
Request:
<configConfMo cookie="1470041969/37207236-ff38-18ff-8003-4d32145daae4"
dn="sys/chassis-1/pid/upload-catalog" inHierarchical="false">
<inConfig>
<uploadPIDCatalog protocol="tftp" remoteServer="10.104.236.99"
remoteFile="latestpid.tar.gz" dn="sys/chassis-1/pid/upload-catalog"/>
</inConfig>
</configConfMo>
TFTP used in the
preceding example is the default protocol. You can also download the LDAP CA
certificate using the other available protocols such as the FTP, SFTP, SCP and
HTTP.
Response:
<configConfMo dn="sys/chassis-1/pid/upload-catalog"
cookie="1470041969/37207236-ff38-18ff-8003-4d32145daae4" response="yes">
<outConfig>
<uploadPIDCatalog dn="sys/chassis-1/pid/upload-catalog" protocol="none" remoteServer=""
remoteFile="" user="" pwd="" pidUploadStatus="Upload in Progress" status="modified" >
</uploadPIDCatalog>
</outConfig>
</configConfMo>
Activating PID
Catalog on Server Node 1
Request:
<configConfMo cookie="1462971767/5e320cff-9032-1290-8009-b1f9cc1a3500"
dn="sys/chassis-1/server-1/board/pid/activate-catalog" inHierarchical="false">
<inConfig>
<activatePIDCatalog adminState="trigger"
dn="sys/chassis-1/server-1/board/pid/activate-catalog"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/board/pid/activate-catalog"
cookie="1470739643/d6acc6cc-a139-19a1-8002-5a45145daae4" response="yes">
<outConfig>
<activatePIDCatalog dn="sys/chassis-1/server-1/board/pid/activate-catalog"
adminState="triggered" pidActivationStatus="Activation Successful" status="modified">
</activatePIDCatalog>
</outConfig>
</configConfMo>
Activating PID
Catalog on Server Node 2
Request:
<configConfMo cookie="1462971767/5e320cff-9032-1290-8009-b1f9cc1a3500"
dn="sys/chassis-1/server-2/board/pid/activate-catalog" inHierarchical="false">
<inConfig>
<activatePIDCatalog adminState="trigger"
dn="sys/chassis-1/server-2/board/pid/activate-catalog"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-2/board/pid/activate-catalog"
cookie="1470739643/d6acc6cc-a139-19a1-8002-5a45145daae4" response="yes">
<outConfig>
<activatePIDCatalog dn="sys/chassis-1/server-2/board/pid/activate-catalog"
adminState="triggered" pidActivationStatus="Activation Successful" status="modified">
</activatePIDCatalog>
</outConfig>
</configConfMo>
Viewing PID
Catalog
Request:
<configResolveClass cookie="1473455878/95c48a0a-1a3c-1c1a-8003-be18652a6ca4"
inHierarchical="false" classId="pidCatalog”/>
Response:
<configResolveClass cookie="1473455878/95c48a0a-1a3c-1c1a-8003-be18652a6ca4"
response="yes" classId="pidCatalog">
<outConfigs>
<pidCatalog dn="sys/chassis-1/server-1/board/pid" name="Cisco
Product Identifiers (PID)" version="2.0(13a)09"/>
<pidCatalog dn="sys/chassis-1/server-2/board/pid" name="Cisco
Product Identifiers (PID)" version="2.0(13a)09"/>
</outConfigs>
</configResolveClass>
Retrieving PID
Catalog of CPUs
Request:
<configResolveClass cookie='1282522267/f91bd068-8e72-1e72-8002-7e573e8f835c'
inHierarchical='false' classId='pidCatalogCpu'/>
Response:
<configResolveClass cookie="1470739643/d6acc6cc-a139-19a1-8002-5a45145daae4"
response="yes" classId="pidCatalogCpu">
<outConfigs>
<pidCatalogCpu id="1" socketdesignation="CPU1" description="Intel(R)
Xeon(R) CPU E5-2620 v4 @ 2.10GHz/85W 8C/20MB Cache/DDR4 2133MHz"
pid="UCS-CPU-E52620E" model="Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz"
signature="Type 0, Family 6, Model 79, Stepping 1" currentspeed="2100"
operState="Enabled" dn="sys/chassis-1/server-1/board/pid/pid-cpu-1" >
</pidCatalogCpu>
<pidCatalogCpu id="2" socketdesignation="CPU2" description="Intel(R)
Xeon(R) CPU E5-2620 v4 @ 2.10GHz/85W 8C/20MB Cache/DDR4 2133MHz"
pid="UCS-CPU-E52620E" model="Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz"
signature="Type 0, Family 6, Model 79, Stepping 1" currentspeed="2100"
operState="Enabled" dn="sys/chassis-1/server-1/board/pid/pid-cpu-2" >
</pidCatalogCpu>
<pidCatalogCpu id="1" socketdesignation="CPU1" description="Intel(R)
Xeon(R) CPU E5-2695 v4 @ 2.10GHz/120W 18C/45MB Cache/DDR4 2400MHz"
pid="UCS-CPU-E52695E" model="Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz"
signature="Type 0, Family 6, Model 79, Stepping 1" currentspeed="2100"
operState="Enabled" dn="sys/chassis-1/server-2/board/pid/pid-cpu-1" >
</pidCatalogCpu>
<pidCatalogCpu id="2" socketdesignation="CPU2" description="Intel(R)
Xeon(R) CPU E5-2695 v4 @ 2.10GHz/120W 18C/45MB Cache/DDR4 2400MHz"
pid="UCS-CPU-E52695E" model="Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz"
signature="Type 0, Family 6, Model 79, Stepping 1" currentspeed="2100"
operState="Enabled" dn="sys/chassis-1/server-2/board/pid/pid-cpu-2" >
</pidCatalogCpu>
</outConfigs>
</configResolveClass>
Retrieving PID
Catalog of DIMMs
Request:
<configResolveClass cookie='1282522267/f91bd068-8e72-1e72-8002-7e573e8f835c'
inHierarchical='false' classId='pidCatalogDimm'/>
Response:
<configResolveClass cookie="1470739643/d6acc6cc-a139-19a1-8002-5a45145daae4"
response="yes" classId="pidCatalogDimm">
<outConfigs>
</pidCatalogDimm>
<pidCatalogDimm name="DIMM_G2" description="32GB DDR4-2400-MHz RDIMM/PC4-19200/dual rank/x4/1.2v"
pid="UCS-MR-1X322RV-A" mfgid="0xCE00" manufacturer="Samsung" serialnumber="02EB3481"
model="M393A4K40BB1-CRC" capacity="32768 MB" speed="2400" datawidth="64 bits"
operability="Operable" dn="sys/chassis-1/server-2/board/pid/pid-dimm-DIMM_G2" >
</pidCatalogDimm>
.
.
.
.
<pidCatalogDimm name="DIMM_G2" description="32GB DDR4-2400-MHz RDIMM/PC4-19200/dual rank/x4/1.2v"
pid="UCS-MR-1X322RV-A" mfgid="0xCE00" manufacturer="Samsung" serialnumber="02EB33FD"
model="M393A4K40BB1-CRC" capacity="32768 MB" speed="2400" datawidth="64 bits"
operability="Operable" dn="sys/chassis-1/server-2/board/pid/pid-dimm-DIMM_G1" >
</pidCatalogDimm>
<pidCatalogDimm name="DIMM_G2" description="32GB DDR4-2400-MHz RDIMM/PC4-19200/dual rank/x4/1.2v"
pid="UCS-MR-1X322RV-A" mfgid="0xCE00" manufacturer="Samsung" serialnumber="02EB3481"
model="M393A4K40BB1-CRC" capacity="32768 MB" speed="2400" datawidth="64 bits"
operability="Operable" dn="sys/chassis-1/server-2/board/pid/pid-dimm-DIMM_G2" >
</pidCatalogDimm>
</outConfigs>
</configResolveClass>
Retrieving PID
Catalog of HDDs
Request:
<configResolveClass cookie='1282522267/f91bd068-8e72-1e72-8002-7e573e8f835c'
inHierarchical='false' classId='pidCatalogHdd'/>
Response:
<configResolveClass cookie="1470739643/d6acc6cc-a139-19a1-8002-5a45145daae4"
response="yes" classId="pidCatalogHdd">
<outConfigs>
<pidCatalogHdd disk="8" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="WD" model="WD4001FYYG-01SL3"
serialnumber="WMC1F1927555" dn="sys/chassis-1/server-1/board/pid/pid-hdd-8" >
</pidCatalogHdd>
<pidCatalogHdd disk="9" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="WD" model="WD4001FYYG-01SL3"
serialnumber="WMC1F1930050" dn="sys/chassis-1/server-1/board/pid/pid-hdd-9" >
</pidCatalogHdd>
<pidCatalogHdd disk="6" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="WD" model="WD4001FYYG-01SL3"
serialnumber="WMC1F1927672" dn="sys/chassis-1/server-2/board/pid/pid-hdd-6" >
</pidCatalogHdd>
<pidCatalogHdd disk="7" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="WD" model="WD4001FYYG-01SL3" serialnumber="WMC1F1928331"
dn="sys/chassis-1/server-2/board/pid/pid-hdd-7" >
</pidCatalogHdd>
<pidCatalogHdd disk="10" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="WD" model="WD4001FYYG-01SL3" serialnumber="WMC1F1928305"
dn="sys/chassis-1/server-2/board/pid/pid-hdd-10" >
</pidCatalogHdd>
<pidCatalogHdd disk="11" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="TOSHIBA" model="MG03SCA400" serialnumber="14P0A0E8FVU4"
dn="sys/chassis-1/server-2/board/pid/pid-hdd-11" >
</pidCatalogHdd>
<pidCatalogHdd disk="12" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="TOSHIBA" model="MG03SCA400" serialnumber="14P0A069FVU4"
dn="sys/chassis-1/server-2/board/pid/pid-hdd-12" >
</pidCatalogHdd>
<pidCatalogHdd disk="13" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="TOSHIBA" model="MG03SCA400" serialnumber="14P0A07BFVU4"
dn="sys/chassis-1/server-2/board/pid/pid-hdd-13" >
</pidCatalogHdd>
<pidCatalogHdd disk="14" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="TOSHIBA" model="MG03SCA400" serialnumber="14O0A06EFVU4"
dn="sys/chassis-1/server-2/board/pid/pid-hdd-14" >
</pidCatalogHdd>
<pidCatalogHdd disk="28" controller="SBMezz1" description="4TB 6Gb SAS 7.2K RPM 3.5"
pid="UCSC-C3X60-HD4TB" vendor="TOSHIBA" model="MG03SCA400" serialnumber="14O0A08MFVU4"
dn="sys/chassis-1/server-2/board/pid/pid-hdd-28" >
</pidCatalogHdd>
</outConfigs>
</configResolveClass>
Retrieving PID
Catalog of PCI Adapters
Request:
<configResolveClass cookie='1282522267/f91bd068-8e72-1e72-8002-7e573e8f835c'
inHierarchical='false' classId='pidCatalogPCIAdapter'/>
Response:
<configResolveClass cookie="1470739643/d6acc6cc-a139-19a1-8002-5a45145daae4"
response="yes" classId="pidCatalogPCIAdapter">
<outConfigs>
<pidCatalogPCIAdapter slot="SBNVMe1" description="800GB 2.5in NVMe based
PCIe SSD drive" pid="UCSC-C3K-NV8" vendor="0x1c58" device="0x0003" subvendor="0x1137"
subdevice="0x019e" dn="sys/chassis-1/server-1/board/pid/pid-pciadapter-SBNVMe1" >
</pidCatalogPCIAdapter>
<pidCatalogPCIAdapter slot="SIOC1" description="Cisco UCS 40Gb Ethernet"
pid="UCSC-C3260-SIOC" vendor="0x1137" device="0x0042" subvendor="0x1137"
subdevice="0x0157" dn="sys/chassis-1/server-1/board/pid/pid-pciadapter-SIOC1" >
</pidCatalogPCIAdapter>
<pidCatalogPCIAdapter slot="SBMezz1" description="Cisco UCS C3000 RAID controller
for M4 Server Blade with 4G RAID Cache" pid="UCS-C3K-M4RAID" vendor="0x1000"
device="0x00ce" subvendor="0x1137" subdevice="0x0197"
dn="sys/chassis-1/server-1/board/pid/pid-pciadapter-SBMezz1" >
</pidCatalogPCIAdapter>
<pidCatalogPCIAdapter slot="SIOC2" description="Cisco UCS 40Gb Ethernet" pid="N/A"
vendor="0x1137" device="0x0042" subvendor="0x1137" subdevice="0x0157"
dn="sys/chassis-1/server-2/board/pid/pid-pciadapter-SIOC2" >
</pidCatalogPCIAdapter>
<pidCatalogPCIAdapter slot="SBMezz1" description="Cisco UCS C3000 RAID controller
for M4 Server Blade with 4G RAID Cache" pid="UCSC-C3K-M4RAID" vendor="0x1000"
device="0x00ce" subvendor="0x1137" subdevice="0x0197"
dn="sys/chassis-1/server-2/board/pid/pid-pciadapter-SBMezz1" >
</pidCatalogPCIAdapter>
</outConfigs>
</configResolveClass>