User Guide for Cisco Unified Provisioning Manager 1.3.1
Administering Provisioning Manager
Downloads: This chapterpdf (PDF - 358.0KB) The complete bookPDF (PDF - 6.5MB) | Feedback

Administering Provisioning Manager

Table Of Contents

Administering Provisioning Manager

Viewing Licensing Information

Licensing Process

Obtaining a PAK

Obtaining a License File

Registering a License File with Provisioning Manager

Launching Cisco Unified Operations Manager IP Phone Details

Setting Throttling Values for Cisco Unified Communications Managers

Managing Log Files

Changing the Log Level

Changing the Maximum Log File Size

Changing the Log Purging Level

Enabling Data Purging

Configuring Provisioning Manager to Use AAA Servers

Adding a AAA Server

Enabling SSL Support for a AAA Server

Changing AAA Server Information

Testing the Connection to a AAA Server

Maintenance Mode

Provisioning Manager Database Backup and Restore

Changing the IP Address on a Provisioning Manager Systems

Changing the IP Address on the Provisioning Manager Server (for a Distributed Setup)

Changing the IP Address on the Provisioning Manager Database Server (for a Distributed Setup)

Provisioning Manager Processes

Scheduling Synchronizations

Searching Inventory

Using Inventory Search

Performing Basic Searches

Performing Advanced Searches

Return Values

Creating Search Reports

Running Search Reports

Editing Search Reports

Deleting Search Reports

Viewing System Reports


Administering Provisioning Manager


This chapter includes the following topics:

Viewing Licensing Information

Launching Cisco Unified Operations Manager IP Phone Details

Setting Throttling Values for Cisco Unified Communications Managers

Managing Log Files

Enabling Data Purging

Configuring Provisioning Manager to Use AAA Servers

Maintenance Mode

Provisioning Manager Database Backup and Restore

Changing the IP Address on a Provisioning Manager Systems

Provisioning Manager Processes

Scheduling Synchronizations

Searching Inventory

Viewing System Reports

Viewing Licensing Information

The License Status Information page displays the following:

Unavailable features—Any features in Provisioning Manager that you do not have access to, because you do not have the appropriate license or because you have reached the limit for the use of the feature.

Features in overdraft state—Any features that you are using that have exceeded their allowable use limit.

All valid features—List of features and their corresponding use limit (Available), overuse allowed (Overdraft), current use (Used) and date of expiration (Expiry).

Select System Administration > License Information. The License Status Information page appears.

Licensing Process

The Provisioning Manager license file includes support for at least 500 phones. You can purchase incremental licenses for additional phone support and register up to 30,000 phones with a single Provisioning Manager. For each incremental license that you purchase, you will receive a PAK, and you must use that PAK to obtain a license file.

This process applies to new installations and license upgrades:

1. Obtain a Product Authorization Key (PAK)—The PAK is used to register Provisioning Manager, and any additional device support that you might purchase for Provisioning Manager, on Cisco.com, and it contains resource limitations. See Obtaining a PAK.

2. Obtain a license file—A license file is sent to you after you register the PAK on Cisco.com. See Obtaining a License File.

3. Copy the license file to the server where Provisioning Manager is to be installed. If Provisioning Manager is already installed and you are upgrading your license file, you must register the license file with Provisioning Manager. See Registering a License File with Provisioning Manager.

Obtaining a PAK

The PAK is located on the software claim certificate that is shipped with the Provisioning Manager product CD.

Obtaining a License File

Register the PAK and the MAC address of the system where Provisioning Manager is installed with Cisco.com at http://www.cisco.com/go/license. You will be asked to log in. You must be a registered user of Cisco.com to log in.


Note The MAC address is required because licensing uses node-locking technology. The license file can only be used with the MAC address that you supply. The license file will be emailed to you. After you obtain a license file, register the license with the Provisioning Manager server.


Registering a License File with Provisioning Manager


Step 1 Copy the license file to the Provisioning Manager server, in the folder <Installation directory>\license.

The system validates the license file and updates the license. The updated licensing information appears on the Licensing Status Information page.

Step 2 If the license does not automatically take effect after a few minutes, select System Administration > License Information.

Step 3 Click PERFORM AUDIT. You will see the phones that you are licensed to update.

Step 4 If you purchased more than one license, repeat Step 1 to install each additional license.


Launching Cisco Unified Operations Manager IP Phone Details

If you have purchased Operations Manager and are running it, you can set up Provisioning Manager to launch the IP Phone Details dialog box from Operations Manager. The IP Phone Details dialog box is launched from a subscriber record.

Before using this feature, you must first configure Provisioning Manager (see Configuring Provisioning Manager to Open Cisco Unified Operations Manager IP Phone Details).

After performing the configuration procedure, a Details button appears on the subscriber record. The Details button launches the IP Phone Details dialog box from Operations Manager (see Opening the Cisco Unified Operations Manager IP Phone Details Dialog Box).

Configuring Provisioning Manager to Open Cisco Unified Operations Manager IP Phone Details


Step 1 On the Provisioning Manager system, go to the <Installation directory>\sep folder.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 2 Open the ipt.properties file.

Step 3 In the ipt.properties file change the following properties:

dfc.ipt.operationsmanager.host: <hostname>—Enter the Operations Manager system hostname or IP address.

dfc.ipt.operationsmanager.port: <port>—Enter the port number that Operations Manager uses.

Step 4 Save and close the file.

Step 5 Stop Provisioning Manager. On the Provisioning Manager system, select Start > All Programs > Cisco Unified Provisioning Manager > Stop Cisco Unified Provisioning Manager.

Step 6 Start Provisioning Manager (Start > All Programs > Cisco Unified Provisioning Manager > Start Cisco Unified Provisioning Manager).


Opening the Cisco Unified Operations Manager IP Phone Details Dialog Box


Step 1 Open the subscriber record for the desired subscriber (see Accessing a Subscriber Record, page 3-1).

Step 2 Click the Phone that you want to see the details for.

Step 3 Click the Details button. The Operations Manager login page appears. (Valid Operations Manager credentials are required to view the IP Phone Details dialog box.)

Step 4 Log into Operations Manager. The IP Phone Details dialog box from Operations Manager appears.


Setting Throttling Values for Cisco Unified Communications Managers

The throttling setting values in Provisioning Manager must be equal to or less than the values set in Cisco Unified Communications Manager. If you change the throttling settings in Cisco Unified Communications Manager, you must also change the same settings in Provisioning Manager.

The throttling settings in Provisioning Manager are set in the ipt.properties file (located at <Installation Directory>\sep).


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


The following properties (in the ipt.properties file) are used to control the write request sent to Cisco Unified Communications Manager:

dfc.ipt.axl.soap.MaxAXLWritesPerMinute: 20

This property specifies the default number of write requests per minute. Its value is used if there is no version or device specific value specified.

dfc.ipt.axl.soap.MaxAXLWritesPerMinute.ccm501: 50

This property specifies the number of write requests per minute for Cisco Unified Communications Manager version 5.0(1). Its value is used if there is no device specific value specified.

dfc.ipt.axl.soap.MaxAXLWritesPerMinute.<IP address>: 20

This property specifies the number of write requests per minute for a specific Cisco Unified Communications Manager indicated by the IP address.

For example, dfc.ipt.axl.soap.MaxAXLWritesPerMinute.1.2.3.4: 20 sets the value to 20 for Cisco Unified Communications Manager with the IP address of 1.2.3.4.

Managing Log Files

Provisioning Manager writes application log files for the Service Enabling Platform (SEP) module (sep.log) and the Network Interface and Configuration Engine (NICE) service (nice.log). The log files are located in the <Installation directory>\sep\logs folder.

You cannot disable logging. However, you can:

Collect more data when needed by increasing the logging level

Return to the default logging level (NORMAL)

Following are the available logging levels:

DETAIL (provides the most information)

LOW

NORMAL

HIGH

EMERGENCY

Log files are backed up every hour, or when they reach their maximum log size limit. The default size limit is 20 Mb (see Changing the Maximum Log File Size). The files are saved in the format sep.log.<date stamp>-<timestamp>.


Note Log files are deleted from the Provisioning Manager server when their size exceeds 500 MB or the number of log files in the logs folder exceeds 200. If you want to change these levels, see Changing the Log Purging Level.


Changing the Log Level


Step 1 On the Provisioning Manager system, go to the <Installation directory>\sep folder.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 2 Open the dfc.properties file.

Step 3 Change the dfc.log.level property to the desired level. Following are the available logging levels:

DETAIL

LOW

NORMAL

HIGH

EMERGENCY

Step 4 Save the changes.

Step 5 Restart the Provisioning Manager services. Changes will not take effect until Provisioning Manager is restarted.

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Services. The Services window appears.

b. Right-click the following services and select Start.

cupm JBossService

cupm NiceService


Changing the Maximum Log File Size


Step 1 On the Provisioning Manager system, go to the <Installation directory>\sep folder.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 2 Open the dfc.properties file.

Step 3 Change the dfc.log.maxsize property to the desired size (default is 20 Mb).

Step 4 Save the changes.

Step 5 Restart the Provisioning Manager services. Changes will not take effect until Provisioning Manager is restarted.

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Services. The Services window appears.

b. Right-click the following services and select Start.

cupm JBossService

cupm NiceService


Changing the Log Purging Level


Step 1 On the Provisioning Manager system, go to the <Installation directory>\sep folder.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 2 Open the ipt.properties file, and do one or both of the following:

To change the maximum file size level, update the dfc.purgelog.maxused_mb property to the desired level.

To change the maximum number of log files level, update the dfc.purgelog.maxlogsaved property to the desired level.

Step 3 Save the changes.

Step 4 Restart the Provisioning Manager services. (Changes will not take effect until Provisioning Manager is restarted.)

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Services. The Services window appears.

b. Right-click the following services and select Start.

cupm JBossService

cupm NiceService


Enabling Data Purging

You can configure Provisioning Manager to purge data at a scheduled interval.

Provisioning Manager retains the following types of data:

Order—When an order is placed for any product provisioning (for example: phone, line, voicemail or any bundle), an order data object is created and stored in the system.

ServiceAction—Objects that are created when the application is communicating with the device during product provisioning.

Workflow—After an order is placed for a product, it goes through a workflow (approval, shipping, and receiving) before going to the service activator.


Note Data will be purged when the retention time or retention count criterion is met. For example, if the data is older than the retention time it will be removed. Also, if the data amount exceeds the retention count, it will be removed.



Step 1 Select System Administration > Data Maintenance. The Data Maintenance Configuration page appears.

Step 2 Select the check box in the row for the data you want to schedule for purging.

Step 3 In the Retention Time column, change the number of days for which you want to retain the data (default is seven days).

Step 4 In the Retention Count column, select the amount of data that you want to retain.


Note Retention count is the number of objects that you want Provisioning Manager to keep and not purge. For example, if there are 1000 total orders and the retention count is 100, Provisioning Manager will purge 900 orders and keep the latest 100 orders.


The default settings for the Retention Count are:

Orders—100

ServiceAction—100

Workflow—50

Step 5 (Optional) To export the purged data to a file before it is removed, in the Export Before Purge field select Yes, then enter a directory location at which to store the data.


Note Only Orders and Workflow data is exported. Service action data cannot be exported.


Step 6 Select a purge interval (the default is 24 hours).

The Purging Information pane displays the time of the next scheduled purge and the last purge.

Step 7 Click Update.


Configuring Provisioning Manager to Use AAA Servers

You can configure Provisioning Manager to use AAA for authentication when users log into Provisioning Manager. Provisioning Manager does not retrieve authorization or accounting information, and it does not write information to the AAA server.


Note Provisioning Manager allows you to add only Lightweight Directory Access Protocol (LDAP) servers.


AAA servers are enabled on a per Domain basis. After adding a AAA server, you then assign it to a Domain. Then all the users in that Domain will be authenticated against that AAA server. If a AAA server is not associated to a Domain, all the Domain's users are authenticated locally.


Note The administrator account (pmadmin) is always authenticated locally.


Adding a AAA Server

Table 7-1 describes the fields for adding a AAA server.

Table 7-1 AAA Server Configuration Fields 

Field
Description

AAA Server Name

AAA server name.

Server Type

Type of AAA server. You can only choose LDAP.

LDAP Server Type

Type of LDAP server.

Note Provisioning Manager supports only Microsoft AD 2000, 2003, and 2008.

AAA Server IP Address

IP of the AAA server.

Server Port

Port number for the AAA server.

Backup Server IP Address

IP address of the backup AAA server.

Backup Server Port

Port number for the backup AAA server.

Admin Distinguished Name

The administrative user ID of the LDAP manager that has access rights to the LDAP directory.

Admin Password

The administrative users password (LDAP manager).

LDAP User Search Base

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

Use SSL

You should select this check box if Provisioning Manager should use Secure Socket Layer (SSL) encryption for the transmission channel between Provisioning Manager the AAA server.



Step 1 Select System Administration > AAA Servers. The AAA Server Configuration page appears.

Step 2 Click AAA Server.

Step 3 Enter the following information for the AAA server:

Name

Server type

IP address

Server port number

(Optional) Backup server IP address

(Optional) Backup server port number

Admin distinguished name

Admin password

LDAP use search base

(Optional) Select SSL

Step 4 Click Save.


Enabling SSL Support for a AAA Server

To enable SSL for a AAA server, you must import the SSL certificate for the LDAP server into Provisioning Manager. Provisioning Manager provides a command line script to import the SSL certificate.


Step 1 On the Provisioning Manager system, open a command prompt.

Step 2 In the command prompt, go to <Install directory>\sep\build\bin.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 3 In the command prompt, run the following command:

ImportSSLCertificate.bat <operation> <alias> [path] 

Following are descriptions for the fields:

operation—The action that the command is performing. You can enter either import or delete.

alias—The string under which the certificate will be stored in the Provisioning Manager key store.

path—The path where the certificate is stored (for example, C:\servercert.cer). This is required only if you are importing a certificate.

Step 4 Restart Provisioning Manager.

Step 5 Go to the AAA Server Configuration page and select the Use SSL check box.


Note To delete an SSL certificate in Provisioning Manager, run the same script making sure to enter delete for the operation.



Changing AAA Server Information

After a AAA server is added, you can update its information.


Step 1 Select System Administration > AAA Servers. The AAA Server Configuration page appears.

Step 2 Click View AAA Server. The Choose a AAA Server dialog box appears.

Step 3 Select the AAA Server that you require. Information for the selected server appears.

Step 4 In the Options pane, click Update. The Update a AAA Server page appears.

Step 5 Edit the fields as required. (For explanations of the fields, see Adding a AAA Server.)

Step 6 Click Save.


Testing the Connection to a AAA Server

After a AAA server is added to Provisioning Manager, you can test the connection to the server at any time.


Note When a AAA server is added, a test of the connection to both the main and the backup AAA server is automatically performed.



Step 1 Select System Administration > AAA Servers. The AAA Server Configuration page appears.

Step 2 Click View AAA Server. The Choose a AAA Server dialog box appears.

Step 3 Select the AAA Server that you require. Information for the selected server appears.

Step 4 In the Options pane, click Test Connection. A message appears, stating whether or not the test was successful.


Maintenance Mode

You can put Provisioning Manager into maintenance mode to perform user-impacting actions that are not available in normal mode, such as deleting Domains, processors, and Service Areas.


Step 1 Select System Administration > Maintenance Mode. The Application Mode page appears.

Step 2 Click Enter Maintenance Mode. All users except users with administrative rights are logged out. A warning appears on the login page, notifying users that system use is limited to users with administrative privileges. Maintenance options that are not available in normal mode, such as deleting domains, become available.

Step 3 Perform any maintenance activities, such as deleting a domain.

Step 4 When you have completed maintenance activities, select System Administration > Maintenance Mode. The Application Mode page appears.

Step 5 Click Enter Normal Mode. The warning on the login page is removed and users can now log in as usual. Maintenance options such as deleting Domains are no longer available.


Provisioning Manager Database Backup and Restore

There are two backup and restore scenarios; select the set of procedures that matches your scenario:

Backup and restore on a single machine, with the same installation or a new installation. For this scenario, see Backing up the Single-Machine Provisioning Manager Database and Restoring the Single-Machine Provisioning Manager Database.

Backup and restore for a distributed database scenario, for the same installation, a new installation with the same IP address, or a new installation with a new IP address. For this scenario, see Backing up Provisioning Manager for a Distributed Database and Restoring Provisioning Manager for a Distributed Database.


Note When backing up files, you should place the files on a different file server. Also, you should burn the backup data onto a CD.


Backing up the Single-Machine Provisioning Manager Database

This procedure requires that you have administrator level access to the Provisioning Manager database (the PostgreSQL database).


Step 1 On the Provisioning Manager system, stop the following services:

Apache

cupm JBossService

cupm NiceService

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Services.

b. Right-click each of the services and click Stop.

Step 2 On the Windows desktop, select Start > All Programs > PostgreSQL8.2 > Command Prompt. A command prompt opens in the <Installation directory>\pgsql\bin directory.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 3 In the command prompt, run the following command and enter the PostgreSQL administrator password when prompted.

pg_dumpall -o -U<username> > <directory>\<backup file name>

<username>—The username of the PostgreSQL administrator. If you accepted the default, the administrator username is postgres.

<directory>—The directory must already exist.

<backup file name>—The filename must not currently exist.


Note Enter the password each time that you are prompted.


This command is used to backup the database by storing the database information in a file.

Step 4 If you are backing up on the same installation, proceed to the next step. If you are backing up for a new installation, make backup copies as described in this step.

a. In a backup folder, make copies of the following files and directories:

<Installation directory>\install.log

<Installation directory>\sep\dfc.properties

<Installation directory>\sep\dfc.keystore

<Installation directory>\jboss-4.0.3SP1\server\cupm\conf\login-config.xml

Step 5 Start the following services:

Apache

cupm JBossService

cupm NiceService

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Services.

b. Right-click each of the services and click Start.


Restoring the Single-Machine Provisioning Manager Database

If you are restoring to a new installation, have the system with the new installation up and running before beginning this procedure.

This procedure requires that you have administrator level access to the Provisioning Manager database (the PostgreSQL database).


Note If you are restoring the database on a new system, you must verifying that the following ports are not being used by another application:

dfc.jboss.port=8008

dfc.postgres.port=5432

dfc.nice.rmi.registry.internal.port=1602

dfc.webport=80

If a port is being used by another application, you must change the port number to a vacant port. These settings are defined in the <Installation directory>\sep\dfc.properties file. (If you accepted the default location during installation, the installation directory is C:\CUPM.)



Step 1 Stop Provisioning Manager services (for information on which services to stop, see Step 1 ).

Step 2 On the Windows desktop, select Start > All Programs > PostgreSQL8.2 > Command Prompt.

A command prompt opens, displaying <Installation directory>\pgsql\bin.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 3 To enter the PostgreSQL prompt, run the following command and enter the PostgreSQL administrator password for the current installation when prompted:

psql.exe -U<username>

Where <username> is the username of the PostgreSQL administrator. If you accepted the default, the administrator username is postgres.

Step 4 Before restoring the database, you must drop the database name and role. In the command prompt, run the following commands exactly as shown, one at a time and in the following order:

DROP DATABASE cupm;

Where cupm is the database name to be removed.

Expected output: DROP DATABASE

DROP ROLE <rolemame>;

Where <rolename> is the username for the SEP database user. If you accepted the default, the username is cupm.

Expected output: DROP ROLE

ALTER ROLE <username> WITH PASSWORD `<password>';

Where username is the username of the PostgreSQL administrator user, and password is the password set for the PostgreSQL administrator with backed-up data. If you accepted the default administrator username, the username is postgres.

Expected output: ALTER ROLE

Step 5 Enter \q to quit the PostgreSQL prompt.

Step 6 From the command line, run the following command, entering the password set in the previous step for the PostgreSQL user when prompted:

psql.exe -U<username> -d postgres < <directory>\<file name to be restored from>

Where <username> is the username of the PostgreSQL administrator. If you accepted the default, the administrator username is postgres.

This command restores the database.

Step 7 If you are restoring to the same installation, proceed to the next step. If you are restoring to a new installation, copy back the following backed-up files:

<Installation directory>\install.log

<Installation directory>\sep\dfc.properties

<Installation directory>\sep\dfc.keystore

<Installation directory>\jboss-4.0.3SP1\server\cupm\conf\login-config.xml

Step 8 Start the following services:

Apache

cupm JBossService

cupm NiceService

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Services.

b. Right-click each of the services and click Start.


Backing up Provisioning Manager for a Distributed Database

This procedure requires that you have administrator level access to the Provisioning Manager database (the PostgreSQL database).


Step 1 On the system where Provisioning Manager is running, stop the following services:

Apache

cupm JBossService

cupm NiceService

a. On the Windows desktop where Provisioning Manager is running, select Start > Control Panel > Administrative Tools > Services.

b. Right-click each of the services and click Stop.

Step 2 On the Windows desktop where the Provisioning Manager database is running, select Start > All Programs > PostgreSQL8.2 > Command Prompt. A command prompt opens in the <Installation directory>\pgsql\bin directory.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 3 In the command prompt, run the following command and enter the PostgreSQL administrator password when prompted.

pg_dumpall -o -U<username> > <directory>\<backup file name>

<username>—The username of the PostgreSQL administrator. If you accepted the default, the administrator username is postgres.

<directory>—The directory must already exist.

<backup file name>—The file name must not currently exist.


Note Enter the password each time that you are prompted.


This command is used to backup the database by storing the database information in a file.

Step 4 If you are backing up on the same installation, proceed to the next step. If you are backing up for a new installation, either with the same or a new IP address, on the machine where Provisioning Manager is running, make copies of the following files and directories in a backup folder:

<Installation directory>\install.log

<Installation directory>\sep\dfc.properties

<Installation directory>\sep\dfc.keystore

<Installation directory>\jboss-4.0.3SP1\server\cupm\conf\login-config.xml

Step 5 Start the following services:

Apache

cupm JBossService

cupm NiceService

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Services.

b. Right-click each of the services and click Start.


Restoring Provisioning Manager for a Distributed Database

If you are restoring to a new installation, either with the same or a new IP address, have the system with the new installation up and running before beginning this procedure.

This procedure requires that you have administrator level access to the Provisioning Manager database (the PostgreSQL database).


Note If you are restoring the database on a new system, you must verifying that the following ports are not being used by another application:

dfc.jboss.port=8008

dfc.postgres.port=5432

dfc.nice.rmi.registry.internal.port=1602

dfc.webport=80

If a port is being used by another application, you must change the port number to a vacant port. These settings are defined in the <Installation directory>\sep\dfc.properties file. (If you accepted the default location during installation, the installation directory is C:\CUPM.)

Also, you will need to change the system name in one of the following settings:

dfc.postgres.host=<system name> (If the databse is on one system.)

dfc.postgres.hostlist=<system names> (If the database is on multiple systems.)



Step 1 On the system where Provisioning Manager is running, stop the Provisioning Manager services (for information on which services to stop, see Step 1).

Step 2 On the Windows desktop where the Provisioning Manager database is running, select Start > All Programs > PostgreSQL8.2 > Command Prompt.

A command prompt opens, displaying <Installation directory>\pgsql\bin.


Note If you accepted the default location during installation, the installation directory is C:\CUPM.


Step 3 To enter the PostgreSQL prompt, run the following command and enter the PostgreSQL administrator password for the current installation when prompted:

psql.exe -U<username>

Where <username> is the username of the PostgreSQL administrator. If you accepted the default, the administrator username is postgres.

Step 4 Before restoring the database, you must drop the database name and role. In the command prompt, run the following commands exactly as shown, one at a time and in the following order:

DROP DATABASE cupm;

Where cupm is the database name to be removed.

Expected output: DROP DATABASE

DROP ROLE <rolemame>;

Where <rolename> is the username for the SEP database user. If you accepted the default, the username is cupm.

Expected output: DROP ROLE

ALTER ROLE <username> WITH PASSWORD `<password>';

Where <username> is the username of the PostgreSQL administrator, and password is the password set for the PostgreSQL administrator with backed-up data. If you accepted the default administrator username, the username is postgres.

Expected output: ALTER ROLE

Step 5 Enter \q to quit the PostgreSQL prompt.

Step 6 From the command line, run the following command, entering the password set in the previous step for the PostgreSQL user when prompted:

psql.exe -U<username> -d postgres < <directory>\<file name to be restored from>

Where <username> is the username of the PostgreSQL administrator. If you accepted the default, the administrator username is postgres.

This command restores the database.

Step 7 If you are restoring to the same installation, proceed to Step 9. If you are restoring to a new installation, either with the same or a new IP address, copy back the following backed up files on the machine where Provisioning Manager is running:

<Installation directory>\install.log

<Installation directory>\sep\dfc.properties

<Installation directory>\sep\dfc.keystore

<Installation directory>\jboss-4.0.3SP1\server\cupm\conf\login-config.xml

Step 8 If you are restoring to the same IP address, proceed to Step 9. If you are restoring to a new installation with a new IP address, complete this step.

a. On the system where Provisioning Manager is running, in the file <Installation directory>\sep\dfc.properties, find the property dfc.postgres.host, and change it to:

dfc.postgres.host=<New DB Server IP Address>

a. On the Windows desktop of the machine where the database is running, go to Start > Programs > PostgreSQL 8.2 > pgAdmin III.

b. Double-click cupmPostgreSQL and log in using the PostgreSQL administrator password.

c. Click the SQL menu item at the top of the query window, and in the top right pane, enter the following command:

delete from nicesyseng where host='<Old NICE Server IP Address>'

d. Click the Execute Query button at the top of the query window.

e. In the Output Pane at the bottom of the screen, confirm that the result message says the query was returned successfully.

f. Exit the query window.

g. Exit the pgAdminIII window.

h. Restart PostgreSQL on the machine where the database is running.

On the Windows desktop, select Start > Control Panel > Administrative Tools > Services.

Right-click the service cupmPostgreSQL and click Start.

Step 9 On the system where Provisioning Manager is running, start the following services:

Apache

cupm JBossService

cupm NiceService

a. On the Windows desktop, select Start > Control Panel > Administrative Tools > Service.

b. Right-click each of the services and click Start.


Changing the IP Address on a Provisioning Manager Systems

If you are changing the IP address on a single machine setup, after changing the IP address on the system you must stop and restart Provisioning Manager (Start > Programs > Cisco Unified Provisioning Manager > Stop Cisco Unified Provisioning Manager).

If you are changing the IP address on a distributed setup, you can change either system's IP address. See either Changing the IP Address on the Provisioning Manager Server (for a Distributed Setup) or Changing the IP Address on the Provisioning Manager Database Server (for a Distributed Setup).

Changing the IP Address on the Provisioning Manager Server (for a Distributed Setup)

This procedure is required only for a distributed setup. Perform this procedure after changing the IP address of the Provisioning Manager server.


Step 1 On the Windows desktop of the machine where Provisioning Manager is running, select Start > Programs > Cisco Unified Provisioning Manager > Stop Cisco Unified Provisioning Manager.

Step 2 On the Windows desktop of the machine where the database is running, select Start > Programs > PostgreSQL 8.2 > Stop Service.

Step 3 On the system where the Provisioning Manager Database is running, in the file <Installation directory>\pgsql\data\pg_hba.conf, update the following line with the new IP address:

host all all <Provisioning Manager_IP_ADDR>/32 md5

Step 4 On the Windows desktop of the machine where the database is running, select Start > Programs > PostgreSQL 8.2 > Start Service.

Step 5 On the Windows desktop of the machine where Provisioning Manager is running, select Start > Programs > Cisco Unified Provisioning Manager > Start Cisco Unified Provisioning Manager.


Changing the IP Address on the Provisioning Manager Database Server (for a Distributed Setup)

This procedure is required only for a distributed setup. Perform this procedure after changing the IP address of the Provisioning Manager database server.


Step 1 On the Windows desktop of the machine where Provisioning Manager is running, select Start > Programs > Cisco Unified Provisioning Manager > Stop Cisco Unified Provisioning Manager.

Step 2 On the Windows desktop of the machine where the database is running, select Start > Programs > PostgreSQL 8.2 > Stop Service.

Step 3 On the system where Provisioning Manager is running, update the following files:

<Installation directory>\sep\dfc.properties—Update the following line with the new IP address:

dfc.postgres.host=<DB_SERVER_ADDR>

<Installation directory>\jboss-4.0.3SP1\server\cupm\deploy\dfc-ds.xml—Update the following line with the new IP address:

<connection-url>jdbc:postgresql://<DB_SERVER_ADDR>:5432/cupm</connection-url>

Step 4 On the Windows desktop of the machine where the database is running, select Start > Programs > PostgreSQL 8.2 > Start Service.

Step 5 On the Windows desktop of the machine where Provisioning Manager is running, select Start > Programs > Cisco Unified Provisioning Manager > Start Cisco Unified Provisioning Manager.


Provisioning Manager Processes

You can use the Windows Task Manager to find the process identifier (located in the PID column) for any processes running on Windows.

In a Windows command prompt, you can run the netstat -aon command to display all the TCP/UDP ports open and the process identifier. From this output, you can determine which processes are listening on a particular port or are keeping it open. For more information on using the netstart command and Task Manager, see the Windows 2003 documentation.

Table 7-2 provides a complete list of Provisioning Manager processes.

Table 7-2 Provisioning Manager Processes 

Name
Windows Service Name
Description
Dependency

Apache.exe

Apache2

Apache Web Server.

None.

JBossService.exe

cupm JBossService

JBoss Application Server.

PostgreSQL Database Server.

NICEService.exe

cupm NICEService

CUPM NICE Engine.

PostgreSQL Database Server.

postgres.exe and pg_ctl.exe

cupmPostgreSQL

PostgreSQL Database Server.

None.


Scheduling Synchronizations

Besides running synchronizations on demand through the appropriate Provisioning Manager functional area, you can set up scheduled synchronizations. You schedule synchronizations for the following:

Call Processors (see Synchronizing Call Processors, page 5-4)

Unified Message Processors (see Synchronizing Unified Message Processors, page 5-11)

Domains (see Synchronizing Domains, page 5-16)

You do not use Provisioning Manager to set up scheduled synchronizations. You must use the Scheduled Tasks functionality that comes with your Windows system.


Note When scheduling synchronization, you should use the same Windows user account that was used when Provisioning Manager was installed. If you want to schedule synchronization from a different Windows user account, the following environment variables must be set:

DEV_DIR

EOSS_BASE

JBOSS_HOME

JAVA_HOME

DFC_PROPERTIES

The values for these properties can be copied from the user account that was used when Provisioning Manager was installed.



Step 1 On the Windows desktop, select Start > Programs > Accessories > System Tools > Scheduled Tasks. The Scheduled Tasks window opens.

Step 2 Double-click Add Scheduled Task. The Scheduled Task wizard appears.

Step 3 Click Next.

Step 4 On the next page, click Browse.

Step 5 Browse to the file C:\CUPM\sep\build\bin\sync.bat (this is the correct location if you accepted the default location during installation).

Step 6 Select how often you want the synchronization to run. Click Next.

Step 7 Select the time and day when you want the synchronization task to start. Click Next.


Note You should run synchronizations during off-peak network usage periods.


Step 8 Enter the password (and confirm) for the system's administrator user. Click Next.

Step 9 Click Finish. The new scheduled task appears in the Scheduled Tasks window.

Step 10 Right-click the new scheduled task and select Properties.

Step 11 In the Run field, at the end of the string (after sync.bat), enter one or more of the following commands:

callprocessor—Runs infrastructure and subscriber synchronizations for all Call Processors in the system.

messageprocessor—Runs infrastructure and subscriber synchronizations for all Unified Message Processors in the system.

domain—Runs synchronizations for all the domains in the system. The order of Domain synchronizations depends on the value set on the syncPrecedence property for the corresponding domain instances.

all—Runs infrastructure and subscriber synchronizations for all Call Processors and Unified Message Processors. The order of synchronizations is callprocessor, messageprocessor, and domain.


Note You can also use these commands in a command prompt to start a synchronization. Run the commands at the following location: <Installation directory>\sep\build\bin\sync.bat.


Step 12 Click OK.


Searching Inventory

If you are assigned the Administration authorization role you can browse the Provisioning Manager network and service inventory. You can view different types of network or service-related data in a tree-based selector.

The following objects appear in the selector:

Global Resources—List infrastructure data stored in Provisioning Manager. Some examples are, Route Partition, Call Search Space, Call Pickup Group.

Product Catalog—Lists the products present in Provisioning Manager.

Subscribers—List all subscribers and their locations in Provisioning Manager.

Domain-specific directory numbers, phones, rules and Services Areas.

This section provides information for browsing and searching Provisioning Manager inventory, using the Instance Browser and search functionality of the Inventory Manager.

Using Inventory Search

Creating Search Reports

Figure 7-1 shows an example of the Inventory Search page.

Figure 7-1 Inventory Search


Step 1 Select System Administration > Inventory. A new page appears.

Step 2 Do one of the following:

If you want to browse Provisioning Manager's inventory, click Browse. The Instance Browser appears. For information on the Instance Browser, see Using Inventory Search.

If you want to perform a search of Provisioning Manager's inventory, click Search. The Search Reports page appears. On this page you can do the following:

Perform a search using a sample report.

Create a new Search report to perform a search.


Using Inventory Search

You can search for inventory objects using basic or advanced searches. You use basic searches to find instances of an object based on its properties. Advanced searches are used to specify more detailed search criteria. You can include multiple constraints, such as customers, properties, associations, and namespaces, to limit the search results. You can also specify what properties you want the search to return. You can save advanced searches as reports, and organize them into categories. Reports can be created only by Administrators.

The following sections describe how to run basic and advanced searches:

Performing Basic Searches

Performing Advanced Searches

Return Values

Performing Basic Searches

Using the Instance Browser, you can run a basic search for instances of a particular object. In a basic search, the search parameters are based on the properties of the class.

The first step to searching for an instance is specifying the class that it is based on. You can specify search criteria and how the results are displayed by:

Specifying a keyword or partial keyword. You can use asterisks (*) as wild cards.

Specifying whether the results are displayed according to the class name or label property.

Restricting the search to a particular domain.

Including and/or excluding abstract, association, and interface classes.

After you have located the class that the instance is based on, you can narrow your search by specifying search criteria based on the class properties. The number of searchable properties varies from class to class.


Step 1 Select System Administration > Inventory. A new page appears.

Step 2 Click Browse. The Instance Browser appears.

Step 3 Click the Search icon (). The Class Search dialog box appears.

Step 4 Either enter a class or choose a class from the list. The Instance Search screen appears.

Step 5 Complete the fields if you have search parameters you want to specify.

Step 6 Click Search. The results appear in the Found matches section.


Performing Advanced Searches

You can perform advanced searches to find inventory instances within a specified object class. An advanced search can be saved for future use.


Step 1 Select System Administration > Inventory. A new page appears.

Step 2 Do one of the following:

Click Browse, select a class using a basic search, then click Advanced.

Click Search, click the New icon (), and then select a class.

Step 3 Add any applicable constraints. You can constrain searches using properties, associations, namespaces, or customers.

Step 4 Create a list of properties to return in the search from a list of available properties. The search results include only those instances that contain the selected properties.

Step 5 Specify associated properties to return in the search, if applicable, by building the path to the properties. The search results will include only those instances with the selected properties.

Step 6 Specify associated objects to return in the search, if applicable, by building the path to the objects. The search results will include only those instances with the selected objects.

Step 7 Specify whether to include or exclude Namespaces and Object Classes in the search results.

Step 8 Run the search. The search results are displayed.


The following sections contain detailed instructions for selecting constraints and returning objects and properties:

Constraints

Defining Property Constraints

Defining Association Constraints

Defining Namespace Constraints

Associated Properties to Return

Associated Objects to Return

Constraints

Use the Add Constraint section to define the constraints for the search.

The following constraints are available for advanced searches:

Properties—To restrict the results to objects that meet specified property criteria. You can set the properties constraint to be case sensitive or case insensitive. You can specify that either all or part of the value must be matched to return results.

Associations—To restrict the results to objects that are (or are not) associated with other objects using a specified association path. Association paths allow the relation between the source object and the queried objects to span multiple association classes.

Namespaces—To restrict the results to objects contained (or not contained) in specified namespaces.

Customers—To restrict the results to objects that are associated with specific customers.

Defining Property Constraints

You can define searches to select only the objects that meet specified property constraints. For example, you can define a constraint in which only instances that have a specific model number are included in the search results. In this case, the property constraint acts as a filter when searching for a specific object property.

When defining property constraints, the following conditions are available:

Equals—To specify a value that is equivalent in value to the selected property.

Contains—To specify a value that is contained within the value of the selected property.

Not equal to—To specify a value that is not equivalent in value to the selected property.

Does not contain—To specify a value that is not contained within the value of the selected property.

In range—To specify a value that has a Date property that is within the specified range. This operator can only be used when Date properties have been specified for an object, and where reportable=true is set in the class definition properties.

After you select the operator, you can either specify a value, or leave the field blank. If you specify a value, it becomes the default value, although users who execute the search can change the value if required. Leaving the field blank allows a user who is executing the search at a later time to specify a value for that property constraint.

To define property constraints:


Step 1 In the Advanced Instance Search screen, select a property from the Add Constraint list.

Step 2 Click Add. The available conditions appear in a list.

Step 3 From the available conditions list, select the appropriate operator and click Add. The Property list appears in the Add Constraint section.

Step 4 Select the appropriate property. The Value field appears in the Add Constraint section.

Step 5 In the Value field, do one of the following:

Specify a default value for the constraint.

Leave the field blank so that users can specify their own constraints.

Step 6 If you want the search to be case-insensitive, enable Ignore Case.

Step 7 Click Add. The constraint appears in the Selected Constraints section.

Step 8 Repeats Steps 1 through 7 to add additional constraints.

Step 9 If you have defined multiple constraints, specify the and or or operands as required in the Operand column.


Defining Association Constraints

You can define searches to select objects that are, or are not, associated with other objects. For example, you can define a search for Lines that are associated with Voice Terminals of a certain type, excluding Voice Terminals of another type. Additionally, you can sort within a range; for example, you can search for all Phones with two to six Lines.

When defining association constraints, the following conditions are available:

Associated with—Used to specify the object instance and association path associating the search class with another object instance.

Not associated with—Used to specify the object instance to not associate with for the search class.

Associated with range—Used to specify the range of object instances to associate with the search class. If you select this condition, you must complete the appropriate association, condition, and quantity information.

After the operator is selected, you must select an object instance for the constraint. Each operator has a different procedure for selecting object instances to associate with.

To define constraints using the associated with operator:


Step 1 From the Add Constraint list, select Associations.

Step 2 Click Add. The available conditions appear in a list.

Step 3 From the available conditions list, select Associated with.

Step 4 Click Add. The constraint is added to the Add Constraint section.

Step 5 In the Add Constraint section, in the Instance field, click the Search icon (). The Instance and Association Path dialog box appears.

Step 6 In the To Class list, select the class that the object instance is associated with, and click Apply.

Step 7 In the By Association list, select the appropriate association, and then click Apply. The Participating As list appears.

Step 8 Select the appropriate role for the class, and then click Apply.

Step 9 To specify another class in the To Class field, repeat Steps 6 through 8.

Step 10 To restrict the constraint to a specific object instance, click the Search icon () and search for that instance. By default, the constraint is not restricted to a particular instance.

Step 11 Click Add to save your selections. The selected path is displayed.

Step 12 To add the constraint as defined, click Add. The Selected Constraints section displays the Instance and Association Path information.

Step 13 If you have defined multiple constraints, select the and or or operands as required in the Operand column.


To define constraints using the associated with range operator:


Step 1 From the Add Constraint list, select Associations.

Step 2 Click Add. The available conditions appear in a list.

Step 3 From the available conditions list, select the Associated with range condition, then click Add. The constraint is added to the Add Constraint section.

Step 4 From the Association list, select the association class that you want to search with.

Step 5 From the Condition list, select the condition to satisfy in the search.

Step 6 In the Quantity field, enter the number of instances the condition must meet, then click Add. The constraint is displayed in the Selected Constraints section.

Step 7 Repeat Steps 1 through 6 to add additional constraints.

Step 8 If you have defined multiple constraints, select the and or or operands as required in the Operand column.


Defining Namespace Constraints

Use namespace constraints to restrict the search to or exclude specific namespaces.


Step 1 From the Add Constraint list, select a namespace, then click Add. Namespace appears in the Add Constraint section.

Step 2 Do one of the following:

To specify a namespace to search in, select Equals.

To exclude a namespace from the search, select Not Equal To.

Step 3 The Value list appears, displaying the available namespaces.

Step 4 From the Value list, select the namespace, then click Add. The constraint appears in the Selected Constraints section.

Step 5 Repeats Steps 1 through 4 to add additional constraints.

Step 6 If you have defined multiple constraints, select the and or or operands as required in the Operand column.


Return Values

By default, the namespace, object class, and object values for each instance are displayed in the results of an advanced search. In addition to the default values, you can select other values for the advanced search to display.

Properties to Return

The Properties to Return section lists the available properties of the object class being searched, and those properties that you want the search to return. Using the Properties to Return section, you can expand the search to display a list of property values.


Step 1 In the Properties to Return section, from the Available list, select a property, then click Add. These properties are displayed in the Selected list.

Step 2 After adding all the desired properties, click Apply.


Associated Properties to Return

The Associated Properties to Return section identifies the associated object class properties that you want the search to return. Using the Associated Properties to Return section, you can extend the search to include a list of associated object property values.


Step 1 In the Associated Properties section, click Add. The Associated Property Path screen appears.

Step 2 In the To Class list, select the object class.

Step 3 Click Apply. The By Association list appears.

Step 4 Select the appropriate association. Click Apply. The Participating as list appears.

Step 5 Select the appropriate role for the class. Click Apply. The Select Property of lists appear.

Step 6 Do one of the following:

From the To Class list, select the object class. Click Apply. Repeat Steps 2 and 3 after you have added the classes that you require.

From the Select Property of list, select the properties of the class that you chose in Step 2. Click Apply.

The Associated Property Path screen appears with the selected path displayed.

Step 7 Click Add. The new associated property is displayed in the search screen.


Tip To remove a property, select the Remove check box, then click the Remove button.



Associated Objects to Return

The Associated Objects to Return section identifies the associated object classes that you want the search to return. Using the Associated Objects to Return section, you can extend the search to include a list of associated objects of a specific class.


Step 1 Click Add in the Associated Objects section. The Associated Object Class Path window appears.

Step 2 In the To Class list, select the object class, then click Apply. The By Association list appears.

Step 3 Select the appropriate association, then click Apply. The Participating as list appears.

Step 4 Select the appropriate role for the class, then click Apply. The To Class list appears.

Step 5 Do one of the following:

If you need to continue the path, repeat Steps 2 through 4.

If you are done, click Add.

The new associated property is displayed in the search screen.


Tip To remove a property, select the Remove check box, then click the Remove button.



Creating Search Reports

You can save advanced searches (see Performing Advanced Searches) for future use. These are called Search Reports. Also, Provisioning Manager provides you with sample search reports that you can use, or you can create your own. The sample search reports are not editable.

You can save an advanced search at any time.


Step 1 Select System Administration > Inventory > Search. The Search Reports page appears.

Step 2 Click the New icon (). The Class Search dialog box appears.

Step 3 Either enter a class in the search field or click one of the displayed classes. The Instance Search page appears.

Step 4 Enter the desired search criteria. For instructions on using the Instance Search page, see Performing Advanced Searches.

Step 5 Click Save. The Save Search page appears.

Step 6 Enter a name for the report and choose a category for it.

Step 7 Click Save. You are returned to the Advanced Search page, where you can initiate the search.


Running Search Reports

Once you have saved a search as a Search report, you can run it. Before running a Search report, you can choose to have the search results displayed in the current browser window or in a new window.


Step 1 Select System Administration > Inventory > Search. The Search Reports page appears.

Step 2 Click the report that you want to run (either one of the sample search reports, or a search report that you created). The Inventory Search page appears, displaying the constraints that have been defined.

Step 3 Change the constraint values if required.

Step 4 To display the search results in a separate browser window, select Open results in a new window.

Step 5 Do one of the following:

To execute the search and display the search results, click Search.

To execute the search and write the search results to an Excel spreadsheet, click Excel.

The search results are displayed as specified.


Editing Search Reports


Step 1 Select System Administration > Inventory > Search. The Search Reports page appears.

Step 2 Click the Edit icon () next to the Search report that you want to edit. The Instance Search for the report appears.

Step 3 Make the appropriate changes. For instructions on using the Instance Search page, see Performing Advanced Searches.


Deleting Search Reports


Step 1 Select System Administration > Inventory > Search. The Search Reports page appears.

Step 2 Click the Edit icon () next to the Search report that you want to delete. The Instance Search for the report appears.

Step 3 In the Search Options section, click Delete.

Step 4 In the confirmation box, click OK.


Viewing System Reports

Provisioning Manager contains a set of preconfigured reports. Following are the available reports:

Service Area Report

Resource Configuration Report

Service Configuration Report

Directory Number Inventory Report


Step 1 Select System Administration > Reports.

Step 2 Click one of the following available reports:

Service Area Report

Resource Configuration Report

Service Configuration Report

Directory Number Inventory Report

A report is displayed.