cc/td/doc/product/software/ios122/122sup/122csum/csum1
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Basic System Management Commands
absolute
alias
buffers
buffers huge size
calendar set
clock calendar-valid
clock read-calendar
clock set
clock summer-time
clock timezone
clock update-calendar
downward-compatible-config
hostname
ip bootp server
ip finger
ip telnet source-interface
ip tftp source-interface
load-interval
ntp access-group
ntp authenticate
ntp authentication-key
ntp broadcast
ntp broadcast client
ntp broadcastdelay
ntp clock-period
ntp disable
ntp master
ntp peer
ntp refclock
ntp server
ntp source
ntp trusted-key
ntp update-calendar
periodic
prompt
scheduler allocate
scheduler interval
service decimal-tty
service exec-wait
service finger
service hide-telnet-address
service nagle
service prompt config
service tcp-small-servers
service telnet-zero-idle
service udp-small-servers
show aliases
show buffers
show calendar
show clock
show ntp associations
show ntp status
show registry
show sntp
sntp broadcast client
sntp server
time-range

Basic System Management Commands


This chapter describes the function and syntax of the commands used to perform basic system management tasks, such as naming the router and setting time services. For more information about these commands, refer to the corresponding chapter of the Cisco IOS Configuration Fundamentals Command Reference.

absolute

To specify an absolute time when a time range is in effect, use the absolute time-range configuration command. To remove the time limitation, use the no form of this command.

absolute [start time date] [end time date]
no absolute

Syntax Description

start time date

(Optional) Absolute time and date that the permit or deny statement of the associated access list starts going into effect. The time is expressed in 24-hour notation, in the form of hours:minutes. For example, 8:00 is 8:00 a.m. and 20:00 is 8:00 p.m. The date is expressed in the format day month year. The minimum start is 00:00 1 January 1993. If no start time and date are specified, the permit or deny statement is in effect immediately.

end time date

(Optional) Absolute time and date that the permit or deny statement of the associated access list is no longer in effect. Same time and date format as described for the start keyword. The end time and date must be after the start time and date. The maximum end time is 23:59 31 December 2035. If no end time and date are specified, the associated permit or deny statement is in effect indefinitely.

alias

To create a command alias, use the alias global configuration command. To delete all aliases in a command mode or to delete a specific alias, and to revert to the original command syntax, use the no form of this command.

alias mode command-alias original-command
no alias mode [command-alias]

Syntax Description

mode

Command mode of the original and alias commands.

command-alias

Command alias.

original-command

Original command syntax.

buffers

To make adjustments to initial buffer pool settings and to the limits at which temporary buffers are created and destroyed, use the buffers global configuration command. To return the buffers to their default size, use the no form of this command.

buffers {small | middle | big | verybig | large | huge | type number} {permanent | max-free | min-free | initial} number-of-buffers
no buffers {small | middle | big | verybig | large | huge | type number} {permanent | max-free | min-free | initial} number-of-buffers

Syntax Description

small

Buffer size of this public buffer pool is 104 bytes.

middle

Buffer size of this public buffer pool is 600 bytes.

big

Buffer size of this public buffer pool is 1524 bytes.

verybig

Buffer size of this public buffer pool is 4520 bytes.

large

Buffer size of this public buffer pool is 5024 bytes.

huge

Default buffer size of this public buffer pool is 18024 bytes. This value can be configured with the buffers huge size command.

type number

Interface type and interface number of the interface buffer pool. The type value cannot be fddi.

permanent

Number of permanent buffers that the system tries to create and keep. Permanent buffers are normally not trimmed by the system.

max-free

Maximum number of free or unallocated buffers in a buffer pool. A maximum of 20,480 small buffers can be constructed in the pool.

min-free

Minimum number of free or unallocated buffers in a buffer pool.

initial

Number of additional temporary buffers that are to be allocated when the system is reloaded. This keyword can be used to ensure that the system has necessary buffers immediately after reloading in a high-traffic environment.

number-of-buffers

Number of buffers to be allocated.

buffers huge size

To dynamically resize all huge buffers to the value you specify, use the buffers huge size global configuration command. To restore the default buffer values, use the no form of this command.

buffers huge size number-of-bytes
no buffers huge size number-of-bytes

Syntax Description

number-of-bytes

Huge buffer size (in bytes).

calendar set

To manually set the hardware clock (calendar), use one of the formats of the calendar set EXEC command.

calendar set hh:mm:ss day month year
calendar set hh:mm:ss month day year

Syntax Description

hh:mm:ss

Current time in hours (using 24-hour notation), minutes, and seconds.

day

Current day (by date) in the month.

month

Current month (by name).

year

Current year (no abbreviation).

clock calendar-valid

To configure a system as an authoritative time source for a network based on its hardware clock (calendar), use the clock calendar-valid global configuration command. To specify that the hardware clock is not an authoritative time source, use the no form of this command.

clock calendar-valid
no clock calendar-valid

Syntax Description

This command has no arguments or keywords.

clock read-calendar

To manually read the hardware clock (calendar) settings into the software clock, use the clock read-calendar EXEC command.

clock read-calendar

Syntax Description

This command has no arguments or keywords.

clock set

To manually set the system software clock, use one of the formats of the clock set EXEC command.

clock set hh:mm:ss day month year
clock set hh:mm:ss month day year

Syntax Description

hh:mm:ss

Current time in hours (military format), minutes, and seconds.

day

Current day (by date) in the month.

month

Current month (by name).

year

Current year (no abbreviation).

clock summer-time

To configure the system to automatically switch to summer time (daylight saving time), use one of the formats of the clock summer-time global configuration command. To configure the Cisco IOS software not to automatically switch to summer time, use the no form of this command.

clock summer-time zone recurring [week day month hh:mm week day month hh:mm [offset]]
clock summer-time zone date date month year hh:mm date month year hh:mm [offset]
clock summer-time zone date month date year hh:mm month date year hh:mm [offset]
no clock summer-time

Syntax Description

zone

Name of the time zone (for example, "PDT" for Pacific Daylight Time) to be displayed when summer time is in effect.

recurring

Indicates that summer time should start and end on the corresponding specified days every year.

date

Indicates that summer time should start on the first specific date listed in the command and end on the second specific date in the command.

week

(Optional) Week of the month (1 to 5 or last).

day

(Optional) Day of the week (Sunday, Monday, and so on).

date

Date of the month (1 to 31).

month

(Optional) Month (January, February, and so on).

year

Year (1993 to 2035).

hh:mm

(Optional) Time (military format) in hours and minutes.

offset

(Optional) Number of minutes to add during summer time (default is 60).

clock timezone

To set the time zone for display purposes, use the clock timezone global configuration command. To set the time to Coordinated Universal Time (UTC), use the no form of this command.

clock timezone zone hours-offset [minutes-offset]
no clock timezone

Syntax Description

zone

Name of the time zone to be displayed when standard time is in effect.

hours-offset

Hours difference from UTC.

minutes-offset

(Optional) Minutes difference from UTC.

clock update-calendar

To perform a one-time update of the hardware clock (calendar) from the software clock, use the clock update-calendar in user or privileged EXEC mode.

clock update-calendar

Syntax Description

This command has no arguments or keywords.

downward-compatible-config

To generate a configuration that is compatible with an earlier Cisco IOS release, use the downward-compatible-config global configuration command. To remove this feature, use the no form of this command.

downward-compatible-config version
no downward-compatible-config

Syntax Description

version

Cisco IOS release number, not earlier than Release 10.2.

hostname

To specify or modify the host name for the network server, use the hostname global configuration command.

hostname name

Syntax Description

name

New host name for the network server.

ip bootp server

To access the BOOTP service available from hosts on the network, use the ip bootp server global configuration command. To disable these services, use the no form of the command.

ip bootp server
no ip bootp server

Syntax Description

This command has no arguments or keywords.

ip finger

To configure a system to accept Finger protocol requests (defined in RFC 742), use the ip finger global configuration command. To disable this service, use the no form of this command.

ip finger [rfc-compliant]
no ip finger

Syntax Description

rfc-compliant

(Optional) Configures the system to wait for "Return" or "/W" input when processing Finger requests. This keyword should not be used for those systems.

ip telnet source-interface

To allow a user to select an address of an interface as the source address for Telnet connections, use the ip telnet source-interface global configuration command. To reset the source address to the default for each connection, use the no form of this command.

ip telnet source-interface interface
no ip telnet source-interface

Syntax Description

interface

The interface whose address is to be used as the source for Telnet connections.

ip tftp source-interface

To allow a user to select the interface whose address will be used as the source address for TFTP connections, use the ip tftp source-interface global configuration command.

ip tftp source-interface interface
no ip tftp source-interface

Syntax Description

interface

The interface whose address is to be used as the source for TFTP connections.

load-interval

To change the length of time for which data is used to compute load statistics, use the load-interval interface configuration command. To revert to the default setting, use the no form of this command.

load-interval seconds
no load-interval seconds

Syntax Description

seconds

Length of time for which data is used to compute load statistics. A value that is a multiple of 30, from 30 to 600 (30, 60, 90, 120, and so on).

ntp access-group

To control access to the Network Time Protocol (NTP) services on the system, use the ntp access-group global configuration command. To remove access control to the NTP services, use the no form of this command.

ntp access-group {query-only | serve-only | serve | peer} access-list-number
no ntp access-group {query-only | serve-only | serve | peer}

Syntax Description

query-only

Allows only NTP control queries. See RFC 1305 (NTP version 3).

serve-only

Allows only time requests.

serve

Allows time requests and NTP control queries, but does not allow the system to synchronize to the remote system.

peer

Allows time requests and NTP control queries and allows the system to synchronize to the remote system.

access-list-number

Number (from 1 to 99) of a standard IP access list.

ntp authenticate

To enable Network Time Protocol (NTP) authentication, use the ntp authenticate global configuration command. To disable the feature, use the no form of this command.

ntp authenticate
no ntp authenticate

Syntax Description

This command has no arguments or keywords.

ntp authentication-key

To define an authentication key for Network Time Protocol (NTP), use the ntp authentication-key global configuration command. To remove the authentication key for NTP, use the no form of this command.

ntp authentication-key number md5 value
no ntp authentication-key number

Syntax Description

number

Key number (from 1 to 4294967295).

md5

Authentication key. Message authentication support is provided using the message digest algorithm 5 (MD5) algorithm. The key type md5 is currently the only key type supported.

value

Key value (an arbitrary string of up to eight characters).

ntp broadcast

To configure the system to send Network Time Protocol (NTP) broadcast packets on a specified interface, use the ntp broadcast interface configuration command. To disable this capability, use the no form of this command.

ntp broadcast [version number]
no ntp broadcast

Syntax Description

version number

(Optional) Number from 1 to 3 indicating the NTP version.

ntp broadcast client

To configure the system to receive Network Time Protocol (NTP) broadcast packets on a specified interface, use the ntp broadcast client interface configuration command. To disable this capability, use the no form of this command.

ntp broadcast client
no ntp broadcast client

Syntax Description

This command has no arguments or keywords.

ntp broadcastdelay

To set the estimated round-trip delay between the Cisco IOS software and a Network Time Protocol (NTP) broadcast server, use the ntp broadcastdelay global configuration command. To revert to the default value, use the no form of this command.

ntp broadcastdelay microseconds
no ntp broadcastdelay

Syntax Description

microseconds

Estimated round-trip time (in microseconds) for NTP broadcasts. The range is from 1 to 999999.

ntp clock-period


Caution   Do not enter this command; it is documented for informational purposes only. The system automatically generates this command as Network Time Protocol (NTP) determines the clock error and compensates.

As NTP compensates for the error in the software clock, it keeps track of the correction factor for this error. The system automatically saves this value into the system configuration using the ntp clock-period global configuration command. To revert to the default, use the no form of this command.

ntp clock-period value
no ntp clock-period

Syntax Description

value

Amount to add to the software clock for each clock hardware tick (this value is multiplied by 2-32).

ntp disable

To prevent an interface from receiving Network Time Protocol (NTP) packets, use the ntp disable interface configuration command. To enable receipt of NTP packets on an interface, use the no form of this command.

ntp disable
no ntp disable

Syntax Description

This command has no arguments or keywords.

ntp master

To configure the Cisco IOS software as a Network Time Protocol (NTP) master clock to which peers synchronize themselves when an external NTP source is not available, use the ntp master global configuration command. To disable the master clock function, use the no form of this command.

ntp master [stratum]
no ntp master [stratum]

Caution   Use this command with caution. It is very easy to override valid time sources using this command, especially if a low stratum number is configured. Configuring multiple machines in the same network with the ntp master command can cause instability in keeping time if the machines do not agree on the time.

Syntax Description

stratum

(Optional) Number from 1 to 15. Indicates the NTP stratum number that the system will claim.

ntp peer

To configure the software clock to synchronize a peer or to be synchronized by a peer, use the ntp peer global configuration command. To disable this capability, use the no form of this command.

ntp peer ip-address [version number] [key keyid] [source interface] [prefer]
no ntp peer ip-address

Syntax Description

ip-address

IP address of the peer providing, or being provided, the clock synchronization.

version

(Optional) Defines the Network Time Protocol (NTP) version number.

number

(Optional) NTP version number (1 to 3).

key

(Optional) Defines the authentication key.

keyid

(Optional) Authentication key to use when sending packets to this peer.

source

(Optional) Names the interface.

interface

(Optional) Name of the interface from which to pick the IP source address.

prefer

(Optional) Makes this peer the preferred peer that provides synchronization.

ntp refclock

To configure an external clock source for use with Network Time Protocol (NTP) services, use the ntp refclock command in line configuration mode. To disable support of the external time source, use the no form of this command.

ntp refclock {trimble | telecom-solutions} pps {cts | ri | none} [inverted] [pps-offset number] [stratum number] [timestamp-offset number]
no ntp refclock

Syntax Description

trimble

Enables the reference clock driver for the Trimble Palisade NTP Synchronization Kit (Cisco 7200 series routers only).

telecom-solutions

Enables the reference clock driver for a Telecom Solutions GPS device.

pps

Pulse per second (PPS) signal line. Indicate PPS pulse reference clock support. Choices are cts, ri, or none.

cts

Pulse per second on CTS.

ri

Pulse per second on RI.

none

No PPS signal available.

inverted

(Optional) PPS signal is inverted.

pps-offset number

(Optional) Offset of PPS pulse. The number is the offset (in milliseconds).

stratum number

(Optional) Number from 0 to 14. Indicates the NTP stratum number that the system will claim.

timestamp-offset number

(Optional) Offset of time stamp. The number is the offset (in milliseconds).

ntp server

To allow the software clock to be synchronized by a Network Time Protocol (NTP) time server, use the ntp server global configuration command. To disable this capability, use the no form of this command.

ntp server ip-address [version number] [key keyid] [source interface] [prefer]
no ntp server ip-address

Syntax Description

ip-address

IP address of the time server providing the clock synchronization.

version

(Optional) Defines the NTP version number.

number

(Optional) NTP version number (1 to 3).

key

(Optional) Defines the authentication key.

keyid

(Optional) Authentication key to use when sending packets to this peer.

source

(Optional) Identifies the interface from which to pick the IP source address.

interface

(Optional) Name of the interface from which to pick the IP source address.

prefer

(Optional) Specifies that the server referenced in this command is preferred over other configured NTP servers.

ntp source

To use a particular source address in Network Time Protocol (NTP) packets, use the ntp source global configuration command. To remove the specified source address, use the no form of this command.

ntp source type number
no ntp source

Syntax Description

type

Type of interface.

number

Number of the interface.

ntp trusted-key

To authenticate the identity of a system to which Network Time Protocol (NTP) will synchronize, use the ntp trusted-key global configuration command. To disable authentication of the identity of the system, use the no form of this command.

ntp trusted-key key-number
no ntp trusted-key key-number

Syntax Description

key-number

Key number of authentication key to be trusted.

ntp update-calendar

To periodically update the hardware clock (calendar) from a Network Time Protocol (NTP) time source, use the ntp update-calendar global configuration command. To disable the periodic updates, use the no form of this command.

ntp update-calendar
no ntp update-calendar

Syntax Description

This command has no arguments or keywords.

periodic

To specify a recurring (weekly) time range for functions that support the time-range feature, use the periodic time-range configuration command. To remove the time limitation, use the no form of this command.

periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm
no periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm

Syntax Description

days-of-the-week

The first occurrence of this argument is the starting day or day of the week that the associated time range is in effect. The second occurrence is the ending day or day of the week the associated statement is in effect.

This argument can be any single day or combinations of days: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday. Other possible values are:

  • daily—Monday through Sunday
  • weekdays—Monday through Friday
  • weekend—Saturday and Sunday

If the ending days of the week are the same as the starting days of the week, they can be omitted.

hh:mm

The first occurrence of this argument is the starting hours:minutes that the associated time range is in effect. The second occurrence is the ending hours:minutes the associated statement is in effect.

The hours:minutes are expressed in a 24-hour clock. For example, 8:00 is 8:00 a.m. and 20:00 is 8:00 p.m.

to

Entry of the to keyword is required to complete the range "from start-time to end-time."

prompt

To customize the CLI prompt, use the prompt global configuration command. To revert to the default prompt, use the no form of this command.

prompt string
no prompt [string]

Syntax Description

string

Text that will be diplayed on screen as the CLI prompt, including any desired prompt variables.

scheduler allocate

To guarantee CPU time for processes, use the scheduler allocate global configuration command on the Cisco 7200 series and Cisco 7500 series routers. To restore the default, use the no form of this command.

scheduler allocate interrupt-time process-time
no scheduler allocate

Syntax Description

interrupt-time

Integer (in microseconds) that limits the maximum number of microseconds to spend on fast switching within any one network interrupt context. The range is from 400 to 60000 microseconds. The default is 4000 microseconds.

process-time

Integer (in microseconds) that guarantees the minimum number of microseconds to spend at the process level when network interrupts are disabled. The range is from 100 to 4000 microseconds. The default is 200 microseconds.

scheduler interval

To control the maximum amount of time that can elapse without running system processes, use the scheduler interval global configuration command. To restore the default, use the no form of this command.

scheduler interval milliseconds
no scheduler interval

Syntax Description

milliseconds

Integer that specifies the interval (in milliseconds). The minimum interval that you can specify is 500 milliseconds; there is no maximum value.

service decimal-tty

To specify that line numbers be displayed and interpreted as decimal numbers rather than octal numbers, use the service decimal-tty global configuration command. To restore the default, use the no form of this command.

service decimal-tty
no service decimal-tty

Syntax Description

This command has no arguments or keywords.

service exec-wait

To delay the startup of the EXEC on noisy lines, use the service exec-wait global configuration command. To disable the delay function, use the no form of this command.

service exec-wait
no service exec-wait

Syntax Description

This command has no arguments or keywords.

service finger

The service finger command has been replaced by the ip finger command. However, the service finger and no service finger commands continue to function to maintain backward compatibility with older versions of Cisco IOS software. Support for this command may be removed in a future release. See the description of the ip finger command in this chapter for more information.

service hide-telnet-address

To hide addresses while trying to establish a Telnet session, use the service hide-telnet-address global configuration command. To remove this service, use the no form of this command.

service hide-telnet-address
no service hide-telnet-address

Syntax Description

This command has no arguments or keywords.

service nagle

To enable the Nagle congestion control algorithm, use the service nagle global configuration command. To to disable the algorithm, use the no form of this command.

service nagle
no service nagle

Syntax Description

This command has no arguments or keywords.

service prompt config

To display the configuration prompt (config), use the service prompt config global configuration command. To remove the configuration prompt, use the no form of this command.

service prompt config
no service prompt config

Syntax Description

This command has no arguments or keywords.

service tcp-small-servers

To access minor TCP/IP services available from hosts on the network, use the service tcp-small-servers global configuration command. To disable these services, use the no form of the command.

service tcp-small-servers
no service tcp-small-servers

Syntax Description

This command has no arguments or keywords.

service telnet-zero-idle

To set the TCP window to zero (0) when the Telnet connection is idle, use the service telnet-zero-idle global configuration command. To disable this service, use the no form of this command.

service telnet-zero-idle
no service telnet-zero-idle

Syntax Description

This command has no arguments or keywords.

service udp-small-servers

To access minor User Datagram Protocol (UDP) services available from hosts on the network, use the service udp-small-servers global configuration command. To disable these services, use the no form of this command.

service udp-small-servers
no service udp-small-servers

Syntax Description

This command has no arguments or keywords.

show aliases

To display all alias commands, or the alias commands in a specified mode, use the show aliases EXEC command.

show aliases [mode]

Syntax Description

mode

(Optional) Command mode.

show buffers

To display statistics for the buffer pools on the network server, use the show buffers EXEC command.

show buffers [address hex-addr | [all | assigned | failures | free | old [dump | header | packet]]
| input-interface interface-type identifier | pool pool-name]

Syntax Description

address

(Optional) Displays buffers at a specified address.

hex-addr

Address (in hexadecimal notation) of the buffer to display.

all

(Optional) Displays all buffers.

assigned

(Optional) Displays the buffers in use.

failures

(Optional) Displays buffer allocation failures.

free

(Optional) Displays the buffers available for use.

old

(Optional) Displays buffers older than one minute.

dump

(Optional) Displays the buffer header and all data in the display.

header

(Optional) Displays the buffer header only in the display.

packet

(Optional) Displays the buffer header and packet data in the display.

input-interface

(Optional) Displays interface pool information. If the specified interface-type argument has its own buffer pool, displays information for that pool.

interface-type

Value of interface-type can be ethernet, fastethernet, loopback, serial, or null.

identifier

Identifier of the interface specified in interface-type argument.

pool

(Optional) Displays buffers in a specified buffer pool.

pool-name

Specifies the name of a buffer pool to use.

show calendar

To display the current time and date setting for the hardware clock, use the show calendar EXEC command:

show calendar

Syntax Description

This command has no arguments or keywords.

show clock

To display the time and date from the system software clock, use the show clock EXEC command.

show clock [detail]

Syntax Description

detail

(Optional) Indicates the clock source (NTP, VINES, hardware clock, and so on) and the current summer-time setting (if any).

show ntp associations

To show the status of Network Time Protocol (NTP) associations, use the show ntp associations EXEC command.

show ntp associations [detail]

Syntax Description

detail

(Optional) Displays detailed information about each NTP association.

show ntp status

To show the status of the Network Time Protocol (NTP), use the show ntp status EXEC command.

show ntp status

Syntax Description

This command has no arguments or keywords.

show registry

To show the function registry information, use the show registry EXEC command.

show registry [registry-name [registry-num]] [brief | statistics]

Syntax Description

registry-name

(Optional) Name of the registry to examine.

registry-num

(Optional) Number of the registry to examine.

brief

(Optional) Displays limited functions and services information.

statistics

(Optional) Displays function registry statistics.

show sntp

To show information about the Simple Network Time Protocol (SNTP), use the show sntp EXEC command on a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720, or Cisco 1750 router.

show sntp

Syntax Description

This command has no arguments or keywords.

sntp broadcast client

To use the Simple Network Time Protocol (SNTP) to accept Network Time Protocol (NTP) traffic from any broadcast server, use the sntp broadcast client global configuration command to configure a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720, or Cisco 1750 router. To prevent the router from accepting broadcast traffic, use the no form of this command.

sntp broadcast client
no sntp broadcast client

Syntax Description

This command has no arguments or keywords.

sntp server

To configure a Cisco 1003, Cisco 1004, Cisco 1005, Cisco 1600, Cisco 1720, Cisco 1750, or Cisco 800 router to use the Simple Network Time Protocol (SNTP) to request and accept Network Time Protocol (NTP) traffic from a stratum 1 time server, use the sntp server global configuration command. To remove a server from the list of NTP servers, use the no form of this command.

sntp server {address | hostname} [version number]
no sntp server {address | hostname}

Syntax Description

address

IP address of the time server.

hostname

Host name of the time server.

version number

(Optional) Version of NTP to use. The default is 1.

time-range

To enable time-range configuration mode and define time ranges for functions (such as extended access lists), use the time-range global configuration command. To remove the time limitation, use the no form of this command.

time-range time-range-name
no time-range time-range-name

Syntax Description

time-range-name

Desired name for the time range. The name cannot contain a space or quotation mark, and must begin with a letter.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Tue Jan 14 22:27:37 PST 2003
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.