Chapter 12: - Using Cisco Tools from a Command Line

How to Use the Log Collection Utility from a Command Line

 

Command:

Description:

Example:

 

Note: Using Help or ? also displays this list, but includes

 

 

several additional ICM commands (e.g., echo, error_stop)

 

 

not used by this utility.

 

/?

Displays syntax for a specified command.

><command> /?

appserver

Optionally Specifies the system on which the utility should

>lctool

 

run. If not specified, the utility is run on the local system. <app_servername>

system

Note: This command is not used with the Log Collection

 

 

utility.

 

localhost

Note: This command is not used with the Log Collection

 

 

utility.

 

create_collection_request,

Opens a session for creating a log collection request and

>ccolreq

ccolreq

specifies the new collection's name.

<new_collection_name>

 

 

Note: Maximum length for

 

 

name is 32 characters

add_log_group, alg

Adds one log group from the application server's

>alg <log_group_name>

 

Repository into current log collection. Each log group must

 

 

be added on a separate line.

 

remove_log_group, rmlg

Removes 1 log group from current log collection.

>rmlg <log_group_name>

list_log_groups, lslg

Lists the log groups in the current collection request.

>lslg

add_request_description,

Optionally, sets a description for current log collection.

>lcdesc <description>

lcdesc

 

 

set_icm_binary, bin

Optionally, sets the icmBinary flag ON or OFF. ON causes

>bin /on

/on

ICM logs to include binary data. If not specified, defaults

 

to off.

 

/off

set_log_range, range /start_date

/start_time

/end_date

Specifies the date/time range for logs to collect. /start_date,

>range /start_date mm/

/start_time, /end_date and /end_time are all required.

dd/yyyy

Date format is mm/dd/yyyy. Time format is hh:mm.

/start_timehh:mm /

Optionally, you can specify /all in place of specific

end_date mm/dd/yyyy

 

dates/times.

/end_time hh:mm

/end_time

Cisco Support Tools User Guide for Cisco Unified Software Release 2.1(1)

148

Page 162
Image 162
Cisco Systems 2.1(1) manual Ccolreq Specifies the new collections name, Lcdesc Seticmbinary, bin, Endtime, 148