[Index]
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
This procedure adds and configures a CUCM server (Cisco Unified Communications Manager) within a CUCM cluster.
Note
References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.
Log in to the VOSS Admin portal with the appropriate hierarchy administrator credentials.
Note
Set the hierarchy path to the correct level:
Go to (default menus) Apps Management > CUCM > Servers.
Click Add.
Configure server details on the Base tab:
At CUCM Server Name, fill out the CUCM server name.
Note
A CUCM server that has been configured in HCM-F and synced into VOSS Automate may exist at the sys.hcs hierarchy. If the server name you enter matches this server, the Migrate from HCM-F to VOSS Automate checkbox displays.
To migrate this server to the current hierarchy level, click Save. The fields are populated with the values configured in HCM-F. If you don't want to migrate the server, enter a different server name.
If you're configuring a publisher node, select the Publisher checkbox. This displays an additional tab (Publisher tab).
For a CUCM Publisher node, fill out the Cluster Name field with the name you want for this cluster. A new cluster is created with this name. For CUCM Subscribers, choose the CUCM cluster from the Cluster Name drop-down menu.
At Server Type, choose an option, either VOICE_VIDEO or IM_P.
To trigger a sync (auto-import) of the UC app server when saving the form, select Sync on Create/Update.
Expand Network Addresses, and add network addresses, one or more:
At Address Space, choose SERVICE_PROVIDER_SPACE.
Note
If NAT is used, you will also need to add a APPLICATION_SPACE network address (repeat these steps and for address space, choose APPLICATION_SPACE).
The Hostname field is automatically populated with the CUCM server Name. Edit it if necessary.
Fill out the IP address of the CUCM server in the IPv4 Address field.
Note
Either the hostname or the IP address is required. Ensure the hostname or IP address does not contain a trailing blank space since VOSS Automate can't validate entries that contain a blank space at the end of the hostname or IP address.
Fill out the domain of the CUCM application.
Provide an optional description for the network address.
Expand Credentials, then add credentials for PLATFORM, ADMIN, HTTP, and SNMP_Vx credential types. Click + to add more credentials.
Fill out the user ID and password that you configured when installing the CUCM.
For Access Type, choose RO (Read-only) or RW (Read or Write). The default is RO.
Provide an optional description for the credential.
Note
Fill out fields on the Publisher tab:
Note
This tab displays only if you've selected the Publisher checkbox on the Base tab.
Field | Description |
---|---|
Prime Collab | Choose the Prime Collaboration management application monitoring this cluster. To un-associate Prime Collaboration for this cluster, choose None. |
Call Processing ID | The Call Processing ID of this cluster |
SDR Cluster ID | The SDR CUCM cluster ID, as shown on SDR Configuration > SDR CUCM Clusters. |
Version | Choose the version of the Unified CM Servers in this cluster. The available versions depend on the version of the HCM-F device that has been configured. |
Multi-Tenant | Read-only field. If creating at provider level, this field is set to Shared. If creating at customer level, this field is set to Dedicated. |
Port | The port on the Unified CM server to connect to. Default is 8443. |
User Move Mode | Choose Automatic to automatically move synced in users to sites, based on the filters and filter order defined in User Management > Manage Filters. Choose Manual if you want an Administrator to manually move synced in users to a Site. |
User Entitlement Profile | Choose the Entitlement Profile that specifies which devices and services users synced from this Unified CM are entitled to. Note: A violation of the Entitlement Profile does not prevent a user from being synced to VOSS Automate from Unified CM. However, subsequent updates to the user fail until the user's configuration satisfies the restrictions set in the Entitlement Profile. |
Enable Change Notification Sync | Select this check box to enable Change Notification. By enabling this, a Change Notification data sync and corresponding Schedule will be created. The Schedule is initially created as Disabled and needs to be manually enabled from the Scheduling menu. The Change Notification Sync interval is set to 14 days by default. See the note below this table. |
Monitoring | For new servers and if Arbitrator servers are available, monitoring can be enabled for this CUCM on VOSS Insights. The Arbitrator server checkboxes can be selected to add the server as an asset. The Arbitrator server will be updated. Existing servers can be managed from the Onboard Assets and Offboard Assets menus under VOSS Insights. The arbitrator checkboxes will then reflect the asset status. |
Inspect the default mappings and modify if required, see User Field Mapping.
Click Save. A CUCM network device is created in VOSS Automate. (If installed, a cluster and CUCM are created in the SDR.)
Test the connection between CUCM and VOSS Automate.
Related Topics
Test a CUCM and VOSS Automate Connection
Once you've added a CUCM server, you should test the connection between the CUCM server and VOSS Automate.
In the VOSS Automate Admin Portal, to to (default menus) Apps Management > Advanced > CUCM Network Device.
Click the CUCM you just added.
Choose Action > Test Connection.
If the test fails, and you used a hostname, ensure that VOSS Automate has the correct DNS and Domain set. Refer to the Network services topic in the Platform Guide.
Log in to the platform CLI.
Query the current DNS setting: network dns.
Set the DNS if needed: network dns <dns_server_ip_address>.
Query the current domain setting: network domain.
Set the domain if needed: network domain <domain>.
Note
Use the CUCM Network Device page only for testing the connection. Do not edit CUCM from this page. To change any configuration of the CUCM, edit it via Apps Management > CUCM > Servers in VOSS Automate.
After updating DNS servers, you'll need to restart the selenium service on the platform CLI:
app start selenium
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is UC Publisher |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is TFTP Server |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Music Server |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Attendant Console |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is CTI Manager |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Conference Server |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Annunciator |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Media Termination Point |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Call Processing Engine |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Type Cucm Server * | Default: VOICE_VIDEO |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Server Name * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Type Deployment Mode |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Auto Linked | Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Routing Id |
|
||||||||||||||||||||||||||||||||||||||||||||||||
CUCM Cluster * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Virtual Machine |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Credentials |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Type Credential * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
User ID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Password Community String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Type SNMP Access | Default: RO |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Network Addresses |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Type Address Space * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
IP Addr V4 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
IP Addr V6 |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Host Short Name Only |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Domain |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is SRV Address * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
SIP Trunks |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Cluster Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Sdr Cluster |
|
||||||||||||||||||||||||||||||||||||||||||||||||
id |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Type Cucm Cup Sharing Mode | Default: DEDICATED |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Name * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Cluster ID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Call Processing ID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Description |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Type App Version * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Is Manual Mode |
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
Country Code |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Num End User Subscribers |
|
||||||||||||||||||||||||||||||||||||||||||||||||
ELMID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
CUOM |
|
||||||||||||||||||||||||||||||||||||||||||||||||
ELM |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Owns Org Unit |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Monitors Prime Collab |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Customers |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Voss Application |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Description | The description of the Cisco Unified Communications Manager. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Host Name * | The host name of the Cisco Unified Communications Manager. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Admin Username * | The administrator Username to connect to the Cisco Unified Communications Manager. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Admin Password * | The administrator Password associated with the Username to connect to the Cisco Unified Communications Manager. The text will be hidden. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Version * | The selected version of the Cisco Unified Communications Manager to connect to. The list of versions is maintained in the CallManagerVersion model. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Port | The port on the Cisco Unified Communications Manager server to connect to. Default: 8443 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Immediate Import | Deprecated. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
CUCM Cluster Notes | CUCM Cluster Notes Field |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Voss Cluster |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Name * | The (unique) name of the CUCM cluster. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Sync on Create/Update | If this checkbox is selected, then when saving this form (on either create or update), it will also immediately trigger the auto-import (sync) of this UC App server now. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Version | Indicates the version of the CUCMs within the cluster. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
HostNameOrIP | The hostname or IPV4 of the CUCM |
|
|||||||||||||||||||||||||||||||||||||||||||||||
User Move Mode | The behavior for moving users to site. Setting this value to Automatic will trigger the system to apply the move filters (refer to User Management) automatically when users are sync'd into the system. Automatic is only applicable to creating new users. Setting this value to Manual means that users must be moved to site by an Adminstrator (refer to User Management). Default: Automatic |
|
|||||||||||||||||||||||||||||||||||||||||||||||
User Entitlement Profile | The Entitlement Profile assigned to users imported from this UC Application. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Misc Data | Miscellaneous data used at run-time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Migrate from HCM-F to CUCDM | Migrate HCM-F Models to CUCDM Models Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Multi-Tenant | Indicates whether the cluster applications are dedicated to a customer or shared across multiple customers |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Enable Change Notification Sync | Enable Change Notification Sync for Cluster Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Monitoring | Manage Monitoring for this Cluster |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Credential Type | Select the credential type to use for the monitoring. Default: ADMIN |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Assurance Arbitrator Servers | Select the Assurance Arbitrator servers to configure for monitoring this cluster. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Field Mapping |
|
||||||||||||||||||||||||||||||||||||||||||||||||
User ID * | The CUCM field mapped to the user's login attribute. Default: userid |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Building Name | The CUCM field mapped to the user's custom building name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
C | The CUCM field mapped to the user's custom country. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Department | The CUCM field mapped to the user's department number. Default: department |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Directory URI | The CUCM field mapped to the user's custom directory URI. Default: directoryUri |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Display Name | The CUCM field mapped to the user's custom display name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Employee Number | The CUCM field mapped to the user's custom employee number. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Employee Type | The CUCM field mapped to the user's custom employee type. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Facsimile Telephone Number | The CUCM field mapped to the user's custom FAX number. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
First Name | The CUCM field mapped to the user's first name. Default: firstName |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Home Number | The CUCM field mapped to the user's home phone number. Default: homeNumber |
|
|||||||||||||||||||||||||||||||||||||||||||||||
IP Phone | The CUCM field mapped to the user's custom IP phone number. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Jabber ID | The CUCM field mapped to the user's custom Jabber ID. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
L | The CUCM field mapped to the user's custom city. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Mail ID | The CUCM field mapped to the user's email address. Default: mailid |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Manager ID | The CUCM field mapped to the user's manager. Default: manager |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Member Of | The CUCM field mapped to the user's groups. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Mobile Number | The CUCM field mapped to the user's mobile phone number. Default: mobileNumber |
|
|||||||||||||||||||||||||||||||||||||||||||||||
O | The CUCM field mapped to the user's custom organization name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Object Class | The CUCM field mapped to the user's object class. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Other Mailbox | The CUCM field mapped to the user's other mailbox. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Ou | The CUCM field mapped to the user's custom organization unit name. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Photo URL | The CUCM field mapped to the user's custom photo URL. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Physical Delivery Office Name | The CUCM field mapped to the user's post office. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Postal Code | The CUCM field mapped to the user's postal code. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Preferred Language | The CUCM field mapped to the user's preferred language. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Last Name * | The CUCM field mapped to the user's last name. Default: lastName |
|
|||||||||||||||||||||||||||||||||||||||||||||||
St | The CUCM field mapped to the user's state. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Street | The CUCM field mapped to the user's street. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Telephone Number | The CUCM field mapped to the user's telephone number. Default: telephoneNumber |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Timezone | The CUCM field mapped to the user's time zone. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Title | The CUCM field mapped to the user's title. Default: title |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Uid | The CUCM field mapped to the user's userid. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Unverified Mail Box | The CUCM field mapped to the user's unverified mailbox. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 1 | The CUCM field mapped to a custom string. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 2 | The CUCM field mapped to a custom string. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 3 | The CUCM field mapped to a custom string. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 4 | The CUCM field mapped to a custom string. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom String 5 | The CUCM field mapped to a custom string. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 1 | The CUCM field mapped to a custom list of strings. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 2 | The CUCM field mapped to a custom list of strings. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 3 | The CUCM field mapped to a custom list of strings. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 4 | The CUCM field mapped to a custom list of strings. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom List of Strings 5 | The CUCM field mapped to a custom list of strings. |
|