CMSCDR Configuration Syntax

The CMSCDR Configuration is used to configure the Cisco Meeting Server for monitoring.

SUBSYS CMSCDR

DEFINE HTTP_PROFILE (CMSCDR, port=<port-number>[, ssl=1][, {"TLSCertchain=<server-cert-key-combined.pem>" | "TLSCertThumb=<certificate thumbprint>"}] )
DEFINE PARAMS ([ActiveExpiryPeriod=<secs>][, CompletedExpiryPeriod=<secs>][, ApiQueryPeriod=30][, ApiQueryTimeout=10][, ApiQueryValidateSSL=0,][ ApiQueryBatchSize=100][, "ApiQueryProxy="])

Syntax Elements

DEFINE HTTP_PROFILE

This is used to define a common listener for all CMS systems to be monitored. When configured all CDR's are received on the common port and sent through to the Cisco CMS monitor.

port=<port-number>

HTTP Listener port on the device

ssl=1Use this flag to specify that Secure Sockets are to be used, ie. https listener.

TLSCertchain=<server-cert-key-combined.pem>

(Optional) A Combined TLS server certificate with certificate key. By default, the CMSCDR Configuration uses the self-signed certificate generated during installation and present in the <Prognosis_Home>\Server\Configuration folder. The default certificate name is "server_cert_key_combined.pem". A Certificate Authority signed certificate can be used instead. If the desired certificate file is not in the Configuration folder, then the absolute path for the certificate file must be included in the file name.

If the path or filename contains spaces, then enclose the full file name in double quotes ("...").

TLSCertThumb=<certificate thumbprint>

(Optional) If the certificate to use for HTTPS is already present in the Personal certificate store on the local Windows computer, refer to Installing Server Certificate in the Windows Certificate Store, it can be used directly without the need to export it to the file <server-cert-key-combined.pem> for use in TLSCertchain parameter.

To obtain the thumbprint of the certificate. Refer to Locating the Thumbprint for Certificates in the Windows Certificate Store for more information.

Ensure that the parameter and the certificate thumbprint (sequence of hex numbers) are enclosed in double-quotes ("...").

Only use one of either the parameters TLSCertchain or TLSCertThumb, not both.

DEFINE PARAMS

If required, the following statements can be added to configure expiry periods for call and call Legs.

ActiveExpiryPeriod

Expiry period in seconds for active calls, if the active call does not receive an update since the last call event. The valid range is between 3600 (1 hour) and 259200 (3 days). Default: 86400 (1 day)

CompletedExpiryPeriod

Expiry period in seconds for completed calls (i.e. calls after this delay will be deleted from memory and no further out of bound call events will be processed for this call). The valid range is between 0 to 86400 (1 day). Default: 60 (1 minute).

The following configuration parameters are also available, these will enable the CMS Web API interface to retrieve QoS metrics for active calls. However, please only change these settings after consultation with IR Support.

ApiQueryPeriod

Used to determine how often to query the API for call leg information. The valid range is between 0 to 3600 (1 hour). When the value is 0, the CMSCDR process will stop querying the REST API. Default: 30.

This value is recommended to be a multiple of 30 seconds as the Displays have a 30 second refresh rate, so anything in between will not be captured in the Displays.

ApiQueryTimeout

The number of seconds before a HTTP request times out. The valid range is between 5 to 30. Default: 5.

ApiQueryValidateSSL

Used to determine whether to validate the certificate from the HTTP response. The value is either 0 or 1 (false or true respectively). Default: 0.

ApiQueryBatchSize

Used to determine how many requests will be sent out at a time to the server, before waiting for all active requests to receive a response. Valid values range from 10 to 500. Default: 100.

ApiQueryProxy

URL of the web proxy server (without the http:// prefix). The default value is empty.

Example:

SUBSYS CMSCDR

DEFINE HTTP_PROFILE (CMSCDR, port=6000, ssl=1, TLSCertchain=server_cert.pem )
DEFINE PARAMS (ActiveExpiryPeriod=86400, CompletedExpiryPeriod=60)
DEFINE PARAMS (ApiQueryPeriod=30, ApiQueryTimeout=5, ApiQueryValidateSSL=0, ApiQueryBatchSize=100, "ApiQueryProxy=")
Provide feedback on this article