Get started with the Provisioning Manager System Administration Guide

117 Pages·2017·4.17 MB·English

Akkadian Provisioning Manager 4.12

System Administration Guide

Updated – November 9th, 2017
Copyright and Trademarks:

I. Copyright:

This website and its content is copyright © 2017 Akkadian, LLC. All rights reserved.
Except with the prior written permission of Akkadian, LLC, any redistribution or reproduction
of part or all of the contents of this website, including the redistribution or reproduction of any
documentation or other materials downloaded from this website, in any form and in any
media, is prohibited.

II. Trademarks:
Akkadian, the Akkadian logo and other trademark or service marks used on this website,
whether registered or not, are the property of Akkadian, LLC and may not be used or
reproduced without the prior written permission of Akkadian, LLC.

aPME UG 1/8/2017 0001 © http://www.akkadianlabs.com/apme/
Table of Contents
Task List for Installing and Configuring Akkadian Provisioning Manager 4.12 ................................................................ 5
Section 1.0 – System Requirements for Akkadian Provisioning Manager 4.12 ................................................................ 8
1.1 - Provisioning Manager 4.12 – Server Requirements .................................................................................................................................... 8
1.2 – Cisco Unified Communications Application Requirements ....................................................................................................................... 8
1.3 – SMTP Requirements ....................................................................................................................................................................................... 9
1.4 – Web Browser Requirements ......................................................................................................................................................................... 9
1.5 – Firewall Ports .................................................................................................................................................................................................. 9
Section 2.0 – Preparing Cisco Unified Communications Manager for Provisioning Manager Express ....................... 10
2.1 - Activate the AXL Web Service ....................................................................................................................................................................... 10
2.2 – Create Provisioning Manager CUCM Application User ............................................................................................................................. 10
Section 3.0 – Preparing Cisco Unified Contact Center Express for Provisioning Manager Express ............................. 12
3.1 – Assigning a user Cisco Unified CCX Administrator capability .................................................................................................................. 12
Section 4.0 – Preparing Cisco Unity Connection for Provisioning Manager Express ..................................................... 13
4.1 – Creating a Cisco Unity Connection System Administration Account ...................................................................................................... 13
Section 5.0 – Akkadian Provisioning Manager for Windows ............................................................................................. 14
Section 6.0 – Deploying the Akkadian Provisioning Manager Virtual Appliance ............................................................ 15
Section 7.0 – Akkadian Provisioning Manager Initial Configuration ................................................................................ 25
7.0.1 – Logging into Akkadian Provisioning Manager ........................................................................................................................................ 25
7.1 – Email Configuration ............................................................................................................................................................................ 26
7.2 – Single Sign-on Configuration ............................................................................................................................................................. 27
7.3 – Akkadian Provisioning Manger 4.12 SSL Configuration .................................................................................................................. 28
7.3.1 – Generating an SSL Certificate Signing Request (CSR) ............................................................................................................................ 28
7.3.2 – Uploading SSL Certificates ........................................................................................................................................................................ 29
7.4 – LDAP Agreement Configuration ........................................................................................................................................................ 30
7.5 – Installing a Provisioning Manager Express License......................................................................................................................... 31
7.6 – Integrating Application Servers with Provisioning Manager Express ............................................................................................ 32
7.6.1 – Integrating CUCM Application Servers .................................................................................................................................................... 32
7.6.2 – Integrating CUC Application Servers ....................................................................................................................................................... 34
7.6.3 – Integrating Cisco UCCX Application Servers ........................................................................................................................................... 35
7.6.4 – Integrating Cisco Packaged UCCE Servers .............................................................................................................................................. 36
7.6.5 – Integrating Cisco WebEx Application Servers ......................................................................................................................................... 37
7.7 – Configuring Service Groups ............................................................................................................................................................... 38
7.7.1 – Enable the Self-Service Portal .................................................................................................................................................................. 41
7.7.2 – Branding the Self-Service Portal .............................................................................................................................................................. 42
7.8 – Adding Security Groups and Permissions ........................................................................................................................................ 43
7.9 – Assigning Access to Service Groups ................................................................................................................................................. 44
7.10 – Configuring Users ............................................................................................................................................................................. 46

Akkadian Provisioning Manager 4.12 System Administration Guide 2
7.11 – Configuring Filter Templates ........................................................................................................................................................... 47
7.12 – Configuring DN Pools ....................................................................................................................................................................... 49
7.13 – Configuring License Pools ............................................................................................................................................................... 51
7.14 – Configuring Global Variables ........................................................................................................................................................... 53
7.15 – Configuring Device Pools Groups ................................................................................................................................................... 55
7.16 – Log Archive Configuration ............................................................................................................................................................... 56
7.17 – Configuring Email Templates .......................................................................................................................................................... 57
Section 8.0 - Getting Started with Templates in Akkadian Provisioning Manager 4.12 ................................................. 58
Section 8.1 – Using Provisioning Variables ............................................................................................................................................... 59
Section 8.2 – Creating Add Templates ....................................................................................................................................................... 62
Section 8.2.1 – Creating Add Speed Dial Templates .......................................................................................................................................... 62
Section 8.2.2 – Creating Add Voice Mail Profile Templates ............................................................................................................................... 63
Section 8.2.3 – Creating Add User Templates ..................................................................................................................................................... 65
Section 8.2.4 – Creating Add Line Templates...................................................................................................................................................... 66
Section 8.2.5 – Creating Add Device Templates ................................................................................................................................................. 68
Section 8.2.6 – Creating Add CUC Voice Mail Templates ................................................................................................................................... 69
Section 8.2.7 – Creating Add WebEx Templates ................................................................................................................................................. 70
Section 8.2.9 – Creating Site Templates .............................................................................................................................................................. 71
Section 8.3 – Editing Templates in Akkadian Provisioning Manager 4.12 .............................................................................................. 74
Section 9.0 – Getting Started with Jobs Templates in Akkadian Provisioning Manager 4.12........................................ 76
Section 10.0 – Getting Started with Provisioning in Akkadian Provisioning Manager 4.12 .......................................... 81
Section 10.1 – Bulk Provisioning ................................................................................................................................................................ 83
Section 10.2 – Scheduled Bulk Provisioning ............................................................................................................................................. 84
Section 10.3 – Using the Extension Mobility Tool ..................................................................................................................................... 85
Section 10.4 – Using the Swap Feature ..................................................................................................................................................... 86
Section 10.4.1 – Using the Device Swap Feature ................................................................................................................................................ 86
Section 10.4.2 – Using the User Swap Feature ................................................................................................................................................... 87
Section 10.5 – Using Bulk Swap .................................................................................................................................................................. 88
Section 10.6 – Using the CMC/FAC Editor.................................................................................................................................................. 90
Section 10.7 – Using the Visual Phone Editor ........................................................................................................................................... 91
Section 10.8 – Using Phone Control........................................................................................................................................................... 92
Section 10.9 – CUC Voice Mailbox Scheduled Delete Service.................................................................................................................. 95
Section 11.0 – FTP Server Configuration ............................................................................................................................. 97
Section 12.0 – Configuring Backup and Restore ................................................................................................................ 98
Section 13.0 – Performing System Updates........................................................................................................................ 99
Section 14.0 – Reporting ..................................................................................................................................................... 100
Section 15.0 – Updating the Default PMEAdmin Password ............................................................................................ 102
Section 16.0 – Getting Started with the REST API in Akkadian Provisioning Manager 4.12 ........................................ 103

Akkadian Provisioning Manager 4.12 System Administration Guide 3
Section 17.0 – Configuring the Self-Provisioning Service in Akkadian Provisioning Manager 4.12 ........................... 110
Section 17.1 – Configuring Device Default Template Mappings for the Self-Provisioning Service ............................................................ 110
Section 17.2 – Method 1 - Deploying Self-Provisioning using an IP Phone Service ..................................................................................... 111
Section 17.3 – Method 2 - Deploying Self-Provisioning with Auto-registration ............................................................................................ 113
Section 18.0 – Configuring Active Directory Auto Provisioning in Akkadian Provisioning Manager 4.12 ................. 115

Akkadian Provisioning Manager 4.12 System Administration Guide 4
Task List for Installing and Configuring Akkadian Provisioning
Manager 4.12

To install and configure Akkadian Provisioning Manager 4.12 complete the following tasks in
the order presented:

1. Review the requirements for deploying Akkadian Provisioning Manager 4.12 in Section 1
– “System Requirement for Akkadian Provisioning Manager 4.12”.

2. Configure Cisco Unified Communications Manager for AXL API access. See Section 2.0 –
“Preparing Cisco Unified Communications Manager for Provisioning Manager 4.12”.

3. Optional – Configure Cisco Contact Center Express for REST API access. See Section 3.0 –
“Preparing Cisco Unified Contact Center Express for Provisioning Manager 4.12”. If you
are not using Unity Connection, please proceed to step 4.

4. Optional – Configure Cisco Unity Connection for REST API access. See Section 4.0 –
“Preparing Cisco Unity Connection for Provisioning Manager 4.12”. If you are not using
Unity Connection, please proceed to step 4.

5. Install Akkadian Provisioning Manger 4.12. Section 6.0 – “Deploying the Akkadian
Provisioning Manager 4.12 Virtual Appliance”.

6. Log in to Provisioning Manager 4.12 to perform the initial configuration – See Section 7.0
“Akkadian Provisioning Manager 4.12 Initial Configuration”.

7. Configure the SMTP Host for password recovery and notifications. See Section 7.1 –
“Akkadian Provisioning Manager 4.12 Email Configuration”.

8. Optional – Upload SSL Certificate and Key. See Section 7.3 – “Akkadian Provisioning
Manger 4.12 SSL Configuration”.

9. Optional – Configure LDAP authentication. See Section 7.4 – “Akkadian Provisioning
Manger 4.12 LDAP Configuration”. This is only required if you wish to utilize LDAP
authentication to access Provisioning Manager 4.12; otherwise proceed to the next step.

10. Upload the license file. See Section 7.5 – “Akkadian Provisioning Manger 4.12 Licensing”.
If you are trialing Akkadian Provisioning Manager, this step is optional.
11. Add Applications Servers such as Cisco Unified Communications Manager and Cisco
Unity Connection. See Section 7.6 – “Adding Application Servers to Akkadian
Provisioning Manger 4.12”.

12. Configure Service Groups to provide provision access to your Application Servers. See
Section 7.7 – “Configuring Service Groups in Akkadian Provisioning Manger 4.12”.

13. Optional – Add Groups and Permissions. See Section 7.8 – “Adding Groups and
Permissions in Akkadian Provisioning Manager 4.12”. The built-in groups can be used to
provide access to Provisioning Manager 4.12. Custom Groups should be used for greater
flexibility and security.

14. Associate Service Groups to User Groups to provide access to provision in Application
Servers. See Section 7.9 – “Assigning Access to Service Groups in Akkadian Provisioning
Manager 4.12”.

15. Create Users and assign them to Groups. See Section 7.10 – “Configuring Users in
Akkadian Provisioning Manager 4.12”. The PMEAdmin user has no provisioning rights
and should not be used for daily system administration. At least one user with System
Administrator permissions will be required to complete the Provisioning Manager 4.12
configuration. Please note the username and password for this user, as it will be
required for Step 16.

16. Log out of Provisioning Manager 4.12 as PMEAdmin and log back in using the user with
Administrator privileges created in Step 15.

17. Optional – Create Filter Templates to limit device and data for Provisioners. See Section
7.11 – “Configuring Filter Templates in Akkadian Provisioning Manager 4.12”.

18. Optional – Create DN Pools to streamline Directory Number assignment during
provisioning. See Section 7.12 – “DN Pool Management in Akkadian Provisioning
Manager 4.12.”

19. Optional – Create Global Variables to simplify the provisioning process. See Section 7.13
– “Configuring Global Variables in Akkadian Provisioning Manager 4.12”. Global
Variables are optional, though they are necessary to streamline the provisioning
process.

20. Configure Provisioning Manager 4.12 Templates. See Section 8.0 - “Getting Started with
Templates in Akkadian Provisioning Manager 4.12”. Templates are the core of

Akkadian Provisioning Manager 4.12 System Administration Guide 6
Provisioning Manager 4.12 and the number and types of Templates will differ depending
on the environment. Section 7.0 will help you understand how to best utilize Templates
in Provisioning Manager Express.

21. Create provision Actions. See Section 9.0 – “Getting Started with Jobs in Akkadian
Provisioning Manager 4.12”. Actions Templates combine one or more Provisioning
Templates to create a single template.

22. Start Provisioning. Use Action Templates to start provisioning in your environment. See
Section 10.0 – “Getting Started with Provisioning in Akkadian Provisioning Manger 4.12”.

23. Optional - Updating the PMEAdmin password. For security purposes, it is best practice to
change the PMEAdmin password. See Section 15.0 – “Updating the PMEAdmin Password
in Akkadian Provisioning Manager”.

24. Backup the system. It is recommended to backup the system when your configuration is
complete as described in Section 12.0 – “Backup and Restore in Akkadian Provisioning
Manager 4.12”.

Akkadian Provisioning Manager 4.12 System Administration Guide 7
Section 1.0 – System Requirements for Akkadian Provisioning
Manager 4.12

1.1 - Provisioning Manager 4.12 – Server Requirements

Akkadian Provisioning Manager 4.12 is available for as a Linux Virtual Appliance. It was developed
to run in a virtual environment on VMware ESXi 4.x and above.

The recommended server requirements for Akkadian Provisioning Manager 4.12 are based on
several variables. To assist with allocating the proper resources for Provisioning Manager 4.12, use
the Table 1.1.1 to determine the appropriate system resources.

Table 1.1.1 - System Requirements Guideline
System
Requirements
Devices (Phones
Guideline or Device Profiles) Application Servers* vCPU* vRAM vDisk (Thick) vNIC
SRG - 1 5000 10 1 4 GB 1x 110 GB 1
SRG - 2 15,000 20 2 4 GB 1x 110 GB 1
SRG - 3 30,000 40 2 6 GB 1x 110 GB 1
SRG - 4 60,000+ 60+ 4 8 GB 1x 110 GB 1
* Applications servers are defined as configured applications servers in Provisioning Manager and is not related
to the number of servers with a cluster.
* Minimum of 2000 MHz reserved

1.2 – Cisco Unified Communications Application Requirements

Table 1.2.1
Application Supported Versions
Cisco Unified Communications Manager 9.x – 11.x
Cisco Unified Contact Center Express 10.x – 11.x
Cisco Unity Connection 9.x - 11.x

Akkadian Provisioning Manager 4.12 System Administration Guide 8
1.3 – SMTP Requirements

Akkadian Provisioning Manager 4.12 requires an SMTP server to send users their initial
password as well as important notifications. Ensure Provisioning Manager Express is
authorized to send mail via the configured SMTP server.

1.4 – Web Browser Requirements

• Microsoft Internet Explorer 10+
• Microsoft Edge 39+
• Mozilla Firefox 53+
• Chrome 50+

** Previous browser versions may function, but are not officially supported.

1.5 – Firewall Ports

If Akkadian Provisioning Manager 4.12 is located behind a firewall, the ports in Table 1.5.1 are
required for proper communication.

Table 1.5.1
Traffic Port Direction
Application Web Access HTTPS:443 Inbound --> Provisioning Manager
Communication to Cisco
Communications Manager via HTTPS:8443 Outbound Provisioning Manager --> CUCM
AXL/SOAP API
Communication to Cisco Unity
HTTPS:8443 Outbound Provisioning Manager --> CUC
Connection via REST API
Communication to WebEx HTTPS:8443 Outbound Provisioning Manager --> WebEx
HTTPS:443 / TCP
Communication to UCCE Outbound Provisioning Manager --> UCCE
1443
FTP between application and Outbound Provisioning Manager --> SFTP
TCP Port 21
backup server Server
Secure FTP between Outbound Provisioning Manager --> SFTP
TCP Port 22
application and backup server Server
Outbound Provisioning Manager --> SMTP
SMTP mail to mail server TCP Port 25
Server
TCP/UDP Ports 389
or Secure 636 / 3268
Outbound Provisioning Manager --> LDAP
LDAP authentication & 3269 for AD
Server
Global Catalog
Server
Outbound Provisioning Manager --> SSO
SSO (SAML) TCP Port 443
Server
Outbound Provisioning Manager --> NTP
Network Time Protocol (NTP) UDP Port 123
Server

Akkadian Provisioning Manager 4.12 System Administration Guide 9
Section 2.0 – Preparing Cisco Unified Communications
Manager for Provisioning Manager Express

Akkadian Provisioning Manager 4.12 communicates with Cisco Unified Communications Manager
using the AXL/SOAP API. Two items are required on Cisco Unified Communications Manager to allow
access via the AXL API:

1. The Cisco AXL Web Service must be activated and started
2. An Application user with AXL API access

If CUCM is already configured for AXL API access, proceed to Section.

2.1 - Activate the AXL Web Service

The Cisco AXL Web Service is disabled by default on some versions of Cisco Unified
Communications Manager. The service must be activated to enable AXL API access.
1. Browse to the CUCM Serviceability page on https://<IP_CUCM>/ccmservice
2. Tools > Service Activation
3. Select the Publisher node
4. Scroll down to Database and Admin Services
5. Check the box for Cisco AXL Web Service and click Save
Figure 2.1.1 – CUCM AXL Service Activation

2.2 – Create Provisioning Manager CUCM Application User

To configure a new Application user:
1. From the Cisco Unified Communications Manager Administration Web page, select Application
User from the User Management menu, and then click Add New.
2. In the User ID field, type PMEAXL.
3. In the Password and Confirm Password fields, type a password for the new user and then click
Save.

Akkadian Provisioning Manager 4.12 System Administration Guide 10