Call Detail Records on Demand SOAP Service API Developer Guide

Control Center Services, part of Cisco Unified Communications Manager (Unified CM), support service activation, service deactivation, gathering service lists, and service start, stop, and restart.

For Control Center Services, use requests from both ControlCenterServices APIs and ControlCenterServicesEx APIs to accomplish typical application use cases.

There are two Control Center Services WSDLs:

Control Center Services

https://ServerName:8443/controlcenterservice2/services/ControlCenterServices?wsdl

Control Center Services Extended

https://ServerName:8443/controlcenterservice2/services/ControlCenterServicesEx?wsdl

Replace ServerName with the Cisco Unified CM server name or IP address.

Note: All Control Center Services operations work only on the local node identified by the NodeName element.

getProductInformationList

This method lists all product and service information including ProductID, ServiceName, and DependentServices. These values are referenced in most Control Center APIs.

For each server in the cluster, clients are expected to send one request to gather this information. Clients only need to send this request once during initialization.

Request

Response

Copy<!--Control Center - getProductInformationList API Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:getProductInformationList>
         <soap:ServiceInfo></soap:ServiceInfo>
      </soap:getProductInformationList>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center - getProductInformationList API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:getProductInformationListResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:getProductInformationListReturn>
            <ns1:ActiveServerVersion>10.0.0.98000-328.i386</ns1:ActiveServerVersion>
            <ns1:PrimaryNode>cucm3</ns1:PrimaryNode>
            <ns1:SecondaryNode/>
            <ns1:Products>
               <ns1:item>
                  <ns1:ProductName>Cisco Unified Communications Manager</ns1:ProductName>
                  <ns1:ProductVersion>10.0.0.98000-328</ns1:ProductVersion>
                  <ns1:ProductDescription>Cisco Unified Communications Manager</ns1:ProductDescription>
                  <ns1:ProductID>CallManager</ns1:ProductID>
                  <ns1:ShortName>UCM</ns1:ShortName>
               </ns1:item>
               <ns1:item>
                  <ns1:ProductName>Cisco Prime License Manager</ns1:ProductName>
                  <ns1:ProductVersion>10.0.0.98000-328</ns1:ProductVersion>
                  <ns1:ProductDescription>Cisco Prime License Manager</ns1:ProductDescription>
                  <ns1:ProductID>Elm</ns1:ProductID>
                  <ns1:ShortName>ELM</ns1:ShortName>
               </ns1:item>
               <ns1:item>
                  <ns1:ProductName>Common Services</ns1:ProductName>
                  <ns1:ProductVersion>10.0.0.98000-328</ns1:ProductVersion>
                  <ns1:ProductDescription>Common Services for all Products</ns1:ProductDescription>
                  <ns1:ProductID>Common</ns1:ProductID>
                  <ns1:ShortName>SYS</ns1:ShortName>
               </ns1:item>
            </ns1:Products>
            <ns1:Services>
               <ns1:item>
                  <ns1:ServiceName>Cisco Serviceability Reporter</ns1:ServiceName>
                  <ns1:ServiceType>Service</ns1:ServiceType>
                  <ns1:Deployable>true</ns1:Deployable>
                  <ns1:GroupName>Performance and Monitoring Services</ns1:GroupName>
                  <ns1:ProductID>Common</ns1:ProductID>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               </ns1:item>
               <ns1:item>
                  <ns1:ServiceName>Cisco DirSync</ns1:ServiceName>
                  <ns1:ServiceType>Service</ns1:ServiceType>
                  <ns1:Deployable>true</ns1:Deployable>
                  <ns1:GroupName>Directory Services</ns1:GroupName>
                  <ns1:ProductID>Common</ns1:ProductID>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               </ns1:item>
               ...
               <ns1:item>
                  <ns1:ServiceName>Cisco Prime LM Admin</ns1:ServiceName>
                  <ns1:ServiceType>Servlet</ns1:ServiceType>
                  <ns1:Deployable>false</ns1:Deployable>
                  <ns1:GroupName>ELM Services</ns1:GroupName>
                  <ns1:ProductID>Elm</ns1:ProductID>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               </ns1:item>
            </ns1:Services>
         </ns1:getProductInformationListReturn>
      </ns1:getProductInformationListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
ServiceInfo	The request handler. Information on all products and services is returned regardless of the value in ServiceInfo, including a value of blank.

Response Format

The response contains the following values:

Parameter	Description
ActiveServerVersion	Version of Cisco Unified CM installed
PrimaryNode	Name of the primary node
SecondaryNode	Name of the secondary node, if any
Products	Array of installed products
Services	Array of services

Each item in Products includes:

Parameter	Description
ProductName	Name of the product
ProductVersion	Version number of the product
ProductDescription	Descriptive name of the product
ProductID	Product identifier, which is useful to applications for distinguishing between one product and another
ShortName	Short name for the product

Each item in Services includes:

Parameter	Description
ServiceName	Name of the service
ServiceType	Service or servlet
Deployable	True or false
GroupName	Name of the group to which the service belongs
ProductID	Product identifier, which is useful to applications for distinguishing between one product and another
DependentServices	Array of dependent services, if any

soapGetServiceStatus

The soapGetServiceStatus method allows clients to perform a status query for a service. This method returns information to determine if a service is started or stopped, and activated or deactivated. The response also includes a timestamp for the last time it was started.

Request

Response

Copy<!--Control Center - soapGetServiceStatus API Request-->
<!--If you leave service status empty you will get the status of all services, if not you can list specific services and get information for requested services only-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:soapGetServiceStatus>
          <soap:ServiceStatus></soap:ServiceStatus>
      </soap:soapGetServiceStatus>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center - soapGetServiceStatus API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:soapGetServiceStatusResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:soapGetServiceStatusReturn>
            <ns1:ReturnCode>0</ns1:ReturnCode>
            <ns1:ReasonCode>-1</ns1:ReasonCode>
            <ns1:ReasonString xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <ns1:ServiceInfoList>
               <ns1:item>
                  <ns1:ServiceName>A Cisco DB</ns1:ServiceName>
                  <ns1:ServiceStatus>Started</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1</ns1:ReasonCode>
                  <ns1:ReasonCodeString></ns1:ReasonCodeString>
                  <ns1:StartTime>Fri Aug 22 10:00:04 2014</ns1:StartTime>
                  <ns1:UpTime>1831891</ns1:UpTime>
               </ns1:item>
               <ns1:item>
                  <ns1:ServiceName>A Cisco DB Replicator</ns1:ServiceName>
                  <ns1:ServiceStatus>Started</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1</ns1:ReasonCode>
                  <ns1:ReasonCodeString></ns1:ReasonCodeString>
                  <ns1:StartTime>Fri Aug 22 10:00:05 2014</ns1:StartTime>
                  <ns1:UpTime>1831890</ns1:UpTime>
               </ns1:item>
               ...
               <ns1:item>
                  <ns1:ServiceName>Self Provisioning IVR</ns1:ServiceName>
                  <ns1:ServiceStatus>Stopped</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1068</ns1:ReasonCode>
                  <ns1:ReasonCodeString>Service Not Activated</ns1:ReasonCodeString>
                  <ns1:StartTime xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <ns1:UpTime>-1</ns1:UpTime>
               </ns1:item>
            </ns1:ServiceInfoList>
         </ns1:soapGetServiceStatusReturn>
      </ns1:soapGetServiceStatusResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
ServiceStatus	Leave ServiceStatus empty to receive the service status information for all services in the system. List specific services to receive information for those requested services only.

Response Format

This method returns information to determine if a service is started or stopped, and activated or deactivated. The response also includes a timestamp for the last time the service was started.

Parameter	Description
ReturnCode	Returns return code values: 0: OK 1: "Not Found" client error 2: "Invalid Request" client error 3: "Internal Error" server error 9: "Invalid Node Name" client error 10: "Not Ready" server error 50: "Handle Not Found In Cache" client error 127: "Unknown Error" client/server error
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonString	Refer to Service Status, Reason Code, Reason Code String
ArrayOfServiceInformation	An array of requested information for one or more elements of the type `item`.

ServiceInfoList includes one or more elements of the type item with the following format:

Parameter	Description
ServiceName	The ServiceName found in ControlCenterServices getProductInformationList
ServiceStatus	Refer to Service Status, Reason Code, Reason Code String
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonCodeString	Refer to Service Status, Reason Code, Reason Code String
StartTime	Time the service was started, in time string format
UpTime	Time in seconds since the service was started

soapGetStaticServiceList

The soapGetStaticServiceList method allows clients to perform a query of all static specifications for services in Cisco Unified CM.

Request

Response

Copy<!--Control Center - soapGetStaticServiceList API Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:soapGetStaticServiceList>
         <soap:ServiceInformationResponse></soap:ServiceInformationResponse>
      </soap:soapGetStaticServiceList>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center - soapGetStaticServiceList API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:soapGetStaticServiceListResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:soapGetStaticServiceListReturn>
            <ns1:Services>
               <ns1:item>
                  <ns1:ServiceName>Cisco Serviceability Reporter</ns1:ServiceName>
                  <ns1:ServiceType>Service</ns1:ServiceType>
                  <ns1:Deployable>true</ns1:Deployable>
                  <ns1:GroupName>Performance and Monitoring Services</ns1:GroupName>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               </ns1:item>
               <ns1:item>
                  <ns1:ServiceName>Cisco DirSync</ns1:ServiceName>
                  <ns1:ServiceType>Service</ns1:ServiceType>
                  <ns1:Deployable>true</ns1:Deployable>
                  <ns1:GroupName>Directory Services</ns1:GroupName>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               </ns1:item>
               ...
               <ns1:item>
                  <ns1:ServiceName>Cisco Prime LM Admin</ns1:ServiceName>
                  <ns1:ServiceType>Servlet</ns1:ServiceType>
                  <ns1:Deployable>false</ns1:Deployable>
                  <ns1:GroupName>ELM Services</ns1:GroupName>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               </ns1:item>
            </ns1:Services>
         </ns1:soapGetStaticServiceListReturn>
      </ns1:soapGetStaticServiceListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
ServiceInformationResponse	The request handler. Information on all services is returned regardless of the value in ServiceInformationResponse, including a blank value.

Response Format

soapGetStaticServiceList returns an array of service static specifications. Each item in the array includes:

Parameter	Description
ServiceName	The ServiceName found in ControlCenterServices getProductInformationList
ServiceType	Service or servlet
Deployable	True or false
GroupName	Name of the group to which the service belongs
DependentServices	Array of dependent services, if any

soapDoControlServices

The soapDoControlServices method allows clients to start or stop a list of services. The method returns the services response information for the services that are requested to be started or stopped. The method does not allow clients to stop non-stop services such as:

Cisco DB
Cisco Tomcat

This method does not allow clients to provide an empty list of services for starting or stopping the services.

Request

Response

Copy<!--Control Center - soapDoControlServices API Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:soapDoControlServices>
         <soap:ControlServiceRequest>
            <soap:NodeName>ciscart23</soap:NodeName>
            <soap:ControlType>Start</soap:ControlType>
            <soap:ServiceList>
               <soap:item>Cisco CallManager</soap:item>
            </soap:ServiceList>
         </soap:ControlServiceRequest>
      </soap:soapDoControlServices>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center - soapDoControlServices API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:soapDoControlServicesResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:soapDoControlServicesReturn>
            <ns1:ReturnCode>-1</ns1:ReturnCode>
            <ns1:ReasonCode>-1057</ns1:ReasonCode>
            <ns1:ReasonString/>
            <ns1:ServiceInfoList>
               <ns1:item>
                  <ns1:ServiceName>Cisco CallManager</ns1:ServiceName>
                  <ns1:ServiceStatus>Started</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1</ns1:ReasonCode>
                  <ns1:ReasonCodeString></ns1:ReasonCodeString>
                  <ns1:StartTime>Fri Aug 22 10:00:52 2014</ns1:StartTime>
                  <ns1:UpTime>1825887</ns1:UpTime>
               </ns1:item>
            </ns1:ServiceInfoList>
         </ns1:soapDoControlServicesReturn>
      </ns1:soapDoControlServicesResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
NodeName	The name of the local node.
ControlType	Start Stop Restart
ServiceList	Name of the service to start, stop, or restart. This is the same value as `ServiceName` found in `getProductInformationList` and `soapGetServiceStatus`.

Response Format

Parameter	Description
ReturnCode	Returns return code values: 0: OK 1: "Not Found" client error 2: "Invalid Request" client error 3: "Internal Error" server error 9: "Invalid Node Name" client error 10: "Not Ready" server error 50: "Handle Not Found In Cache" client error 127: "Unknown Error" client/server error
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonString	Refer to Service Status, Reason Code, Reason Code String
ArrayOfServiceInformation	An array of requested information for one or more elements of the type `item`.

item consists of:

Parameter	Description
ServiceName	The name of the service provided in the request
ServiceStatus	Refer to Service Status, Reason Code, Reason Code String
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonCodeString	Refer to Service Status, Reason Code, Reason Code String
StartTime	Time the service was started, in time string format
UpTime	Time in seconds since the service was started

soapDoServiceDeployment

Use this method to deploy or undeploy a deployable service, where a deployable service has the Deployable attribute set to True in the response from soapGetServiceStatus method.

soapDoServiceDeployment does not allow clients to deploy or undeploy an empty list of services.

This method only activates services on the node specified by the NodeName element. NodeName must use the local node as its value.

Request

Response

Copy<!--Control Center - soapDoServiceDeployment API Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:soapDoServiceDeployment>
         <soap:DeploymentServiceRequest>
            <soap:NodeName>ciscart23</soap:NodeName>
            <soap:DeployType>Deploy</soap:DeployType>
            <soap:ServiceList>
               <soap:item>Cisco Tftp</soap:item>
            </soap:ServiceList>
         </soap:DeploymentServiceRequest>
      </soap:soapDoServiceDeployment>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center - soapDoServiceDeployment API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:soapDoServiceDeploymentResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:soapDoServiceDeploymentReturn>
            <ns1:ReturnCode>0</ns1:ReturnCode>
            <ns1:ReasonCode>-1</ns1:ReasonCode>
            <ns1:ReasonString xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <ns1:ServiceInfoList>
               <ns1:item>
                  <ns1:ServiceName>Cisco Tftp</ns1:ServiceName>
                  <ns1:ServiceStatus>Started</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1</ns1:ReasonCode>
                  <ns1:ReasonCodeString></ns1:ReasonCodeString>
                  <ns1:StartTime>Wed Sep 10 13:42:50 2014</ns1:StartTime>
                  <ns1:UpTime>175188</ns1:UpTime>
               </ns1:item>
            </ns1:ServiceInfoList>
         </ns1:soapDoServiceDeploymentReturn>
      </ns1:soapDoServiceDeploymentResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
NodeName	The name of the local node where services are requested to be deployed or undeployed.
DeployType	Deploy or UnDeploy.
ServiceList	Services to deploy or undeploy. This is the same value as `ServiceName` found in `getProductInformationList` and `soapGetServiceStatus`.

Response Format

The soapDoServiceDeployment method returns the response information for the services that are requested to be deployed or undeployed.

Parameter	Description
ReturnCode	Returns return code values: 0: OK 1: "Not Found" client error 2: "Invalid Request" client error 3: "Internal Error" server error 9: "Invalid Node Name" client error 10: "Not Ready" server error 50: "Handle Not Found In Cache" client error 127: "Unknown Error" client/server error
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonString	Refer to Service Status, Reason Code, Reason Code String
ArrayOfServiceInformation	An array of requested information for one or more elements of the type `item`.

Information for a service consists of:

Parameter	Description
ServiceName	The name of the service provided in the request
ServiceStatus	Refer to Service Status, Reason Code, Reason Code String
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonCodeString	Refer to Service Status, Reason Code, Reason Code String
StartTime	Time the service was started, in time string format
UpTime	Time in seconds since the service was started

Control Center Services Extended API

Control Center Services Extended was introduced with enhancements to Control Center Services in Version 9.0.

getFileDirectoryList

The getFileDirectoryList method lists the names of the files contained in the specified directory. The files are not downloaded. Use this method prior to using the DimeGetFile Service API.

Request

Rewponse

Copy<!--Control Center Extended - getFileDirectoryList API Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:getFileDirectoryList>
         <soap:DirectoryPath>/var/log/active/tomcat/logs/ccmservice</soap:DirectoryPath>
      </soap:getFileDirectoryList>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center Extended - getFileDirectoryList API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:getFileDirectoryListResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:ListOfFiles>
            <ns1:File>ccmservice00005.log</ns1:File>
            <ns1:File>ccmservice00010.log</ns1:File>
            <ns1:File>ccmservice00008.log</ns1:File>
            <ns1:File>ccmservice00006.log</ns1:File>
            <ns1:File>ccmservice.bin</ns1:File>
            <ns1:File>ccmservice00004.log</ns1:File>
            <ns1:File>ccmservice00003.log</ns1:File>
            <ns1:File>ccmservice00001.log</ns1:File>
            <ns1:File>ccmservice00009.log</ns1:File>
            <ns1:File>ccmservice00007.log</ns1:File>
            <ns1:File>ccmservice00002.log</ns1:File>
         </ns1:ListOfFiles>
      </ns1:getFileDirectoryListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
DirectoryPath	Directory path of the files. For example, /var/log/active/tomcat/logs/ccmservice. Use LogCollectionPort `selectLogFiles` to return the path for the service.

Response Format

Parameter	Description
ListOfFiles	The names of the files contained in the directory specified in the request.

getStaticServiceListExtended

ControlCenterServices getStaticServiceList provides a detailed list of all of the services. The ControlCenterServicesEx getStaticServiceListExtended includes the ProductID and restrictions in addition.

Request

Response

Copy<!--Control Center Extended - getStaticServiceListExtended API Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:getStaticServiceListExtended>
         <soap:ServiceInformationResponse></soap:ServiceInformationResponse>
      </soap:getStaticServiceListExtended>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center Extended - getStaticServiceListExtended API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:getStaticServiceListExtendedResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:getStaticServiceListExtendedReturn>
            <ns1:PrimaryNode>true</ns1:PrimaryNode>
            <ns1:SecondaryNode>false</ns1:SecondaryNode>
            <ns1:Services>
               <ns1:item>
                  <ns1:ServiceName>Cisco Serviceability Reporter</ns1:ServiceName>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <ns1:ProductID>Common</ns1:ProductID>
                  <ns1:ServiceType>Service</ns1:ServiceType>
                  <ns1:RestrictServer>no</ns1:RestrictServer>
                  <ns1:Restrict>none</ns1:Restrict>
                  <ns1:SetDefault>yes</ns1:SetDefault>
                  <ns1:SequenceNumber>201000</ns1:SequenceNumber>
                  <ns1:ServiceEnum>14</ns1:ServiceEnum>
                  <ns1:GroupName>Performance and Monitoring Services</ns1:GroupName>
                  <ns1:Deployable>true</ns1:Deployable>
               </ns1:item>
               <ns1:item>
                  <ns1:ServiceName>Cisco DirSync</ns1:ServiceName>
                  <ns1:DependentServices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <ns1:ProductID>Common</ns1:ProductID>
                  <ns1:ServiceType>Service</ns1:ServiceType>
                  <ns1:RestrictServer>no</ns1:RestrictServer>
                  <ns1:Restrict>PrimaryNode</ns1:Restrict>
                  <ns1:SetDefault>no</ns1:SetDefault>
                  <ns1:SequenceNumber>201800</ns1:SequenceNumber>
                  <ns1:ServiceEnum>27</ns1:ServiceEnum>
                  <ns1:GroupName>Directory Services</ns1:GroupName>
                  <ns1:Deployable>true</ns1:Deployable>
               </ns1:item>
               ...
                <ns1:item>
                  <ns1:ServiceName>Cisco CDR Repository Manager</ns1:ServiceName>
                  <ns1:DependentServices>
                     <ns1:item>Cisco Database Layer Monitor</ns1:item>
                     <ns1:item>A Cisco DB</ns1:item>
                  </ns1:DependentServices>
                  <ns1:ProductID>CallManager</ns1:ProductID>
                  <ns1:ServiceType>Service</ns1:ServiceType>
                  <ns1:RestrictServer>no</ns1:RestrictServer>
                  <ns1:Restrict>PrimaryNode</ns1:Restrict>
                  <ns1:SetDefault>no</ns1:SetDefault>
                  <ns1:SequenceNumber>3000</ns1:SequenceNumber>
                  <ns1:ServiceEnum>18</ns1:ServiceEnum>
                  <ns1:GroupName>CDR Services</ns1:GroupName>
                  <ns1:Deployable>false</ns1:Deployable>
               </ns1:item>
            </ns1:Services>
         </ns1:getStaticServiceListExtendedReturn>
      </ns1:getStaticServiceListExtendedResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
ServiceInformationResponse	The request handler. Information on all products and services is returned regardless of the value in ServiceInformationResponse, including a value of blank.

Response Format

Parameter	Description
PrimaryNode	True or false
SecondaryNode	True or false
Services	One or more Services

Each Service consists of the following:

Parameter	Description
ServiceName	The ServiceName found in ControlCenterServices getProductInformationList
DependentServices	Array of dependent services, if any
ProductID	Product identifier, which is useful to applications for distinguishing between one product and another
ServiceType	Service or servlet
RestrictServer	Yes or no, indicating if there are any restrictions. If yes, see `Restrict`.
Restrict	Values are: None = No restriction PrimaryNode = Service should appear only on the PrimaryNode DoNotStop = Restrict the service from starting or stopping from the GUI.
SetDefault	This attribute is used by the serviceability GUI pages to help select all services that need to be activated in a single server mode (only one node in a cluster). The values are: Yes No
SequenceNumber	This attribute is used by service manager to order the startup sequence of services. The first service to start is `SequenceNumber` 1 and the other services follow.
ServiceEnum	This attribute is used during migration. The `ServiceEnum` does not change for a service. The same enum is used from release to release. This helps in migration of services from release to release even if the service name has changed. The use of this enum is product specific. A value of “blank” indicates that this service does not have a `ServiceEnum.`
GroupName	Each service is part of a group. This is the name of that group.
Deployable	True or false. If `Deployable` is false, a start, stop, or restart of a service is not possible.

soapDoControlServicesEx

The soapDoControlServicesEx method is used to start, stop, or restart services on UCM and ELM (10.0 and above).

Request

Response

Copy<!--Control Center Extended - soapDoControlServicesEx API Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:soapDoControlServicesEx>
         <soap:ControlServiceRequestEx>
            <soap:ProductId>CallManager</soap:ProductId>
            <soap:DependencyType>none</soap:DependencyType>
            <soap:ControlType>Start</soap:ControlType>
            <soap:ServiceList>
               <soap:item>Cisco Messaging Interface</soap:item>
               <soap:item>Cisco Dialed Number Analyzer Server</soap:item>
            </soap:ServiceList>
         </soap:ControlServiceRequestEx>
      </soap:soapDoControlServicesEx>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center Extended - soapDoControlServicesEx API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:soapDoControlServicesExResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:soapDoControlServicesExReturn>
            <ns1:ReturnCode>-1</ns1:ReturnCode>
            <ns1:ReasonCode>-1057</ns1:ReasonCode>
            <ns1:ReasonString/>
            <ns1:ServiceInfoList>
               <ns1:item>
                  <ns1:ServiceName>Cisco Messaging Interface</ns1:ServiceName>
                  <ns1:ServiceStatus>Stopped</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1068</ns1:ReasonCode>
                  <ns1:ReasonCodeString>Service Not Activated</ns1:ReasonCodeString>
                  <ns1:StartTime xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <ns1:UpTime>-1</ns1:UpTime>
               </ns1:item>
               <ns1:item>
                  <ns1:ServiceName>Cisco Dialed Number Analyzer Server</ns1:ServiceName>
                  <ns1:ServiceStatus>Started</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1</ns1:ReasonCode>
                  <ns1:ReasonCodeString></ns1:ReasonCodeString>
                  <ns1:StartTime>Fri Aug 22 10:01:00 2014</ns1:StartTime>
                  <ns1:UpTime>1836232</ns1:UpTime>
               </ns1:item>
            </ns1:ServiceInfoList>
         </ns1:soapDoControlServicesExReturn>
      </ns1:soapDoControlServicesExResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
ProductId	The name of the product. Each service is associated to a product. To determine the `ProductId` for the service you want to control, use `getStaticServiceListExtended.` Examples of a `ProductId` are CallManager, Elm, and Common.
DependencyType	Some services require other dependency services to be started for the functionality to work correctly. The possible values for `DependencyType` are: Enforce - Send requests to all the dependent services to start or restart None – There are no dependent services
ControlType	The command to start, stop, or restart the service. A start, stop, or restart of a service is valid only if the status of the service is activated. To determine the activation status of a service, use a `soapGetServiceStatus` request and review the response. “Service Not Activated” in the `ReasonCodeString` indicates the service is not activated. Otherwise, the service is activated. The possible values for `ControlType` are: Start Stop Restart .
ServiceList/Item	List of the services to be controlled by start, stop, or restart. Reference the `ServiceName` found in the response of `soapGetStaticServiceList` or `soapGetStaticServiceListExtended`.

Response Format

The soapDoControlServicesEx method is used to start, stop, or restart services on UCM and ELM (10.0 and above).

Parameter	Description
ReturnCode	Returns return code values: 0: OK 1: "Not Found" client error 2: "Invalid Request" client error 3: "Internal Error" server error 9: "Invalid Node Name" client error 10: "Not Ready" server error 50: "Handle Not Found In Cache" client error 127: "Unknown Error" client/server error
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonString	Refer to Service Status, Reason Code, Reason Code String
ArrayOfServiceInformation	An array of requested information for one or more elements of the type `item`.

Information for each service consists of:

Parameter	Description
ServiceName	The ServiceName found in ControlCenterServices getProductInformationList
ServiceStatus	Refer to Service Status, Reason Code, Reason Code String
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonCodeString	Refer to Service Status, Reason Code, Reason Code String
StartTime	Time the service was started, in time string format
UpTime	Time in seconds since the service was started

soapDoServiceDeploymentNoDbUpdate

Use this method to deploy or undeploy a deployable service, where a deployable service has the Deployable attribute set to True in the response from soapGetServiceStatus method. This method does not allow clients to deploy or undeploy an empty list of services.

This method only activates services on the node specified by the NodeName element. NodeName must use the local node as its value.

soapDoServiceDeploymentNoDbUpdate is similar to soapDoServiceDeployment. However, the soapDoServiceDeploymentNoDbUpdate does not update the isActive column of the processnodeservice table when deploying or undeploying a service.

Request

Response

Copy<!--Control Center Extended - soapDoServiceDeploymentNoDbUpdate API Request-->
<!--Unlike the soapDoServiceDeployment operation, this version will respond with the status of a non-deployable (e.g.Cisco
CallManager Serviceability RTMT) service instead of an 'Operation not supported' message that the soapDoServiceDeployment operation provides-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:soapDoServiceDeploymentNoDbUpdate>
         <soap:DeploymentServiceRequestEx>
            <soap:ProductId>CallManager</soap:ProductId>
            <soap:DeployType>UnDeploy</soap:DeployType>
            <soap:ServiceList>
               <soap:item>Cisco Extension Mobility</soap:item>
            </soap:ServiceList>
         </soap:DeploymentServiceRequestEx>
      </soap:soapDoServiceDeploymentNoDbUpdate>
   </soapenv:Body>
</soapenv:Envelope>

Copy<!--Control Center Extended - soapDoServiceDeploymentNoDbUpdate API Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:soapDoServiceDeploymentNoDbUpdateResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
         <ns1:soapDoServiceDeploymentNoDbUpdateReturn>
            <ns1:ReturnCode>0</ns1:ReturnCode>
            <ns1:ReasonCode>-1</ns1:ReasonCode>
            <ns1:ReasonString xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <ns1:ServiceInfoList>
               <ns1:item>
                  <ns1:ServiceName>Cisco Extension Mobility</ns1:ServiceName>
                  <ns1:ServiceStatus>Stopped</ns1:ServiceStatus>
                  <ns1:ReasonCode>-1068</ns1:ReasonCode>
                  <ns1:ReasonCodeString>Service Not Activated</ns1:ReasonCodeString>
                  <ns1:StartTime xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <ns1:UpTime>-1</ns1:UpTime>
               </ns1:item>
              </ns1:ServiceInfoList>
         </ns1:soapDoServiceDeploymentNoDbUpdateReturn>
      </ns1:soapDoServiceDeploymentNoDbUpdateResponse>
   </soapenv:Body>
</soapenv:Envelope>

Request Format

Parameter	Description
ProductID	Product identifier of the service, such as CallManager
DeployType	Deploy UnDeploy
ServiceList	A list of services, such as Cisco CallManager, Cisco CallManager Serviceability

Response Format

Parameter	Description
ReturnCode	Returns return code values: 0: OK 1: "Not Found" client error 2: "Invalid Request" client error 3: "Internal Error" server error 9: "Invalid Node Name" client error 10: "Not Ready" server error 50: "Handle Not Found In Cache" client error 127: "Unknown Error" client/server error
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonString	Refer to Service Status, Reason Code, Reason Code String
ArrayOfServiceInformation	An array of requested information for one or more elements of the type `item`.
Array of services returns the following:

Parameter	Description
ServiceName	The ServiceName found in ControlCenterServices getProductInformationList
ServiceStatus	Refer to Service Status, Reason Code, Reason Code String
ReasonCode	Refer to Service Status, Reason Code, Reason Code String
ReasonCodeString	Refer to Service Status, Reason Code, Reason Code String
StartTime	Time the service was started, in time string format
UpTime	Time in seconds since the service was started

Unlike the soapDoServiceDeployment operation, this version will return the status of a non-deployable service, for example Cisco CallManager Serviceability RTMT, instead of an 'Operation not supported' message that the soapDoServiceDeployment operation provides.

Service Status, Reason Code, Reason Code String

The following details apply to ServiceStatus, ReasonCode, and ReasonCodeString.

Parameter	Description
ServiceStatus	Started Stopped Starting Stopping Unknown

ServiceStatus is Started or Stopped.

If ServiceStatus is Started:

StartTime gives the time the service was started in a time string format.
UpTime gives the time in seconds since the service was started.
ReasonCode is -1
ReasonCodeString is null

The ReasonCode and ReasonCodeString indicate why the service is Stopped.

If a deployable service is activated and stopped by an administrator:

The status is Stopped
The ReasonCode equals -1019
The corresponding ReasonCodeString specifies “Component is not running”

If a deployable service is deactivated

The status is Stopped
The ReasonCode equals -1068
The corresponding ReasonCodeString specifies “Service Not Activated”

If a nondeployable service is stopped by an administrator:

The status could be Stopped
The ReasonCode equals -1019
The corresponding ReasonCodeString specifies “Component is not running”

Invalid Service: Nondeployable Service

If the request to activate or deactivate a service is for a nondeployable service, the Deployable attribute is set to False in the response. For example, “SNMP Master Agent,” returns the ReasonCode -1045 with the ReasonCodeString “Operation not supported” in the response.

The complete list of ReasonCode and ReasonCodeString follows:

Reason Code	Reason Code String
-1000	Component already initialized
-1001	Entry replaced
-1002	Component not initialized
-1003	Component is running
-1005	Unable to process event
-1006	Registration already present
-1007	Unsuccessful completion
-1008	Registration not found
-1009	Missing or invalid environment variable
-1010	No such service
-1011	Component is reserved for platform
-1012	Bad arguments
-1013	Internal error
-1014	Entry was already present
-1015	Error opening IPC
-1016	No license available
-1017	Error opening file
-1018	Error reading file
-1019	Component is not running
-1020	Signal ignored
-1021	Notification ignored
-1022	Buffer overflow
-1023	Cannot parse
-1024	Out of memory
-1025	Not connected
-1026	Component already exists
-1027	Message was truncated
-1028	Component is empty
-1029	Operation is pending
-1030	Transaction does not exist
-1031	Operation timed-out
-1032	File is locked
-1033	Feature is not implemented yet
-1034	Alarm was already set
-1035	Alarm was already clear
-1036	Dependency is in active state
-1037	Dependency is not in active state
-1038	Circular dependencies detected
-1039	Component already started
-1040	Component already stopped
-1041	Dependencies still pending
-1042	Requested process state transition not allowed
-1043	No changes
-1044	Boundary violation for data structure
-1045	Operation not supported
-1046	Process recovery in progress
-1047	Process recovery in progress
-1048	Operation pending on active dependencies
-1049	Operation pending on active dependents
-1050	Shutdown is in progress
-1051	Invalid Table Handle
-1052	Data Base not initialized
-1053	Data Directory
-1054	Table Full
-1055	Deleted Data
-1056	No Such Record
-1057	Component already in specified state
-1058	Out of range
-1059	Cannot create object
-1060	MSO refused, standby system not ready.
-1061	MSO refused, standby state update still in progress. Try again later.
-1062	MSO refused, standby state update failed. Verify configuration on standby.
-1063	MSO refused, Warm start-up in progress.
-1064	MSO refused, Warm start-up Failed.
-1065	MSO refused, System is not in active state
-1066	MSO refused, Detected standalone Flag
-1067	Invalid Token presented in request
-1068	Service Not Activated
-1069	Commanded Out of Service
-1070	Multiple Modules have error
-1071	Encountered exception
-1072	Invalid context path was specified
-1073	No context exists
-1074	No context path was specified
-1075	Application already exists