The examples in
this section show how to use the Cisco IMC XML API to retrieve and configure
communication services. Each example shows the XML API request followed by the
response from Cisco IMC.
This section
includes the following examples:
Retrieving
Server Communication Services Details
Request:
<configResolveClass cookie="1418471980/706e0794-180a-1a18-8007-91fabb1b0ff4"
classId="commSvcRack" inHierarchical="true"></configResolveClass>
Response:
<configResolveClass cookie="1418471980/706e0794-180a-1a18-8007-91fabb1b0ff4"
response="yes" classId="commSvcRack">
<outConfigs>
<commSvcRack dn="sys/chassis-1/server-1/svc-ext">
<commKvm rn="kvm-svc" adminState="enabled" totalSessions="4" activeSessions="1"
port="2068" encryptionState="enabled" localVideoState="enabled"/>
<commVMedia rn="vmedia-svc" adminState="enabled" activeSessions="0"
encryptionState="disabled"/>
<commIpmiLan rn="ipmi-lan-svc" adminState="enabled" priv="admin"
key="0000000000000000000000000000000000000000"/>
</commSvcRack>
</outConfigs>
</configResolveClass>
Retrieving
Server Communication Services Details Using DN
Request:
<configResolveDn dn='sys/chassis-1/server-1/svc-ext' inHierarchical='true'>
cookie='1418471980/706e0794-180a-1a18-8007-91fabb1b0ff4' </configResolveDn>
Response:
<configResolveDn cookie="1418471980/706e0794-180a-1a18-8007-91fabb1b0ff4"
response="yes" dn="sys/chassis-1/server-1/svc-ext">
<outConfig>
<commSvcRack dn="sys/chassis-1/server-1/svc-ext">
<commKvm rn="kvm-svc" adminState="enabled" totalSessions="4" activeSessions="1"
port="2068" encryptionState="enabled" localVideoState="enabled"/>
<commVMedia rn="vmedia-svc" adminState="enabled" activeSessions="0"
encryptionState="disabled"/>
<commIpmiLan rn="ipmi-lan-svc" adminState="enabled" priv="admin"
key="0000000000000000000000000000000000000000"/>
</commSvcRack>
</outConfig>
</configResolveDn>
Retrieving IPMI
over LAN Details for CMCs
Request:
<configResolveClass cookie="0948771774/afdfe352-e75e-1ee7-8002-e87877e2cff4"
classId="commEpIpmiLan" inHierarchical="true"></configResolveClass>
Response:
<configResolveClass cookie="0948771774/afdfe352-e75e-1ee7-8002-e87877e2cff4"
response="yes" classId="commEpIpmiLan">
<outConfigs>
<commEpIpmiLan dn="sys/chassis-1/slot-1/cmc-ipmi-lan" adminState="enabled"
priv="admin" key="1111100000000000000000000000000000000000"/>
<commEpIpmiLan dn="sys/chassis-1/slot-2/cmc-ipmi-lan" adminState="enabled"
priv="admin" key="0000000000000000000000000000000000000000"/>
</outConfigs>
</configResolveClass>
Retrieving IPMI
over LAN Details for CMC Using DN
Request:
<configResolveDn cookie="0948771774/afdfe352-e75e-1ee7-8002-e87877e2cff4"
response="yes" dn="sys/chassis-1/slot-2/cmc-ipmi-lan">
Response:
<outConfig>
<commEpIpmiLan dn="sys/chassis-1/slot-2/cmc-ipmi-lan" adminState="enabled"
priv="admin" key="0000000000000000000000000000000000000000"/>
</outConfig>
</configResolveDn>
Configuring IPMI
over LAN for CMCs
Request:
<configConfMo cookie='0948774645/804a211e-e85e-1ee8-8002-e87877e2cff4'
dn='sys/chassis-1/slot-2/cmc-ipmi-lan'>
<inConfig>
<commEpIpmiLan adminState='enabled'
key="1111100000000000000000000000000000022222"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/slot-2/cmc-ipmi-lan"
cookie="0948774645/804a211e-e85e-1ee8-8002-e87877e2cff4" response="yes">
<outConfig>
<commEpIpmiLan dn="sys/chassis-1/slot-2/cmc-ipmi-lan" adminState="enabled"
priv="admin" key="1111100000000000000000000000000000022222"
status="modified"/>
</outConfig>
</configConfMo>
Retrieving IPMI
over LAN Details for BMCs
Request:
<configResolveClass cookie="0948774645/804a211e-e85e-1ee8-8002-e87877e2cff4"
classId="commIpmiLan" inHierarchical="true"></configResolveClass>
Response:
<configResolveClass cookie="0948774645/804a211e-e85e-1ee8-8002-e87877e2cff4"
response="yes" classId="commIpmiLan">
<outConfigs>
<commIpmiLan dn="sys/chassis-1/server-1/svc-ext/ipmi-lan-svc"
adminState="disabled"
priv="admin" key="0000000000000000000000000000000000000000"/>
</outConfigs>
Retrieving
IPMI over LAN Details Using DN for BMC
Request:
<configResolveDn cookie="0948775445/40885b7d-e85e-1ee8-8004-e87877e2cff4"
dn='sys/chassis-1/server-1/svc-ext/ipmi-lan-svc' inHierarchical="true"/>
Response:
<configResolveDn cookie="0948775445/40885b7d-e85e-1ee8-8004-e87877e2cff4"
response="yes" dn="sys/chassis-1/server-1/svc-ext/ipmi-lan-svc">
<outConfig>
<commIpmiLan dn="sys/chassis-1/server-1/svc-ext/ipmi-lan-svc"
adminState="disabled" priv="admin" key="0000000000000000000000000000000000000000"/>
</outConfig>
</configResolveDn>
Configuring
IPMI over LAN Details for BMC
Request:
<configConfMo cookie='0948775445/40885b7d-e85e-1ee8-8004-e87877e2cff4'
dn='sys/chassis-1/server-1/svc-ext/ipmi-lan-svc'>
<inConfig>
<commIpmiLan adminState='enabled' key="3333300000000000000000000000000000044444"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/chassis-1/server-1/svc-ext/ipmi-lan-svc"
cookie="0948775445/40885b7d-e85e-1ee8-8004-e87877e2cff4" response="yes">
<outConfig>
<commIpmiLan dn="sys/chassis-1/server-1/svc-ext/ipmi-lan-svc"
adminState="enabled" priv="admin"
key="3333300000000000000000000000000000044444" status="modified"/>
</outConfig>
Retrieving
Chassis Communication Services Details
Request:
<configResolveClass cookie="1256517526/630efb57-cc76-16cc-8009-aaec921b0ff4"
response="yes" classId="commSvcEp">
Response:
<outConfigs>
<commSvcEp dn="sys/svc-ext">
<commHttp rn="http-svc" adminState="enabled" descr="HTTP Service" name="http"
port="80" redirectState="enabled" sessionTimeout="1800" maximumSessions="4"
activeSessions="0" proto="tcp"/>
<commHttps rn="https-svc" adminState="enabled" descr="Secure HTTP Service"
name="https" port="443" sessionTimeout="1800" maximumSessions="4" activeSession
="0" proto="tcp"/>
<commSsh rn="ssh-svc" adminState="enabled" descr="Secure Shell Server" name="ssh"
port="22" sessionTimeout="1800" maximumSessions="4" activeSessions="1"
proto="tcp"/>
<commSnmp rn="snmp-svc" descr="SNMP Service" name="snmp" adminState="enabled"
port="161" proto="udp" community="public" trapCommunity="" com2Sec="full"
sysContact="who@where" sysLocation="unknown">
<commSnmpTrap id="1" adminState="disabled" version="v3" notificationType="traps"
port="162" hostname="0.0.0.0" user="unknown" rn="snmp-trap-1"/>
<commSnmpTrap id="2" adminState="disabled" version="v3" notificationType="traps"
port="162" hostname="0.0.0.0" user="unknown" rn="snmp-trap-2"/>
.
.
<commSnmpUser id="1" name="" securityLevel="" auth="" authPwd="" privacy=""
privacyPwd="" rn="snmpv3-user-1"/>
<commSnmpUser id="2" name="" securityLevel="" auth="" authPwd="" privacy=""
privacyPwd="" rn="snmpv3-user-2"/>
.
.
<commSyslog rn="syslog" adminState="enabled" descr="Syslog Service" name="syslog"
port="514" proto="tcp" localSeverity="debug" remoteSeverity="warning">
commSyslogClient adminState="disabled" hostname="0.0.0.0" name="primary" port="514"
rn="client-primary"/>
<commSyslogClient adminState="disabled" hostname="0.0.0.0" name="secondary" port="514"
rn="client-secondary"/>
</commSyslog>
<commNtpProvider rn="ntp-svc" description="Network Time Protocol" ntpEnable="no"
ntpServer1=" " ntpServer2=" " ntpServer3=" " ntpServer4=" "/>
</commSvcEp>
</outConfigs>
</configResolveClass>
Retrieving NTP
Using DN
Request:
<configResolveDn cookie="1256518508/a00063d2-cc76-16cc-800a-aaec921b0ff4"
dn='sys/svc-ext/ssh-svc' inHierarchical="false"/>
Response:
<configResolveDn cookie="1256518508/a00063d2-cc76-16cc-800a-aaec921b0ff4"
response="yes" dn="sys/svc-ext/ssh-svc">
<outConfig>
<commSsh dn="sys/svc-ext/ssh-svc" adminState="enabled" descr="Secure Shell Server"
name="ssh" port="22" sessionTimeout="1800" maximumSessions="4"
activeSessions="1" proto="tcp"/>
</outConfig>
</configResolveDn>
Configuring
NTP Servers
Request:
<configConfMo cookie="1256520649/5b73df6a-cd76-16cd-800b-aaec921b0ff4"
dn="sys/svc-ext/ntp-svc">
<inConfig>
<commNtpProvider dn="sys/svc-ext/ntp-svc" ntpEnable="no" ntpServer1="10.104.255.217"
ntpServer2="ntpserver2.cisco.com" ntpServer3="ntp.globalcomp.net"
ntpServer4="ntpserver4.cisco.com"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/svc-ext/ntp-svc"
cookie="1256520649/5b73df6a-cd76-16cd-800b-aaec921b0ff4" response="yes">
<outConfig>
<commNtpProvider dn="sys/svc-ext/ntp-svc" description="Network Time Protocol"
ntpEnable="no" ntpServer1="10.104.255.217" ntpServer2="ntpserver2.cisco.com"
ntpServer3="ntp.globalcomp.net" ntpServer4="ntpserver4.cisco.com" status="modified"/>
</outConfig>
</configConfMo>
Retrieving
SNMP Details
Request:
<configResolveClass cookie="1256522119/b7fff8fc-cc76-16cc-800c-aaec921b0ff4" inH
ierarchical="true" classId="aaaLdap"/>
Response:
<configResolveClass cookie="1256522119/b7fff8fc-cc76-16cc-800c-aaec921b0ff4"
response="yes" classId="aaaLdap">
<outConfigs>
<aaaLdap dn="sys/ldap-ext" adminState="disabled" basedn="" domain=""
filter="sAMAccountName" attribute="CiscoAvPair" timeout="60" encryption="enabled"
locateDirectoryUsingDNS="no" dnsDomainSource="extracted-domain" dnsSearchDomain=""
dnsSearchForest="" ldapServer1="" ldapServerPort1="389" ldapServer2=""
ldapServerPort2="389" ldapServer3="" ldapServerPort3="389" ldapServer4=""
ldapServerPort4="3268" ldapServer5="" ldapServerPort5="3268" ldapServer6=""
ldapServerPort6="3268" bindMethod="login-credentials" bindDn="" password=""
groupAuth="disabled" groupAttribute="memberOf">
.
.
rn="rolegroup-27"/> <aaaLdapRoleGroup id="28" name="" domain="" role=""
adminAction="no-op" rn="rolegroup-28"/>
</aaaLdap>
</outConfigs>
</configResolveClass>
Retrieving
SNMP Details Using DN
Request:
<configResolveDn cookie="1256523667/8f16501a-ce76-16ce-8012-aaec921b0ff4"
inHierarchical="true" dn='sys/svc-ext/snmp-svc'/>
Response:
<configResolveDn cookie="1256523667/8f16501a-ce76-16ce-8012-aaec921b0ff4"
response="yes" dn="sys/svc-ext/snmp-svc">
<outConfig>
<commSnmp dn="sys/svc-ext/snmp-svc" descr="SNMP Service" name="snmp"
adminState="enabled" port="161" proto="udp"
community="public" trapCommunity=""
com2Sec="full" sysContact="who@where" sysLocation="unknown">
<commSnmpTrap id="1" adminState="disabled" version="v3"
notificationType="traps" port="162" hostname="0.0.0.0"
user="unknown" rn="snmp-trap-1"/>
<commSnmpTrap id="2" adminState="disabled" version="v3"
notificationType="traps" port="162" hostname="0.0.0.0"
user="unknown" rn="snmp-trap-2"/>
<commSnmpTrap id="3" adminState="disabled" version="v3"
notificationType="traps" port="162" hostname="0.0.0.0"
user="unknown" rn="snmp-trap-3"/>
<commSnmpTrap id="4" adminState="disabled"
version="v3" notificationType="traps"
port="162" hostname="0.0.0.0" user="unknown" rn="snmp-trap-4"/>
<commSnmpTrap id="5" adminState="disabled" version="v3"
notificationType="traps" port="162"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-5"/>
<commSnmpTrap id="6" adminState="disabled"
version="v3" notificationType="traps" port="162"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-6"/>
<commSnmpTrap id="7" adminState="disabled" version="v3"
notificationType="traps" port="162" hostname="0.0.0.0"
user="unknown" rn="snmp-trap-7"/>
<commSnmpTrap id="8" adminState="disabled"
version="v3" notificationType="traps"
port="162" hostname="0.0.0.0" user="unknown" rn="snmp-trap-8"/>
<commSnmpTrap id="9" adminState="disabled"
version="v3" notificationType="traps" port="162"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-9"/>
<commSnmpTrap id="10" adminState="disabled" version="v3"
notificationType="traps" port="162" hostname="0.0.0.0"
user="unknown" rn="snmp-trap-10"/>
<commSnmpTrap id="11" adminState="disabled" version="v3"
notificationType="traps" port="162" hostname="0.0.0.0"
user="unknown" rn="snmp-trap-11"/>
<commSnmpTrap id="12" adminState="disabled" version="v3"
notificationType="traps" port="162" hostname="0.0.0.0"
user="unknown" rn="snmp-trap-12"/>
<commSnmpTrap id="13" adminState="disabled"
version="v3" notificationType="traps" port="162"
hostname="0.0.0.0" user="unknown" rn="snmp-trap-13"/>
...
...
...
</commSnmp>
</outConfig>
</configResolveDn>
Enabling SNMP
and Configuring Parameters
Request:
<configConfMo cookie="0961471706/5f867d7e-746a-1a74-8004-77812a02b884"
inHierarchical="false" dn="sys/svc-ext/snmp-svc">
<inConfig>
<commSnmp dn="sys/svc-ext/snmp-svc" adminState="enabled" community="Top$ecrt"
trapCommunity="Dar$Good" com2Sec="full" sysContact="snmpadmin@cisco" sysLocation="San Jose"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/svc-ext/snmp-svc"
cookie="0961471706/5f867d7e-746a-1a74-8004-77812a02b884" response="yes">
<outConfig>
<commSnmp dn="sys/svc-ext/snmp-svc" descr="SNMP Service" name="snmp"
adminState="enabled" port="161" proto="udp" community="Top$ecrt"
trapCommunity="Dar$Good" com2Sec="full" sysContact="snmpadmin@cisco"
sysLocation="San Jose" engineId="80 00 1F 88 80 64 DA CE 16 39 4E E5 0F"
status="modified" >
</commSnmp>
</outConfig>
</configConfMo>
Configuring
SNMP Users
Request:
<configConfMo cookie="0961472433/0c3bd92d-756a-1a75-8005-77812a02b884"
inHierarchical="false" dn="sys/svc-ext/snmp-svc/snmpv3-user-1">
<inConfig>
<commSnmpUser dn="sys/svc-ext/snmp-svc/snmpv3-user-1" id="1" name="admin"
auth="MD5" authPwd="cisco123" privacy="DES" securityLevel="authpriv"
privacyPwd="ciscoucs"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/svc-ext/snmp-svc/snmpv3-user-1"
cookie="0961472433/0c3bd92d-756a-1a75-8005-77812a02b884" response="yes">
<outConfig>
<commSnmpUser id="1" name="admin" securityLevel="authpriv" auth="MD5"
authPwd="" privacy="DES" privacyPwd="" adminAction="no-op"
dn="sys/svc-ext/snmp-svc/snmpv3-user-1" status="modified" >
</commSnmpUser>
</outConfig>
</configConfMo>
Configuring
SNMP Traps
Request:
<configConfMo cookie="0961472980/a220c9eb-746a-1a74-8006-77812a02b884"
inHierarchical="false" dn="sys/svc-ext/snmp-svc/snmp-trap-1">
<inConfig>
<commSnmpTrap dn="sys/svc-ext/snmp-svc/snmp-trap-1" id="1" adminState="enabled"
hostname="10.106.146.33" notificationType="traps" version="v2c"/>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/svc-ext/snmp-svc/snmp-trap-1"
cookie="0961472980/a220c9eb-746a-1a74-8006-77812a02b884" response="yes">
<outConfig>
<commSnmpTrap id="1" adminState="enabled" version="v2c" notificationType="traps"
port="162" hostname="10.106.146.33" user="unknown" adminAction="no-op"
dn="sys/svc-ext/snmp-svc/snmp-trap-1" status="modified" >
</commSnmpTrap>
</outConfig>
</configConfMo>
Setting Up an
SNMP Engine ID
Request:
<configConfMo cookie="1468979398/1fd17a6c-3808-1808-8002-ac988322e470"
inHierarchical="false" dn="sys/svc-ext/snmp-svc">
<inConfig>
<commSnmp dn="sys/svc-ext/snmp-svc” adminState="enabled"
engineIdKey="Test_Engine_Key”>
</commSnmp>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/svc-ext/snmp-svc" cookie="1468979398/1fd17a6c-3808-1808-8002-ac988322e470"
response="yes">
<outConfig>
<commSnmp dn="sys/svc-ext/snmp-svc" descr="SNMP Service"
name="snmp" adminState="enabled" port="161" proto="udp" community=""
trapCommunity="" com2Sec="disabled" sysContact="who@where" sysLocation="unknown"
engineId="" engineIdKey="Test_Engine_Key" status="modified” >
</commSnmp>
</outConfig>
</configConfMo>
Retrieving the
Configured SNMP Engine ID
Request:
<configResolveClass cookie="1468979398/1fd17a6c-3808-1808-8002-ac988322e470"
inHierarchical="false" classId="commSnmp”/>
Response:
<configResolveClass cookie="1468979398/1fd17a6c-3808-1808-8002-ac988322e470"
response="yes" classId="commSnmp”>
<outConfigs>
<commSnmp dn="sys/svc-ext/snmp-svc" descr="SNMP Service"
name="snmp" adminState="enabled" port="161" proto="udp" community=""
trapCommunity="" com2Sec="disabled" sysContact="who@where" sysLocation="unknown"
engineId="80 00 00 09 04 54 65 73 74 5F 45 6E 67 69 6E 65 5F 4B 65 79"
engineIdKey="Test_Engine_Key">
</commSnmp>
</outConfigs>
</configResolveClass>
Configuring
SMTP Server For Receiving Email Alerts
Request:
<configConfMo dn="sys/svc-ext/mail-alert-svc">
cookie="1484920480/dd879b5e-8746-1687-8003-be18652a6ca4" inHierarchical="true">
<inConfig>
<commMailAlert adminState="enabled" port="25" ipAddress="10.10.10.10"
minSeverityLevel="critical" dn="sys/svc-ext/mail-alert-svc" >
<mailRecipient id="1" dn="sys/svc-ext/mail-alert-svc/mail-recipient-1" rn="mail-recipient-1"
email="john@example.com" adminAction="send-test-mail"> </mailRecipient>
<mailRecipient id="2" dn="sys/svc-ext/mail-alert-svc/mail-recipient-2" rn="mail-recipient-2"
email="mary@example.com" adminAction="send-test-mail"> </mailRecipient>
<mailRecipient id="3" dn="sys/svc-ext/mail-alert-svc/mail-recipient-3" rn="mail-recipient-3"
email="tom@example.com" adminAction="send-test-mail"> </mailRecipient>
</commMailAlert>
</inConfig>
</configConfMo>
Response:
<configConfMo dn="sys/svc-ext/mail-alert-svc"
cookie="1484920480/dd879b5e-8746-1687-8003-be18652a6ca4" response="yes">
<outConfig>
<commMailAlert dn="sys/svc-ext/mail-alert-svc"
adminState="enabled" port="25" minSeverityLevel="critical"
ipAddress="10.10.10.10" status="modified">
<mailRecipient id="1" email="john@example.com" adminAction="no-op"
testMailStatus="yes" rn="mail-recipient-1" status="modified"/>
<mailRecipient id="2" email="mary@example.com" adminAction="no-op"
testMailStatus="no" rn="mail-recipient-2" status="modified"/>
<mailRecipient id="3" email="tom@example.com" adminAction="no-op"
testMailStatus="no" rn="mail-recipient-3" status="modified"/>
</commMailAlert>
</outConfig>
</configConfMo>