Cisco TelePresence Recording Server Release 1.8 Command Reference
CTRS File Commands

Table Of Contents

CTRS File Commands

file delete activelog

file delete inactivelog

file delete install

file dump activelog

file dump inactivelog

file dump install

file get activelog

file get inactivelog

file get install

file list activelog

file list inactivelog

file list install

file search activelog

file search inactivelog

file search install

file tail activelog

file tail inactivelog

file tail install

file view activelog

file view inactivelog

file view install


CTRS File Commands


October 2011

This chapter contains Cisco TelePresence Recording Server (CTRS) file commands:

file delete activelog

file delete inactivelog

file delete install

file dump activelog

file dump inactivelogq

file dump install

file get activelog

file get inactivelog

file get install

file list activelog

file list inactivelog

file list install

file search activelog

file search inactivelog

file search install

file tail activelog

file tail inactivelog

file tail install

file view activelog

file view inactivelog

file view install


Note For information about using the CTRS administration software, refer to the Cisco TelePresence Recording Server Release 1.8 Administration Guide at the following URL:

http://www.cisco.com/en/US/products/ps10341/prod_maintenance_guides_list.html


file delete activelog

file delete activelog file-spec [det] [noconfirm]

Syntax Description

file-spec

Name of the file to delete. File-spec can contain an asterisk (*) as a wildcard.

det

Provides details about the files being deleted.

noconfirm

Deletes files without requesting confirmation of each deletion.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to delete one or more files on an active side logging area.


Note You cannot delete files that are in use.


Examples

admin:file delete activelog platform/log/*.log det noconfirm
deleting file : platform/log/cli00001.log
deleting file : platform/log/cli00002.log
deleting file : platform/log/cli00003.log
deleting file : platform/log/cli00004.log
files:       found = 4, deleted = 4

file delete inactivelog

file delete inactivelog file-spec [det] [noconfirm]

Syntax Description

file-spec

Name of the file to delete. File-spec can contain an asterisk (*) as a wildcard.

det

Provides details about the files being deleted.

noconfirm

Deletes files without requesting confirmation of each deletion.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to delete one or more files on an inactive side logging area.


Note You cannot delete files that are in use.


Examples

admin:file delete inactivelog platform/log/*.log det noconfirm
deleting file : platform/log/cli00001.log
deleting file : platform/log/cli00002.log
deleting file : platform/log/cli00003.log
deleting file : platform/log/cli00004.log
files:       found = 4, deleted = 4

file delete install

file delete install file-spec [det] [noconfirm]

Syntax Description

file-spec

Name of the file to delete. File-spec can contain an asterisk (*) as a wildcard.

det

Provides details about the files being deleted.

noconfirm

Deletes files without requesting confirmation of each deletion.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to delete one or more files on an install side logging area.


Note You cannot delete files that are in use.


Examples

admin:file delete install platform/log/*.log det noconfirm
deleting file : platform/log/cli00001.log
deleting file : platform/log/cli00002.log
deleting file : platform/log/cli00003.log
deleting file : platform/log/cli00004.log
files:       found = 4, deleted = 4

file dump activelog

file dump activelog file-spec [expression | recent]

Syntax Description

file-spec

Name of the file to dump.

expression

Hexadecimal identifier of file to dump.

recent

Dumps the most recently changed file in the directory.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to dump the contents of a file on an active side logging area.

Examples

admin:file dump activelog platform/log/cli00001.log
2005-08-03 15:01:39,482 INFO [main] - Startup of CLI
Getting XML configuration file
....

file dump inactivelog

file dump inactivelog file-spec[expression | recent]

Syntax Description

file-spec

Name of the file to dump.

expression

Hexadecimal identifier of file to dump.

recent

Dumps the most recently changed file in the directory.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to dump the contents of a file on an inactive side logging area.

Examples

admin:file dump inactivelog platform/log/cli00001.log
2005-08-03 15:01:39,482 INFO [main] - Startup of CLI
Getting XML configuration file
....

file dump install

file dump install file-spec [expression | recent]

Syntax Description

file-spec

Name of the file to dump.

expression

Hexadecimal identifier of file to dump.

recent

Dumps the most recently changed file in the directory.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to dump the contents of a file on an install side logging area.

Examples

admin:file dump install install.log page
12/09/2005 17:43:54 anaconda|========================= Starting Installation 
=========================|<LVL::Info>
12/09/2005 17:43:54 anaconda|Starting anaconda script|<LVL::Info>
....

file get activelog

file get activelog file-spec [reltime | abstime | match | recurs | compress]

Syntax Description

file-spec

Name of the file to retrieve. File-spec can contain an asterisk (*) as a wildcard.

reltime

Relative time to filter in the following format: months/weeks/days/hours/minutes.

abstime

Absolute time to filter in the following format: hh:mm:MM/DD/YY hh:mm:MM/DD/YY

match

Search pattern to filter.

recurs

Collect all files located in file-spec and subdirectories.

compress

Transfer files as compressed files.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.

1.8

The compress keyword was added.


Usage Guidelines

Use this command to retrieve active log files using SFTP.


Note The files are saved under [target dir from input]/[this server's ip address]/[time period]/.


Examples

admin:file get activelog platform abstime 00:00:12/01/04 01:00:12/30/04

file get inactivelog

file get inactivelog file-spec [reltime | abstime | match | recurs | compress]

Syntax Description

file-spec

Name of the file to retrieve. File-spec can contain an asterisk (*) as a wildcard.

reltime

Relative time to filter in the following format: months/weeks/days/hours/minutes.

abstime

Absolute time to filter in the following format: hh:mm:MM/DD/YY hh:mm:MM/DD/YY

match

Search pattern to filter.

recurs

Collect all files located in file-spec and subdirectories.

compress

Transfer files as compressed files.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.

1.8

The compress keyword was added.


Usage Guidelines

Use this command to retrieve inactive log files using SFTP.


Note The files are saved under [target dir from input]/[this server's ip address]/[time period]/.


Examples

admin:file get inactivelog platform abstime 00:00:12/01/04 01:00:12/30/04

file get install

file get install file-spec [reltime | abstime | match | recurs | compress]

Syntax Description

file-spec

Name of the file to retrieve. File-spec can contain an asterisk (*) as a wildcard.

reltime

Relative time to filter in the following format: months/weeks/days/hours/minutes.

abstime

Absolute time to filter in the following format: hh:mm:MM/DD/YY hh:mm:MM/DD/YY.

match

Search pattern to filter

recurs

Collect all files located in file-spec and subdirectories.

compress

Transfer files as compressed files.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.

1.8

The compress keyword was added.


Usage Guidelines

Use this command to retrieve install log files using SFTP.


Note The files are saved under [target dir from input]/[this server's ip address]/[time period]/.


Examples

admin:file get install platform abstime 00:00:12/01/04 01:00:12/30/04

file list activelog

file list activelog file-spec [page] [detail] [reverse] [date] [size]

Syntax Description

file-spec

Name of the file. File-spec can contain an asterisk (*) as a wildcard.

page

Pauses output.

detail

Shows detailed listing.

reverse

Displays listing in reverse sort order.

date

Sorts listing by date.

size

Sorts listing by file size.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to list active logging files.

Examples

admin:file list activelog platform detail
13 Dec,2005 14:23:59      <dir>    cli
13 Dec,2005 14:23:59      <dir>    drf
13 Dec,2005 14:23:59      <dir>    log
13 Dec,2005 14:23:59      <dir>    temp
09 Dec,2005 17:54:33       12,583  servm_startup.log
dir count = 4, file count = 1

file list inactivelog

file list inactivelog file-spec [page] [detail] [reverse] [date] [size]

Syntax Description

file-spec

Name of the file. File-spec can contain an asterisk (*) as a wildcard.

page

Pauses output.

detail

Shows detailed listing.

reverse

Displays listing in reverse sort order.

date

Sorts listing by date.

size

Sorts listing by file size.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to list inactive logging files.

Examples

admin:file list inactivelog platform detail
01 Dec,2005 14:43:34      <dir>    cli
01 Dec,2005 14:43:34      <dir>    drf
01 Dec,2005 14:43:34      <dir>    log
01 Dec,2005 14:43:34      <dir>    temp
01 Dec,2005 16:54:33       12,583  servm_startup.log
dir count = 4, file count = 1

file list install

file list install file-spec [page] [detail] [reverse] [date] [size]

Syntax Description

file-spec

Name of the file. File-spec can contain an asterisk (*) as a wildcard.

page

Pauses output.

detail

Shows detailed listing.

reverse

Displays listing in reverse sort order.

date

Sorts listing by date.

size

Sorts listing by file size.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to list install logging files.

Examples

admin:file list install * detail
09 Dec,2005 17:54:33          140  capture.txt
09 Dec,2005 17:50:43       20,506  install.err
13 Dec,2005 14:02:58      230,018  install.log
09 Dec,2005 17:47:53       21,634  ks.cfg
09 Dec,2005 17:47:53          208  partAlloc
dir count = 0, file count = 5

file search activelog

file search activelog file-spec reg-exp [reltime | abstime] [ignorecase] [recurs]

Syntax Description

file-spec

Name of the file for which to search. File-spec can contain an asterisk (*) or a question mark (?) as a wildcard.

reg-exp

Regular expression to be searched

reltime

Searches for files that were modified during relative time period; format this field as follows: months/weeks/days/hours/minutes.

abstime

Searches for files that were modified within a specific time range; format this field as follows: hh:mm:MM/DD/YY hh:mm:MM/DD/YY

ignorecase

Ignores case distinctions

recurs

Searches for patterns recursively through subdirectories.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to search the contents of active side logging files for the given "regular expression" to display the matching lines.

Examples

admin:file search activelog platform/log/platform.log Err[a-z] ignorecase

file search inactivelog

file search inactivelog file-spec reg-exp [reltime | abstime] [ignorecase] [recurs]

Syntax Description

file-spec

Name of the file for which to search. File-spec can contain an asterisk (*) or a question mark (?) as a wildcard.

reg-exp

Regular expression to be searched

reltime

Searches for files that were modified during relative time period; format this field as follows: months/weeks/days/hours/minutes.

abstime

Searches for files that were modified within a specific time range; format this field as follows: hh:mm:MM/DD/YY hh:mm:MM/DD/YY

ignorecase

Ignores case distinctions

recurs

Searches for patterns recursively through subdirectories.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to search the contents of inactive side logging files for the given "regular expression" to display the matching lines.

Examples

admin:file search inactivelog platform/log.platfom.log Err[a-z] ignorecase

file search install

file search install file-spec reg-exp [reltime | abstime] [ignorecase] [recurs]

Syntax Description

file-spec

Name of the file for which to search. File-spec can contain an asterisk (*) or a question mark (?) as a wildcard.

reg-exp

Regular expression to be searched.

reltime

Searches for files that were modified during relative time period; format this field as follows: months/weeks/days/hours/minutes.

abstime

Searches for files that were modified within a specific time range; format this field as follows: hh:mm:MM/DD/YY hh:mm:MM/DD/YY

ignorecase

Ignores case distinctions.

recurs

Searches for patterns recursively through subdirectories.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to search the contents of install logging files for the given "regular expression" to display the matching lines.

Examples

admin:file search install install_post.log Err[a-z] page ignorecase

file tail activelog

file tail activelog file-spec [expression] [recent]

Syntax Description

file-spec

Name of the file to tail.

expression

Expression to be searched.

recent

Tails the most recently changed files in the directory.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to tail the contents of the indicated file on an active side logging area.

Examples

This example shows a tailed file starting with the last 10 lines with pagination enabled:

admin:file tail activelog platform/log/cli00001.log page 10
2005-08-03 15:01:41,248 DEBUG [main] - cmdMVL size = 0
2005-08-03 15:01:41,248 INFO [main] - adding command in level3 (password/security)
2005-08-03 15:01:41,249 DEBUG [main] - begin for level4, topVL size = 0
2005-08-03 15:01:41,250 DEBUG [main] - begin for level4, topVL size = 0
2005-08-03 15:01:41,256 DEBUG [main] - begin for level3, topVL size = 0
2005-08-03 15:01:41,257 DEBUG [main] - begin for level2, topVL size = 0
2005-08-03 15:01:41,884 INFO [main] - merging complete
2005-08-03 15:06:27,619 INFO [main] - got to save history
2005-08-03 15:06:27,620 INFO [main] - Exiting CLI

file tail inactivelog

file tail inactivelog file-spec [expression] [recent]

Syntax Description

file-spec

Name of the file to tail.

expression

Expression to be searched.

recent

Tails the most recently changed files in the directory.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to tail the contents of a file on an inactive side logging area.

Examples

admin:file tail inactivelog platform/log/cli00001.log
2005-08-03 15:01:41,248 DEBUG [main] - cmdMVL size = 0
2005-08-03 15:01:41,248 INFO [main] - adding command in level3 (password/security)
2005-08-03 15:01:41,249 DEBUG [main] - begin for level4, topVL size = 0
2005-08-03 15:01:41,250 DEBUG [main] - begin for level4, topVL size = 0
2005-08-03 15:01:41,256 DEBUG [main] - begin for level3, topVL size = 0
2005-08-03 15:01:41,257 DEBUG [main] - begin for level2, topVL size = 0
2005-08-03 15:01:41,884 INFO [main] - merging complete
2005-08-03 15:06:27,619 INFO [main] - got to save history
2005-08-03 15:06:27,620 INFO [main] - Exiting CLI

file tail install

file tail install file-spec [expression] [recent]

Syntax Description

file-spec

Name of the file to tail.

expression

Expression to be searched.

recent

Tails the most recently changed files in the directory.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to tail the contents of a file on an install side logging area.

Examples

admin:file tail install capture.txt
  inflating: Help/ccmcfg/CCM Administration Guide-23-6.html
  inflating: Help/ccmcfg/CCM Administration Guide-23-7.html
  inflating: Help/ccmcfg/CCM Administration Guide-23-8.html
  inflating: Help/ccmcfg/CCM Administration Guide-24-1.html

file view activelog

file view activelog file-spec

Syntax Description

file-spec

Name of the file to view. File-spec can contain an asterisk (*) as a wildcard as long as it resolves to a single file.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to show the contents of an active side logging file.

Examples

admin:file view activelog platform/log/platform.log

file view inactivelog

file view inactivelog file-spec

Syntax Description

file-spec

Name of the file to view. File-spec can contain an asterisk (*) as a wildcard as long as it resolves to a single file.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to show the contents of an inactive side logging file.

Examples

admin:file view inactivelog platform/log.platfom.log

file view install

file view install file-spec

Syntax Description

file-spec

Name of the file to view. File-spec can contain an asterisk (*) as a wildcard as long as it resolves to a single file.


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was introduced.


Usage Guidelines

Use this command to show the contents of an install logging file.

Examples

admin:file view install install.log