Table Of Contents
Utils Commands
utils fior
utils firewall
utils iostat
utils iothrottle enable
utils iothrottle disable
utils iothrottle status
utils network arp
utils network capture eth0
utils network host
utils network ipv6
utils network ping
utils network traceroute
utils ntp
utils remote_account
utils service
utils service list
utils snmp
utils snmp hardware-agents
utils system
Utils Commands
Published: October 26, 2010, OL-23878-01
This chapter contains the following utils commands:
•
utils fior
•
utils firewall
•
utils iostat
•
utils iothrottle enable
•
utils iothrottle disable
•
utils iothrottle status
•
utils network arp
•
utils network capture eth0
•
utils network host
•
utils network ipv6
•
utils network ping
•
utils network traceroute
•
utils ntp
•
utils remote_account
•
utils service
•
utils service list
•
utils snmp
•
utils snmp hardware-agents
•
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
|
Specifies a starting date and time.
|
stop
|
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
utils firewall
utils firewall [ipv4 | ipv6] [list | status]
Syntax Description
ipv4
|
Internet Protocol version 4.
|
ipv6
|
Internet Protocol version 6.
|
list
|
Current configuration of the firewall.
|
status
|
Status of the firewall.
|
Command Modes
Admin
Command privilege level: 1
Command History
Release
|
Modifications
|
1.7
|
This command was first documented.
|
Usage Guidelines
This command displays the current status and configuration of either an IPv4 or IPv6 firewall.
Examples
admin: utils firewall ipv4 list
Chain PREROUTING (policy ACCEPT)
target prot opt source destination
Chain INPUT (policy ACCEPT)
target prot opt source destination
Chain FORWARD (policy ACCEPT)
target prot opt source destination
Chain OUTPUT (policy ACCEPT)
target prot opt source destination
Chain POSTROUTING (policy ACCEPT)
target prot opt source destination
utils iostat
utils iostat
Syntax Description
None.
Command Modes
Admin
Command privilege level: 1
Command History
Release
|
Modifications
|
1.7
|
This command was first documented.
|
Usage Guidelines
This command provides the iostat output for the given number of iterations and interval.
Examples
Executing command... Please be patient
Tue Oct 9 12:47:09 IST 2007
Linux 2.4.21-47.ELsmp (csevdir60) 10/09/2007
avg-cpu: %user %nice %sys %iowait %idle
3.61 0.02 3.40 0.51 92.47
Device: rrqm/s wrqm/s r/s w/s rsec/s wsec/s rkB/s wkB/s avgrq-sz avgqu-sz
await svctm %util
sda 3.10 19.78 0.34 7.49 27.52 218.37 13.76 109.19 31.39 0.05
5.78 0.73 0.57
sda1 0.38 4.91 0.14 0.64 4.21 44.40 2.10 22.20 62.10 0.02
26.63 1.62 0.13
sda2 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 10.88 0.00
2.20 2.20 0.00
sda3 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 5.28 0.00
1.88 1.88 0.00
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 enable
utils iothrottle enable
Syntax Description
None.
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
I/O throttling has been enabled
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
None.
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
I/O throttling has been disabled.
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
I/O throttling is disabled.
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 hostname or IP address of the host] [options]
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 hostname 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:utils network arp list
Admin:utils network arp list host
Note: if you enter host, you must follow it with a hostname or IP address
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
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
utils network host
utils network host hostname [server server-name] [page] [detail] [srv]
Syntax Description
hostname
|
Represents the hostname 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
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 ipv6
utils network ipv6 [host] [ping | traceroute destination]
Syntax Description
host
|
Look up an IPv6 address or hostname.
|
ping
|
Ping an IPv6 address or hostname.
|
traceroute
|
Traceroute IPv6 address or hostname.
|
destination
|
IPv6 address.
|
Command Modes
Admin
Command privilege level: 0
Allowed during upgrade: Yes
Command History
Release
|
Modifications
|
1.7
|
This command was first documented.
|
Usage Guidelines
This command display IPv6 information including host, ping and traceroute.
Examples
admin: utils network ipv6 host fd00:5::21b:78ff:fed1:7da6
IPv6 address fd00:12::250:56ff:feba:532f resolves to bldr-vcm6.example.com
admin:utils network ipv6 ping fd00:5::21b:78ff:fed1:7da6
PING fd00:5::21b:78ff:fed1:7da6(fd00:5::21b:78ff:fed1:7da6) 56 data bytes
64 bytes from fd00:5::21b:78ff:fed1:7da6: icmp_seq=0 ttl=63 time=0.392 ms
64 bytes from fd00:5::21b:78ff:fed1:7da6: icmp_seq=1 ttl=63 time=0.376 ms
64 bytes from fd00:5::21b:78ff:fed1:7da6: icmp_seq=2 ttl=63 time=0.380 ms
64 bytes from fd00:5::21b:78ff:fed1:7da6: icmp_seq=3 ttl=63 time=0.408 ms
--- fd00:5::21b:78ff:fed1:7da6 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3071ms
rtt min/avg/max/mdev = 0.376/0.389/0.408/0.012 ms, pipe 2
admin:utils network ipv6 traceroute fd00:5::21b:78ff:fed1:7da6
utils network ping
utils network ping dest [count VALUE] [size VALUE]
Syntax Description
ping
|
destination with count value and size value.
|
destination
|
Mandatory. Represents the hostname or IP address of the server that you want to ping.
|
count
|
Optional. Specifies the number of times to ping the external server. The default count equals 4.
|
size
|
Optional. Specifies the size of the ping packet in bytes. The default size is 56.
|
Command Modes
Admin:utils network ping
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 traceroute
utils network traceroute dest
Syntax Description
dest
|
Represents the IP address or hostname of the server to which you want to send a trace.
Note IP address must be dotted.
|
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 traceroute 209.165.201.1
209.165.201.30 (209.165.201.30) 0.293 ms 0.208 ms 0.199 ms
2 example-main-sw21 (209.165.200.225) 0.263 ms 0.275 ms 0.300 ms
3 example21-00lab-gw1-gig2-3 (209.165.202.129) 0.714 ms 0.725 ms 1.019 ms
4 example23-lab5-gw1-ten3-5 (209.165.202.130) 1.314 ms 0.861 ms 0.824 ms
5 example20-sbb5-gw1-ten7-5 (209.165.202.131) 1.424 ms 1.267 ms 1.011 ms
6 example20-rbb-gw1-ten6-2 (209.165.202.135) 0.475 ms 0.391 ms 0.364 ms
7 example12-rbb-gw4-ten7-1 (209.165.202.140) 0.459 ms * 0.508 ms
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 displays the NTP status or configuration.
Examples
The following example show an ntp client out of sync:
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
polling server every 16 s
current time is : Mon Jan 31 12:01:38 PST 2005
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
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 the Cisco Systems support team to access the system for the specified life of the account. You can have only one remote account enabled at one time.
Examples
admin:utils remote_account create remacct 10
Expiry : 3-24-2008:13:00:00(MM-DD-YYYY:Hr:Min:Sec)
utils service
utils service
start service-name
stop service-name
Syntax Description
service-name
|
Represents the name of the service that you want to stop or start:
– System SSH
– Service Manager
– Cisco SNMP Service
|
Command Modes
Admin
Command privilege level: 1
Allowed during upgrade: No
Command History
Release
|
Modifications
|
1.2
|
This command was first documented.
|
1.7
|
Removed restart, enable, disable and the following service-name parameters: System NTP, A Cisco DB, Cisco WebServer, Cisco Database Layer Monitor and Cisco Unified Serviceability, because of changes in the 1.7 release of CTS-Manager.
|
Usage Guidelines
This command stops, starts, or restarts a service.
Examples
admin:utils service start System NTP
System NTP Starting...done
utils service list
utils service list [page]
Syntax Description
page
|
Displays the output one page at a time if command out is more than 20.
|
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 if command out is more than 20. Minimum ssh window length is 20 lines.
Examples
Requesting service status, please wait...
Service Manager is running
Cisco CDP Service [Running]
Cisco Certificate Expiry Monitor [Running]
Cisco Event Subsystem [Running]
Cisco Server Resource Monitor [Running]
Cisco TelePresence Cluster Manager [Running]
utils snmp
utils snmp [reset | save]
Syntax Description
reset
|
Resets SNMP objects to their default values.
|
save
|
Saves a subset of current SNMP object values.
|
Command Modes
Admin
Command privilege level: 0
Allowed during upgrade: Yes
Command History
Release
|
Modifications
|
1.7
|
This command was first documented.
|
Usage Guidelines
This command allows you to save or reset SNMP object values.
Note
The saved value will replace the object default value when Snmpd is restarted.
Examples
Reset Snmp objects to their default values when Snmpd is restarted.
utils snmp hardware-agents
utils snmp hardware-agents [restart | start | status | stop]
Syntax Description
restart
|
Restarts all of the SNMP agents provided by the vendor of the hardware.
|
start
|
Starts all of the SNMP agents provided by the vendor of the hardware.
|
status
|
Shows the status of the SNMP agents provided by the vendor of the hardware.
Note Only the agents that provide status will be shown by this command. Not all hardware agents will provide status.
|
stop
|
Stops all of the SNMP agents provided by the vendor of the hardware.
|
Command Modes
Admin
Command privilege level: 0
Allowed during upgrade: Yes
Command History
Release
|
Modifications
|
1.7
|
This command was first documented.
|
Usage Guidelines
This command allows you to control and get status for the SNMP hardware agent.
Examples
Reset Snmp objects to their default values when Snmpd is restarted.
admin:utils snmp hardware-agents restart
Hourly HP Agent watchdog process is deactivated. To activate the watchdog process run the
command: utils snmp hardware-agents start
HP Agent watchdog process has been reactivated.
utils system
utils system {boot [console | serial | status] | restart | shutdown | switch-version [nodatasync]}
Syntax Description
boot
|
Boots the system.
|
restart
|
Restarts the system.
|
shutdown
|
Shuts down the system.
|
switch-version
|
Switches to the product release that is installed on the inactive partition.
|
Options
•
console—Changes the output during system boot to the console.
•
serial—Changes the output during the system boot to COM1 (serial port one).
•
status—Displays where system boot messages will be sent (console or serial port one).
•
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.
|
1.7
|
This command was updated with boot command and console, serial and status options.
|
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 restart
Appliance is being Restarted ...
Shutting down Service Manager will take some time..
Broadcast message from root (Tue Oct 26 16:53:23 2010):
The system is going down for reboot NOW!
\ Service Manager shutting down services... Please Wait