CTS-Manager CLI Command Reference Guide 1.5
CLI Command Utility file

Table Of Contents

Utils Commands

utils fior

utils iothrottle enable

utils iothrottle disable

utils iothrottle status

utils network arp

utils network capture eth0

utils network host

utils network ping

utils network tracert

utils ntp

utils remote_account

utils service list

utils service

utils system


Utils Commands


Revised: April 15, 2009, OL-19545-01

This chapter contains the following utils commands:

utils fior

utils iothrottle enable

utils iothrottle disable

utils iothrottle status

utils network arp

utils network capture eth0

utils network host

utils network ping

utils network tracert

utils ntp

utils remote_account

utils service list

utils service

utils system

utils fior

utils fior

Options:

disable

enable

list [start=date-time] [stop=date-time]

start

status

stop

top number [read | write | read-rate | write-rate] [start=date-time] [stop=date-time]

Syntax Description

disable

Prevents the file I/O reporting service from starting automatically when the machine boots. This command does not stop the service without a reboot. Use the stop option to stop the service immediately.

enable

Enables the file I/O reporting service to start automatically when the machine boots. This command does not start the service without a reboot. Use the start option to start the service immediately.

list

This command displays a list of file I/O events, in chronological order, from oldest to newest.

start

Starts a previously stopped file I/O reporting service. The service remains in a started state until it is manually stopped or the machine is rebooted.

status

Displays the status of the file I/O reporting service.

stop

Stops the file I/O reporting service. The service remains in a stopped state until it is manually started or the machine is rebooted.

top

Displays a list of top processes that create file I/O. You can sort this list by the total number of bytes read, the total number of bytes written, the rate of bytes read, or the rate of bytes written.

[start=date-time]

Specifies a starting date and time.

[stop=date-time]

Specifies a stopping date and time.

date-time

Specifies a date and time, in any of the following formats: H:M, H:M:S a, H:M, a, H:M:S Y-m-d, H:M, Y-m-d, H:M:S.

number

Specifies how many of the top processes to list.

[read | write | read-rate | write-rate]

Specifies the metric that is used to sort the list of top process.


Command Modes

Admin

Command privilege level: 1

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

Use this command to monitor the I/O on the server. The File I/O Reporting service provides a kernel-based daemon for collecting file I/O per process.

Examples

admin: utils fior

Related Commands

Command
Description
   

utils iothrottle enable

utils iothrottle enable

Syntax Description

   

Command Modes

Admin

Command privilege level: 1

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command enables I/O throttling enhancements. When enabled, I/O throttling enhancements lower the impact of upgrades on an active system.

Examples

admin: utils iothrottle enable

Related Commands

Command
Description

utils iothrottle disable

Disables I/O throttling enhancements.

utils iothrottle status

Displays the status of I/O throttling enhancements.


utils iothrottle disable

utils iothrottle disable

Syntax Description

   

Command Modes

Admin

Command privilege level: 1

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command disables I/O throttling enhancements. This could adversely affect the system during upgrades.

Examples

admin: utils iothrottle disable

Related Commands

Command
Description

utils iothrottle enable

Enables I/O throttling enhancements.

utils iothrottle status

Displays the status of I/O throttling enhancements.


utils iothrottle status

utils iothrottle status

Syntax Description

   

Command Modes

Admin

Command privilege level: 1

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command displays the status of I/O throttling enhancements.

Examples

admin: utils iothrottle status

Related Commands

Command
Description

utils iothrottle enable

Enables I/O throttling enhancements.

utils iothrottle disable

Disables I/O throttling enhancements.


utils network arp

utils network arp

list [host host] [page] [numeric]

set {host} {address}

delete host

Options

page—Displays the output one page at a time

numeric—Displays hosts as dotted IP addresses

Syntax Description

list

Lists the contents of the address resolution protocol table.

set

Sets an entry in the address resolution protocol table.

delete

Deletes an entry in the address resolution table.

host

Represents the host name or IP address of the host to add or delete to the table

address

Represents the MAC address of the host to be added. Enter the MAC address in the following format: XX:XX:XX:XX:XX:XX


Command Modes

Admin

Command privilege level: 0

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command lists, sets, or deletes Address Resolution Protocol (ARP) table entries.

Examples

admin: utils network arp set myhost 11:22:33:44:55:66

Related Commands

Command
Description
   

utils network capture eth0

utils network capture eth0 [page] [numeric] [file fname] [count num] [size bytes] [src addr] [dest addr] [port num]

Options

page—Displays the output one page at a time

When you use the page or file options, the complete capture of all requested packets must occur before the command completes.

numeric—Displays hosts as dotted IP addresses

file fname—Outputs the information to a file

The file option saves the information to platform/cli/fname.cap. The filename cannot contain the "." character.

count num—Sets a count of the number of packets to capture

For screen output, the maximum count equals 1000, and, for file output, the maximum count equals 10,000.

size bytes—Sets the number of bytes of the packet to capture

For screen output, the maximum number of bytes equals 128, for file output, the maximum of bytes can be any number or ALL

src addr—Specifies the source address of the packet as a host name or IPV4 address

dest addr—Specifies the destination address of the packet as a host name or IPV4 address

port num—Specifies the port number of the packet, either source or destination

Syntax Description

eth0

Specifies Ethernet interface 0.


Command Modes

Admin

Command privilege level: 0

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command captures IP packets on the specified Ethernet interface.

Examples

admin: utils network capture eth0 

Related Commands

Command
Description
   

utils network host

utils network host hostname [server server-name] [page] [detail] [srv]

Syntax Description

hostname

Represents the host name or IP address that you want to resolve.

server-name

Specifies an alternate domain name server.

page

Displays the output one screen at a time.

detail

Displays a detailed listing.

srv

Displays DNS SRV records.


Command Modes

Admin

Command privilege level: 0

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command resolves a host name to an address or an address to a host name.

Examples

admin: utils network host cisco.com
Local Resolution:
Nothing found

External Resolution:
cisco.com resolves to 192.0.2.0

Related Commands

Command
Description

utils network ping

Sends one or more ping packets to a remote destination.

utils network tracet

Traces an IP packets to a remote destination.


utils network ping

utils network ping destination [count]

Syntax Description

destination

Represents the hostname or IP address of the server that you want to ping.

count

Specifies the number of times to ping the external server. The default count equals 4.


Command Modes

Admin

Command privilege level: 0

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command allows you to ping another server.

Examples

admin:utils network ping www.cisco.com count 5

Related Commands

Command
Description

utils network host

Resolves a hostname to an address, or an address to a hostname.

utils network tracert

Traces an IP packets to a remote destination.


utils network tracert

utils network tracert destination

Syntax Description

destination

Represents the hostname or IP address of the server to which you want to send a trace.


Command Modes

Admin

Command privilege level: 0

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command traces IP packets that are sent to a remote destination

Examples

admin: utils network tracert 

Related Commands

Command
Description
   

utils ntp

utils ntp {status | config}

Syntax Description

destination

Represents the hostname or IP address of the server to which you want to send a trace.


Command Modes

Admin

Command privilege level: 0

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command traces IP packets that are sent to a remote destination

Examples

The following example show an ntp client out of sync:

admin:utils ntp status
ntpd (pid 10561) is running...
     remote           refid      st t when poll reach   delay   offset  jitter
==============================================================================
 ntp-sj1.cisco.c .GPS.            1 u    3   64    1    5.885   -0.091   0.008

unsynchronised
  time server re-starting
   polling server every 16 s

current time is : Mon Jan 31 12:01:38 PST 2005

example for in sync:
ntpd (pid 10561) is running...
     remote           refid      st t when poll reach   delay   offset  jitter
==============================================================================
*ntp-sj1.cisco.c .GPS.            1 u    2   64   77    5.865    0.554   0.057

synchronized to NTP server (171.68.10.150) at stratum 2
   time correct to within 188 ms
   polling server every 64 s

current time is : Mon Jan 31 12:14:35 PST 2005

Related Commands

Command
Description
   

utils remote_account

utils remote_account

status

enable

disable

create username life

Syntax Description

username

Specifies the name of the remote account. The username can contain only lowercase characters and must be more than six characters long.

life

Specifies the life of the account in days. After the specified number of day, the account expires


Command Modes

Admin

Command privilege level: 1

Allowed during upgrade: Yes

Command History

Release
Modifications

1.4

This command was first documented.


Usage Guidelines

This command allows you to enable, disable, create, and check the status of a remote account.

A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the system for the specified life of the account. You can have only one remote account that is enabled at a time.

Examples

admin:utils remote_account create remacct 10
Remote Support
Status          : enabled
Decode Version  : 1
Account         : remacct
Passphrase      : 26NWA9SG4Q
Expiry          : 3-24-2008:13:00:00(MM-DD-YYYY:Hr:Min:Sec)

Related Commands

Command
Description
   

utils service list

utils service list [page]

Syntax Description

page

Displays the output one page at a time


Command Modes

Admin

Command privilege level: 0

Allowed during upgrade: Yes

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command retrieves a list of all services and their status

Examples

admin:utils service list

Service                State
----------             --------
System_Log             [Running]
Appl_Log               [Running]
DHCP_Srvr              [Running]

Related Commands

Command
Description
   

utils service

utils service list

start service-name

stop service-name

restart service-name

Syntax Description

service-name

Represents the name of the service that you want to stop or start:

System NTP

System SSH

Service Manager

A Cisco DB

Cisco Tomcat

Cisco Database Layer Monitor

Cisco Unified Serviceability

enable

Enables auto-restart.

disable

Disables auto-restart.

show

Shows the auto-restart status


Command Modes

Admin

Command privilege level: 1

Allowed during upgrade: No

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

This command stops, starts, or restarts a service.

Examples

admin:utils service start System NTP
System NTP		 Starting...done

Related Commands

Command
Description
   

utils system

utils system {restart | shutdown | switch-version [nodatasync]}

Syntax Description

restart

Restarts the system.

shutdown

Shuts down the system.

switch-version

Switches to the product release that is installed on the inactive partition.

nodatasync

Switches product versions without synchronizing User Facing Feature Data (UFF data) between the active and inactive partitions.


Command Modes

Admin

Command privilege level: 1

Allowed during upgrade: No

Command History

Release
Modifications

1.2

This command was first documented.


Usage Guidelines

The utils system shutdown command provides a 5-minute time-out. If the system does not shut down within 5 minutes, the command gives you the option of doing a forced shutdown.

A warning message displays, and you are prompted for confirmation before this command runs with the nodatasync option.

If you use the nodatasync option, any changes to UFF data on the active partition will get lost. You should use this option only to force the versions to switch if the system will not switch versions otherwise because a data synchronization failure occurred. For more information about UFF data, refer to the Cisco Unified Communications Solution Reference Network Design (SRND):

http://cisco.com/en/US/products/sw/voicesw/ps556/products_implementation_design_guides_list.html


Note Administrative changes made on the active partition, such as adding new phones, do not get synchronized when you switch versions. UFF data gets synchronized when you switch versions, unless you use the nodatasync option.


The nodatasync option does not support command auto-completion. You must enter the entire option name.

.

Examples

admin:utils system re start 
Are you sure you want to restart the system ?
Enter "yes" to restart or any other key to abort
continue: yes

The system is going down for restart NOW!

Related Commands

Command
Description