Cisco Unified Contact Center Express Command Line Interface Reference Guide, Release 9.0(2)
Utils Commands
Downloads: This chapterpdf (PDF - 1.23MB) The complete bookPDF (PDF - 2.57MB) | The complete bookePub (ePub - 251.0KB) | Feedback

Utils Commands

Utils Commands

utils cuic purge

Command Syntax

utils cuic purge

This command runs a manual purge of the cuic database tables. You might do this if you receive an alert that the database is nearing capacity and you do not want to wait for the daily automatic purge.

The tables purged are:
  • CuicDataSetInfo
  • CuicDataSet
  • CuicReportDefinitionFilter
  • CuicReportDefinitionFilterField
  • CuicReportDefinitionFilterParameter
  • CuicCollection
  • CuicCollectionValue

This command prompts for the password of the administration user. When the password is confirmed, the purge runs immediately.

Options

None

Requirements

Level privilege—1

Command privilege level—1

Allowed during upgrade—Yes

Example

admin:utils cuic purge

utils remote_account

This command allows you to enable, disable, create, and check the status of a remote account.

Command Syntax

  • utils remote_account status
  • utils remote_account enable
  • utils remote_account disable
  • utils remote_account create username life Arguments
  • username specifies the name of the remote account. The username can contain only lowercase characters and must be more than six characters long.
  • life specifies the life of the account in days. After the specified number of day, the account expires Usage Guidelines

A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the system for the specified life of the account. You can have only one remote account that is enabled at a time.

Example

admin:utils remote_account status

Caution


Avoid creating remote account usernames starting with "uccx" or "UCCX" because such usernames may conflict with system account names used internally within the Cisco Unified Contact Center Express server.


utils reset_application_ui_administrator_name

This command resets the application user interface administrator name.

Command Syntax

utils reset_application_ui_administrator_name

Command Modes

Administrator (admin)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes


Note


Restart the service (Cisco Unified Intelligence Center Reporting Service) on all nodes in the cluster to enable the new administrator to log in to Unified Intelligence Center.


utils reset_application_ui_administrator_password

This command resets the application user interface administrator password.

Command Syntax

utils reset_application_ui_administrator_password

Command Modes

Administrator (admin)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils service [list start stop restart auto-restart]

This is the CLI command for service control.

The CLI command allows starting, stopping, and restarting of all the services as listed:

System SSH

Service Manager

A Cisco DB

Cisco Tomcat

Cisco Database Layer Monitor

Cisco Unified Serviceability

Cisco CAR DB

Service Manager

Cisco Unified CCX Cluster View Daemon

Cisco Unified CCX Database

Cisco Unified CCX Application Administration

Cisco Unified CCX Serviceability Administration

Cisco Unified CCX Engine

Cisco Desktop Agent E-Mail Service

Cisco Desktop Call/Chat Service

Cisco Desktop Enterprise Service

Cisco Desktop LDAP Monitor Service

Cisco Desktop License and Resource Manager Service

Cisco Desktop Recording and Playback Service

Cisco Desktop Recording and Statistics Service

Cisco Desktop Sync Service

Cisco Desktop VoIP Monitor Service

Cisco Desktop Browser and IP Phone Agent Service

Cisco Unified CCX Notification Service

Command Syntax:

utils service [option] [service-name]

Arguments:

  • <option>—The option to start/stop/restart etc.
  • <service-name>—The service which is to be started/stopped or restarted. Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin: utils service start "Unified CCX Application Administration" 
Command successful.
Unified CCX Application Administration started successfully.

utils system upgrade initiate

This command allows you to install upgrades and Cisco Option Package (COP) files from both local and remote directories.

Command Syntax

utils system upgrade initiate

Arguments

initiate starts a new upgrade wizard or assumes control of an existing upgrade wizard. The wizard prompts you for the location of the upgrade file for Unified CCX.

utils system switch-version

This command allows you to restart the system on the inactive partition.

Command Syntax

utils system switch-version

Arguments

switch-version switches to the Unified CCX product release that is installed on the inactive partition.

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

When the user initiates a switch version, system restart, or system shutdown from the CLI, a warning message is displayed and user confirmation is requested before proceeding with the command execution. This is applicable for the following scenarios:

  • if the system detects that a switch version is in progress
  • if the system detects that a previous switch version was abruptly terminated

Note


A switch version operation is abruptly terminated if a power reset or hard reboot is done on the Unified CCX system when it is in progress.


utils uccx database dbserver integrity

Checks the integrity of the database server disk structures and displays results. It also checks the DB config integrity and does a fix if integrity is broken. Detailed information is output to a text file. The Informix utility oncheck will be used for the command.

Command Syntax

utils uccx database dbserver integrity

Arguments

The name of the file containing the output from all the checks performed is automatically generated by the command script. In order for the filename to be generated to be unique, the naming format will be DbServerIntegrity_<TIMESTAMP>.txt. This will ensure the uniqueness across processes and over time. The file path and file name are displayed upon completion.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

This operation may take a few minutes to complete. Please wait...
 Output is in file: uccx/cli/DbServerIntegrity_1270057580834.txt
Command successful.
Starting DB config integrity check
 This operation may take a few minutes to complete. Please wait...
Output is in file: uccx/cli/DbConfigIntegrity_1270057597410.txt
 Command successful..

utils uccx eemtables cleanup normal

Purges e-mail records from the database (Normal Mode). All e-mail records meeting the parameters you enter are removed from the database.

Command Syntax

utils uccx eemtables cleanup normal <CSQ ID> <cutoff date> <e-mail state>

Arguments

CSQ ID all records containing this CSQ ID are purged if other criteria are met. This must be an integer.

cutoff date any recognizable date as specified by the Informix Date command. All e-mail records are purged up to, but not including, the cutoff date.

e-mail state Optional. If this parameter is not given, the command behaves as if the parameter ALL is used. The options are:
  • Queued: use for e-mail statuses In Queue Waiting, Transferred, Requeued, and PeerReview.
  • Assigned: Use for e-mail statuses In process at agent and In draft at agent
  • Resolved: Use for e-mail statuses Pending Delete, Sent, and Deleted
  • All: Use to select all e-mail statuses.

Example

admin:utils uccx eemtables cleanup normal 15 9/16/2010 all

utils uccx eemtables cleanup uid

Command Syntax

utils uccx eemtables cleanup uid <uid>

Purges e-mail records from the database that contain the specified e-mail UID (UID Mode).

Arguments

uid unique ID for an e-mail message, corresponding to the emailUIDOnMailServer field in the e-mail tables. These IDs can be obtained by running SELECT queries on the appropriate tables.

Requirements

Level privilege—1

Command privilege level—1

Allowed during upgrade—Yes

Example

admin:utils uccx eemtables cleanup uid 206785259 1208664064 -1111623128

utils uccx delete license licenseName

This command deletes a license, permanent or temporary, that is already uploaded into the Unified CCX system.


Caution


Use this command with extreme care, because it will delete any license that has been uploaded to the Unified CCX system, without checking whether the license is a temporary or a permanent one. We recommend that you use this command only to delete wrong or invalid permanent licenses. You can delete temporary licenses by using Unified CCX Administration.

Note


For the single node system, execute the delete command first, and then restart the Unified CCX node. For the HA system, execute the delete command separately on each of the two nodes, and then restart both the Unified CCX nodes in the cluster.

Command Syntax

utils uccx delete license licenseName

Arguments

  • licenseName—mandatory;licenseName. This license will be deleted from the Unified CCX system

Options

NA

Requirements

Level privilege—1

Command privilege level—1

Allowed during upgrade—false

Example

admin:utils uccx delete license ccx85_premium_300seat.lic
Warning:
Deleting the license may have adverse effect on the working of the uccx system. 
After deleting the license the UCCX nodes in the cluster have to be restarted for the changes to be reflected.
Are you sure you want to run this command? 
Continue(y/n)? y
Command successful.

utils uccx jtapi_client update

This command updates the JTAPI Client version on the active partition on the Unified CCX box to match JTAPI version on the Unified CM. This command downloads the JTAPI Client from the Unified CM and checks if the downloaded version needs to be installed. If the downloaded version needs to be installed, it will install the downloaded JTAPI Client and will display a message that the JTAPI Client was updated with the previous and the current versions. If the downloaded version does not need to be installed, it will display a message saying the same and will display the current JTAPI Client version.

The JTAPI client update will happen only on the local node and not the second node in case of an HA deployment.


Note


After you run this command, you must reboot the Unified CCX server and restart all the Unified CCX services. For more information on how ro restart the Unified CCX services, see the Cisco Unified CCX Serviceability Administration Guide available here:



Note


http:/​/​www.cisco.com/​en/​US/​products/​sw/​custcosw/​ps1846/​products_​installation_​and_​configuration_​guides_​list.html


Command Syntax

utils uccx jtapi_client update

Arguments

NA

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:utils uccx jtapi_client update Node ID: 1 -- Cisco JTAPI Client versions are consistent
 Command successful.

utils uccx list license

This command lists the licenses that are uploaded into the Unified CCX system.

Command Syntax

utils uccx list license

Arguments

NA

Requirements

Level privilege—1

Command privilege level—1

Allowed during upgrade—false

Example

admin:utils uccx list license
The following licenses are uploaded in the system:
ccx85_premium_300seat.lic
ccx85_pre_warm_stby_demo.lic
Command successful.

utils uccx prepend custom_classpath

This command adds the CustomJarName to the classpath ahead of the system classpath.


Note


This command must be used when there are common classes being used in the custom code as well as by UCCX and there is a version mismatch between the common classes being used.

Warning


The Custom clsspath be added only if the Custom class files have a newer version than the class files used by UCCX. Adding class files that are of older version at the start of the classpath could lead to system instability.

Command Syntax

utils uccx prepend custom_classpath <CustomJarName>

Arguments

CustomeJarName— Mandatory; Custom jar filename to be prepended to classpath

Example

admin:utils uccx add custom_classpath jsafe.jar
Command successful.

utils uccx setuppubrestore

This command sets up a password less communication between CCX cluster nodes. Password less communication is required to perform the restore operation.

Command Syntax

utils uccx setuppubrestore

Arguments

NA

Example

admin:utils uccx setuppubrestore

utils uccx switch-version db-check

This command allows you to check if the database was corrupted after an unsuccessful switch version due to a restart in the middle of a switch version attempt. The command will display the status of last switch version. If there is a database backup available that can be restored, it will print the timestamp of the backup and display the CLI command utils uccx switch-version db-recover to recover from this backup.

Command Syntax

utils uccx switch-version db-check

Parameters

  • None

Requirements

Level privilege—1

Command privilege level—1

Allowed during upgrade—None

Example

admin:utils uccx switch-version db-check
CCX DB was found to be corrupted.

Last switch version was aborted at 05/29/2012 16:18:07
05/29/2012 16:18:07|root:Switch Version 9.0.1.10000-41 to 9.0.10000-42 Aborted

There is a CCX backup with timestamp 2012-05-29 16:16:19.000000000 +0530 that was taken during a prior switch version.

!!!WARNING!!! IF YOU CHOOSE TO RECOVER FROM THIS BACKUP, ANY CHANGES DONE TO THE DATABASE AFTER THE TIMESTAMP OF THIS BACKUP WILL BE LOST.

You can run the CLI command "utils uccx switch-version db-recover" to restore the DB from this backup.

utils uccx switch-version db-recover

This command will first check if the database was corrupted after an unsuccessful switch version due to the restart in the middle of a switch version attempt. The command will display the status of the last switch version. If there is a database backup available that can be restored, it will print the timestamp of the backup and offer an option to restore the database from this backup. If the restore option is chosen, the command will complete after restoring the database from this backup and bringing up all the services.

Command Syntax

utils uccx switch-version db-recover

Parameters

  • None

Requirements

Level privilege—1

Command privilege—1

Allowed during upgrade—No

Example

admin:utils uccx switch-version db-recover
CCX DB was found to be corrupted.

Last switch verison was aborted at 05/29/2012 16:18:07
05/29/2012 16:18:07|root:Switch Version 9.0.1.10000-42 Aborted

There is a CCX DB backup with timestamp 2012-05-29 16:16:19:000000000 +530 that was taken during a prior switch version.

!!!WARNING!!! IF YOU CHOOSE TO RECOVER FROM THIS BACKUP, ANY CHANGES DONE TO THE DATABASE AFTER THE TIMESTAMP OF THIS BACKUP WILL BE LOST.

Are you sure you want to continue?
Continue (y/n)?y
This operation may take a few minutes to complete. Please wait

utils uccx syncusers

This command allows you to synchronize the uccx user passwords with the security password.

Command Syntax

utils uccx syncusers

Arguments

NA

Example

admin:utils uccx syncusers
Command successful.