ET/HDLC Command Line Utilities for BSD Un*x and LINUX

The following describes the syntax and function of the ET/HDLC command line utilities:

---

et5reset: Physically Reset A Card

frmanage: Set Frame Relay Management Protocol

hdebug: Enable/disable Debugging

hdlccfg: Configure a Sync Line

ifhdlc: Things ifconfig can't do

linkdown: Brink down a Link
linkup: Bring up a Link
l2stats: Display Link Level Statistics
l3stats: Display Packet Level Statistics on an X.25 line
maproute: Specialized Routing and Sub-Interface Management
multilink: Create and Built Multi-line Bundles
restart: Restart an X.25 Line
usagemon: Set Utilization Monitoring on a Line or Sub-Interface
watchdog: Enable or disable the watchdog timer

ET5RESET:

Syntax:

et5reset line

Parameters

line: line number

Function:

Physically resets a port the card. On a mutiport card, only the primary (first) port should be reset (this will reset all the ports on the card).

Example:

et5reset 0 ; resets line 0 (eth0)

FRMANAGE:

Syntax:

frmanage interface ansi | lmi

Parameters:

interface: The interface name

ansi: Sets the frame relay interface to ANSI ANNEX-D

lmi: Sets the frame relay interface to LMI

Function

Sets/changes the management protocol on a frame relay line

Example

frmanage eth0 ansi ; sets eth0 to ANSI ANNEX-D

HDEBUG

Syntax

hdebug interface [lmi frdata frhex hevts devts htrace pppevts ppptrace]

Parameters

Interface: The interface name
lmi: Enable LMI debugging
frdata: Enable frame relay data debugging
frhex: Display first few bytes of data packet in hex
hevts: Show HDLC non-data events
devts: Show HDLC data events
htrace: Show HDLC packets in hex
pppevts: Show PPP events
ppptrace: Show PPP packet trace

Function

Enables or disables low level debugging on an interface. No parameters disables debugging. Note that lmi can only be debugged on a root inteface...if you set frdata debugging on a root interface it enables data tracing for all subinterfaces.

Example

hdebug eth0 lmi ; enable LMI debugging

hdebug eth0 hevts ; enable HDLC event debugging on eth0

hdebug eth0 hevts htrace ; show HDLC events and packets

hdebug eth0 ; disables debugging in eth0

hdebug etha16 frdata ; enables data tracing on a frame relay channel

HDLCCFG

Syntax

hdlccfg config.file [line]

Parameters

config.file: The name of the hdlc line configuration file

line: The line number to configure (default 0)

Function

Configures the hardware and protocol driver for an HDLC port. See sample config files.

Example

hdlccfg eth0.fr.cfg ; Configures line 0 with the file eth0.fr.cfg
hdlccfg eth1.ppp.cfg ; Configures line 1 with the file eth1.ppp.cfg
hdlccfg eth0.hdlc.cfg ; Configures line 1 with the file eth0.hdlc.cfg

IFHDLC

Syntax

ifhdlc [interface] [congest|-congest] [multicast|-multicast]
ifhdlc interface keepalive value
ifhdlc interface linespeed bits
ifhdlc interface frencap cisco | ietf

Parameters

interface: The name of the interface to get information about
congest: enable congestion management on an interface
-congest: disable congestion management on an interface
multicast: turns on the IFF_MULTICAST flag
-multicast: turn off the IFF_MULTICAST flag
value: The keepalive in seconds (0 to disable)
bits: The linespeed in bits per seconds (for SNMP reporting in BSD only)

Function

If just an interface is specified, ifhdlc displays infomation about the interface. Otherwise enables or disables features on an interface.

Example

ifhdlc ; displays information about all HDLC interfaces

ifhdlc eth0 ; displays information about interface eth0

ifhdlc etha17 congest ; enables congestion management on etha16

LINKDOWN

Syntax

linkdown [line]

Parameters

line line number (default 0)

Function

Brings the link down (logically) and performs the appropriate link level protocol procedures.

LINKUP

Syntax

linkup [line]

Parameters

line: line number (default 0)

Function

Starts the link level protocol on an interface. This function has no effect if the link is already up. Issue a linkdown first to restart the protocol on the physical line.

L2STATS

Syntax

l2stats Interface [reset]

Parameters

Interface: Interface name reset: Reset statistics

Function

Displays on standard output the level 2 statistics for the requested line. For Frame Relay sub-interfaces, the DLCI channel statistics are displayed.

Example

l2stats eth0 l2stats etha16 l2stats etha16 reset

L3STATS

Syntax

l3stats channel [line]

Parameters

channel: channel number line: line number (default 0)

Function

Displays on standard output the statistics for the requested channel. If the channel is a server channel, the aggregate statistics for the entire line are displayed.

MAPROUTE

Syntax

maproute Interface

Creates a subinterface

Function

Allocates and sets up the subinterface for frame relay connection.

Examples

maproute etha16

MULTILINK

Syntax

multilink create [-b] rootinterface
multilink add rootinterface -f interface factor
multilink del rootinterface interface

Parameters

multi-interface : A multilink bundled interface of type ethm#
-b : Load Balancing Enabled
-f : Fallback Interface
factor : factor for load balancing

Function

Use to allocate and build multilink bundles. The create keyword creates a new bundle. The add keyword is used to add real interfaces to the virtual bundle. del is used to delete an interface from the bundle. The root interface can be any name but must end in a digit from 0 to 7. There can be up to 8 bundles configured and they all must have different ending digits. You do not have the name the bundles the same, so you could have GTE0 and ATT1, but you cannot have 2 budles with the same unit number.

"Factoring" allows you to balance at virtually any ratio either in relation to the speed of the line or along some other reasoning. So, if you had a 512k line and a 256k line and wanted to balance them, you would set the factor to 2 for the 512k line and 1 for the 256k line.

Example

multilink create -b multi0 ; creates a load balancing bundle named multi0
multilink add ethm0 eth0 1 ; adds interface eth0 to the multi0 bundle
multilink add ethm0 etha16 1 ; adds interface etha16 to the 1 to 1 factored bundle

RESTART

Syntax

restart [line]

Parameters

line Line number (default 0)

Function

Restarts an X.25 link and level 3 by issuing a link up request to LAPB and a restart packet.

USAGEMON

Syntax

usagemon interface interval

Parameters

interface: The interface name
interval: The monitoring interval in seconds. 0 to disable, 21600 Max (6 hours)

Function

Enables or disables traffic monitoring

Example

usagemon eth0 600 ; Update monitoring info every 10 minutes

WATCHDOG

Syntax

watchdog interface timeout | disable [noauto|auto]

Parameters

interface - wdt0 for the standalong watchdog, eth0 for 'BSD unix and ets0 for Linux
timeout - the watchdog timeout for reboot. If the timer is not reset in this time in seconds the system will boot.
disable - use this instead of a timeout value to disable the watchdog timer.
noauto - disables automatic touching by interrupt

Function

This utility enables or disables the watchdog timer function. Any value will enable it (a value of 0 will immediately boot the system). The default behavior is for the driver to "touch", that is reset, the timer once per second when an interrupt occurs. As long as board interrupts are being processed by the system the watchdog will not boot the system. When noauto is set, the driver will NOT reset the watchdog automatically, and you much have an application or script that resets the timer by issuing another watchdog call. This function defaults to noauto, so if you want it to be reset automatically you must use the auto keyword.

Examples

/* disables the watchdog timer */

watchdog eth0 disable

/* sets the timer to 10 seconds */

watchdog eth0 10 auto

/* reboots the system on demand in LINUX */

watchdog ets0 0

/* sets the timer to 10 seconds in LINUX without interrupt reset */

watchdog ets0 10 noauto

/* a sample script which reboots the system when test file fails */

# while true
# do
# if test file
# then
# sync
# watchdog ets0 0
# fi
# watchdog ets0 5 noauto
# sleep 2
# done