Step 1 - Set up Service Account
To utilize CMS meeting and user reporting APIs, a service account with read-only administrator access must be created:
- SSH into the CMS box using any convenient command line utility.
- Login with the Administrator account (e.g. firstname.lastname@example.org).
- Enter the following command: user add vyopta_svc api
- Type in the vyopta_svc user account password.
Note: By default, CMS provisions new account passwords with a 180-day duration, meaning that you will need to update the password on the service account twice yearly. If your corporate service account policies permit, you may want to extend this default duration before adding the vyopta_svc account.
To change the default user account password duration, after logging into the CMS command line interface with your administrator account, but before adding the vyopta_svc account, enter the following command:
user rule password_age NNNN
where NNNN is the number of days before a password expires. So to set the default expiration to yearly, enter:
user rule password_age 1825
If you have already added the Vyopta service account but want to extend its expiration duration, you still enter the above command, followed by:
You'll then be prompted to confirm your administrator password to allow you to do this, then simply reenter the existing password on the vyopta_svc account. It does not need to change to be refreshed -- and if you do change it, you will need to update it on the Vyopta apps management portal.
- To verify that the API role is set (and the password expiration, if changed), enter the following command: user list
- Close the SSH session.
Figure 7-1: CMS User Account Information
Step 2 - Add a CMS Connector
To add a CMS Connector requires the following:
- Access to your organization’s CMS Webpage from the Vyopta Data Collector
- Credentials for the CMS read-only API service account established in the previous step (Section 7.1, Set up a Service Account for Cisco Meeting Server (CMS))
Please follow the instructions below to add the CMS instance:
- Select either Cisco Meeting Server (CMS) or Acano Server, depending upon your version of the Vyopta Data Collector, in the Infrastructure Type drop-down menu. (Only one of those two choices will be available.)
- Enter the server name.
- Enter the CMS URL into the Hostname.
Note: Please include any non-standard port number in the URL. For example:
- Enter an optional description of the video device in the Description field.
- Enter the username and password of the service account established in the prior section.
- Select Server Type (X2, X3 or VM). If VM, enter the number of ports for which your CMS is licensed in the ‘Max concurrent 720p calls’ field
Note: If you are on a fractionally licensed X2 / X3 then please add as a VM instead and specify your max concurrent HD calls.
Figure 7-2: Adding CMS
- Click Validate to ensure that the Vyopta Data Collector can connect to your CMS.
- If the connection to the video component succeeded, click the ‘Copy to Clipboard’ button in order to capture the CDR URL which needs to be entered in CMS and then click the Save button.
- Login to the CMS configuration portal using administrator credentials.
- Navigate to Configuration > CDR Settings tab
- If the Receiver URI 1 field is blank then paste the URL that you copied in step 8 into the ‘URI 1’ field. Otherwise paste the value into the ‘URI 2’ field.
- Click Submit.
- For Acano versions prior to 1.8 or for deployments which require more than 2 CDR streams, please contact email@example.com
Note: Port 22280 is the default port over which the Vyopta Data Collector will listen for inbound CMS CDR data. If this port is not open in your network environment then please reach out to firstname.lastname@example.org for further assistance.
Cisco Meeting Server (CMS) Reference Table
Acano 1.7 or above, CMS 2.0.0 or above
Server IP/FQDN of CMS device(s)
Local account with read-only API access enabled.
Vyopta Data Collector to CMS
CMS CDR forward push to Vyopta Data Collector
Note: the management port can be set to a separate port such as TCP 445 so please confirm the correct port with your CMS administrator.