System Admin Guide

103 Pages·2017·3.48 MB·English

akkadian Provisioning Manager Express 4.9

System Administration Guide

Updated – January 13th, 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 Express 4.9 .................................................... 4
Section 1.0 – System Requirements for akkadian Provisioning Manager Express 4.9 .................................................... 7
1.1 - Provisioning Manager Express 4.9 – Server Requirements ........................................................................................................................ 7
1.2 – Operating System Requirements .................................................................................................................................................................. 7
1.3 – Cisco Unified Communications Application Requirements ....................................................................................................................... 8
1.4 – SMTP Requirements ....................................................................................................................................................................................... 8
1.5 – Web Browser Requirements ......................................................................................................................................................................... 8
1.6 – Firewall Ports .................................................................................................................................................................................................. 8
Section 2.0 – Preparing Cisco Unified Communications Manager for Provisioning Manager Express 4.9 ................... 9
2.1 - Activate the AXL Web Service ......................................................................................................................................................................... 9
2.2 – Create aPME CUCM Application User ........................................................................................................................................................... 9
Section 3.0 – Preparing Cisco Unified Contact Center Express for Provisioning Manager Express 4.9 ...................... 11
3.1 – Assigning a user Cisco Unified CCX Administrator capability .................................................................................................................. 11
Section 4.0 – Preparing Cisco Unity Connection for Provisioning Manager Express 4.9 .............................................. 12
4.1 – Creating a Cisco Unity Connection System Administration Account ...................................................................................................... 12
Section 5.0 – Installing akkadian Provisioning Manager Express for Windows .............................................................. 13
Section 6.0 – Deploying the akkadian Provisioning Manager Express 4.9 Virtual Appliance ....................................... 16
Section 7.0 – akkadian Provisioning Manager Express 4.9 Initial Configuration ............................................................ 25
7.1 – Logging into akkadian Provisioning Manager Express 4.9 ....................................................................................................................... 25
7.2 – akkadian Provisioning Manager Express 4.9 Email Configuration ................................................................................................ 26
7.3 – akkadian Provisioning Manger Express 4.9 SSL Configuration ...................................................................................................... 27
7.3.1 – akkadian Provisioning Manger Express 4.9 Certificate Signing Request ............................................................................................. 27
7.3.2 – akkadian Provisioning Manger Express 4.9 Generating a Certificate .................................................................................................. 28
7.3.3 – akkadian Provisioning Manger Express 4.9 Uploading Certificates ..................................................................................................... 28
7.4 – akkadian Provisioning Manger Express 4.9 LDAP Configuration .................................................................................................. 29
7.5 – akkadian Provisioning Manger Express 4.9 Licensing .................................................................................................................... 30
7.6 – Configuring Application Servers in akkadian Provisioning Manager Express 4.9 ........................................................................ 31
7.6.1 – Configuring CUCM & UCCX Application Servers ..................................................................................................................................... 31
7.6.2 – Configuring CUC Application Servers ...................................................................................................................................................... 33
7.6.3 – Configuring Cisco WebEx Application Servers ........................................................................................................................................ 34
7.7 – Configuring Service Groups in akkadian Provisioning Manger Express 4.9 ................................................................................. 36
7.8 – Adding Groups and Permissions in akkadian Provisioning Manager Express 4.9 ....................................................................... 40
7.9 – Assigning Access to Service Groups in akkadian Provisioning Manager Express 4.9 .................................................................. 41
7.10 – Configuring Users in akkadian Provisioning Manager Express 4.9 ............................................................................................. 43
7.11 – Configuring Filter Templates in akkadian Provisioning Manager Express 4.9 ........................................................................... 44
7.12 – DN Pools in akkadian Provisioning Manager Express 4.9 ............................................................................................................ 46
7.13 – Configuring License Pools in akkadian Provisioning Manager Express 4.9 ................................................................................ 48

akkadian Provisioning Manager Express 4.9 System Administration Guide 2
7.14 – Configuring Global Variables in akkadian Provisioning Manager Express 4.9 ........................................................................... 50
7.15 – Configuring Device Pools in akkadian Provisioning Manager Express 4.9 ................................................................................. 52
7.16 – akkadian Provisioning Manger Express 4.9 Log Configuration ................................................................................................... 53
Section 8.0 - Getting Started with Templates in akkadian Provisioning Manager Express 4.9 .................................... 54
Section 8.1 – Using Variables with Templates in akkadian Provisioning Manager Express 4.9 ........................................................... 55
Section 8.2 – Creating Add Templates in akkadian Provisioning Manager Express 4.9 ....................................................................... 58
Section 8.2.1 – Creating Add Speed Dial Templates in akkadian Provisioning Manager Express 4.9 ........................................................... 58
Section 8.2.2 – Creating Add Voice Mail Profile Templates in akkadian Provisioning Manager Express 4.9 ............................................... 59
Section 8.2.3 – Creating Add User Templates in akkadian Provisioning Manager Express 4.9 ..................................................................... 61
Section 8.2.4 – Creating Add Line Templates in akkadian Provisioning Manager Express 4.9 ...................................................................... 62
Section 8.2.5 – Creating Add Device Templates in akkadian Provisioning Manager Express 4.9 .................................................................. 64
Section 8.2.6 – Creating Add CUC Voice Mail Templates in akkadian Provisioning Manager Express 4.9 ................................................... 65
Section 8.2.7 – Creating Add WebEx Templates in akkadian Provisioning Manager Express 4.9 ................................................................. 66
Section 8.2.9 – Creating Site Templates in akkadian Provisioning Manager Express 4.9 .............................................................................. 67
Section 8.3 – Creating Editing Templates in akkadian Provisioning Manager Express 4.9 .................................................................. 69
Section 9.0 – Getting Started with Jobs Templates in akkadian Provisioning Manager Express 4.9 ........................... 71
Section 10.0 – Getting Started with Provisioning in akkadian Provisioning Manager Express 4.9 .............................. 76
Section 10.1 – Bulk provisioning in akkadian Provisioning Manager Express 4.9................................................................................. 78
Section 10.2 - Scheduling in akkadian Provisioning Manager Express 4.9 ............................................................................................ 79
Section 10.3 – Using the Extension Mobility Tool in Provisioning Manager Express 4.9 ..................................................................... 80
Section 10.4 – Using the Swap Feature in Provisioning Manager Express 4.9 ...................................................................................... 81
Section 10.4.1 – Using the Device Swap Feature ................................................................................................................................................ 81
Section 10.4.2 – Using the User Swap Feature ................................................................................................................................................... 82
Section 10.5 – Using Bulk Swap in Provisioning Manager Express 4.9 .................................................................................................. 84
Section 10.6 – Using the CMC/FAC Editor in Provisioning Manager Express 4.9 .................................................................................. 85
Section 10.7 – Using the Visual Phone Editor in Provisioning Manager Express 4.9 ............................................................................ 86
Section 11.0 – Configuring FTP in akkadian Provisioning Manager Express 4.9 ............................................................ 87
Section 12.0 - Backup and Restore in akkadian Provisioning Manager Express 4.9 ...................................................... 88
Section 13.0 - System Update in akkadian Provisioning Manager Express 4.9 .............................................................. 89
Section 14.0 – Reporting in akkadian Provisioning Manager Express 4.9 ....................................................................... 90
Section 15.0 – Updating the PMEAdmin Password in akkadian Provisioning Manager Express 4.9 ........................... 92
Section 16.0 – Getting Started with the REST API in Provisioning Manager akkadian Provisioning Manager Express 4.9 93
Section 17.0 – Configuring the Self-Provisioning Service in Provisioning Manager akkadian Provisioning Manager Express 4.9
................................................................................................................................................................................................ 100
Section 17.1 – Method 1 - Deploying Self-Provisioning using an IP Phone Service ..................................................................................... 100
Section 17.2 – Method 2 - Deploying Self-Provisioning with Auto-registration ............................................................................................ 102

akkadian Provisioning Manager Express 4.9 System Administration Guide 3
Task List for Installing and Configuring akkadian Provisioning
Manager Express 4.9

To install and configure akkadian Provisioning Manager Express 4.9 complete the following
tasks in the order presented:

1. Review the requirements for deploying akkadian Provisioning Manager Express 4.9 in
Section 1 – “System Requirement for akkadian Provisioning Manager Express 4.9”.

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

3. Optional – Configure Cisco Contact Center Express for REST API access. See Section 3.0 –
“Preparing Cisco Unified Contact Center Express for Provisioning Manager Express 4.9”.
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 Express 4.9”. If you are not
using Unity Connection, please proceed to step 4.

5. Install akkadian Provisioning Manger Express 4.9. See Section 5.0 – “Installing akkadian
Provisioning Manager Express 4.9 for Windows” or Section 6.0 – “Deploying the akkadian
Provisioning Manager Express 4.9 Virtual Appliance”.

6. Log in to Provisioning Manager Express 4.9 to perform the initial configuration – See
Section 7.0 “akkadian Provisioning Manager Express 4.9 Initial Configuration”.

7. Configure the SMTP Host for password recovery and notifications. See Section 7.2 –
“akkadian Provisioning Manager Express 4.9 Email Configuration”.

8. Optional – Upload SSL Certificate and Key. See Section 7.3 – “akkadian Provisioning
Manger Express 4.9 SSL Configuration”.

9. Optional – Configure LDAP authentication. See Section 7.4 – “akkadian Provisioning
Manger Express 4.9 LDAP Configuration”. This is only required if you wish to utilize LDAP
authentication to access Provisioning Manager Express 4.9; otherwise proceed to the
next step.
10. Upload the license file. See Section 7.5 – “akkadian Provisioning Manger Express 4.9
Licensing”. If you are trialing akkadian Provisioning Manager Express, 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 Express 4.9”.

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

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

14. Associate Service Groups to User Groups in order to provide access to provision in
Application Servers. See Section 7.9 – “Assigning Access to Service Groups in akkadian
Provisioning Manager Express 4.9”.

15. Create Users and assign them to Groups. See Section 7.10 – “Configuring Users in
akkadian Provisioning Manager Express 4.9”. 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 Express 4.9 configuration. Please note the username and password for this
user, as it will be required for Step 15.

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

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

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

19. Optional – Create Global Variables to simplify the provisioning process. See Section 7.13
– “Configuring Global Variables in akkadian Provisioning Manager Express 4.9”. Global

akkadian Provisioning Manager Express 4.9 System Administration Guide 5
Variables are optional, though they are necessary to streamline the provisioning
process.

20. Configure Provisioning Manager Express 4.9 Templates. See Section 8.0 - “Getting
Started with Templates in akkadian Provisioning Manager Express 4.9”. Templates are
the core of Provisioning Manager Express 4.9 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 Action Templates in
akkadian Provisioning Manager Express 4.9”. Actions Templates combine one or more
Provisioning Templates to create a single template.

22. Start Provisioning. Use Action Templates to starting provisioning in your environment.
See Section 10.0 – “Getting Started with Provisioning in akkadian Provisioning Manger
Express 4.9”.

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 Express”.

24. Backup the system. It is recommended to back up the system when your configuration
is complete as described in Section 12.0 – “Backup and Restore in akkadian Provisioning
Manager Express 4.9”.

akkadian Provisioning Manager Express 4.9 System Administration Guide 6
Section 1.0 – System Requirements for akkadian Provisioning
Manager Express 4.9

1.1 - Provisioning Manager Express 4.9 – Server Requirements

akkadian Provisioning Manager Express 4.9 is available for Windows Server or 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 Express 4.9 are based
on several variables. In order to assist with allocating the proper resources for Provisioning
Manager Express 4.9, 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 aPME and is not related to the number
of servers with a cluster.
* Minimum of 2000 MHz reserved

1.2 – Operating System Requirements

akkadian Provisioning Manger Express 4.9 for Windows Server is supported on the following
Windows Server Operating Systems:

 Windows 2008 R2
 Windows 2012 R2

akkadian Provisioning Manager Express 4.9 System Administration Guide 7
1.3 – Cisco Unified Communications Application Requirements

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

1.4 – SMTP Requirements

Akkadian Provisioning Manager Express 4.9 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.5 – Web Browser Requirements

 Internet Explorer 9.x+
 Mozilla Firefox 20+
 Chrome

1.6 – Firewall Ports

If akkadian Provisioning Manager Express 4.9 is located behind a firewall, the ports in Table
1.6.1 are required for proper communication.

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

akkadian Provisioning Manager Express 4.9 System Administration Guide 8
Section 2.0 – Preparing Cisco Unified Communications
Manager for Provisioning Manager Express 4.9

akkadian Provisioning Manager Express 4.9 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 aPME 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 Express 4.9 System Administration Guide 9
4. Navigate down the page to Permissions Information.
5. Click Add to Access Control Group (User Group in some versions of CUCM) and then click Find.
6. Select Standard TabSync User and then click Add Selected.
7. Select Standard EM Authentication Proxy Rights and then click Add Selected.
8. On the Cisco Unified Communications Manager Administration Web page, confirm the Standard
AXL API Access group is listed under Roles.
Figure 2.2.1 – CUCM Application user Groups assignment

akkadian Provisioning Manager Express 4.9 System Administration Guide 10