Modem Management Commands

This chapter describes the function and displays the syntax for modem management commands. For more information about defaults and usage guidelines, see the corresponding chapter of the Dial Solutions Command Reference.

called-number

To assign a called party number to a pool of modems, use the called-number modem pool configuration command. Use the no form of this command to remove a number from a modem pool.

number	Called number for a modem pool.
max-conn number	(Optional) Maximum number of simultaneous connections allowed for the called party number.

called-number number [max-conn number]
no called-number number [max-conn number]

number

Called number for a modem pool.

max-conn number

(Optional) Maximum number of simultaneous connections allowed for the called party number.

clear counters (async)

To clear the counters of a specified asynchronous interface or specified asynchronous interface group, as displayed by the show interface async command, enter the clear counters (async) interface configuration command.

async	Clears the counters in a specified asynchronous interface.
async-interface-number	Required async interface number of the asynchronous interface that has been previously created with this number specification. The range is from 1 through 49.
group-async	Clears the counters in a specified asynchronous interface group.
group-async-interface-number	Required group-async interface number that has been previously created with this number specification. The range is from 0 through 49.

clear counters {async async-interface-number | group-async group-async-interface-number}

async

Clears the counters in a specified asynchronous interface.

async-interface-number

Required async interface number of the asynchronous interface that has been previously created with this number specification. The range is from 1 through 49.

group-async

Clears the counters in a specified asynchronous interface group.

group-async-interface-number

Required group-async interface number that has been previously created with this number specification. The range is from 0 through 49.

clear counters line

To clear line counters, use the clear counters line EXEC command.

type	Type of line you want to clear. Replace the type argument with one of the following: aux, console, tty, or vty.
number	Specifies the first line number to clear, which can be between 0 and 54.

clear counters line {type | number}

type

Type of line you want to clear. Replace the type argument with one of the following: aux, console, tty, or vty.

number

Specifies the first line number to clear, which can be between 0 and 54.

clear modem

To reset the hardware for one or more manageable modems on an access server or router, use the clear modem EXEC command.

slot/port-number	Clear the modem at the specified slot and modem port number. Remember to include the forward slash (/) when entering this variable. For example: 1/1. This variable can also be used with the subcommands clear modem at-mode and clear modem counters.
all	Clear all modems. This command disconnects any active calls.
group group-number	Clears the modem hardware for a group of modems. The modem group-number is the number of the group you have previously created.
at-mode slot/port-number	Tears down an AT directly connected session. The variable, slot/port-number, is required. This EXEC command clears an attention (AT) directly connected session to a manageable Microcom modem from a second Telnet session.

clear modem {slot/port-number | all | group group-number | at-mode slot/port-number |
group group-number}

slot/port-number

Clear the modem at the specified slot and modem port number. Remember to include the forward slash (/) when entering this variable. For example: 1/1. This variable can also be used with the subcommands clear modem at-mode and clear modem counters.

all

Clear all modems. This command disconnects any active calls.

group group-number

Clears the modem hardware for a group of modems. The modem group-number is the number of the group you have previously created.

at-mode slot/port-number

Tears down an AT directly connected session. The variable, slot/port-number, is required. This EXEC command clears an attention (AT) directly connected session to a manageable Microcom modem from a second Telnet session.

clear modem counters

To clear the statistical counters on one or more manageable modems installed in an access server, use the clear modem counters EXEC command.

slot/port-number	Clear the modem at the specified slot and modem port number. Remember to include the forward slash (/) when entering this variable. For example: 1/1. This variable can also be used with the subcommands clear modem at-mode and clear modem counters.
group [group-number]	(Optional) Clears the counter for one or all groups of modems. The subcommand, clear modem counters group, without the group-number clears counters in all modem groups. The optional modem group-number is the number of the group you have previously created. The Group number range is 1 through1002.

clear modem counters [slot/port-number | group [group-number]]

slot/port-number

Clear the modem at the specified slot and modem port number. Remember to include the forward slash (/) when entering this variable. For example: 1/1. This variable can also be used with the subcommands clear modem at-mode and clear modem counters.

group [group-number]

(Optional) Clears the counter for one or all groups of modems. The subcommand, clear modem counters group, without the group-number clears counters in all modem groups. The optional modem group-number is the number of the group you have previously created. The Group number range is 1 through1002.

clear modempool-counters

To clear the active or running counters associated with one or more modem pools, use the clear modempool-counters EXEC command. This command is used only with MICA digital modems.

name	(Optional) Modem pool name. If you do not include this option, all counters for all modem pools will be cleared.

clear modempool-counters [name]

name

(Optional) Modem pool name. If you do not include this option, all counters for all modem pools will be cleared.

copy modem

To copy modem firmware to integrated modems in an access server, use the copy modem EXEC command.

flash	Copies firmware from Flash memory to the modems.
tftp	Copies firmware from a local TFTP server on your network to the modems.
rcp	Copies firmware from a local rcp server on your network to the modems.

copy {flash | tftp | rcp} modem

flash

Copies firmware from Flash memory to the modems.

tftp

Copies firmware from a local TFTP server on your network to the modems.

rcp

Copies firmware from a local rcp server on your network to the modems.

modem answer-timeout

To set the amount of time that the Cisco IOS software waits for the Clear to Send (CTS) signal after raising the data terminal ready (DTR) signal in response to RING, use the modem answer-timeout line configuration command. Use the no form of this command to revert to the default value.

seconds	Specifies the timeout interval in seconds.

modem answer-timeout seconds
no modem answer-timeout

seconds

Specifies the timeout interval in seconds.

modem at-mode

To open a directly connected session and enter AT command mode, which is used for sending AT commands to Microcom manageable modems, use the modem at-mode EXEC command.

slot/port	Slot and modem port number. Remember to include the forward slash (/) when entering this variable.

modem at-mode slot/port

slot/port

Slot and modem port number. Remember to include the forward slash (/) when entering this variable.

modem at-mode-permit

To permit a Microcom modem to accept a directly connected session, use the modem at-mode-permit line configuration command. The no form of this command disables permission for modems to accept a direct connection.

modem at-mode-permit
no modem at-mode-permit

modem autoconfigure discovery

To configure a line to discover what kind of modem is connected to the router and to configure that modem automatically, use the modem autoconfigure discovery line configuration command. Use the no form of this command to disable this feature.

modem autoconfigure discovery
no modem autoconfigure discovery

modem autoconfigure type

To direct a line to attempt to configure the attached modem using the entry for modem-name, use the modem autoconfigure type line configuration command. Use the no form of this command to disable this feature.

modem-name	The name of the modem (such as Codex_3260).

modem autoconfigure type modem-name
no modem autoconfigure type

modem-name

The name of the modem (such as Codex_3260).

modem autotest

To automatically and periodically perform a modem diagnostics test for modems inside the access server or router, use the modem autotest global configuration command. Use the no form of this command to disable or turn off the modem autotest service.

error threshold	Maximum modem error threshold. When the system detects this many errors with the modems, the modem diagnostics test is automatically triggered. Specify a threshold count between 3 and 50.
minimum modem	Minimum number of modems that will remain untested and available to accept calls during each test cycle. You can specify between 5 and 48 modems. The default is 6 modems.
time hh:mm	Time you want the modem autotest to begin. You must use the military time convention and a required colon (:) between the hours and minutes variables for this feature. For example, 1:30 a.m. is issued as 01:30.
interval	(Optional) Long-range time variable used to set the modem autotest more than one day in advance. The range of hours is between 1 hour and 168 hours. For example if you want to run the test once per week, issue 168. There are 168 hours in one week.

modem autotest {error threshold | minimum modem | time hh:mm [interval]}
no modem autotest

error threshold

Maximum modem error threshold. When the system detects this many errors with the modems, the modem diagnostics test is automatically triggered. Specify a threshold count between 3 and 50.

minimum modem

Minimum number of modems that will remain untested and available to accept calls during each test cycle. You can specify between 5 and 48 modems. The default is 6 modems.

time hh:mm

Time you want the modem autotest to begin. You must use the military time convention and a required colon (:) between the hours and minutes variables for this feature. For example, 1:30 a.m. is issued as 01:30.

interval

(Optional) Long-range time variable used to set the modem autotest more than one day in advance. The range of hours is between 1 hour and 168 hours. For example if you want to run the test once per week, issue 168. There are 168 hours in one week.

modem bad

To remove an integrated modem from service and indicate it as suspected or proven to be inoperable, use the modem bad line configuration command. Use the no form of this command to restore a modem to service.

modem bad
no modem bad

modem buffer-size

To configure the size of the history event queue buffer for integrated modems installed in an access server or router, use the modem buffer-size command.

number	Defined number of modem events that each manageable modem is able to store.

modem buffer-size number

number

Defined number of modem events that each manageable modem is able to store.

modem busyout

To gracefully disable a modem from dialing or answering calls, use the modem busyout line configuration command. Use the no form of this command to re-enable a modem.

modem busyout
no modem busyout

modem country mica

To configure the modem country code for a bank of MICA modems, use the modem country mica global configuration command. Use the no form of this command to remove a country code from service.

country	Specifies a type of country code. Replace the argument country with one of the following supported country names: · australia · austria · belgium · china · cyprus · czech-republic (Czech/Slovak Republic) · denmark · e1-default (Default E1, A Law)
	· finland · france · germany · hong-kong · india · ireland · israel · italy · japan · malaysia · netherlands · new-zealand
	· norway · poland · portugal · russia · singapore · south-africa · spain · sweden · switzerland · t1-default (Default T1, u Law) · taiwan · thailand · turkey · united-kingdom · usa

modem country mica country
no modem country mica country

country

Specifies a type of country code. Replace the argument country with one of the following supported country names:

· australia

· austria

· belgium

· china

· cyprus

· czech-republic (Czech/Slovak Republic)

· denmark

· e1-default (Default E1, A Law)

· finland

· france

· germany

· hong-kong

· india

· ireland

· israel

· italy

· japan

· malaysia

· netherlands

· new-zealand

· norway

· poland

· portugal

· russia

· singapore

· south-africa

· spain

· sweden

· switzerland

· t1-default (Default T1, u Law)

· taiwan

· thailand

· turkey

· united-kingdom

· usa

modem country microcom_hdms

To configure the modem country code for a bank of Microcom modems, use the modem country microcom_hdms global configuration command. Use the no form of this command to remove a country code from service.

country	Specifies a type of country code. Replace the argument country with one of the following supported country names: · argentina · australia · austria · belgium · brazil · canada · chile · china · columbia · czech-republic (Czech/Slovak Republic) · denmark · finland · france · germany · greece · hong-kong · hungary · india · indonesia
	· finland · israel · italy · japan · korea · malaysia · mexico · netherlands · new-zealand
	· norway · peru · philippines · poland · portugal · saudi-arabia · singapore · south-africa · spain · sweden · switzerland · taiwan · thailand · united-kingdom · usa

modem country microcom_hdms country
no modem country microcom_hdms country

country

Specifies a type of country code. Replace the argument country with one of the following supported country names:

· argentina

· australia

· austria

· belgium

· brazil

· canada

· chile

· china

· columbia

· czech-republic (Czech/Slovak Republic)

· denmark

· finland

· france

· germany

· greece

· hong-kong

· hungary

· india

· indonesia

· finland

· israel

· italy

· japan

· korea

· malaysia

· mexico

· netherlands

· new-zealand

· norway

· peru

· philippines

· poland

· portugal

· saudi-arabia

· singapore

· south-africa

· spain

· sweden

· switzerland

· taiwan

· thailand

· united-kingdom

· usa

modem hold-reset

To reset and isolate integrated modems for extensive troubleshooting, use the modem hold-reset line configuration command. Use the no form of this command to restart a modem.

modem hold-reset
no modem hold-reset

modem poll retry

To set the maximum number of polling attempts used to retrieve performance statistics from a modem installed in an access server or router, use the modem poll retry global configuration command.

number	Maximum number of polling attempts. The configuration range is from 0 to 10 attempts.

modem poll retry number

number

Maximum number of polling attempts. The configuration range is from 0 to 10 attempts.

modem poll time

To set the time interval between modem polls, which are used to periodically retrieved and report modem statistics, use the modem poll time global configuration command. To restore the 12-second default setting, use the no form of this command.

seconds	Number of seconds between polls. The configuration range is from 2 to 120 seconds.

modem poll time seconds
no modem poll time seconds

seconds

Number of seconds between polls. The configuration range is from 2 to 120 seconds.

modem recovery action

To specify the modem recovery mode, enter the modem recovery action global configuration command. Enter the no form of this command to turn off this feature.

disable	Mark the modem bad.
download	Recover by firmware download. Sets the modem into a recovery pending state, thus, stopping the modem from accepting new calls.
none	Do not try to recover. Ignore the recovery threshold and just keep going.

modem recovery action {disable | download | none}
no modem recovery action

disable

Mark the modem bad.

download

Recover by firmware download. Sets the modem into a recovery pending state, thus, stopping the modem from accepting new calls.

none

Do not try to recover. Ignore the recovery threshold and just keep going.

modem recovery maintenance

To specify the modem maintenance recovery behavior, enter the modem recovery maintenance global configuration command. Enter the no form of this command to turn off this behavior.

action	Mode of recovery. The default is set to reschedule.
disable	Mark the modem bad. Mark the originally faulty modem as bad and return all other modems back into service.
drop-call	Force firmware download by dropping holding calls. This forces the recovery by dropping any active calls remaining on modems within the module.
reschedule	Reschedule firmware download to next maintenance time. Leave the originally faulty modem as needing recovery and return all other modems back into service. Recovery will be attempted again on the following day. The default is set to reschedule.
max-download number	Maximum simultaneous recovery downloads. You must choose one number between 1 and 30. A range of values is not supported.
schedule	Scheduling method for modem recovery. Determines if the system should attempt module recovery as soon as a problem is found or wait for the maintenance window.
immediate	Immediately attempt module recovery.
pending	Delay recovery until maintenance time.
time hh:mm	Time of day for scheduled modem recovery. This is the actual time of day when the modem recovery maintenance process wakes up and starts recovering MICA modems. The default time is 3:00 AM.
window minutes	Amount of time for normal recovery to take place. This is the delay timer in minutes, which is between 0 and 360.

modem recovery maintenance {action {disable | drop-call | reschedule} | max-download number | schedule {immediate | pending} | time hh:mm | window minutes}
no modem recovery maintenance

action

Mode of recovery. The default is set to reschedule.

disable

Mark the modem bad. Mark the originally faulty modem as bad and return all other modems back into service.

drop-call

Force firmware download by dropping holding calls. This forces the recovery by dropping any active calls remaining on modems within the module.

reschedule

Reschedule firmware download to next maintenance time. Leave the originally faulty modem as needing recovery and return all other modems back into service. Recovery will be attempted again on the following day. The default is set to reschedule.

max-download number

Maximum simultaneous recovery downloads. You must choose one number between 1 and 30. A range of values is not supported.

schedule

Scheduling method for modem recovery. Determines if the system should attempt module recovery as soon as a problem is found or wait for the maintenance window.

immediate

Immediately attempt module recovery.

pending

Delay recovery until maintenance time.

time hh:mm

Time of day for scheduled modem recovery. This is the actual time of day when the modem recovery maintenance process wakes up and starts recovering MICA modems. The default time is 3:00 AM.

window minutes

Amount of time for normal recovery to take place. This is the delay timer in minutes, which is between 0 and 360.

modem recovery threshold

To specify the threshold, which starts the modem recovery process, enter the modem recovery threshold global configuration command. Enter the no form of this command to disable the threshold value.

number	Number of consecutive call attempts, which fail to train up, before the modem is deemed faulty. Choose between 1 and 1000.

modem recovery threshold number
no modem recovery threshold

number

Number of consecutive call attempts, which fail to train up, before the modem is deemed faulty. Choose between 1 and 1000.

modem recovery-time

To set the maximum amount of time the call-switching module waits for a local modem to respond to a request before it is considered locked in a suspended state, use the modem recovery-time global configuration command. The no form of this command sets a 5-minute response time, which is the default setting.

minutes	Maximum amount of time local modems wait for a response.

modem recovery-time minutes
no modem recovery-time

minutes

Maximum amount of time local modems wait for a response.

modem shutdown

To abruptly shut down an active or idle modem installed in an access server or router, use the modem shutdown line configuration command. Use the no form of this command to take the modem out of a shutdown state and place it back in service.

modem shutdown
no modem shutdown

modem startup-test

To perform diagnostic testing on each integrated modem during the rebooting process, use the modem startup-test global configuration command. Use the no form of this command to disable startup testing.

modem startup-test
no modem startup-test

modem status-poll

To poll for modem statistics through a modem's out-of-band feature, use the modem status-poll line configuration command. Use the no form of this command to disable status polling through the out-of-band feature for a specified modem.

modem status-poll
no modem status-poll

modemcap edit

To change a modem value that was returned from the show modemcap command, use the modemcap edit global configuration command.

modem-name	Name of the modem whose values are being edited.
attribute	Modem capability, or attribute, as defined by the show modemcap command.
value	The AT command equivalent (such as &F).

modemcap edit modem-name attribute value

modem-name

Name of the modem whose values are being edited.

attribute

Modem capability, or attribute, as defined by the show modemcap command.

value

The AT command equivalent (such as &F).

modemcap entry

To store and compress information about the capability of a specified modem, use the modemcap entry global configuration command. Use the no form of this command to disable this feature.

modem-type	Type of supported modem.

modemcap entry modem-type

modem-type

Type of supported modem.

modem-pool

To create a new modem pool or to specify an existing modem pool, use the modem-pool global configuration command. Use the no form of this command to delete a modem pool from the access server's configuration.

name	Specifies the name of a modem pool.

modem-pool name
no modem-pool name

name

Specifies the name of a modem pool.

pool-range

To assign a range of modems to a modem pool, use the pool-range modem-pool configuration command.

number-number	Assigns a range of TTY lines, which correspond to ranges of modems, to a modem pool. A dash (-) is required between the two modem numbers. The range of modems you can choose from is equivalent to the number of modems in your access server that are not currently associated with another modem pool.

pool-range number-number (Cisco AS5200 and Cisco AS5300)

number-number

Assigns a range of TTY lines, which correspond to ranges of modems, to a modem pool. A dash (-) is required between the two modem numbers. The range of modems you can choose from is equivalent to the number of modems in your access server that are not currently associated with another modem pool.

show modem

To display a high-level performance report for all the modems or a single modem inside an access server or router, use the show modem EXEC command.

slot/port	(Optional) Specifies the location of a slot and modem port. Remember to include the forward slash (/) when entering this variable.
group number	(Optional) Specifies a modem group to which a specified modem belongs. The group number range is between 1 and 200.

show modem [slot/port | group number] (Cisco AS5200, CiscoAS5300)

slot/port

(Optional) Specifies the location of a slot and modem port. Remember to include the forward slash (/) when entering this variable.

group number

(Optional) Specifies a modem group to which a specified modem belongs. The group number range is between 1 and 200.

show modem at-mode

To display a list of the manageable Microcom modems that have open AT sessions and a list of users logged in to those sessions, use the show modem at-mode EXEC command.

show modem at-mode

show modem call-stats

To display the local disconnect reasons for all modems inside an access server or router, use the show modem call-stats EXEC command.

show modem call-stats [slot]

slot

(Optional) Specifies the slot number, which limits the display output to a particular range of modems in the system.

show modem configuration

To display the current modem configuration for digital MICA modems loaded inside an access server or router, use the show modem configuration EXEC command.

show modem configuration [slot/port]

slot/port

(Optional) Specifies the location of a slot and modem port. If this number is not specified, statistics for all connected modems are displayed. Remember to include the forward slash (/) when entering this variable.

show modem connect-speeds

To display connection speed statistics for all the modems running in an access server or router, use the show modem connect-speeds EXEC command.

show modem connect-speeds [max-speed [slot]]

max-speed

(Optional) Maximum speed you want displayed in the shifting speed window. You can specify from 12,000 to 56,000 bps.

slot

(Optional) Specifies the slot number, which limits the display output to a particular range of modems in the system.

show modem cookie

To display information about the modem cookie, use the show modem cookie EXEC command.

show modem cookie

show modem csm

To display the internal status of the call switching module for modems inside access servers or routers, use the show modem csm EXEC command.

show modem csm [slot/port | group number]

slot/port

(Optional) Specifies the location of a slot and modem port. If this number is not specified, statistics for all connected modems are displayed. Remember to include the forward slash (/) when entering this variable.

group number

(Optional) Specifies the location of a specific group of modems. If this number is not specified, statistics for all modems in the access server are displayed. The group number range is between 1 and 200.

show modem log

To display the modem history event status performed on a manageable modem or group of modems, use the show modem log EXEC command.

show modem log [ slot/port | group number]

slot/port

(Optional) Specifies the location of a slot and modem port. If this number is not specified, statistics for all connected modems are displayed. Remember to include the forward slash (/) when entering this variable.

group number

(Optional) Specifies the location of a specific group of modems. If this number is not specified, statistics for all modems in the access server are displayed. The group number range is between 1 and 200.

show modem mapping

To display a snapshot of all the firmware versions running on all the modems in the access server, use the show modem mapping EXEC command. This command also shows the source location of each version of firmware (for example, running out of Flash, boot Flash, or bundled with Cisco IOS software).

show modem mapping

show modem mica

To display information about MICA digital modems, use the show modem mica EXEC command.

show modem mica {slot/port | all | slot [number]}

slot/port

Specifies the display for a single modem in a MICA digital modem board.

all

Displays output for all the MICA modems in the system.

slot number

Displays output for a particular slot, which is mainly used for debugging purposes. The optional number variable allows you to specify a slot number.

show modem operational-status

To display the current modem operational status for MICA digital modems loaded inside an access server or router, use the show modem operational-status EXEC command.

show modem operational-status [slot/port]

slot/port

(Optional) Specifies the location of a slot and modem port. If this number is not specified, statistics for all connected modems are displayed. Remember to include the forward slash (/) when entering this variable.

show modem summary

To display a high-level report for all manageable modems dialing into and out of the network, use the show modem summary EXEC command.

show modem summary

show modem test

To display the modem test log, use the show modem test EXEC command.

show modem test

show modem version

To display version information about the modem firmware, controller and DSP code (for 56K modems only), and boot code, use the show modem version EXEC command.

show modem version

show modem-pool

To display the configuration and connection status for one or more modem pools, use the show modem-pool EXEC command.

show modem-pool [name]

name

(Optional) Modem pool name.

test modem back-to-back

To diagnose an integrated modem that may not be functioning properly, use the test modem back-to-back EXEC command.

test modem back-to-back first-slot/port second-slot/port

first-slot/port

Slot and modem number of the first test modem. Remember to include the forward slash (/) when entering this variable.

second-slot/port

Slot and modem number of the second test modem. Remember to include the forward slash (/) when entering this variable.

max-speed	(Optional) Maximum speed you want displayed in the shifting speed window. You can specify from 12,000 to 56,000 bps.
slot	(Optional) Specifies the slot number, which limits the display output to a particular range of modems in the system.

slot/port	Specifies the display for a single modem in a MICA digital modem board.
all	Displays output for all the MICA modems in the system.
slot number	Displays output for a particular slot, which is mainly used for debugging purposes. The optional number variable allows you to specify a slot number.

first-slot/port	Slot and modem number of the first test modem. Remember to include the forward slash (/) when entering this variable.
second-slot/port	Slot and modem number of the second test modem. Remember to include the forward slash (/) when entering this variable.

Table of Contents

Modem Management Commands