[Index]

Model: view/GlobalSIPVMIntegration

Overview

Full HTML Help

Overview

The Unity SIP integration tooling provisions complete SIP integration between redundantly deployed Cisco Call Managers (CUCM) and Cisco Unity Connection (CUC) servers. This integration tooling can be used to define the primary only integration that the legacy Voicemail Service provides.

The integration tooling provides a repeatable process to manage the integration of CUCM and CUC, while also providing the ability to:

Important

Contact your dedicated VOSS support representative for details on how to set up and configure the Unity SIP Integration feature.

Note

If this feature is not exposed in the Admin Portal menu layout, refer to "Unity SIP Integration - Menu Layout Changes and Access Profile Changes".

Unity SIP integration scope

The Unity SIP integration tooling provides support for:

Unity SIP Integration

Full HTML Help

Tip

Use the Action search to navigate Automate

The Unity SIP Integration feature can be used in place of your existing voicemail service. A list of menus items is available to carry out the Unity SIP Integration tasks. Unity SIP Integration provides SIP integration for both CUCM and CUC.

A typical workflow would be that one or more integration dial plan profiles are set up for use, and then a SIP Unity Integration is pushed to CUCM and CUC.

Menu Description
Integrate Unity-CallManager The main tool used to push integration between CUCM and CUC.
Remove Integrate Unity- CallManager This allows you to remove the complete integration out of the target CUCM and CUC.
Dial Plan Profile This allows an advanced administrator to define all of the dial plan elements that make up the CUC integration, for example device pools, route group, route list, CSSs, and so on.
Integration Log This log is populated with information about when the integration was pushed, as well as other details, so that it can be pulled back out again.
Unity Tenant Management A "tenant" is basically a small voicemail setup for a sub-company within your larger Connection server. In other words if you had companies sharing a single connection server for voicemail services, you can set each one up as a separate "tenant" in your install which effectively isolates them from one another. Note that a Unity server containing user data without tenants cannot have tenants added after the fact.
Unity Tenant Add This allows you to add a unity tenant to the Unity server.
Unity Tenant Delete This allows you to remove a unity tenant from the Unity server.

Integrate Unity-Call Manager

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

Integrate Unity-Call Manager is the main tool used to push integration between CUCM and CUC, allowing you to create a SIP integration between Cisco Unified Call Manager (CUCM) and Cisco Unity Connection (CUC).

You can select the following tabs on the Integrate Unity-CallManager page:

Configure the Integrate Unity-CallManager

  1. In the Automate Admin portal, go to Integrate Unity-CallManager.

  2. Fill out the following fields to auto-populate initial key values:

  3. Mandatory. On the Deployment Options tab/panel, fill out values for the following:

    Note

    The Unity Tenant(s) Present checkbox is selected by default if the Provisioning Target Unity server you selected on the UC Publisher Application Selection tab/panel contains tenants.

  4. View auto-populated settings on the CUCM Global tab/panel - these values auto-populate based on options selected for Voicemail Service Dial Plan Profile on the Deployment tab/panel:

  5. Complete at minimum the mandatory values on the following tabs:

Unity Port Group tab/panel

Complete, at minimum, the mandatory fields on this tab/panel:

Unity Ports tab/panel

Complete, at minimum, the mandatory fields on this tab/panel:

CUCM Voicemail Pilot tab/panel

Complete, at minimum, the mandatory fields on this tab/panel:

CUCM Voicemail Profile tab/panel

Complete the following fields, as required:

CUCM Route List tab/panel

Complete the following fields as required:

CUCM Route Group tab/panel

Complete the following fields as required:

CUCM to CUC Publisher SIP Trunk tab/panel

Complete, at minimum, the mandatory fields on this tab/panel:

CUCM to CUC Subscriber SIP Trunk tab/panel

Complete, at minimum, the mandatory fields on this tab/panel:

Note

This tab displays only if you've selected the Provision CUCM-Unity in Redundant Mode checkbox on the Deployment Options tab/panel.

Add or delete a Unity Tenant

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

The ability to add or delete Unity tenants assists in creating groups of objects in Unity Connection that provide a basic "tenant services" application. It allows you to create a tenant, which includes numerous interrelated database objects in Connection that work together to provide basic directory segmentation features to allow for isolated groups of users and handlers within your Connection server.

Add a Unity tenant

Note

The description, alias and SMTP Domain name must all be unique among tenants in your system.

  1. Go to Unity Tenant Add.
  2. Complete, at minimum, the following mandatory fields:
  3. Save your changes.

Delete a Unity tenant

Note

When deleting a tenant, ALL OBJECTS associated with that tenant are deleted as well. This means all users, call handlers, interviewers, schedules, COS etc. are deleted. There is NO UNDO for this. Make sure you really want to remove a tenant and all its objects before doing so.

  1. Go to Unity Tenant Delete.
  2. At Unity Tenant Name (Alias), select the tenant to delete.
  3. Click Save to remove the tenant.

Voicemail Integration offering redundancy

Model Details: view/GlobalSIPVMIntegration

Title Description Details
Provisioning Target Call Manager Provisioning Target Call Manager
  • Field Name: target_cucm
  • Type: String
Create Custom Unity Partition and CSS Create a unique partition/css for Unity Server Default: false
  • Field Name: options_partitionCUC
  • Type: Boolean
  • Default: false
Unity Tenant(s) Present Compulsory check for Unity Tenants Default: false
  • Field Name: options_tenantCUC
  • Type: Boolean
  • Default: false
Provision CUCM-Unity in Redundant Mode Provision Unity Subscriber Trunk and Ports to redundant systems Default: true
  • Field Name: options_SubTrunk
  • Type: Boolean
  • Default: true
Provisioning Target Unity Provisioning Target Unity
  • Field Name: target_cuc
  • Type: String
SIP Trunk Security Profile Add or choose existing SIP Trunk Security Profile
  • Field Name: ucm_stsp
  • Type: String
SIP Profile Choose existing or create a new SIP profile
  • Field Name: ucm_sp
  • Type: String
Device Name Primary SIP Trunk Device Name
  • Field Name: ucm_sipTrunk_P_DevName
  • Type: String
Description Primary SIP Trunk Description
  • Field Name: ucm_sipTrunk_P_Desc
  • Type: String
SRTP Allowed If you will enable Cisco Unified CM authentication and encryption, check this check box Default: false
  • Field Name: ucm_sipTrunk_P_SRTP
  • Type: Boolean
  • Default: false
Calling Search Space
  • Field Name: ucm_sipTrunk_P_CSS
  • Type: String
Redirecting Diversion Header Delivery - Inbound Redirecting Diversion Header Delivery - Inbound Tickbox Default: true
  • Field Name: ucm_sipTrunk_P_RedirectInbound
  • Type: Boolean
  • Default: true
Redirecting Diversion Header Delivery - Outbound Redirecting Diversion Header Delivery - Outbound Default: true
  • Field Name: ucm_sipTrunk_P_RedirectOutbound
  • Type: Boolean
  • Default: true
Destination IP Address IP Address of the target unity server
  • Field Name: ucm_sipTrunk_P_DestIP
  • Type: String
Destination Port Port of the target unity server trunk
  • Field Name: ucm_sipTrunk_P_DestPort
  • Type: String
Rerouting Calling Search Space Rerouting Calling Search Space
  • Field Name: ucm_sipTrunk_P_ReRouteCSS
  • Type: String
Trunk Device Pool Trunk Device Pool
  • Field Name: ucm_sipTrunk_P_DevicePool
  • Type: String
SIP Profile Trunk Sip Profile
  • Field Name: ucm_sipTrunk_P_SIPProf
  • Type: String
Device Name SIP Trunk Device Name
  • Field Name: ucm_sipTrunk_S_DevName
  • Type: String
Description SIP Trunk Description
  • Field Name: ucm_sipTrunk_S_Desc
  • Type: String
SRTP Allowed If you will enable Cisco Unified CM authentication and encryption, check this check box Default: false
  • Field Name: ucm_sipTrunk_S_SRTP
  • Type: Boolean
  • Default: false
Calling Search Space
  • Field Name: ucm_sipTrunk_S_CSS
  • Type: String
Redirecting Diversion Header Delivery - Inbound Redirecting Diversion Header Delivery - Inbound Tickbox Default: true
  • Field Name: ucm_sipTrunk_S_RedirectInbound
  • Type: Boolean
  • Default: true
Redirecting Diversion Header Delivery - Outbound Redirecting Diversion Header Delivery - Outbound Default: true
  • Field Name: ucm_sipTrunk_S_RedirectOutbound
  • Type: Boolean
  • Default: true
Destination IP Address IP Address of the target unity server
  • Field Name: ucm_sipTrunk_S_DestIP
  • Type: String
Destination Port Port of the target unity server trunk
  • Field Name: ucm_sipTrunk_S_DestPort
  • Type: String
Rerouting Calling Search Space Rerouting Calling Search Space
  • Field Name: ucm_sipTrunk_S_ReRouteCSS
  • Type: String
Trunk Device Pool Trunk Device Pool choice
  • Field Name: ucm_sipTrunk_S_DevicePool
  • Type: String
SIP Profile Trunk Sip Profile
  • Field Name: ucm_sipTrunk_S_SIPProf
  • Type: String
Pilot Number Unity Pilot for Route Pattern
  • Field Name: ucm_cuc_Pilot
  • Type: String
Calling Search Space Voicemail Pilot calling search space
  • Field Name: ucm_VoicemailPilot_CSS
  • Type: String
Voicemail Pilot Description Voicemail Pilot Description
  • Field Name: ucm_VoicemailPilot_Desc
  • Type: String
Default Voice Mail Pilot for the System Default Voice Mail Pilot for the System Default: false
  • Field Name: ucm_VoicemailPilot_DefaultPilot
  • Type: Boolean
  • Default: false
Unity Server Publisher Unity server selection
  • Field Name: cuc_server_P
  • Type: String
Unity Server Subscriber Unity Server Subscriber
  • Field Name: cuc_server_S
  • Type: String
Phone System Unity Phone System
  • Field Name: cuc_phoneSystem
  • Type: String
SIP Server Authentication Username Call Manager Authentication Username
  • Field Name: cuc_portGroup_username
  • Type: String
SIP Server Authentication Password Call Manager Authentication Password
  • Field Name: cuc_portGroup_password
  • Type: String
  • Is Password: True
SIP Security Profile (IP Port) SIP Security Profile Default: 5060
  • Field Name: cuc_portGroup_TCPport
  • Type: String
  • Default: 5060
  • Choices: ["5060", "5061/TLS"]
SIP Transport Protocol SIP Transport Protocol for CUCM Default: TCP
  • Field Name: cuc_portGroup_Protocol
  • Type: String
  • Default: TCP
  • Choices: ["TCP", "UDP"]
Primary CUCM IPv4 Address or Host Name Primary CUCM IPv4 Address or Host Name
  • Field Name: cuc_portGroup_CUCMIP
  • Type: String
Redundant SIP Servers
  • Field Name: cuc_portGroup_SIPServerArray.[n]
  • Type: Array
Call Manager Server IP or Host Name
  • Field Name: cuc_portGroup_SIPServerArray.[n].cuc_portGroup_SipServer
  • Type: String
Custom Unity Partition Name Custom Unity partition name for option
  • Field Name: cuc_customPartition
  • Type: String
Custom Unity CSS Name Custom Unity CSS Name
  • Field Name: cuc_customCSS
  • Type: String
Target CUCM IP
  • Field Name: target_cucm_ip
  • Type: String
Target CUCM BKEY
  • Field Name: target_cucm_bkey
  • Type: String
Target CUCM PKID
  • Field Name: target_cucm_pkid
  • Type: String
Target CUC IP
  • Field Name: target_cuc_ip
  • Type: String
Target CUC BKEY
  • Field Name: target_cuc_bkey
  • Type: String
Target CUC PKID
  • Field Name: target_cuc_pkid
  • Type: String
Ports Enabled Ports Enabled Default: true
  • Field Name: cuc_port_enabled
  • Type: Boolean
  • Default: true
Publisher Server Publisher Server
  • Field Name: cuc_port_PubServer
  • Type: String
Subscriber Server Subscriber Server
  • Field Name: cuc_port_SubServer
  • Type: String
Answer Calls Answer Calls Default: true
  • Field Name: cuc_port_AnswerCalls
  • Type: Boolean
  • Default: true
Perform Message Notification Perform Message Notification Default: true
  • Field Name: cuc_port_PerfMessNot
  • Type: Boolean
  • Default: true
Send MWI Requests Send MWI Requests Default: true
  • Field Name: cuc_port_MWI
  • Type: Boolean
  • Default: true
Allow TRAP Connections Allow TRAP Connections Default: true
  • Field Name: cuc_port_AllowTrap
  • Type: Boolean
  • Default: true
Publisher Port Count Unity Port Count
  • Field Name: cuc_port_PubCount
  • Type: String
  • Pattern: ^([01]?[1-9]?[0-9]|2[0-4][0-9]|25[0])$
Subscriber Port Count Unity Port Count
  • Field Name: cuc_port_SubCount
  • Type: String
  • Pattern: ^([01]?[1-9]?[0-9]|2[0-4][0-9]|25[0])$
Tenant Tenant Configured in Unity Connection
  • Field Name: cuc_tenant_alias
  • Type: String
CUC Tenant List this will only show 1 in the list but that is all we need to evaluate tenancy
  • Field Name: cuc_tenant_list
  • Type: String
Name Custom name of route list
  • Field Name: ucm_routeList_name
  • Type: String
Run On All Active Unified CM Nodes Run Route List On All Active Unified CM Nodes Default: true
  • Field Name: ucm_routeList_runAllNodes
  • Type: Boolean
  • Default: true
Call Manager Group Call Manager Group Assignment for Route List
  • Field Name: ucm_routeList_cucmGroup
  • Type: String
Name Route Group Name
  • Field Name: ucm_routeGroup_Name
  • Type: String
Distribution Algorithm Route Group Distribution Algorithm Default: Top Down
  • Field Name: ucm_routeGroup_distAlg
  • Type: String
  • Default: Top Down
  • Choices: ["Circular", "Top Down"]
Voicemail Service Dial Plan Profile Pre-Configured dial plan framework to reduce input
  • Field Name: vmDpProfile
  • Type: String
Dial Plan Advanced Mode enable editing of Dial Plan element live (Optional) Default: false
  • Field Name: dpAdvancedMode
  • Type: Boolean
  • Default: false
NOTES Important Notes Default: Please choose the Call Manager, Unity Cluster and Dial Plan Profile before proceeding. Several fields rely on this input to set proper values.
  • Field Name: notes
  • Type: String
  • Default: Please choose the Call Manager, Unity Cluster and Dial Plan Profile before proceeding. Several fields rely on this input to set proper values.
CUC Tenant Count
  • Field Name: cuc_tenantCount
  • Type: String
Name Voicemail Profile Name
  • Field Name: ucm_VMProfile_name
  • Type: String
Description Voicemail Profile Description
  • Field Name: ucm_VMProfile_desc
  • Type: String
Pilot
  • Field Name: ucm_VMProfile_pilot
  • Type: String
Voice Mail Box Mask Voice Mail Box Mask
  • Field Name: ucm_VMProfile_VMBoxMask
  • Type: String
Make this the default Voice Mail Profile for the System Make this the default Voice Mail Profile for the System Default: false
  • Field Name: ucm_VMProfile_default
  • Type: Boolean
  • Default: false
Route Pattern Partition Route Pattern Partition
  • Field Name: ucm_routePatternPT
  • Type: String