Interface monitoring and configuration

Naming order of router interfaces is described in Section Types and naming order of router interfaces.

Commands entered in interface (interface group) configuration mode are applied to a selected interface (interface group).

General commands

clear interfaces counters

The command performs the reset of specified system interface/interface group counter.

Syntax

clear interfaces counters [<IF>]

Parameters

<IF> – name of an interface or a group of interfaces is specified in the form described in Section Types and naming order of router interfaces;

You can specify several interfaces separated by commas ',' or you can specify the range of interfaces with '-'. If interface indexes are not specified, then the counters of all interfaces of a specified group will be cleared. When executing a command without parameters, all system interface counters will be cleared.

Required privilege level

10

Command mode

ROOT

Example:

esr# clear interfaces counters gigabitethernet 1/0/5

CODE

description

The command is used to change a description of configured interface.

The use of a negative form (no) of the command removes a specified description.

Syntax

description <DESCRIPTION>

no description

Parameters

<DESCRIPTION> – interface description, set by the string of up to 255 characters.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-SUBIF

CONFIG-QINQ-IF

CONFIG-PORT-CHANNEL

CONFIG-LOOPBACK

CONFIG-E1

CONFIG-MULTILINK

CONFIG-SERVICE-PORT

CONFIG-CELLULAR-PROFILE

CONFIG-CELLULAR-MODEM

CONFIG-VOICE-PORT

CONFIG-VOIP-PROFILE

CONFIG-LINE-AUX¹

Example:

esr(config-if-gi)# description "Uplink interface"

CODE

¹ Only for ESR-21

history statistics

The command enables maintenance of a current interface usage statistics.

The use of a negative (no) form of the command disable maintenance of a current interface usage statistics.

Syntax

[no] history statistics

Parameters

None.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-SUBIF

CONFIG-QINQ-IF

CONFIG-SERIAL

CONFIG-PORT-CHANNEL

CONFIG-LOOPBACK

CONFIG-MULTILINK

CONFIG-E1

CONFIG-BRIDGE

Example:

esr:esr(config-if-gi)# history statistics
esr:esr(config-if-gi)#

CODE

interface

The command allows you to switch to the configuration mode of one or more interfaces.

The use of a negative form (no) of the command returns the default interface configuration.

Syntax

[no] interface <IF>

Parameters

<IF> – name of an interface or a group of interfaces is specified in the form described in Section Types and naming order of router interfaces;

Required privilege level

10

Command mode

CONFIG

Example 1

Switch to Ethernet interface gi 1/0/20 configuration mode:

esr(config)# interface gigabitethernet 1/0/20
esr(config-if-gi)#

CODE

Example 2

Switch to Ethernet interface gi 1/0/2 configuration mode:

esr(config)# interface tengigabitethernet 1/0/2
esr(config-if-te)#

CODE

Example 3

Switch to a virtual interface configuration mode:

esr(config)# interface loopback 5
esr(config-loopback)#

CODE

Example 4

Switch to a sub interface configuration mode:

esr(config)# interface gigabitethernet 1/0/20.20
esr(config-subif)#

CODE

Example 5

Switch to the port-channel 2 configuration mode:

esr(config)# interface port-channel 2
esr(config-port-channel)#

CODE

Example 6

Switch to interface e1 1/0/1 configuration mode:

esr(config)# interface e1 1/0/1
esr(config-e1)#

CODE

Example 7

Switch to multilink 1 configuration mode:

esr(config)# interface multilink 1
esr(config-multilink)#

CODE

ip tcp adjust-mss

This command overrides the value of the MSS (Maximum segment size) field in incoming TCP packets.

The use of a negative form (no) of the command disables MSS field value correction.

Syntax

ip tcp adjust-mss <MSS>

no ip tcp adjust-mss

Parameters

<MSS> – MSS value, takes values in the range of [500..1460].

Default value

1460

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-SUBIF

CONFIG-QINQ-IF

CONFIG-PORT-CHANNEL

CONFIG-BRIDGE

CONFIG-LOOPBACK

Example

esr(config-if-gi)# ip tcp adjust-mss 1400

CODE

load-average

The command sets a time interval used for interface utilization calculation.

The use of a negative form (no) of the command sets the default value.

Syntax

load-average <TIME>

no load-average

Parameters

<TIME> – interval in seconds, takes values of [5..150].

Default value

5

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-SUBIF

CONFIG-QINQ-IF

CONFIG-SERIAL

CONFIG-PORT-CHANNEL

CONFIG-E1

CONFIG-MULTILINK

CONFIG-BRIDGE

CONFIG-LOOPBACK

Example:

esr(config-if-gi)# load-average 30

CODE

mode

The command sets an operation mode of physical/aggregated interface.

The use of a negative form (no) of the command sets the default value.

Syntax

mode <MODE>

no mode

Parameters

<MODE> – physical/aggregated interface operation mode taking the following values:

switchport – sets L2 mode. Vlan permitting is allowed, IP address assigning and sub/qinq interfaces creating are not.
routerport – sets L3 mode. IP address assigning and sub/qinq interfaces creating are allowed, vlan permitting on an interface is not.
hybrid – vlan permitting, IP address assigning and sub/qinq interfaces creating are allowed¹.

Default value

routerport

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# mode switchport

CODE

¹ Available only for ESR-1000/1200/1500/1511/1700 routers.

mtu

The command specifies MTU (Maximum Transmission Unit) size for interfaces.

The use of a negative form (no) of the command sets the default MTU value.

Syntax

mtu <MTU>

no mtu

Parameters

<MTU> – MTU value in bytes, takes values in the range of:

ESR-10/12V/12VF/14VF – [552..9600]

ESR-20/21 – [552..9500]

ESR-100/200/1000/1200/1500/1511/1700 – [552..10000]

ESR-3100 – [552..9190]

For Serial, E1 and multilink interfaces – [552-1500] for all router models.

MTU value above 1500 can be set only with enabled Jumbo frame support described in Section system jumbo-frames.

Default value

1500

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-SUBIF

CONFIG-QINQ-IF

CONFIG-SERIAL

CONFIG-PORT-CHANNEL

CONFIG-BRIDGE

CONFIG-E1

CONFIG-MULTILINK

CONFIG-CELLULAR-MODEM

Example:

esr(config-if-gi)# mtu 1400

CODE

rate-limit arp-broadcast

The command enables limiting of arp requests receiving on a bridge interface.

When the negative (no) form of the command is used, limiting of arp requests receiving on a bridge interface is disabled.

Syntax

[no] rate-limit arp-broadcast

Parameters

None.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-BRIDGE

Example:

esr(config-bridge)# rate-limit arp-broadcast

CODE

rate-limit arp-broadcast pps

The command sets the maximum limit for arp-requests on a bridge interface. The parameter is available only if the limiting of arp requests receiving on a bridge interface is enabled

The use of a negative form (no) of the command sets the default value.

Syntax

rate-limit arp-broadcast pps <PPS>

no rate-limit arp-broadcast pps

Parameters

<PPS> – number of arp-requests in the range of [1..65535].

Default value

100

Required privilege level

10

Command mode

CONFIG-BRIDGE

Example:

esr(config-bridge)# rate-limit arp-broadcast pps 2000

CODE

show interfaces counters

The command displays system interface counters: ports, sub interfaces, aggregation groups, network bridges.

Syntax

show interfaces counters [ <IF> ]

Parameters

<IF> – an interface's name, specified in the form described in Section Types and naming order of router interfaces.

The command displays counters for router ports, subinterfaces and tunnel interfaces.

You may specify several interfaces. If interface indexes are not specified, then the counters of all interfaces of a specified group will be shown. If a certain interface is specified, the detailed information on this interface will be displayed. When executing a command without parameter, all system interface counters will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces counters gigabitethernet 1/0/4-6
Interface       UC recv         Bytes recv      Errors recv     MC recv
-------------   -------------   -------------   -------------   -------------
gi1/0/4         0               0               0               0
gi1/0/5         0               0               0               0
gi1/0/6         0               0               0               0
Interface       UC sent         Bytes sent      Errors sent
-------------   -------------   -------------   -------------
gi1/0/4         0               0               0
gi1/0/5         1138            393748          0
gi1/0/6         0               0               0
esr# show interfaces counters gigabitethernet 1/0/4
 Packets received:               0
 Bytes received:                 0
 Dropped on receive:             0
 Receive errors:                 0
 Multicasts received:            0
 Receive length errors:          0
 Receive buffer overflow errors: 0
 Receive CRC errors:             0
 Receive frame errors:           0
 Receive FIFO errors:            0
 Receive missed errors:          0
 Receive compressed:             0
 Packets transmitted:            0
 Bytes transmitted:              0
 Dropped on transmit:            0
 Transmit errors:                0
 Transmit aborted errors:        0
 Transmit carrier errors:        0
 Transmit FIFO errors:           0
 Transmit heartbeat errors:      0
 Transmit window errors:         0
 Transmit comressed:             0
 Collisions:                     0

CODE

show interfaces description

The command is used to display system interfaces description.

Syntax

show interfaces description [ <IF> ]

Parameters

<IF> – an interface's name, specified in the form described in Section Types and naming order of router interfaces.

You may specify several interfaces in the command. If interface indexes are not specified, then the statuses of all interfaces of a specified group will be shown. When executing a command without parameter, all system interface descriptions will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces description gigabitethernet 1/0/4-5
Interface       Admin   Link    Description
                State   State
-------------   -----   -----   ----------------------------------------------------
gi1/0/4         Up      Down    Link to NSK
gi1/0/5         Up      Down    Link to MSK

CODE

show interfaces history

The command is used to view interface usage statistics.

Syntax

show interfaces history [<IF>] [timer <TIMER>]

Parameters

<IF> – name of an interface or a group of interfaces is specified in the form described in Section Types and naming order of router interfaces;

<TIMER > – timer optional key. Has the following parameters:

hours displays history in the last 72 hours
minutes displays history in the last 60 hours
seconds displays history in the last 60 seconds
When timer is missing, 3 tables containing tunnel usage history are displayed

Required privilege level

5

Command mode

ROOT

Example:

esr# show interfaces history gi 1/0/1 timer minutes
gi1/0/1
Last 60 minutes:
Timer  Recv utilization, Kbit/s  Sent utilization, Kbit/s  Recv errors  Sent errors  Output drops
------ ------------------------- ------------------------- ------------ ------------ --------------
0-1   240            16             0       0       0
1-2   961            64             0       0       0
2-3   962            64             0       0       0
3-4   962            64             0       0       0
4-5   960            64             0       0       0
5-6   961            64             0       0       0
6-7   719            64             0       0       0
7-8   960            64             0       0       0
8-9   800            65             0       0       0
9-10  962            64             0       0       0
10-11 865            64             0       0       0
11-12 962            64             0       0       0
12-13 817            65             0       0       0
13-14 962            65             0       0       0
14-15 961            65             0       0       0
15-16 880            60             0       0       0
16-17 960            63             0       0       0
17-18  0             0              0       0       0
18-19  0             0              0       0       0
19-20  0             0              0       0       0
20-21  0             0              0       0       0
21-22  0             0              0       0       0

CODE

show interfaces status

The command is used to display system interfaces status.

Syntax

show interfaces status [<IF>]

Parameters

<IF> – an interface's name, specified in the form described in Section Types and naming order of router interfaces.

You may specify several interfaces in the command. If interface indexes are not specified, then the statuses of all interfaces of a specified group will be shown. If a certain interface is specified, the detailed information on this interface will be displayed. When executing a command without parameter, all system interface statuses will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces status gigabitethernet 1/0/1-2
Interface       Admin   Link    MTU      MAC address          Uptime
                state   state
-------------   -----   -----   ------   ------------------   -------------------------
gi1/0/1         Up      Down    1500     a8:f9:4b:aa:53:fc    --
gi1/0/2         Up      Up      1500     a8:f9:4b:aa:53:fd    15 hours, 17 minutes and 52 seconds

CODE

show interfaces utilization

The command is used to display the current load on physical interfaces.

Syntax

show interfaces utilization [ <IF> ]

Parameters

<IF> – a physical interface's name specified in the form described in Section Types and naming order of router interfaces.

You can specify several interfaces separated by commas ',' or you can specify the range of interfaces with '-'. If interface indexes are not specified, then the current load of all interfaces of a specified group will be shown. When executing a command without parameter, all physical interface current load will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces utilization gigabitethernet 1/0/3-5,1/0/9
Port       Period, s     Sent,         Recv,         Frames Sent   Frames Recv
                         Kbit/s        Kbit/s
--------   -----------   -----------   -----------   -----------   -----------
gi1/0/3    5             0             0             0             0
gi1/0/4    5             0             0             0             0
gi1/0/5    5             0             0             0             0
gi1/0/9    5             0             0             0             0

CODE

shutdown

The command disables an interface being configured.

The use of a negative form (no) of the command enables the interface being configured.

Syntax

[no] shutdown

Parameters

The command does not contain parameters.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-SUBIF

CONFIG-QINQ-IF

CONFIG-SERIAL

CONFIG-PORT-CHANNEL

CONFIG-LOOPBACK

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-if-gi)# shutdown

CODE

Configured interface is disabled.

show system jumbo-frames

In the current firmware version this functionality is supported by ESR-200/1000/1200/1500/1511/1700 routers only

The command displays the jumbo frame function current status and status after device reboot.

Syntax

show system jumbo-frames

Parameters

The command does not contain parameters.

Required privilege level

1

Command mode

ROOT

Example:

esr# show system jumbo-frames
Jumbo frames are disabled
Jumbo frames will be disabled after reset

CODE

speed

The command sets speed value for interface (interface group) being configured. The command can set the following modes: 10 Mbps, 100 Mbps, 1000 Mbps, 10 Gbps or auto.

The use of a negative form (no) of the command sets the default value.

Syntax

speed <SPEED> <DUPLEX>

no speed

Parameters

<SPEED> – speed value:

10M – 10Mbps speed;
100M – 100Mbps speed;
1000M – 1000Mbps speed;
10G – 10Gbps speed;
auto – automatic mode selection (unavailable for 10G interfaces).

<DUPLEX> – transmitter receiver operation mode, takes the following values:

full-duplex;
half-duplex.

Default value

auto

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example 1

esr(config-if-te)# speed 10G

CODE

10 Gbps speed limit is set.

Example 2

esr(config-if-gi)# speed 10M full-duplex

CODE

10 Mbps speed limit is set, duplex.

switchport dot1q ethertype egress stag

The command configures EtherType for service VLAN in outgoing packets.

The use of a negative form (no) of the command sets the default value.

Syntax

[no] switchport dot1q ethertype egress stag { 802.1q | 802.1ad }

Parameters

The command does not contain parameters.

Default value

802.1q (0x8100)

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# switchport dot1q ethertype egress stag 802.1ad

CODE

switchport mode

The command specifies VLAN interface operation mode.

The use of a negative form (no) of the command sets the default value.

Syntax

switchport mode <MODE>

no switchport mode

Parameters

<MODE> – operation mode:

access¹ – access interface, non-tagged interface for one VLAN;
trunk¹ – interface that receives only tagged traffic excluding one VLAN that can be added by switchport trunk native vlan command described in Section switchport trunk native-vlan;
general² – physical interface is switched to general mode;
e1 – physical interface is switched to E1 mode (not applicable for aggregated interfaces).

Default value

access¹

general²

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# switchport mode trunk

CODE

¹ This command is supported on the ESR-10/12V/12VF/14VF/20/21/100/200/3100 routers only

² This command is supported on the ESR-1000/1200/1500/1511/1700 routers only

system jumbo-frames

The command enables Jumbo frame support. To bring the changes into effect, reboot the device.

The use of a negative form (no) of the command disables Jumbo frame support.

Syntax

[no] system jumbo-frames

Parameters

The command does not contain parameters.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG

Example:

esr(config)# system jumbo-frames

CODE

Physical interfaces

snmp trap link-status

The command enables sending snmp-trap about tunnel enabling/disabling.

The use of a negative form (no) of the command disables sending snmp-trap about tunnel enabling/disabling.

Syntax

[no] snmp trap link-status

Parameters

The command does not contain parameters.

Default value

Enabled.

Required privilege level

15

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr(config-if-gi)# snmp trap link-status

CODE

show interfaces protected-ports

In the current firmware version this functionality is supported by ESR-1000/1200/1500/1511/1700 routers only

The command displays physical interfaces in group-based isolation mode.

Syntax

show interfaces protected-ports [ <IF> ]

Parameters

<IF> – a physical or aggregated interface's name specified in the form described in Section Types and naming order of router interfaces.

You may specify several interfaces in the command. If interface indexes are not specified, then the statuses of all interfaces of a specified group will be shown. If a certain interface is specified, the detailed information on this interface will be displayed. When executing a command without parameter, all physical interface statuses will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces protected-ports
Interface   State           Community
---------   -------------   ---------
gi1/0/5     Protected       4

CODE

show interfaces sfp

The command displays SFP transceivers information.

Syntax

show interfaces sfp [ <IF> ]

Parameters

<IF> – a physical interface's name specified in the form described in Section Types and naming order of router interfaces. You may specify several interfaces in the command. If interface indexes are not specified, then the statuses of all interfaces of a specified group will be shown. If a certain interface is specified, the detailed information on this interface will be displayed. When executing a command without parameter, all system interface statuses will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces sfp
Interface 'te1/0/1':
 SFP present:       Yes
 Connector Type:    LC
 Type:              SFP/SFP+
 Compliance code:   10G BASE-SR
 Laser wavelength:  850 nm
 Transfer distance: 300.00 m
 Vendor OUI:        24:00:00
 Vendor name:       Modultech
 Vendor PN:         MT-PP-85192-SR
 Vendor SN:         M1204011007
 Vendor date:       04.05.12
 Vendor revision:   1.0
 DDM supported:     Yes
 Temperature:       40.562 C
 Voltage:           3.3364 V
 Current:           6.004 mA
 RX Power:          0.0001 mW / -40.0000 dBm
 TX Power:          0.4398 mW / -3.5674 dBm
 RX LOS:            Yes
 TX Fault:          No
 TX Disable:        No
 Soft TX Disable:   No
Interface 'te1/0/2':
 SFP present:       Yes
 Connector Type:    SC
 Type:              SFP/SFP+
 Compliance code:   1000BASE-LX
 Laser wavelength:  1310 nm
 Transfer distance: 20.00 km
 Vendor OUI:        --
 Vendor name:       OEM
 Vendor PN:         APSB35123CXS20
 Vendor SN:         SG35224701333
 Vendor date:       12.12.12
 Vendor revision:   1.00
 DDM supported:     No

CODE

show interfaces switch-port configuration

In the current firmware version this functionality is supported by ESR-1000/1200/1500/1511/1700 routers only

The command displays physical interface configuration parameters.

Syntax

show interfaces switch-port configuration [ <IF> ]

Parameters

<IF> – a physical interface's name specified in the form described in Section Types and naming order of router interfaces.

You can specify several interfaces separated by commas ',' or you can specify the range of interfaces with '-'. If interface indexes are not specified, then the parameters of all interfaces of a specified group will be shown. When executing a command without parameter, all physical interface parameters will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces switch-port configuration gigabitethernet 1/0/5-7
Port       Media     Duplex   Speed      Neg        Flow      Admin   Back
                                                    control   State   Pressure
--------   -------   ------   --------   --------   -------   -----   --------
gi1/0/5    none      Half     10 Mbps    Enabled    Off       Up      Disabled
gi1/0/6    none      Half     10 Mbps    Enabled    Off       Up      Disabled
gi1/0/7    none      Half     10 Mbps    Enabled    Off       Up      Disabled

CODE

show interfaces switch-port status

The command displays physical interfaces status.

Syntax

show interfaces switch-port status [ <IF> ]

Parameters

<IF> – a physical or aggregated interface's name specified in the form described in Section Types and naming order of router interfaces.

You can specify several interfaces separated by commas ',' or you can specify the range of interfaces with '-'. If interface indexes are not specified, then the statuses of all interfaces of a specified group will be shown. If a certain interface is specified, the detailed information on this interface will be displayed. When executing a command without parameter, all physical interface statuses will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces switch-port status
Port       Media    Duplex   Speed   Neg        Flow   Link    Back       MDI       Port
                                                ctrl   State   Pressure   Mode      Mode
--------   ------   ------   -----   --------   ----   -----   --------   -------   -------
gi1/0/1    --       --       --      Enabled    --     Down    --         --        access
gi1/0/2    --       --       --      Enabled    --     Down    --         --        access
gi1/0/3    --       --       --      Enabled    --     Down    --         --        access
gi1/0/4    --       --       --      Enabled    --     Down    --         --        access
gi1/0/5    --       --       --      Enabled    --     Down    --         --        access
gi1/0/6    --       --       --      Enabled    --     Down    --         --        access

esr# show interfaces switch-port status gigabitethernet 1/0/2
Interface       gigabitethernet 1/0/2
  Status:       up
  Media:        copper
  Speed:        100 Mbps
  Duplex:       full
  Flow control: no
  MAC address:  a8:f9:b5:00:00:25
MAC status:
  Buffers full:            no
  Doing back pressure:     no
  Sending PAUSE frames:    no
  Receiving PAUSE frames:  no
  Auto-Negotiation done:   yes
  Sync fail:               no

CODE

threshold rx-utilization

The command specifies interface incoming load threshold to send snmp-trap eltexInterfaceRxUtilizationHigh and eltexInterfaceRxUtilizationHighOk.

The use of a negative form (no) of the command sets the default value.

Syntax

threshold rx-utilization <TH-HIGH> clear <TH-LOW>

no threshold rx-utilization

Parameters

<TH-HIGH> – threshold (in per cent) to send snmp-trap eltexInterfaceRxUtilizationHigh;

<TH-LOW> – threshold (in per cent) to send snmp-trap eltexInterfaceRxUtilizationHighOk.

Default value

<TH-HIGH> – 90%;

<TH-LOW> – 85%.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# threshold rx-utilization 90 clear 80

CODE

threshold rx-utilization monitoring

The command enables sending snmp-trap eltexInterfaceRxUtilizationHigh and eltexInterfaceRxUtilizationHighOk.

The use of a negative form (no) of the command disables sending snmp-trap eltexInterfaceRxUtilizationHigh and eltexInterfaceRxUtilizationHighOk.

Syntax

[no] threshold rx-utilization monitoring

Parameters

The command does not contain parameters.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# threshold rx-utilization monitoring

CODE

threshold tx-utilization

The command sets interface upstream thresholds for sending snmp-traps eltexInterface T xUtilizationHigh and eltexInterface T xUtilizationHighOk.

The use of a negative form (no) of the command sets the default value.

Syntax

threshold tx-utilization <TH-HIGH> clear <TH-LOW>

no threshold tx-utilization

Parameters

<TH-HIGH> – threshold (in per cent) to send snmp-trap eltexInterfaceTxUtilizationHigh;

<TH-LOW> – threshold (in per cent) to send snmp-trap eltexInterfaceTxUtilizationHighOk.

Default value

<TH-HIGH> – 90%;

<TH-LOW> – 85%.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# threshold tx-utilization 90 clear 80

CODE

threshold tx-utilization monitoring

The command is used to enable sending snmp-traps eltexInterface T xUtilizationHigh and eltexInterface T xUtilizationHighOk.

The use of the negative form of the command (no) disables sending snmp-traps eltexInterface T xUtilizationHigh and eltexInterface T xUtilizationHighOk.

Syntax

[no] threshold tx-utilization monitoring

Parameters

The command does not contain parameters.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# threshold tx-utilization monitoring

CODE

switchport community

In the current firmware version this functionality is supported by ESR-1000/1200/1500/1511/1700 routers only

The command adds an interface to an isolation group. The command is relevant if the port is in group-based isolation mode.

The use of a negative form (no) of the command removes an interface from isolation group.

Syntax

switchport community <ID>

no switchport community

Parameters

<ID> – group identifier, takes values in the range of [1..30].

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# switchport community 10

CODE

switchport protected

In the current firmware version this functionality is supported by ESR-1000/1200/1500/1511/1700 routers only

The command enables Private VLAN functionality and specifies an interface to which received packets can be sent.

The use of a negative form (no) of the command disables Private VLAN functionality.

Syntax

switchport protected <IF>

no switchport protected

Parameters

<IF> – an interface's name specified in the form described in Section Types and naming order of router interfaces.

Default value

Private VLAN functionality is disabled.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr(config-if-gi)# switchport protected gigabitethernet 1/0/1

CODE

switchport protected-port

In the current firmware version this functionality is supported by ESR-1000/1200/1500/1511/1700 routers only

The command switches an interface to a group-based isolation mode. According to this mode, traffic exchange is allowed for interfaces belonging to the same group, prohibited for interfaces from different groups and allowed for isolated and non-isolated interfaces.

The use of a negative form (no) of the command sets the default value.

Syntax

[no] switchport protected-port

Parameters

None.

Default value

Interface not isolated.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

CONFIG-PORT-CHANNEL

Example:

esr:esr(config-if-gi)# switchport protected-port

CODE

Aggregated interfaces

channel-group

The command adds a physical interface to channel aggregation group.

The use of a negative form (no) of the command removes an interface from channel aggregation group.

Syntax

channel-group <ID> mode <MODE>

no channel-group

Parameters

<ID> – sequence number of a channel aggregation group, takes values of [1..12].

<MODE> – mode of the channel aggregation group formation:

auto – add interface to the dynamic aggregation group with the support of LACP;
on – add interface to the static aggregation group.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr(config-if-gi)# channel-group 6 mode auto

CODE

lacp port-priority

The command sets LACP priority of Ethernet interface.

The use of a negative form (no) of the command sets the default value.

Syntax

lacp port-priority <PRIORITY>

no lacp port-priority

Parameters

<PRIORITY> – priority, set in the range of [1..65535].

Default value

1

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr(config-if-gi)# lacp port-priority 5000

CODE

lacp system-priority

The command sets the system priority for LACP.

The use of a negative form (no) of the command sets the default value.

Syntax

lacp system-priority <PRIORITY>

no lacp system-priority

Parameters

<PRIORITY> – priority, set in the range of [1..65535].

Default value

1

Required privilege level

10

Command mode

CONFIG

Example:

esr(config)# lacp system-priority 5000

CODE

lacp timeout

The command sets an administrative LACP timeout.

The use of a negative form (no) of the command sets the default value.

Syntax

lacp timeout { short | long }

no lacp timeout

Parameters

long – long timeout (90 seconds);

short – short timeout (3 seconds).

Default value

long

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr(config-if-gi)# lacp timeout short

CODE

port-channel load-balance

The command sets the load balancing mechanism for channel aggregation groups.

The use of a negative form (no) of the command sets the default value.

Syntax

port-channel load-balance {src-dst-mac-ip|src-dst-mac|src-dst-ip|src-dst-mac-ip-port}

no port-channel load-balance

Parameters for ESR-1000, ESR-1200 ESR-1500, ESR-1511 and ESR-1700

– src-dst-mac – balancing mechanism is based on source and destination MAC address;

– src-dst-ip – balancing mechanism is based on source and destination IP address;

– src-dst-mac-ip – balancing mechanism is based on source and destination MAC addresses and IP addresses;

src-dst-ip-port – balancing mechanism is based on source and destination IP addresses and tcp/udp ports;

– src-dst-mac-ip-port – balancing mechanism is based on source and destination MAC address, IP address and port.

Parameters for ESR-10, ESR-12V, ESR-12VF, ESR-14VF, ESR-20, ESR-21, ESR-100, ESR-200 and ESR-3100

active-backup – all traffic is sent to one interface and redirected to another if the first one has passed to down status;

src-dst-mac – balancing mechanism is based on the MAC addresses of a sender and receiver;

src-dst-mac-ip – balancing mechanism is based on source and destination MAC addresses and IP addresses;

src-dst-ip-port – balancing mechanism is based on source and destination IP addresses and tcp/udp ports;

Default value

src-dst-mac

Required privilege level

10

Command mode

CONFIG

Example:

esr(config)# port-channel load-balance src-dst-mac-ip

CODE

show interfaces port-channel

The command displays information on members of channel aggregation group.

Syntax

show interfaces port-channel [<ID>]

Parameters

<ID> – sequence number of a channel aggregation group, takes values of [1..12].

Required privilege level

1

Command mode

ROOT

Example:

esr# show interfaces port-channel 1
load-balance: src-dst-mac
Channels   Ports
--------   ----------------------------------------
po1        gi1/0/21

CODE

show lacp counters

In the current firmware version this functionality is supported only by ESR-1000/1200/1500/1511/1700 routers

The command displays the statistics on LACP operation for Ethernet interface.

Syntax

show lacp counters [ <IF> ]

Parameters

<IF> – an interface's name, specified in the form described in Section Types and naming order of router interfaces.

You may specify several interfaces in the command. If interface indexes are not specified, then the statistics on all interfaces of a specified group will be shown. If a certain interface is specified, the detailed information on this interface will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show lacp counters port-channel 2
Interface          Sent           Recv           Link failure
----------------   ------------   ------------   ------------
po2                42             814            2

CODE

show lacp interfaces

The command displays LACP information.

Syntax

show lacp interfaces [ <IF> ]

Parameters

<IF> – a physical or aggregated interface's name specified in the form described in Section Types and naming order of router interfaces.

You may specify several interfaces in the command. If interface indexes are not specified, then LACP information will be shown for all interfaces of a specified group.

Required privilege level

1

Command mode

ROOT

Example:

esr# show lacp interfaces port-channel 2
port-channel 2 [aggregator 1, active] ports count: 1
                   Actor Port             Partner Port
----------------   --------------------   --------------------
System Priority    32768                  1
System MAC         a8:f9:4b:aa:12:40      a8:f9:4b:83:01:80
Key                8000                   1
port-channel 2 [aggregator 2, backup] ports count: 1
                   Actor Port             Partner Port
----------------   --------------------   --------------------
System Priority    32768                  65535
System MAC         a8:f9:4b:aa:12:40      00:00:00:00:00:00
Key                8000                   FFFF
esr# show lacp interfaces gigabitethernet 1/0/1
gigabitethernet 1/0/1 [active] up
                   Actor Port     Partner Port
----------------   ------------   ------------
Port Priority      32768          1
LACP Activity      Active         Active

CODE

show lacp parameters

The command displays LACP configuration parameters for Ethernet interface.

Syntax

show lacp parameters [ <IF> ]

Parameters

<IF> – a physical interface's name specified in the form described in Section Types and naming order of router interfaces. The use of only physical interfaces is possible.

You may specify several interfaces in the command. If interface indexes are not specified, then the parameters of all interfaces of a specified group will be shown. If a certain interface is specified, the detailed information on this interface will be displayed.

Required privilege level

1

Command mode

ROOT

Example:

esr# show lacp parameters tengigabitethernet 1/0/2
   LACP parameters
   ~~~~~~~~~~~~~~~
Interface   Port Priority   Timeout   Mode
---------   -------------   -------   -------
te1/0/2    32768           Short     Active

CODE

E1/multilink

enable

The command enables a PPP user.

The use of a negative form (no) of the command disables a PPP user.

Syntax

[no] enable

Parameters

The command does not contain parameters.

Default value

PPP user disabled.

Required privilege level

10

Command mode

CONFIG-PPP-USER

Example:

esr(config-ppp-user)# enable

CODE

ip tcp header-compression

The command enables TCP header compression protocol. The protocol is used to improve performance of low-speed channels.

The use of a negative (no) form of the command disables TCP header compression protocol.

Syntax

[no] ip tcp header-compression

Parameters

None.

Required privilege level

10

Command mode

CONFIG-E1

CONFIG-MULTILINK

Example:

(config-e1)# ip tcp header-compression

CODE

ip tcp compression-connections

The command specifies a number of simultaneous tcp connections for which TCP header compression protocol will be used.

The use of a negative (no) form of a command sets a default number of simultaneous tcp connections for which TCP header compression protocol will be used.

Syntax

ip tcp compression-connections <NUMBER>

no ip tcp compression-connections

Parameters

<NUMBER> – a number of simultaneous tcp connections for which a tcp headers compression protocol will be used. Can take values [2..16].

Default value

16

Required privilege level

10

Command mode

CONFIG-E1

CONFIG-MULTILINK

Example:

esr:esr(config-e1)# ip tcp compression-connections 32
esr:esr(config-e1)#

CODE

mrru

The command specifies the maximum size of a received packet for MLPPP interface.

The use of a negative form (no) of the command sets the default mrru value.

Syntax

mrru { <MRRU> }

no mrru

Parameters

<MRRU> – maximum size of a received packet for MLPP interface, takes value in the range of [1500..10000].

Default value

1500

Required privilege level

10

Command mode

CONFIG-MULTILINK

Example:

esr(config-multilink)# mrru 1700

CODE

password

Set encrypted or unencrypted password for a specific user to authenticate the remote party. User password is kept in configuration in encrypted form. During configuration you can specify unencrypted password or copy encrypted password from another device.

The use of a negative form (no) of the command removes a user’s password.

Syntax

password ascii-text { <CLEAR-TEXT> | encrypted <ENCRYPTED-TEXT> }

no password

Parameters

<CLEAR-TEXT> – unencrypted password, set by the string of [1..64] characters, may include [0-9a-fA-F] characters;

<ENCRYPTED-TEXT> – unencrypted password, set by the string of [2..128] characters.

The password are kept in encrypted form independently of format used when entering the command.

Required privilege level

15

Command mode

CONFIG-PPP-USER

Example:

esr(config-ppp-user)# password ascii-text 01234567

CODE

ppp authentication chap

The command enables CHAP authentication.

The use of a negative form (no) of the command disables the authentication.

Syntax

[no] ppp authentication chap

Parameters

The command does not contain parameters.

Required privilege level

15

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)# ppp authentication chap

CODE

ppp chap hostname

Specify the router name that is sent to a remote party for CHAP authentication.

The use of a negative form (no) of the command sets the default value.

Syntax

ppp chap hostname <NAME>

no ppp chap hostname

Parameters

<NAME> – router name, set by the string of up to 31 characters.

Default value

Device system name (hostname).

Required privilege level

15

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)# ppp chap hostname esr1

CODE

ppp chap password

Specify the password that is sent with the router name to a remote party for CHAP authentication.

The use of a negative form (no) of the command removes the password.

Syntax

ppp chap password ascii-text { <CLEAR-TEXT> | encrypted <ENCRYPTED-TEXT> }

no ppp chap password

Parameters

<CLEAR-TEXT> – unencrypted password, set by the string of [1..64] characters, may include [0-9a-fA-F] characters;

<ENCRYPTED-TEXT> – unencrypted password, set by the string of [2..128] characters.

The password is kept in encrypted form independently of format used when entering the command.

Required privilege level

15

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)# ppp chap password ascii-text 01234567

CODE

ppp chap refuse

The command enables authentication ignoring.

The use of a negative form (no) of the command sets the default value.

Syntax

[no] ppp chap refuse

Parameters

The command does not contain parameters.

Default value

Authentication ignoring is disabled.

Required privilege level

15

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)# ppp chap refuse

CODE

ppp chap username

The command specifies a user for remote party authentication and switches to user configuration mode.

The use of a negative form (no) of the command removes a specified user.

Syntax

[no] ppp chap username <NAME>

Parameters

<NAME> – user name, set by the string of up to 31 characters.

Required privilege level

15

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)# ppp chap username xap

CODE

ppp ipcp accept-address

The command ensures any non-null IP address to be accepted as a local IP address from the neighbor.

The use of a negative form (no) of the command sets the default value.

Syntax

[no] ppp ipcp accept-address

Parameters

The command does not contain parameters.

Default value

IP address reception is prohibited.

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)# ppp ipcp accept-address

CODE

ppp ipcp remote-address

The command sets IP address that is sent to a remote party for the further allocation.

The use of a negative form (no) of the command removes remote party IP address.

Syntax

ppp ipcp remote-address <ADDR>

no ppp ipcp remote-address

Parameters

<ADDR> – IP address of a remote gateway.

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)# ppp ipcp remote-address 192.168.1.2

CODE

ppp max-configure

The command sets the amount of attempts to send Configure-Request packets before the remote peer is found to be unable to respond.

The use of a negative form (no) of the command sets the default value.

Syntax

ppp max-configure <VALUE>

no ppp max-configure

Parameters

<VALUE> – time in seconds, takes values of [1..255].

Default value

10

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-e1)#i ppp max-configure 4

CODE

ppp max-failure

The command sets the amount of attempts to send Configure-NAK packets before all options are confirmed.

The use of a negative form (no) of the command sets the default value.

Syntax

ppp max-failure <VALUE>

no ppp max-failure

Parameters

<VALUE> – time in seconds, takes values of [1..255].

Default value

10

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-if-gi)#i ppp max-failure 3

CODE

ppp max-terminate

The command sets the amount of attempts to send Terminate-Request packets before the session is aborted.

The use of a negative form (no) of the command sets the default value.

Syntax

ppp max-terminate <VALUE>

no ppp max-terminate

Parameters

<VALUE> – time in seconds, takes values of [1..255].

Default value

2

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-if-gi)#i ppp max-terminate 4

CODE

ppp mru

The command sets MRU (Maximum Receive Unit) size for the interface.

The use of a negative form (no) of the command sets the default MRU value.

Syntax

ppp mru <MRU>

no ppp mru

Parameters

<MRU> – MRU value, takes values in the range of [552..1500].

Default value

1500

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-if-gi)# mru 1400

CODE

ppp multilink

The command enables MLPPP mode on E1 interface.

The use of a negative form (no) of the command disables MLPPP mode.

Syntax

[no] ppp multilink

Parameters

The command does not contain parameters.

Required privilege level

10

Command mode

CONFIG-E1

Example:

esr(config-e1)# ppp multilink

CODE

ppp multilink-group

The command adds E1 interface to aggregation group.

The use of a negative form (no) of the command removes an interface from aggregation group.

Syntax

ppp multilink-group <GROUP-ID>

Parameters

<GROUP-ID> – group identifier, takes values in the range of [1..4].

Required privilege level

10

Command mode

CONFIG-E1

Example:

esr(config-e1)# ppp multilink-group 1

CODE

ppp timeout keepalive

The command specifies the time interval in seconds after which the router sends a keepalive message.

The use of a negative form (no) of the command sets the default value.

Syntax

ppp timeout keepalive [ <TIME >]

no ppp timeout keepalive

Parameters

<TIME> – time in seconds, takes values of [1..32767].

Default value

10

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-if-gi)# ppp timeout keepalive 200

CODE

ppp timeout retry

The command specifies the time interval in seconds after which the router reiterates the request to establish a session.

The use of a negative form (no) of the command sets the default value.

Syntax

ppp timeout retry <TIME>

no ppp timeout retry

Parameters

<TIME> – time in seconds, takes values of [1..255].

Default value

3

Required privilege level

10

Command mode

CONFIG-SERIAL

CONFIG-E1

CONFIG-MULTILINK

Example:

esr(config-if-gi)# ppp timeout retry 3

CODE

show controllers e1

The command displays information on E1 controllers.

Syntax

show controllers e1 [<IF>]

Parameters

<IF> – a physical interface's name specified in the form described in Section Types and naming order of router interfaces;

Required privilege level

1

Command mode

ROOT

Example:

esr# show controllers e1 
Interface 'te1/0/1':
 SFP present:     Yes
 SFP Vendor name: NSC-COM
 SFP Vendor PN:   611.900
 Line code:       HDB3
 Clock source:    Internal
 Timeslot:        24
 Invert Data:     No
 Framing CRC4:    No
 Loopback:        --
 CRC algorithm:   FCS16
 E1 Link:         Down
 E1 Synced:       No
 E1 RX AIS:       No
 E1 RX RAI:       No

CODE

switchport e1 slot

The command binds e1 port to a physical interface. The use of a negative form (no) of the command switches to standard mode.

Syntax

[no] switchport e1 slot <SLOT>

Parameters

<SLOT> – slot identifier, takes values in the range of [0..12].

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr(config-if-gi)# switchport e1 0

CODE

switchport e1 clock source

The command defines a e1 interface's synchronization source.

The use of a negative form (no) of the command sets the default value.

Syntax

switchport e1 clock source { internal | line }

no switchport e1 clock source

Parameters

internal – internal synchronization source is used;

line – a signal from the line is used for synchronization.

Default value

internal

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr:esr(config-if-gi)# switchport e1 clock source line

CODE

switchport e1 crc

The command defines a mode for integrity check of data transmitted.

The use of a negative form (no) of the command sets the default value.

Syntax

switchport e1 crc { 16 | 32 }

no switchport e1 crc

Parameters

16 – a 16-bit Cyclic redundancy check (СRC) algorithm is used;

32 – a 32-bit Cyclic redundancy check (СRC) algorithm is used;

Default value

16

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr:esr(config-if-gi)# switchport e1 crc 16

CODE

switchport e1 framing

The command enables integrity check based on CRC4 algorithm

The use of a negative form (no) of the command sets the default value.

Syntax

switchport e1 framing { crc4 | no-crc4 }

no switchport e1 framing

Parameters

crc4 – enable CRC4-based integrity check;

no-crc4 – disable CRC4-based integrity check.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr:esr(config-if-gi)# switchport e1 framing crc4

CODE

switchport e1 invert data

The command enables reverse data sending.

The use of a negative form (no) of the command sets the default value.

Syntax

[no] switchport e1 invert data

Parameters

None.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr:esr(config-if-gi)# switchport e1 invert data

CODE

switchport e1 linecode

The command defines an algorithm for data encryption to transmit it via a physical channel.

The use of a negative form (no) of the command sets the default value.

Syntax

switchport e1 linecode { ami | hdb3 }

Parameters

ami – use ami algorithm;

hdb3 – use hdb3 algorithm.

Default value

hdb3

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr:esr(config-if-gi)# switchport e1 linecode ami

CODE

switchport e1 timeslots

The command defines a number of 64kbps channels in one E1.

The use of a negative form (no) of the command sets the default value.

Syntax

switchport e1 timeslots < RANGE >

no switchport e1 timeslots

Parameters

< RANGE > – the number of 64 kbps channels, takes values [1..31].

Default value

31

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr:esr(config-if-gi)# switchport e1 timeslots 16

CODE

switchport e1 unframed

The command enables the mode according to which E1 is not splitted to 64kbps channels and used as a single one.

The use of a negative form (no) of the command sets the default value.

Syntax

[no] switchport e1 unframed

Parameters

None.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr:esr(config-if-gi)# switchport e1 unframed

CODE

switchport mode e1

The command switches a physical port to SFP e1 module operation mode.

The use of a negative form (no) of the command switches a port to standard mode.

Syntax

[no] switchport mode e1

Parameters

The command does not contain parameters.

Required privilege level

10

Command mode

CONFIG-GI

CONFIG-TE

Example:

esr(config-if-gi)# switchport mode e1

CODE

Serial interfaces

Only for ESR-21

chat-script

The command is used to create chat-script, which can be used when connecting via dialup.

The use of a negative form (no) of the command removes the chat-script.

Syntax

chat-script <NAME> <TEXT>

no chat-script { <NAME> | all }

Parameters

<NAME> – script name, set by the string of up to 31 characters.

<TEXT> – script content, set by the string of up to 255 characters. It is necessary to enclose the script in parentheses and shield spaces and specialized symbols with the "\" symbol.

all — the key used to delete all created scripts.

Required privilege level

15

Command mode

CONFIG

Example:

esr(config)# chat-script DIAL "\(ABORT ERROR ABORT BUSY \"\" \"ATZ\" OK \"ATDTT\" TIMEOUT 30 CONNECT\)"

CODE

clear line aux

This command is used to remove serial interface sessions.

Syntax

clear line aux [ <NUM> ]

Parameters

<NUM> – a number of a serial interface in the range [1..3].

Required privilege level

15

Command mode

ROOT

Example:

esr# clear line aux 2

CODE

databits

The command specifies a number of data bits sent.

The use of a negative form (no) of the command sets the default value.

Syntax

databits <BITS>

no databits

Parameters

<BITS> – a number of data bits sent. Takes values [7..8]

Default value

8

Required privilege level

15

Command mode

CONFIG-LINE-AUX

Example:

esr(config-line-aux)# databits 7

CODE

dialer

This command is used to enable dialer function.

The use of a negative form (no) of the command disables this feature.

Syntax

[no] dialer

Parameters

The command does not contain parameters.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-SERIAL

Example:

esr(config-serial)# dialer

CODE

dialer idle-timeout

This command sets the time of connection holding in the absence of traffic.

The use of a negative form (no) of the command sets the default value.

Syntax

dialer idle-timeout <TIME>
no dialer idle-timeout

Parameters

<TIME> – time of connection holding in the absence of traffic in seconds, takes value in the range [1..65535].

Default value

30

Required privilege level

10

Command mode

CONFIG-SERIAL

Example:

esr(config-serial)# dialer idle-timeout 210

CODE

dialer in-band

This command enables the V.25bis mode at the serial interface.

The use of a negative form (no) of the command sets the default value.

Syntax

[no] dialer in-band

Parameters

The command does not contain parameters.

Default value

Disabled.

Required privilege level

10

Command mode

CONFIG-SERIAL

Example:

esr(config-serial)# dialer in-band

CODE

dialer map

This command specifies the correspondence of IP subnetworks and dial-up numbers for access to these subnetworks.

The use of a negative form (no) of the command sets the default value.

Syntax

dialer map ip <SUBNET> name <PPPUSER> [ modem-script <SCRIPT-NAME> ] <PHONE-NUM>
no dialer map ip

Parameters

<SUBNET> – destination address, specified as AAA.BBB.CCC.DDD/NN, where AAA-DDD may take values [0..255] and NN may take values [1..32].

<PPPUSER> – user name for dialer, set by the string of up to 31 characters.

<SCRIPT-NAME> – name of the dialer script, set by the string of up to 31 characters.

<PHONE-NUM> – number for dialer. Specified by a string of up to 15 characters, it is possible to use only digits.

Default value

None

Required privilege level

10

Command mode

CONFIG-SERIAL

Example:

esr(config-serial)# dialer map ip 192.168.33.0/27 name SITE12 5512

CODE

dialer string

This command sets the phone number for dialup modem connection.

The use of the negative form of the command (no) removes the phone number for connection establishing via dialup modem.

Syntax

dialer string <PHONE-NUM>
no dialer string

Parameters

<PHONE-NUM> – phone number for dialer. Specified by a string of up to 15 characters, it is possible to use only digits.

Default value

None

Required privilege level

15

Command mode

CONFIG-SERIAL

Example:

esr(config-serial)# dialer string 3835401

CODE

flowcontrol

The command sets a mode of data flow control.

The use of a negative form (no) of the command sets the default value.

Syntax

flowcontrol <MODE>

no flowcontrol

Parameters

<MODE> – data flow control mode. Takes the following values:

software – sowtware flow control;
hardware – hardware flow control;
disabled – flow control disabled.

Default value

Disabled.

Required privilege level

15

Command mode

CONFIG-LINE-AUX

Example:

esr(config-line-aux)# flowcontrol software

CODE

line aux

The command switches to the configuration mode of a serial interface.

Syntax

line aux <NUM>

Parameters

<NUM> – a number of a serial interface from the range [1..3].

Required privilege level

15

Command mode

CONFIG

Example:

esr(config)# line aux 1
esr(config-line-aux)#

CODE

modem inout

The command switches a serial interface to the mode of operation with a modem.

The use of a negative form of the command (no) switches a serial interface to the console server mode.

Syntax

modem inout

no modem inout

Parameters

None.

Default value

By default, a serial interface operates in the console server mode.

Required privilege level

15

Command mode

CONFIG-LINE-AUX

Example:

esr(config-line-aux)# modem inout

CODE

parity

The command enables a parity bit setting mode.

The use of a negative form (no) of the command sets the default value.

Syntax

parity <MODE>

no parity

Parameters

<MODE> – parity bit setting mode. Takes the following values:

odd – a check for oddness
even –a check for evenness
none – parity bit is not set.

Default value

none.

Required privilege level

15

Command mode

CONFIG-LINE-AUX

Example:

esr(config-line-aux)# parity even

CODE

show line aux

The command is used to display serial interfaces status.

Syntax

show line aux [ <NUM> ]

Parameters

<NUM> – a number of a serial interface in the range [1..3].

Required privilege level

10

Command mode

ROOT

Example:

esr# show line aux
AUX Line 1
 Baud rate:            115200
 Databits:             8
 Parity:               NONE
 Stopbits:             1
 Flowcontrol:          Disabled
 Timeout Exec (min):   300
 Telnet port:          2001
 Modem mode:           Disabled

CODE

speed

The command sets a speed for a serial interface.

The use of a negative form (no) of the command sets the default value.

Syntax

speed <SPEED>

no speed

Parameters

<SPEED> – a speed of a serial interface in bps. Takes the following values:

300;
1200;
2400;
4800;
9600;
19200;
38400;
57600;
115200.

Default value

115200.

Required privilege level

15

Command mode

CONFIG-LINE-AUX

Example:

esr(config-line-aux)# speed 9600

CODE

stopbits

The command sets the number of stop bits transmitted.

The use of a negative form (no) of the command sets the default value.

Syntax

stopbits <STOP-BITS>

no stopbits

Parameters

<STOP-BITS> – the number of stop bits transmitted. Takes values in the range of [1..2].

Default value

1

Required privilege level

15

Command mode

CONFIG-LINE-AUX

Example:

esr(config-line-aux)# stopbits 2

CODE

transport telnet port

In the command a TCP port number for console server mode is specified. When connecting to the router's IP address and to a TCP port configured by the command via telnet, a user will be connected to a console interface of a device connected to the router's serial interface.

The use of a negative (no) form of a command deletes a TCP port number for console server mode.

Syntax

transport telnet port <PORT>

no transport telnet port

Parameters

<PORT> – TCP port number for console server mode. Takes values in the range of [1..65535].

Default value

None

Required privilege level

15

Command mode

CONFIG-LINE-AUX

Example:

esr(config-line-aux)# transport telnet port 2001

CODE

Wireless modems

allowed-auth

The command specifies method of user authentication in a mobile network.

The use of a negative form (no) of the command sets the default authentication method.

Syntax

allowed-auth <TYPE>

no allowed-auth

Parameters

<TYPE> – method of user authentication in a mobile network [none, PAP, CHAP, MSCHAP, MSCHAPv2, EAP]

Default value

PAP

Required privilege level

15

Command mode

CONFIG-CELLULAR-PROFILE

Example:

esr(config-cellular-profile)# allowed-auth MSCHAP

CODE

allowed-mode

The command allows the use of the mode while USB-modem operation.

The use of a negative form (no) of the command removes a permission to use the mode.

Syntax

[no] allowed-mode <MODE>

Parameters

<MODE> – acceptable USB modem operation mode [2g, 3g, 4g]

Default value

The modes displayed as 'Allowed modes:' in show cellular status modem <ID> command output are allowed.

Required privilege level

10

Command mode

CONFIG-CELLULAR-MODEM

Example:

esr(config-cellular-modem)# allowed-mode 4g

CODE

apn

The command specifies mobile network access point.

Syntax

apn <NAME>

Parameters

<NAME> – mobile network access point, set by the string of up to 255 characters.

Default value

Not configured.

Required privilege level

10

Command mode

CONFIG-CELLULAR-PROFILE

Example:

esr(config-cellular-profile)# apn internet

CODE

cellular modem

The command creates USB modem with a certain identifier and switches to USB modem configuration mode.

The use of a negative form (no) of the command removes a configured USB modem.

Syntax

[no] cellular modem <ID>

Parameters

<ID> – USB modem identifier, set in the range of [1..10].

Required privilege level

10

Command mode

CONFIG

Example:

esr(config)# cellular modem 1

CODE

cellular profile

The command creates parameter profile for USB modem with a certain identifier and switches to profile configuration mode.

The use of a negative form (no) of the command removes a configured parameter profile of USB modem.

Syntax

[no] cellular profile <ID>

Parameters

<ID> – identifier of USB modem parameter profile, set in the range of [1..10].

Required privilege level

10

Command mode

CONFIG

Example:

esr(config)# cellular profile 1

CODE

device

The command specifies the identifier of connected modem’s USB port.

The use of a negative form (no) of the command removes a set identifier.

Syntax

device <WORD>

no device

Parameters

<WORD> – identifier of connected modem’s USB port, set in the range of [1..12].

The identifier should match the identifier in 'USB port device' field in show cellular status modem command output.

Default value

Not specified.

Required privilege level

10

Command mode

CONFIG-CELLULAR-MODEM

Example:

esr(config-cellular-modem)# device 1-1

CODE

enable

The command enables USB modem.

The use of a negative form (no) of the command disables USB modem.

Syntax

[no] enable

Parameters

The command does not contain parameters.

Default value

USB modem is disabled.

Required privilege level

10

Command mode

CONFIG-CELLULAR-MODEM

Example:

esr(config-cellular-modem)#

CODE

ip-version

The command restricts the ability to use IP addresses families in a mobile network.

The use of a negative form (no) of the command allows the use of both IPv4 and IPv6 families addressing.

Syntax

ip-version { ipv4 | ipv6 }

no ip-version

Parameters

ipv4 – ipv4 family;

ipv6 – ipv6 family;

Default value

Both IPv4 and IPv6 addressing is allowed.

Required privilege level

10

Command mode

CONFIG-CELLULAR-PROFILE

Example:

esr(config-cellular-profile)# ip-version ipv4

CODE

mru

The command sets the maximum size of a received packet.

The use of a negative form (no) of the command sets the default value.

Syntax

mru { <MRU> }

no mru

Parameters

<MRU> – MRU value, takes values in the range of [128..16383].

Default value

1500

Required privilege level

10

Command mode

CONFIG-CELLULAR-MODEM

Example:

esr(config-cellular-modem)# mru 1476

CODE

number

The command sets a dial-up number for connection to a mobile network.

The use of a negative form (no) of the command removes a dial-up number for connection to a mobile network.

Syntax

number <WORD>

no number

Parameters

<WORD> – dial-up number for connection to a mobile network, set by the string from 1 to 15 characters.

Default value

The number is not specified.

Required privilege level

10

Command mode

CONFIG-CELLULAR-PROFILE

Example:

esr(config-cellular-profile)# number *99#

CODE

password

The command sets the password of mobile network user in unencrypted or encrypted form. User password is kept in configuration in encrypted form. During configuration you can specify unencrypted password or copy encrypted password from another device.

The use of a negative form (no) of the command removes a user’s password.

Syntax

password ascii-text { <CLEAR-TEXT> | encrypted <ENCRYPTED-TEXT> }

no password

Parameters

<CLEAR-TEXT> – unencrypted password, set by the string of [1..64] characters, may include [0-9a-fA-F] characters;

<ENCRYPTED-TEXT> – unencrypted password, set by the string of [2..128] characters.

The password are kept in encrypted form independently of format used when entering the command.

Required privilege level

15

Command mode

CONFIG-PPP-USER

Example:

esr(config-ppp-user)# password ascii-text 01234567

CODE

pin

The command sets SIM card unblock code.

The use of a negative form (no) of the command removes SIM card unblock code.

Syntax

pin <WORD>

no pin

Parameters

<WORD> – SIM card unblock code [4..8] characters. Only digits are allowed.

Default value

PIN is not specified.

Required privilege level

15

Command mode

CONFIG-CELLULAR-MODEM

Example:

esr(config-cellular-modem)# pin 4856

CODE

preferred-mode

The command sets a preferable operation mode of USB modem in a mobile network.

The use of a negative form (no) of the command removes a preferable operation mode of USB modem in a mobile network.

Syntax

preferred-mode { <MODE> }

no preferred-mode

Parameters

<MODE> – preferable USB modem operation mode [ 2g, 3g, 4g ].

Default value

Defined by USB modem.

Required privilege level

10

Command mode

CONFIG-CELLULAR-MODEM

Example:

esr(config-cellular-modem)# preferred-mode 4g

CODE

profile

The command assigns a created parameter profile for USB modem.

The use of a negative form (no) of the command removes a created parameter profile for USB modem.

Syntax

profile <ID>

no profile

Parameters

<ID> – identifier of USB modem parameter profile, set in the range of [1..10].

Default value

Parameter profile ID is not specified.

Required privilege level

10

Command mode

CONFIG-CELLULAR-MODEM

Example:

esr(config-cellular-modem)# profile 1

CODE

show cellular configuration modem

The command displays the information on configured USB modems

Syntax

show cellular configuration modem [ <ID> ]

Parameters

<ID> – USB modem identifier, set in the range of [1..10].

When USB modem number is not specified, a table with brief information on all configured USB modems is displayed.

Required privilege level

10

Command mode

ROOT

Example:

esr# show cellular configuration modem
Number   State      Description                      USB port device   Profile
modem
------   --------   ------------------------------   ---------------   --------
1        Enabled    megafon                          1-1               1
2        Enabled    mts                              1-2               2

esr# show cellular configuration modem 2
State:             Enabled
Description:       mts
USB port device:   1-2
Pin:               --
MRU:               --
MTU:               1500
Preferred mode:    none
Allowed modes:     all
Profile:           2
Description:          MTS
  User name:            mts
  Number:               *99#
  APN:                  internet.mts.ru
  Password (encrypted): 91A010
  IP version:           both
  Allowed auth:         EAP
Security zone:     --

CODE

show cellular configuration profile

The command displays the information on configured USB modems profiles.

Syntax

show cellular configuration profile [ <ID> ]

Parameters

<ID> – USB modem identifier, set in the range of [1..10].

When USB modem number is not specified, a table with brief information on all configured USB modems is displayed.

Required privilege level

10

Command mode

ROOT

Example:

esr# show cellular configuration profile
Number    User name          APN                Number             Description
profile
-------   ----------------   ----------------   ----------------   ------------------------------
1         gdata              internet           *99#               MEGAFON
2         mts                internet.mts.ru    *99#               MTS

esr# show cellular configuration profile 1
Description:          MEGAFON
User name:            gdata
Number:               *99#
APN:                  internet
Password (encrypted): 9BB00279B1
IP version:           both
Allowed auth:         EAP

CODE

show cellulas status modem

The command displays information on connected USB modems' status.

Syntax

show cellular status modem [ <ID> ]

Parameters

<ID> – USB modem identifier, set in the range of [1..10].

Without specifying a USB modem number, a table with brief information on all detected USB modems is displayed

Required privilege level

1

Command mode

ROOT

Example:

esr# show cellular status modem
Number   USB port   Manufacturer   Model        Current state   Inteface          Link
device                                                                            state
------   --------   ------------   ----------   -------------   ---------------   -----
1        1-1        huawei         E3372        disabled        --                Down

esr# show cellulars status modem 1 
Interface 'modem 1' status information:   
	USB port device:         1-1   
	Manufacturer:            huawei   
	Model:                   E3372   
	Revision:                21.180.01.00.00   
	IMEI:                    861821036192893   
	Status SIM lock:         --   
	Status unlock retries:   sim-pin (3) sim-pin2 (3) sim-puk (10) sim-puk2 (10)   
	Current state:           disabled   
	Access tech:             unknown   
	Signal level:            0   
	Support modes:     
		allowed 2G; preferred none;     
		allowed 3G; preferred none;     
		allowed 4G; preferred none;     
		allowed 2G 3G 4G; preferred none;   
	Allowed modes:           2G 3G 4G   
	Preferred modes:         none   
	Type IP:                 IPv4   
	Operator name:   
	Registration:            unknown

CODE

user

The command specifies mobile network user name. After executing this command, the router enters the user parameters configuration mode.

The use of a negative form (no) of the command removes mobile network user name.

Syntax

[no] user <NAME>

Parameters

<NAME> – user name, set by the string from 1 to 31 characters.

Default value

User is not created.

Required privilege level

15

Command mode

CONFIG-CELLULAR-PROFILE

Example:

esr(config-cellular-profile)# user gdata

CODE

Phone port configuration

This functionality is supported only by ESR-12V/12VF/14VF routers

authentication name

The command assigns a user name that is used for authentication on SIP server (and registration server).

The use of a negative form (no) of the command removes the value.

Syntax

authentication name {<LOGIN> | as-phone}

no authentication name

Parameters

<LOGIN> – user name that is used for authentication, set by the string of up to 31 characters or by as-phone directive which means that user name for authentication will be equal to the phone number;

As-phone – user name for authentication, equal to the phone number.

Default value

None

Required privilege level

15

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxo)# authentication name userlogin

CODE

authentication password

The command assigns a password that is used for authentication on SIP server (and registration server).

The use of a negative form (no) of the command removes the value.

Syntax

authentication password { <PASS> | encrypted <ENCRYPTED-PASS>}

no authentication password

Parameters

<PASS> – authentication password, set by the string of up to 16 characters.

<ENCRYPTED-PASS> – hash password via sha512 algorithm, set by the string of [2..32] characters.

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# authentication password superpassword

CODE

call-forwarding busy

The command allows the use of CFB (Call Forward at Busy) service – call forwarding to a specified number at busy subscriber.

The use of a negative form (no) of the command restricts the use of CFB service..

Syntax

[no] call-forwarding busy

Parameters

The command does not contain parameters.

Default value

CFB service is disabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# call-forwarding busy

CODE

call-forwarding busy number

The command assigns a number, which incoming calls are forwarded to, with CFB service enabled.

The use of a negative form (no) of the command removes a call-forwarding busy number.

Syntax

call-forwarding busy number <PHONE>

no call-forwarding busy number

Parameters

<PHONE> – a number to which incoming calls are forwarded at busy subscriber, set by the string of up to 50 characters.

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# call-forwarding busy number 4596

CODE

call-forwarding no-answer

The command allows the use of CFNA (Call Forward at No Answer) service – call forwarding to a specified number at no subscriber answer.

The use of a negative form (no) of the command restricts the use of CFNA service.

Syntax

[no] call-forwarding no-answer

Parameters

The command does not contain parameters.

Default value

CFNA service is disabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# call-forwarding no-answer

CODE

call-forwarding no-answer number

The command assigns a number, which incoming calls are forwarded to, with CFNA service enabled.

The use of a negative form (no) of the command removes a call-forwarding no-answer number.

Syntax

call-forwarding no-answer number <PHONE>

no call-forwarding no-answer number

Parameters

<PHONE> – number to which incoming calls are forwarded at no subscriber answer, set by the string of up to 50 characters

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# call-forwarding no-answer number 4685

CODE

call-forwarding no-answer timeout

The command specifies time interval, within which call forwarding is performed at subscriber no answer, with CFNA service enabled.

The use of a negative form (no) of the command sets the default value.

Syntax

call-forwarding no-answer timeout <TIME>

no call-forwarding no-answer timeout

Parameters

<TIME> – time interval in seconds within which call forwarding is performed at subscriber no answer, takes the values of [0-120].

Default value

0

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# call-forwarding no-answer timeout 15

CODE

call-forwarding unconditional

The command enables the use of CFU (Call Forward Unconditional) service – all incoming calls are forwarded unconditionally to a specified number.

The use of a negative form (no) of the command restricts the use of CFB service..

Syntax

[no] call-forwarding unconditional

Parameters

The command does not contain parameters.

Default value

CFU service is disabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# call-forwarding unconditional

CODE

call-forwarding unconditional number

The command specifies a call-forwarding unconditional number.

The use of a negative form (no) of the command removes a call-forwarding unconditional number.

Syntax

call-forwarding unconditional number <PHONE>

no call-forwarding unconditional number

Parameters

<PHONE> – number to which incoming calls are forwarded with CFU service enabled, set by the string of up to 50 characters.

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# call-forwarding unconditional number 4685

CODE

call-waiting

The command enables the use of 'Call Waiting' service.

The use of a negative form (no) of the command restricts the use of 'Call Waiting' service.

Syntax

[no] call-waiting

Parameters

The command does not contain parameters.

Default value

CW service is disabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

CONFIG-VOIP-PROFILE

Example:

esr(config-voice-port-fxs)# call-waiting

CODE

caller-id mode

The command selects Caller ID distribution mode.

The use of a negative form (no) of the command disables Caller ID distribution.

Syntax

caller-id mode <MODE>

no caller-id mode

Parameters

<MODE> – Caller ID distribution mode, may take the following values:

auto – automatic detection of Caller-id method being used. Available only on FXO port;
dtmf – Caller ID detection by DTMF method. The number is served between the first and second ringing tones by double frequency DTMF ringings;
fsk-bell – Caller ID and name detection by FSK method according to Bell202 standard. The number is served between the first and second ringing tones by a stream of data with a frequency modulation;
fsk-v23 – Caller ID and name detection by FSK method according to ITU-T V.23 standard. Issuance of the number in a line is carried out between the first and the second ringing signal by data stream with frequency modulation.

Default value

Disables Caller ID.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

CONFIG-VOIP-PROFILE

Example:

esr(config-voice-port-fxs)# caller-id mode fsk-v23

CODE

dial-type

The command selects the mode of dialing by FXO set.

The use of a negative form (no) of the command restores the default value.

Syntax

dial-type <MODE>

no dial-type

Parameters

<MODE> – mode of dialing by FXO set, may take the following values:

dtmf – dialing by DTMF signal transmission;
pulse – dialing by sequential interlocking and unlocking of a phone line.

Default value

dtmf

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# dial-type pulse

CODE

enable

The command enables a profile or a rule set.

The use of a negative form (no) of the command disables a profile or a set of rules.

Syntax

[no] enable

Parameters

The command does not contain parameters.

Default value

Not enabled.

Required privilege level

10

Command mode

CONFIG-VOIP-PROFILE

Example:

esr(config-config-voip-sip-proxy)# enable

CODE

flash call-transfer

The command selects flash function (flash call transfer) usage mode.

The use of a negative form (no) of the command returns the default value.

Syntax

flash call-transfer <METHOD>

no flash call-transfer

Parameters

<METHOD> – flash function usage mode, may take the following values:

attended – flash is proceeded by the device locally (call transfer is carried out after the connection with the third subscriber is established);
unattended – flash is proceeded by the device locally (call transfer is carried out after the third subscriber dial ends);
transmit-flash – flash transfer to channel (by any method configured with transfer flash command in SIP profile parameters);
local-transfer – call transfer within the device, without sending REFER message.

Default value

transmit-flash

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

CONFIG-VOIP-PROFILE

Example:

esr(config-voice-port-fxs)# flash call-transfer attended

CODE

flash call-transfer mode

The command selects call transfer mode – configuration is available only for Attended calltransfer and Local calltransfer and is in charge for call transfer service enable mode.

The use of a negative form (no) of the command returns the default value.

Syntax

flash call-transfer mode <MODE>

no flash call-transfer mode

Parameters

<MODE> – call transfer mode, may take the following values:

r4 – call transfer is enabled after pressing R 4;
hook – call transfer is enabled after going on-hook;
both – call transfer is enabled after going on-hook and pressing R 4.

Default value

r4

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

CONFIG-VOIP-PROFILE

Example:

esr(config-voice-port-fxs)# flash call-transfer mode hook

CODE

flash timer

The command sets the minimum time of flash signal (flash call transfer) detection.

The use of a negative form (no) of the command returns the default value.

Syntax

flash timer <TIME>

no flash timer

Parameters

<TIME> – minimum time of flash signal detection in milliseconds, takes the values of [80..1000]

Default value

100

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

CONFIG-VOIP-PROFILE

Example:

esr(config-voice-port-fxs)# flash timer 200

CODE

hotline

The command enables 'Hot/Warm line' service. This service allows to establish an outgoing connection automatically without dialling the number right after the lifting of a headset – «hot line», or with a delay – «warm line».

Syntax

[no] hotline

Parameters

The command does not contain parameters.

Default value

'Hot/Warm line' service is disabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# hotline

CODE

hotline ipt

The command enables 'Hot/Warm line' service in the direction from analogue telephone line to VoIP.

The use of a negative form (no) of the command disables 'Hot/Warm line' service in the direction from analogue telephone line to VoIP.

Syntax

[no] hotline ipt

Parameters

The command does not contain parameters.

Default value

'Hot/Warm line' service is disabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# hotline ipt

CODE

hotline pstn

The command enables 'Hot/Warm line' service in the direction from VoIP to PSTN.

The use of a negative form (no) of the command disables 'Hot/Warm line' service in the direction from VoIP to PSTN.

Syntax

[no] hotline pstn

Parameters

The command does not contain parameters.

Default value

'Hot/Warm line' service is disabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# hotline pstn

CODE

hotline number

The command assigns phone number for the connection establishment when using 'Hot/Warm line' service.

The use of a negative form (no) of the command removes 'Hot/Warm line' service number.

Syntax

hotline number <PHONE>

no hotline number

Parameters

<PHONE> – phone number for the connection establishment after a phone is picked up, set by the string from 1 to 50 characters.

Default value

The value is not specified.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# hotline number 5462

CODE

hotline number ipt

The command assigns phone number for the connection establishment when using 'Hot/Warm line' service in the direction from analogue telephone line to VoIP.

The use of a negative form (no) of the command removes the number of 'Hot/Warm line' service in the direction from analogue telephone line to VoIP.

Syntax

hotline number ipt <PHONE>

no hotline number ipt

Parameters

<PHONE> – phone number which is called when using «Hot/Warm line» service in the direction from analogue telephone line to VoIP, set by the string from 1 to 50 characters.

Default value

The value is not specified.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# hotline number ipt 6347

CODE

hotline number pstn

The command assigns phone number for the connection establishment when using 'Hot/Warm line' service in the direction from VoIP to analogue telephone line.

The use of a negative form (no) of the command removes 'Hot/Warm line' service number in the direction from VoIP to analogue telephone line.

Syntax

hotline number pstn <PHONE>

no hotline number pstn

Parameters

<PHONE> – hot number for the call in PSTN direction, set by the string of up to 50 characters.

Default value

The value is not specified.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# hotline number pstn 5462

CODE

hotline timeout

The command sets 'Hotline timeout' before establishing the connection and after picking up a phone.

The use of a negative form (no) of the command returns the default value.

Syntax

hotline timeout <TIME>

no hotline timeout

Parameters

<TIME> – time interval in seconds within which connection with an opposing subscriber is established, takes the values of [0..60].

Default value

0

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# hotline timeout 10

CODE

hotline timeout ipt

The command sets 'Hotline timeout' before establishing the connection with 'Hot number' in the direction from analogue telephone line to VoIP.

The use of a negative form (no) of the command sets the default value.

Syntax

hotline timeout ipt <TIME>

no hotline timeout ipt

Parameters

<TIME> – time interval in seconds within which connection with an opposing subscriber is established, takes the values of [0..60].

Default value

0

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# hotline timeout ipt 10

CODE

hotline timeout pstn

The command sets 'Hotline timeout' before establishing the connection with 'Hot number' in the direction from VoIP to analogue telephone line.

The use of a negative form (no) of the command sets the default value.

Syntax

hotline timeout pstn <TIME>

no hotline timeout pstn

Parameters

<TIME> – time interval in seconds within which connection with an opposing subscriber is established, takes the values of [0..60].

Default value

0

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# hotline timeout pstn 10

CODE

hybrid rx

The command ensures incoming signal amplification.

Syntax

hybrid rx <NUM>

no hybrid rx

Parameters

<NUM> – takes values of [-200..200]

Default value

0

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# hybrid rx 100

CODE

hybrid tx

The command ensures outgoing signal amplification.

Syntax

hybrid rx <NUM>

no hybrid rx

Parameters

<NUM> – takes values of [-200..200]

Default value

0

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# hybrid rx 20

CODE

ipt prefix-name

The command specifies the prefix of CallerID name which is transmitted in VoIP direction.

The use of a negative form (no) of the command removes a specified value.

Syntax

ipt prefix-name <NAME>

no ipt prefix-name

Parameters

<NAME> – prefix that is added to CallerID name, set by the string from 1 to 21 characters.

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# ipt prefix-name localPSTN

CODE

ipt prefix-number

The command specifies the prefix of CallerID number which is transmitted in VoIP direction.

The use of a negative form (no) of the command removes a specified value.

Syntax

ipt prefix-number <NUMBER>

no ipt prefix-number

Parameters

<NUMBER> – prefix that is added to number in CallerID, set by the string from 1 to 21 characters.

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# ipt prefix-number 7

CODE

ipt offhook-ringing

The command sets the loop closure when calling from TDM to IP before voice channel forwarding in the VoIP direction.

The use of a negative form (no) of the command allows you not to close the loop when calling from TDM to IP until the vocal tract to SIP gateway, that interacts via the protocol, is received. The setting is used only in combination with 'Hotline' setting.

Syntax

[no] ipt offhook-ringing

Parameters

The command does not contain parameters.

Default value

Allows you not to close the loop when calling from TDM to IP before voice channel forwarding.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# no ipt offhook-ringing

CODE

ipt ring-number

The command sets the number of 'Call sendings' according to which FXO set will close the loop ('picks up the phone') and return a dial tone to phone line.

The use of a negative form (no) of the command sets the default value.

Syntax

ipt ring-number <COUNT>

no ipt ring-number

Parameters

<COUNT> – amount of 'Call sendings' according to which FXO set will close the loop, takes the value of [2..10].

Default value

2

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# ipt ring-number 4

CODE

profile sip

The command allows choosing a SIP profile for a port being configured.

Syntax

profile sip <PROFILE>

Parameters

<PROFILE> – SIP profile index, can take values [1..5].

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxo)# profile sip 1

CODE

profile pbx

The command allows choosing a SIP profile for a port being configured.

Syntax

profile pbx<PROFILE>

Parameters

<PROFILE> – name of the SIP profile created on the PBX server, set by a string from 1 to 31 characters.

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxo)# profile pbx fxs_ports

CODE

pstn transmit-number

The command sets the transmission of a number received from IP (from Request URI header of INVITE request) to the line, excluding port number.

The use of a negative form (no) of the command disables the transmission of number received from IP.

Syntax

[no] pstn transmit-number

Parameters

The command does not contain parameters.

Default value

Not to transmit full number.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# pstn transmit-number

CODE

pstn transmit-prefix

The command sets the transmission of FXO set subscriber number.

The use of a negative form (no) of the command disables the transmission of FXO set subscriber number.

Syntax

[no] pstn transmit-prefix

Parameters

The command does not contain parameters.

Default value

Transmit FXO set’s subscriber number.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# pstn transmit-prefix

CODE

shutdown

The command disables a port.

The use of a negative form (no) of the command enables the port.

Syntax

[no] shutdown

Parameters

The command does not contain parameters.

Default value

Port enabled.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# shutdown

CODE

sip port

The command specifies UDP port number to receive SIP messages coming to the account as well as to send outgoing SIP messages from the account.

The use of a negative form (no) of the command returns the default value.

Syntax

sip port <PORT>

no sip port

Parameters

<PORT> – UDP port number, takes values of [1..65535].

Default value

5060

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# sip port 5080

CODE

sip user display-name

The command allows you to specify user name matched with the port (displayed in ‘Display-Name’ field of ‘From’ header in outgoing SIP messages).

The use of a negative form (no) of the command removes the value.

Syntax

sip user display-name <LOGIN>

no sip user display-name

Parameters

<LOGIN> – user name displayed in the Display-Name field, set by the string of up to 31 characters.

Default value

None

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# sip user display-name "port-1"

CODE

sip user phone

The command assigns a subscriber number reserved for a telephone port.

The use of a negative form (no) of the command removes a subscriber number.

Syntax

sip user phone <PHONE>

no sip user phone

Parameters

<PHONE> – subscriber number reserved for a telephone port, set by the string of up to 50 characters.

Default value

The value is not specified.

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

CONFIG-VOICE-PORT-FXS

Example:

esr(config-voice-port-fxs)# sip user phone 4101

CODE

timing delay

The command sets the delay before dialling.

The use of a negative form (no) of the command sets the default value.

Syntax

timing delay <TIME>

no timing delay

Parameters

<TIME> – delay before dialling in seconds, takes the values of [0..10].

Default value

2

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# timing delay 4

CODE

timing digit

The command sets a minimally detectable interdigit interval for FXS port.

The use of a negative form (no) of the command sets the default value.

Syntax

timing digit <TIME>

no timing pulse-interdigit

Parameters

<TIME> – minimum interdigit interval in milliseconds, takes values of [150..20000].

Default value

200

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXS

CONFIG-VOIP-PROFILE

Example:

esr(config-voice-port-fxs)# timing interdigit 300

CODE

timing flash

The command sets time of loop closure to simulate 'flash' pulse.

The use of a negative form (no) of the command sets the default value.

Syntax

timing flash <TIME>

no timing flash

Parameters

<TIME> – time of loop closure in milliseconds, takes values of [70..1000].

Default value

100

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# timing flash 150

CODE

timing pulse-digit

The command sets the impulse duration under pulse dialing.

The use of a negative form (no) of the command sets the default value.

Syntax

timing pulse-digit <TIME>

no timing pulse-digit

Parameters

<TIME> – signal pulse width during pulse dialing in milliseconds, takes the values of [50..120].

Default value

80

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# timing pulse-digit 75

CODE

timing pulse-interdigit

The command sets interdigit interval when pulse dialing to analogue telephone line for FXO port.

The use of a negative form (no) of the command sets the default value.

Syntax

timing pulse-interdigit <TIME>

no timing pulse-interdigit

Parameters

<TIME> – interdigit interval during pulse dialing in milliseconds, takes the values of [80..2500].

Default value

200

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# timing pulse-interdigit 300

CODE

timing pulse-pause

The command sets the pause duration under pulse dialing.

The use of a negative form (no) of the command sets the default value.

Syntax

timing pulse-pause <TIME>

no timing pulse-pause

Parameters

<TIME> – pause duration when pulse dialing in milliseconds, takes the values of [50..100].

Default value

80

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# timing pulse-pause 75

CODE

timing tone-digit

The command sets the tone duration under pulse dialing.

The use of a negative form (no) of the command sets the default value.

Syntax

timing tone-digit <TIME>

no timing tone-digit

Parameters

<TIME> – tone duration with DTMF dialing in milliseconds, takes the values of [65..100].

Default value

80

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# timing tone-digit 75

CODE

timing tone-interdigit

The command sets the pause duration under DTMF dialing.

The use of a negative form (no) of the command sets the default value.

Syntax

timing tone-interdigit <TIME>

no timing tone-interdigit

Parameters

<TIME> – pause duration with DTMF dialing in milliseconds, takes the values of [80..2500].

Default value

100

Required privilege level

10

Command mode

CONFIG-VOICE-PORT-FXO

Example:

esr(config-voice-port-fxo)# timing tone-interdigit 150

CODE

Phone port testing

This functionality is supported only by ESR-12V/12VF/14VF routers

test voice-port start

The command starts the procedure of subscriber line electric performance measurement.

Syntax

test voice-port <NUM> start

Parameters

<NUM> – FXS proxy number, takes values of [1..3].

Required privilege level

1

Command mode

ROOT

Example:

esr# test voice-port 3 start 
Voice-port 3 test started. The result will be available in 80 seconds, or more if the test run on other ports.

CODE

test voice-port status

The command displays the results of last procedure of subscriber line electrical performance measurement.

Syntax

test voice-port <NUM> status

Parameters

<NUM> – FXS proxy number, takes values of [1..3].

Required privilege level

1

Command mode

ROOT

Example:

esr# test voice-port 3 status 
Testing voice-port 3 is idle
Last test start: Sat May 20 16:01:37 2017
Number voip-port 3
  Foreign DC voltage A (TIP):    0.128377 U
  Foreign DC voltage B (RING):   0.144342 U
  Foreign AC voltage A (TIP):    0.026239 U
  Foreign AC voltage B (RING):   0.032287 U
  Cross current:                 0.260343 mA
  Longitudinal current:          -0.101857 mA
  Line supply voltage:           -50.370598 U
  Resistance A (TIP) – B (RING): 1007.203674 kOm
  Resistance A (TIP) – Ground:   402.105469 kOm
  Resistance B (RING) – Ground:  874.041443 kOm
  Capacity A (TIP) – B (RING):   50.000000 nF
  Capacity A (TIP) – Ground:     573.000000 nF

CODE