Besides the commands available on Unified CCX , more commands are available that can be executed as a part of Unified Operating System. For detailed information about all the CLI commands available for the Cisco Unified Operating System, see the Command Line Interface Reference Guide for Cisco Unified Communications Solutions available here:

https://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html

The following Unified Operating System commands are not applicable to Unified CCX :

• delete dscp

• file delete license

• file get license

• file list license

• file view license

• set cert bulk

• set dscp

• set network cluster publisher

• set network dhcp

• set network ipv6 dhcp

• set network ipv6 service

• set network ipv6 static_address

• show ctl

• show dscp

• show itl

• show network ipv6 settings

• show tech ccm_service

• run loadxml

• utils sso unavailable

Important

When file get CLI command is used with the abstime as an option to collect log files, this filters the files based on the last modified timestamp. If the last modified time is updated, this CLI may not give desired results. Use the log collection feature in RTMT instead to collect the log files.

This command displays the Unified CCX versions on the active partition and the inactive partition. The inactive version is displayed only if the inactive partition is available.

Command syntax

show uccx version

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx version 
Active UCCX Version: 10.5.0.95000-152
Inactive UCCX Version: NA
Command successful. 

This command displays the JTAPI client version that the Unified CCX is using on the active and the inactive partitions. The inactive version is displayed only if the inactive partition is available.

Command syntax

show uccx jtapi_client version

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx jtapi_client version 
Active:Cisco JTAPI version 9.0(0.96000)-4 Release
Inactive: NA
Command successful. 

This command displays the various components in Unified CCX for which tracing can be turned on or off from CLI commands. This command is useful when you need the list of components to modify the trace settings of Unified CCX.

Command syntax

show uccx components

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx components
Various UCCX components are as follows -

 UCCXEngine
 UCCXCVD
 UCCXEditor
 JTAPI_CLIENT
 UCCXAppAdmin 

This command displays the various subcomponents in specific Unified CCX component. This command is useful when you need the list of subcomponents to modify the trace settings of Unified CCX.

Command syntax

show uccx subcomponents component [options]

Options

• component—(Mandatory) Component such as UCCXEngine or UCCXEditor. For example, some of the UCCX subcomponents for 'UCCX_ENGINE' component are:

  • APP_MGR

  • ARCHIVE_MGR

  • BOOTSTRAP_MGR

  • CFG_MGR

  • CHANNEL_MGR and so on

• page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx subcomponents uccxengine

This command displays various licenses that are configured for Unified CCX and the features which have been activated. This command works only if the Unified CCX Cluster View Daemon (CVD) is running.

Note	This command does not display license-expiry information. For more information about viewing licenses, see the Cisco Unified Contact Center Express Administration and Operations Guide . This command is not applicable when you are using Smart Licensing.

Command syntax

show uccx license

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx license
Configured Licenses:

Package: Cisco Unified CCX Premium
IVR Port(s): 300
Cisco Unified CCX Premium Seat(s): 300
High Availability : Enabled
Cisco Unified CCX Preview Outbound Dialer: Enabled
Cisco Unified CCX Quality Manager Seat(s): 300
Cisco Unified CCX Advanced Quality Manager Seat(s): 300
Cisco Unified CCX Workforce Manager Seat(s): 300
Cisco Unified CCX Compliance Recording Seat(s): 300
Cisco Unified CCX Maximum Agents: 400
Cisco Unified CCX Licensed Outbound IVR Port(s): 150
Cisco Unified CCX Licensed Outbound Agent Seat(s): 150
For dynamic content like the Inbound ports In Use and Outbound IVR Ports/Agent Seats In Use please check using the Cisco Unified CCX Administration.

Command successful.

This command displays the names and trace levels of the various Unified CCX components and subcomponents. If the optional component is specified, then the trace settings of all the subcomponents of the specified component are displayed. If both the optional component and subcomponent are specified, then the trace settings of the specified subcomponent of the specified component are displayed.

Command syntax

show uccx trace levels [options]

Options

• Component—Displays the trace levels of all the subcomponents of this component

• Sub-component—Displays the trace levels of this subcomponent for the specified component. The trace levels can be displayed only if the component was specified

• page—Displays the output one page at a time

• file—Stores the output to a file instead of showing it on the console. The name of the file is displayed after the completion of the command

  Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx trace levels UCCXEngine  
 Trace settings for component 'UCCX_ENGINE' and module  are
  ALARM = true
  DEBUGGING = false
  XDEBUGGING1 = false
  XDEBUGGING2 = false
  XDEBUGGING3 = false
  XDEBUGGING4 = false
  XDEBUGGING5 = false

 Command successful.

admin:show uccx trace levels UCCXEngine  
 Trace settings for component 'UCCX_ENGINE' and module  are
  ALARM = true
  DEBUGGING = false
  XDEBUGGING1 = false
  XDEBUGGING2 = false
  XDEBUGGING3 = false
  XDEBUGGING4 = false
  XDEBUGGING5 = false

 Command successful.

This command shows the Unified CCX AXL provider IP address.

Command syntax

show uccx provider ip axl

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin: show uccx provider ip axl
Cisco Unified Communications Manager IP is 10.78.14.140

Command Successful.

This command shows the Unified CCX JTAPI provider IP address.

Command syntax

show uccx provider ip jtapi

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin: show uccx provider ip jtapi
UCCX JTAPI Provider is 10.78.14.140

Command Successful.

This command shows the Unified CCX Resource Manager-Contact Manager provider IP address.

Command syntax

show uccx provider ip rmcm

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin: show uccx provider ip rmcm
UCCX RMCM Provider is 10.78.14.140

Command Successful.

This command shows the trace file size for the specified component.

Command syntax

show uccx trace file size [component]

Options

component—(Mandatory) Component such as UCCXEngine or UCCXEditor

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: Yes

Example

admin: show uccx trace file size UCCXEngine
Trace file size for UCCXEngine is 3000000 bytes.

Command Successful.

This commands shows the trace file count for the specified component, which is the maximum number of trace files. The new file overwrites the older files.

Command syntax

show uccx trace file count [component]

Options

component—(Mandatory) Component such as UCCXEngine or UCCXEditor

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: Yes

Example

admin: show uccx trace file count UCCXEngine
Trace file count for UCCXEngine is 300.

Command Successful.

This command displays the status of the Socket.IO service and the following details of the LiveData connection:

• Total Active Client Connections to Socket.IO server.

• Total Long Polling clients connected to Socket.IO server.

Command syntax

show uccx livedata connections

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx socketio connection
Server Status: Active
Client Count: 2 (polling: 1)

Command successful.

This command allows you to show the minimum TLS version in the server that is currently configured.

Command syntax

show tls server min-version [tls server minVersion]

Options

tls server minVersion—Refers to 1.2 (TLS Version 1.2)

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:show tls server min-version
The server tls min-version is set to 1.2
Command successful

This command allows you to show the minimum TLS version in the client that is currently configured.

Command syntax

show tls client min-version [tls client minVersion]

Options

tls client minVersion—Refers to 1.2 (TLS Version 1.2)

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:show tls client min-version
The client tls min-version is set to 1.2
Command successful

This command runs the commands show uccx tech dbserver log diagnostic and show uccx tech dbserver status in succession and stores the output of the commands in a file.

Command syntax

show uccx tech dbserver all

Note	The name of the file containing the output from each show uccx tech command run is automatically generated by the command script. The file path and filename are displayed after the completion of the operation.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx tech dbserver all 
This operation may take a few minutes to complete. Please wait...

Output is in file: uccx/cli/DbServerAll_1250664874580.txt

Command successful.

This command checks for the existence of Informix assertion failure and shared memory dump logs. If logs exist, the name and path of the log files are displayed.

Command syntax

show uccx tech dbserver log diagnostic [options]

Options

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx tech dbserver log diagnostic 
This operation may take a few minutes to complete. Please wait...

The following diagnostic logs are available for the UC database server.
 core/log.txt
 core/gskit.log

 Command successful.

This command outputs a detailed status report of the Unified CCX database server (IDS engine) instance, that is onstat -a to a txt file.

Command syntax

show uccx tech dbserver status

Note	The name of the file is automatically generated by the command script. The file path and filename are displayed after the completion of the operation.

Requirements

Level privilege—0

Command privilege level—0

Allowed during upgrade—Yes

Example

admin:show  uccx tech dbserver status 
This operation may take a few minutes to complete. Please wait...

 Output is in file: uccx/cli/DbServerStatus_1250666138379.txt

 Command successful.

This command dumps the contents of the specified database. This command can be used to recreate a customer database on a test system for troubleshooting. For each Unified CCX database table, a dump csv file is created. Because there are huge numbers of files, these files are created in a subdirectory which will have the name as DbContents_<TIMESTAMP>. After the completion of the command, the subdirectory name and subdirectory path are displayed.

Command syntax

show uccx dbcontents database_name

Arguments

database_name—(Mandatory) Database whose contents will be output to CSV file

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:show uccx dbcontents db_cra 
 This operation may take a few minutes to complete. Please wait...
 Database contents dump is in directory: uccx/cli/DbContents_1250666234370

 Command successful.

This command displays the column names of the specified table.

Command syntax

show uccx dbtable schema database_name table_name [options]

Arguments

database_name—(Mandatory) Name of the database (db_cra, db_cra_repository etc.,) in which the table resides

table_name—(Mandatory) Name of the table

Options

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbtable schema db_cra_repository documentsfiletbl
List of columns in table 'documentsfiletbl' in database 'db_cra_repository' is -
filename (nvarchar)
parentfolderid (nvarchar)
payload (blob)
lastmodifystamp (datetime year to fraction(3))
lastmodifyuser (nvarchar)
length (int)
checksum (int)

Command successful.

This command outputs the schema for all the tables, views, and stored procedures in the specified database to a text file. The output consists of SQL statements that are necessary to replicate a specified database. The IDS "dbschema" utility is used to create the file. This command only displays the DB schema; it does not provide any data in the tables.

Command syntax

show uccx dbschema database_name

Arguments

database_name—(Mandatory) Name of the database whose schema will be output

Note	The name of the file containing the schema is automatically generated by the command script. The file path and filename are displayed after the completion of the operation.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbschema db_cra
Output is in file: uccx/cli/schema_db_cra_080212-110543.txt

This command displays the names of all the tables contained in the specified Unified CCX IDS database. The database names can be db_cra, db_cra_repository, FCRasSvr, sysmaster.

Command syntax

show uccx dbtable list database_name [options]

Arguments

database_name—(Mandatory) Database name where tables reside

Options

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbtable list 
db_craList of tables in database 'db_cra' is -
 agentconnectiondetail
 agentroutingsetting
 agentstatedetail
 application
 areacode
 campaign
 campaigncsqmap
 configlog
 configschema
 configschemacolumn
 configseed 
…
…
teamcsqmapping
 workflowtask
 Command successful.

This command displays information for each storage space (chunks and dbspaces).

Command syntax

show uccx dbserver disk [options]

Options

page—Displays the output one page at a time

file—Outputs the information to a .txt file. The filename is generated dynamically at runtime and the filename and path are displayed to user after the completion of the operation.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbserver disk
SNO. DATABASE NAME      TOTAL SIZE (MB) USED SIZE (MB) FREE SIZE (MB) PERCENT FREE
---- ------------------ --------------- -------------- -------------- ------------
 1    rootdbs                     358.4           66.3          292.1          81%
 2    log_dbs                     317.4          307.3           10.1           3%
 3    db_cra                      512.0            8.8          503.2          98%
 4    db_hist                   13000.0         3651.4         9348.6          71%
 5    db_cra_repository            10.2            2.9            7.3          71%
 6    db_frascal                  512.0            2.8          509.2          99%
 7    temp_uccx                  1572.9            0.1         1572.7          99%
 8    uccx_sbspace               3145.7         2988.1          157.6           5%
 9    uccx_er                     204.8            0.1          204.7          99%
 10   uccx_ersb                  1572.9         1494.1           78.8           5%


CHUNK NO. OFFSET TOTAL SIZE (MB) FREE SIZE (MB) FILENAME
--------- ------ --------------- -------------- ---------------------------------------------
 1         0               358.4          292.1  /var/opt/cisco/uccx/db/root_uccx_dbs
 2         0               317.4           10.1  /var/opt/cisco/uccx/db/log_dbs
 3         0               512.0          503.2  /var/opt/cisco/uccx/db/db_cra_dbs
 4         0             13000.0         9348.6  /common/var-uccx/dbc/db_hist_dbs
 5         0                10.2            7.3  /var/opt/cisco/uccx/db/db_cra_repository_dbs
 6         0               512.0          509.2  /var/opt/cisco/uccx/db/db_frascal_dbs
 7         0              1572.9         1572.8  /common/var-uccx/dbc/temp_uccx_dbs
 8         0              3145.7          157.6  /var/opt/cisco/uccx/db/uccx_sbspace_dbs
 9         0               204.8          204.7  /common/var-uccx/dbc/uccx_er_dbs
 10        0              1572.9           78.8  /common/var-uccx/dbc/uccx_ersb_dbs

This command displays detailed session and SQL-related information for each database user session. The content of the information displayed is equivalent to running the IDS command onstat -g ses for each active session.

Command syntax

show uccx dbserver sessions all [options]

Options

• page—Displays the output one page at a time

• file—Outputs the information to a txt file. The filename is generated dynamically at runtime and the filename and path are displayed to user after the completion of the operation.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbserver sessions all
IBM Informix Dynamic Server Version 10.00.UC5XD   -- On-Line -- Up 58 days 02:26:37 -- 444676 Kbytes

session                                      #RSAM    total      used       dynamic
id       user     tty      pid      hostname threads  memory     memory     explain
27       cudbeven -        6750     crslnx   1        151552     75400      off

tid      name     rstcb    flags    curstk   status
75       sqlexec  52477164 Y--P---  4208     cond wait(netnorm)

Memory pools    count 2
name         class addr     totalsize freesize #allocfrag #freefrag
27           V     5309a020 147456    73704    148        50
27*O0        V     5442f020 4096      2448     1          1

name           free       used           name           free       used
overhead       0          3296           scb            0          96
opentable      0          6456           filetable      0          1088

sqscb info
scb      sqscb    optofc   pdqpriority sqlstats optcompind  directives
52fda4d0 53234018 0        0           0        0           1

Sess  SQL            Current            Iso Lock       SQL  ISAM F.E.
Id    Stmt type      Database           Lvl Mode       ERR  ERR  Vers Explain   
27    -              uccxdirdb         CR  Wait 30    0    0    9.03 Off       

Last parsed SQL statement :
  SELECT FIRST 100 *, CAST(Timestamp AS varchar(32)) AS strTimestamp,
    CAST(Object_Id AS varchar(64)) AS strObject_Id FROM
    UccxDb: DbChangeEventQ WHERE EventId > ? ORDER BY EventId ASC

This command displays detailed session and SQL-related information for a specific session, which represents a user connected to the database server. The content of the information displayed is equivalent to running the IDS command onstat -g ses for an active session specified by the session-id.

Command syntax

show uccx dbserver session session_id [options]

Arguments

session_id—(Mandatory) The Informix session ID number

Options

page—Displays the output one page at a time

file—Outputs the information to a .txt file. The filename is generated dynamically at runtime and the filename and path are displayed to user after the completion of the operation.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbserver session 58
IBM Informix Dynamic Server Version 11.50.UC4     -- On-Line -- Up 14 days 04:43:40 -- 254160 Kbytes

session           effective                            #RSAM    total      used       dynamic
id       user     user      tty      pid      hostname threads  memory     memory     explain
58       uccxuser -         -        -1       sakkumar 1        126976     107496     off

tid      name     rstcb    flags    curstk   status
93       sqlexec  4b2deca0 Y--P---  5680     cond wait  netnorm   -

Memory pools    count 2
name         class addr     totalsize freesize #allocfrag #freefrag
58           V     4caa9028 122880    17064    332        18
58*O0        V     4c9d0028 4096      2416     1          1

name           free       used           name           free       used
overhead       0          3360           scb            0          96
opentable      0          8344           filetable      0          1104
ru             0          464            log            0          16512
temprec        0          21600          keys           0          1392
ralloc         0          5120           gentcb         0          1240
ostcb          0          2600           sqscb          0          29384
sql            0          40             rdahead        0          848
hashfiletab    0          280            osenv          0          1552
sqtcb          0          7464           fragman        0          368
GenPg          0          592            udr            0          5136

sqscb info
scb      sqscb    optofc   pdqpriority sqlstats optcompind  directives
4c907018 4cc92018 1        0           0        2           1

Sess       SQL            Current            Iso Lock       SQL  ISAM F.E.
Id         Stmt type      Database           Lvl Mode       ERR  ERR  Vers  Explain
58         -              db_cra             LC  Not Wait   0    0    9.28  Off

Last parsed SQL statement :
  select campaignen0_.campaignID as campaignID3_, campaignen0_.profileID as
    profileID3_, campaignen0_.recordID as recordID3_, campaignen0_.active as
    active3_, campaignen0_.ansMachineRetry as ansMachi5_3_,
    campaignen0_.cacheSize as cacheSize3_, campaignen0_.callbackTimeLimit as
    callback7_3_, campaignen0_.campaignName as campaign8_3_,
    campaignen0_.createDateTime as createDa9_3_, campaignen0_.dateInactive as
    dateIna10_3_, campaignen0_.description as descrip11_3_,
    campaignen0_.enabled as enabled3_, campaignen0_.endTime as endTime3_,
    campaignen0_.maxAttempts as maxAtte14_3_,
    campaignen0_.missedCallbackAction as missedC15_3_,
    campaignen0_.privateData as private16_3_, campaignen0_.startTime as
    startTime3_ from Campaign campaignen0_ where campaignen0_.active=?
 Command successful.

This command displays a one-line summary of each active Unified CCX database session. The summary includes the database name, username, session ID, and process ID. The session ID information can be used to display more detailed information about a specified session using the show uccx dbserver session command.

Command syntax

show uccx dbserver sessions list [options]

Options

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbserver sessions list
DATABASE           USERNAME     SESSION PROCESS ID
------------------ ------------ ------- ----------
 db_cra             uccxuser         49         -1
 db_cra             uccxuser         44         -1
 db_cra             uccxuser         46         -1
 db_cra             uccxuser         61         -1
 db_cra             uccxuser         24         -1
 db_cra             uccxuser         18         -1
 db_cra             uccxhruser    31224         -1
 db_cra             uccxuser         62         -1
 db_cra             uccxuser         60         -1
 db_cra             uccxuser         47         -1
 db_cra             uccxuser         59         -1
 db_cra             uccxuser         58         -1
 db_cra             uccxuser         48         -1
 db_cra             uccxuser         50         -1
 db_cra             uccxcliuser   31616         -1

 Command successful.

This command displays a one-line summary of each active uccx database user. The summary includes the database name, session ID and process ID. The session ID information can be used to display more detailed information about a specified user session using the show Unified CCX dbserver session command.

Command syntax

show uccx dbserver user list [option]

Option

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbserver user list
DATABASE           USERNAME     SESSION PROCESS ID
------------------ ------------ ------- ----------
 sysadmin           informix         15          0
 sysadmin           informix         16          0
 sysadmin           informix         17          0
 sysmaster          uccxuser         18         -1
 db_cra             uccxuser         18         -1
 sysmaster          uccxuser         24         -1
 db_cra             uccxuser         24         -1
 db_cra_repository  uccxuser         25         -1
 sysmaster          uccxuser         25         -1
 fcrassvr           uccxuser         26         -1
 sysmaster          uccxuser         26         -1
 sysmaster          uccxuser         44         -1
 db_cra             uccxuser         44         -1
 db_cra_repository  uccxuser         45         -1
 sysmaster          uccxuser         46         -1
 db_cra             uccxuser         46         -1
 sysmaster          uccxuser         47         -1
 db_cra             uccxuser         47         -1
 db_cra             uccxuser         48         -1
 sysmaster          uccxuser         48         -1
 sysmaster          uccxuser         49         -1

 Command successful.

This command displays a one-line summary of each Unified CCX database user and also displays whether a user session is waiting for a resource.

Command syntax

show uccx dbserver user waiting [option]

Option

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbserver user waiting
USERNAME     SESSION ID LATCH LOCK BUFFER CHECKPOINT TRANSACTION INCRITICAL
------------ ---------- ----- ---- ------ ---------- ----------- ----------
 informix            16     N    N      N          N           N          N
 informix            17     N    N      N          N           N          N
 informix            15     N    N      N          N           N          N
 uccxcliuser      33927     N    N      N          N           N          N
 uccxcliuser      32784     N    N      N          N           N          N
 uccxcliuser      32737     N    N      N          N           N          N
 uccxcliuser      32631     N    N      N          N           N          N
 uccxcliuser      34424     N    N      N          N           N          N
 uccxcliuser      32522     N    N      N          N           N          N
 uccxcliuser      34364     N    N      N          N           N          N
 uccxcliuser      32508     N    N      N          N           N          N
 uccxcliuser      32480     N    N      N          N           N          N
 uccxcliuser      31616     N    N      N          N           N          N
 uccxcliuser      31601     N    N      N          N           N          N
 uccxcliuser      34327     N    N      N          N           N          N
 uccxcliuser      34071     N    N      N          N           N          N
 uccxcliuser      33981     N    N      N          N           N          N
 uccxcliuser      33939     N    N      N          N           N          N
 uccxhruser       31224     N    N      N          N           N          N
 uccxuser         30278     N    N      N          N           N          N
 uccxuser            60     N    N      N          N           N          N

 Command successful.

This command displays the most recent messages in the Informix message log. The number of messages displayed is determined by the lines parameter.

Command syntax

show uccx tech dbserver log message [lines] [option]

Arguments

lines—(Optional) Number of lines from message log that will be displayed. Defaults to 20.

Option

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx tech dbserver log message 10
Message Log File: online.uccx.log

The last 10 lines of the log file are -

16:05:19  Maximum server connections 33
16:05:19  Checkpoint Statistics - Avg. Txn Block Time 0.000, # Txns blocked 0, Plog used 21, Llog used 12

16:10:19  Checkpoint Completed:  duration was 0 seconds.
16:10:19  Wed Aug 19 - loguniq 8, logpos 0x93c018, timestamp: 0xb0244c Interval: 4106

16:10:19  Maximum server connections 33
16:10:19  Checkpoint Statistics - Avg. Txn Block Time 0.000, # Txns blocked 0, Plog used 2, Llog used 2


 Command successful.

This command displays the contents of the specified table.

Command syntax

show uccx dbtable contents database_name table_name [option]

Arguments

database_name—(Mandatory) Name of the database for example, db_cra, db_cra_repository in which the table resides

table_name—(Mandatory) Name of the table

Option

page—Displays the output one page at a time

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show uccx dbtable contents db_cra resource 
Output is in file: uccx/cli/resource_Contents_1250666550481.csv

 Command successful.

This command sets the default trace levels for all components and subcomponents in Unified CCX. If the optional component is specified, it sets the default trace levels only for all the subcomponents of the specified component. If both the optional component and subcomponent are specified, it sets the default trace levels only for the specified subcomponent under the component.

Command syntax

set uccx trace defaults [component] [subcomponent]

Options

• Component—(Mandatory) Sets the default trace levels for all the subcomponents of this component. The various components are UCCXEngine, UCCXCvd, UCCXAppAdmin and JTAPI_CLIENT.

• Sub-component—(Optional) Sets the default trace levels for this subcomponent for the specified component. This trace level can be specified only if the component was specified preceding it.

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set uccx trace defaults uccxengine 
SS_HTTP
Default traces restored successfully for the module.

This command sets the trace file size for the specified component.

Command syntax

set uccx trace file size [component] [size]

Parameters

component—(Mandatory) The component such as UCCXEngine or UCCXEditor

size—(Mandatory) Specifies the file size in bytes

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set uccx trace file size uccxengine 3145728
Trace file size for uccxengine is set to 3145728 bytes.

This command sets the trace file count for the specified component, that is the maximum number of trace files after which older files will start getting overwritten.

Command syntax

set uccx trace file count [component] [no-of-files]

Arguments

• component—(Mandatory) The component such as UCCXEngine or UCCXEditor.

• no-of-files—(Mandatory) Specifies the number of files after which older files will get overwritten.

Requirements

Level privilege—1

Command privilege level—1

Allowed during upgrade—No

Example

admin:set uccx trace file count uccxengine 300
Trace file count for uccxengine is set to 300

Enables the specified logging level for the sub-component in the component mentioned in the command. The user can enter multiple levels of logging by separating them by commas.

After the completion of the command, a message is displayed showing the current log trace settings enabled.

Restart the Unified CCX services for the trace changes to take effect.

Command syntax

set uccx trace enable [component] [sub-component] [level]

Options

component—(Mandatory) The component such as UCCXEngine or UCCXEditor or JTAPI_CLIENT

sub-component—(Mandatory) The subcomponent within the component such as JTAPI Subsystem within the UCCXEngine component. For the JTAPI_CLIENT component, there are no sub-components.

sub-component—(Mandatory) The subcomponent within the component such as SS_SIP within the UCCXEngine component. For the SS_SIP component, there are no sub-components.

Level—(Mandatory) The logging level which will be enabled. Tracing levels are Debugging, XDebugging1, XDebugging2, XDebugging2, XDebugging3, XDebugging4 and XDebugging5. For the JTAPI_CLIENT, the tracing levels are Warning, Informational, Debug, Jtapi_Debug, JtapiImpl_Debug, Cti_Debug, CtiImpl_Debug, Protocol_Debug and Misc_Debug.

Level—(Mandatory) The logging level which will be enabled. Tracing levels are Debugging, XDebugging1, XDebugging2, XDebugging2, XDebugging3, XDebugging4 and XDebugging5.

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example 1

admin:set uccx trace enable uccxengine SS_VB debugging
 Trace for uccxengine:SS_VB:debugging is enabled.
 Command successful.

Example 2

admin:set uccx trace enable UCCXengine SS_SIP XDEBUGGING1,XDEBUGGING2
Trace for uccxengine:SS_SIP:XDEBUGGING1 is enabled
Trace for uccxengine:SS_SIP:XDEBUGGING2 is enabled
Command successful.

Disables the specified logging level for the subcomponent in the component mentioned in the command. The user can enter multiple levels of logging by separating them by commas. You cannot use this command to turn off Alarm tracing.

After the completion of the command, a message is displayed showing the current log trace settings enabled.

Restart the Unified CCX services for the trace changes to take effect.

Command syntax

set uccx trace disable [component] [sub-component] [level]

Options

Component—The component such as UCCXEngine or UCCXEditor or JTAPI_CLIENT.

Sub-component—The subcomponent within the component such as JTAPI Subsystem within the UCCXEngine component. For the JTAPI_CLIENT component, there are no subcomponents.

Sub-component—The subcomponent within the component such as SS_SIP within the UCCXEngine component.

Level—(Mandatory) The logging level which will be disabled. Tracing levels are Debugging, XDebugging1, XDebugging2, XDebugging2, XDebugging3, XDebugging4 and XDebugging5. The tracing levels will also be available as part of the help of the command.

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example 1

admin:set uccx trace disable uccxengine SS_VB debugging
 Trace for uccxengine:SS_VB:debugging is disabled.
 Command successful.

Example 2

set uccx trace disable UCCXEngine SS_SIP XDEBUGGING1,XDEBUGGING2
Trace for uccxengine:SS_SIP:XDEBUGGING1 is disabled
Trace for uccxengine:SS_SIP:XDEBUGGING2 is disabled
Command successful.

This command changes the security/SFTP password on Unified CCX. In addition to changing the security password, it also changes the passwords of the internal Unified CCX users.

Command syntax

set password user security

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set password user security   
Please enter the old password: ******
Please enter the new password: ******
Reenter new password to confirm: ******
WARNING:
Please make sure that the security password on the publisher is changed first.
The security password needs to be the same on all cluster nodes,
including the application server, therefore the security password on all nodes
need to be changed.

After changing the security password on a cluster node, please restart that node.

Continue (y/n)?y

Please wait...

Command successful.

This command allows you to configure the minimum TLS version in the server that can be used for inbound SSL connections. You must restart the system for the changes to take effect.

Note	In a high availability (HA) deployment, run this CLI command on both the nodes of the cluster. Restart both the nodes after executing the CLI command.

Command syntax

set tls server min-version [tls server minVersion]

Options

tls server minVersion—Refers to 1.2 (TLS Version 1.2)

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set tls server min-version 1.2
**WARNING** If you are lowering the TLS version it can lead to security issues **WARNING**
Do you really want to continue (yes/no) ? yes
Execute this command in the other nodes of the cluster.
Restart the system using the command 'utils system restart' for the changes to take effect
Command successful

This command allows you to configure the minimum TLS version in the client that can be used for outbound SSL connections. You must restart the system for the changes to take effect.

Note	In a high availability (HA) deployment, run this CLI command on both the nodes of the cluster. Restart both the nodes after executing the CLI command.

Command syntax

set tls client min-version [tls client minVersion]

Options

tls client minVersion—Refers to 1.2 (TLS Version 1.2)

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set tls client min-version 1.2
**WARNING** If you are lowering the TLS version it can lead to security issues **WARNING**
Do you really want to continue (yes/no) ? yes
Execute this command in the other nodes of the cluster.
Restart the system using the command 'utils system restart' for the changes to take effect
Command successful

This command sets the Unified CCX AXL provider IP address. Use this command only when the IP address of Unified Communications Manager has been changed and Unified CCX is being pointed to the new IP address.

Note	After you run this command, restart the Unified CCX Engine service. After Unified CCX Engine service starts successfully, restart Cisco Tomcat using the CLI command utils service restart Cisco Tomcat.

Command syntax

set uccx provider ip axl [ip-address]

Arguments

[ip-address]—The IP address of the AXL provider.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: No

Example

admin: set uccx provider ip axl 10.78.14.140
Cisco Unified Communications Manager IP is set to 10.78.14.140

Command Successful.

This command sets the Unified CCX JTAPI provider IP address. Use this command only when the IP address of Unified Communication Manager has been changed and Unified CCX is being pointed to the new IP address.

Note	After you run this command, restart the Unified CCX Engine service. After Unified CCX Engine service starts successfully, restart Cisco Tomcat using the CLI command utils service restart Cisco Tomcat.

Command syntax

set uccx provider ip jtapi [ip-address]

Arguments

[ip-address]—The IP address of the JTAPI provider.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: No

Example

admin: set uccx provider ip jtapi 10.78.14.140
UCCX JTAPI Provider is set to 10.78.14.140

Command Successful.

This command sets the Unified CCX Resource Manager-Contact Manager provider IP address. Use this command only when the IP address of Unified Communications Manager has been changed and Unified CCX is being pointed to the new IP address.

Note	After you run this command, restart the Unified CCX Engine service. After Unified CCX Engine service starts successfully, restart Cisco Tomcat using the CLI command utils service restart Cisco Tomcat.

Command syntax

set uccx provider ip rmcm [ip-address]

Arguments

[ip-address]—The IP address of the RMCM provider.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: No

Example

admin: set uccx provider ip rmcm 10.78.14.140
UCCX RMCM Provider is set to 10.78.14.140

Command Successful.

Administrator capability can be added to a user in Unified Communications Manager using this command.

Note	Run this command to set the administrator for a configured Unified CCX system only. For a newly installed system, you must login with the platform login password that you specified during installation.

Command syntax

set uccx appadmin administrator [username]

Options

[username]—Username is set as the Cisco Unified CCX application administration.

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set uccx appadmin administrator username
UCCX appadmin adminstrator is set to username

Note	You cannot assign Administrator capability to a user ID that is the same as the application administrator user ID that you created during the Unified CCX installation. If you assign Administrator capability to such a user ID, a "Command failed" error message is displayed on the console.

This command is used to set the authentication mode.

Command syntax

set authmode <non_sso>

Options

non_sso - to set authentication to Non-SSO mode.

Requirements

Level privilege: 4

Command privilege level: 4

Allowed during upgrade: No

Example

admin:set authmode non_sso

Executes an SQL "select" statement from the CLI. Read-only operations are permitted. Insert, Update, Delete and any DML statements are disallowed. This command allows queries to be run against the Unified CCX databases (data stores) and sysmaster database for the Unified CCX Informix instance (IDS engine).

Command syntax

run uccx sql database_name sql_query [options]

Arguments

database_name—(Mandatory) Database on which the SQL statement is run

sql_query—(Mandatory) The sql statement to run

Options

page—Displays the output one page at a time

file—Stores the output to a file instead of showing it on the console. The name of the file is displayed after the completion of the command.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: No

Example

admin:run uccx sql db_cra select resourceid,resourcename from resource
RESOURCEID      RESOURCENAME
-----------------------
1        b
2        agent22
3        sacagent3
4        sacagent1
7        user
8        sacagent2
9       user agent2
10      user rtlite1
11       agent130
14       sk1
15       sk2
24      User RT Pro

Executes a stored procedure that is specified as a parameter on the database, which is also mentioned as a parameter. This command runs only a stored procedure.

Command Syntax

run uccx sp database_name sp_name [options]

Arguments

database_name—(Mandatory) Database on which the stored procedure is run

sp_name—(Mandatory) The stored procedure to be run

Options

page—Displays the output one page at a time

file—Stores the output to a file instead of showing it on the console. The name of the file is displayed after the completion of the command.

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: No

Example

admin:run uccx sp db_cra sp_email_contact_detail('2016-12-06 18:30:00','2016-12-07 18:29:59','testemailcsq1','FinesseAgent1','')
CONTACT_ID      SEQUENCE_NUMBER CSQ_NAME        AGENT_NAME      RECEIVED        RETRIEVED       REPLIED DISCARDED       FROM_ADDRESS    REPLY_TO_ADDRESS        TO_ADDRESS      SUBJECT CONTACT_TYPE CONTACT_DISPOSITION     EMAIL_REPLY_TO  EMAIL_REPLY_CC  EMAIL_REPLY_BCC
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

 D82AC14C1000015800000EFF0A4E5D8A        0       testemailcsq1   FinesseAgent1   2016-12-07 07:22:49.0   2016-12-07 07:59:45.051 2016-12-07 08:00:47.06  null    reboottest2@sky13.sm   "RebootTestUser2 Reboot." <reboottest2@sky13.sm>    reboottest1@sky13.sm   test    1       2       reboottest2@sky13.sm,reboottest1@sky13.sm

 Command successful.

This command allows you to enable, disable, and check the status of debug logging for Cisco Unified CCX Notification Service.

By default, debug logging is disabled for Cisco Unified CCX Notification Service. Enable debug logging for Cisco Unified CCX Notification Service when there is an issue in the system related to this service and when you require detailed logs for troubleshooting. After the troubleshooting is complete, disable logging for Cisco Unified CCX Notification Service.

You can retrieve the logs from the log-collection facility provided by Cisco Unified Real-Time Monitoring Tool.

You can execute utils uccx notification-service log only if Cisco Unified CCX Notification Service is running. If the service is not running, start the service first and then execute the command.

Note	Logging for Cisco Unified CCX Notification Service affects system performance; therefore, disable logging when it is not required. Logging is disabled automatically when you restart Cisco Unified CCX Notification Service.

Command syntax

utils uccx notification-service log enable

utils uccx notification-service log disable

utils uccx notification-service log status

Arguments

None

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Examples

Check status of logging

admin:utils uccx notification-service log status

Cisco Unified CCX Notification Service logging is currently DISABLED.

Enable logging

admin:utils uccx notification-service log enable

WARNING! Enabling Cisco Unified CCX Notification Service logging can affect system performance and should be disabled when logging is not required.

Do you want to proceed (yes/no)?
Cisco Unified CCX Notification Service logging enabled successfully.

NOTE: Logging will be disabled automatically if Cisco Unified CCX Notification Service is restarted.

admin:utils uccx notification-service log disable

Cisco Unified CCX Notification Service logging disabled successfully.

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 days, the account expires.

Usage Guidelines

A remote account generates a pass phrase that allows Cisco support personnel to access 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
Remote Support
Status         : disabled
Decode Version : 2

Caution

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

This command resets the application user interface administrator name for Serviceability, CUIC Admin property, and CUIC Administrator.

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.

admin:utils reset_application_ui_administrator_name

-------------------- utils reset_ui_administrator_name --------------------


Reset user interface administrator user name

New administrator user name:

User_1
Serviceability Administrator user name has been successfully updated to User_1

CUIC Admin property has been successfully updated to User_1

CUIC Administrator user name has been successfully updated to User_1

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

Example

admin:utils reset_application_ui_administrator_password
New password:********
Confirm new Password:********

This command allows start, stop, activate, deactivate, list, auto-restart and restart of the following services:

• System SSH

• Service Manager

• Entropy Monitoring Daemon

• Cisco SCSI Watchdog

• A Cisco DB

• A Cisco DB Replicator

• Cisco AMC Service

• Cisco Audit Event Service

• Cisco CDP

• Cisco CDP Agent

• Cisco CallManager Serviceability

• Cisco Certificate Change Notification

• Cisco Certificate Expiry Monitor

• Cisco Cloud Connect Container Manager

• Cisco Database Layer Monitor

• Cisco DRF Local

• Cisco DRF Master

• Cisco Finesse Tomcat

• Cisco Identity Service

• Cisco Log Partition Monitoring Tool

• Cisco RIS Data Collector

• Cisco RTMT Reporter Servlet

• Cisco Syslog Agent

• Cisco Tomcat

• Cisco Tomcat Stats Servlet

• Cisco Trace Collection Service

• Cisco Trace Collection Servlet

• Cisco Unified Serviceability RTMT

• Cisco Finesse Tomcat

• Cisco Unified CCX Administration

• Cisco Unified CCX CVD Dependent Webapp

• Cisco Unified CCX Cluster View Daemon

• Cisco Unified CCX Configuration API

• Cisco Unified CCX DB Perfmon Counter Service

• Cisco Unified CCX Database

• Cisco Unified CCX Engine

• Cisco Unified CCX Notification Service

• Cisco Unified CCX Perfmon Counter Service

• Cisco Unified CCX SNMP Java Adapter

• Cisco Unified CCX Serviceability

• Cisco Unified CCX Socket.IO Service

• Cisco Unified CCX Voice Subagent

• Cisco Unified CCX WebServices

• Cisco Unified Intelligence Center Reporting Service

• Cisco Unified Intelligence Center Serviceability Service

• Cisco Unified Serviceability RTMT

• Cisco Web Proxy Service

• Docker Engine

• Host Resources Agent

• MIB2 Agent

• Platform Administrative Web Service

• Platform Communication Web Service

• SNMP Master Agent

• SOAP -Log Collection APIs

• SOAP -Performance Monitoring APIs

• SOAP -Real-Time Service APIs

• System Application Agent

• Cisco DirSync

• Cisco Serviceability Reporter

Command syntax

utils service [option] [service-name]

Arguments

option—The option to {start | stop | activate | deactivate | list | auto-restart | restart} a service.

service-name—The name of the service.

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:utils service start Cisco Unified CCX Administration 
Service Manager is running
Cisco Unified CCX Administration[STARTING]  
Cisco Unified CCX Administration[STARTING]  
Cisco Unified CCX Administration[STARTED]  
Cisco Unified CCX Administration[STARTED]  

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

Command syntax

utils system upgrade [Options]

Options

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.

status—Displays status of the upgrade

cancel—Stops the upgrade process

Example

admin:utils system upgrade initiate

Warning: Do not close this window without first canceling the upgrade.

Source:

 1) Remote Filesystem via SFTP
 2) Remote Filesystem via FTP
 3) Local DVD/CD
 q) quit

Please select an option (1 - 3 or "q" ):

This command restarts and switches the system to the Unified CCX product release that is installed on the inactive partition.

Command syntax

utils system switch-version

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 Unified CCX proceeds with the command execution. This command is applicable for the following scenarios:

• The system detects that a switch version is in progress.

• 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 performed on the Unified CCX system when the operation is in progress. Example admin:utils system switch-version ** There is no inactive side available **

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

Command Syntax

utils uccx database dbserver integrity

Requirements

Level privilege: 0

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:utils uccx database dbserver integrity
 This operation may take a few minutes to complete. Please wait...

 Output is in file: uccx/cli/DbServerIntegrity_1372844998930.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_1372845048816.txt
 Use "file view activelog  uccx/cli/DbConfigIntegrity_1372845048816.txt" command to see output
 Command successful.

Note

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

This command lists the licenses that are uploaded into the uccx system.

Note	This command is not applicable when you are using Smart Licensing.

Command syntax

utils uccx list license

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:utils uccx list license
The following licenses are uploaded in the system:
ccx90_pre_demo.lic
UCCXLicense.lic
ccx100_premium_300seat_allfeatures_dummy.lic
ccx90_enh_demo.lic
ccx_10.5-300_Seat_DummyLicense.lic
 Command successful.

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. 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 is deleted from the Unified CCX system

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:utils uccx delete license ccx10_premium_300seat.lic
Warning:
Deleting the license may have adverse effect on the working of the uccx system.
After deleting the license from all UCCX nodes, restart the UCCX nodes in the cluster.
Are you sure you want to run this command?
Continue (y/n)?n
Exiting the command.
Command successful.

This command updates the JTAPI Client version on the active partition on the Unified CCX box to match JTAPI version on the Unified Communications Manager. This command downloads the JTAPI Client from the Unified Communications Manager and checks whether the downloaded version needs to be installed. If the downloaded version needs to be installed, it installs the downloaded JTAPI Client and displays 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 displays a message saying the same and displays the current JTAPI Client version.

The JTAPI client update occurs 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.

Command syntax

utils uccx jtapi_client update

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.

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

Note	You must use this command when there are common classes being used in the custom code as well as by Unified CCX and there is a version mismatch between the common classes that are being used.

Caution

You must add the custom classpath only if the Custom class files have a newer version than the class files used by Unified CCX. 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—Custom jar filename to be prepended to classpath

Example

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

This command allows you to check whether the database was corrupted after an unsuccessful switch version due to a restart in the middle of a switch version attempt. The command displays the status of last switch version. If there is a database backup available that can be restored, it prints the time stamp 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

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

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.

This command first checks whether the database was corrupted after an unsuccessful switch version due to the restart in the middle of a switch version attempt. The command displays the status of the last switch version. If there is a database backup available that can be restored, it prints the time stamp of the backup and offer an option to restore the database from this backup. If the restore option is chosen, the command completes after restoring the database from this backup and bringing up all the services.

Command Syntax

utils uccx switch-version db-recover

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

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

Command syntax

utils uccx syncusers

Example

admin:utils uccx syncusers
Command successful.

This command allows you to view the current configuration parameter values for the Caller ID (CLID) feature.

Command syntax

utils uccx icd clid status

Example

admin:utils uccx icd clid status
CLID Feature: Disabled
CLID Text Header: Caller Details
CLID Text Prefix: Calling Party Number :

This command allows you to enable the CLID feature.

Restart the Unified CCX Engine service for the changes to take effect.

In HA deployments, run this command separately on both the Unified CCX nodes.

After upgrade, run this command again to enable the CLID feature.

Command syntax

utils uccx icd clid enable

Example

admin:utils uccx icd clid enable
Successfully enabled the CLID feature
Please restart the "Cisco Unified CCX Engine" service for changes 
to take effect
In case of Cisco Unified CCX HA cluster, enable the CLID feature in 
remote node as well by running the CLI command 
"utils uccx icd clid enable" on the remote node

This command allows you to disable the CLID feature.

Restart the Unified CCX Engine service for the changes to take effect.

In HA deployments, run this command separately on both the Unified CCX nodes.

After upgrade, run this command again to disable the CLID feature.

Command syntax

utils uccx icd clid disable

Example

admin:utils uccx icd clid disable
Successfully disabled the CLID feature
Please restart the "Cisco Unified CCX Engine" service for changes
to take effect
In case of Cisco Unified CCX HA cluster, disable the CLID feature in 
remote node as well by running the CLI command 
"utils uccx icd clid disable" on the remote node

This command allows you to set the display header on the phone screen.

Restart the Unified CCX Engine service for the changes to take effect.

In HA deployments, run this command separately on both the Unified CCX nodes.

After upgrade, run this command again to set the values for the display header.

If the header string has space, enclose the entire string in double quotes.

You can set the header string to "" if you do not want to provide any values.

Command syntax

utils uccx icd clid header <header string>

Example

admin:utils uccx icd clid header "Caller Details"
Successfully set the CLID text header to "Caller Details"
Please restart the "Cisco Unified CCX Engine" service for changes
to take effect
In case of Cisco Unified CCX HA cluster, set the CLID text header in 
remote node as well by running the CLI command 
"utils uccx icd clid header <header string>" on the remote node

This command allows you to set the prefix string for the calling party number displayed on the phone screen.

Restart the Unified CCX Engine service for the changes to take effect.

In HA deployments, run this command separately on both the Unified CCX nodes.

After upgrade, run this command again to set the values for the prefix string.

If the prefix string has space, enclose the entire string in double quotes.

You can set the prefix string to "" if you do not want to provide any values.

Command syntax

utils uccx icd clid prefix <prefix string>

Example

admin:utils uccx icd clid prefix "Calling Party Number : "
Successfully set the CLID text prefix to "Caller Party Number: "
Please restart the "Cisco Unified CCX Engine" service for changes
to take effect
In case of Cisco Unified CCX HA cluster, set the CLID text prefix in 
remote node as well by running the CLI command 
"utils uccx icd clid prefix <prefix string>" on the remote node

Run this command to enable Unified CCX administration security filter settings.

In HA deployments, run this command separately on both the Unified CCX nodes.

Command syntax

utils uccx security_filter enable

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:utils uccx security_filter enable
The status of security filter is: enabled
Please restart Unified CCX service using 
'utils service restart Cisco Tomcat' for changes to take effect.
In case of Cisco Unified CCX HA cluster, set the security filter in
remote node as well.

Run this command to disable Unified CCX administration security filter settings.

In HA deployments, run this command separately on both the Unified CCX nodes.

Command syntax

utils uccx security_filter disable

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:utils uccx security_filter disable
The status of security filter is: disabled
Please restart Unified CCX service using 
'utils service restart Cisco Tomcat' for changes to take effect.
In case of Cisco Unified CCX HA cluster, set the security filter in
remote node as well.

Run this command to check the status of Unified CCX administration security filter flag.

Command syntax

utils uccx security_filter status

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

admin:utils uccx security_filter status
uccx security filter is :enabled

Run this command to append the data of dbreplication configuration files to a text file. This command is only available in the High Availability deployment of Unified CCX.

Command syntax

utils uccx dbreplication dump configfiles

Requirements

Level privilege: 1

Command privilege level: 0

Allowed during upgrade: No

Example

admin:utils uccx dbreplication dump configfiles 
Command Started
Output is in file: DbConfigFiles_120813161827.txt
Use "file view activelog uccx/cli/DbConfigFiles_120813161827.txt" command to view the file
Use "file get activelog uccx/cli/DbConfigFiles_120813161827.txt" command to get the file 
Command Successful

This command runs the database health check script, which checks the health of the Unified CCX database.

After the execution of this command, a health check report is generated. If any issues are found by this script then they are recorded in the health check report. A solution file is also generated that consists of suggested solutions for the problems reported in the health check report file.

Command syntax

utils uccx database healthcheck

Requirements

Level privilege: 1

Command privilege level: 0

Allowed during upgrade: No

Example

admin:utils uccx database healthcheck 
Command Started
This command may take few minutes to complete
UCCX database health report is available at: /var/log/active/uccx/cli/healthcheck.rpt
UCCX database health report suggested solutions is available at: /var/log/active/uccx/cli/healthcheck.soln
Use "file view activelog uccx/cli/healthcheck.rpt" command to view the file
Use "file get activelog uccx/cli/healthcheck.rpt" command to get the file
Use "file view activelog uccx/cli/healthcheck.soln" command to view the file
Use "file get activelog uccx/cli/healthcheck.soln" command to get the file
Command Successful

Run this command to monitor the CPU and database utilization on the Unified CCX server.

After this command is executed, a successful execution message appears on the screen. This command runs in the background for the total duration specified in the command at periodic intervals and generates a file, which consists of the details related to CPU and database utilization.

Command syntax

utils uccx database dbperf start totalHours interval

Arguments

• Interval— Period of time between the execution / operation.

• TotalHours—Total duration of the execution.

Requirements

Level privilege: 1

Command privilege level: 0

Allowed during upgrade: No

Example

admin: utils uccx database dbperf start 10 20
The script runs every 20 minutes over a total duration of 10 hours.
Please collect files after 10 hours
Use "file get activelog uccx/cli/dbperf_250913131546.log" to get the file
Use "file view activelog uccx/cli/dbperf_250913131546.log" to view the file
Command Successful

Run this command to stop the current active instance of utils uccx database dbperf start before it runs to completion.

Command syntax

utils uccx database dbperf stop

Requirements

Level privilege: 1

Command privilege level: 0

Allowed during upgrade: No

Example

admin:utils uccx database dbperf stop
Execution of dbperf has been stopped
Command Successful

Run this command to perform checks on the Unified CCX system to ensure that the potential issues are detected at an early stage. When you execute this command, you are prompted to enter the category on which health check must be performed. For example, you can select to check the Unified CCX system hardware usage to detect if it is within the threshold limit and return the health check status. A report can be generated with all the plug-in details.

Note	If you execute utils uccx healthcheck all, you are not prompted to select the category. This command will execute health check on all the categories.

Command Syntax

utils uccx healthcheck

Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: Yes

This section provides information on the Unified CCX system hardware usage. Plug-ins of this category checks and provides the Unified CCX system CPU usage, memory usage, disk space usage, and disk I/O latency status. If the hardware usage exceeds the threshold limit, then the system will display the appropriate status message.

For example, if the CPU usage in the last ten minutes is within the threshold limit, an OK state is displayed. If the CPU usage in the last ten minutes exceeded the threshold limit, a Not OK state is displayed with the appropriate message.

The following table lists the available plug-ins, their threshold limits and the message displayed when the threshold limit is exceeded.

Example

admin:utils uccx healthcheck
Healthcheck is available for the following categories:
1) Hardware Usage
2) System Parameters
3) Database
4) Unified CM Configurations
q) Quit
Select an option (1 - 4 or "q"):1
       Checking CPU Usage.................................................OK
       Checking Memory Usage..............................................OK
       Checking Disk Usage................................................OK  
       Checking Disk I/O Latency......................................Not OK
              Disk I/O exceeded the premissible limit.
Use 'file get activelog healthcheck/report_2019-11-11-09-40-04.json' command to 
download the health report.
Command Successful.

The following plug-ins check the various configuration limits in the Unified CCX system:

• Configured Agents

• Configured Agents per Team

• Configured CSQs

• Configured Skills per Agent

• Configured Outbound Campaigns

• Configured Supervisors per Team

• Configured Teams per Supervisor

• Configured Contacts per Outbound Campaign

• Configured Contact Service Queues

• Configured Skills

• Configured Skills per CSQ

For more information on team configuration limits, see Server Capacities and Limits section in the Solution Design Guide for Cisco Unified Contact Center Express.

admin:utils uccx healthcheck
Healthcheck is available for the following categories:
1) Hardware Usage
2) System Parameters
3) Database
4) Unified CM Configurations
q) Quit
Select an option (1 - 4 or "q"):3
       Checking CCX DB Status.......................................OK
       Checking CCX DB Replication Status.................................OK
       Checking CCX DB Space Usage....................................Not OK
       Reason:DB space usage has exceeded the threshold limit of 75% for the 
       following:db_hist and db_cra_repository
       Checking CCX Config DB tables consistency in HA................Not OK
       Reason:DB table(s) out of sync:Skill
              ID in configseed table out of sync:Crsuser
       Checking the number of Wallboard/External Clients..............Not OK
       Reason:Found 3(allowed:1)wallboard/external clients.
Use 'file get activelog healthcheck/report_2019-11-11-09-40-04.json' command to
download the health report.
Command Successful.

admin:utils uccx healthcheck
Healthcheck is available for the following categories:
1) Hardware Usage
2) System Parameters
3) Database
4) Unified CM Configurations
q) Quit
Select an option (1 - 4 or "q"):4
       Checking AXL Configuration  .......................................OK
       Checking Telephony Provider (JTAPI) Configuration..................OK
       Checking RmCm Provider Configuration...........................Not OK
       Reason:The configured RmCm Provider is not assigned with the following
       roles in Unified CM: Standard CTI Allow Call Recording
       Checking CCX Config DB tables consistency in HA................Not OK
Use 'file get activelog healthcheck/report_2019-11-11-09-40-04.json' command 
to download the health report.
Command Successful.

This command enables, disables, or displays the status of FIPS 140-2 mode. By default, FIPS 140-2 mode is disabled.

utils fips {enable | disable| status}

For using FIPS 140-2 mode, consider the following points:

Note	FIPS 140-2 mode is supported only on releases that have been through FIPS compliance.

• In a HA setup, FIPS 140-2 mode must be first enabled or disabled on the publisher and then on the subscriber. Before enabling or disabling FIPS 140-2 mode on the subscriber, ensure that all the services are running on the publisher.

• Ensure that SRTP is disabled before enabling or disabling FIPS 140-2 mode in Unified CCX. You can enable SRTP after enabling or disabling FIPS 140-2 mode in Unified CCX.

• When FIPS 140-2 mode is enabled or disabled, the keys and certificates are regenerated, and the Unified CCX server reboots. While rebooting, the system performs the cryptographic modules integrity check, and runs certification self-tests.

• After the FIPS 140-2 mode setting is enabled or disabled, the system reboots automatically. To bring the Live Data datasource online, perform the following:

  • Open the tomcat-trust certificate in Cisco Unified Operating System Administration

  • Restart the Cisco Unified Intelligence Center Reporting Service

Caution

Back up the system before and after enabling FIPS 140-2 mode. If any of the startup self-tests fail, the Unified CCX server halts. Restart the Unified CCX server. If the startup self-test error persists, it indicates that there is a critical problem in the FIPS module and the only option is to use a recovery CD.