Cisco IOS Dial Technologies Command Reference, Release 12.3
Dial Technologies Commands: shutdown through X

Table Of Contents

shutdown (port)

shutdown (spe)

signaling-class cas

snapshot client

snapshot server

source-ip (VPDN)

source template

source vpdn-template

spe

spe call-record modem

spe country

spe download maintenance

spe log-size

spe recovery

start-character

start-chat

stop-character

subscriber access

subscriber authorization enable

tdm clock priority

tdm-group

template

terminate-from

test modem back-to-back

test port modem back-to-back

timeout absolute

timer

trunk group (global)

tunnel

virtual-profile if-needed

virtual-profile virtual-template

virtual-template

vpdn aaa attribute

vpdn aaa override-server

vpdn aaa untagged

vpdn authen-before-forward

vpdn authorize directed-request

vpdn authorize domain

vpdn domain-delimiter

vpdn enable

vpdn group

vpdn history failure

vpdn incoming

vpdn ip udp ignore checksum

vpdn logging

vpdn multihop

vpdn outgoing

vpdn pmtu

vpdn profile

vpdn redirect identifier

vpdn redirect attempts

vpdn redirect identifier

vpdn redirect source

vpdn search-order

vpdn session-limit

vpdn softshut

vpdn source-ip

vpdn-group

vpdn-template

vpn

vty-async

vty-async dynamic-routing

vty-async header-compression

vty-async ipx ppp-client loopback

vty-async keepalive

vty-async mtu

vty-async ppp authentication

vty-async ppp use-tacacs

vty-async virtual-template

x25 aodi

x25 map ppp


shutdown (port)

To disable a port, use the shutdown command in port configuration mode. To change the administrative state of a port from out-of-service to in-service, use the no form of this command.

shutdown

no shutdown

Syntax Description

This command has no arguments or keywords.

Defaults

Port is enabled.

Command Modes

Port configuration

Command History

Release
Modification

12.1(1)XD

This command was introduced on the Cisco AS5400.

12.1(3)T

This command was implemented on the Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.


Usage Guidelines

The shutdown command disables a port.


Note The shutdown command is similar to the modem shutdown MICA technologies modem command.


Examples

The following example disables ports 1 to 18 and then reenables them:

router(config)# port 1/1 1/18
router(config-port)# shutdown
router(config-port)# no shutdown

Related Commands

Command
Description

busyout (port)

Disables a port by causing the system to wait for the active services on the port to terminate.

clear port

Resets the NextPort port and clears any active call.

clear spe

Reboots all specified SPEs.

modem shutdown

Abruptly shuts down an active or idle modem installed in an access server or router.

show spe

Displays history statistics of all SPEs, a specified SPE, or the specified range of SPEs.


shutdown (spe)

To take a service processing element (SPE) out of service, use the shutdown command in SPE configuration mode. To change the administrative state of this SPE from down to up, use the no form of this command.

shutdown

no shutdown

Syntax Description

This command has no arguments or keywords.

Defaults

SPE is in service.

Command Modes

SPE configuration

Command History

Release
Modification

12.1(1)XD

This command was introduced on the Cisco AS5400.

12.1(3)T

This command was implemented on the Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.


Examples

The following example disables SPE ports 1 to 18 and then reenables them:

Router(config)# spe 1/1 1/18
Router(config-spe)# shutdown
Router(config-spe)# no shutdown

Related Commands

Command
Description

busyout (port)

Disables a port by causing the system to wait for the active services on the port to terminate.

clear spe

Reboots all specified SPEs.

show spe

Displays history statistics of all SPEs, a specified SPE, or the specified range of SPEs.


signaling-class cas

To define a signaling class with a template formed by directives guiding the Call Service Module (CSM) to process the digit sequence, use the signaling-class cas command in global configuration mode. To remove the signaling class assignment, use the no form of this command.

signaling-class cas name

no signaling-class cas name

Syntax Description

name

The signaling class name, which specifies the template that processes the ANI/DNIS delimiter.


Defaults

No default behavior or values

Command Modes

Global configuration

Command History

Release
Modification

12.1(1)T

This command was introduced.


Usage Guidelines

The signaling class is referred by the name argument.

Examples

The following example enables the signaling-class cas command:

signaling-class cas test
 profile incoming S<*a<*d<*n
 controller T1 1/0/1
 cas-custom 1
 class test

Related Commands

Command
Description

class (controller)

Activates the signaling-class cas command.

profile incoming

Defines a template formed by directives guiding the CSM to process the digit sequence for a signaling class.


snapshot client

To configure a client router for snapshot routing, use the snapshot client command in interface configuration mode. To disable a client router, use the no form of this command.

snapshot client active-time quiet-time [suppress-statechange-updates] [dialer]

no snapshot client active-time quiet-time [suppress-statechange-updates] [dialer]

Syntax Description

active-time

Amount of time, in minutes, that routing updates are regularly exchanged between the client and server routers. This can be an integer ranging from 5 to 100. There is no default value. A typical value is 5 minutes.

quiet-time

Amount of time, in minutes, that routing entries are frozen and remain unchanged between active periods. Routes are not aged during the quiet period, so they remain in the routing table as if they were static entries. This argument can be an integer ranging from 8 to 100000. There is no default value. The minimum quiet time is generally the active time plus 3.

suppress-statechange-updates

(Optional) Disables the exchange of routing updates each time the line protocol goes from "down" to "up" or from "dialer spoofing" to "fully up."

dialer

(Optional) Specifies that the client router dials up the remote router in the absence of regular traffic.


Defaults

Snapshot routing is disabled.

The active-time and quiet-time arguments have no default values.

Command Modes

Interface configuration

Command History

Release
Modification

10.3

This command was introduced.


Usage Guidelines

The value of the active-time argument must be the same for the client and server routers.

To specify that the remote server routers be called by this client router during each active period, use the dialer map snapshot command.

Examples

The following example configures a client router for snapshot routing:

interface dialer 1
 snapshot client 5 600 suppress-statechange-updates dialer

Related Commands

Command
Description

clear resource-pool

Ends the quiet period on a client router within 2 minutes.

dialer map snapshot

Defines a dialer map for the Cisco snapshot routing protocol on a client router connected to a DDR interface.

show snapshot

Displays snapshot routing parameters associated with an interface.

snapshot client

Configures a client router for snapshot routing.

snapshot server

Configures a server router for snapshot routing.


snapshot server

To configure a server router for snapshot routing, use the snapshot server command in interface configuration mode. To disable a server router, use the no form of this command.

snapshot server active-time [dialer]

no snapshot server active-time [dialer]

Syntax Description

active-time

Amount of time, in minutes, that routing updates are regularly exchanged between the client and server routers. This can be an integer ranging from 5 to 100. There is no default value. A typical value is 5 minutes.

dialer

(Optional) Specifies that the client router dials up the remote router in the absence of regular traffic.


Defaults

Snapshot routing is disabled.

The active-time argument has no default value.

Command Modes

Interface configuration

Command History

Release
Modification

10.3

This command was introduced.


Usage Guidelines

The value of the active-time argument must be the same for the client and server routers.

Examples

The following example configures a server router for snapshot routing:

interface dialer 1
 snapshot server 5 

Related Commands

Command
Description

show snapshot

Displays snapshot routing parameters associated with an interface.

snapshot client

Configures a client router for snapshot routing.


source-ip (VPDN)

To specify an IP address that is different from the physical IP address used to open a virtual private dialup network (VPDN) tunnel for the tunnels associated with a VPDN group, use the source-ip command in VPDN group configuration mode. To remove the alternate IP address, use the no form of this command.

source-ip ip-address

no source-ip

Syntax Description

ip-address

Alternate IP address.


Command Default

No alternate IP address is specified.

Command Modes

VPDN group configuration

Command History

Release
Modification

12.0(5)T

This command was introduced.


Usage Guidelines

Use the source-ip command in VPDN group configuration mode to configure an alternate IP address to be used for only those tunnels associated with that VPDN group. Each VPDN group on a router can be configured with a unique source-ip command.

Use the vpdn source-ip command to specify a single alternate IP address to be used for all tunnels on the device. A single source IP address can be configured globally per device.

The VPDN group-level configuration will override the global configuration.

Examples

The following example configures a network access server (NAS) to accept Layer 2 Tunnel Protocol (L2TP) dial-out calls using the alternate IP address 172.23.33.7, which is different from the physical IP address used to open the L2TP tunnel:

vpdn-group 3
 accept-dialout
  protocol l2tp
  dialer 2
 terminate-from hostname router21
 source-ip 172.23.33.7

Related Commands

Command
Description

accept-dialin

Creates an accept dial-in VPDN subgroup that configures a tunnel server to accept requests from a NAS to tunnel dial-in calls, and enters accept dial-in VPDN subgroup configuration mode.

accept-dialout

Creates an accept dial-out VPDN subgroup that configures a NAS to accept requests from a tunnel server to tunnel L2TP dial-out calls, and enters accept dial-out VPDN subgroup configuration mode.

request-dialin

Creates a request dial-in VPDN subgroup that configures a NAS to request the establishment of a dial-in tunnel to a tunnel server, and enters request dial-in VPDN subgroup configuration mode.

request-dialout

Creates a request dial-out VPDN subgroup that configures a tunnel server to request the establishment of dial-out L2TP tunnels to a NAS, and enters request dial-out VPDN subgroup configuration mode.

vpdn source-ip

Globally specifies an IP address that is different from the physical IP address used to open a VPDN tunnel.


source template

To attach a configured customer profile template to a particular customer profile, use the source template command in customer profile configuration mode.

source template name

Syntax Description

name

Customer profile template name.


Defaults

No templates are sourced or attached to a customer profile.

Command Modes

Customer profile configuration

Command History

Release
Modification

12.0(6)T

This command was introduced.


Usage Guidelines

All PPP and peer-default commands are allowed for a particular customer profile template under this grouping.

Examples

The following example shows the creation and configuration of a customer profile template named acme-direct and its subsequent assignment to the customer profile acme1:

template acme-direct
 multilink {max-fragments num | max-links num | min-links num}
 peer match aaa-pools
 peer default ip address pool acme-numbers
 ppp ipcp dns 10.1.1.1  10.2.2.2 
 ppp multilink
 exit
resource-pool profile customer acme1
source template acme-direct

Related Commands

Command
Description

template

Accesses the template configuration mode for configuring a particular customer profile template.


source vpdn-template

To associate a virtual private dialup network (VPDN) group with a VPDN template, use the source vpdn-template command in VPDN group configuration mode. To disassociate a VPDN group from a VPDN template, use the no form of this command.

source vpdn-template [name]

no source vpdn-template [name]

Syntax Description

name

(Optional) The name of the VPDN template to be associated with the VPDN group.


Defaults

Global VPDN template settings are applied to individual VPDN groups if a global VPDN template has been defined. If no global VPDN template has been defined, system default settings are applied to individual VPDN groups.

Command Modes

VPDN group configuration

Command History

Release
Modification

12.2(4)B

This command was introduced on the Cisco 7200 series and Cisco 7401ASR routers.

12.2(8)T

This command was integrated into Cisco IOS Release 12.2(8)T without support for the name argument.

12.2(13)T

Support was added for the name argument in Cisco IOS Release 12.2(13)T.


Usage Guidelines

Use the source vpdn-template command to associate a VPDN group with a VPDN template. By default, VPDN groups are associated with the global VPDN template if one is defined. A VPDN group can be associated with only one VPDN template. Associating a VPDN group with a named VPDN template automatically disassociates it from the global VPDN template.

The hierarchy for the application of VPDN parameters to a VPDN group is as follows:

VPDN parameters configured for the individual VPDN group are always applied to that VPDN group.

VPDN parameters configured in the associated VPDN template are applied for any settings not specified in the individual VPDN group configuration.

System default settings for VPDN parameters are applied for any settings not configured in the individual VPDN group or the associated VPDN template.

Uncoupling a VPDN group from the global VPDN template using the no source vpdn-template command results in the following hierarchy for the application of VPDN parameters to that VPDN group:

VPDN parameters configured for the individual VPDN group are always applied to that VPDN group.

System default settings for VPDN parameters are applied for any settings not configured in the individual VPDN group.

If you uncouple a VPDN group from a named VPDN template, the VPDN group will be associated with the global VPDN template if one is defined.

Examples

The following example configures the VPDN group named group1 to ignore the global VPDN template settings and use the system default settings for all unspecified VPDN parameters:

Router(config)# vpdn-group group1
Router(config-vpdn)# no source vpdn-template

The following example creates a VPDN template named l2tp, enters VPDN template configuration mode, configures two VPDN parameters in the VPDN template, and associates the VPDN group named l2tptunnels with the VPDN template:

Router(config)# vpdn-template l2tp
Router(config-vpdn-templ)# l2tp tunnel busy timeout 65
Router(config-vpdn-templ)# l2tp tunnel password 7 tunnel4me
!
Router(config)# vpdn-group l2tptunnels
Router(config-vpdn)# source vpdn-template l2tp

The following example uncouples the VPDN group named l2tptunnels from the VPDN template named l2tp. The VPDN group will be associated with the global VPDN template if one has been defined.

Router(config)# vpdn-group l2tptunnels
Router(config-vpdn)# no source vpdn-template l2tp

Related Commands

Command
Description

vpdn-group

Creates a VPDN group and enters VPDN group configuration mode.

vpdn-template

Creates a VPDN template and enters VPDN template configuration mode.


spe

To enter service processing element (SPE) configuration mode and set the range of SPEs, use the spe command in global configuration mode.

Cisco AS5350 and Cisco AS5400 with the NextPort Dial Feature Card (DFC)

spe {slot | slot/spe}

Cisco AS5800 with the Universal Port Card (UPC)

spe {shelf/slot | shelf/slot/spe}

Syntax Description

slot

All ports on the specified slot. For the Cisco AS5350 slot values range from 1 to 3. For the Cisco AS5400, slot values range from 1 to 7.

slot/spe

All ports on the specified slot and SPE. For the Cisco AS5350 slot values range from 1 to 3. For the Cisco AS5400, slot values range from 1 to 7. SPE values range from 1 to 17. You must include the slash mark.

shelf/slot

All ports on the specified shelf and slot. For the Cisco AS5800, shelf values range from 0 to 1 and UPC slot values range from 2 to 11. You must include the slash mark.

shelf/slot/spe

All ports on the specified SPE. For the Cisco AS5800, shelf values range from 0 to 1, slot values range from 2 to 11, and SPE values range from 0 to 53. You must include the slash marks.


Defaults

No default behavior or values.

Command Modes

Global configuration

Command History

Release
Modification

12.0(4)XI1

This command was introduced.

12.0(5)T

This command was implemented on the Cisco AS5200 and Cisco AS5300 platforms.

12.1(1)XD

This command was implemented on the Cisco AS5400.

12.1(3)T

This command was implemented on the Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.


Usage Guidelines

The spe global configuration command enables the SPE configuration mode. Configure your SPE by specifying a slot and an SPE associated with the slot; or, you can configure a range of SPEs by specifying the first and last SPE in the range.

To exit SPE configuration mode, use the exit command.

Examples

The following example shows the spe command being used from global configuration mode to access the SPE configuration mode for the SPE range from 1/2 to 1/4:

router(config)# spe 5/4 5/6
router(config-spe)# ?
SPE Configuration Commands:
  busyout   Busyout SPE
  default   Set a command to its defaults
  exit      Exit from SPE Configuration Mode
  firmware  Firmware used for the SPE
  help      Description of the interactive help system
  no        Negate a command or set its defaults
  shutdown  Take the SPE out of Service

When the universal gateway is booted, the spe global configuration command specifies the location from where the firmware image is downloaded to the SPE. If the spe configuration command is used to download the firmware from Flash memory and then subsequently the no version of the exact command is entered, then the spe command downloads the embedded firmware.


Note Use this command when traffic is low because the spe download does not begin until the modems have no active calls.



Caution The spe command is a configuration command. Save it using the write memory command; otherwise, the configuration is not saved. If the configuration is not saved, the downloading of the specified firmware does not occur after the next reboot.

The following example shows the spe command being used from global configuration mode to access the SPE configuration mode for the range of SPEs from 1/2 to 1/4 on the Cisco AS5400:

Router(config)# spe 1/2 1/4

The following example specifies the range for use of the shutdown command:

Router(config)# spe 1/1 1/18
Router(config-spe)# shutdown
Router(config-spe)# no shutdown

Related Commands

Command
Description

exit

Exits SPE configuration mode.

show spe

Displays SPE status.


spe call-record modem

To generate a modem call record at the end of each call, use the spe call-record modem command in global configuration mode. To cancel the request to generate the reports, use the no form of the command.

spe call-record modem {max-userid number | quiet}

no spe call-record modem {max-userid number | quiet}

Syntax Description

max-userid number

Maximum length of the user ID for the modem call record report in number of bytes. The range is from 0 to 100.

quiet

Disables logging to console and terminal, but not to syslog.


Defaults

An SPE call record is enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(1)XD

This command was introduced on the Cisco AS5400.

12.1(3)T

This command was implemented on the Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.


Usage Guidelines

The spe modem-call-record command generates a modem call record at the end of each call.


Note The spe call-record modem command is similar to the modem call-record command.


Examples

The following example displays an SPE call record:

Router# configure terminal
Router(config)# spe call-record modem max-userid 50
Router(config)# end
Router#
00:18:30: %SYS-5-CONFIG_I: Configured from console by console
Router# write memory
Building configuration...
[OK]

The following is a partial example of traces generated when a call terminates. The logs from the show port modem log command do not change as a result of using the spe call-record modem command.

.
.
.
%LINK-3-UPDOWN: Interface Async5/105, changed state to down
%MODEMCALLRECORD-6-PM_TERSE_CALL_RECORD: DS0 slot/contr/chan=4/2/15,
shelf/slot/port=5/37, call_id=EE, userid=touraco-e1-4, ip=79.188.24.1,
calling=(n/a), called=35160, std=V.34+, prot=LAP-M, comp=V.42bis,
init-rx/tx b-rate=33600/33600, finl-rx/tx b-rate=33600/33600, rbs=0,
d-pad=None, retr=1, sq=5, snr=10495, rx/tx chars=286/266, bad=0, rx/tx
ec=16/6, bad=0, time=96, finl-state=Steady Retrain,
disc(radius)=(n/a)/(n/a), disc(modem)=1F00 <unknown>/Requested by
host/non-specific host disconnect
%MODEMCALLRECORD-6-PM_TERSE_CALL_RECORD: DS0 slot/contr/chan=4/1/24,
shelf/slot/port=5/38, call_id=FD, userid=touraco-e1-4, ip=79.205.24.1,
calling=(n/a), called=35170, std=V.34+, prot=LAP-M, comp=V.42bis,
init-rx/tx b-rate=33600/33600, finl-rx/tx b-rate=33600/33600, rbs=0,
d-pad=None, retr=1, sq=5, snr=10495, rx/tx chars=289/267, bad=0, rx/tx
ec=17/7, bad=0, time=93, finl-state=Steady Retrain,
disc(radius)=(n/a)/(n/a), disc(modem)=1F00 <unknown>/Requested by
host/non-specific host disconnect
%MODEMCALLRECORD-6-PM_TERSE_CALL_RECORD: DS0 slot/contr/chan=4/3/15,
shelf/slot/port=5/2, call_id=FF, userid=touraco-e1-4, ip=79.200.24.1,
calling=(n/a), called=35170, std=V.34+, prot=LAP-M, comp=V.42bis,
init-rx/tx b-rate=33600/33600, finl-rx/tx b-rate=33600/33600, rbs=0,
d-pad=None, retr=1, sq=5, snr=10495, rx/tx chars=287/270, bad=0, rx/tx
ec=17/7, bad=0, time=92, finl-state=Steady Retrain,
disc(radius)=(n/a)/(n/a), disc(modem)=1F00 <unknown>/Requested by
host/non-specific host disconnect
%MODEMCALLRECORD-6-PM_TERSE_CALL_RECORD: DS0 slot/contr/chan=4/3/10,
shelf/slot/port=5
.
.
.

Related Commands

Command
Description

modem call-record

Activates the logging of a summary of modem events upon the termination of a call.


spe country

To specify the country while setting the modem card parameters (including country code and encoding), use the spe country command in global configuration mode. To set the country code to the default value, use the no form of this command.

spe country {country-name | e1-default | t1-default}

no spe country {country-name | e1-default | t1-default}

Syntax Description

country-name

Name of the country, See Table 139 for a list of supported country name keywords.

e1-default

Use this command when using the E1 interface.

t1-default

Use this command when using the T1 interface.


Defaults

Disabled

Command Modes

Global configuration

Command History

Release
Modification

12.1(1)XD

This command was introduced on the Cisco AS5400.

12.1(3)T

This command was implemented on the Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.


Usage Guidelines

On the Cisco universal gateway, DS0 companding law selection is configured for the entire system rather than on individual voice ports. Set the spe country command to the appropriate country.

If T1 lines are configured, the default is t1-default; if E1 lines are configured, the default is e1-default.

The Cisco universal gateway must be in an Idle state (no calls are active) for the spe country command to function. All sessions on all modules in all slots must be in the Idle state.


Note The spe country command is similar to the modem country mica and modem country microcom_hdms commands.


Table 139 lists the country names and corresponding companding law.

Table 139 Country Names and Corresponding Companding Law 

Keyword
Country
Companding Law

australia

Australia

a-law

austria

Austria

a-law

belgium

Belgium

a-law

china

China

a-law

cyprus

Cyprus

a-law

czech-republic

Czech/Slovak Republic

a-law

denmark

Denmark

a-law

e1-default

Default for E1

a-law

finland

Finland

a-law

france

France

a-law

germany

Germany

a-law

hong-kong

Hong Kong

u-law

india

India

a-law

ireland

Ireland

a-law

israel

Israel

a-law

italy

Italy

a-law

japan

Japan

u-law

malaysia

Malaysia

a-law

netherlands

Netherlands

a-law

new-zealand

New Zealand

a-law

norway

Norway

a-law

poland

Poland

a-law

portugal

Portugal

a-law

russia

Russia

a-law

singapore

Singapore

a-law

south-africa

South Africa

a-law

spain

Spain

a-law

sweden

Sweden

a-law

switzerland

Switzerland

a-law

t1-default

Default for T1

u-law

taiwan

Taiwan

u-law

thailand

Thailand

a-law

turkey

Turkey

a-law

united-kingdom

United Kingdom

a-law

usa

United States of America

u-law


Examples

The following example configures the setting of the country code to the default for E1:

router(config)# spe country e1-default

The following example configures the setting of the country code to the default for T1:

router(config)# spe country t1-default

Related Commands

Command
Reference

modem country mica

Configures the modem country code for a bank of MICA technologies modems.

modem country microcom_hdms

Configures the modem country code for a bank of Microcom modems.

show spe

Displays SPE status.


spe download maintenance

To perform download maintenance on service processing elements (SPEs) that are marked for recovery, use the spe download maintenance command in global configuration mode. To disable download maintenance on SPEs, use the no form of the command.

spe download maintenance {time hh:mm | stop-time hh:mm | max-spes number-of-spes | window time-period | expired-window {drop-call | reschedule}}

no spe download maintenance {time hh:mm | stop-time hh:mm | max-spes number-of-spes | window time-period | expired-window {drop-call | reschedule}}

Syntax Description

time hh:mm

Time of the day to start the download maintenance activity. Enter the value in the format of the variable as shown in hours and minutes. Default is 03:00 a.m.

stop-time hh:mm

Time of the day to stop the download maintenance activity. Enter the value in the format of the variable as shown in hours and minutes.

max-spes number-of-spes

Maximum number of SPEs that can simultaneously be in maintenance. The value ranges from 1 to 10,000. Default is equal to 20 percent of the maximum number of SPEs in each NextPort Dial Feature Card (DFC).

window time-period

Time window to perform the maintenance activity. The value ranges from 0 to 360 minutes. Default is 60 minutes.

expired-window

Action to take if SPE maintenance is not completed within the specified window. Default is reschedule.

drop-call

Expired window choice that forces download by dropping active calls.

reschedule

Expired window choice that defers recovery to the next maintenance time (default for the expired-window keyword).


Defaults

Enabled

Command Modes

Global configuration

Command History

Release
Modification

12.1(1)XD

This command was introduced on the Cisco AS5400.

12.1(3)T

This command was implemented on the Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.


Usage Guidelines

The SPE download maintenance activity takes place when SPEs are marked for recovery. The settings are enabled by default. When you want to change the default settings to a desired setting, use the spe download maintenance command parameters to perform SPE download maintenance activity with the specific changes.

Enter the time hh:mm keyword to set a time to start the SPE download maintenance activity. Then enter the stop-time hh:mm keyword to set a time to stop the download maintenance. Next enter the max-spes number-of-spes keyword to set the number of SPEs for the download maintenance. Then enter the window time-period keyword to set a time period to perform the download maintenance. Finally, enter the expired-window keyword to set actions in the event the SPE download maintenance is not completed in the set window time-period.

The download maintenance activity starts at the set start time and steps through all the SPEs that need recovery and the SPEs that need a firmware upgrade and starts maintenance on the maximum number of set SPEs for maintenance. The system waits for the window delay time for all the ports on the SPE to become inactive before moving the SPE to the Idle state. Immediately after the SPE moves to the Idle state, the system starts to download firmware. If the ports are still in use by the end of window delay time, depending upon the expired-window setting, connections on the SPE ports are shut down and the firmware is downloaded by choosing the drop-call option, or the firmware download is rescheduled to the next download maintenance time by choosing the reschedule option. This process continues until the number of SPEs under maintenance is below the max-spes value, or until the stop-time value (if set), or until all SPEs marked for recovery or upgrade have had their firmware reloaded.

Examples

The following example displays the SPE download maintenance with the different keyword parameters:

Router(config)# spe download maintenance time 03:00

Router(config)# spe download maintenance stop-time 04:00

Router(config)# spe download maintenance max-spes 50

Router(config)# spe download maintenance window 30

Router(config)# spe download maintenance expired-window reschedule

Related Commands

Command
Description

firmware location

Downloads firmware into Cisco integrated modems.

firmware upgrade

Specifies the method in which the SPE will be downloaded.

show spe version

Displays the firmware version on an SPE.

spe recovery

Sets an SPE port for recovery.


spe log-size

To set the size of the port event log, use the spe log-size command in global configuration mode. To restore the default size, use the no version of this command.

spe log-size number

no spe log-size

Syntax Description

number

The number of recorded events. Valid values for the number argument range from 0 to 100. The default value is 50 events.


Command Default

The port event log records 50 events.

Command Modes

Global configuration

Command History

Release
Modification

12.1(1)XD

This command was introduced on the Cisco AS5400.

12.1(3)T

This command was integrated into Cisco IOS Release 12.1(3)T on the Cisco AS5400 and Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.


Examples

The following example sets the size of the event log to 70 events:

Router(config)# spe log-size 70

Related Commands

Command
Description

show port digital log

Displays the digital data event log with the oldest event first.

show port modem log

Displays the modem port history event log or modem test log.


spe recovery

To set a service processing element (SPE) port for recovery, use the spe recovery command in global configuration mode. To disable SPE recovery or to restore the default port-threshold value, use the no form of this command.

spe recovery {port-action {disable | recover} | port-threshold number-failures}

no spe recovery {port-action | port-threshold}

Syntax Description

port-action

Action to apply to the port for recovery when the configured port-threshold value has been exceeded.

disable

Sets the port to the bad state.

recover

Sets the port for recovery.

port-threshold number-failures

Number of consecutive failed attempts made on the port before the port-action keyword is applied. The range is from 1 to 10000. The default value is 30.


Defaults

There is no default port-action value. SPE recovery is disabled.
The default port-threshold value is 30 failed attempts.

Command Modes

Global configuration

Command History

Release
Modification

12.1(1)XD

This command was introduced on the Cisco AS5400.

12.1(2.3)T1

This command was implemented on the Cisco AS5800.

12.1(5)XM1

This command was implemented on the Cisco AS5350.

12.2(11)T

This command was integrated into Cisco IOS Release 12.2(11)T and implemented on the Cisco AS5350.


Usage Guidelines

Failure of an SPE port to connect after repeated tries indicates that a problem exists in the SPE or firmware. An SPE port in this state is recovered by downloading firmware.

When an SPE port fails to connect consecutively for a number of times, as specified by the