Escolar Documentos
Profissional Documentos
Cultura Documentos
5(1)
For Cisco Unified Contact Center Express and Cisco Unified IP IVR Release 8.5(1)
This document describes the Unified CCX Command Line Interface (CLI) commands that are available for the Cisco Unified Communications Operating System. For detailed information on CLI commands available exclusively for the Cisco Unified Communications Operating System, refer to Command Line Interface Reference Guide for Cisco Unified Communications Solutions available here: http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html
Contents
This document comprises the following sections:
Starting a CLI Session, page 2 CLI Basics, page 2 CLI Commands Unavailable for Unified CCX, page 5 Show Commands, page 7 Set Commands, page 24 Run Commands, page 31 Utils Commands, page 32 File Commands, page 37 High Availability Commands, page 41 CAD and CSD Commands, page 48 Obtain Additional Support and Documentation, page 58
Americas Headquarters: Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA
From a SSH-enabled client workstation, you can use SSH to connect securely to the Cisco Unified Contact Center Express. You can access the Cisco Unified Contact Center Express CLI directly by using the monitor and keyboard that you used during installation or by using a terminal server that is connected to the serial port. Use this method if a problem exists with the IP address.
Ensure you have the following information that gets defined during installation:
You will need this information to log in to the Cisco IPT Platform. Perform the following steps to start a CLI session:
Step 1
From a remote system, use SSH to connect securely to the Cisco IPT Platform. In your SSH client, enter ssh adminname@hostname where adminname specifies the Administrator ID and hostname specifies the hostname that was defined during installation. For example, ssh admin@ipt-1. From a direct connection, you receive this prompt automatically:
ipt-1 login:
where ipt-1 represents the host name of the system. Enter your administrator ID. In either case, the system prompts you for a password.
Step 2
Enter your password. The CLI prompt displays. The prompt represents the Administrator ID; for example:
admin:
CLI Basics
The following section contains basic tips for using the command line interface.
Completing Commands, page 3 Getting Help on Commands, page 3 Exiting a Command with the Ctrl-C Key Sequence, page 4 Ending a CLI Session, page 4
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
CLI Basics
Completing Commands
To complete commands, use Tab:
Enter the start of a command and press Tab to complete the command. For example, if you enter se and press Tab, set gets completed. Enter a full command name and press Tab to display all the commands or sub-commands that are available. For example, if you enter set and press Tab, you see all the set sub-commands. An * identifies the commands that have sub-commands. If you reach a command, keep pressing Tab, and the current command line repeats; this indicates that no additional expansion is available.
Detailed help that includes a definition of the command and an example of its use Short query help that includes only command syntax
Procedure
To get detailed help, at the CLI prompt, enter help command Where command specifies the command name or the command and parameter. See Example 1-1.
Note
If you enter the help command without specifying the name of a particular command as the optional parameter, the system provides information about the CLI system. To query only command syntax, at the CLI prompt, enter command? Where command represents the command name or the command and parameter. See Example 1-2.
Note
If you enter a ? after a menu command, such as set, it acts like the Tab key and lists the commands that are available.
Example 1-1
admin:help file list activelog activelog help: This will list active logging files options are: page - pause output detail - show detailed listing
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
CLI Basics
reverse - reverse sort order date - sort by date size - sort by size file-spec can contain '*' as wildcards Example: admin:file list activelog 02 Dec,2004 12:00:59 02 Dec,2004 12:00:59 16 Nov,2004 21:45:43 27 Oct,2004 11:54:33 dir count = 2, file count
Example 1-2
Query Example:
admin:file list activelog? Syntax: file list activelog file-spec [options] file-spec mandatory file to view options optional page|detail|reverse|[date|size]
admin:utils system upgrade initiate Warning: Do not close this window without first exiting the upgrade command. Source: 1) Remote Filesystem 2) DVD/CD q) quit Please select an option (1 - 2 or "q"): Exiting upgrade command. Please wait... Control-C pressed admin:
Note
If you execute the command utils system switch-version and enter Yes to start the process, entering Ctrl-C exits the command but does not stop the switch-version process.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
set network ipv6 static_address show network ipv6 settings show tech ccm_services
Note
For detailed information on all the CLI commands available for the Cisco Unified Communications Operating System, refer to Command Line Interface Reference Guide for Cisco Unified Communications Solutions available here: http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html
Conventions
This document uses the following conventions: Convention boldface font italic font [ ] {x|y|z} [x|y|z] string
screen
Description Commands and keywords are in boldface. Arguments for which you supply values are in italics. Elements in square brackets are optional. Alternative keywords are grouped in braces and separated by vertical bars. Optional alternative keywords are grouped in brackets and separated by vertical bars. A non-quoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
font font
Terminal sessions and information the system displays are in screen font. Information you must enter is in boldface screen font. Arguments for which you supply values are in italic screen font. This pointer highlights an important line of text in an example. The symbol ^ represents the key labeled Controlfor example, the key combination ^D in a screen display means hold down the Control key while you press the D key. Non-printing characters, such as passwords, are in angle brackets.
boldface screen
< >
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
Conventions
Note
Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication. Timesavers use the following conventions:
Timesaver
Means the described action saves time. You can save time by performing the action described in the paragraph. Tips use the following conventions:
Tip
Means the information contains useful tips. Cautions use the following conventions:
Caution
Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data. Warnings use the following conventions:
Warning
This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents.
The following sections list and describe the CLI commands that are available for the Cisco Unified Contact Center Express.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
Show Commands
Show Commands
This section contains descriptions of the following commands:
show uccx version, page 7 show uccx jtapi_client version, page 8 show uccx components, page 8 show uccx subcomponents, page 9 show uccx license, page 9 show uccx trace levels, page 10 show uccx provider ip axl, page 11 show uccx provider ip jtapi, page 11 show uccx provider ip rmcm, page 11 show uccx trace file size component size, page 12 show uccx trace file count component no-of-files, page 12 show uccx tech dbserver all, page 13 show uccx tech dbserver log diagnostic, page 13 show uccx tech dbserver status, page 14 show uccx dbcontents, page 14 show uccx dbschema, page 15 show uccx dbtable list, page 16 show uccx dbtable schema, page 16 show uccx dbserver disk, page 17 show uccx dbserver sessions all, page 18 show uccx dbserver session, page 19 show uccx dbserver sessions list, page 20 show uccx dbserver user list, page 21 show uccx dbserver user waiting, page 22 show uccx tech dbserver log message, page 23 show uccx dbtable contents, page 23
Level privilege: 0
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
Show Commands
NA
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
Show Commands
component(mandatory) The component such as UCCXEngine or UCCXEditor. pageDisplays the output one page at a time
Requirements
NA
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
Show Commands
Configured Licenses: Package: Cisco Unified CCX Premium IVR Port(s): 150 Cisco Unified CCX Premium Seat(s): 400 High Availability: Enabled Cisco Unified CCX Preview Outbound Dialer: Enabled Cisco Unified CCX Maximum Agents: 300 Command successful.
ComponentDisplays the various trace levels of all the sub-components of this component. Sub-componentDisplays the various trace levels of this sub-component for the specified component. This can be specified only if the component was specified. pagedisplays the output one page at a time filestores the output to a file instead of showing it on the console. The name of the file will be displayed after the completion of the command.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
10
Show Commands
Level privilege: 0
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
11
Show Commands
Requirements
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
12
Show Commands
Example
admin: show uccx trace file count UCCXEngine Trace file count for UCCXEngine is 300. Command Successful.
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 file name are displayed upon completion.
Requirements
NA
Options
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
13
Show Commands
Requirements
Note
The name of the file is automatically generated by the command script. The file path and file name are displayed upon completion.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
14
Show Commands
Command Syntax
Requirements
Note
The name of the file containing the schema is automatically generated by the command script. The file path and file name are displayed upon completion.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
15
Show Commands
Options
Requirements
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
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
16
Show Commands
Options
Requirements
page - displays the output one page at a time file - outputs the information to a txt file. The file name will be generated dynamically at runtime and the file name and path will be displayed to user after the completion of the operation.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
17
Show Commands
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
page - displays the output one page at a time file - outputs the information to a txt file. The file name will be generated dynamically at runtime and the file name and path will be displayed to user after the completion of the operation.
Requirements
pid 6750
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 overhead free 0 used 3296 name scb free 0 used 96
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
18
Show Commands
opentable
6456
filetable
1088
sqscb info scb sqscb optofc 52fda4d0 53234018 0 Sess Id 27 SQL Stmt type -
pdqpriority sqlstats optcompind 0 0 0 Iso Lock Lvl Mode CR Wait 30 SQL ERR 0
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
Options
page - displays the output one page at a time file - outputs the information to a txt file. The file name will be generated dynamically at runtime and the file name and path will be displayed to user after the completion of the operation.
Requirements
netnorm
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
19
Show Commands
58 58*O0 name overhead opentable ru temprec ralloc ostcb sql hashfiletab sqtcb GenPg
V V free 0 0 0 0 0 0 0 0 0 0
4caa9028 122880 4c9d0028 4096 used 3360 8344 464 21600 5120 2600 40 280 7464 592
17064 2416
332 1
18 1 free 0 0 0 0 0 0 0 0 0 0 used 96 1104 16512 1392 1240 29384 848 1552 368 5136
name scb filetable log keys gentcb sqscb rdahead osenv fragman udr
sqscb info scb sqscb optofc 4c907018 4cc92018 1 Sess Id 58 SQL Stmt type -
pdqpriority sqlstats optcompind 0 0 2 Current Database db_cra Iso Lock Lvl Mode LC Not Wait
Explain 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.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
20
Show Commands
Example
admin:show uccx dbserver sessions list DATABASE USERNAME SESSION PROCESS ID ------------------ ------------ ------- ---------db_cra uccxcaduser 64 9395 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.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
21
Show Commands
sysmaster db_cra db_cra_repository sysmaster db_cra sysmaster db_cra db_cra sysmaster sysmaster Command successful.
uccxuser uccxuser uccxuser uccxuser uccxuser uccxuser uccxuser uccxuser uccxuser uccxuser
44 44 45 46 46 47 47 48 48 49
-1 -1 -1 -1 -1 -1 -1 -1 -1 -1
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
22
Show Commands
60
lines - optional; number of lines from message log that will be displayed. Defaults to 20.
Options
Requirements
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.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
23
Set Commands
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
Requirements
Set Commands
This section contains descriptions of the following commands:
set uccx trace defaults, page 24 set uccx trace file size component size, page 25 set uccx trace file count component no-of-files, page 25 set uccx trace enable component sub-component level, page 26 set uccx trace disable component sub-component level, page 27 set password user security, page 27 set uccx provider ip axl, page 28 set uccx provider ip jtapi, page 29 set uccx provider ip rmcm, page 29 set uccx appadmin administrator, page 30
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
24
Set Commands
Options
ComponentSets the default trace levels for all the sub-components of this component. The various components are UCCXEngine, UCCXCvd, UCCXAppAdmin, JTAPI_CLIENT. Sub-componentSets the default trace levels for this sub-component for the specified component. This can be specified only if the component was specified preceding it.
Requirements
componentMandatory; The component such as UCCXEngine or UCCXEditor. sizeMandatory; Specifies the file size in bytes
Requirements
componentMandatory; The component such as UCCXEngine or UCCXEditor. no-of-filesMandatory; Specifies the number of files after which older files will get overwritten.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
25
Set Commands
Requirements
componentMandatory; The component such as UCCXEngine or UCCXEditor or JTAPI_CLIENT sub-componentMandatory - The sub-component within the component such as JTAPI Subsystem within the UCCXEngine component. For the JTAPI_CLIENT component there are no sub-components. LevelMandatory - The logging level which will be enabled. Various tracing levels are Debugging, XDebugging1, XDebugging2, XDebugging2, XDebugging3, XDebugging4 and XDebugging5. For the JTAPI_CLIENT the various tracing levels are Warning, Informational, Debug, Jtapi_Debug, JtapiImpl_Debug, Cti_Debug, CtiImpl_Debug, Protocol_Debug and Misc_Debug.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
26
Set Commands
Command successful.
ComponentThe component such as UCCXEngine or UCCXEditor or JTAPI_CLIENT. Sub-componentThe sub-component within the component such as JTAPI Subsystem within the UCCXEngine component. For the JTAPI_CLIENT component there are no sub-components. LevelMandatory - The logging level which will be disabled. Various tracing levels are Debugging, XDebugging1, XDebugging2, XDebugging2, XDebugging3, XDebugging4 and XDebugging5. For the JTAPI_CLIENT the various tracing levels are Warning, Informational, Debug, Jtapi_Debug, JtapiImpl_Debug, Cti_Debug, CtiImpl_Debug, Protocol_Debug and Misc_Debug. The various tracing levels will also be available as part of the help of the command.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
27
Set Commands
Command Syntax
None
Requirements
Note
After you run this command, restart all the Unified CCX services. After Unified CCX services start successfully, restart Cisco Tomcat using the CLI command "utils service restart Cisco Tomcat". For more information on how ro restart the Unified CCX services, see the Cisco Unified CCX Serviceability Administration Guide available here: http://www.cisco.com/en/US/products/sw/custcosw/ps1846/products_installation_and_configuration_g uides_list.html
Command Syntax:
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
28
Set Commands
Requirements
Note
After you run this command, restart all the Unified CCX services. After Unified CCX services start successfully, restart Cisco Tomcat using the CLI command "utils service restart Cisco Tomcat". For more information on how ro restart the Unified CCX services, see the Cisco Unified CCX Serviceability Administration Guide available here: http://www.cisco.com/en/US/products/sw/custcosw/ps1846/products_installation_and_configuration_g uides_list.html
Command Syntax
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
29
Set Commands
Note
After you run this command, restart all the Unified CCX services. After Unified CCX services start successfully, restart Cisco Tomcat using the CLI command "utils service restart Cisco Tomcat". For more information on how ro restart the Unified CCX services, see the Cisco Unified CCX Serviceability Administration Guide available here: http://www.cisco.com/en/US/products/sw/custcosw/ps1846/products_installation_and_configuration_g uides_list.html
Command Syntax
Requirements
Note
Run this command to set the administrators for configured Cisco Unified CCX system only. For new install system, you must login with the platform login password specified during installation.
Command Syntax
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
30
Run Commands
Example
admin:set uccx appadmin administrator username UCCX appadmin adminstrator is set to username
Run Commands
This section contains descriptions of the following commands:
run uccx sql <database_name> <sql_query>, page 31 run uccx sp <database_name> <sp_name>, page 32
database_namemandatory; database on which the SQL statement will be run sql_querymandatory; the sql statement to run
Options
pagedisplays the output one page at a time filestores the output to a file instead of showing it on the console. The name of the file will be displayed after the completion of the command.
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
31
Utils Commands
14 15 24
database_namemandatory; database on which the stored procedure will be run sp_namemandatory; the stored procedure to be run
Options
pagedisplays the output one page at a time filestores the output to a file instead of showing it on the console. The name of the file will be displayed after the completion of the command.
Requirements
Utils Commands
This section contains descriptions of the following commands:
utils remote_account, page 33 utils service [list, start, stop, restart, auto-restart], page 33 utils uccx jtapi_client update, page 34 utils uccx database dbserver integrity, page 35
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
32
Utils Commands
utils system upgrade initiate, page 36 utils system switch-version, page 36 utils uccx prepend custom_classpath, page 36 utils uccx syncusers, page 37
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.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
33
Utils Commands
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
Command Syntax:
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
34
Utils Commands
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: http://www.cisco.com/en/US/products/sw/custcosw/ps1846/products_installation_and_configuration_g uides_list.html
Command Syntax
NA
Requirements
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
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
35
Utils Commands
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.
switch-version switches to the Unified CCX product release that is installed on the inactive partition.
Requirements
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.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
36
File Commands
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
Requirements
None
Requirements
File Commands
This section contains descriptions of the following commands:
file uccx view, page 38 file uccx list, page 38 file uccx get, page 39
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
37
File Commands
file uccx tail, page 39 file uccx delete, page 40 file uccx dump, page 41
Note
file-specmandatory; the file to view. The file-spec must resolve to a single file. file-spec can contain '*' as wildcards, providing it resolves to a single file
Options Requirements
Options
pagepause output detailshow detailed listing reversereverse sort order date sort by date size sort by size
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
38
File Commands
Requirements
Options
reltimerelative time to filter abstimeabsolute time to filter matchsearch pattern to filter recursobtain all the files located in file-spec and subdirectories compresstransfer files as compressed file
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
39
File Commands
Arguments
Options
hex,[num lines],regexp "expression" recent: to tail the most recently changed file in the directory.
Requirements
Tail file starting with the last 10 lines with pagination enabled:
admin:file 2005-08-03 2005-08-03 2005-08-03 2005-08-03 2005-08-03 2005-08-03 2005-08-03 2005-08-03 2005-08-03 uccx tail custom_file text.txt page 10 15:01:41,248 DEBUG [main] - cmdMVL size = 0 15:01:41,248 INFO [main] - adding command in level3 15:01:41,249 DEBUG [main] - begin for level4, topVL 15:01:41,250 DEBUG [main] - begin for level4, topVL 15:01:41,256 DEBUG [main] - begin for level3, topVL 15:01:41,257 DEBUG [main] - begin for level2, topVL 15:01:41,884 INFO [main] - merging complete 15:06:27,619 INFO [main] - got to save history 15:06:27,620 INFO [main] - Exiting CLI
Note
Command Syntax
Options
detail,noconfirm
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
40
Example
admin:file uccx delete custom_file log/*.log det noconfirm deleting file : log/cli00001.log deleting file : log/cli00002.log deleting file : log/cli00003.log deleting file : log/cli00004.log files: found = 4, deleted = 4
Options
hex,regexp "expression" recent: to dump the most recently changed file in the directory.
Requirements
show uccx dbreplication tables, page 42 show uccx dbreplication servers, page 43 utils uccx modify remote_IPAddress, page 43 utils uccx database forcedatasync, page 44 utils uccx dbreplication setup, page 45 utils uccx dbreplication templatestatus, page 45 utils uccx dbreplication repair, page 46 utils uccx dbreplication stop, page 46 utils uccx dbreplication start, page 47
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
41
utils uccx dbreplication reset, page 47 utils uccx dbreplication teardown, page 48
page - displays the output one page at a time file - stores the output to a file and displays the filename
Requirements
Command successful.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
42
admin:
page - displays the output one page at a time file - stores the output to a file and displays the filename
Requirements
Note
Use this command only when the IP Address of the other node is going to be changed. 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: http://www.cisco.com/en/US/products/sw/custcosw/ps1846/products_installation_and_configuration_g uides_list.html
Command Syntax
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
43
Arguments
remote_server_old_ip_addressOld IP address of the remote server remote_server_new_ip_addressNew IP address of the remote server
Requirements
NA
Options
NA
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
44
Requirements
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
45
[database_name]|all - mandatory; database_name - which database to repair replication on. all - fix replication on all nodes.
Options
Requirements
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
46
Requirements
Remove database replication (utils uccx dbreplication teardown) Setup database replication (utils uccx dbreplication setup) Initiate a data repair process for all the databases (utils uccx dbreplication repair all).
Command Syntax:
Requirements
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
47
Requirements
utils cad show versioninfo, page 49 utils uccx ldap search, page 49 utils uccx ldap modify, page 50 utils uccx ldap delete, page 50 utils uccx ldap add, page 50 utils uccx ldap cat, page 51 utils uccx ldap index, page 51 utils uccx ldap recover, page 51 utils uccx ldap archive, page 52 utils uccx ldap stat, page 52 utils uccx ldap modrdn, page 52 utils uccx ldap checkpoint, page 53
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
48
utils uccx dump packets, page 53 utils uccx recordings purge, page 53 show uccx cad license usage, page 54 show uccx cad prefs, page 54 show uccx cad log, page 54 show uccx cad config, page 55 show uccx recordings space, page 55 show uccx recordings allowed, page 55 show uccx servm config, page 56 set uccx cad prefs, page 56 set uccx cad config, page 56 set uccx cad log, page 57
file. The file for which version info has to be displayed. pattern. Patterns like *.so are also allowed.
Example
admin:utils cad show versioninfo /opt/cisco/uccx/desktop/lib/libSplkCRS.so Retrieveing Version Info for 1 file(s) Version Info for file /opt/cisco/uccx/desktop/lib/libSplkCRS.so
<baseDN>. The point where the attribute is to be searched filter. Filter if there are any. This is optional Attribute. The list of attributes to be listed. This is optional.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
49
Example
admin:utils uccx ldap search "ou=Agents,lcc=Call Center 1,ou=Company,o=Spanlink Communications" "empID=dactuser1" Using Host: 10.192.252.85 dn: empID=dactuser1,ou=Agents,lcc=Call Center 1,ou=Company,o=Spanlink Communications role: 0 userPassword:: MEMzMURGMTAwNTVGQ0U0QjFBQTYxRTJBRTg4MTkwN0E= recordTS: 0 objectClass: agent objectClass: employee empID: dactuser1 loginName: dactuser1 cn:: IERhY3R5bFRlc3RVc2VyMQ== sn: DactylTestUser1 tid: 1 awg: default
ldifFile. The file should contain the entries to be modified as per ldif file format. If null, it will read from standard input
Example
utils uccx ldap modify /tmp/ldp_mod.ldif
ldifFile. The file should contain the DN of the entries to be deleted as per LDIF file format. If passed null, it will read from standard input.
Example
uccx ldap delete /tmp/ldp_del.ldif
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
50
Command Syntax:
ldifFile. The file should contain the DN of the entries to be added as per LDIF file format.
Example
utils uccx ldap add /tmp/ldp_add.ldif
Note
None.
Example
utils uccx ldap index
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
51
Parameters
None.
Example
utils uccx ldap recover
None.
Example
utils uccx ldap archive
None.
Example
utils uccx ldap stat
add. This option is to add the RDN but not delete the existing DN. file <ldifFile>. Should contain 2 lines. 1st line will be the existing DN and 2nd line is new RDN.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
52
None.
Example
utils uccx ldap checkpoint
Note
Be careful while giving the time value. If the value is large, the capturing will go on and it will be difficult to stop the capture process. This will end up capturing the packets and eating up the space.
Command Syntax:
<Capturefile.cap>. File to which the packets are to be dumped. Give absolute path and .cap extension <Time interval>. Interval for which capturing should go on. The value is in seconds.
Example
utils uccx dump packets capturefile.cap 5
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
53
Note
None.
Example
show uccx cad license usage
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
54
Command Syntax:
<pathkey>. It is the mandatory Pathkey for which log configuration has to be displayed.
Example
show uccx cad log BIPPAService
None.
Example
show uccx recordings space
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
55
Parameters
None.
Example
show uccx recordings allowed
l. List all the services in servM configuration file. Group and Services displayed; <Service>. Displays the configuration of the specified 'Service'. To know the 'Service'(s) present, try this command with 'l'.
Example
Example1: show uccx servm config list Example2: show uccx servm config "Cisco Unified CCX Administration"
<key> - key name in quotes (case sensitive) <value> - new value in quotes.
Example
set uccx cad prefs SiteSetup "LDAP Host 5" 0
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
56
Parameters
<pathkey> - mandatory;Pathkey for which configuration has to be set <key> - mandatory; key name (case sensitive) <value> - mandatory; new value.
Example
set uccx cad config BIPPAService CMPort 8090
<pathkey> - mandatory; pathkey for which configuration has to be set. <type> - mandatory; type of file we need to update. eg., log/debug. <key> - mandatory; key name (case sensitive). <value> - mandatory; new value.
Example
This will set value against the key in cad server's log configuration file. Example1: set uccx cad log LRMService log Files 15 Example2: set uccx cad log LRMService debug Files 15
This will set value for Enable or Disable Alarm in cad server's log configuration file. Example1: set uccx cad log LRMService log Alarm Enable Example2: set uccx cad log LRMService log Alarm Disable
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
57
Related Documentation
Related Documentation
For further information about Cisco Unified Contact Center Express documentation, refer to the following URL: http://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.ht ml For a complete list of terms used in Cisco Unified CCX and Cisco Unified IP IVR, see the following URL: http://www.cisco.com/en/US/products/sw/custcosw/ps1846/prod_technical_reference_list.html
Documentation Feedback
You can provide comments about this document by sending an email to the following address: ccbu_docfeedback@cisco.com We appreciate your comments.
Command Line Interface Reference Guide for Cisco Unified CCX and Cisco Unified IP IVR, Release 8.5(1) Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/web/siteassets/legal/trademark.html. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R) 2011 Cisco Systems, Inc. All rights reserved.
Command Line Interface Reference Guide for Cisco Unified Contact Center Express Release 8.5(1)
58