Get Enterprise Parameters, Service Parameters?

[cdnadmin]

Subject: RE: Get Enterprise Parameters, Service Parameters?
Replied by: David Staudt on 31-03-2010 03:58:58 PM
Depending on the UCM version there may be more or fewer direct requests to facilitate this, but you should be able to get it done.  Lookin at UCM7:
 
- A 'process node' is a UCM node in the cluster
- The special process node with name 'EnterpriseWideData' is a placeholder for the enterprise parameters
- You can either get a dump of the processnode table (via <executeSQLQuery> like 'select * from processnode') or use <listProcessNodeByService> if you know the Service you're looking for (probably won't get the EnterpriseWideData node that way), to get a list of the UCM nodes in the cluster
- You can use <listServiceParameters> to get a list of parameters on a node, the following gets all enterprise parameters:
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/7.0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:listServiceParameters sequence="1">
         <nodeName>*</nodeName>
         <serviceType>Enterprise Wide</serviceType>
      </ns:listServiceParameters>
   </soapenv:Body>
</soapenv:Envelope>
 
- <getServiceParameter> is used to retrieve a particular parameter, e.g.:
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/7.0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getServiceParameter sequence="1">
         <name>ClusterSecurityMode</name>
         <processNodeName>EnterpriseWideData</processNodeName>
         <service>Enterprise Wide</service>
      </ns:getServiceParameter>
   </soapenv:Body>
</soapenv:Envelope>
 
Note, you can also change service parameters via <updateServiceParameter>.  You can deal with service parameters more directly via SQL, the main tables involved: processnode, processconfig
This document was generated from CDN thread

Created by: Jeff Garner on 31-03-2010 02:55:39 PM
Is there any way to retrieve any of the values for items in the Enterprise Parameters and Service Parameters?   I want to write a script that checks certain values across multiple clusters¿

Subject: RE: Get Enterprise Parameters, Service Parameters?
Replied by: Chikeobi Njaka on 01-10-2011 12:43:39 AM
David,
In CUCM 8, there is no such AXL command as listServiceParameters, which is what I am looking for. Do you know what call replaced it?
 

Depending on the UCM version there may be more or fewer direct requests to facilitate this, but you should be able to get it done.  Lookin at UCM7:
 
- A 'process node' is a UCM node in the cluster
- The special process node with name 'EnterpriseWideData' is a placeholder for the enterprise parameters
- You can either get a dump of the processnode table (via <executeSQLQuery> like 'select * from processnode') or use <listProcessNodeByService> if you know the Service you're looking for (probably won't get the EnterpriseWideData node that way), to get a list of the UCM nodes in the cluster
- You can use <listServiceParameters> to get a list of parameters on a node, the following gets all enterprise parameters:
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/7.0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:listServiceParameters sequence="1">
         <nodeName>*</nodeName>
         <serviceType>Enterprise Wide</serviceType>
      </ns:listServiceParameters>
   </soapenv:Body>
</soapenv:Envelope>
 
- <getServiceParameter> is used to retrieve a particular parameter, e.g.:
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/7.0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getServiceParameter sequence="1">
         <name>ClusterSecurityMode</name>
         <processNodeName>EnterpriseWideData</processNodeName>
         <service>Enterprise Wide</service>
      </ns:getServiceParameter>
   </soapenv:Body>
</soapenv:Envelope>
 
Note, you can also change service parameters via <updateServiceParameter>.  You can deal with service parameters more directly via SQL, the main tables involved: processnode, processconfig

Subject: RE: Get Enterprise Parameters, Service Parameters?
Replied by: Chikeobi Njaka on 07-09-2013 01:58:03 PM
Hi David,
With regards to "listServiceParameters", I don't recall if or how this issue was resolved. Even though the developer's guide indicates that listServiceParameters is supported up to version 8.5(1), I don't see it in the Interface spec. Was is deprecated back in 7.x? If so, what API replaced it?

Subject: RE: Get Enterprise Parameters, Service Parameters?
Replied by: Adrienne Moherek on 13-09-2013 12:30:45 PM
Hi Chikeobi,

It looks like listServiceParameters was available in 7.0 and then got removed in 8.0, 8.5, and 9.0. However, it is now available in 9.1.
As an alternative, you can use executeSQLQuery to return a list of service parameters.

Here is a very basic example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/7.0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:executeSQLQuery sequence="?">
         <sql>select * from processconfig</sql>
      </ns:executeSQLQuery>
   </soapenv:Body>
</soapenv:Envelope>

To filter the results take a look at the relationship table for service parameters here:
http://developer.cisco.com/axl/dictionary/html/datadictionary.9.1.1.html#CommonRelations

Thanks,
Adrienne