Guest

Cisco Prime Unified Provisioning Manager

Quick Start Guide for Cisco Prime Unified Provisioning Manager 9.0BE

  • Viewing Options

  • PDF (1.4 MB)
  • Feedback
Quick Start Guide

Table Of Contents

Cisco Prime Unified Provisioning Manager 9.0BE Quick Start Guide

About This Guide

Overview

Deploying Provisioning Manager

Requirements

Supported Ports

Supported Cisco Unified Products

About Provisioning Manager Licensing

Before Deploying Provisioning Manager

Activating Services

Configuring an SRST Gateway

Preparing to Deploy the Provisioning Manager OVA

Deploying the Provisioning Manager OVA

Setting the Provisioning Manager VM MAC Address

Configuring Provisioning Manager VM Communications

Configuring SSL and Network Parameters

Enabling SSL on the Provisioning Manager Server

Changing the Port Used by SSL

Importing CA Certificates

Changing Password Policies

Setting Up Provisioning Manager

Configuring Provisioning Manager Communications

Modifying the System Configuration

Configuring a Site

Configuring Usage Profiles

Managing Sites and Users with Provisioning Manager

Managing Sites

Adding Sites

Copying Sites

Deleting Sites

Transferring Users Between Sites and Usage Profiles

Managing Usage Profiles

Updating Usage Profiles

Copying Usage Profiles

Deleting Usage Profiles

Obtaining a Usage Profile List

Obtaining a User List for a Usage Profile

Obtaining a Phone List for a Usage Profile

Managing Users

Adding Users

Setting Authorization Roles

Adding Services for Users

Verifying User Information and Services

Verifying User Self-Care Settings

Importing Users

Removing Users

Configuring Self-Care Options

Configuring Phone Settings

Setting the MAC Address

Configuring Speed Dial

Configuring Do Not Disturb Options

Specifying User Locale

Configuring Music On Hold Options for a Phone

Configuring Other Phone Options

Configuring Extension Mobility Settings

Configuring Single Number Reach Settings

Configuring Alternate Numbers

Configuring Line Settings

Configuring Call Forwarding Options

Configuring Caller ID Options

Setting Ring and Notification Options

Configuring Music On Hold Options for a Line

Configuring User Settings

Changing Your Personal Information

Changing Your Password

Changing Your PIN

Managing Provisioning Manager

Backing Up Provisioning Manager

Restoring Provisioning Manager

Resetting the Provisioning Manager Admin Password

Resetting the PostgreSQL Admin Password

Changing the Provisioning Manager Server IP Address

Troubleshooting Provisioning Manager

Abort Orders

Change Log Level

Show Tech

Fixing File Problems

Provisioning Manager Dial Plan

Customizing the Self-Care Portal

Obtaining Documentation and Submitting a Service Request


Quick Start Guide

Cisco Prime Unified Provisioning Manager 9.0BE Quick Start Guide


February 03, 2013, OL-26973-02

1 About This Guide

This guide describes how to deploy, configure, and manage Cisco Prime Unified Provisioning Manager (Provisioning Manager) 9.0 Business Edition (9.0BE) for use on virtualized servers.

Table 1 describes the contents and audiences for this guide.

Table 1 Guide Contents and Audience

Section
Audience
Description

Overview

All users.

Product overview.

Deploying Provisioning Manager

Those deploying the Provisioning Manager OVA.

Provisioning Manager requirements, how to deploy the Provisioning Manager OVA, and post-deployment tasks.

Setting Up Provisioning Manager

Those setting up the Provisioning Manager environment.

How to set up the Provisioning Manager environment for use, including:

Configuring and testing communications with other Cisco Unified Communications Manager components.

Configuring internal dialing options, telephone number range, gateway, and options for local and long-distance calls.

Configuring usage profiles.

Managing Sites and Users with Provisioning Manager

Those using Provisioning Manager to provision services on an ongoing basis.

How to manage sites, usage profiles, and users in Provisioning Manager.

Configuring Self-Care Options

Those using the Self-Care portal.

How to use the Self-Care portal to modify telephone preferences.

Managing Provisioning Manager

Those managing Provisioning Manager.

How to back up and restore Provisioning Manager, and how to change the Provisioning Manager server IP address.

Troubleshooting Provisioning Manager

Those troubleshooting issues with Provisioning Manager.

Tools that can help you troubleshoot problems with Provisioning Manager.

Provisioning Manager Dial Plan

Those setting up dial plans.

Provisioning Manager dial plan details.

Customizing the Self-Care Portal

Those managing Provisioning Manager.

How to customize the Self-Care portal for your company or location.

Obtaining Documentation and Submitting a Service Request

All users.

Where to find additional documentation for this and related products, and how to obtain technical assistance.


The audience for this document must be familiar with UNIX and Linux commands.

2 Overview

Provisioning Manager is a provisioning application for Cisco Unified Communications Manager (Unified Communications Manager) initial deployments and implementations. Provisioning Manager provides:

Provisioning for Unified Communications Manager initial deployments and implementations.

Ongoing operational provisioning and activation services for individual end user changes.

Table 2 describes the features in Provisioning Manager 9.0BE.

Table 2 Provisioning Manager 9.0BE Features 

Feature
Description

Ease of deployment and configuration

A workflow-based interface enables you to build and manage sites for phone, line, voice mail, and presence client services.

It also enables you to configure and validate communications, create sites, specify dial plans, and configure usage profiles quickly and efficiently.

Site and user management

Site and user configuration screens enable you to update site information and manage users easily, whether adding users, transferring users between sites, adding services for users, or assigning user roles.

LDAP integration

You can import users from LDAP and provision services based on criteria that you specify.

SRST support

Configuring Survivable Remote Site Telephone (SRST) in Unified Communications Manager enables you to ensure that phone service will not be lost if the link between IP phones and Unified Communications Manager is lost.

Usage profiles

Usage profiles allow you to provision sets of services that you can associate with users to meet their business needs. Services include voice mail, unified messaging, Extension Mobility, remote destination profile, and presence.

Phone button template support

You can import phone button templates from Unified Communications Manager and select the phone button to use for the phone or service being provisioned.

Single Number Reach

The Single Number Reach feature enables you to associate an IP phone number with another number. When a call is received on the IP phone number, Provisioning Manager automatically directs the call to the associated number as well as the IP phone. In this way, the Single Number Reach feature enables callers to reach the phone user, regardless of the user's location.

Extension Mobility

The Extension Mobility feature enables any user to log into a phone and use the phone as their own, on a temporary basis. When the user logs in, the phone adopts the user's default device profile information (including line numbers, speed dials, services links, and other user-specific properties), and dynamically configures the phone to that device profile.

Dial plans

You can use the default dial plan (North America Number Plan) included with Provisioning Manager, or create a custom dial plan that suits your environment.

Self-Care portal

The Self-Care portal enables end users to set up lines, manage services, and configure phone options. Options include:

Phone settings—Setting up speed dialing, Do Not Disturb options, and alternate number configuration.

Line settings—Call-forwarding, caller ID, and notification options.

User settings—Updating passwords and PINs.


Provisioning Manager 9.0BE is designed for use with the Cisco Business Edition 6000 solution.

3 Deploying Provisioning Manager

The following topics describe the Provisioning Manager requirements, and how to deploy and prepare Provisioning Manager for use:

Requirements

Supported Ports

Supported Cisco Unified Products

About Provisioning Manager Licensing

Before Deploying Provisioning Manager

Deploying the Provisioning Manager OVA

Setting the Provisioning Manager VM MAC Address

Configuring Provisioning Manager VM Communications

Configuring SSL and Network Parameters

For dial plan information, see Provisioning Manager Dial Plan.

Requirements

Provisioning Manager is delivered as an Open Virtual Appliance (OVA) file named UnifiedPM9.0BE.ova. An OVA allows you to easily deploy a prepackaged Virtual Machine (VM).

Table 3 identifies the VM requirements for managing 1000 phones or voice terminals using Provisioning Manager.

Table 3 VM Minimum Requirements 

Type
Requirement

VMware

vSphere 4.1 with ESXi 4.1

vCPU

1

vDisk

45 GB

vNIC

1 GB

vRAM

2 GB


Table 4 identifies the client machine requirements for using Provisioning Manager.

Table 4 Client Minimum Requirements 

Type
Requirement

System Hardware

Any PC or server platform with a Pentium 4 processor greater than 1.0 GHz.

Color monitor with video card set to 24 bits color depth.

Screen resolution of 1280 x 768 DPI. This resolution is recommended for full product functionality.

System Software

One of the following:

Internet Explorer (IE) 8.0

If you use IE 8.0 to access Provisioning Manager, enable Compatibility View in IE.

Firefox 10.0 Extended Support Release (ESR)

Firefox 14.0

Firefox is the recommended browser.


Supported Ports

Before deploying the Provisioning Manager OVA, ensure that the appropriate ports are available.

Table 5 identifies the inbound ports that must be open on a firewall.

Table 5 Inbound TCP Ports that Must Be Open on a Firewall  

Port Number
Protocol
Process
Additional Information

80

HTTP

Apache Web Server

5432

JDBC

PostgreSQL Database Server

This port enables the Provisioning Manager server to access the database.This port does not need to be open for external access.

46443

HTTPS

Apache Web Server

By default, this port is not configured for use.


Table 6 identifies the ports that are used by Provisioning Manager but that do not need to be open on a firewall.

Table 6 TCP Ports Used by Provisioning Manager 

Port Number
Protocol
Process

46001

RMI

Provisioning Manager NICE Engine

46008

HTTP

Jboss Application Server

46009

AJP

Jboss Application Server

46083

Web Service

Jboss Application Server

46098

RMI

Jboss Application Server

46099

JNP Service

Jboss Application Server

46444

JRMP

Jboss Application Server

46445

Transaction Manager

Jboss Application Server

46446

Remoting Server

Jboss Application Server

46457

Bisocket Transport

Jboss Application Server


Table 7 lists the outbound TCP ports that must be open on a firewall between Provisioning Manager and the device.

Table 7 Outbound TCP Port Used to Communicate with Other Devices  

Port Number
Protocol
Application

8443

HTTPS

Cisco Unified Communications Manager, Cisco Unified Presence, and Cisco Unity Connection


Supported Cisco Unified Products

Provisioning Manager is supported for use with the following Cisco Unified products and versions:

Cisco Unified Communications Manager (Unified Communications Manager)  9.1(1)

Cisco Unity Connection (Unity Connection) 9.0.1

Cisco Unified Presence (Unified Presence) 9.0.1

About Provisioning Manager Licensing

The license file is part of the OVA image. This file allows you to manage the following resources:

1500 phones or voice terminals

One Unified Communications Manager

One Unity Connection

One Unified Presence

30 total pmadmin and Self- Care user logins

Before Deploying Provisioning Manager

The following topics describe the requirements that must be met to ensure the successful deployment and configuration of Provisioning Manager:

Activating Services

Configuring an SRST Gateway

Preparing to Deploy the Provisioning Manager OVA

Activating Services

Before Provisioning Manager can interact with Unified Communications Manager, Cisco CallManager (CallManager), and Unified Presence servers, you must activate the services for each server that will communicate with Provisioning Manager for these services.

Complete the following steps on each server providing services for Provisioning Manager:


Step 1 In Cisco Unified Serviceability, choose Tools > Service Activation.

Step 2 From the Server drop-down list, choose the server on which you want to activate the service, then click Go.

For the server that you choose, the window displays the service names and activation status of the services.

Step 3 Check the Cisco AXL Web Service check box, then click Save.

Step 4 If your site includes Presence services:

a. Log into the Presence server as admin.

b. When prompted, enter the hostname and IP address for the CallManager server.

Step 5 When prompted, enter the required information to complete service activation.


For more information about service activation, see the Cisco Unified Serviceability Administration Guide, Release 8.6(1).

Configuring an SRST Gateway

If your site will include Survivable Remote Site Telephony (SRST) service, you need to configure the SRST gateway before the gateway can be used as an SRST reference by Provisioning Manager.

Preparing to Deploy the Provisioning Manager OVA

Ensure that your VMware environment meets the requirements in Table 8 before deploying the Provisioning Manager OVA.

For dial plan information, see Provisioning Manager Dial Plan.

Table 8 Prerequisites for Deploying the OVA 

÷
Requirement
Comments
 

VMware ESXi is installed and configured on the ESXi host.

See the VMware documentation for information on setting up and configuring the host machine.

 

VMware ESXi host is accessible with the configured IP settings.

IP address

IP network mask

Gateway

 

VMware vSphere client is installed.

After the virtual host is available on the network, browse to its IP address to display a web-based interface from which you can install the VMware vSphere client.

Note The VMware vSphere client is Windows-based. Therefore, you must download and install the client from a Windows PC.

After you install the vSphere client, you can log into the virtual host using the hostname or IP address of the virtual host, the root login ID, and the password that you configured. You can add the host to a vCenter if you want to manage it through vCenter. See VMware documentation for details.

 

OVA is downloaded and saved to the same machine where vSphere client is installed.

 

VMware ESXi server hostname is configured in the DNS server.

 

VMware ESXi server is synchronized with the NTP server.


Deploying the Provisioning Manager OVA

Provisioning Manager is installed under the /opt/cupm directory.

Prerequisites

Before deploying the OVA, make sure that all requirements are met as described in the following sections:

Requirements

Supported Ports

Before Deploying Provisioning Manager

To deploy the OVA:


Step 1 Copy the OVA file to your local machine where the VMware vSphere client is running.

Step 2 From VMware vSphere client, choose File > Deploy OVF Template.

Step 3 Click the Deploy from File radio button.

Step 4 Click Browse to navigate to the OVA file location.

Step 5 In the Inventory panel, select the required VM.

Step 6 Power on the virtual machine by right-clicking the virtual appliance and choosing Power > Power On.

The virtual appliance console is displayed.


Setting the Provisioning Manager VM MAC Address

After the OVA is deployed, you must assign a MAC address to the Provisioning Manager VM.

To assign the MAC address:


Step 1 In vSphere, right-click the Provisioning Manager VM and choose Power > Power Off.

Step 2 Click the Summary tab, and then click Edit Settings.

Step 3 In the Hardware list, select Network Adapter.

Step 4 Change the static MAC address of the virtual machine to 00:50:56:11:11:11.

Step 5 Power on the virtual machine by right-clicking the virtual appliance and choosing Power > Power On.

The virtual appliance console is displayed.


Continue with Configuring Provisioning Manager VM Communications.

Configuring Provisioning Manager VM Communications

After you deploy the OVA, you must configure the Provisioning Manager VM for communications with other systems.

You are prompted for the following account passwords when you configure Provisioning Manager:

Linux server admin

Provisioning Manager pmadmin

PostgreSQL admin

root


NoteThe server, PostgreSQL, and root passwords cannot be recovered. We recommend that you keep a record of these passwords for future reference.

Because pmadmin is the preconfigured Provisioning Manager username, do not use pmadmin as the administrative password.


To configure the Provisioning Manager VM:


Step 1 If you have not already done so, power on the VM by right-clicking it and choosing Power > Power On.

Step 2 Right-click the VM and choose Open Console.

Step 3 At the localhost login prompt, enter setup.

Step 4 Enter the following information at the console prompts:

— IP address of VM instance

— IP default netmask

— IP default gateway

— Default DNS domain

— Primary nameserver

To enter another name server, enter y at the next prompt.

— Primary NTP server [time.nist.gov]

To enter a secondary NTP server, enter y at the next prompt.

— Timezone [UTC]

We recommend that you accept the default.

If you choose to enter a time zone, the entry follows the form area/location, such as America/Los_Angeles or Etc/GMT+12. For a list of time zones, see http://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

— Username [admin]

Administrative username for logging into the Linux server at the shell prompt.

We recommend that you accept the default.

— Password

Password for logging into the Linux server at the shell prompt.

— Provisioning Manager pmadmin password

— PostgreSQL password

— root password

The VM reboots after configuration and validation are complete.


The following example shows the setup procedure for a controller:

**********************************************
Please type 'setup' to configure the appliance
**********************************************
localhost.localdomain login: setup
 
   
Enter hostname[]: hostname-controller
Enter IP address[]: 10.165.200.225
Enter IP default netmask[]: 255.0.0.0
Enter IP default gateway[]: 10.165.200.238
Enter default DNS domain[]: example.com
Enter primary nameserver[]: 1
Add/Edit another nameserver? Y/N : n
Enter primary NTP server[time.nist.gov]: ntp.esl.example.com
Add/Edit secondary NTP server? Y/N : n
Enter system timezone[UTC]:<cr>
Enter username[admin]:<cr>
Enter password:server-admin-password 
Enter password again:server-admin-password
 
   
Application bundle (UNIFIEDPM)installed successfully
Installing ROOTPATCH...
 
   
Application bundle (ROOTPATCH)installed successfully
 
   
 === Initial Setup for Application: CUPM ===
 
   
Create pmadmin password:pmadmin-password
Enter pmadmin password again:pmadmin-password speed 38400 baud; line = 0;
-brkint -imaxbel
-echo
 
   
Password of the pmadmin user has been reset.
Please restart the CUPM services.
Create postgres password:postgres-password
Enter postgres password again:postgres-password speed 38400 baud; line = 0; 
-brkint -imaxbel
-echo
 
   
Create root password:root-password
Enter root password again:root-password 
 
   

Configuring SSL and Network Parameters

After you deploy the OVA and configure the Provisioning Manager VM communications, you must configure network parameters and import SSL certificates as described in the following sections:

Enabling SSL on the Provisioning Manager Server

Changing the Port Used by SSL

Importing CA Certificates

Changing Password Policies

Enabling SSL on the Provisioning Manager Server

Secure Socket Layer (SSL) is an application-level protocol that enables secure transactions of data through privacy, authentication, and data integrity. It relies on certificates, public keys, and private keys.

Provisioning Manager supports SSL between clients and the server. When you start Provisioning Manager, the login page always opens in secure mode, providing secure access between the client browser and the Provisioning Manager server.

In secure mode, SSL is used to encrypt the transmission channel between the browser and the server. To use secure mode throughout Provisioning Manager, you must enable SSL.

Keep the following in mind when using SSL:

The URL for logging in uses HTTPS (for example, https://host/cupm/Login where host is the hostname or IP address).

We recommend that port 443 be configured in the ssl.conf file. If you must change the port number, change the line Listen 443 in the ssl.conf file to the desired port as described in Changing the Port Used by SSL.

To use HTTPS exclusively, disable HTTP by commenting the line Listen 80 in the /install-directory/httpd/conf/httpd.conf file (where install-directory is the installation directory), and then restart the Apache server.

To enable SSL, complete the tasks described in the following sections:

Installing OpenSSL and Generating a Certificate

Configuring the Apache Server

For information on changing the port used by SSL, see Changing the Port Used by SSL.

Installing OpenSSL and Generating a Certificate

To install OpenSSL and generate a certificate:


Step 1 Log into the Provisioning Manager server as root using SSH.

Step 2 Get the file OpenSSL0.9.8s-Linux_P90X.zip from the CD packaged along with Cisco Business Edition 6000, and extract the attached OpenSSL zip file to any folder.

The following folders are extracted:

bin/

lib/

modules/

ssl/

Step 3 Copy the extracted folders to /opt/cupm/httpd. The default installation directory is /opt/cupm.

If you are asked to overwrite existing files, enter Yes.

Step 4 At the command prompt, navigate to /opt/cupm/httpd/bin.

Step 5 Set access privileges by entering the following command:

chmod 777 openssl
 
   

Step 6 Generate an RSA private key by entering the following command:

./openssl genrsa -out /opt/cupm/httpd/mycorp.com.key 1024 
 
   

Step 7 Generate a new certificate request and a new key by entering the following command:

./openssl req -new -key /opt/cupm/httpd/mycorp.com.key -x509 -out  
/opt/cupm/httpd/mycorpcom.crt -days 365
 
   

To see an example of this command output, see Sample Output.

Step 8 Update the following entries in the /opt/cupm/httpd/conf/ssl.conf file so that they map the certificate to the key file:

SSLCertificateFile /opt/cupm/httpd/mycorpcom.crt (from conf/server.crt)

SSLCertificateKeyFile /opt/cupm/httpd/mycorp.com.key (from conf/server.key)

Continue with Configuring the Apache Server.


Sample Output

   You are about to be asked to enter information that will be incorporated into your certificate request. What 
you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank For some fields there will be a default value, If you 
enter '.', the field will be left blank.
 
   
-----
 
   
Country Name (2 letter code) [AU]:US
State or Province Name (full name) [Some-State]:CA
Locality Name (eg, city) []:CA
Organization Name (eg, company) [Internet Widgets Pty Ltd]:mycorp, LLC
Organizational Unit Name (eg, section) []:Sales
Common Name (eg, YOUR name) []: <CR> 
Email Address []:you@mycorp.com
 
   

Configuring the Apache Server

After you install OpenSSL and generate a certificate, you are ready to configure the Apache server.

To configure the Apache server:


Step 1 On the Provisioning Manager system, back up the httpd.conf file (located in install-directory/httpd/conf).

Step 2 In the httpd.conf file, comment the following lines using a vi editor:

#<IfModule mod_ssl.c>
#</IfModule>
 
   

Step 3 In the same directory, back up the ssl.conf file.

A file can be backed up by using the cp command.

cp <file name> <back up file name>
 
   

Step 4 Uncomment the following lines:

<IfDefine SSL>
</IfDefine> 
 
   

Step 5 Change the entries for Listen, VirtualHost _default_, and ServerName Host to the following:

Listen 443 
<VirtualHost _default_:443> 
ServerName host.your-domain.com:443 
 
   

To change the SSL port to a different number, see Changing the Port Used by SSL.

Step 6 On the Provisioning Manager system, back up the pmservers.sh file (located in /opt/cupm) using the following command:

cp /opt/cupm/pmservers.sh /opt/cupm/pmservers.sh.orig
 
   

Step 7 Change the following line in the /opt/cupm/pmservers.sh file:

$PM_BASE/httpd/bin/apachectl -k start &

to

$PM_BASE/httpd/bin/apachectl -k start -DSSL &

Step 8 Enter the following commands to restart the Apache2 Service:

/opt/cupm/httpd/bin/apachectl -k stop
/opt/cupm/httpd/bin/apachectl -k start -DSSL
 
   

Step 9 Wait approximately two minutes for the SSL port to be up and running, before you log into Provisioning Manager using HTTPS.


For information on using HTTPS exclusively, see Enabling SSL on the Provisioning Manager Server.

Changing the Port Used by SSL

If Provisioning Manager is installed on a coresident system with Cisco Operations Manager, you must change the port used for SSL by one of the applications. This section describes how to change the port used for SSL by Provisioning Manager.


Step 1 On the Provisioning Manager system, open the ssl.conf file (located at install-directory/httpd/conf).

Step 2 Change the port number in the following lines to a different number. We recommend that you use 443.

Listen port-number

<VirtualHost _default_:port-number>

ServerName host.your-domain.com:port-number

where port-number is the desired port number.

Step 3 Save the changes and close the file.



Note After you change the port number, you must include the new port number in the URL to access Provisioning Manager, such as https://hostname:443.


Importing CA Certificates

Provisioning Manager uses the root Certification Authority (CA) certificates in the keystore install-directory/jvm/jre/lib/security/cacerts to validate any nonself-signed certificates used on Unified Communications Manager and Unity Connection as part of secure communications with them.

If the root CA certificate that you use is not in this keystore, you can use the Java keytool utility to import the certificate into the listed keystore. For example, if you want to import a certificate, service_root.crt, you must enter:

/opt/cupm/jvm/jre/bin/keytool -import -trustcacerts -alias root -file /tmp/service_root.crt -keystore /opt/cupm/jvm/jre/lib/security/cacerts

Enter the password for the keystore when prompted. The default password is changeit.

Changing Password Policies

Provisioning Manager stores password policy properties in a file named passwordpolicy.properties in install-directory/sep where install-directory is the directory in which you install Provisioning Manager. You can modify the properties file to change the password policies as required. Restart Provisioning Manager whenever you modify the password policy properties.

4 Setting Up Provisioning Manager

After you deploy the Provisioning Manager OVA and complete the post-installation tasks, you are ready to set up Provisioning Manager for use.

To set up Provisioning Manager, complete the following tasks:

#
Task
Related Topic

1.

Configure and test communications with other components of the Unified Communications Manager suite and, optionally, with an LDAP server.

Configuring Provisioning Manager Communications

2.

Configure one or more sites with internal and external dialing options, a range of phone numbers, gateway, and options for local and long-distance calling.

Configuring a Site

3.

Configure usage profiles for different types of users.

Configuring Usage Profiles


Configuring Provisioning Manager Communications

For Provisioning Manager to work properly, it must be able to communicate with other components of the Unified Communications Management Suite, including Unified Communications Manager and Unity Connection.

If your environment includes an LDAP server for authentication, you can also configure Provisioning Manager communications with that server.

Similarly, if your environment includes Unified Presence, you can also configure Provisioning Manager communications for use with it.

Provisioning Manager enables you to perform the following tasks from one screen:

Confirm IP address and account information for Unified Communications Manager and Unity Connection/

Configure voicemail.

Test access from Provisioning Manager to Unified Communications Manager and Unity Connection.

Optionally, configure IP address and account information for Unified Presence, an Exchange server, and LDAP.

If you configure any of these optional services, the following rules apply:

If you configure Provisioning Manager for communications with Unified Presence, you cannot remove it from the Provisioning Manager configuration.

If you configure Provisioning Manager for communications with an Exchange server, you cannot remove it from the Provisioning Manager configuration.

If you configure LDAP server access and need to remove it later, you can do so by removing the IP address for the LDAP server.


Note For information about configuring LDAP servers and profiles on Unified Presence servers, and automatically provisioning user services, see the Unified Presence documentation.


If configured, test access to Unified Presence and an LDAP server.

To configure Provisioning Manager communications:


Step 1 In a browser, enter the URL https://host/cupm/Login where host is the hostname or IP address of the system on which Provisioning Manager is installed.

Step 2 In the menu bar for the Provisioning Manager dashboard, choose Deployment > System Configuration > Devices.

The Configure System panel is displayed as shown in Figure 1.

Step 3 Enter the information for the following services as described in Table 9:

Unified Communications Manager

Unity Connection

Unified Presence (Optional)

LDAP (Optional)

Step 4 (Optional) To verify that Provisioning Manager can communicate with Unified Communications Manager, Unity Connection, Unified Presence, or an LDAP server, click Test Access in the relevant area.

A message is displayed, indicating the success or failure of the connection.

Step 5 Click Save.

Provisioning Manager tests all device connections and saves the configuration.

Step 6 Click Go To Site Management to continue setting up Provisioning Manager (see Configuring a Site).


Example Screen

Figure 1 Configure System Screen

Field Descriptions

Table 9 System Configuration Fields 

Field
Description
Unified Communications Manager

IP Address

Unified Communications Manager server IP address.

Account Name

Username for administrative account.

Password

Password for administrative account.

Test Access

Tests connectivity to Unified Communications Manager.

Extension Mobility—Service URL

Location of the Extension Mobility service.

Dialing Options—Outside Dial Number

Number used to access an outside line.

Device Data

Last Updated

Date and time that device data was last updated.

Get Data

Retrieves the latest phone button template and security profile from the Unified Communications Manager Server.

Unity Connection

IP Address

Unity Connection server IP address.

Account Name

User name for administrative account.

Password

Password for administrative account.

Test Access

Tests connectivity to the Unity Connection server.

Voicemail

Voicemail Pilot Number

Directory number dialed to access voice mail messages.

Message Waiting Indicator On Extension

Extension used to identify which phone should turn on a message waiting indicator (MWI).

Message Waiting Indicator Off Extension

Extension used to identify which phone should turn off an MWI.

Port Range Starting Extension

Beginning extension of the voicemail port range.

Number of Ports to Answer Calls

Of 24 total ports, the number of ports to use for answering calls.

We recommend that you allocate 70% of the available ports for answering calls. For 24 available ports, 70% is 17 ports.

Exchange Server (Optional)

Note If you configure Exchange Server access, you cannot delete it later.

Type

Exchange server version.

IP Address

Exchange server IP address.

Account Name

Exchange server account name.

Password

Exchange server password.

Unified Presence

Note If you configure Presence server access, you cannot delete it later.

IP Address

IP address of the Unified Presence server.

Account Name

User name for administrative account.

Password

Password for administrative account.

Test Access

Tests connectivity to the Unified Presence server.

LDAP (Optional)

You can configure and remove LDAP server access as needed. To remove LDAP server access, delete the IP address.

IP Address

LDAP server IP address.

Backup IP Address (optional)

LDAP backup server IP address.

Admin Distinguished Name

Administrative user ID of the LDAP manager who has access rights to the LDAP directory.

Search Base

Container or directory in which the users are configured.

Provisioning Manager searches for users under the base CN=Users, DC=Cisco, DC=com.

Port

LDAP server port.

Port (optional)

Port number for the LDAP backup server.

Password

Administrative user password.

Use SSL

Check the check box to enable SSL for LDAP.

If you enable LDAP SSL, you need to add the SSL certificate for the host to Provisioning Manager.

Test Access

Tests connectivity to the LDAP server.


Modifying the System Configuration

After you initially configure Provisioning Manager as described in Configuring Provisioning Manager Communications, you can modify some, but not all, of the settings.


Note You can modify the IP address for Unified Communications Manager, Unity Connection, or Unified Presence only to update an IP address. You cannot change the IP address in this screen for a server that has been replaced by a different physical server.


To modify Provisioning Manager settings:


Step 1 Choose Deployment > System Configuration > Devices.

Step 2 In the navigation pane, select Site.

Step 3 Modify the information as described in Table 10, then click Save.


Field Descriptions

Table 10 System Configuration Fields that Can Be Modified 

Field
Description
Unified Communications Manager

IP Address

Unified Communications Manager server IP address.

Unity Connection

IP Address

Unity Connection server IP address.

Voicemail

Message Waiting Indicator On Extension

Extension used to identify which phone should turn on a message waiting indicator (MWI).

Message Waiting Indicator Off Extension

Extension used to identify which phone should turn off an MWI.

Exchange Server (Optional)

Type

Exchange server version.

IP Address

Exchange server IP address.

Account Name

Exchange server account name.

Password

Exchange server password.

Unified Presence

IP Address

IP address of the Unified Presence server.


Configuring a Site

Provisioning Manager enables you to quickly configure a new site with internal and external dialing options, a range of extension numbers, and options for internal, local, long-distance, and international calling.

If your site will include Survivable Remote Site Telephony (SRST) service, you must configure the SRST gateway before the gateway can be used as an SRST reference by Provisioning Manager.

If you provision a site using the North America Number Plan (NANP) option, the following infrastructure objects are created on Unified Communications Manager for each site:

Date\Time Group

Partition

Calling Search Space

Location

Region

Device Pool

SRST (optional)

H.323 Gateway

Translation Pattern for intra-site dialing (if DN block is configured)

Route Patterns for each site

To configure a new site:


Step 1 Choose Deployment > System Configuration > Sites.

The Site Configuration screen is displayed as shown in Figure 2.

Step 2 Enter the information described in Table 11.


Note Except for the Name field, all fields become display-only after the site is deployed with an Active status. You cannot make changes to these fields if the site status is Active.


Step 3 Click Save.

Step 4 Click Next to configure usage profiles as described in Configuring Usage Profiles.


Example Screen

Figure 2 Site Configuration Screen

Field Descriptions

Table 11 Site Configuration Fields 

Field
Description
Site Configuration

Name

Site name.

Status

Current status of the site (read-only).

Site status can be any of the following:

Unsaved—Site information has not been saved to the server. If you reload the page, the information will be lost.

Plan—The site information has been saved to the server and profiles have been created, but the dial plan configuration has not yet been provisioned on the device.

Building—The system is provisioning the dial plan and site configuration.

Deploy Failed—Provisioning on the device failed. Correct any issues and redeploy the site.

Active—The dial plan was successfully deployed on the device. You can now add users and services to the site.

Deleting—The site is in the process of being deleted.

Language

Language of the site.

Dial Plans

Dial Plan

Choose an existing dial plan for the site or choose Custom Dial Plan to create a new dial plan.

The default dial plan is the North America Numbering Plan (NANP).

Note If you choose Custom Dial Plan, you will need to use the native Unified Communications Manager CLI to configure Survivable Remote Site Telephony (SRST) and the Date/Time Group, and then associate it to the custom dial plan device pool.

Time Zone

Time zone of the site.

Dialing Options—Extension Length

Number of extension digits for intra-site dialing.

Gateway—Name

Available when adding a new site, otherwise read-only.

IP address or name that Unified Communications Manager uses to identify the device.

Enter the H323 gateway IP address or hostname.

Provisioning Manager supports only H323 gateways.

Directory Number Block (Optional)

Add Row

Available when adding a new site.

Enables you to add additional ranges of phone numbers.

From / To

Beginning and ending ten-digit phone numbers for the site.

These fields include a 1- prefix, indicating that long distance calls will be prepended with a one (1).

Remove

Removes a range of phone numbers.

Survivable Remote Site Telephony [SRST] (Optional)

IP Address

IP address of the gateway to use as an SRST reference.

Port

Gateway port to use for communications. The default port is 2000.

SIP Network/IP Address

IP address of the gateway that phones running SIP will use when in SRST mode.

SIP Port

Port for the SRST gateway. The default port is 5060.

LDAP User Import (Optional)

Mode

Select the mode to use:

Authenticate Only—Use information in the LDAP directory to authenticate users and administrators who access or use telephony services.

Authenticate and Synchronize—Use information in the LDAP directory to synchronize a number of user attributes on either a periodic or on-demand basis. If you choose this feature, users are automatically provisioned from the LDAP directory.

LDAP Authenticate and Synchronize Options

The following options are available if you choose Authenticate and Synchronize for the LDAP User Import mode.

Update Existing User Details

Indicate the action to take if existing user information differs from newly imported LDAP information:

All Fields—Update the existing user information to match the LDAP import information.

Do Not Update—Do not update the existing user information.

Delete Users

Select the action to take if an existing Provisioning Manager user no longer appears in the imported LDAP information:

Do not delete—Retain the user information in Provisioning Manager.

Delete if user has no services—If the user has no telephony services, delete from Provisioning Manager.

Always delete—Delete from Provisioning Manager in all cases.

User Search Base

Location on the LDAP server to look for information.

Map LDAP user field ... to Contact Phone Number

Choose one of the following options to map to the contact phone number for the Provisioning Manager user:

IP phone

Telephone number

Additional Filtering

Choose the level of filtering to apply to the LDAP user import operation, then supply the required criteria.

None

No filtering is applied. All users will be imported.

Simple Query

Enables you to filter LDAP import information based on the following fields, criteria, and operators:

User fields: User ID, Department, Phone, or Contact Email

Filter criteria: In, equals, not equal

Operators: And, or

Advanced Query

Enables you to enter detailed queries for specific results.

For example, to obtain information for a subscriber matching the following criteria:

ID—john

Department—Starts with ABC

Mail ID—john@cisco.com

you would enter the query:

(&(sAMAccountName=john)(department=ABC*)(mail=john@cisco.com))
 
        

Configuring Usage Profiles

After you configure a site (see Configuring a Site), you can configure usage profiles for different levels of service at that site. For example, some users might need local and long distance access, whereas others need international access.


Note We recommend that you configure usage profiles for phone, line, and voicemail services before provisioning services for users.


To configure usage profiles:


Step 1 Choose Deployment > System Configuration > Sites, then click Next.

The Usage Profiles screen is displayed with the Standard profile, which is created automatically. See Figure 3.

Step 2 In the Sites list, choose the required site, then click New Profile.

Step 3 In the New Profile dialog box, enter a name for the new profile, then click OK.

After a few seconds, a message states that the profile has been created, and the profile list is updated with the new profile.

Step 4 In the profile list, click the Expand icon ()next to the profile name to expand the profile and view the configuration options.

Step 5 Select the options for LDAP imports (if applicable), dial plans, phones, and services using the information in Table 12.

If appropriate, click Default Service Settings to configure additional settings for the profile.


Note In the Default Service Settings dialog box, some of the provisioning attributes for lines, Extension Mobility lines, and Remote Destination Profile include an asterisk (*) next to the field name. The presence of an asterisk indicates that the attribute is a directory number-level attribute that can be shared among lines.


Step 6 Click Save.

Step 7 After the usage profile is successfully saved, click Deploy Site.

Deploying a site can take a few minutes while Provisioning Manager provisions all required objects on the Unified Communications devices. A summary screen displays the progress as Provisioning Manager deploys the site.


Note The Deploy Site button is displayed while the site is in Plan state. If the site is in Building or Active state, the button changes to Deployment Summary.



Example Screen

Figure 3 Usage Profiles Screen

Field Descriptions

Table 12 Usage Profiles Fields 

Field
Description

LDAP Information

Name

Profile name.

LDAP Import

If the site will import users from LDAP, you can automatically assign a profile to imported users by specifying the following information:

1. From the first drop-down list, choose the LDAP field to use for identifying potential users for this profile. Options are Title, Description, and Department.

2. In the second drop-down list, enter the specific information that must appear in the selected LDAP field for the user to be assigned this profile.

For example, if you want to automatically assign all vice-presidents and the CEO to an Executive profile, your entries would be:

LDAP field: Title

Matching information: CEO, *VP

Dial Plan

The options that are displayed depend on the dial plan selected when configuring the site.

North American Dial Plan

Check a check box to enable a dial option.

Custom Dial Plan

To configure a custom dial plan:

1. Click Build Custom dial plan using Infrastructure Configuration.

2. In the Infrastructure Configuration screen, choose the required processor.

3. In the Products list, choose the following provisioning options and add or modify existing entries as needed for the dial plan:

Call Search Space—Call search spaces for phones and lines using this dial plan.


Note Configure at least two call search spaces: one for phones in the dial plan, and one for lines in the dial plan.


Common Device Config—Common device settings for the dial plan.

Device Pool—Collection of device properties to use for this dial plan.

Location—Attribute that specifies the amount of bandwidth that is available to and from the location for the dial plan.

Route Partition—Partition to use for this dial plan.

4. In the Usage Profile screen, from each of the drop-down lists, choose the entry to use for the dial plan.

Services

Allow users to manage their own services (Self-Care)

Check the check box to allow users in this profile to manage their services via the Self-Care Portal.

Phone Selection

Identifies the phone models that are supported in this profile and the default phone model.

To identify the phone models supported by this profile and the default phone model:

1. To add phone models to the profile:

a. Click the More icon (). The available phone models are displayed.

b. Click a model to add it to the phone carousel.

2. In the phone carousel, click a phone model to identify it as the default model for the profile. A check mark is displayed on the selected phone.

3. To remove a phone model from the carousel, position your cursor over the model you want to remove, then click the x in the upper right corner of the phone icon.

Services

Identifies the services that are available for this profile.

Check the check box for a required service to include it in the profile:

Line—Enables a line.

Voicemail—Enables voicemail.

with Unified Messaging—Enables the retrieval of email from voicemail, and the retrieval of voicemail from email. This service is available if voicemail is enabled.


Note You must configure an exchange server in the Device Configuration screen for this service to be orderable.


Extension Mobility—Enables Extension Mobility services for users with this profile.

Remote Destination Profile—Enables Single Number Reach service for users with this profile.

Presence—Enables Unified Presence, Client Service, and Unified Presence User Settings.


5 Managing Sites and Users with Provisioning Manager

The following topics describe how to manage Provisioning Manager sites, users, and usage profiles on an ongoing basis:

Managing Sites

Managing Usage Profiles

Managing Users

Managing Sites

The following topics describe how to maintain and administer sites on an ongoing basis:

Adding Sites

Copying Sites

Deleting Sites

Transferring Users Between Sites and Usage Profiles

Adding Sites

Provisioning Manager enables you to add new sites as needed for your organization.

To add an additional site to Provisioning Manager:


Step 1 Choose Deployment > System Configuration > Sites.

Step 2 In the Site navigation pane, click New.

Step 3 In the New Site dialog box, enter a name for the site, then click OK.

Step 4 Provide the information described in Table 11, and click Save.

After the site is created, click Next to configure usage profiles as described in Configuring Usage Profiles.


Copying Sites

If you need to create a site with many of the same attributes as an existing site, you can create a copy of the existing site and then modify the configuration as needed for the new site.

To copy a site:


Step 1 Choose Deployment > System Configuration > Sites.

Step 2 In the Site navigation pane, choose the site that you want to copy, then click Copy.

Step 3 In the Copy Site dialog box, enter a name for the new site, then click OK.

Step 4 Update the information for the new site as described in Table 11, then click Save.

After the new site is created, click Next to configure usage profiles as described in Configuring Usage Profiles.


Deleting Sites

As business needs change, you might need to delete an existing site.

To delete a site:


Step 1 Choose Deployment > System Configuration > Sites.

Step 2 In the Site navigation pane, select the site that you want to delete, then click Delete.

Step 3 When prompted, confirm the deletion.


Transferring Users Between Sites and Usage Profiles

Provisioning Manager enables you to transfer users from one site or usage profile to another as needed.

The following conditions apply when transferring users from one site or usage profile to another:

If you transfer a user who has a phone model that is not supported by the new usage profile, the phone is provisioned with the default phone model of the new usage profile.

If you transfer a user with phone, line, and voicemail services to a new usage profile that supports presence services, the existing services are transferred to the new usage profile with the presence service.

If you transfer a user with phone, line, voicemail, and presence services to a new usage profile that does not support presence services, the presence service is not provisioned after the user is transferred to the new usage profile.

If the new usage profile supports additional features than the originally assigned profile (such as voicemail, unified messaging, remote destination profiles, or Extension Mobility), these additional features are not automatically provisioned for the user. The user can add these services after the transfer, as appropriate.

If you transfer a user who has a softphone, such as an Android device, to a new usage profile that does not support the user's softphone model, the user's softphone will be provisioned with the default physical phone type of the new profile and a temporary MAC address.

You cannot transfer a user who shares a line service with another user. Instead, first remove the shared line service from the user, then transfer the user.

A user cannot transfer to the same site.

To transfer a user to a different site or usage profile:


Step 1 Click User Management.

Step 2 In the Sites Information pane, choose the site associated with the user.

To reduce the list of users, choose a profile under the site name.

Step 3 In the Users table, click Add User > Transfer User.

Step 4 In the Transfer Selected User dialog box:

a. In the Users list, select the user to transfer.

b. From the Site drop-down list, select the site to transfer the user to.

c. In the Usage Profile list, select the usage profile for the user at the new site.

d. Click Next.

e. In the confirmation dialog box, confirm the transfer summary is correct, then click Submit.


Managing Usage Profiles

The following topics describe how to manage usage profiles on an ongoing basis as your telephony environment and needs change:

Updating Usage Profiles

Copying Usage Profiles

Deleting Usage Profiles

Obtaining a Usage Profile List

Obtaining a User List for a Usage Profile

Obtaining a Phone List for a Usage Profile

Updating Usage Profiles

Provisioning Manager enables you update usage profiles as needed. For example, over time you might need to accommodate new phone models or change the services supported by a profile.

To update a usage profile:


Step 1 Choose Deployment > System Configuration > Sites.

Step 2 In the navigation pane, choose the required site, then click Next.

Step 3 In the list of profiles, click the Expand icon next to the profile you want to update.

Step 4 Update the profile as required, using the information in Table 12, then click Save.


Copying Usage Profiles

If you create many profiles for a site, and the profiles contain many of the same attributes (such as phone types), you can copy an existing profile and then modify it as needed.

To copy a usage profile:


Step 1 Choose Deployment > System Configuration > Sites.

Step 2 In the navigation pane, choose the site with the profile you want to copy, then click Next.

Step 3 In the Usage Profiles pane, click Copy Profile.

Step 4 In the Copy Profile dialog box, provide the following information, then click OK:

a. From the Copy From drop-down lists, choose the site and profile to copy.

b. In the Name field, enter a name for the new profile.

After the copied profile is successfully created, the profile is added to the profile list.

Step 5 Modify the newly created profile as needed, then click Save.

For information about usage profile options, see Table 12.

Step 6 To update the site with the new profile, click Deploy Summary.


Deleting Usage Profiles

If a usage profile is no longer needed, you can delete it from Provisioning Manager.

To delete a profile:


Step 1 Choose Deployment > System Configuration > Sites.

Step 2 In the navigation pane, choose the site with the profile you want to delete, then click Next.

Step 3 In the profile list, select the profile you want to delete, then click Delete Profile.

Step 4 Confirm the deletion when prompted.


Obtaining a Usage Profile List

Provisioning Manager enables you to list all usage profiles for a site.

To obtain a list of usage profiles for a site:


Step 1 Click User Management.

Step 2 In the Sites Information pane, click the Expand icon next to the required site.

All usage profiles for the site are listed below the site name.


Obtaining a User List for a Usage Profile

Provisioning Manager enables you to identify the users associated with a specific usage profile and includes the following information for each user:

User ID

User name

Phone number

Extension

Status

User order status, hyperlinked to the orders associated with that user

Roles associated with the user

To obtain a user list for a usage profile:


Step 1 Click User Management.

Step 2 In the navigation pane, choose the required site and profile.

Step 3 In the content pane, click the Users tab.

The users associated with the selected site and profile are displayed.


Obtaining a Phone List for a Usage Profile

Provisioning Manager enables you to identify the IP phones associated a specific usage profile and includes the following information for each phone:

MAC address or device name

Phone model

Whether or not Extension Mobility is enabled

User ID

Line number and phone number

To obtain a phone list for a usage profile:


Step 1 Click User Management.

Step 2 In the navigation pane, choose the required site and profile.

Step 3 In the content pane, click the Phones tab.


Managing Users

The following topics describe how to administer and manage users in Provisioning Manager:

Adding Users

Setting Authorization Roles

Adding Services for Users

Verifying User Information and Services

Verifying User Self-Care Settings

Importing Users

Removing Users


Note Before you provision services, customize the phone, line, and voice mail attributes for each usage profile at the site. For information on configuring usage profiles, see Configuring Usage Profiles.


Adding Users


Note This procedure describes how to add individual users to Provisioning Manager. To import multiple users from a file, see Importing Users.


Provisioning Manager enables you to add new users as needed for your IP telephony environment.

To add a new user:


Step 1 Click User Management.

Step 2 In the Sites Information pane, choose the site and profile for the new user.

Step 3 Click Add User.

Step 4 In the Add User dialog box, enter the information described in Table 13, then click Add.

The list of users is updated with the new user.


Field Descriptions

Table 13 Add User Fields 

Field
Description

ID

User ID.

First Name

User first name.

Last Name

User last name.

PIN

Personal ID number for the user.

Confirm PIN

PIN confirmation.

Password

User password.

Confirm Password

User password confirmation.

Site

Site to which the user is assigned.

Usage Profile

User usage profile.

Phone Button Template

(Optional) Select the phone button template to apply to the user's phone. If you do not select a template, the default phone template will be provisioned for the phone and Extension Mobility access, based on the usage profile.

MAC Address

(Optional) Telephone MAC address.

A MAC address can be entered after a phone has been added.

If you do not enter a MAC address, Provisioning Manager provisions a temporary MAC address based on the default phone model for the usage profile until the actual MAC address is added.

Confirm MAC Address

MAC address confirmation.

Line Type

Line Type—Choose the type of line to be added:

Auto-Assigned Line—Assigns a number from the allocated directory block of numbers to this line.

Chosen Line—Assigns a specific number to this line. In the Directory Number field, enter the number to assign to this line.

Directory Number

Phone number to assign to the user.


Setting Authorization Roles

Provisioning Manager provides the following authorization roles for users:

Administration—User has complete access to Provisioning Manager.

Help Desk—User can add, transfer, change, and delete users and services.

Self-Care—User can update their account and services by using the Self-Care portal.

To set or change a user's authorization role:


Step 1 Choose User Management.

Step 2 In the Sites Information pane, choose the user's site and profile.

Step 3 In the Users table, select the user whose role you want to change, then click Authorization Roles.

Step 4 In the User Authorization Roles dialog box, check the check box for each role you want to enable for the user, then click Update.

In the Users table, the Roles column is updated with the user's roles.


Adding Services for Users

Provisioning Manager enables you add services for users when needed; for example, when new services become available at a site or when user needs change.

The following restrictions apply when adding services for users:

If you add Extension Mobility access to a shared line, the following Extension Mobility attributes are not set:

Line Description

Alerting Name

User Hold Audio Source

Auto Answer

Voicemail Profile

ASCII Alerting Name

Network Hold Audio Source

AAR Destination Mask

MLPP Target

MLPP No Answer Ring Duration

If you add remote destination profile service to a shared line, the following remote destination profile attributes are not set:

Line Description

Voicemail Profile

Alerting Name

ASCII Alerting Name

AAR Destination Mask

MLPP Calling Search Space

MLPP Target

MLPP No Answer Ring Duration


Note The attributes listed above might appear to be configured in the User Management screens when they are not. To configure these attributes, use the Self-Care portal.


To add services for a user:


Step 1 Click User Management.

Step 2 In the Sites Information pane, choose the user's site and profile.

Step 3 In the list of users, select the required user.

Step 4 In the toolbar, click the service you want to add, and provide the information described in Table 14.

The services that are displayed depend on the user's profile and the availability of the service at the site.


Field Descriptions

Table 14 Service Options 

Service Option
Description

Add Phone

In the Add Phone dialog box, provide the following information, then click Save:

Phone Type—Choose the phone type of the new phone.

Phone Button Template—Choose the template for the phone.

MAC Address—Enter the MAC address for the phone. If you do not enter a MAC address, Provisioning Manager provisions a temporary MAC address until the actual MAC address can be added.

Confirm MAC Address—Reenter the phone MAC address.

Add Line

Add Line

In the Add Line dialog box, provide the following information, then click Submit:

Product Type—Choose the service to which you want to add a line: Line, Extension Mobility Line, Remote Destination Profile Line.

Selected option—Where option depends on the selected service:

Selected Phone—Choose the phone to which the line is to be added.

Selected EM Access—Choose the Extension Mobility access profile.

Selected RDP—Choose the remote destination profile for the new line.

Line Position—Choose an available line.

Line Type—Choose the type of line to be added:

Auto-Assigned Line—Assigns a number from the allocated directory block of numbers to the line.

Chosen Line—Assigns the number in the Directory Number field to this line.

Directory Number—If you selected Chosen Line in the Line Type field, enter the number to assign to this line.

Add Shared Line

In the Add Shared Line dialog box, provide the following information, then click Submit:

Product Type—Choose the service to which you want to add a line: Line, Extension Mobility Line, Remote Destination Profile Line.

Selected option—Where option depends on the selected service:

Selected Phone—Choose the phone to which the line is to be added.

Selected EM Access—Choose the Extension Mobility access profile.

Selected RDP—Choose the remote destination profile for the new line.

Line Position—Choose an available line. This option is available for Line and Extension Mobility Lines only.

Directory Number—Choose the number to assign to the shared line.

Add Line on Shared Phone

In the Add Line on a Shared Phone dialog box, provide the following information, then click Submit:

Target Phone—Choose the shared phone to receive a new line.

Line Position—Choose an available line.

Line Type—Choose the type of line to be added:

Auto-Assigned Line—Assigns a number from the allocated directory block of numbers to the line.

Chosen Line—Assigns the number in the Directory Number field to this line.

Directory Number—If you selected Chosen Line in the Line Type field, enter the number to assign to this line.

Add Unified Messaging

Add Unified Messaging for a Line

In the Add Unified Messaging dialog box, provide the following information, then click Submit:

Product Type—Choose Line.

Selected Line—Choose the line to add voicemail to.

Voicemail Alias—Enter the alias for the voicemail service.

Voicemail Display Name—Enter the name to be displayed for voicemail.

Add Unified Messaging for an Extension Mobility Line

In the Add Unified Messaging dialog box, provide the following information, then click Submit:

Product Type—Choose Extension Mobility Line.

Selected EM Line—Choose the Extension Mobility line to add voicemail to.

Voicemail Alias—Enter the alias for the voicemail service.

Voicemail Display Name—Enter the name to be displayed for voicemail.

Add Unified Messaging for a Remote Destination Profile Line

In the Add Unified Messaging dialog box, provide the following information, then click Submit:

Product Type—Choose Remote Destination Profile Line.

Selected Line—Choose the Remote Destination Profile line to add voicemail to.

Voicemail Alias—Enter the alias for the voicemail service.

Voicemail Display Name—Enter the name to be displayed for voicemail.

Add Voicemail

Add Voicemail

In the Add Voicemail dialog box, provide the following information, then click Submit:

Selected Line—Choose the line to add voicemail to.

Voicemail Alias—Enter the alias for the voicemail service.

Voicemail Display Name—Enter the name to be displayed for voicemail.

Note If the selected usage profile includes Unified Messaging Service as an orderable product, the Add Voicemail option is not displayed in the toolbar. Instead, the Add Unified Messaging option is displayed. If you choose Add Unified Messaging, voicemail is included as part of the Unified Messaging product.

More Services

Add Presence

In the Add Presence dialog box, click Submit to confirm Presence service for the user.

Add Single Number Reach

In the Add Single Number Reach dialog box, enter the following information, then click Submit:

Name—Enter a name for this service.

Line Type—Choose the type of line to be added:

Auto-Assigned Line—Assigns a number from the allocated directory block of numbers to the line.

Chosen Line—Assigns the number in the Directory Number field to this line.

Directory Number—If you selected Chosen Line in the Line Type field, enter the number to assign to this line.

Add Extension Mobility

In the Add EM Access and Line dialog box, enter the following information, then click Submit:

Name—Enter a name for this service.

Phone Button Template—Choose the phone button template to use for this service.

Line Type—Choose the type of line to be added:

Auto-Assigned Line—Assigns a number from the allocated directory block of numbers to the line.

Chosen Line—Assigns the number in the Directory Number field to this line.

Directory Number—If you selected Chosen Line in the Line Type field, enter the number to assign to this line.


Verifying User Information and Services

Provisioning Manager enables you to verify user information and their telephony services, and examine the attributes of each phone, line, and service.

To verify user information and telephony services:


Step 1 Click User Management.

Step 2 In the Sites Information pane, choose the user's site and profile.

Step 3 In the Users table, select the required user.

The following sections are displayed below the Users table (see Figure 4):

General Information—Displays the user ID, name, site, usage profile, phone number, extension, status, and authorization roles.

Service Information—Nested entries display the phones, lines, and services associated with the user, and the configuration settings for each item.

Step 4 Click the Expand icon next to each phone, line, or service to examine the configuration details.


Example Screen

Figure 4 User Telephony and Services Information

Verifying User Self-Care Settings

Provisioning Manager enables you to verify a user's settings in the Self-Care portal.

To verify a user's settings in Self-Care:


Step 1 Click User Management.

Step 2 In the Sites Information pane, choose the user's site and profile.

Step 3 In the Users table, select the required user.

Step 4 Click Personal Settings.

The Self-Care portal for the selected user is displayed in a separate browser tab for your review.

For information on Self-Care options, see Configuring Self-Care Options.


Importing Users

Provisioning Manager enables you to import multiple users in a single operation in the following ways:

Using a file in comma-separated value (CSV) or text (TXT) format—See Using a File.

Using an LDAP server—Using an LDAP Server.


Note The following topics describe how to import multiple users from a file or an LDAP server. For information on adding individual users, see Adding Users.


Using a File

Provisioning Manager enables you to import multiple users in a single operation by using a provided template in comma-separated value (CSV) or text (TXT) format.

Before You Begin

Ensure that the user account passwords do not include a character that is repeated three or more times consecutively. If Provisioning Manager detects a password with the same character repeated three times consecutively, it will issue an error. Examples of passwords that would result in errors are csvCOCI999 and c999OCI1965.

To import users into Provisioning Manager by using a file:


Step 1 Click User Management.

Step 2 Create a user import file:

a. Choose Add User > Import User.

b. In the Import User dialog box, click the From File radio button.

c. Download a CSV or TXT import file template. Each template contains example content for your reference.

d. Enter the information for the users you want to import.


Note User names can contain only letters (A-Z, a-z), digits (0-9), hyphens (-), underscores (_), dots (.), at signs (@), apostrophes (`), and spaces.


e. Save the file.

Step 3 Import the user import file:

a. Click Add User > Import User.

b. In the File to Import field, navigate to the user import file that you created, then click Upload.

After the user import file is located and examined, a Preview Import Users dialog box lists the users to be imported. If an error is found in the file, a message is displayed that indicates the location of the error.

Step 4 In the Preview Import Users dialog box, click Import to import the identified users.

The Users table is updated with the newly imported users.


Using an LDAP Server

Provisioning Manager enables you to import multiple users in a single operation from an LDAP server.

Before You Begin

Configure access to the LDAP server and initiate synchronization before importing users from an LDAP server. For information on configuring access to and synchronization with an LDAP server, see the following topics:

Configuring Provisioning Manager Communications

Configuring a Site


Note Directory numbers must be specified for users in one of the following ways:

- In Site Management, a range of directory numbers configured in the Directory Number Block area.
- In LDAP, a directory number assigned to each user.

The import operation will fail if you import users without directory numbers, and the site does not have a directory number block configured.


To import users into Provisioning Manager from an LDAP server:


Step 1 Click User Management.

Step 2 Choose Add User > Import User.

Step 3 In the Import User dialog box, click the From LDAP radio button.

Step 4 In the Site field, choose the site configured for importing from LDAP, then click Import.

Step 5 To view the results of the last synchronization between Provisioning Manager and the LDAP server, click Last Sync Report.


Removing Users

Provisioning Manager enables you to remove users as needed.

To remove a user:


Step 1 Click User Management.

Step 2 In the Sites Information pane, choose the user's site and profile.

Step 3 In the Users table, select the user to remove.

Step 4 Choose Add User > Remove User, and confirm the removal when prompted.

The user is removed from the Users table.


6 Configuring Self-Care Options

The Provisioning Manager Self-Care portal enables you to set individual attributes and personal preferences for the following aspects of phone use:

Phone or Profile:

Phone options include configuring speed dial numbers, do not disturb options, and music when a call is placed on hold.

Profile options allow you to configure options for Extension Mobility and Single Number Reach.

Line—Options for a specific line on the phone, such as call forwarding, caller identification, and notifications.

User—Options for the phone user, such as passwords and personal identification numbers (PINs).

To log into the Self-Care portal:

1. In a browser, enter https://host where host is the hostname or IP address of the Provisioning Manager server.

2. Enter your username and password.

The Self-Care portal is displayed as shown Figure 5.

Figure 5 Self-Care Portal

The Self-Care portal screen contains the following elements:

Phone carousel—The phone carousel (positioned in the lower left side of the screen) contains icons for the phones and service profiles that you can configure. Click the icons at either side of the visible icons to view the additional phones or profiles.

Main menu—The main menu options (to the right of the phone carousel) are Phone Settings, Line Settings, and User Settings. Depending on your selection in the phone carousel, the Phone Settings option might be replaced by Extension Mobility Settings or Single Number Reach Settings.

Configuration area—The configurable categories for the selected main menu option appear next. When you click a category, such as Speed Dials, the right side of the screen displays the configurable options.

To ensure that you configure the correct phone or profile and line:

1. In the phone carousel, select the phone or profile you want to configure.


Note Not all options are available for all phone models. As a result, you might see Self-Care options that do not apply to your phone. For example, you might see an option for enabling video, when video calls are not available for your phone. If you select one of these options, the option is not saved.


2. In the Line Settings menu, make sure that you select the correct line for the options you are configuring.

For information on configuring the available options, see the following sections:

Configuring Phone Settings

Configuring Extension Mobility Settings

Configuring Single Number Reach Settings

Configuring Line Settings

Configuring User Settings

Configuring Phone Settings

The following topics describe how to configure phone options and features:

Setting the MAC Address

Configuring Speed Dial

Configuring Do Not Disturb Options

Specifying User Locale

Configuring Music On Hold Options for a Phone

Configuring Other Phone Options

Setting the MAC Address

When administrators provision phones, they do not need to enter a MAC address for each phone. If a MAC address is not provided, Provisioning Manager automatically assigns a temporary MAC address until a valid one can be entered.

You can change a phone MAC address if Provisioning Manager has assigned a temporary one to the phone or if your existing phone is replaced by a different phone.

You can ensure that your phone and its features work properly by entering a valid MAC address through the Self-Care portal.

To set your phone MAC address using Self-Care:


Step 1 Choose Phone Settings > General.

Step 2 In the MAC Address field, enter a valid MAC address for your phone.

Step 3 Reenter the MAC address in the Confirm MAC Address field.

Step 4 Click Save.


Configuring Speed Dial

Speed dial enables you to quickly dial a number from a list of phone numbers that you configure on your phone. Depending on your phone model, you either press one or more buttons on the phone, or access a menu to dial a speed dial number.

To configure speed dial:


Step 1 Choose Phone Settings > Speed Dials.

Step 2 In the Speed Dials screen, click Add.

Step 3 Enter the following information:

Index—Position of the speed dial, such as 1, 3, 5, and so on.

Number—Phone number.

Label—Name for speed dial entry.

Step 4 Click Save, then click Save.


To modify or delete an existing speed dial entry, click the radio button for the required entry, then click Edit or Delete.

Configuring Do Not Disturb Options

The Do Not Disturb feature enables you to disable audible ringing for incoming calls. When the Do Not Disturb feature is enabled, incoming calls do not ring on the phone. Instead, a visual alert is given and the call information is displayed. You can answer incoming calls while the Do Not Disturb feature is enabled.

To configure Do Not Disturb options:


Step 1 Choose Phone Settings > Do Not Disturb.

Step 2 Check the Enable Do Not Disturb check box.

Step 3 In the DND drop-down list, choose the action to be taken when an incoming call arrives:

Call Reject—The call is rejected and the caller receives a busy signal.

Ringer Off—The ringer is turned off for incoming calls and a visual alert is displayed.

Use Common Phone Profile Setting—The call is handled as defined by the common phone profile.

Step 4 Click Save.


To disable the Do Not Disturb feature, uncheck the Enable Do Not Disturb check box and click Save.

Specifying User Locale

Provisioning Manager uses information about your location to ensure that the phone is configured appropriately for your environment, such as language, font, date and time formatting, and alphanumeric keyboard text information.

To specify your user locale:


Step 1 Choose Phone Settings > Locale.

Step 2 From the User Locale drop-down list, choose your location, then click Save.


Configuring Music On Hold Options for a Phone

Provisioning Manager enables you to select the audio source that plays when you place a call on hold.


Note You can also set Music On Hold Options for individual lines on a phone. For more information, see Configuring Music On Hold Options for a Line.


To configure Music On Hold options for a phone:


Step 1 Choose Phone Settings > Music On Hold.

Step 2 From the User Hold Audio Source drop-down list, choose the audio source to play when you place a call on hold, then click Save.


Configuring Other Phone Options

Provisioning Manager enables you to enable or disable the following phone features:

Phone speakerphone

Phone speakerphone and headset

Video calls

Phone PC port

Extension Mobility

To configure these options:


Step 1 Choose Phone Settings > Others.

Step 2 Check or uncheck the check box as required for each option by using the information in Table 15, then click Save.


Field Descriptions

Table 15 Field Descriptions for Other Phone Settings 

Field
Description

Disable Speakerphone

Check the check box to disable the phone speakerphone.

Disable Speakerphone and Headset

Check the check box to disable the phone speakerphone and headset.

Enable Video

Check the check box to enable video calls on the phone.

Video calls are available only if both endpoints support video calls.

Enable PC Port

Enabled by default.

Uncheck the check box to disable the PC port on the phone. Disabling the PC port is useful for phones in lobbies or conference rooms.

Enable Extension Mobility

Enabled by default.

The Extension Mobility feature enables any user who uses the phone to log into the phone and use the phone as their own, on a temporary basis. When the user logs in, the phone adopts their default device profile information (including line numbers, speed dials, services links, and other user-specific properties), and dynamically configures the phone to that device profile. The Extension Mobility feature is most commonly used by employees who share office spaces on a rotational basis.

Uncheck the check box to disable Extension Mobility.


Configuring Extension Mobility Settings

See the following topics to configure Extension Mobility settings:

Configuring Speed Dial

Configuring Do Not Disturb Options

Specifying User Locale

Configuring Music On Hold Options for a Phone

Configuring Single Number Reach Settings

See the following topics to configure Single Number Reach settings:

Configuring Do Not Disturb Options

Specifying User Locale

Configuring Music On Hold Options for a Phone

Configuring Alternate Numbers

Configuring Alternate Numbers

The Single Number Reach feature enables you to associate a another phone number with your business IP phone number. When a call is received on the business phone number, Provisioning Manager automatically directs the call to ring on the phone you specify as well as the business phone. In this way, the Single Number Reach feature enables callers to reach you by dialing a single number, regardless of your location.

To configure an alternate number for Single Number Reach:


Step 1 In the phone carousel, select the icon associated with the remote destination profile.

Step 2 Choose Single Number Reach Settings > Alternate Numbers.

Step 3 Provide the information as described in Table 16, then click Save.

Step 4 If needed, click Add New to add an additional alternate number.


Field Descriptions

Table 16 Field Descriptions for Alternate Numbers 

Field
Description

Alternate Number

Enter the alternate number that Provisioning Manager is to direct calls to when calls are received on your primary phone.

Description

(Optional) Enter a description of the alternate number.

Enable Reach Me Anywhere

Check the check box to enable incoming calls to ring on multiple phones at the same time.

This is a mobile device

Check the check box if the alternate number is for a mobile device.

Allow me ... seconds to answer

Enter the length of time (in tenths of seconds) that Provisioning Manager should wait for you to answer the call on the primary phone before directing the call to the alternate number.

Continue ringing the alternate number for ... seconds

Enter the length of time (in tenths of seconds) that Provisioning Manager should ring at the alternate number.

If the alternate number answers within ... seconds

Enter the length of time (in tenths of seconds) that Provisioning Manager should wait after directing a call to the alternate device before connecting a call on the device. This delay prevents calls from being picked up by automated greetings, such as voice mail, on the device.

Line Association Information

Check the check box for the line to associate with this alternate number.


Configuring Line Settings

The following topics describe how to configure options and features for individual phone lines:

Configuring Call Forwarding Options

Configuring Caller ID Options

Setting Ring and Notification Options

Configuring Music On Hold Options for a Line

Configuring Call Forwarding Options

Provisioning Manager enables you to configure the following call forwarding options for each line on your phone:

Default call forwarding options

Options for external incoming calls

Options for internal incoming calls

To configure call forwarding options:


Step 1 Choose Line Settings > Call Forward.

Step 2 To configure call forwarding options, enter the information described in Table 17.

Step 3 Click Save.


Field Descriptions

Table 17 Field Descriptions for Call Forwarding 

Field
Description

Line

Choose the line to configure for call forwarding.

General Tab

Phone State

Forward All (read-only).1

Action

Choose the action to take for the phone state Forward All:

None—Take no action.

Voicemail—Forward the call to voicemail.

Use Number—Forward the call to the number entered in the Number field. If you do not enter a number in the Number field, Provisioning Manager defaults to None.

Number

For the action Use Number, enter the number to which calls are to be forwarded.

If you choose Use Number but do not enter a number in the Number field, Provisioning Manager defaults to None.

No Answer Ring Duration (seconds)

Enter the length of time, in seconds, to wait without someone answering the phone before forwarding the call.1

Call Pickup Group

Choose the call pickup group to which this line belongs.1

External Tab

Phone State

Identifies the available phone states (read-only):1

Busy

No Answer

No Coverage

Unregistered

Action

For each phone state, choose the action to take:

None—Take no action.

Voicemail—Forward the call to voicemail.

Use Number—Forward the call to the number entered in the Number field. If you do not enter a number in the Number field, Provisioning Manager defaults to None.

Number

For the action Use Number, enter the number to which calls are to be forwarded.

If you choose Use Number but do not enter a number in the Number field, Provisioning Manager defaults to None.

Internal Tab

Phone State

Identifies the available phone states (read-only):1

Busy

No Answer

No Coverage

Unregistered

Action

For each phone state, choose the action to take:

None—Take no action.

Voicemail—Forward the call to voicemail.

Use Number—Forward the call to the number entered in the Number field. If you do not enter a number in the Number field, Provisioning Manager defaults to None.

Number

For the action Use Number, enter the number to which calls are to be forwarded.

If you choose Use Number but do not enter a number in the Number field, Provisioning Manager defaults to None.

Info to Forward Tab

Caller Name

Check the check box to forward the caller name when forwarding calls.

Caller Number

Check the check box to forward the caller number when forwarding calls.

Dialed Number

Check the check box to forward the dialed number when forwarding calls.

Redirected Number

Check the check box to forward the redirected number when forwarding calls.

1 The asterisk (*) indicates an attribute at the directory number level that can be shared among lines.


Configuring Caller ID Options

Provisioning Manager enables you to configure caller ID options for each line on your phone.

To configure caller ID options:


Step 1 Choose Line Settings > Caller ID.

Step 2 From the Line drop-down list, choose the line to configure for caller ID.

Step 3 In the Line Text Label field, enter text that identifies this line on this phone.

Step 4 In the Display (Internal Caller ID) field, enter the text that is displayed for internal calls. If this field is left empty, the extension number is displayed.

Step 5 In the Line Description field, enter a brief line description.

The asterisk (*) indicates that this is an attribute at the directory number level that can be shared among lines.

Step 6 Click Save.


Setting Ring and Notification Options

Provisioning Manager enables you to set the ring and notification options for each line on your phone for each of the following conditions:

The phone is idle.

The phone is active.

A phone message has been received.

To set ring and notification settings:


Step 1 Choose Line Settings > Notification.

Step 2 From the Line drop-down list, choose the line to configure.

Step 3 Set the notification options for the line using the information in Table 18, then click Save.


Field Descriptions

Table 18 Field Descriptions for Notification Settings 

Field
Description

Ring Setting (Phone Idle)

Choose the notification method to use if a call arrives and the phone is idle:

Use System Default

Disable

Flash Only

Ring Once

Ring

Ring Setting (Phone Active)

Choose the notification method to use if a call arrives while the phone is in use:

Use System Default

Disable

Flash Only

Ring Once

Ring

Beep Only

Message Waiting Policy

Choose the notification method to use if a message has arrived:

Use System Policy

Light and Prompt

Prompt Only

Light Only

None


Configuring Music On Hold Options for a Line

Provisioning Manager enables you to select the audio source that plays for a specific line when you place a call on hold.


Note You can also set Music On Hold Options for a phone. For more information, see Configuring Music On Hold Options for a Phone.


To configure Music On Hold options for a line:


Step 1 Choose Line Settings > Music On Hold.

Step 2 From the Line drop-down list, choose the line to configure for Music On Hold options.

Step 3 From the User Hold Audio Source drop-down list, choose the audio source to play when you place a call on hold.

The asterisk (*) indicates that this is an attribute at the directory number level that can be shared among lines.

Step 4 Click Save.


Configuring User Settings

The following topics describe how to configure and verify your user settings:

Changing Your Personal Information

Changing Your Password

Changing Your PIN

Changing Your Personal Information

Provisioning Manager enables you to verify your current phone information and optionally provide an email address.

To verify your phone settings:


Step 1 Choose User Settings > Information.

Step 2 Confirm or update the information as described in Table 19, then click Save.


Field Descriptions

Table 19 User Information in Self-Care

Field
Description

User ID

Your Provisioning Manager user ID (read-only).

First Name

Your first name.

Last Name1

Your last name.

Email

Your email address.

Site

Your Provisioning Manager site (read-only).

Usage Profile

Your usage profile (read-only).

Primary Device

MAC address of your primary device.

1 This is a mandatory field.


Changing Your Password

Provisioning Manager enables you to change your passwords for Self-Care, Unified Communications Manager, and Unity Connection Web.


Note If Provisioning Manager is integrated with LDAP, you cannot change the Self-Care login password.


To change your password:


Step 1 Choose User Settings > Password.

Step 2 From the Password Type drop-down list, choose the type of password you want to change.

Step 3 In the Password and Confirm Password fields, enter the new password and confirm it.

Step 4 Click Save.


Changing Your PIN

Provisioning Manager enables you to easily change your phone and voice mail personal identification numbers. If you change your PIN, your PIN is updated in Unified Communications Manager and Unity Connection.

To change your PIN:


Step 1 Choose User Settings > PIN.

Step 2 In the PIN Type drop-down list, choose the type of PIN you want to change.

Step 3 In the PIN and Confirm PIN fields, enter your new PIN and confirm it.

Step 4 Click Save.


7 Managing Provisioning Manager

The following sections describe Provisioning Manager management activities:

Backing Up Provisioning Manager

Restoring Provisioning Manager

Resetting the Provisioning Manager Admin Password

Resetting the PostgreSQL Admin Password

Changing the Provisioning Manager Server IP Address

Backing Up Provisioning Manager

To back up Provisioning Manager:


Step 1 Stop Apache, JBoss, and NICE services by entering the following commands:

ps -aef | grep startcupm 
ps -aef | grep nice 
kill startcupm-process-id
kill nice-process-id
 
   

Step 2 Enter the following command to navigate to the /opt/postgres/9.0/bin directory:

cd /opt/postgres/9.0/bin
 
   

Step 3 Enter the following command:

./pg_dumpall -o -U pmadmin /mnt/bak
 
   

where pmadmin is the PostgreSQL user ID and /mnt is the directory where the backup file named bak will be created.

Step 4 Enter the following commands to restart Apache, JBoss, and NICE services:

nohup /opt/cupm/sep/build/bin/startcupm.sh > /opt/cupm/sep/logs/jboss.log 2>&1 &
nohup /opt/cupm/sep/build/bin/nice.sh NICE:01 > /opt/cupm/sep/logs/nice.log 2>&1 &
 
   

Restoring Provisioning Manager

To restore Provisioning Manager from a backup:


Step 1 Stop Apache, JBoss, and NICE services by entering the following commands:

ps -aef | grep startcupm 
ps -aef | grep nice 
kill startcupm process-id
kill nice-process-id
 
   

Step 2 Enter the following command to navigate to the /opt/postgres/9.0/bin directory:

cd /opt/postgres/9.0/bin
 
   

Step 3 Enter the following command:

./psql.bin -U pmadmin -d postgres
 
   

where pmadmin is the username.

Step 4 Enter the following command:

DROP DATABASE cupm 
 
   

where cupm is the database.

If you receive an error stating that the database is being accessed by other users, perform the following steps:

a. Enter \q to exit the PostgreSQL terminal.

b. Enter the following commands:

   ps -aef
   kill </opt/cupm/jvm/bin/java -server -classpath /opt/cupm/sep/lib/dom.jar:/opt/cupm/sep/lib/jaxb-    	
api.jar:/opt/cupm/sep/lib/jaxb-impl.jar>
 
   

c. Return to Step 4 to resume restoring Provisioning Manager from the backup.

Step 5 Enter the following command:

DROP ROLE rolename 
 
   

where rolename is username for the SEP database user. The default username is cupm.

Step 6 Enter the following command:

ALTER ROLE username WITH PASSWORD `password'; 
 
   

where username is username of the PostgreSQL administrator user, and password is the password for the PostgreSQL administrator on the machine with the backed-up data. The default username is postgres.

Step 7 Enter \q to exit the PostgreSQL terminal.

Step 8 Navigate to the directory /opt/postgres/9.0/bin and enter the following command:

./CUPM-restore.sh pmadmin postgres /mnt/bak
 
   

Step 9 Enter the following commands to restart Apache, JBoss, and NICE services:

nohup /opt/cupm/sep/build/bin/startcupm.sh > /opt/cupm/sep/logs/jboss.log 2>&1 &
nohup /opt/cupm/sep/build/bin/nice.sh NICE:01 > /opt/cupm/sep/logs/nice.log 2>&1 &
 
   

Resetting the Provisioning Manager Admin Password

To ensure that access to Provisioning Manager meets the security requirements at your site, you can reset the password for the Provisioning Manager pmadmin administrative account.

To reset the password for pmadmin:


Step 1 Log into the Provisioning Manager server as root using SSH.

Step 2 Open the command prompt.

Step 3 Enter the following command:

./ResetCUPMAdminPassword.sh password ALL
 
   

where password is the new password.


Resetting the PostgreSQL Admin Password

As needed, you can reset the password for the PostgreSQL administrative account.

To resent the PostgreSQL admin password:


Step 1 Log into the Provisioning Manager server as root using SSH.

Step 2 Open the command prompt.

Step 3 Enter the following command:

./ResetPostgresAdminPassword.sh password ALL
 
   

where password is the new password.


Changing the Provisioning Manager Server IP Address

If needed, you can change the IP address of the Provisioning Manager server.

To change the IP address:


Step 1 Using PuTTY or the SSH Tectia Client, log into the Provisioning Manager server using the root account.

Step 2 Back up the following files:

- /etc/passwd

- /etc/passwd-

- /etc/group

- /etc/group-

Step 3 Enter the following command:

/opt/system/bin/setup -c
 
   

Step 4 Restore the files that you backed up in Step 2 to the folder /etc.

Step 5 Power off the VM, then power it on again.

Step 6 When prompted during the reboot, provide the required information, including the new IP address. You can use the information in Configuring Provisioning Manager VM Communications as a guide.

Step 7 When the server reboots again, log in using the new IP address for the server.


8 Troubleshooting Provisioning Manager

You can use the following tools to debug Provisioning Manager issues:

Abort Orders—Aborts or clears orders created in Provisioning Manager.

Change Log Level—Temporarily changes the Provisioning Manager log level without restarting Provisioning Manager.

Show Tech—Collects the required troubleshooting information in a single, compressed archive file.

If you encounter problems while working with these Provisioning Manager tools, see Fixing File Problems for help.

Abort Orders

Abort Orders is a CLI tool used to abort or clear orders created in Provisioning Manager. For orders in Recoverable Error or Unrecoverable Error state, this tool provides the options to remove one or all of these orders. The tool attempts to initiate an orderly abort with proper rollback. However, this cannot be guaranteed because it depends on the state of the order.


Note Do not use this tool if you do not have a good understanding of failed orders, because aborting a running order can result in data integrity issues.


To abort orders:


Step 1 Log into the Provisioning Manager server as root using SSH.

Step 2 Open the command prompt.

Step 3 Go to the script directory:

cd/mnt/data/cupm/sep/build/bin 
 
   

Step 4 Run the following command with the appropriate options:

./AbortOrders.sh userid password [Errors | RecoverableErrors | UnrecoverableErrors | order-id [-forced]]
 
   

- userid—Enter pmadmin as the userid. The userid should have admin privileges.

- password—Password associated with the pmadmin userid.

- Errors—Aborts all the orders that are in Recoverable or Unrecoverable error state.

- RecoverableErrors—Aborts all the orders that are in Recoverable state.

- UnrecoverableErrors—Aborts all the orders that are in Unrecoverable state.

- order-id—Aborts the order with the specified ID, only if the order is in the Error state.

- order-id [-forced]—Forces the order with the specified ID to abort. The order can be in any state. This option can be used to abort stuck orders.


Change Log Level

Change Log Level is a CLI tool that temporarily changes the Provisioning Manager log level without restarting Provisioning Manager. When you restart Provisioning Manager, the log level reverts to the level configured in the dfc.properties file. This tool changes the log level only for SEP and NICE logs.

To permanently change log level, you must change the value of dfc.log.level in the dfc.properties file located in:

CUPM_INSTALL_DIR/sep/build/bin

and restart Provisioning Manager.

Provisioning Manager logs are stored in:

/mnt/data/cupm/sep/logs

To temporarily change the log level:


Step 1 Log into the Provisioning Manager server as root using SSH.

Step 2 Open the command prompt.

Step 3 Go to the script directory:

cd CUPM_INSTALL_DIR/sep/ipt/bin
 
   

Step 4 Run the following command with the appropriate options to change the log level:

./changelogleve.sh -level loglevel [APPSERVER | NICE | BOTH]
 
   

If APPSERVER, NICE, or BOTH is not specified, the default option of BOTH is used.

loglevel can be DETAIL, LOW, NORMAL, HIGH, or EMERGENCY.


Show Tech

Show Tech is a CLI tool that collects required troubleshooting information in a single compressed archive file.

While collecting the troubleshooting data, and before writing to the output directory, the tool checks that at least 100 MB of free disk space is available on the target drive. During data collection, if 100 MB of free disk space is not available, the tool will abort (with an appropriate message) and clean up the drive, thereby preventing the risk of consuming too much disk space. We recommend that you refine the date range options to limit the data to be collected, and rerun the tool.

To collect troubleshooting information in a single compressed archive file:


Step 1 Log into the Provisioning Manager server as root using SSH.

Step 2 Open the command prompt.

Step 3 Go to the script directory:

cd CUPM_INSTALL_DIR/sep/build/bin 
 
   

Step 4 Enter the following command with the appropriate options:

./showtech.sh -start START_DATE -end END_DATE [options]
 
   

where:

- START_DATE is the starting date and time in YYYY-MM-DD HH:MM format.

- END_DATE is the ending date and time in YYYY-MM-DD HH:MM format.

Options include:

- outputDiroutput directory; the default is the OS temp directory.

- component COMPONENT—component data to collect (ALL | DEPLOYMENT | LOGS | ORDER | SYSTEM); the default is ALL.


Fixing File Problems

Error: Bad Interpreter: No such file or directory

If you get this error while using the troubleshooting tools, do the following:


Step 1 Open the file using a VI editor:

vi filename
 
   

Step 2 After the file is loaded, enter the following command:

:setfileformat=unix
 
   

Step 3 Save and exit the file by entering the following command:

:!wq
 
   

Error: File contains ^M and the script does not run

If you get this error while using the troubleshooting tools, do the following:


Step 1 Open the file using a VI editor:

vi filename
 
   

Step 2 After the file is loaded, enter the following command:

:setfileformat=unix
 
   

Step 3 Save and exit the file by entering the following command:

:!wq
 
   

Error: No permission for running the file.

If you encounter this error:


Step 1 Log into the Provisioning Manager server as root using SSH.

Step 2 Open the command prompt.

Step 3 Navigate to the directory that contains the required file.

Step 4 Enter the following command:

chmod 777 filename
 
   

where filename is the problematic file.


9 Provisioning Manager Dial Plan

The Provisioning Manager 9.0BE dial plan uses the line/device calling search space (CSS) approach and has the following characteristics:

The line CSS is intended to enforce Class of Restriction (that is, dialing privileges). Anything else should be configured in the device CSS.

Line CSSes are associated with partitions that block calls.

Device CSSes are associated with partitions that route calls to internal, voice-mail, local, long-distance, and international destinations.

Core 11-digit numbers (1 plus 10 digits) are stored as directory numbers in the global partition PHONES_PT; for example, 14085276001.

For intra-site calls, Provisioning Manager provisions translation patterns during the deployment of a site. For example, if five digits are used for intra-site calls, then translation patterns to handle five digits are created.

For inter-site calls, full E164 numbers (1 plus 10 digits) are used, such as 14085276001.

The external phone number mask (1 plus 10 digits) should be configured on the line. When a call is made using that line, the external phone number mask is displayed, such as Calling Party Number = 14085276001.

All inbound PSTN gateways are configured to use the 10 digits of the inbound Direct Inward Dial (DID) number. Prefix DN = 1 is set at the gateway for inbound calls to append 1 to the incoming 10 digits.

Voicemail Pilot is stored in global partition SHARED_PT.

Figure 6 provides a graphical representation of the Provisioning Manager dial plan and the required CSSes and partitions.


Note Customers must configure any additional required partitions, calling search spaces, translation patterns, or route patterns.


Figure 6 Calling Search Spaces and Partitions Needed with the Line/Device Approach

10 Customizing the Self-Care Portal

Provisioning Manager enables you to customize the Self-Care portal with your logo and company name.

To customize the Self-Care portal:


Step 1 Open the P90XProperties.js file located in the following directory:

CUPM-install\sep\deploy\dfc.ear\dfc.war\ipt\selfcare\nls

where CUPM-install is the directory in which Provisioning Manager was installed. The default installation directory is /opt/cupm.

Step 2 Add the following properties to the file:

"CLIENT_PRODUCT_FAMILY":"PRODUCT_FAMILY",
"CLIENT_PRODUCT_TITLE":"PRODUCT_TITLE",
"CLIENT_IMAGE_PATH":"img/ciscologo_68x38.png",
 
   

The file uses the following conventions:

- Property keys and values are placed within double quotation marks ("  ").

- A comma (,) separates properties.

- A colon (:) separates the property key and value.

Step 3 Replace the following values with your information:

- PRODUCT_FAMILY

- PRODUCT_TITLE

Step 4 Add the desired logo to the img directory, and then update the value for CLIENT_IMAGE_PATH with the name of the file that you added to the img directory.


11 Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as an RSS feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service. Cisco currently supports RSS Version 2.0.