CLI Commands for CAD

[shalushar]

• Introduction
• Executing CLI Commands
• Related Links

Introduction

This document describes CLI tools and commands on Unified Communications Operating System.The Command Line Interface (CLI) tool is used to execute CLI commands on the Unified Communications Operating System and help diagnose and troubleshoot problems with the CAD services.

Executing CLI Commands

The CLI tool framework automatically loads when the user logs into the Unified Communications Operating System as an administrator.

To execute CLI commands:-

1. Log into the Unified Communications Operating System as an administrator. CLI starts.

2. At the admin prompt, type the desired CLI command.

CLI Command Syntax

• Pathkey, Key, and Value are mandatory fields and case sensitive.
• If a key or value contains spaces, enclose the string with double quotes. For example:

               set uccx cad prefs SiteSetup "LDAP Host 5" "cal lab.lab.com"

        NOTE: All commands are case sensitive.

CLI Commands

CommandDescription

show uccx cad license usage	Displays the available and used license information.
help <command>	Displays the description of the command. Example: help utils service list
utils service list	Displays the status of all services running on the Unified Communications Operating System.
utils uccx dump  packets <Capturefile.cap> <Time interval>	Copies active span-based monitoring packets into the specified file. • <Capturefile.cap>: Name of the file into which the packets must be copied. The file must have a CAP extension. • <Time interval>: Captures the packets for the specified time. The value for time interval must be in seconds. NOTE:  Make sure the time interval specified is less than 180 seconds. If the time interval is longer than 180                          seconds, the process continues without stopping, leading to more memory and space usage. Example: utils uccx dump packets capturefile.cap 5

Preferences

CommandsDescription

show uccx cad prefs <pathkey>	Displays key value pairs for the specified preferences file. Example: show uccx cad prefs SiteSetup
set uccx cad prefs <pathkey> <key> <value>	Sets the key value pairs with a new value. • Pathkey: Name of the CAD service’s preferences. • Key: The name of the key that you want to set with a new value. • Value: Specify a new value. Example: set uccx cad prefs SiteSetup "LDAP Host 5" 0

Recordings

CommandsDescription

show uccx recordings allowed	Displays the maximum amount of disk size allowed for recordings.
show uccx recordings space	Displays the total size of all the recording files.
utils uccx recordings purge <size in MB> <cutoff da	Deletes the specified size of recording files on or before the cutoff date. No recordings newer than the cutoff date will be purged. • Size in MB: Value must be a positive real number. • Cutoff date: Value can be any recognizable date as specified by the Unix system date command. Examples: utils uccx recordings purge 4.005 10/28/2011 20:56:33 utils uccx recordings purge 50 2 weeks ago

LDAP utilities

CommandDescription

utils uccx ldap recover	Recovers the LDAP database from an inconsistent state.
utils uccx ldap archive	Displays the path of LDAP transaction log files that are currently not used.
utils uccx ldap stat	Displays the statistics of the LDAP database.
utils uccx ldap checkpoint	Inspects and clears all LDAP database transaction logs and exits.
utils uccx ldap index	Regenerates the LDAP service indices based on the current LDAP database. Stop the LDAP service in the Unified CCX Serviceability page before executing this command.
utils uccx ldap search   <base DN value> [filter]   [attribute]	Displays information from the specified directory name in LDAP. • Base DN value: The directory name. • Filter and attribute: Optional. Filters the specified directory name by these criteria. Example: utils uccx ldap search "ou=Agents,lcc=Call Center 1,ou=Company,o=Calabrio Communications" "empID=dactuser1"
utils uccx ldap add <ldifFile>	Adds entries in the LDAP database according to the format in the specified LDIF file. • <LDIF File>: The LDIF file name. Stop the LDAP Monitor service in the Cisco Unified CCX Serviceability page before executing these commands. Examples: utils uccx ldap add adp_add.ldif
utils uccx ldap modify <ldifFile>	Modifies entries in the LDAP database according to the format in the specified LDIF file. • <LDIF File>: The LDIF file name. Stop the LDAP Monitor service in the Cisco Unified CCX Serviceability page before executing these commands. Examples: utils uccx ldap modify ldp_mod.ldif
utils uccx ldap delete <ldifFile	Deletes entries in the LDAP database according to the format in the specified LDIF file. • <LDIF File>: The LDIF file name. Stop the LDAP Monitor service in the Cisco Unified CCX Serviceability page before executing these commands. Examples: utils uccx ldap delete cdp_del.ldif
utils uccx ldap cat <ldifFile>	Copies all LDAP contents into the specified LDIF file. • <LDIF File>: The LDIF file name. Stop the LDAP Monitor service in the Unified CCX Serviceability page before executing this command. Example: utils uccx ldap cat ldp_list.ldif
utils uccx ldap modrdn   [add] [file <ldifFile>] |   [DN RDN]	Modifies the specified relative directory name in the LDAP database. • add: Optional. Adds a new relative directory name in LDAP. If this option is not specified, it replaces the existing directory name with the new one. • file <ldifFile>: The LDIF file name. The LDIF file must contain two lines, where: The first line contains the existing directory name The second line contains the new relative directory name Or DN RDN: DN is the existing directory name and RDN is the new relative directory name. You must provide parameters to either the [file <ldif file>] or DN RDN fields. Example: utils uccx ldap modrdn file /tmp/ldap_add.ldif

Debugging log threshold, number, size, and alert preferences

CommandDescription

show uccx cad log <pathkey>

Displays the specified CAD service’s log configuration details. Example: show uccx cad log slapd

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

Sets debugging log threshold, number size, and alerts for debug or log files for the specified CAD application. • Pathkey: Name of the CAD service's configuration file. • Type: The type of logging you want to set with the specified key value pairs. The types are debug or log. The additional type xslt can be set only for Bars CLI. • Key: The name of the key you want to set for the log threshold. The keys are Threshold, Size, and Files. NOTE:  The Threshold key is used only with the debug type. You cannot set the Threshold key for Bars CLI. • Value: The values for Threshold can be one of the following: OFF, DEBUG, CALL, TRACE, and DUMP. The value for Size and Files must be an integer. The value for Alarm must be either Enable or Disable. Examples: Threshold: set uccx cad log LRMService debug Threshold CALL Size: set uccx cad log LRMService log Size 10 File: set uccx cad log LRMService debug Files 25 Alarm: set uccx cad log EEMServerJava log Alarm Enable

Restart, start, and stop CAD services

Header 1Header 2

utils service restart <CAD service>	Restarts the specified CAD service. Example: utils service restart Cisco Desktop LDAP Monitor Service
utils service start <CAD service>	Starts the specified CAD service. Example: utils service start Cisco Desktop Sync Service
utils service stop <CAD service>	Stops the specified CAD service. Example: utils service stop Cisco Desktop LDAP Monitor Service

Related Links

Troubleshooting Agent in CAD