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

Set Commands

Set Commands

set cuic properties

Use these commands to set values for the cuic database and session timeout.

Command syntax

set cuic properties host-to-ip

Parameter

  • <host>—Enter the value for the host DNS name for the server, as displayed on the Data Sources interface.
  • <ip_adddress>—Enter the IP address of the server for the historical or realtime database.

set cuic properties session-timeout

Parameter

  • #numberofSeconds—This command sets the session timeout for the Unified IC Reporting web application. The default is 14,400 seconds (4 hours).

Requirements

Level Privilege—0

Command Privilege Level—0

Allowed during Upgrade—Yes

Example

admin:set cuic properties
set cuic properties host-to-ip
set cuic properties session-timeout

unset cuic properties

Use this command to unset the translation of host-to-ip hostname.

Command syntax

unset cuic properties host-to-ip <hostname>

Options

None

Requirements

Level Privilege—0

Command Privilege Level—0

Allowed during Upgrade—Yes

Example

admin:unset cuic properties host-to-ip <hostname>

set cuic syslog

Command Syntax

set cuic syslog <disable|enable>

Options
  • disable—to disable CUIC application remote syslogs
  • enable—to enable CUIC application remote syslogs

Requirements

Level Privilege—0

Command Privilege Level—0

Allowed during Upgrade—Yes

Example

admin:set cuic syslog enable

set cuic trace

Use these commands to set or change the log levels and trace setting for the cuicserver subsystem to basic or detailed.

Command Syntax

set cuic trace basic cuicserver <subsystem> none

set cuic trace infrastructure cuicserver <subsystem> <TRACE_FLAGS|none>

set cuic trace subsystem cuicserver <subsystem> trace_mask1 trace_mask2

For cuicserver, the valid subsystems are:
  • Infrastructure
  • CUIC
  • CUIC_MODEL_OBJECTS
  • CUIC_DATA_PROCESSING
  • CUIC_SECURITY
  • CUIC_DISPLAY
  • CUIC_MIGRATION
  • CUIC_USER_HISTORY
  • CUIC_JSP
  • CUIC_STATISTICS

Detailed log levels are set by enabling trace flags which allows debug statements to appear in the logs. You can control debug tracing for specific functions (specified in the TRACEflag name) within specific subsystem components.

PARAMETERS
  • basic—set to basic level of tracing to display messages and warnings
  • detailed—set to debug level to allow you to turn on tracing for specific components
  • subsystem—indicates the subsystem and displays the list of all valid subsystems
  • none—no flag is set for tracing

Requirements

Level Privilege—1

Command Privilege Level—1

Allowed during Upgrade—Yes

Example

admin:set cuic trace basic cuicserver CUIC_SECURITY

set uccx trace defaults

Sets the default trace levels for all components and sub-components in Unified CCX. If the optional component is specified, it sets the default trace levels only for all the sub-components of the specified component. If both the optional component and sub-component are specified, it sets the default trace levels only for the specified sub-component under the component.

Command Syntax:

set uccx trace defaults [options]

Options

  • Component—Sets the default trace levels for all the sub-components of this component. The various components are UCCXEngine, UCCXCvd, UCCXAppAdmin, JTAPI_CLIENT.
  • Sub-component—Sets 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

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: No

Example

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

set uccx trace file size component size

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 3145728Trace file size for uccxengine is set to 3145728 bytes.

set uccx trace file count component no-of-files

Sets the trace file count for the specified component. i.e. 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 300Trace file count for uccxengine is set to 300

set uccx trace enable component sub-component level

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. The following formats for level are supported # and #, #.

This command will *not* set the trace settings for CAD or CSD services. There will be a separate set of CLI commands for them. Trace settings for the DB component, which is the Informix server, will also not be available.

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

The Unified CCX services will have to be restarted for the trace changes to take effect. 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_​guides_​list.html

Command Syntax:

set uccx trace enable <component> <sub-component> <level>

Arguments

  • component—Mandatory; The component such as UCCXEngine or UCCXEditor or JTAPI_CLIENT
  • sub-component—Mandatory; The sub-component within the component such as JTAPI Subsystem within the UCCXEngine component. For the JTAPI_CLIENT component there are no sub-components.
  • Level—Mandatory; 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

Level privilege—1

Command privilege level—1

Allowed during upgrade—No

Example 1

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

Example 2

set uccx trace enable UCCXEngine ICD_CTI XDEBUGGING1,XDEBUGGING2Trace for UCCXEngine:ICD_CTI:XDEBUGGING1 is enabled
Trace for UCCXEngine:ICD_CTI:XDEBUGGING2 is enabled

set uccx trace disable component sub-component level

Disables 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. The following formats for level are supported # and #, #. Turning off Alarm tracing using this command will not be possible.

This command will *not* set the trace settings for CAD/CSD services. There will be a separate set of CLI commands for them. Trace settings for the DB component i.e. the Informix server will also not be available.

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

The Unified CCX services will have to be restarted for the trace changes to take effect. 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_​guides_​list.html

CCommand Syntax:

set uccx trace disable <component> <sub-component> <level>

Arguments

  • Component – The component such as UCCXEngine or UCCXEditor or JTAPI_CLIENT.
  • Sub-component - The sub-component within the component such as JTAPI Subsystem within the UCCXEngine component. For the JTAPI_CLIENT component there are no sub-components.
  • Level - Mandatory - 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

Level privilege—1

Command privilege level—1

Allowed during upgrade—No

Example 1

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

Example 2

set uccx trace disable UCCXEngine ICD_CTI XDEBUGGING1,XDEBUGGING2Trace for UCCXEngine:ICD_CTI:XDEBUGGING1 is disabled
Trace for UCCXEngine:ICD_CTI:XDEBUGGING2 is disabled

set password user security

This is the CLI command for changing the security/SFTP password on the UCOS box. In addition to changing the security password, it will also change the passwords of the internal Unified CCX users.

Command Syntax

set password user security

Arguments

None

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.

set uccx provider ip axl

Sets the Unified CCX AXL provider IP address. This command should only be used when the IP address of Unified CM has been changed and Unified CCX is being pointed to the new IP address.


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".



Note


For more information on how ro restart the Unified CCX services, see the Cisco Unified CCX Serviceability Administration Guide available here:



Note


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


Command Syntax:

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.

set uccx provider ip jtapi

Sets the Unified CCX JTAPI provider IP address. This command should only be used when the IP address of Unified CM has been changed and Unified CCX is being pointed to the new IP address.


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".



Note


For more information on how ro restart the Unified CCX services, see the Cisco Unified CCX Serviceability Administration Guide available here:



Note


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


Command Syntax

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.

set uccx provider ip rmcm

Sets the Unified CCX RmCm provider IP address. This command should only be used when the IP address of Unified CM has been changed and Unified CCX is being pointed to the new IP address.


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".



Note


For more information on how ro restart the Unified CCX services, see the Cisco Unified CCX Serviceability Administration Guide available here:



Note


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


Command Syntax

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.

set uccx appadmin administrator

Sets the username as Cisco Unified CCX Appadmin Administrator. You can get the correct username from the call manager's end user page.


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

set uccx appadmin administrator <username>

Arguments

  • <username> — Username is set as the Cisco Unified CCX application administration. Requirements

Level privilege: 1

Command privilege level: 1

Allowed during upgrade: False

Example

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

Note


You cannot assign Administrator capability to a user ID which is the same as the application administrator user ID 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.