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

CAD and CSD Commands

CAD and CSD Commands

utils cad show versioninfo

This command displays the version information for the file(s) supplied. You can either give a single file (or) a pattern for files.

Command Syntax:

utils cad show versioninfo <file>|<pattern>

Parameters

  • 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.soRetrieveing Version Info for 1 file(s)
    Version Info for file /opt/cisco/uccx/desktop/lib/libSplkCRS.so
    

utils uccx ldap search

This command returns the results based on user's search query. You need to provide the baseDN and an optional filter and attribute.

Command Syntax:

utils uccx ldap search <baseDN> [filter] [Attribute]

Parameters

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

utils uccx ldap modify

This command modifies the entries in an LDAP as mentioned in the ldif file.

Command Syntax:

utils uccx ldap modify <ldifFile>

Parameters

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

utils uccx ldap delete

This command deletes the entries in an LDAP as mentioned in the ldif file.

Command Syntax:

utils uccx ldap delete <ldifFile>

Parameters

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

utils uccx ldap add

This command updates LDAP with the entries the file passed in LDIF file format.

Command Syntax:

utils uccx ldap add <ldifFile>

Parameters

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


Execute this command when SLAPD is not running.


utils uccx ldap cat

This command dumps the entire contents of LDAP in to the file passed in LDIF file format.

Command Syntax:

utils uccx ldap cat <ldifFile>

Parameters

ldifFile. Name of the file to which the data is to be dumped.

Example

utils uccx ldap cat /tmp/ldap_cat.ldif

utils uccx ldap index

This command regenerates slapd indices based on the current contents of a database.

Command Syntax:

utils uccx ldap index

Parameters

None.

Example

utils uccx ldap index

utils uccx ldap recover

This command recovers the LDAP database from an inconsistent state.

Command Syntax:

utils uccx ldap recover

Parameters

None.

Example

utils uccx ldap recover

utils uccx ldap archive

This command displays the path names of LDAP transcation log files that are no longer in use.

Command Syntax:

utils uccx ldap archive

Parameters

None.

Example

utils uccx ldap archive

utils uccx ldap stat

This command displays the statistics of LDAP database.

Command Syntax:

utils uccx ldap stat

Parameters

None.

Example

utils uccx ldap stat

utils uccx ldap modrdn

This command modifies the RDN of entries. The entry information is read from standard input, from file passed as an argument, or from the command-line pair DN and RDN.

Command Syntax:

utils uccx ldap modrdn [add] [file <ldifFile>] | [DN RDN]

Parameters

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.

DN RDN. DN is the existing DN and RDN is the new DN to be added/updated.

Example

utils uccx ldap file modrdn /tmp/ldap_modadd.ldif

utils uccx ldap checkpoint

This command Checkpoints the log once, regardless of whether or not there has been activity since the last check-point and then exit.

Command Syntax:

utils uccx ldap checkpoint

Parameters

None.

Example

utils uccx ldap checkpoint

utils uccx dump packets

This command dumps the 'active span based monitoring packets' to the file mentioned.


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:

utils uccx dump packets <Capturefile.cap> <Time interval>

Parameters

<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

utils uccx recordings purge

This command will delete the XX MB of recording files.


Note


This command purges the oldest recording files first.


Command Syntax:

utils uccx recordings purge <size in MB>

Parameters

<size in MB>—Space to be freed up in MB.

Example

utils uccx recordings purge 2

show uccx cad license usage

This will display the available and used license information. This will take a few seconds to retrieve the license details.

Command Syntax:

show uccx cad license usage

Parameters

None

Example

show uccx cad license usage

show uccx cad prefs

This will display the contents of the configuration file.

Command Syntax:

show uccx cad prefs <pathkey>

Parameters

pathkey. It is the mandatory Pathkey for which configuration has to be displayed.

Example

show uccx cad prefs SiteSetup

show uccx cad log

This will display the contents of the desktop service's log configuration file.

Command Syntax:

show uccx cad log <pathkey>

Parameters

<pathkey>—It is the mandatory Pathkey for which log configuration has to be displayed.

Example

show uccx cad log BIPPAService

show uccx cad config

This will display the contents of the desktop service's configuration file.

Command Syntax:

show uccx cad config <pathkey>

Parameters

<pathkey>. It is the mandatory Pathkey for which configuration has to be displayed.

Example

show uccx cad config BIPPAService

show uccx recordings space

This will display the total size of all the recording files.

Command Syntax:

show uccx recordings space

Parameters

None.

Example

show uccx recordings space

show uccx recordings allowed

This command displays the maximum amount of disk size allowed for recordings.

Command Syntax:

show uccx recordings allowed

Parameters

None

Example

show uccx recordings allowed

show uccx servm config

This command is used to get the list of services or a specified service in servM configuration file.

Command Syntax:

show uccx servm config l|h|<Service>

Parameters

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"

set uccx cad prefs

This command will set the value to the corresponding key of CAD server's preferences file.

Command Syntax:

set uccx cad prefs <pathkey> <key> <value>

Parameters

<key> - key name in quotes (case sensitive)

<value> - new value in quotes.

Example

set uccx cad prefs SiteSetup "LDAP Host 5" 0

set uccx cad config

This will set configuration file value for the CAD server's configuration file.

Command Syntax:

set uccx cad config <pathkey> <key> <value>

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

set uccx cad log

This command displays log configuration info for the desktop service.

Command Syntax:

set uccx cad log <pathkey> <type> <key> <value>

Parameters

<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 command sets the 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