Cisco Prime Collaboration Provisioning Guide - Standard and Advanced, 10.0
Maintaining the Server
Downloads: This chapterpdf (PDF - 1.37MB) The complete bookPDF (PDF - 6.23MB) | Feedback

Maintaining the Server

Maintaining the Server

Managing Log Files

Cisco Prime Collaboration Provisioning writes application log files for the Service Enabling Platform (SEP) module (sep.log) and the Network Interface and Configuration Engine (NICE) service (nice.01.log). The log files are located in the /opt/cupm/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 most of the 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 . The files are saved in the format sep.log.date stamp timestamp.


Note


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


Changing the Log Level

Procedure
    Step 1   On the Prime Collaboration Provisioning system, go to the opt/cupm/sep folder.

    If you accepted the default location during installation, the installation location is /opt/cupm.

    Step 2   Open the dfc.properties file and change the dfc.log.level property to the desired level.
    Following are the available logging levels:
    • DETAIL
    • LOW
    • NORMAL
    • HIGH
    • EMERGENCY
    Step 3   Save the changes, and restart the Provisioning services as your changes will not take effect until Prime Collaboration Provisioning is restarted:
    1. Log into the server using SSH.
    2. Go to /opt/cupm folder and execute the ./cupm-app-service.sh stop command.
    3. Check whether the services are down by executing the following:
      
      ps -aef | grep startcupm
      
      If there are any processes running, kill those services by using the following command:
      
      kill -9 <processID1> <processId2>
      ps -aef | grep nice
      
      If there are any processes running, kill those services by using the following command:
      
      kill -9 <processID1> <processId2>
      
    4. Check if the port 46009 is free (used by JBoss):
      
      netstat -a | grep 46009
      
      If this port is in use, wait till it gets free.
    5. Start the application services: execute ./cupm-app-service.shstart.

      Wait for the services to start.



    Note


    • 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 (or /opt/cupm/sep/build/bin), and restart Prime Collaboration Provisioning. Prime Collaboration Provisioning logs are stored in:/opt/cupm/sep/logs
    • To temporarily change the log level:
      1. Log into the Prime Collaboration Provisioning server as root using SSH.
      2. Open the command prompt and go to the script directory: cd CUPM_INSTALL_DIR/sep/ipt/bin
      3. Run the following command with the appropriate options to change the log level:
        
        ./changeloglevel.sh -level loglevel [APPSERVER | NICE | BOTH]
        
        If APPSERVER, NICE, or BOTH options are not specified, the default option BOTH is used. Log level can be DETAIL, LOW, NORMAL, HIGH, or EMERGENCY.

    Changing the Maximum Log File Size

    Procedure
      Step 1   On the Prime Collaboration Provisioning system, go to the opt/cupm/sep folder.

      If you accepted the default location during installation, the installation location is /opt/cupm.

      Step 2   Open the dfc.properties file and change the dfc.log.maxsize property to the desired size (default is 20 Mb).
      Step 3   Save the changes and restart the Provisioning services as your changes will not take effect until Prime Collaboration Provisioning is restarted. To restart:
      1. Log into the server using SSH.
      2. Go to /opt/cupm folder and execute the ./cupm-app-service.sh stop command.
      3. Check whether the services are down by executing the following command:
        
        ps -aef | grep startcupm
        
        If there are any processes running, kill those services by using the following command:
        
        kill -9 <processID1> <processId2>
        ps -aef | grep nice
        
        If there are any processes running, kill those services by using the following command:
        
        kill -9 <processID1> <processId2>
        
      4. Check if the port 46009 is free (used by JBoss):
        
        netstat -a | grep 46009
        
        If this port is in use, wait till it gets free.
      Step 4   Start the application services:
      execute ./cupm-app-service.sh start

      Wait for the services to start.


      Changing the Log Purging Level

      Procedure
        Step 1   On the Prime Collaboration Provisioning system, go to the /opt/cupm/sep folder. If you accepted the default location during installation, the installation location is /opt/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, and restart the Prime Collaboration Provisioning services, as your changes will not take effect until Prime Collaboration Provisioning is restarted.
        1. Log into the server using SSH.
        2. Go to /opt/cupm folder and execute the ./cupm-app-service.sh stop command.
        3. Check whether the services are down by executing the following commands:
          
          ps -aef | grep startcupm
          
          If there are any processes running, kill those services by using the following command:
          
          kill -9 <processID1> <processId2>
          ps -aef | grep nice
          
          If there are any processes running, kill those services by using the following command:
          
          kill -9 <processID1> <processId2>
          
        4. Check if the port 46009 is free (used by JBoss):
          
          netstat -a | grep 46009
          
          If this port is in use, wait till it gets free.
        Step 4   Start the application services:
        execute ./cupm-app-service.sh start
        Wait for the services to start.

        Enabling Data Purging for Provisioning

        You can configure Cisco Prime Collaboration Provisioning to purge data at a scheduled interval.

        Cisco Prime Collaboration Provisioning retains the following types of data:

        • Order—When an order is placed for any product provisioning (for example: endpoint, 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. By default, purging of Service Action data is enabled.
        • Task—Scheduling of infrastructure configuration updates. Through Infrastructure Configuration you can save configurations locally. The saved configurations can then be bundled in a Task and pushed to the device.
        • Workflow—After an order is placed for a product, it goes through a workflow (approval, shipping, and receiving) before going to the service activator.
        • Audit Trail—For every PIN/Password change, PIN/Password reset, PIN/Password change on next login, unlock voice mail of a user in a Unity or Unity Connection device, an audit entry is created.

          Note


          Data is 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.


        Procedure
          Step 1   Choose Administration > System Setup > Provisioning Setup > Data Maintenance . (See Table 1-1 for navigation in the standalone Prime Collaboration Provisioning application.)
          Step 2   Check the check box in the row for the data you want to schedule for purging.
          Step 3   In the Retention Time in Days column, change the number of days for which you want to retain the data (default is seven days except for ServiceAction, which is 30 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 to keep and not purge. For example, if there are 1000 total orders and the retention count is 200, Provisioning will purge 800 orders and keep the last 200 orders.

          The default settings for the Retention Count are:

          • Orders—latest 100 orders
          • ServiceAction—Unlimited
          • Task—50
          • Workflow—50
          • Audit Trail—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. Only Orders and Workflow data is exported. Service action data cannot be exported.
          Step 6   Select a purge interval (the default is 24 hours), and click Update.

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

          To purge Provisioning data, choose Administration > System Setup > Provisioning Setup > Data Maintenance (In the standalone Prime Collaboration Provisioning application, choose Administration > System Maintenance > Data Maintenance). You can provide the data in the Data Maintenance Configuration page.


          Maintenance Mode

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

          Any user other than administrator will be able to access all non Provisioning pages as per the roles assigned to him. Though Provisioning links are available, when user tries to access these pages, a message appears indicating that the application is currently in Maintenance mode.

          Procedure
            Step 1   Choose Administration > System Setup > Provisioning Setup > Maintenance Mode (For UI navigation in standalone Prime Collaboration Provisioning application, see Prime Collaboration Provisioning Converged or Standalone User Interface).

            The Application Mode Management page appears with the following message:

            Exiting Maintenance mode will restore access to all users. Delete operations on processors (Call Processors, Unified Message Processors), LDAP and ACS Servers, Domains, and Service Areas will no longer be available.

            Step 2   Select a time delay from the Delay Before Maintenance Mode Begins (mins) drop-down list. You can select a time delay between 1 minute to 60 minutes. To put Cisco Prime Collaboration Provisioning to maintenance mode immediately, select Immediately.
            Step 3   In Message to Display to Logged-in Users, enter a message. This message will appear on the screens of the logged-in users. You can enter a maximum of 200 characters.
            Step 4   Click Enter Maintenance Mode, and then click Yes to confirm.

            A warning appears on the login page, notifying users that the 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 5   Perform any maintenance activities, such as deleting a Domain.
            Step 6   When you have completed the maintenance activities, select Maintenance Mode.
            Step 7   Click Exit Maintenance 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.

            An email notification will be sent to all the administrators when Cisco Prime Collaboration Provisioning is going into maintenance mode. The following notification event must be enabled to send an email notification:

            When system enters or exits Maintenance Mode (email will be sent to the logged in administrators)

            To configure notification settings, see Configuring System Notifications


            Performing Backup and Restore

            Cisco Prime Collaboration Provisioning allows you to backup your data and restore it. You can schedule periodic backups using the Provisioning UI, or run backup commands manually by logging in to the system as an admin user (CLI user). However, you must manually run restore commands by logging in to the system as an admin user (CLI user).

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

            Cisco Prime Collaboration Provisioning allows you to back up system data and restore it on a different system in the event of total system failure. To restore the backup from another system, the following prerequisites must be met:
            • Ensure that the application server to which data is restored has the same MAC address as that of the system that was backed up (the IP address and the hostname can be different).
            • If you are unable to assign the MAC address of the original system (the one that was backed up) to another system, contact Cisco TAC for information on a new license file (for a new MAC address).
            • The procedure to backup and restore data on a different system is the same as the procedure to backup and restore data on the same system.

            Backing Up the Single-Machine Provisioning Database

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

            Procedure
              Step 1   Login as root using SSH with port 22
              Step 2   Navigate to the /opt/cucm folder and enter the following command:
              ./cupm-app-service.sh stop
              Step 3   Stop Apache, JBoss, and NICE Services using the following commands:
              
              ps -aef | grep startcupm
              ps -aef | grep nice
              kill -9 <startcupm process ID>
              kill -9 <nice process ID>
              
              Step 4   Go to the directory using the command:
              cd /opt/postgres/9.0/bin
              Step 5   Run the following command:
              
              ./pg_dumpall -o -Upmadmin > /<backup_directory_name>/<backup_file_name>
              
              where,
              • pmadmin—postgres user id
              • backup_directory_name—Name of the directory where you want to place the backup file
              • backup_file_name—Backup will be created with this file name.
              Step 6   In a backup folder, make copies of the following files and directories:
              • /opt/cupm/sep/dfc.properties
              • /opt/cupm/sep/ipt.properties
              • /opt/cupm/sep/dfc.keystore
              • /opt/cupm/jboss/server/cupm/conf/login-config.xml
              • /opt/cupm/jboss/server/cupm/deploy/dfc-ds.xml
              Step 7   Start Apache, JBoss, and NICE Services using the following commands:
              cd /opt/cupm
              ./cupm-app-service.sh start

              Restoring the Single-Machine Provisioning Database

              Before You Begin

              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 database (the PostgreSQL database).

              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=46008
              • dfc.postgres.port=5432
              • dfc.nice.rmi.registry.internal.port=46001
              • 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 /opt/cupm/sep/dfc.properties file. If you accepted the default location during installation, the installation directory is /opt/cupm.

              Procedure
                Step 1   Login as root using SSH with port 22.
                Step 2   Navigate to the /opt/cucm folder and enter the following command:
                ./cupm-app-service.sh stop
                Step 3   Stop Apache, JBoss and NICE Services using the following command:
                
                ps -aef | grep startcupm
                ps -aef | grep nice
                kill -9 <startcupm process-id>
                kill -9 <nice process-id>
                
                1. To check whether the nice process is still holding on the postgres connection, enter the following command:
                  ps -aef
                2. Look for the process: /opt/cupm/jvm/bin/java -server -classpath /opt/cupm/sep/lib/dom.jar:/opt/cupm/sep/lib/jaxbapi.jar:/opt/cupm/sep/lib/jaxb-impl.jar

                  If the process is running then enter the following command:

                  kill -9 <Process-Id found earlier>
                Step 4   If you are restoring to the same installation, then proceed to the next step, if you are restoring to a new installation, paste the backed-up file (bak) into /mnt folder
                Step 5   Go to the directory using the command:
                cd /opt/postgres/9.0/bin
                Step 6   Run the following command:
                
                ./CUPM-restore.sh <username> <password> /mnt/<backup_file_name>
                

                where, username is the username of the PostgreSQL administrator. The default administrator username is pmadmin; the password is same as you entered for globaladmin.

                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:
                • /opt/cupm/sep/dfc.properties
                • /opt/cupm/sep/ipt.properties
                • /opt/cupm/sep/dfc.keystore
                • /opt/cupm/jboss/server/cupm/conf/login-config.xml
                • /opt/cupm/jboss/server/cupm/deploy/dfc-ds.xml
                Step 8   Start Apache, JBoss, and NICE Services using the following commands:
                cd /opt/cupm
                ./cupm-app-service.sh start

                Backing Up Provisioning for a Distributed Database

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

                Procedure
                  Step 1   Login as root using SSH with port 22.
                  Step 2   Navigate to the /opt/cupm folder in the application server and enter the following command:
                  ./cupm-app-service.sh stop
                  Step 3   In the Prime Collaboration Provisioning application server, stop Apache, JBoss and NICE Services using the following commands:
                  
                  ps -aef | grep startcupm
                  ps -aef | grep nice
                  kill -9 <startcupm process id>
                  kill -9 <nice process id>
                  
                  Step 4   In the database server, go to the directory:
                  cd /opt/postgres/9.0/bin
                  Step 5   Run the following command:
                  
                  ./pg_dumpall -o -Upmadmin /<backup_directory_name>/<backup_file_name>
                  
                  where,
                  • pmadmin—postgres user id
                  • backup_directory_name—Name of the directory where you want to place the backup file
                  • backup_file_name—Backup will be created with this file name.
                  Step 6   In a backup folder, make copies of the following files and directories from the application server:
                  • /opt/cupm/sep/dfc.properties
                  • /opt/cupm/sep/ipt.properties
                  • /opt/cupm/sep/dfc.keystore
                  • /opt/cupm/jboss/server/cupm/conf/login-config.xml
                  • /opt/cupm/jboss/server/cupm/deploy/dfc-ds.xml
                  Step 7   In the Prime Collaboration Provisioning application server, start Apache, JBoss, and NICE Services using the following commands:
                  cd /opt/cupm
                  ./cupm-app-service.sh start

                  Restoring Provisioning for a Distributed Database

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

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

                  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=46008
                  • dfc.postgres.port=5432
                  • dfc.nice.rmi.registry.internal.port=46001
                  • 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 /sep/dfc.properties file. (If you accepted the default location during installation, the installation directory is /opt/cupm.)

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

                  • dfc.postgres.host=<system name> (If the database is on one system.)
                  • dfc.postgres.hostlist=<system names> (If the database is on multiple systems.)
                  Restoring Database in the Database Server
                  Procedure
                    Step 1   Login as root using SSH with port 22.
                    Step 2   Navigate to the /opt/cupm folder in the application server and enter the following command:
                    ./cupm-app-service.sh stop
                    Step 3   In the Prime Collaboration Provisioning application server, stop Apache, JBoss, and NICE Provisioning Services using the following command:
                    
                    ps -aef | grep startcupm
                    ps -aef | grep nice
                    kill -9 <startcupm process id>
                    kill -9 <nice process id>
                    
                    1. To check whether the nice process is still holding on the postgres connection, enter the following command:
                      ps -aef
                    2. Look for the process: /opt/cupm/jvm/bin/java -server -classpath /opt/cupm/sep/lib/dom.jar:/opt/cupm/sep/lib/jaxbapi.jar:/opt/cupm/sep/lib/jaxb-impl.jar

                      If the process is running then enter the following command:

                      
                      kill -9 <Process-Id found earlier>
                      
                    Step 4   If you are restoring to the same installation, then proceed to the next step. If you are restoring to a new installation, paste the backed-up file (bak) into /<backup_folder> in the database server.
                    Step 5   Go to the following directory in the database server:
                    cd /opt/postgres/9.0/bin
                    Step 6   Run the following command:
                    
                    ./CUPM-restore.sh <username> <password> /<backup_folder>/<backup_file_name>
                    

                    Where, username is the username of the PostgreSQL administrator. The default administrator username is pmadmin; the password is same as you entered for globaladmin

                    Step 7   If you are restoring to the same installation, proceed to the next step. If you are restoring to a new installation, run the following commands in the database server:
                    cd /opt/postgres/9.0/bin 
                    ./psql -Upmadmin -d cupm 
                    select * from nicesyseng; 
                    
                    In the console output, check if there are any entries that contain your old IP address (in the host column). If there are any entries, delete them by executing the following command:
                    delete from nicesyseng where host='<old_IP_address>';
                    Step 8   Restart database services by using the following commands:
                    cd /opt/cupm
                    ./cupm-db-service.sh stop
                    ./cupm-db-service.sh start
                    

                    Restoring Database in the Application Server
                    Procedure
                      Step 1   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:
                      • /opt/cupm/logs/install.log
                      • /opt/cupm/sep/dfc.properties
                      • /opt/cupm/sep/ipt.properties
                      • /opt/cupm/sep/dfc.keystore
                      • /opt/cupm/jboss/server/cupm/conf/login-config.xml
                      • /opt/cupm/jboss/server/cupm/deploy/dfc-ds.xml
                      Step 2   Update the IP address of the database server (postgres host) in opt/cupm/sep/dfc.properties.
                      Step 3   Update the IP address of database server (postgres host) in opt/cupm/jboss/server/cupm/deploy/dfc-ds.xml.
                      Step 4   Start Apache, JBoss, and NICE Services using the following commands:
                      cd /opt/cupm
                      ./cupm-app-service.sh start

                      Scheduling Backup Using the Provisioning User Interface

                      You can create periodic backups of Provisioning database using the Provisioning User Interface. You must be logged in as an administrator to perform backup. To create a backup of the Provisioning database:

                      Procedure
                        Step 1   Choose Administration > System Maintenance > Backup Management.
                        Step 2   In the Backup Management page, click New.
                        Step 3   Enter a backup title in the Create New Backup page.
                        Step 4   From the Backup Connection drop-down list, select SFTP, FTP, or Local to save your backup files.
                        1. If you select SFTP or FTP, provide the following details:
                          • IP address of the server where the backup files need to be saved.
                          • Path to the backup location and port details (for SFTP only).
                          • Username and password information. Testing the SFTP or FTP password is optional.
                        2. If you select local, provide only the location where you want to save the backup files on your local machine.
                        Step 5   For a local backup, select the number of backup files you want to save on your local machine from the Backup History drop-down list.

                        The default value is 2. By default, you can save two recent backup files. You can save up to 9 recent backup files.

                        Step 6   Enter the scheduling details to schedule a backup.

                        The time displayed is the client browser time. The default recurrence type for a new backup job is None. After a backup job is created with default settings, the backup will start immediately.

                        Step 7   Enter email address to receive status notification for the scheduled backup. You can enter multiple email addresses separated with a comma.
                        Step 8   Click Save. The scheduled backup appears in the Backups table on the Backup Management page.
                        Step 9   Click Run Now, to run a backup immediately.

                        Prime Collaboration Provisioning enters maintenance mode before backup starts. A notification will be displayed for all logged-in users stating that the users will be logged out of Prime Collaboration Provisioning 10 minutes before the scheduled backup starts. Users must save their work and log out before the backup starts, else they will be logged out automatically, and will not be able to access Prime Collaboration Provisioning.

                        The backup table provides information on the status and history of each backup job. The Next Run Time option provides details on the next periodic schedule.

                        The Last Run Status column shows the status of the last run backup job. The status of a backup job can be Scheduled, In Progress, Success or Failed.

                        When a backup job reaches the scheduled time, the last run status changes to Scheduled. After entering into maintenance mode, that is after 10 minutes, the status will change from Scheduled to In Progress.

                        After the backup job is complete, the status is either Success or Failure.

                        To know about the history of any backup job, click Run History Count, and open the dialog box. You can view the start time, end time, status and file size of the backup. You can delete the run history logs. The backed up files are not deleted when the backup logs are deleted.

                        Managing Backup Jobs

                        With the scheduled jobs, you can:
                        • Edit and Delete: The Edit and Delete options are disabled during Scheduled and In Progress states. You cannot edit or delete a backup job when the backup is in Scheduled or In Progress state. You can edit only one backup job at a time.
                        • Cancel: You can cancel a running backup job which is in Scheduled or In Progress state only.