Easy UC for Cisco · Documentation

Complete technical documentation with all content on installation, provisioning and the end-user portal.

Introduction

Easy UC is a virtual appliance that radically simplifies the management of your Cisco Unified Communications environment. Save up to 90% of manual configuration work.

Concept at a glance

🖥️

Virtual Appliance (OVA)

A pre-configured Linux VM with everything needed: Easy UC service, database, web server.

🔌

CUCM API integration

Easy UC communicates via official CUCM APIs (AXL, RIS, CDR) – no changes to CUCM required.

🗂️

LDAP-driven

New users from Active Directory or LDAP are automatically detected and provisioned.

👤

Self-Service Portal

End users manage softphones, SNR, speed dials and block lists without IT tickets.

Main components

  • Easy UC Core – Provisioning engine, web interface, job scheduler
  • LDAP sync service – Detects changes in AD/LDAP in real time
  • Template engine – Manages configuration snapshots of CUCM devices
  • End-user portal – Dedicated subdomain for end-user self-service
💡
Demo license: 30-day free trial – full feature set, including setup support by our team.

Prerequisites

Easy UC has a few technical prerequisites to work in your CUCM environment.

Virtual Machine

ResourceMinimumRecommended
vCPU2 Cores4 Cores
RAM4 GB8 GB
Storage60 GB100 GB (SSD)
VMwareESXi 6.7ESXi 7.0+ / vSphere 8
Network1× vNIC1× vNIC, Static IP

Cisco UC environment

ComponentVersions
Cisco CUCM11.5 · 12.5 · 14 · 15
Cisco Unity Connection11.5+ (optional, for voicemail)
Cisco Jabber11+ (Windows/macOS/Mobile)
LDAP / Active DirectoryWindows Server 2012+ / OpenLDAP / 389DS

Network requirements

Easy UC communicates with various Cisco services. The following ports must be reachable from Easy UC to CUCM:

ServiceTargetPortProtocol
CUCM AXL APICUCM Publisher8443HTTPS
CUCM RISCUCM Publisher8443HTTPS
CUCM CDR (FTP/SFTP)Easy UC22 / 21SFTP / FTP
Unity Connection RESTUnity Publisher8443HTTPS
LDAPAD/LDAP Server389 / 636LDAP / LDAPS
SMTPMail Relay25 / 587SMTP
Easy UC WebEasy UC443HTTPS
⚠️
Firewall: Make sure CUCM can communicate back to Easy UC (port 443) – only then do API calls work in both directions.

OVA installation

Installation of Easy UC is done in just a few steps. Typical setup time is about 1 hour.

Step by step

Get portal access

After your request is processed, we send you credentials for our customer portal by email. There you find the current OVA version, release notes, license and support areas.

Download OVA

Under "Downloads → OVA Files" in the customer portal the current version is available. We recommend always using the latest stable version. File size: ~3 GB.

Deploy OVA in VMware

Via the vSphere Web Client under Hosts and Clusters → Deploy OVF Template. Select the OVA file, give the VM a name and choose datastore and network. Resources are taken from the OVF profile.

Power on VM

After the first start, the VM console shows a DHCP-assigned IP address. This is temporary – in the next step we set a static address.

Configure network

See the Network Configuration section for details. After that Easy UC is reachable in the browser at https://<ip>/setup.

Run the web installer

The web installer guides through CUCM connection, LDAP integration, first admin account and license import. Duration: ~15–30 minutes.

Activate license

After setup, you create a license request which we answer within one business day with a 30-day demo license.

Network configuration

After first boot, configure the static IP address directly in the VM console.

Set static IP

  1. Open the VM console in vSphere
  2. Sign in with the default account: easyuc / easyuc
  3. Start the network setup tool: sudo easyuc-network
  4. Enter the following values:
ParameterExample
IP address10.10.20.50
Subnet mask255.255.255.0
Gateway10.10.20.1
DNS Primary10.10.10.10
DNS Secondary10.10.10.11
Hostnameeasyuc-prod
Domaincompany.local

After confirmation the network stack restarts. Easy UC is then reachable in the browser at the configured IP.

Tip: Add the Easy UC IP address to your internal DNS (e.g. easyuc.company.local). This simplifies later references and CUCM configuration.

Web installer

The web installer is a browser-based wizard that guides through the initial configuration of Easy UC.

Configuration phases

1️⃣

CUCM connection

FQDN/IP of the publisher, AXL service user credentials, test connection.

2️⃣

LDAP integration

LDAP server, bind DN, search base, sync interval.

3️⃣

Admin account

Creates the first Easy UC administrator (own credentials).

4️⃣

License

Create a license request or import existing license.

Updating the web installer

Easy UC and the web installer are updated in independent cycles. Via the admin interface under System → Updates the web installer can be brought to the latest version manually.

📌
AXL service user: In CUCM under User Management → Application User create a user with the roles Standard AXL API Access, Standard CCM Admin Users and Standard CTI Enabled.

Licensing

Easy UC is available as a demo and production license. Both grant the full feature set.

License types

🎁

Demo license

30 days free · Full features · Setup support included · Sent automatically after license request.

💼

Production license

Custom pricing · Subscription or perpetual · Maintenance & updates · Enhanced support · On request.

Create a license request

  1. In the web installer (or under System → License) click "Create license request"
  2. Easy UC generates a signed request with server ID and desired modules
  3. Download the file and send it to our team
  4. Within one business day you receive the license file in return
  5. Upload it in the same menu under "Import license"

Disk expansion

If the disk fills up due to CDR imports or logs, the virtual disk can be expanded:

  1. Shut down the VM in vSphere
  2. Under VM Hardware → Disk set the new size
  3. Restart the VM
  4. In the console: run sudo easyuc-disk-extend
  5. The filesystem is expanded automatically

Locations

Locations map physical sites to Cisco CUCM concepts such as Device Pools and number ranges.

Concept

Every location bundles:

  • Geographic data (city, country, address) – also usable for emergency routing
  • CUCM Device Pool – to which all created devices are assigned
  • E.164 number ranges – from which Easy UC pulls free numbers during onboarding
  • Default package – the configuration new users at this location get by default
  • Assignment rules – the logic used to assign users to this location

Three assignment modes

🏷️

Custom User Field

Evaluation of an LDAP attribute (e.g. department, physicalDeliveryOfficeName). Recommended for clear HR structures.

📞

Phone Numbers

Assignment based on the already assigned number (E.164 range). Recommended with an existing number plan.

✍️

Normal Mode

Manual assignment via the Easy UC interface. Recommended for edge cases or pilot groups.

Create location

Navigate to Configuration → Locations

In the Easy UC admin interface click "+ New Location".

Enter master data

Name, country, city, address (for Emergency Calling), time zone and language.

Configure CUCM mapping

Assign Device Pool, Common Device Configuration, Region, Date/Time Group, Calling Search Spaces.

Add number ranges

Define one or more E.164 ranges, e.g. +4940604294800 – +4940604294899.

Choose assignment mode

Choose and configure Custom User Field, Phone Numbers or Normal Mode.

Assign default package

Which package is used automatically for new users at this location.

Packages & Templates

Templates are configuration snapshots of your CUCM devices. Packages group templates logically.

Understanding templates

A template is a snapshot of an existing CUCM device. Easy UC reads the complete device configuration from CUCM and stores it as a blueprint. When provisioning a new device, the template is copied and only user-specific fields (MAC, description, owner) are overwritten.

Templates are recommended per device type and location:

  • IP Phone templates – Cisco 7841, 8841, 8851, 9971 etc.
  • Softphone templates – Jabber Windows (CSF), Mac (TCT), Mobile (TAB / BOT)
  • Remote Destination templates – for Single Number Reach

Create template

  1. Create a reference device directly in CUCM with the desired configuration
  2. In Easy UC under Templates → New Template
  3. Choose the device type and source device from the CUCM cluster
  4. Easy UC reads the configuration and saves it as a template
  5. Name the template meaningfully (e.g. HH_8841_Standard)

Copying templates

Templates can be duplicated across locations – without recreating a reference device. When copying, location-specific fields (Device Pool, CSS, Locations) are adapted to the target location.

Understanding packages

A package is a logical group of templates. Examples:

PackageContainsUse case
StandardIP Phone 8841Regular staff
ManagerIP Phone 8851 + Jabber Win + SNRManagement
MobileJabber Win + Jabber MobileField sales
ReceptionIP Phone 9971 + Pickup GroupReception

A default package can be defined per location, which is used automatically during Auto User Setup.

💡
Tip: Keep the number of packages manageable. Three to five well-defined packages usually cover 95% of all use cases.

User management

The central user page shows all aspects of a CUCM user in one place.

User Basics

In the <em>User Basics</em> area you manage the core properties of a user that are normally maintained via the CUCM admin interface:

FieldDescription
Telefon-PIN4–8 digits, for voicemail and Extension Mobility
PasswordFor CUCM Self-Care & Jabber login (local users only)
Home ClusterIn multi-cluster environments, the primary CUCM
IM & PresenceActivates Jabber chat features
User LocaleLanguage and locale for phone menus
RolesCUCM permission roles (Standard CCM End User etc.)

Directory Number Settings

Every assigned Directory Number has its own settings:

  • Display Caller ID – How the number appears to the called party
  • External Phone Number Mask – Masking for outbound calls
  • Call Forward – No Answer, Busy, All Calls (target and voice mailbox)
  • Voicemail profile – Which Unity profile is active
  • Calling Search Space – Which routes this number may use
  • Maximum Number of Calls / Busy Trigger – Call behavior
📌
Note: A user's assigned number is only active once a device (IP phone, softphone) is associated with it.

Devices

Each user can have any number of devices assigned – IP phones, softphones and Remote Destinations.

Add a device

Open the user

Navigate to the target user, click the "Devices" tab.

Click "+ Add Device"

Choose the device type and matching template (e.g. HH_8841_Standard).

Enter MAC address

IP phones require a MAC. For softphones, Easy UC generates a unique device ID automatically.

Trigger provisioning

Easy UC copies the template, adjusts user-specific fields and creates the device in CUCM. Duration: 2–5 seconds.

Phone Recreation

If a device was accidentally deleted from CUCM, it can be restored with one click using the Recreate function. Easy UC stores the last known configuration and can replay it 1:1.

⚠️
Important: The restored configuration matches the state of the last Easy UC sync. Manual CUCM changes since the last sync may be lost.

Pickup & Hunt Groups

Pickup Groups and Hunt Groups are CUCM concepts for call distribution. Easy UC simplifies their management.

Pickup Groups

A Pickup Group lets you answer a call ringing at a colleague's phone – via key combination or soft key.

  • In the user profile under "Pickup Groups" the user can be assigned to one or more groups
  • New Pickup Groups are created directly in CUCM and are immediately available
  • Easy UC shows the assigned members for each Pickup Group

Hunt Groups

A Hunt Group distributes incoming calls across multiple members (Sequential, Longest Idle, Broadcast, Circular).

  • Hunt Pilot, Hunt List and Line Group are managed together via Easy UC
  • Members can be added or removed via drag-and-drop
  • Easy UC shows for each user at a glance in which Hunt Groups they are a member

Call Detail Records (CDRs)

CUCM creates a CDR for every call. Easy UC imports these and shows them directly in the user profile.

Data source

CDRs are sent from CUCM to Easy UC via FTP/SFTP. In CUCM under Serviceability → CDR Management Easy UC is added as a Billing Server. Easy UC imports files hourly and parses them into its internal database.

Analytics

  • Per user – call history directly in the user profile
  • Hunt Group reporting – Number of calls, who answered, average wait time
  • Global reports – Top callers, top destinations, utilization per location
📌
Note: CDRs contain personal data. Easy UC supports configurable retention periods and automatic anonymization according to GDPR.

Quick Tasks

Recurring tasks are available as Quick Tasks – done with a few clicks.

📋

Copy User

Creates a new user with the configurations of an existing user. Ideal for "Person X moves to the same job as Person Y".

🗑️

Delete User

Removes a user including all devices, group memberships and voicemail. With confirmation prompt and audit log.

🔄

Replace User

Transfers all devices and configurations from one user to another. Example: employee A leaves, employee B takes over.

Copy User – step by step

  1. Select the source user
  2. Click Quick Tasks → Copy User
  3. Select the target user (must already exist in LDAP)
  4. Select which elements to copy:
    • ☑ Devices & Templates
    • ☑ Directory Number Settings
    • ☑ Pickup Groups / Hunt Groups
    • ☐ Voicemail box (separate provisioning recommended)
  5. Confirm – Easy UC executes all steps automatically

Auto User Setup

Whenever a new user is imported into CUCM via LDAP, Easy UC automatically provisions all resources.

Workflow

LDAP sync detects new user

During the regular CUCM LDAP sync (typically every 6h) Easy UC detects the new user.

Location assignment

Based on the configured assignment rules (Custom Field / Phone Number) the location is determined.

Apply package

The location's default package is applied. Optionally a different package can be chosen by an LDAP attribute (e.g. title = Manager → Manager package).

Create devices

All devices from the package are created in CUCM: IP phone (if MAC known), Jabber softphones, Remote Destinations.

Create voicemail

If enabled, a mailbox is automatically created in Unity Connection.

Email report

Easy UC sends a daily report to the defined admin distribution list with all actions.

Synchronizing LDAP name changes

When a user is renamed in LDAP (marriage, divorce, etc.), Easy UC detects this on the next sync and automatically updates:

  • Display name on all of the user's devices
  • Caller ID configuration
  • Display Caller ID on Hunt Groups where the user is a member
  • Voicemail display name
Recommendation: Enable Auto User Setup only after all locations and packages are properly configured. Otherwise misconfigurations roll out broadly.

Wizard / Bulk operations

For large rollouts or location moves Easy UC provides a wizard for bulk actions.

Select users

Via CSV import

Upload a CSV with a "userid" (or "mail") column. Easy UC matches users and adds them to the selection.

userid,department,location
mmueller,Sales,Hamburg
aschmidt,Marketing,Berlin
tklein,Support,Hamburg

Select manually

Add individual users via the search function. Filter by location, department or device type is possible.

Bulk actions

  • Apply Package – Apply a package to all selected users
  • Move Location – Change location for all (incl. new number from the pool)
  • Change Template – Swap template on all devices
  • Add to Pickup/Hunt Group – Bulk group assignment
  • Mass Voicemail Reset – Reset PINs, re-initialize mailboxes

Voicemail

Voicemail boxes in Cisco Unity Connection can be managed directly from Easy UC.

Create voicemailbox

  1. In the user profile → "Voicemail" tab
  2. Click "Create Voicemailbox"
  3. Choose template (e.g. Standard_EN with English language and default greetings)
  4. Extension is taken automatically from the primary number
  5. Initial PIN is generated automatically and can be sent to the user by email

Greetings

Easy UC allows central upload and assignment of voicemail greetings:

  • Standard Greeting – Regular greeting
  • Closed Greeting – Outside business hours
  • Busy Greeting – When line is busy
  • Internal Greeting – Audible only to internal callers
  • Alternate Greeting – E.g. vacation announcement

Mailbox access

Easy UC offers a quick action "Send Mailbox Access Link" – it sends an email with credentials and a direct link to the Unity Connection web interface.

Number plan

The visual number plan shows all numbers of your CUCM cluster at a glance.

Features

  • Filter by location – Show only numbers of the selected location
  • Status – Free / Used / Reserved / Hunt Pilot / Conference Bridge etc.
  • Assignment – Who has the number, which device
  • Free-range view – See at a glance where gaps have appeared
  • Bulk reservation – Reserve multiple numbers at once for a project

Writing numbers back to LDAP

Easy UC can automatically write assigned numbers back to the LDAP attribute telephoneNumber (or a configurable field). This keeps the directory consistent and Outlook / Teams show the correct numbers.

📌
LDAP write permission: For Easy UC to write to LDAP, the bind user needs write rights on the telephone number attribute.

Daily provisioning tasks

The most common provisioning tasks explained step by step.

Create user

Regular user creation happens via LDAP sync and Auto User Setup. Manual creation:

  1. Users → New User
  2. Enter UserID (must be unique) and display name
  3. Choose location and package
  4. Adjust any special requirements (PIN, language, permissions)
  5. "Create" – Easy UC creates user & devices in CUCM

Change phone number

  1. Open user → "Directory Number" tab
  2. Select current number from dropdown → "Change Number"
  3. Choose new number from the pool (only free numbers shown)
  4. Optionally: enable "Update LDAP entry" checkbox
  5. Confirm – Easy UC updates DN on all devices and in CUCM

Change names on phones

Easy UC updates the display name (e.g. after marriage) on all devices and Pickup/Hunt groups with a single click. Quick Tasks → Update Display Name.

Set Call Forward

  1. Open user → "Directory Number" tab
  2. In the "Call Forward" area choose one of the profiles (All Calls / Busy / No Answer)
  3. Enter target number (external: with area code, internal: extension only)
  4. "Voice Mail" as target is directly selectable via checkbox
  5. Save – CUCM configuration is updated immediately

Set up Single Number Reach

SNR makes an incoming call to the office number also ring on the mobile phone in parallel:

  1. Open user → "Remote Destinations" tab
  2. "+ Add Remote Destination" → enter mobile number
  3. Optionally: set ringing times (e.g. Mon-Fri 08:00–18:00)
  4. Choose template Mobile_SNR_Standard
  5. Save – SNR is immediately active

Add Pickup / Hunt Group

Open user → "Groups" tab → select the group via search → "Add". Easy UC updates the member list in CUCM in real time.

IP phone without user

For conference room phones, lobby phones etc. devices can be created without user assignment:

  1. Devices → New Device → Standalone
  2. Choose template, enter MAC address
  3. Maintain description (e.g. "Conference room Moon, 4th floor")
  4. Optionally: pickup group or hunt group membership

End-user portal

The self-service portal gives end users control over their own configuration – no IT ticket required.

Features for end users

💻

Request softphone

Employees request Jabber Windows / Mac / iOS / Android themselves. Easy UC creates the softphone automatically and sends installation instructions.

📲

Single Number Reach

Forward calls to the office number to the mobile in parallel. With time control and toggle button.

📒

Personal directory

Add personal contacts, group them and sync across all devices.

🚫

Block numbers

Block unwanted callers via self-service – no IT ticket required.

Speed dials

Assign speed dial keys on the IP phone yourself – no CUCM admin access required.

🌍

Multilingual

Portal available in German and English – more languages on request.

Authentication

Login is either via LDAP/AD (Single Sign-On) or via SAML/OAuth with your Identity Provider (Azure AD, Okta, Keycloak). Optionally classic login with CUCM end-user credentials is possible.

Configure permissions

You can configure per location or per user group which features are available in the end-user portal. For example, field staff can activate SNR themselves while inside staff may only configure speed dials.

Dashboard & Logs

The Easy UC dashboard provides an overview of the environment at any time.

Easy UC logs

All system activity is logged:

  • Provisioning log – Which devices/users were created/changed/deleted and when
  • Admin audit – Who signed in and which configuration changes were made
  • System log – Connection errors, service restarts, update operations
  • API calls – Incoming and outgoing API calls (for troubleshooting)

Automatically Setup Log

Special log for Auto User Setup. Shows for each auto-provisioning:

  • LDAP sync time
  • Detected new users
  • Applied location and package assignment
  • Created devices with success/error status
  • Sent email reports

Phone registration history

Which phones are currently registered with CUCM? Easy UC collects this via the RIS API:

  • Status: Online / Offline / Unregistered
  • Last registration time
  • Phone IP address
  • Firmware version
  • Connected switch port (LLDP)
Tip: Configure alerts (email or webhook) when critical phones (e.g. reception, emergency hotline) are unregistered for more than 5 minutes.

Troubleshooting

AXL connection fails

Cause: Wrong credentials or missing permissions for the service user.
Fix: In CUCM ensure the Application User has the roles Standard AXL API Access, Standard CCM Admin Users and Standard CTI Enabled. Password must not contain characters requiring URL-encoding.

LDAP sync finds no users

Cause: Search base too restrictive or bind user lacks read permissions.
Fix: Set search base to a higher OU, test with ldapsearch from the Easy UC console, check bind user permissions.

Disk full

Cause: CDR import or logs fill the disk.
Fix: Adjust retention policies under System → Retention, or expand the disk as described in "Disk expansion".

Web installer does not start

Cause: Outdated version or corrupted installation.
Fix: In the VM console run sudo systemctl restart easyuc-webinstaller. If errors persist, contact Easy UC support.

Phone shows "Configuration mismatch"

Cause: Template configuration in Easy UC differs from TFTP configuration in CUCM.
Fix: In CUCM click the phone → "Apply Config" → "Reset". Easy UC re-syncs the configuration in the background.

Need more help?

Our support team assists with all questions around setup and operation. During the demo phase, support is fully free. → Contact us