UC Monitor Rest Web Service

Scope of API for Certificate Monitoring REST Web Service

This is a web interface for the Certificate Monitoring REST Web Service. This web service contains Read APIs to view data in the Certificate Monitoring dashboard. The REST APIs URL fetches the report for customers.

Note

You must specify the mandatory headers for using these API. See Specifying Mandatory API Headers

Following is the resource summary for HCM-F Certificate Monitoring:


URL (Base URL)	HTTPs Method
URL (Base URL)	GET	POST	PUT	DEL
Fetch Certificate Status for All Customers
`https://HCM-F_Server_IPaddress/ucmon/certificates/status/customers`	Y	N	N	N
Fetch Certificate Status for Selected Customer
`https://HCM-F_Server_IPaddress/ucmon/certificates/status/customers/{customerId}`	Y	N	N	N
Fetch Certificate Status for Single Cluster
`https://HCM-F_Server_IPaddress/ucmon/certificates/status/cluster/{clusterid}`	Y	N	N	N
Collect Certificate Data OnDemand from All EndPoints and Store
`https://HCM-F_Server_IPaddress/ucmon/certificates/collect`	N	Y	N	N
Collect Certificate Data OnDemand for Given Customer
`https://HCM-F_Server_IPaddress/ucmon/certificates/collect/customercertificates`	N	Y	N	N
Set Parameters
`https://HCM-F_Server_IPaddress/ucmon/certificates/configure`	N	N	Y	N
Get Parameters
`https://HCM-F_Server_IPaddress/ucmon/certificates/configure`	Y	N	N	N
Fetch Certificate Status per Certificate
`https://HCM-F_Server_IPaddress/ucmon/certificates/status/certificate/appId`	Y	N	N	N

Fetch Certificate Status for All Customers

Request

GET https://HCM-F_Server_IPaddress/ucmon/certificates/status/customers

Parameters

Nil

Response


Code	Description
200	`[ {"custId": "string ", "custName": "string ", "custStatus":"string" }, {"custId": "string ", "custName": "string ", "custStatus":"string" } ]`
401	Unauthorized

Fetch Certificate Status for Selected Customer

Request

GET https://HCM-F_Server_IPaddress/ucmon/certificates/status/customers/{customerId}

Parameter


Name	Type	Description
customerId	int	pkid of the customer

Response

Code	Description
200	`[{ "clustName": "string ", "clustId": "String", "clustStatus":"String", "certCount":"String", "lastExecutedDateTime":"String", "lastSuccessDateTime":"String", "clusterType":"String" }, { "clustName": "string ", "clustId": "String", "clustStatus":"String", "certCount":"String", "lastExecutedDateTime":"String", "lastSuccessDateTime":"String", "clusterType":"String" }]`
401	Unauthorized

Code

Description

200

[{
 "clustName": "string ",
 "clustId": "String",
 "clustStatus":"String",
 "certCount":"String",
 "lastExecutedDateTime":"String",
 "lastSuccessDateTime":"String",
 "clusterType":"String"
},
{
 "clustName": "string ",
 "clustId": "String",
 "clustStatus":"String",
 "certCount":"String",
 "lastExecutedDateTime":"String",
 "lastSuccessDateTime":"String",
 "clusterType":"String"
}]

401

Unauthorized

[{"clustName":"Clustercucxn","clustId":"5","clustStatus":"Invalid","certCount":"3","lastExecutedDateTime":"Aug 13 2018 11:42:36 IST","lastSuccessDateTime":"Aug 10 2018 17:39:50 IST","clusterType":"CUCXN"},{"clustName":"Cluster-CUCM","clustId":"6","clustStatus":"Invalid","certCount":"17","lastExecutedDateTime":"Aug 13 2018 11:44:25 IST","lastSuccessDateTime":"Aug 12 2018 03:02:47 IST","clusterType":"CUCM"}]

Fetch Certificate Status for Single Cluster

Request

GET https://HCM-F_Server_IPaddress/ucmon/certificates/status/cluster/{clusterid}

Parameter


Name	Type	Description
clusterId	int	pkid of the cluster

Response

Code	Description
200	`[ { "name":"string", "fromdate":"string", "expdate":"string", "hostname":"string", "numdays":"string", "signauth":"string", "status":"String" }, { "name":"string", "fromdate":"string", "expdate":"string", "hostname":"string", "numdays":"string", "signauth":"string", "status":"String" } ]`
401	Unauthorized

Code

Description

200

[
{
 "name":"string",
 "fromdate":"string",
 "expdate":"string",
 "hostname":"string",
 "numdays":"string",
 "signauth":"string",
 "status":"String" 
},
{
 "name":"string",
 "fromdate":"string",
 "expdate":"string",
 "hostname":"string",
 "numdays":"string",
 "signauth":"string",
 "status":"String" 
}
]

401

Unauthorized

[{"signauth":"Self Signed","status":"Valid","name":"CallManager/CallManager.pem","fromdate":"Dec 12 2017 IST","expdate":"Dec 11 2022 IST","numdays":"1581","hostname":"xxxxx"}]

Collect Certificate Data OnDemand from All EndPoints and Store

Request

POST https://HCM-F_Server_IPaddress/ucmon/certificates/collect

Parameter

Nil

Response


Code	Description
200	`{"jobId":"String","status":"success","message":"string"}` Or `{"jobId":"String","status":"fail","message":"string"}`
401	Unauthorized

Collect Certificate Data OnDemand for Given Customer

Request

POST https://HCM-F_Server_IPaddress/ucmon/certificates/collect/customercertificates

Parameter


Name	Type	Request for POST	Description
custIds	string	List	List of pkids

Response


Code	Description
200	`{"jobId":"String","status":"success","message":"string"} or {"jobId":"String","status":"fail","message":"string"}`
401	Unauthorized

Set Parameters

Request

PUT https://HCM-F_Server_IPaddress/ucmon/certificates/configure

Parameter

Note

All parameters are mandatory.


Name	Type	Request for PUT	Description
scheduleEnable	String	true or false	true: enable scheduler false: disable scheduler
scheduleTime	String	T00:00:00 to T23:59:59	Time of the day when the trigger is scheduled. Default time is 03:00:00.
scheduleDay	String	Sunday, Monday, Tuesday,Wednesday, Thursday, Friday, and Saturday.	Day of the week when the trigger is scheduled. Default day is Sunday.
ToEmailIds* array (path)	String	<mailid1>@<domain>, <mailid2>@<domain>, ... .. <mailid10>@<domain>	parm1, parm2 .... parm10 Minimum one email ID and maximum 10 email IDs can be configured.
FromEmailId	String	<mailid1>@<domain>	parmeter1. Maximum one email ID must be configured.
custNotificationEnable	String	true or false	true - Enable Customer Notification
expressWayECollectionEnable	String	true or false	true - Enable Expressway E collection and retrieval false - Disable Expressway E collection and retrieval

Response

Code	Description
200	`{"status":"success","message":"string"}`
401	Unauthorized
500	{ "errorCode": "500 Internal Error", "errorMessage": "Invalid Schedule Time", "detailedInfo": "NA"} { "errorCode": "500 Internal Error", "errorMessage": "Invalid Schedule Week Day", "detailedInfo": "NA"} { "errorCode": "500 Internal Error", "errorMessage": "Invalid Email id, "detailedInfo": "NA"} { "errorCode": "500 Internal Error", "errorMessage": "Maximum 10 Email addresses(To) are allowed", "detailedInfo": "NA"} { "errorCode": "500 Internal Error", "errorMessage": "Atleast one Email address(To) is required", "detailedInfo": "NA"}

Code

Description

200

{"status":"success","message":"string"}

401

Unauthorized

500

{ "errorCode": "500 Internal Error", "errorMessage": "Invalid Schedule Time", "detailedInfo": "NA"}
{ "errorCode": "500 Internal Error", "errorMessage": "Invalid Schedule Week Day", "detailedInfo": "NA"}
{ "errorCode": "500 Internal Error", "errorMessage": "Invalid Email id, "detailedInfo": "NA"}
{ "errorCode": "500 Internal Error", "errorMessage": "Maximum 10 Email addresses(To) are allowed", "detailedInfo": "NA"}
{ "errorCode": "500 Internal Error", "errorMessage": "Atleast one Email address(To) is required", "detailedInfo": "NA"}

Get Parameters

Request

GET https://HCM-F_Server_IPaddress/ucmon/certificates/configure

Parameter


Name	Type	Request for PUT	Description
scheduleEnable	String	true or false	true: enable scheduler false: disable scheduler
scheduleTime	String	T00:00:00 to T23:59:59	Time of the day when the trigger is scheduled. Default time is 03:00:00.
scheduleDay	String	Sunday, Monday, Tuesday,Wednesday, Thursday, Friday, and Saturday.	Day of the week when the trigger is scheduled. Default day is Sunday.
ToEmailIds* array (path)	String	<mailid1>@<domain>, <mailid2>@<domain>, ... .. <mailid10>@<domain>	parm1, parm2 .... parm10 Minimum one email ID and maximum 10 email IDs can be configured.
FromEmailId	String	<mailid1>@<domain>	parmeter1. Maximum one email ID must be configured.
custNotificationEnable	String	true or false	true - Enable Customer Notification
expressWayECollectionEnable	String	true or false	true - Enable Expressway E collection and retrieval false - Disable Expressway E collection and retrieval

Response

Code	Description
200	`{ "schedulerEnable": boolean, "scheduleTime": "String", "scheduleDay": "String", "smtpHostName": "String", "smtpPort": int, "emailAddressFrom": "String", "emailAddressTo": "String" "custNotificationEnable": boolean,"expressWayECollectionEnable": boolean }}`
401	Unauthorized

Code

Description

200

{
"schedulerEnable": boolean, "scheduleTime": "String", "scheduleDay": "String", "smtpHostName": "String", "smtpPort": int, "emailAddressFrom": "String", "emailAddressTo": "String"
 "custNotificationEnable": boolean,"expressWayECollectionEnable": boolean
}}

401

Unauthorized

Fetch Certificate Status per Certificate

Request

GET https://HCM-F_Server_IPaddress/ucmon/certificates/status/certificate/appId

Path Parameter

Enables you to fetch certificate status along with actions per certificate


Name	Type	Values Allowed	Description
appId	Integer	Path	pkid of the node

Query Parameter


Name	Description
certificate	Certificate Type

Example Response

Code	Description
200	{ "name": "Server Certificate", "fromDate": "Sep 03 2019 IST", "expDate": "Nov 01 2019 IST", "numDays": "57", "signAuth": "ca_0209", "status": "About To Expire", "hostname": "10.78.89.152", "appId": "4", "regenType": "CA Signed", "trustAllowed": true, "keyLength": "4096", "algorithm": "sha256", "org": "s", "locality": "Bangalore", "state": "Karnataka", "country": "IN", "commonName": "hcs-lnx2-152.cisco.com", "email": "nsandesh507@gmail.com", "san": [ "hcs-lnx2-152.cisco.com" ], "orgUnits": [ "s" ], "actions": [] }
401	"Unauthorized"

Code

Description

200

{
  "name": "Server Certificate",
  "fromDate": "Sep 03 2019 IST",
  "expDate": "Nov 01 2019 IST",
  "numDays": "57",
  "signAuth": "ca_0209",
  "status": "About To Expire",
  "hostname": "10.78.89.152",
  "appId": "4",
  "regenType": "CA Signed",
  "trustAllowed": true,
  "keyLength": "4096",
  "algorithm": "sha256",
  "org": "s",
  "locality": "Bangalore",
  "state": "Karnataka",
  "country": "IN",
  "commonName": "hcs-lnx2-152.cisco.com",
  "email": "nsandesh507@gmail.com",
  "san": [
    "hcs-lnx2-152.cisco.com"
  ],
  "orgUnits": [
    "s"
  ],
  "actions": []
}

401

"Unauthorized"

Scope of API for Certificate Management REST Web Service

This is a web interface for the Certificate Management REST Web Service. This web service contains Read APIs to view data in the Certificate Management dashboard. The REST APIs URL fetches the report for customers.

Following is the resource summary for HCM-F Certificate Management:


Release	Base URL	HTTPs Method	Parameters
Regenerate Certificate For more information on the parameters, see Regenerates the Specific Certificate			Changed
HCM-F 12.5	`https://hcmf-ip/ucmon/certmgmt/regenerate`	POST
HCM-F 12.5 SU1	`https://hcmf-ip/ucmon/certmgmt/certificate`	POST
Generate CSR For more information on the parameters, see Generate CSR for a Certificate			Changed
HCM-F 12.5	`https://hcmf-ip/ucmon/certmgmt/csr`	POST
HCM-F 12.5 SU1	`https://hcmf-ip/ucmon/certmgmt/csr`	POST
Download CSR For more information on the parameters, see Download CSR from the Node			Changed
HCM-F 12.5	`https://hcmf-ip/ucmon/certmgmt/csr`	GET
HCM-F 12.5 SU1	`https://hcmf-ip/ucmon/certmgmt/csr`	GET
Email CSR For more information on the parameters, see Email CSR			Changed
HCM-F 12.5	`https://hcmf-ip/ucmon/certmgmt/csr/email/{appID}`	GET
HCM-F 12.5 SU1	`https://hcmf-ip/ucmon/certmgmt/csr/email`	POST
Upload Certificate For more information on the parameters, see Upload Certificate			Changed
HCM-F 12.5	`https://hcmf-ip/ucmon/certmgmt/upload`	POST
HCM-F 12.5 SU1	`https://hcmf-ip/ucmon/certmgmt/certificate`	PUT
Reset Certificate For more information on the parameters, see Reset Certificate Regeneration			Changed
HCM-F 12.5	`https://hcmf-ip/ucmon/certmgmt/reset`	PUT
HCM-F 12.5 SU1	`https://hcmf-ip/ucmon/certmgmt/reset`	PUT

Following is the resource summary for HCM-F Certificate Management for HCM-F 12.5 release:


URL (Base URL)	HTTPs Method
URL (Base URL)	GET	POST	PUT	DEL
Regenerates the Specific Certificate
`https://hcmf-ip/ucmon/certmgmt/regenerate`	N	Y	N	N
Generate CSR for a Certificate
`https://hcmf-ip/ucmon/certmgmt/csr`	N	Y	N	N
Download CSR from the Node
`https://hcmf-ip/ucmon/certmgmt/csr`	Y	N	N	N
Email CSR
`https://hcmf-ip/ucmon/certmgmt/csr/email/appID`	Y	N	N	N
Upload Certificate
`https://hcmf-ip/ucmon/certmgmt/upload`	N	Y	N	N
Reset Certificate Regeneration
`https://hcmf-ip/ucmon/certmgmt/reset`	N	N	Y	N

Regenerates the Specific Certificate

Request


HCM-F 12.5	`POST https://hcmf-ip/ucmon/certmgmt/regenerate/selfsigned`
HCM-F 12.5 SU1	`POST https://hcmf-ip/ucmon/certmgmt/certificate`

POST https://hcmf-ip/ucmon/certmgmt/regenerate/selfsigned

Body Parameters

Note

Regenerates the specific certificate based on the certificate type available on the UC Applications. This option is available only for Self Signed Certificates.

Code

Type

Values Allowed

Description

HCM-F 12.5

HCM-F 12.5 SU1

HCM-F 12.5

HCM-F 12.5 SU1

certType

certificate

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of certificate.

Note

This is required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER).

nodeId

appId

pkid of application node.

Code

Type

Values Allowed

Description

certType

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of certificate.

Note

This is required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER).

nodeId

String

pkid of application node.

Response


Code	Description
200	`{"status":"PASS/FAIL","message":"Detailed message", "jobId":"<pkid of job>"}`
401	Unauthorized
500	`{ "errorCode": "500 Internal Error", "errorMessage": "Invalid Status", "detailedInfo": "NA"}`


Version	Code	Description
HCM-F 12.5	200	`{"status":"PASS/FAIL","message":"Detailed message", "jobId":"<pkid of job>"}`
HCM-F 12.5 SU1	200	`{"status":"Success/Failed","message":"Detailed message", "jobId":"<pkid of job>"}`
HCM-F 12.5	401	Unauthorized
HCM-F 12.5 SU1	401	Unauthorized
HCM-F 12.5	500	`{ "errorCode": "500 Internal Error", "errorMessage": "Invalid Status", "detailedInfo": "NA"}`
HCM-F 12.5 SU1	500	`{ "errorCode": "500 Internal Error", "errorMessage": "Invalid Status", "detailedInfo": "NA"}`

Generate CSR for a Certificate

Request

POST https://hcmf-ip/ucmon/certmgmt/csr

Body Parameters

Note

Creates CSR for the specific certificate type on the corresponding application. CSR Generation is for Expressway only.

This includes all parameters for CSR Generation in JSON format.

Name

Type

Values Allowed

Description

certificateType

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of the certificate

Note

Required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER), and Expressway.

appId

String

pkid of application node

organization

String

Represents the organizational name. Applicable only for Expressway.

organizationalUnit

String

Represents the organizational unit (OU) name.

For Expressway only one organizationalUnit is supported. Applicable only for Expressway.

province

String

Represents the organization state/Province. Applicable only for Expressway.

locality

String

Represents the organization location. Applicable only for Expressway.

additional_FQDNS

String

Specifies additional host names in the form of a list to be included in the certificate.

You can enter multiple values separated by comma for Expressway. Applicable only for Expressway.

country

String

Country Code to be set

Represents the organization country. Applicable only for Expressway.

digestAlgorithm

String

SHA-256/

SHA-384/

SHA-512

The Digest algorithm is used for the signature. Applicable only for Expressway.

keyLength

String

2048/4096

The number of bits is used for public and private key encryption. Applicable only for Expressway.

isCSROverwrite

String

Can be set to true/false.

Set it to true if you want to delete an existing CSR and create a new CSR. Applicable only for Expressway.

String

The email address to be included in the certificate. Applicable only for Expressway.

isCSRParametersConfigurable

String

Can be set to true/false.

Set it to true if you want to configure the parameters for CSR. This is applicable only for Expressway. The default value is set to False.

Note

It is not supported to configure CSR parameters for UC applications.


Code		Type		Values Allowed	Description
HCM-F 12.5	HCM-F 12.5 SU1	HCM-F 12.5	HCM-F 12.5 SU1	Values Allowed	Description
certificateType	certificate	String		For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide	Type of certificate.
appId	appId	String		Expressway ApplicationId.	pkid of application node.
organization	organization	String			Represents the organizational name.
organizationalUnit	organizationalUnit	String Array			Represents the organizational unit (OU) name. For Expressway only one organizationalUnit is supported.
province	province	String			Represents the organization state or province.
locality	locality	String			Represents the organization location.
additional_FQDNS	additional_FQDNS	StringArray			Specifies an alternate name for the host when you generate a web-server certificate. Multiple values can be povided as a list for Expressway.
country	country	String		Country code to be set	Represents the organization country.
digestAlgorithm	digestAlgorithm	String		SHA-256/ SHA-384/ SHA-512	The Digest algorithm is used for the signature.
keyLength	keyLength	String		2048/4096	The number of bits used for public and private key encryption.
isCSROverwrite	isCSROverwrite	String		Can be set to true/false.	Set it to true if there is a need to delete existing CSR and create a new CSR.
email	email	String			The email address to be included in the certificate.

Response


Code	Scenario	Description
200	CSR Generation Job triggered successfully	`{ "jobId": "JobId", "status": "Success", "message": "Generate CSR job triggered successfully" }`
200	Invalid node Id	`{ "jobId": "0", "status": "Success", "message": "Error occurred on fetching cluster info for nodeId." }`
200	Invalid Certificate type	`{ "jobId": "0", "status": "Success", "message": "Error occurred as invalid certificate type was passed" }`
200	With other ongoing requests	`{ "jobId": "0", "status": "Success", "message": "Action could not be performed as there are other ongoing equests for the same Application node. " }`
401	Authorization error


Version	Code	Scenario	Description
HCM-F 12.5	200	CSR Generation Job triggered successfully	`{ "jobId": "JobId", "status": "Success", "message": "Generate CSR job triggered successfully" }`
HCM-F 12.5 SU1	200	CSR Generation Job triggered successfully	`{ "jobId": JobId, "message": "Generate CSR job triggered successfully" }`
HCM-F 12.5	200	Invalid node Id	`{ "jobId": "0", "message": "Error occurred on fetching cluster info for nodeId." }`
HCM-F 12.5 SU1	400	Invalid node Id	`{ "jobId": "0", "message": "Error occurred on fetching cluster info for appId." }`
HCM-F 12.5	200	Invalid Certificate type	`{ "jobId": "0", "message": "Error occurred as invalid certificate type was passed" }`
HCM-F 12.5 SU1	400	Invalid Certificate type	`{ "jobId": "0", "message": "Error occurred as invalid certificate type was passed" }`
HCM-F 12.5	NA	NA	NA
HCM-F 12.5 SU1	400	UC App node Id	`{ "jobId":"0", "message":"Generate CSR feature is not supported for the UCApps in HCM-F." }`
HCM-F 12.5	200	With other ongoing requests	`{ "jobId": "0", "message": "Action could not be performed as there are other ongoing equests for the same Application node. " }`
HCM-F 12.5 SU1	200	With other ongoing requests	`{ "jobId": "0", "message": "Error occurred as there are other ongoing requests for appId" }`
HCM-F 12.5	401	Authorization error
HCM-F 12.5 SU1	401	Authorization error

Download CSR from the Node

Request

GET https://hcmf-ip/ucmon/certmgmt/csr

Query Parameters

Enables you to download the CSR and save it in your local system.

Name

Type

Values Allowed

Description

appId

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

pkid of application node

certificate

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of the certificate

Note

Required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER), and Expressway.

Code

Type

Values Allowed

Description

HCM-F 12.5

HCM-F 12.5 SU1

HCM-F 12.5

HCM-F 12.5 SU1

certtype

certificate

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of certificate.

Note

This is required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER).

nodeId

appId

pkid of application node.

Response


Code	Scenario	Description
200	CSR exists in App	CSR content is returned as part of the response body.
200	CSR does not exist in App	`{ "message":"Error occurred as CSR does not exist in App"} "status":"fail",`
400	Invalid Node Id	`{ "message": "Error occurred on fetching cluster info for nodeId.", "status": "fail" }`
400	Invalid Certificate type	`{ "message": "Error occurred as invalid certificate type was passed", "status": "fail" }`
500	With other ongoing requests	`{ "message": "Action could not be performed as there are other ongoing equests for the same Application node.", "status": "fail" }`


Version	Code	Scenario	Response
HCM-F 12.5	200	CSR exist in app	Return contents of CSR
HCM-F 12.5 SU1	200	CSR exist in app	{ "message": "-----BEGIN CERTIFICATE REQUEST----- \r\nMIIDSzCCAjMCAQAwgYcxCzAJBgNVBAYTAklOMQswCQYDVQQIEwJrYTEMMAoGA1UE\r \nBxMDYmdsMQ4wDAYDVQQKEwVjaXNjbzELMAkGA1UECxMCU1AxDTALBgNVBAsTBEND\r \nQlUxEDAOBgNVBAsTB2hjcyxDVEcxHzAdBgNVBAMTFmhjcy1sbngyLTE0Ni5jaXNj\ r\nby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3JrZluHSmeFJh\r\ nIpzBYilM5pZRQZ2onpjyoo6geyZzbyvuv1MFXzKYJFVZaNdk9HXStk/ssbZgMK16\ r\nSqkCUc77yaaMZHIUI4OdNBhoc+M2vt7y00RnpYfm2W3UCNjuTr8j6dr3dLJ5ZMOS\r\ nV8bMKiYxTPxXWXqcPuOXNsInb0UKn5VzlrMwdw7WbssX9yyrMrL0KmurY9Ds+r7T\ r\nG6Kc9r5lJYtIJqdO2ers+PqvWfZwgjWttUvdL/qTB0juvdy9L8bQUMFM+ZrYD314\r\ nolpxicp65g2/Mz8vIVnFliIFHsiqSBkvhCWVMxI64+tWNhe5QUyf2FmGdwE2XBCZ\ r\n/0IENRKpAgMBAAGgfjB8BgkqhkiG9w0BCQ4xbzBtMB0GA1UdJQQWMBQGCCsGAQUF\r\ nBwMBBggrBgEFBQcDAjAOBgNVHQ8BAf8EBAMCBLAwPAYDVR0RAQH/BDIwMIIWaGNz\ r\nLWxueDItMTQ1LmNpc2NvLmNvbYIWaGNzLWxueDItMTQ2LmNpc2NvLmNvbTANBgkq\r\ nhkiG9w0BAQsFAAOCAQEALeIO89RjI3fCFANKGlKFxBxrfqnMFi4QuGbrNb3TDRO4\ r\n+ERWhmB01TlMk2YO7EmKkbUuelm3QhlENO/ZTPP6m75rsTVE7mt8JuIhpH7vud8u\r\ nwtyb+51KbyQG8FSzK5lqJIBZYksiXSGlivrSJBdQwRwn4tTrARDKHcbClrTLHtxm\ r\nz23c+tm31U2Aopz9IBnd8ZitJVOBB/DhsC3JG+J6dz4bguMc+I8fsOHGn9QSWjbv\r\ ntS5ppvPVtTRi+Muo9uHclEf/tyqXXWTIHBY+0msDL9f67sySRau8NSZ6h457wSks\ r\nNUAvl5Z/qHvWOqhVUZ2J7Rt/E5+4c+dimA2dGM6aow==\r\n -----END CERTIFICATE REQUEST-----\r\n", "status": "Success" }
HCM-F 12.5	200	CSR does not exist in App	`{"status":"fail","message":"Error occurred as CSR does not exist in App"}`
HCM-F 12.5 SU1	200	CSR does not exist in App	`{"status":"Failed","message":"Error occurred as CSR does not exist in the App"}`
HCM-F 12.5	400	Invalid Node Id	`{ "message": "Error occurred on fetching cluster info for nodeId.", "status": "fail" }`
HCM-F 12.5 SU1	400	Invalid Node Id	`{ "message": "Error occurred on fetching cluster info for nodeId.", "status": "Failed" }`
HCM-F 12.5	400	Invalid Certificate type	`{ "message": "Error occurred as invalid certificate type was passed", "status": "fail" }`
HCM-F 12.5 SU1	400	Invalid Certificate type	`{ "message": "Error occurred as invalid certificate type was passed", "status": "Failed" }`
HCM-F 12.5	NA	NA	NA
HCM-F 12.5 SU1	404	CSR does not exist	`{ "message": "Error occurred as CSR does not exist in the App", "status": "Failed" }`
HCM-F 12.5	500	With other ongoing requests	`{ "message": "Action could not be performed as there are other ongoing equests for the same Application node.", "status": "fail" }`
HCM-F 12.5 SU1	500	With other ongoing requests	`{ "message": "Error occurred as there are other ongoing requests for appId", "status": "Failed" }`

Email CSR

Request


HCM-F 12.5	`GET https://hcmf-ip/ucmon/certmgmt/csr/email/appID`
HCM-F 12.5 SU1	`POST https://hcmf-ip/ucmon/certmgmt/csr/email`

POST https://hcmf-ip/ucmon/certmgmt/csr/email

Path Parameters

Enables you to send email notification to the configured Email IDs and allows you to add Email addresses.

Email CSR for the specific certificate type from the node.

Name

Type

Values Allowed

Description

certificate

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of the certificate

Note

Required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER), and Expressway.

appId

Integer

pkid of application node

emails

Additional email Ids separated by comma to which CSR is sent through email.

Note

Email notification is sent to the configured email address.

Query Parameters

Enables you to send email notification to the configured Email IDs and allows you to add Email addresses.

Email CSR for the specific certificate type from the node.

Code

Type

Values Allowed

Description

HCM-F 12.5

HCM-F 12.5 SU1

HCM-F 12.5

HCM-F 12.5 SU1

certType

certificate

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of certificate.

Note

This is required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER).

appId

Integer

pkid of application node.

emails

String

Email Ids to which CSR should be sent via email.

Response


Code	Scenario	Description
200	CSR Email Job triggered successfully	`{ "jobId": JobId, "status": "Success", "message": "Email CSR job triggered successfully" }`
200	Invalid node Id	`{ "jobId": "0", "status": "Success", "message": "CertMgmt is uanble to get Cluster for the given App PkID" }`
200	Invalid Certificate type	`{ "jobId": "0", "status": "Success", "message": "Error occurred as invalid certificate type was passed" }`
200	With other ongoing requests	`{ "jobId": "0", "status": "Success", "message": "Action could not be performed as there are other ongoing equests for the same Application node." }`
401	Authorization error


Version	Code	Scenario	Description
HCM-F 12.5	200	CSR Email Job triggered successfully	`{ "jobId": <JobId>, "message": "Email CSR job triggered successfully" }`
HCM-F 12.5 SU1	200	CSR Email Job triggered successfully	`{ "jobId": <JobId>, "message": "Email CSR job triggered successfully" }`
HCM-F 12.5	200	Invalid node Id	`{ "jobId": "0", "message": "CertMgmt is uanble to get Cluster for the given App PkID" }`
HCM-F 12.5 SU1	400	Invalid node Id	`{ "jobId": "0", "message": "CertMgmt is uanble to get Cluster for the given App PkID" }`
HCM-F 12.5	200	Invalid Certificate type	`{ "jobId": "0", "message": "Error occurred as invalid certificate type was passed" }`
HCM-F 12.5 SU1	400	Invalid Certificate type	`{ "jobId": "0", "message": "Error occurred as invalid certificate type was passed" }`
HCM-F 12.5	200	With other ongoing requests	`{ "jobId": "0", "message": "Action could not be performed as there are other ongoing equests for the same Application node." }`
HCM-F 12.5 SU1	200	With other ongoing requests	`{ "jobId": "0", "message": "Error occurred as there are other ongoing requests for appId" }`
HCM-F 12.5 SU1	401		Authorization error
HCM-F 12.5 SU1	401		Authorization error

Upload Certificate

Request


HCM-F 12.5	`PUT https://hcmf-ip/ucmon/certmgmt/upload`
HCM-F 12.5 SU1	`PUT https://hcmf-ip/ucmon/certmgmt/certificate`

Body Parameters

Enables you to upload the certificate, restarts services, and re-discovers the latest status.

Name

Type

Description

file

String

Certificate type to be uploaded.

appId

String

pkid of the application.

certificate

String

Type of the certificate

Note

Required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER), and Expressway.

filename

String

File name to be displayed on the logs or screen.

type

String

Name of the type of certificate. For example, own or trust.

Code

Type

Values Allowed

Description

HCM-F 12.5

HCM-F 12.5 SU1

HCM-F 12.5

HCM-F 12.5 SU1

certType

certificate

String

For the supported certificates, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Type of certificate.

Note

This is required for Cisco Unified Communications Manager, Cisco Unified Communications Manager IM and Presence Service, Cisco Unity Connection, Cisco Emergency Responder (CER).

nodeId

appId

pkid of application node.

pemfile

file

multipart/formdata

signed CSR file

filename

String

filename of the signed CSR file

type

String

type of certificate - own or trust

Response

{
 "jobId": "JobId",
 "status": "Success",
 "message": "Upload cetificate job triggered successfully"
}

{

  "message": "Job submission successful",

  "jobId": "28",

  "status": "Success"

}

Code

Scenario

Description

200

Certificate upload Job is submitted

{
 "jobId": "JobId",
 "status": "Success",
 "message": "Upload cetificate job triggered successfully"
}

400

Invalid appId

{
  "jobId": "0",
  "status": "Failed",
  "message": "Error occurred on fetching cluster info for nodeId."
}

400

Certificate regeneration reset failed as there is an ongoing upload request

{
 "jobId": "JobId",
 "status": "Failed",
 "message": "Action could not be performed as there are
other ongoing equests for the same Application node."
}


Version	Code	Scenario	Description
HCM-F 12.5	200	Certificate upload Job is submitted	`{"status":"success"}`
HCM-F 12.5 SU1	200	Certificate upload Job is submitted	`{"status":"success"}`
HCM-F 12.5	400	Invalid nodeId	`{"status":"fail", msg:"Error occurred on fetching cluster info for nodeId."}`
HCM-F 12.5 SU1	400	Invalid appId	`{"status":"fail", msg:"Error occurred on fetching cluster info for appId."}`
HCM-F 12.5	400	Certificate regeneration reset failed as there is an ongoing upload request	`{"status":"fail", msg:"Action could not be performed as there are other ongoing equests for the same Application node."}`
HCM-F 12.5 SU1	400		`{"status":"fail", msg:"Error occurred as there are other ongoing requests for appId"}`

Reset Certificate Regeneration

Request

PUT https://hcmf-ip/ucmon/certmgmt/certificate/reset

Query Parameter

Enables you to switch between a self-signed and CA signed certificate regeneration workflow.


Code		Type		Description
HCM-F 12.5	HCM-F 12.5 SU1	HCM-F 12.5	HCM-F 12.5 SU1	Description
NodeID	appId	String		appId to reset Certificate regeneration flow.
certtype	certificate	String		Certificate type for which we have to reset Certificate regeneration flow on a particular node.


Code	Type	Description
appId	String	appId to reset Certificate regeneration flow.
certificate	String	Certificate type to reset certificate regeneration flow on a particular node.

Response


Code	Description	Response
200	Certificate regeneration reset	`{ "status": "success" }`
400	Certificate regeneration reset failed as there is an ongoing upload request	`{ "message": "Error occurred as there are other ongoing requests for nodeId", "status": "fail" }`


Version	Code	Scenario	Response
HCM-F 12.5	200	Certificate regeneration reset	`{ "message": "Reset is successful ", "status": "Success" }`
HCM-F 12.5 SU1	200	Certificate regeneration reset	`{ "status": "success" }`
HCM-F 12.5	400	Certificate regeneration reset failed as there is an ongoing upload request	`{ "message": "Error occurred as there are other ongoing requests for nodeId", "status": "fail" }`
HCM-F 12.5 SU1	400		`{ "message": "Error occurred as there are other ongoing requests for appId", "status": "fail" }`

Scope of API for Upgrade Toolkit REST Web Service

This is a web interface for the Upgrade Toolkit REST Web Service. This web service contains Read APIs to view data in the Upgrade Checks, Upgrade Comparison, and Phone Compatibility Checks. The REST APIs URL fetches the report for customers.

Note

You must specify the mandatory headers for using these API. See Specifying Mandatory API Headers

Following is the resource summary for HCM-F Upgrade Toolkit:


URL (Base URL)	HTTPs Method				UC Application/Cluster
URL (Base URL)	GET	POST	PUT	DEL	UC Application/Cluster
Initiate Collection of Deprecated Phone Per Customer					Unified CM
`POST https://HCM-F_Server_IPaddress /ucmon/checks/Phones/Customer/`	N	Y	N	N	Unified CM
Initiate Collection of Deprecated Phone Per Cluster					Unified CM
`POST https://HCM-F_Server_IPaddress /ucmon/checks/Phones/`	N	Y	N	N	Unified CM
Get Deprecated Phone Per Cluster					Unified CM
`GET https://HCM-F_Server_IPaddress /ucmon/checks/Phones/{pkid_cluster}`	Y	N	N	N	Unified CM
Get Deprecated Phone Per Customer					Unified CM
`GET https://HCM-F_Server_IPaddress /ucmon/checks/Phones/customer/{pkid_cluster}`	Y	N	N	N	Unified CM
Perform Checks					Unified CM, Unity Connection, IM and Presence
`POST https://HCM-F_Server_IPaddress /ucmon/checks/{clusterID}`	N	Y	N	N	Unified CM, Unity Connection, IM and Presence
Checks Result					Unified CM, Unity Connection, IM and Presence
`GET https://HCM-F_Server_IPaddress /ucmon/checks/{clusterID}`	Y	N	N	N	Unified CM, Unity Connection, IM and Presence
Take Snapshot					Unified CM, Unity Connection, IM and Presence
`POST https://HCM-F_Server_IPaddress /ucmon/checks/snapshot/{clusterId}`	N	Y	N	N	Unified CM, Unity Connection, IM and Presence
Get Snapshot					Unified CM, Unity Connection, IM and Presence
`GET https://HCM-F_Server_IPaddress /ucmon/checks/snapshot/{clusterId}`	Y	N	N	N	Unified CM, Unity Connection, IM and Presence
Compare Check					Unified CM, Unity Connection, IM and Presence
`GET https://HCM-F_Server_IPaddress /ucmon/checks/compare/{clusterId}`	Y	N	N	N	Unified CM, Unity Connection, IM and Presence

Initiate Collection of Deprecated Phone Per Customer

Request

POST https://HCM-F_Server_IPaddress/ucmon/checks/Phones/Customer/

Parameter


Name	Type	Description
customerId	String	pkid of the customer
upgradeVersion	String	Type version

Example

{
         "customerId":2,
         "upgradeVersion":"VERSION_11_5"
}

Response


Code	Description
200	Success
401	Invalid credentials
404	Invalid URL
500	Invalid Customer ID and Version

Example

{
   “jobId”: 20
}

Initiate Collection of Deprecated Phone Per Cluster

Request

POST https://HCM-F_Server_IPaddress/ucmon/checks/Phones/

Parameter


Name	Type	Description
clusterId	String	pkid of the cluster
upgradeVersion	String	Type version

Example

{
         "clusterId":2,
         "upgradeVersion":"VERSION_11_5"
}

Response


Code	Description
200	Success
401	Invalid credentials
404	Invalid URL
500	Invalid Cluster ID and Version

Example

{
   “jobId”: 20
}

Get Deprecated Phone Per Customer

Request

GET https://HCM-F_Server_IPaddress/ucmon/checks/Phones/customer/{pkid_cluster}

Parameter


Name	Type	Description
pkid_cluster	String	Unique ID of cluster in database.

Response


Code	Description
200	Success
401	Invalid credentials
404	Invalid URL
500	Invalid Cluster ID

Example

[{
	"customerName": "Customer-1",
	"clusterList": [{
		"clusterName": "CUCM-CLUSTER1",
		"timestamp": "08/30/2018 01:26:21",
		"phoneResponse": {
			"timestamp": "08/30/2018 01:26:21",
			"deprecatedPhonesList": [{
					"devicemodel": "Cisco 30 SP+",
					"username": null,
					"devicename": "SEP111111111115"
				},
				{
					"devicemodel": "Cisco 12 S",
					"username": "user001@cisco.com",
					"devicename": "SEP111111111111"
				},
				{
					"devicemodel": "Cisco 12 SP",
					"username": "user002@cisco.com",
					"devicename": "SEP111111111112"
				},
				{
					"devicemodel": "Cisco 12 SP+",
					"username": "user003@cisco.com",
					"devicename": "SEP111111111113"
				},
				{
					"devicemodel": "Cisco 30 VIP",
					"username": "user003@cisco.com",
					"devicename": "SEP111111111114"
				}
			]
		}
	}]
}]

Get Deprecated Phone Per Cluster

Request

GET https://HCM-F_Server_IPaddress/ucmon/checks/Phones/{pkid_cluster}

Parameter


Name	Type	Description
pkid_cluster	String	pkid of the cluster.

Response


Code	Description
200	Success
401	Invalid credentials
404	Invalid URL
500	Invalid Cluster ID

Example

[{
	"customerName": "Customer-1",
	"clusterList": [{
		"clusterName": "CUCM-CLUSTER1",
		"timestamp": "08/30/2018 01:26:21",
		"phoneResponse": {
			"timestamp": "08/30/2018 01:26:21",
			"deprecatedPhonesList": [{
					"devicemodel": "Cisco 30 SP+",
					"username": null,
					"devicename": "SEP111111111115"
				},
				{
					"devicemodel": "Cisco 12 S",
					"username": "user001@cisco.com",
					"devicename": "SEP111111111111"
				},
				{
					"devicemodel": "Cisco 12 SP",
					"username": "user002@cisco.com",
					"devicename": "SEP111111111112"
				},
				{
					"devicemodel": "Cisco 12 SP+",
					"username": "user003@cisco.com",
					"devicename": "SEP111111111113"
				},
				{
					"devicemodel": "Cisco 30 VIP",
					"username": "user003@cisco.com",
					"devicename": "SEP111111111114"
				}
			]
		}
	}]
}]

Perform Checks

Request

POST https://HCM-F_Server_IPaddress/ucmon/checks/{clusterID}

Parameter


Name	Type	Method Type	Part of Request	Description
clusterId	int		URI	Pkid of the cluster
checksList		x-www-form-urlencoded	Body	List of checks supported: "getDiskUsage", "getInstalledCops", "getDBReplicationStatus", "getLDAPDetails", "runDiagnosticsTest", "getPhoneDetail", "getCTIEndPoints", "getEnterpriseParams", "getServiceList", "getDRSStatus", "getClusterNetworkConnectivity", "getExternalNetworkConnectivity", "getVcenterInfo", "getUCAppVersion

Response


Code	Description
200	Success
401	Unauthorized

Example

{
"jobId": "87",
"message": "Job created successfully for execution of the selected checks"
}

Checks Result

Request

GET https://HCM-F_Server_IPaddress/ucmon/checks/{clusterID}

Parameter


Name	Type	Description
clusterId	int	Pkid of the cluster

Response


Code	Description
200	Success

Example

[
    {
        "status": "SUCCESS",
        "lastExecutionTime": 1535709430000,
        "recommendedAction": "",
        "subCheckDeviceMap": {
            "getUCAppVersion": {
                "cucm-c001-pub": {
                    "rawData": "",
                    "rawInput": "",
                    "summaryData": "11.5.1.13900-52",
                    "summaryTable": [
                        [
                            "App_Version"
                        ],
                        [
                            "11.5.1.13900-52"
                        ]
                    ],
                    "errorMessage": null,
                    "recommendation": null,
                    "success": true,
                    "pub": true
                },
                "cucm-c001-sub": {
                    "rawData": "",
                    "rawInput": "",
                    "summaryData": "11.5.1.13900-52",
                    "summaryTable": [
                        [
                            "App_Version"
                        ],
                        [
                            "11.5.1.13900-52"
                        ]
                    ],
                    "errorMessage": null,
                    "recommendation": null,
                    "success": true,
                    "pub": false
                }
            },
            "clusterNodesCount": {
                "cucm-c001-pub": {
                    "rawData": "200.1.1.12 cucm-c001-sub.stb.com cucm-c001-sub Subscriber callmanager DBSub authenticated using TCP since Thu Aug 30 12:45:21 2018\r\n200.1.1.11 cucm-c001-pub.stb.com cucm-c001-pub Publisher callmanager DBPub authenticated\r\n\r\nServer Table (processnode) Entries\r\n----------------------------------\r\ncucm-c001-pub \r\ncucm-c001-sub \r\n",
                    "rawInput": "show network cluster",
                    "summaryData": "Node Count :2",
                    "summaryTable": [
                        [
                            "Nodes_Count"
                        ],
                        [
                            "2"
                        ]
                    ],
                    "errorMessage": null,
                    "recommendation": null,
                    "success": true,
                    "pub": true
                }
            }
        },
        "lastSuccesfulExecutionTime": null,
        "checkname": "getUCAppVersion",
        "description": "Cluster Version Information",
        "errorMsg": null
    },
    {
        "status": "FAILURE",
        "lastExecutionTime": 1535709430000,
        "recommendedAction": "cucm-c001-pub : Check whether configurations are correct and VCenterSync and UCSMSync are running.\ncucm-c001-sub : Check whether configurations are correct and VCenterSync and UCSMSync are running.\n",
        "subCheckDeviceMap": {
            "getVcenterInfo": {
                "cucm-c001-pub": {
                    "rawData": "",
                    "rawInput": "",
                    "summaryData": "VCenter Version: UNKNOWN\nEsxi Version: UNKNOWN\nVM Hardware Version: UNKNOWN\nBlade Model: UNKNOWN\nVMWare tools Running: false",
                    "summaryTable": [
                        [
                            "vCenterInfo"
                        ],
                        [
                            "VCenter Version: UNKNOWN\nEsxi Version: UNKNOWN\nVM Hardware Version: UNKNOWN\nBlade Model: UNKNOWN\nVMWare tools Running: false"
                        ]
                    ],
                    "errorMessage": "No Data Received.",
                    "recommendation": "Check whether configurations are correct and VCenterSync and UCSMSync are running.",
                    "success": false,
                    "pub": true
                },
                "cucm-c001-sub": {
                    "rawData": "",
                    "rawInput": "",
                    "summaryData": "VCenter Version: UNKNOWN\nEsxi Version: UNKNOWN\nVM Hardware Version: UNKNOWN\nBlade Model: UNKNOWN\nVMWare tools Running: false",
                    "summaryTable": [
                        [
                            "vCenterInfo"
                        ],
                        [
                            "VCenter Version: UNKNOWN\nEsxi Version: UNKNOWN\nVM Hardware Version: UNKNOWN\nBlade Model: UNKNOWN\nVMWare tools Running: false"
                        ]
                    ],
                    "errorMessage": "No Data Received.",
                    "recommendation": "Check whether configurations are correct and VCenterSync and UCSMSync are running.",
                    "success": false,
                    "pub": false
                }
            }
        },
        "lastSuccesfulExecutionTime": null,
        "checkname": "getVcenterInfo",
        "description": "VCenter and ESXi and UCS Details",
        "errorMsg": null
    },
    {
        "status": "SUCCESS",
        "lastExecutionTime": 1535709430000,
        "recommendedAction": null,
        "subCheckDeviceMap": {
            ...

        "lastSuccesfulExecutionTime": null,
        "checkname": "getDRSStatus",
        "description": "Disaster Recovery System Backup",
        "errorMsg": null
    }
]

Note

The preceding result runs to pages and is truncated for accommodating it on a page.

Take Snapshot

Request

POST https://HCM-F_Server_IPaddress/ucmon/checks/snapshot/{clusterId}

Parameter


Name	Type	Description
clusterId	int	Pkid of the cluster

Response


Code	Description
200	Success
401	Unauthorized

Example

{ "response_data" :The current status of all the checks have been saved successfully}

Get Snapshot

Request

GET https://HCM-F_Server_IPaddress/ucmon/checks/snapshot/{clusterId}

Parameter


Name	Type	Description
clusterId	int	Pkid of the cluster

Response


Code	Description
200	Success
401	Unauthorized

Example

[
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getUCAppVersion",
        "description": "Cluster Version Information",
        "errorMsg": null
    },
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getVcenterInfo",
        "description": "VCenter and ESXi and UCS Details",
        "errorMsg": null
    },
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getClusterNetworkConnectivity",
        "description": "Health of Network within the Cluster",
        "errorMsg": null
    },
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getExternalNetworkConnectivity",
        "description": "Network Connectivity(DNS, SMTP)",
        "errorMsg": null
    },
    {
        "status": "FAILURE",
        "lastExecutionTime": 1535706393000,
        "recommendedAction": " Please check replication status though CLI : utils dbreplication status ",
        "subCheckDeviceMap": {
            "NodeReplication": {
                "cup-c004-pub": {
                    "rawData": "[ \r\n -------------------- utils dbreplication status -------------------- \r\n\r\n\r\nStatus cannot be performed when replication is down on the publisher, or on a cluster with a single active node or a CUCMBE 5000 node; aborting replication status check operation\r\n\r\n\r\nUse this command to see the output - file view activelog cm/trace/dbl/sdi/ReplicationStatus.2018_08_31_02_06_40.out \r\n]\n[\r\n\r\nRuntime state cannot be performed on a cluster with a single active node; aborting operation\r\n\r\n\r\n \r\n]",
                    "rawInput": "utils dbreplication status\nutils dbreplication runtimestate",
                    "summaryData": "Not OK",
                    "summaryTable": [
                        [
                            "nodeReplication"
                        ],
                        [
                            "Not OK"
                        ]
                    ],
                    "errorMessage": "Node DB replication status failed ",
                    "recommendation": "Please check replication status through CLI with command: utils dbreplication status",
                    "success": false,
                    "pub": true
                }
            }
        },
        "lastSuccesfulExecutionTime": null,
        "checkname": "getDBReplicationStatus",
        "description": "State of Database Replication",
        "errorMsg": null
    },
    {
        "status": "SUCCESS",
        "lastExecutionTime": 1535707245000,
        "recommendedAction": null,
        "subCheckDeviceMap": {
            "runDiagnosticsTest": {
                "cup-c004-pub": {
                    "rawData": "\r\nLog file: platform/log/diag4.log\r\n\r\nStarting diagnostic test(s)\r\n===========================\r\n\rtest - disk_space          : 2 second(s) left\rtest - disk_space          : 0 second(s) left\r                                                  \rtest - disk_space          : Passed (available: 7552 MB, used: 6377 MB)\r\nskip - disk_files          : This module must be run directly and off hours\r\n\rtest - service_manager     : 1 second(s) left\rtest - service_manager     : 0 second(s) left\r                                                  \rtest - service_manager     : Passed\t\t\t \r\n\rtest - tomcat              : 10 second(s) left\rtest - tomcat              : 0 second(s) left\r                                                  \rtest - tomcat              : Passed\t\t\t \r\n\rtest - tomcat_deadlocks    : 5 second(s) left\rtest - tomcat_deadlocks    : 0 second(s) left\r                                                  \rtest - tomcat_deadlocks    : Passed\t\t\t \r\n\rtest - tomcat_keystore     : 5 second(s) left\rtest - tomcat_keystore     : 0 second(s) left\r                                                  \rtest - tomcat_keystore     : Passed\t\t\t \r\n\rtest - tomcat_connectors   : 30 second(s) left\rtest - tomcat_connectors   : 0 second(s) left\r                                                  \rtest - tomcat_connectors   : Passed\t\t\t \r\n\rtest - tomcat_threads      : 5 second(s) left\rtest - tomcat_threads      : 4 second(s) left\rtest - tomcat_threads      : 0 second(s) left\r                                                  \rtest - tomcat_threads      : Passed\t\t\t \r\n\rtest - tomcat_memory       : 30 second(s) left\rtest - tomcat_memory       : 29 second(s) left\rtest - tomcat_memory       : 28 second(s) left\rtest - tomcat_memory       : 27 second(s) left\rtest - tomcat_memory       : 26 second(s) left\rtest - tomcat_memory       : 0 second(s) left\r                                                  \rtest - tomcat_memory       : Passed\t\t\t \r\n\rtest - tomcat_sessions     : 5 second(s) left\rtest - tomcat_sessions     : 0 second(s) left\r                                                  \rtest - tomcat_sessions     : Passed\t\t\t \r\nskip - tomcat_heapdump     : This module must be run directly and off hours\r\n\rtest - validate_network    : 300 second(s) left\rtest - validate_network    : 299 second(s) left\rtest - validate_network    : 0 second(s) left\r                                                  \rtest - validate_network    : Passed\t\t\t \r\n\rtest - raid                : 10 second(s) left\rtest - raid                : 0 second(s) left\r                                                  \rtest - raid                : Passed\t\t\t \r\n\rtest - system_info         : 60 second(s) left\rtest - system_info         : 59 second(s) left\rtest - system_info         : 58 second(s) left\rtest - system_info         : 57 second(s) left\rtest - system_info         : 56 second(s) left\rtest - system_info         : 55 second(s) left\rtest - system_info         : 0 second(s) left\r                                                  \rtest - system_info         : Passed (Collected system information in diagnostic log)\r\n\rtest - ntp_reachability    : 5 second(s) left\rtest - ntp_reachability    : 0 second(s) left\r                                                  \rtest - ntp_reachability    : Passed\r\n\rtest - ntp_clock_drift     : 5 second(s) left\rtest - ntp_clock_drift     : 0 second(s) left\r                                                  \rtest - ntp_clock_drift     : Passed\r\n\rtest - ntp_stratum         : 5 second(s) left\rtest - ntp_stratum         : 0 second(s) left\r                                                  \rtest - ntp_stratum         : Passed\r\nskip - sdl_fragmentation   : This module must be run directly and off hours\r\nskip - sdi_fragmentation   : This module must be run directly and off hours\r\n\rtest - ipv6_networking     : 60 second(s) left\rtest - ipv6_networking     : 0 second(s) left\r                                                  \rtest - ipv6_networking     : Passed\r\n\r\nDiagnostics Completed\r\n\r\n\r\n The final output will be in Log file: platform/log/diag4.log\r\n\r\n\r\n Please use 'file view activelog platform/log/diag4.log' command to see the output\r\n\r\n",
                    "rawInput": "utils diagnose test",
                    "summaryData": "{raid=Passed, tomcat_threads=Passed, validate_network=Passed, service_manager=Passed, tomcat_connectors=Passed, ntp_reachability=Passed, ipv6_networking=Passed, sdl_fragmentation=Skipped, This module must be run directly and off hours, disk_space=Passed (available: 7552 MB, used: 6377 MB), tomcat_sessions=Passed, tomcat_memory=Passed, tomcat_deadlocks=Passed, ntp_clock_drift=Passed, disk_files=Skipped, This module must be run directly and off hours, tomcat_heapdump=Skipped, This module must be run directly and off hours, tomcat=Passed, ntp_stratum=Passed, tomcat_keystore=Passed, system_info=Passed (Collected system information in diagnostic log), sdi_fragmentation=Skipped, This module must be run directly and off hours}",
                    "summaryTable": [
                        [
                            "Test",
                            "Result"
                        ],
                        [
                            "raid",
                            "Passed"
                        ],
                        [
                            "tomcat_threads",
                            "Passed"
                        ],
                        [
                            "validate_network",
                            "Passed"
                        ],
                        [
                            "service_manager",
                            "Passed"
                        ],
                        [
                            "tomcat_connectors",
                            "Passed"
                        ],
                        [
                            "ntp_reachability",
                            "Passed"
                        ],
                        [
                            "ipv6_networking",
                            "Passed"
                        ],
                        [
                            "sdl_fragmentation",
                            "Skipped, This module must be run directly and off hours"
                        ],
                        [
                            "disk_space",
                            "Passed (available: 7552 MB, used: 6377 MB)"
                        ],
                        [
                            "tomcat_sessions",
                            "Passed"
                        ],
                        [
                            "tomcat_memory",
                            "Passed"
                        ],
                        [
                            "tomcat_deadlocks",
                            "Passed"
                        ],
                        [
                            "ntp_clock_drift",
                            "Passed"
                        ],
                        [
                            "disk_files",
                            "Skipped, This module must be run directly and off hours"
                        ],
                        [
                            "tomcat_heapdump",
                            "Skipped, This module must be run directly and off hours"
                        ],
                        [
                            "tomcat",
                            "Passed"
                        ],
                        [
                            "ntp_stratum",
                            "Passed"
                        ],
                        [
                            "tomcat_keystore",
                            "Passed"
                        ],
                       [
                            "system_info",
                            "Passed (Collected system information in diagnostic log)"
                        ],
                        [
                            "sdi_fragmentation",
                            "Skipped, This module must be run directly and off hours"
                        ]
                    ],
                    "errorMessage": null,
                    "recommendation": null,
                    "success": true,
                    "pub": true
                }
            }
        },
        "lastSuccesfulExecutionTime": null,
        "checkname": "runDiagnosticsTest",
        "description": "CLI Diagnostics",
        "errorMsg": null
    },
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getCertStatus",
        "description": "Certificate Status Information",
        "errorMsg": null
    },
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getServiceList",
        "description": "List of Services",
        "errorMsg": null
    },
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getEnterpriseParams",
        "description": "Enterprise Service Parameters",
        "errorMsg": null
    },
    {
        "status": null,
        "lastExecutionTime": null,
        "recommendedAction": null,
        "subCheckDeviceMap": {},
        "lastSuccesfulExecutionTime": null,
        "checkname": "getDiskUsage",
        "description": "Available Common Partition Space",
        "errorMsg": null
    },
    {
        "status": "SUCCESS",
        "lastExecutionTime": 1535702576000,
        "recommendedAction": null,
        "subCheckDeviceMap": {
            "getInstalledCops": {
                "cup-c004-pub": {
                    "rawData": "Active Master Version: 9.1.1.20000-5\r\nActive Version Installed Software Options: \r\nciscocm.version3-keys.cop\r\n",
                    "rawInput": "show version active",
                    "summaryData": "[ciscocm.version3-keys.cop]",
                    "summaryTable": [
                        [
                            "COPsInstalled"
                        ],
                        [
                            "ciscocm.version3-keys.cop"
                        ]
                    ],
                    "errorMessage": null,
                    "recommendation": null,
                    "success": true,
                    "pub": true
                }
            }
        },
        "lastSuccesfulExecutionTime": null,
        "checkname": "getInstalledCops",
        "description": "Installed Cop files",
        "errorMsg": null
    },
    {
        "status": "SUCCESS",
        "lastExecutionTime": 1535696721000,
        "recommendedAction": null,
        "subCheckDeviceMap": {
            "getDRSStatus": {
                "cup-c004-pub": {
                    "rawData": "Status: SUCCESS :Backup Completed...\r\nTar Filename: 2018-08-23-03-09-32.tar\r\nStorage Location: NETWORK\r\nOperation: backup\r\nPercentage Complete: 100\r\nIM_AND_PRESENCE   CUP-C004-PUB   DB   SUCCESS   Thu Aug 23 03:09:32 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_db.log   \r\nIM_AND_PRESENCE   CUP-C004-PUB   PREFS   SUCCESS   Thu Aug 23 03:09:42 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_prefs.log   \r\nIM_AND_PRESENCE   CUP-C004-PUB   TCT   SUCCESS   Thu Aug 23 03:09:43 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_tct.log   \r\nIM_AND_PRESENCE   CUP-C004-PUB   CDPAGT   SUCCESS   Thu Aug 23 03:09:44 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_cdpagt.log   \r\nIM_AND_PRESENCE   CUP-C004-PUB   XCP   SUCCESS   Thu Aug 23 03:09:45 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_xcp.log   \r\nIM_AND_PRESENCE   CUP-C004-PUB   PLATFORM   SUCCESS   Thu Aug 23 03:09:46 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_platform.log   \r\nIM_AND_PRESENCE   CUP-C004-PUB   CLM   SUCCESS   Thu Aug 23 03:09:47 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_clm.log   \r\nIM_AND_PRESENCE   CUP-C004-PUB   SYSLOGAGT   SUCCESS   Thu Aug 23 03:09:47 PDT 2018   activelog/platform/drf/log/2018-08-23-03-09-32_b_cup-c004-pub_im_and_presence_syslogagt.log   \r\n",
                    "rawInput": "utils disaster_recovery status backup",
                    "summaryData": "The Latest DRS Backup is successfull.Backup information:\nBackupFilename:2018-08-23-03-09-32.tar\tFeatures:[IM_AND_PRESENCE]\tBackupStatus:SUCCESS :Backup Completed... Percentage Complete: 100",
                    "summaryTable": [
                        [
                            "BackupFilename",
                            "Features",
                            "BackupStatus"
                        ],
                        [
                            "2018-08-23-03-09-32.tar",
                            "IM_AND_PRESENCE",
                            "SUCCESS :Backup Completed... Percentage Complete: 100"
                        ]
                    ],
                    "errorMessage": null,
                    "recommendation": null,
                    "success": true,
                    "pub": true
                }
            }
        },
        "lastSuccesfulExecutionTime": null,
        "checkname": "getDRSStatus",
        "description": "Disaster Recovery System Backup",
        "errorMsg": null
    }
]

Compare Check

Request

GET https://HCM-F_Server_IPaddress/ucmon/checks/compare/{clusterId}

Parameter


Name	Type	Description
clusterId	int	Pkid of the cluster

Response


Code	Description
200	Success
401	Unauthorized

Example

[
    {
        "status": "FAILURE",
        "reason": "Comparison failed. Check Application Specific Status",
        "errorMsg": "",
        "preCheckResult": {
            "status": "FAILURE",
            "lastExecutionTime": 1535970246000,
            "recommendedAction": "Internal Error, Check the responses received from Application",
            "subCheckDeviceMap": {
                "getInstalledCops": {
                    "cucm-c001-pub": {
                        "rawData": "",
                        "rawInput": "",
                        "summaryData": "",
                        "summaryTable": [
                            [
                                "COPsInstalled"
                            ]
                        ],
                        "errorMessage": null,
                        "recommendation": null,
                        "success": true,
                        "pub": true
                    },
                    "cucm-c001-sub": {
                        "rawData": "",
                        "rawInput": "",
                        "summaryData": "No admin credentials configured for application",
                        "summaryTable": [
                            [
                                "COPsInstalled"
                            ]
                        ],
                        "errorMessage": "No admin credentials configured for application",
                        "recommendation": "Verify ADMIN credentials.",
                        "success": false,
                        "pub": false
                    }
                }
            },
            "lastSuccesfulExecutionTime": null,
            "checkname": "getInstalledCops",
            "description": "Installed Cop files",
            "errorMsg": null
        },
        "postCheckResult": {
            "status": "FAILURE",
            "lastExecutionTime": 1535970246000,
            "recommendedAction": "Internal Error, Check the responses received from Application",
            "subCheckDeviceMap": {
                "getInstalledCops": {
                    "cucm-c001-pub": {
                        "rawData": "",
                        "rawInput": "",
                        "summaryData": "",
                        "summaryTable": [
                            [
                                "COPsInstalled"
                            ]
                        ],
                        "errorMessage": null,
                        "recommendation": null,
                        "success": true,
                        "pub": true
                    },
                    "cucm-c001-sub": {
                        "rawData": "",
                        "rawInput": "",
                        "summaryData": "No admin credentials configured for application",
                        "summaryTable": [
                            [
                                "COPsInstalled"
                            ]
                        ],
                        "errorMessage": "No admin credentials configured for application",
                        "recommendation": "Verify ADMIN credentials.",
                        "success": false,
                       "pub": false
                    }
                }
            },…..

….
"rawInput": "utils disaster_recovery status backup",
                    "summaryData": "The Latest DRS Backup is successfull.Backup information:\nBackupFilename:2018-08-23-03-09-32.tar\tFeatures:[IM_AND_PRESENCE]\tBackupStatus:SUCCESS :Backup Completed... Percentage Complete: 100",
                    "summaryTable": [
                        [
                            "BackupFilename",
                            "Features",
                            "BackupStatus"
                        ],
                        [
                            "2018-08-23-03-09-32.tar",
                            "IM_AND_PRESENCE",
                            "SUCCESS :Backup Completed... Percentage Complete: 100"
                        ]
                    ],
                    "errorMessage": null,
                    "recommendation": null,
                    "success": true,
                    "pub": true
                }
            }
        },
        "lastSuccesfulExecutionTime": null,
        "checkname": "getDRSStatus",
        "description": "Disaster Recovery System Backup",
        "errorMsg": null
    }
]

Note

The preceding result runs to pages and is truncated for accommodating it on a page.

UC Application Version Report Summary API

This is a web interface to the sync version REST Web Service.

Sync (POST)

This web service contains Read APIs to view data in the Sync Version.

To sync the UC application at provider level:

https://HCM-F_Server_IPaddress/ucmon/appversions/sync

To sync the UC application at customer level:

https://HCM-F_Server_IPaddress/ucmon/appversions/sync/customers/2
To sync the UC application at cluster level:

https://HCM-F_Server_IPaddress/ucmon/appversions/sync/clusters/1

Detailed (GET)

The REST APIs URL fetches the version detailed and summary report for UC clusters at provider, customer, and cluster level.

To fetch the UC application detailed report at cluster level:

https://HCM-F_Server_IPaddress/ucmon/appversions/detailed/clusters/{clusterId} ?clusterType=CUCM&version=11.x

To fetch the UC application detailed report at provider level:

https://HCM-F_Server_IPaddress/ucmon/appversions/detailed ?clusterType=CUCM&version=11.x

Response Example:

{"versionReportInfo": {
   "lastSyncTime": "May 22, 2019 4:31:54 PM",
   "clusterDetails":    [
            {
         "customerName": "cust10x",
         "clusterName": "CUCM10x",
         "clusterType": "CUCM",
         "appVersions":          [
                        {
               "applicationName": "CUCM10xPub",
               "ipAddress": "10.78.89.12",
               "actualInstalledVersion": "10.5.2.14074-1",
               "hostName": "hcs-lnx2-12",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CUCM10xSub",
               "ipAddress": "10.78.89.13",
               "actualInstalledVersion": "10.5.2.14074-1",
               "hostName": "hcs-lnx2-13",
               "publisherOrPrimary": false,
               "presenceServer": false
            },
                        {
               "applicationName": "CUP10xPub",
               "ipAddress": "10.78.89.14",
               "actualInstalledVersion": "10.5.2.23900-4",
               "hostName": null,
               "publisherOrPrimary": true,
               "presenceServer": true
            },
                        {
               "applicationName": "CUP10xSub",
               "ipAddress": "10.78.89.15",
               "actualInstalledVersion": "10.5.2.23900-4",
               "hostName": null,
               "publisherOrPrimary": false,
               "presenceServer": true
            }
         ],
         "versionInfo": "10.X"
      },
            {
         "customerName": "cust10x",
         "clusterName": "CUCXN10x",
         "clusterType": "CUCXN",
         "appVersions":          [
                        {
               "applicationName": "CUCXN10xSub",
               "ipAddress": "10.106.215.115",
               "actualInstalledVersion": "10.5.2.14074-1",
               "hostName": null,
               "publisherOrPrimary": false,
               "presenceServer": false
            },
                        {
               "applicationName": "CUC10xPub",
               "ipAddress": "10.106.215.121",
               "actualInstalledVersion": "10.5.2.14074-1",
               "hostName": null,
               "publisherOrPrimary": true,
               "presenceServer": false
            }
         ],
         "versionInfo": "10.X"
      },
            {
         "customerName": "cust10x",
         "clusterName": "CER10x",
         "clusterType": "CER",
         "appVersions": [         {
            "applicationName": "CER10XPub",
            "ipAddress": "10.106.215.15",
            "actualInstalledVersion": "10.5.1.20000-3",
            "hostName": null,
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "10.X"
      },
            {
         "customerName": "cust10x",
         "clusterName": "EXPE10x",
         "clusterType": "Expressway Edge",
         "appVersions": [         {
            "applicationName": "EXPE-cust10x",
            "ipAddress": "10.78.89.19",
            "actualInstalledVersion": "X8.8.1",
            "hostName": "hcs-lnx2-19",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X8.8"
      },
            {
         "customerName": "cust10x",
         "clusterName": "EXPC10x",
         "clusterType": "Expressway Core",
         "appVersions": [         {
            "applicationName": "EXPC-cust10x",
            "ipAddress": "10.78.89.22",
            "actualInstalledVersion": "X8.8.1",
            "hostName": null,
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X8.8"
      },
            {
         "customerName": "cust11x",
         "clusterName": "CUCM11x",
         "clusterType": "CUCM",
         "appVersions":          [
                        {
               "applicationName": "CUCM11x",
               "ipAddress": "10.78.89.129",
               "actualInstalledVersion": "11.5.1.15900-18",
               "hostName": "hcs-lnx2-129",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CUCM11xSub",
               "ipAddress": "10.78.89.130",
               "actualInstalledVersion": "11.5.1.15900-18",
               "hostName": "hcs-lnx2-130",
               "publisherOrPrimary": false,
               "presenceServer": false
            },
                        {
               "applicationName": "CUP11xPub",
               "ipAddress": "10.78.89.138",
               "actualInstalledVersion": "11.5.1.15900-33",
               "hostName": "hcs-lnx2-138",
               "publisherOrPrimary": true,
               "presenceServer": true
            },
                        {
               "applicationName": "CUP11xSub",
               "ipAddress": "10.78.89.139",
               "actualInstalledVersion": "11.5.1.15900-33",
               "hostName": "hcs-lnx2-139",
               "publisherOrPrimary": false,
               "presenceServer": true
            }
         ],
         "versionInfo": "11.X"
      },
            {
         "customerName": "cust11x",
         "clusterName": "CUCXN11x",
         "clusterType": "CUCXN",
         "appVersions":          [
                        {
               "applicationName": "CUCXN11xPub",
               "ipAddress": "10.78.89.131",
               "actualInstalledVersion": "11.5.1.15900-18",
               "hostName": "hcs-lnx2-131",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CUCXN11xSub",
               "ipAddress": "10.78.89.132",
               "actualInstalledVersion": "11.5.1.15900-18",
               "hostName": "hcs-lnx2-132",
               "publisherOrPrimary": false,
               "presenceServer": false
            }
         ],
         "versionInfo": "11.X"
      },
            {
         "customerName": "cust11x",
         "clusterName": "CER11x",
         "clusterType": "CER",
         "appVersions": [         {
            "applicationName": "CER11xPub",
            "ipAddress": "10.78.89.17",
            "actualInstalledVersion": "11.5.4.50000-6",
            "hostName": "hcs-lnx2-17",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "11.X"
      },
            {
         "customerName": "cust11x",
         "clusterName": "EXPE-cust11x",
         "clusterType": "Expressway Edge",
         "appVersions": [         {
            "applicationName": "EXPEcust11x",
            "ipAddress": "10.78.89.23",
            "actualInstalledVersion": "X8.11.3",
            "hostName": "hcs-lnx2-23",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X8.11.x"
      },
            {
         "customerName": "cust11x",
         "clusterName": "EXPC-cust11x",
         "clusterType": "Expressway Core",
         "appVersions": [         {
            "applicationName": "EXPC-Cuxt11x",
            "ipAddress": "10.78.89.24",
            "actualInstalledVersion": "X8.11.3",
            "hostName": "hcs-lnx2-24",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X8.11.x"
      },
            {
         "customerName": "cust12x",
         "clusterName": "CUCM12x",
         "clusterType": "CUCM",
         "appVersions":          [
                        {
               "applicationName": "CUCM12xPub",
               "ipAddress": "10.78.89.144",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-144",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CUCM12xSub",
               "ipAddress": "10.78.89.145",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-145",
               "publisherOrPrimary": false,
               "presenceServer": false
            },
                        {
               "applicationName": "CUP12xPub",
               "ipAddress": "10.78.89.146",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-146",
               "publisherOrPrimary": true,
               "presenceServer": true
            }
         ],
         "versionInfo": "12.X"
      },
            {
         "customerName": "cust12x",
         "clusterName": "CUCXN12x",
         "clusterType": "CUCXN",
         "appVersions":          [
                        {
               "applicationName": "CUCXN12XPub",
               "ipAddress": "10.78.89.147",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-147",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CUCXN12xSub",
               "ipAddress": "10.78.89.148",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-148",
               "publisherOrPrimary": false,
               "presenceServer": false
            }
         ],
         "versionInfo": "12.X"
      },
            {
         "customerName": "cust12x",
         "clusterName": "CER12x",
         "clusterType": "CER",
         "appVersions":          [
                        {
               "applicationName": "CER12xPub",
               "ipAddress": "10.78.89.149",
               "actualInstalledVersion": "12.5.1.10000-6",
               "hostName": "hcs-lnx2-149",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CER12xSub",
               "ipAddress": "10.78.89.150",
               "actualInstalledVersion": "12.5.1.10000-6",
               "hostName": "hcs-lnx2-150",
               "publisherOrPrimary": false,
               "presenceServer": false
            }
         ],
         "versionInfo": "12.X"
      },
            {
         "customerName": "cust12x",
         "clusterName": "EXPE12x",
         "clusterType": "Expressway Edge",
         "appVersions": [         {
            "applicationName": "EXPE-Cust12x",
            "ipAddress": "10.78.89.152",
            "actualInstalledVersion": "X12.5",
            "hostName": "hcs-lnx2-152",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X12.x"
      },
            {
         "customerName": "cust12x",
         "clusterName": "EXPC-12x",
         "clusterType": "Expressway Core",
         "appVersions": [         {
            "applicationName": "EXPC12x",
            "ipAddress": "10.78.89.151",
            "actualInstalledVersion": "X12.5",
            "hostName": "hcs-lnx-151",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X12.x"
      },
            {
         "customerName": "cust8x",
         "clusterName": "CUCM8x",
         "clusterType": "CUCM",
         "appVersions": [         {
            "applicationName": "CUCM8xPUB",
            "ipAddress": "10.78.89.153",
            "actualInstalledVersion": "8.6.2.25900-8",
            "hostName": null,
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "Pre9.X"
      },
            {
         "customerName": "cust8x",
         "clusterName": "EXPE8xcust8x",
         "clusterType": "Expressway Edge",
         "appVersions": [         {
            "applicationName": "EXPE-cust8x",
            "ipAddress": "10.78.89.154",
            "actualInstalledVersion": "X8.10.4",
            "hostName": "hcs-lnx2-154",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X8.10"
      },
            {
         "customerName": "cust8x",
         "clusterName": "EXPC8xcust8x",
         "clusterType": "Expressway Core",
         "appVersions": [         {
            "applicationName": "EXPC-cust8x",
            "ipAddress": "10.78.89.155",
            "actualInstalledVersion": "X8.10.4",
            "hostName": "hcs-lnx2-155",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X8.10"
      },
            {
         "customerName": "cust9x",
         "clusterName": "CUCM9x",
         "clusterType": "CUCM",
         "appVersions": [         {
            "applicationName": "CUCM9xPub",
            "ipAddress": "10.106.215.97",
            "actualInstalledVersion": "9.1.1.20000-5",
            "hostName": null,
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "9.X"
      },
            {
         "customerName": "cust9x",
         "clusterName": "CUP9x",
         "clusterType": "CUP",
         "appVersions": [         {
            "applicationName": "CUP9xPub",
            "ipAddress": "10.106.215.51",
            "actualInstalledVersion": "9.1.1.20000-5",
            "hostName": null,
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "9.X"
      }
   ]
}}

To fetch the UC application detailed report at customer level:

https://HCM-F_Server_IPaddress/ucmon/appversions/detailed/customers/{customerId} ?clusterType=CUCM&version=11.x

Response Example:

{"versionReportInfo": {
   "lastSyncTime": "May 22, 2019 4:31:54 PM",
   "clusterDetails":    [
            {
         "customerName": "cust12x",
         "clusterName": "CUCM12x",
         "clusterType": "CUCM",
         "appVersions":          [
                        {
               "applicationName": "CUCM12xPub",
               "ipAddress": "10.78.89.144",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-144",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CUCM12xSub",
               "ipAddress": "10.78.89.145",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-145",
               "publisherOrPrimary": false,
               "presenceServer": false
            },
                        {
               "applicationName": "CUP12xPub",
               "ipAddress": "10.78.89.146",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-146",
               "publisherOrPrimary": true,
               "presenceServer": true
            }
         ],
         "versionInfo": "12.X"
      },
            {
         "customerName": "cust12x",
         "clusterName": "CUCXN12x",
         "clusterType": "CUCXN",
         "appVersions":          [
                        {
               "applicationName": "CUCXN12XPub",
               "ipAddress": "10.78.89.147",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-147",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CUCXN12xSub",
               "ipAddress": "10.78.89.148",
               "actualInstalledVersion": "12.5.1.10000-22",
               "hostName": "hcs-lnx2-148",
               "publisherOrPrimary": false,
               "presenceServer": false
            }
         ],
         "versionInfo": "12.X"
      },
            {
         "customerName": "cust12x",
         "clusterName": "CER12x",
         "clusterType": "CER",
         "appVersions":          [
                        {
               "applicationName": "CER12xPub",
               "ipAddress": "10.78.89.149",
               "actualInstalledVersion": "12.5.1.10000-6",
               "hostName": "hcs-lnx2-149",
               "publisherOrPrimary": true,
               "presenceServer": false
            },
                        {
               "applicationName": "CER12xSub",
               "ipAddress": "10.78.89.150",
               "actualInstalledVersion": "12.5.1.10000-6",
               "hostName": "hcs-lnx2-150",
               "publisherOrPrimary": false,
               "presenceServer": false
            }
         ],
         "versionInfo": "12.X"
      },
            {
         "customerName": "cust12x",
         "clusterName": "EXPE12x",
         "clusterType": "Expressway Edge",
         "appVersions": [         {
            "applicationName": "EXPE-Cust12x",
            "ipAddress": "10.78.89.152",
            "actualInstalledVersion": "X12.5",
            "hostName": "hcs-lnx2-152",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X12.x"
      },
            {
         "customerName": "cust12x",
         "clusterName": "EXPC-12x",
         "clusterType": "Expressway Core",
         "appVersions": [         {
            "applicationName": "EXPC12x",
            "ipAddress": "10.78.89.151",
            "actualInstalledVersion": "X12.5",
            "hostName": "hcs-lnx-151",
            "publisherOrPrimary": true,
            "presenceServer": false
         }],
         "versionInfo": "X12.x"
      }
   ]
}}

Summary (GET)

To fetch the UC application summary report at cluster level:

https://HCM-F_Server_IPaddress/ucmon/appversions/summary/clusters/{clusterId} ?clusterType=CUCM&version=11.x

To fetch the specific UC application summary report at provider level:

https://HCM-F_Server_IPaddress/ucmon/appversions/summary ?clusterType=CUCM&version=11.x

Response Example:

{"versionReportInfo": {
   "lastSyncTime": "May 22, 2019 4:31:54 PM",
   "clusterAppVersions":    [
            {
         "clusterType": "Expressway Core",
         "clusterCountForEachVersion":          {
            "X8.10": 1,
            "X8.11.x": 1,
            "X8.8": 1,
            "X12.x": 1
         }
      },
            {
         "clusterType": "CUP",
         "clusterCountForEachVersion": {"9.X": 1}
      },
            {
         "clusterType": "CUCXN",
         "clusterCountForEachVersion":          {
            "11.X": 1,
            "10.X": 1,
            "12.X": 1
         }
      },
            {
         "clusterType": "CUCM",
         "clusterCountForEachVersion":          {
            "11.X": 1,
            "9.X": 1,
            "10.X": 1,
            "12.X": 1,
            "Pre9.X": 1
         }
      },
            {
         "clusterType": "CER",
         "clusterCountForEachVersion":          {
            "11.X": 1,
            "10.X": 1,
            "12.X": 1
         }
      },
            {
         "clusterType": "Expressway Edge",
         "clusterCountForEachVersion":          {
            "X8.10": 1,
            "X8.11.x": 1,
            "X8.8": 1,
            "X12.x": 1
         }
      }
   ]
}}

To fetch the specific UC application summary report at customer level:

https://HCM-F_Server_IPaddress/ucmon/appversions/summary/customers/{customerId} ?clusterType=CUCM&version=11.x

Response Example:

{"versionReportInfo": {
   "lastSyncTime": "May 22, 2019 4:31:54 PM",
   "clusterAppVersions":    [
            {
         "clusterType": "Expressway Core",
         "clusterCountForEachVersion": {"X12.x": 1}
      },
            {
         "clusterType": "CUCXN",
         "clusterCountForEachVersion": {"12.X": 1}
      },
            {
         "clusterType": "CUCM",
         "clusterCountForEachVersion": {"12.X": 1}
      },
            {
         "clusterType": "CER",
         "clusterCountForEachVersion": {"12.X": 1}
      },
            {
         "clusterType": "Expressway Edge",
         "clusterCountForEachVersion": {"X12.x": 1}
      }
   ]
}}

Cisco Hosted Collaboration Mediation Fulfillment Developer Guide, Release 12.6(1)

Bias-Free Language

Results

Chapter: UC Monitor Rest Web Service

UC Monitor Rest Web Service

Scope of API for Certificate Monitoring REST Web Service

Fetch Certificate Status for All Customers

Fetch Certificate Status for Selected Customer

Fetch Certificate Status for Single Cluster

Collect Certificate Data OnDemand from All EndPoints and Store

Collect Certificate Data OnDemand for Given Customer

Set Parameters

Get Parameters

Fetch Certificate Status per Certificate

Request

Path Parameter

Query Parameter

Example Response

Scope of API for Certificate Management REST Web Service

Regenerates the Specific Certificate

Request

Body Parameters

Response

Generate CSR for a Certificate

Request

Body Parameters

Response

Download CSR from the Node

Request

Query Parameters

Response

Email CSR

Request

Path Parameters

Query Parameters

Response

Upload Certificate

Request

Body Parameters

Response

Reset Certificate Regeneration

Request

Query Parameter

Response

Scope of API for Upgrade Toolkit REST Web Service

Initiate Collection of Deprecated Phone Per Customer

Example

Initiate Collection of Deprecated Phone Per Cluster

Example

Example

Get Deprecated Phone Per Customer

Example

Get Deprecated Phone Per Cluster

Example

Perform Checks

Example

Checks Result

Example

Take Snapshot

Example

Get Snapshot

Example

Compare Check

Example

UC Application Version Report Summary API

Sync (POST)

Detailed (GET)

Summary (GET)

Was this Document Helpful?

Contact Cisco