Remote RMX-3200 Version 5 - Westellsupport.westell.com/Documents/Manuals/rmx54xcg.pdfWESTELL.COM TABLE OF CONTENTS Page TOC-1 About this Document.....Preface-i PrefacePreface-i

© Westell Technologies

Part # 030-101840

WESTELL.COM

COM

MA

ND

REFERENCE G

UID

E

Command Reference Guide

Remote RMX-3200

Version 5.4x

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference Guide

1-800-377-8766

Copyright © 2014 by Westell Technologies®. All Rights Reserved. Westell, Kentrox® and Optima Management System® are registered trademarks of Westell. All other names are trademarks of their respective owners.

Information is correct at time of publication and is subject to change without notice. Contact Westell in Dublin, Ohio to verify current product information. Westell Inc.is an Equal Opportunity/Affirmative Action employer.

Westell Technologies750 North Commons Drive

Aurora, IL 60504 USAToll Free: (800) 247-9482

International: +1 (614) 798-2000Fax: +1 (614) 798-1770

TABLE O

F CON

TENTS

Table of Contents

About this Document.........................................................................Preface-i

PrefacePreface-iDocument Conventions.................................................................... Preface-iiCustomer Assistance ...................................................................... Preface-iv

Chapter 1: CLI Overview..........................................................1-1Accessing the Command Line Interface .................................................... 1-2Command Types........................................................................................ 1-3CLI Navigation and Command Entry.......................................................... 1-4Command Help .......................................................................................... 1-7CLI Command Descriptions ..................................................................... 1-10

Chapter 2: Configuration Commands ......................................2-1Config Command Overview ....................................................................... 2-2List of Config Commands........................................................................... 2-3config action ............................................................................................... 2-4config alarm-entry ...................................................................................... 2-6config apply-patch .................................................................................... 2-15config banner ........................................................................................... 2-17config clock .............................................................................................. 2-19config controller bridge switch.................................................................. 2-25config controller ethernet.......................................................................... 2-29config controller ethernet bridge switch.................................................... 2-33config controller ethernet bridge switch stp.............................................. 2-35config controller ethernet mac-security .................................................... 2-37

WESTELL.COM

Page TOC-1

Remote RMX-3200 Version 5.3x Command Reference GuideConfiguration Commands 2-1

config controller nat64.............................................................................. 2-40config controller openvpn ......................................................................... 2-42config controller serial .............................................................................. 2-47config correlation...................................................................................... 2-74config dhcp-relay...................................................................................... 2-77config dhcp-server.................................................................................... 2-79config discrete analog .............................................................................. 2-88config discrete input ................................................................................. 2-95config discrete output ............................................................................... 2-98config event............................................................................................ 2-100config event content ............................................................................... 2-102config hostname..................................................................................... 2-117config interface bridge switch................................................................. 2-118config interface ethernet......................................................................... 2-124config interface nat64............................................................................. 2-129config interface openvpn ........................................................................ 2-130config interface serial ............................................................................. 2-132config ip.................................................................................................. 2-134config iptables ........................................................................................ 2-138config iptables-v6 ................................................................................... 2-139config jobs .............................................................................................. 2-140config jobs name .................................................................................... 2-142config jobs name task ............................................................................ 2-148config meas-table................................................................................... 2-154config mediation snmp event-template .................................................. 2-163config mediation snmp manager ............................................................ 2-166config mediation snmp measurement-template ..................................... 2-167config mediation snmp ne-template ....................................................... 2-173config mediation snmp point-template ................................................... 2-176config mediation snmpne ....................................................................... 2-181config mediation tacacs-service ............................................................. 2-186config mediation tl1command ................................................................ 2-187config mediation tl1mux ......................................................................... 2-189config mediation tl1ne ............................................................................ 2-191config ntp................................................................................................ 2-194config peripheral..................................................................................... 2-196config pkgs install................................................................................... 2-199config pkgs on-demand-install ............................................................... 2-204config pkgs server .................................................................................. 2-206config pkgs uninstall............................................................................... 2-208config profile........................................................................................... 2-210

WESTELL.COM

Page TOC-2

1-800-377-8766

Remote RMX-3200 Version 5.3x Command Reference GuideShow Commands 3-1

config ras................................................................................................2-212config remote-access .............................................................................2-217config response ......................................................................................2-220config response content .........................................................................2-222config site control ...................................................................................2-244config site module ..................................................................................2-246config site network-element....................................................................2-248config site network-element-set..............................................................2-251config site param ....................................................................................2-254config sitebus .........................................................................................2-255config snmp ............................................................................................2-257config tbos load ......................................................................................2-263config tbos port serial .............................................................................2-265config tbos server ...................................................................................2-276config timeout .........................................................................................2-278config use-wizard ...................................................................................2-280config users ............................................................................................2-282

Chapter 3: Show Commands .................................................. 3-1Show Command Overview.........................................................................3-2List of Show Commands ............................................................................3-3show actions...............................................................................................3-5show alarm-entries .....................................................................................3-8show audit ................................................................................................3-12show banner.............................................................................................3-16show clock................................................................................................3-17show compact-flash..................................................................................3-18show config-file.........................................................................................3-19show connections.....................................................................................3-22show controllers .......................................................................................3-24show controllers bridge ............................................................................3-26show controllers ethernet .........................................................................3-30show controllers nat64 .............................................................................3-34show controllers openvpn.........................................................................3-35show controllers serial ..............................................................................3-40show correlations .....................................................................................3-59show debugging .......................................................................................3-61show dhcp-relay .......................................................................................3-63show dhcp-server .....................................................................................3-64show discrete ...........................................................................................3-67show events .............................................................................................3-72

WESTELL.COM

1-800-377-8766

Page TOC-3

Remote RMX-3200 Version 5.3x Command Reference GuideShow Commands 3-1

show expansion-images........................................................................... 3-74show fan................................................................................................... 3-77show interfaces ........................................................................................ 3-78show interfaces bridge ............................................................................. 3-81show interfaces ethernet .......................................................................... 3-85show interfaces openvpn ......................................................................... 3-88show interfaces serial............................................................................... 3-90show inventory ......................................................................................... 3-92show ip ..................................................................................................... 3-93show iptables ........................................................................................... 3-97show jobs ............................................................................................... 3-100show jobs name ..................................................................................... 3-103show licenses......................................................................................... 3-110show listeners ........................................................................................ 3-111show log-file ........................................................................................... 3-113show meas-table .................................................................................... 3-116show mediation ...................................................................................... 3-120show ntp................................................................................................. 3-133show peripherals .................................................................................... 3-134show pkgs .............................................................................................. 3-138show product.......................................................................................... 3-142show profiles .......................................................................................... 3-143show ras................................................................................................. 3-145show remote-access .............................................................................. 3-148show resource-tracking .......................................................................... 3-149show responses ..................................................................................... 3-150show running-config ............................................................................... 3-153show sitebus .......................................................................................... 3-155show site controls................................................................................... 3-160show site modules.................................................................................. 3-163show site network-elements................................................................... 3-166show site network-elements-sets ........................................................... 3-173show site params ................................................................................... 3-176show snmp ............................................................................................. 3-177show tbos ............................................................................................... 3-181show test alarm-entries .......................................................................... 3-185show test mode ...................................................................................... 3-187show timeout .......................................................................................... 3-188show timers ............................................................................................ 3-189show users ............................................................................................. 3-190

WESTELL.COM

Page TOC-4

1-800-377-8766

Remote RMX-3200 Version 5.3x Command Reference GuideDiagnostic Commands 4-1

Chapter 4: Diagnostic Commands .......................................... 4-1Diag Command Overview ..........................................................................4-2List of Diag Commands ..............................................................................4-3diag break...................................................................................................4-4diag clear....................................................................................................4-5diag controller bridge switch dhcp ..............................................................4-7diag controller openvpn ..............................................................................4-8diag controller serial .................................................................................4-10diag controller serial wan/1.......................................................................4-13diag controller serial loopback..................................................................4-16diag fan.....................................................................................................4-18diag ip address show................................................................................4-19diag ip link show .......................................................................................4-24diag ip neighbor show ..............................................................................4-28diag ip route get........................................................................................4-30diag ip route and route-v6 show ...............................................................4-33diag line-monitor.......................................................................................4-39diag line-status .........................................................................................4-41diag mediation snmpne poll......................................................................4-42diag mmdisplay ........................................................................................4-43diag output................................................................................................4-45diag peripheral reload...............................................................................4-46diag ps......................................................................................................4-48diag snapshot ...........................................................................................4-51diag tcpdump............................................................................................4-52diag test alarm-entry.................................................................................4-57diag test mode..........................................................................................4-59diag top.....................................................................................................4-60diag usb....................................................................................................4-63diag who ...................................................................................................4-64diag whoami .............................................................................................4-65

Chapter 5: Utility Commands .................................................. 5-1Utility Commands Overview .......................................................................5-2List of Utility Commands.............................................................................5-3copy............................................................................................................5-4debug ethernet ...........................................................................................5-7debug level .................................................................................................5-9debug mediation.......................................................................................5-10debug modem ..........................................................................................5-14

WESTELL.COM

1-800-377-8766

Page TOC-5

Remote RMX-3200 Version 5.3x Command Reference GuideCommand Identifications A-1

debug openvpn ........................................................................................ 5-15debug ppp ................................................................................................ 5-17debug serial.............................................................................................. 5-19debug snmp ............................................................................................. 5-21erase ........................................................................................................ 5-23exec site control-action ............................................................................ 5-24exec site install......................................................................................... 5-25exec site uninstall..................................................................................... 5-26exec job run.............................................................................................. 5-27exec-job stop............................................................................................ 5-31exec-kill connection.................................................................................. 5-33exit............................................................................................................ 5-34help .......................................................................................................... 5-35logout ....................................................................................................... 5-36password.................................................................................................. 5-37ping .......................................................................................................... 5-38reload ....................................................................................................... 5-41running-config .......................................................................................... 5-42ssh............................................................................................................ 5-44telnet ........................................................................................................ 5-46trace-route................................................................................................ 5-47

Appendix A: Command Identifications ................................................... A-1

Appendix B: WAN Port Availability......................................................... B-1WAN Port Availability .................................................................................B-2Remote RMX-3200 Models and Ports .......................................................B-4

........................................................................................................... Index-1

Copyrights and License Statements ..........................................Copyrights-1

WESTELL.COM

Page TOC-6

1-800-377-8766

PREFACE

Preface

Page Preface-i

About this Document

This document provides a reference for all the commands in the Remote RMX-3200 intelligent remote site management device command line interface (CLI). For scenarios on using the Remote RMX-3200 commands, refer to the Remote RMX-3200 Configuration Guide.

Remote RMX-3200 system administrators should have a working knowledge of their networks and the devices and protocols being used with Westell’s Kentrox Remote devices.

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuidePreface: Document Conventions

Document ConventionsTable 1 describes the text conventions used in this document.

Table 1 Document Conventions

Convention Meaning

Screen Text, System Prompts, Messages and Reports

This style indicates Kentrox configuration screen text, system prompts, messages and reports.

Static Command Text In a command statement, this style indicates text that should be entered exactly as shown at a command line.

Variable Command Text

In a command statement, this style indicates user-specified text.

... In a command statement, ellipses (...) signify that the preceding parameter can be repeated a number of times.

[ ][ | ]

In a command statement, square brackets indicate an optional parameter. Two or more parameters in square brackets with a vertical bar ( | ) between them indicate a choice of optional parameters.

{ | } In a command statement, two or more parameters in braces with a vertical bar ( | ) between them indicate a choice of required parameters.

Menus and Menu Commands

This style indicates menu and menu commands. A right arrow ( > ) separates the menus from the submenus or menu commands. The right arrow also indicates the order in which you should click the menus, submenus and menu commands.

Dialog Boxes, Tabs, Fields, Check Boxes and Command Buttons

This style indicates dialog boxes, tabs, fields, check boxes and command buttons.

Variable Field Text This style indicates variable information you type in a dialog box field.

KEYS Uppercase body text indicates keys on a keyboard, such as the TAB or ENTER keys. Keys used in combination are connected with a plus symbol (+).

WESTELL.COM

Page Preface-ii

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuidePreface: Document Conventions

Labels This style designates physical components on Kentrox products such as jumpers, switches and cable connectors.

Note:

Note messages emphasize or supplement important points of the main text.

Important: Important messages provide information that is essential to the completion of a task.

Tip:Tip messages provide information that assists users in operating equipment more effectively.

Table 1 Document Conventions (Continued)

Convention Meaning

WESTELL.COM

1-800-377-8766

Page Preface-iii

Remote RMX-3200 Version 5.4x Command Reference GuidePreface: Customer Assistance

Customer AssistanceAll customers, partners and resellers who have a valid Support and Services Agreement have complete access to the technical support resources.

Westell offers technical support from 8 a.m. to 5 p.m. Eastern time, Monday - Friday.

Before you contact Westell for assistance, please have the following information available:

The version of hardware and software you are currently running

The error number and exact wording of any messages that appeared on your screen

What happened and what you were doing when the problem occurred

How you tried to solve the problem

Email SupportEmail support is available. You may send email at any time during the day; however, responses will be only be provided during normal business hours, in accordance with your Service and Support Agreement.

To contact Technical Support, send email to:

[email protected]

Telephone Support

Pre-sales support Available, at no charge, to anyone who needs technical assistance in determining how Kentrox products or solutions can help solve your technical needs.

Phone number: 800-733-5511, option 2

Hours of Operation: 8 a.m. – 5 p.m. Eastern Time

Post-sales supportAvailable to qualified Kentrox customers or partners who have not been able to resolve their technical issue by using our online services. To qualify for support, you must have a valid Support and Services Agreement.

Phone number: 800-733-5511, option 3

Normal Business Hours: 8 a.m. to 5 p.m. Eastern time

After-Hours Support: Available to qualified customers who are experiencing service-affecting outages that cannot wait until the next business day. To qualify for after-

WESTELL.COM

Page Preface-iv

1-800-377-8766

mailto:[email protected]


hours support, you must have a valid 24x7 Support and Services Agreement. Call the number above, option 3 and follow the prompts for after-hours service.

Product DocumentationYou can also access and view the most current versions of Kentrox product documentation on our Web site at:

http://www.westell.com

WESTELL.COM

1-800-377-8766

Page Preface-v

http://www.westell.com


WESTELL.COM

Page Preface-vi

1-800-377-8766

CHA

PTER 1

CLI Overview

This chapter describes the structure and use of the Command Line Interface (CLI) including the types of commands, CLI navigation methods and the available help screens. In addition, the information format for each CLI command in this document is described.

Guide to this Chapter

Accessing the Command Line Interface

Command Types

CLI Navigation and Command Entry

Command Help

CLI Command Descriptions

Page 1-1

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuideCLI Overview: Accessing the Command Line Interface

Accessing the Command Line InterfaceAfter a successful login, the default Command Line Interface (CLI) appears:

(Kentrox)>

For details on accessing and logging into Remote RMX-3200, see chapter Getting Started in the Remote RMX-3200 Configuration Guide.

Viewing Global CommandsTo view all high level, or global, commands available to you, enter a question mark (?) at the prompt. The following output appears.

Note: The ? does not actually appear on the screen when typed.

The (+) indicates that a command has a subset of parameters/extensions, which can be viewed by typing ? after the command, for example:

(Kentrox)>config ?

(Kentrox)>Global Commands config(+) Configures parameters. copy Creates a copy of a configuration or patch configuration file. debug(+) Enables or disables session log output. diag(+) Displays system diagnostics. erase Erases (removes) a configuration or patch configuration file. exec(+) Executes system command. exec-job(+) Controls the execution of jobs. exec-kill(+) Terminates a specified mediation connection. exit Exits up one level in the command hierarchy. help Describes how to access help. logout Logs out and terminates the session. password Changes the password for the current user. ping Tests network connectivity to a remote host. reload Resets the system. running-config Displays the current operating configuration. show(+) Displays parameters. ssh Establishes a SSH session. telnet Establishes a Telnet session. trace-route Traces network routing to a remote host.

(Kentrox)>

WESTELL.COM

Page 1-2

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideCLI Overview: Command Types

Command TypesThere are four primary groups of Remote RMX-3200 commands:

Configuration Commands

Show Commands

Diagnostic Commands

Utility Commands

Configuration Commands The configuration commands are used to set up Remote RMX-3200. Typically, the results of what you configure in Remote RMX-3200 with the config command can be displayed with the show command.

Configuration commands usually require parameters and generally have default values. To use configuration commands, enter command config from the CLI.

Show CommandsShow commands display Remote RMX-3200 options, statuses and settings. Typically, the results of what you configure in Remote RMX-3200 with the config command can be displayed with the show command.

The show commands do not have default values and generally only require optional parameters. To use show commands, enter command show from the CLI.

Diagnostic CommandsDiagnostic commands display system-wide diagnostics including information about logged in users, running processes, controllers and peripherals.

To use diagnostic commands, enter command diag from the CLI.

Utility CommandsUtility commands handle administrative tasks such as copying files, displaying the running configuration and logging out of Remote RMX-3200. All are executable from any level of the CLI.

WESTELL.COM

1-800-377-8766

Page 1-3

Remote RMX-3200 Version 5.4x Command Reference GuideCLI Overview: CLI Navigation and Command Entry

CLI Navigation and Command EntrySpecific keys can be used to navigate in the CLI, edit command line entries, or execute command entry shortcuts.

Navigation KeysNavigation keys and key combinations are available for quickly moving backward and forward through the CLI. Those that are available for Remote RMX-3200 appear in Table 1-1.

Note: Some key combinations might not be available for all types of terminal

emulation software.

Table 1-1 CLI Keystrokes

Key Combinations Action

DELETE or BACKSPACE Deletes a previous character.

CTRL+a Places the cursor at the beginning of a line.

CTRL+e Places the cursor at the end of a line.

RIGHT ARROW or CTRL+f Moves forward one character.

LEFT ARROW or CTRL+b Moves backward one character.

CTRL+d Deletes the current character.

CTRL+u Deletes the entire line.

CTRL+k Deletes to the end of the line.

CTRL+t Reverses the order of the current character and the previous character.

UP ARROW or CTRL+p Moves to the previous line in the history buffer.

DOWN ARROW or CTRL+n Moves to the next line in the history buffer.

CTRL+z Returns to the root command prompt.

TAB Completes the command line entry.

exit Moves to next higher level in the CLI.

? Displays related command choices and command usage statements.

WESTELL.COM

Page 1-4

1-800-377-8766


TAB KeyThe TAB key lets you quickly enter words in a command without typing the full command name. For example, to enter the config command, you can type the first three letters and press TAB to see the entire command name.

Note: For TAB completion to work correctly, enter a unique character set so that the

CLI can distinguish the desired command name from other possible command names.

When pressed twice at a stopping point, the TAB key displays a list of all commands available from the stopping point along with all available global commands.

Parameter Values with SpacesUse quotes to enclose command parameters that contain a space or spaces.

Note: This applies only to parameters that accept alphanumeric values.

For example, parameter secret word in command config ras server will generate an error if it is not enclosed in quotes.

Note: Remote RMX-3200 accepts either single quotes (‘) or double quotes (“) for

enclosing parameters.

(Kentrox) config controller ethernet 2>assign disable mac-security unassignbridge enable nodefault encapsulation proxy-arpdescription hardware-address speedGlobal Commandsconfig exec logout showcopy exec-job password telnetdebug exec-kill ping trace-routediag exit reloaderase help running-config(Kentrox) config controller ethernet 2>

(Kentrox)>config ras server 10.50.18.32 secret secret word[UCLI0032] Error unknown command "word".(Kentrox)>config ras server 10.50.18.32 secret "secret word"(Kentrox)>

WESTELL.COM

1-800-377-8766

Page 1-5


Abbreviated Command EntryThe CLI recognizes commands by the first few characters entered in the command name. Remote RMX-3200 recognizes the unique abbreviated entry and executes the command exactly as if it had been entered fully. For example, enter sh us as an abbreviated form of command show users to display all configured Remote RMX-3200 users.

Note: Optional parameter names required by some commands can also be

abbreviated.

Use of abbreviated controller parameter names is also allowed. In the following example, a user configures an Ethernet controller in port 2.

(Kentrox)>sh usStrong Password Support: enabled

Login Name Profile 1. bob restricted 2. ebh restricted 3. jeff status 4. johndoe status 5. techcomm management 6. test supervisor(Kentrox)>

(Kentrox)>con cont eth 2(Kentrox) config controller ethernet 2>

WESTELL.COM

Page 1-6

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideCLI Overview: Command Help

Command HelpCommand help is available for navigating the CLI command hierarchy and for assistance with specific commands. Enter help or ? for command help.

Using the Help CommandEnter help to see the basic Remote RMX-3200 help information. The following example displays the help screen.

(Kentrox)>helpYou can request help for a command at any time by enteringa question mark ('?'). The '?' displays the following typesof information for commands and/or command inputs:

- Usage statements- Available subcommands- Matching commands for partial inputs- Available local and global commands

The type of information displayed depends on where you enter the '?'.For more information on using help, refer to the command referenceguide.(Kentrox)>

WESTELL.COM

1-800-377-8766

Page 1-7


Using the ?The ? displays information for individual commands and command inputs.

Displaying Command Usage StatementsUse the ? directly following a command name to display that command’s usage statement.

For example, enter config interface? at the main prompt to display the following usage statement.

(Kentrox)>config interfaceUsage: interface <type> <instance> no interface <type> { <instance> | * } no interface *

<type> The type of interface. Valid types are bridge, ethernet, openvpn and serial. <instance> Configures an instance of a specific interface. Valid values are based on the type of interface. Valid bridge values: switch switch Bridge group interface consisting of a set of switch Ethernet controllers or WAN ports Valid ethernet values: <port number> <port number> Port number identifying the location of the interface. Port number labels are on the front panel. Valid openvpn values: <name> <name> OpenVPN interface name. Range: Up to 10 alphanumeric characters. Valid serial values: <port number> or <unit number>/<port number> <port number> Port number identifying the location of the interface. Port number labels are on the front panel. <unit number> The peripheral unit number. Valid values: 1 to 12 no Deletes one or more interfaces. Valid types are bridge, ethernet, openvpn and serial. * Specifies all interfaces or all interfaces of a specified type.

(Kentrox)>config interface

WESTELL.COM

Page 1-8

1-800-377-8766


Displaying Available SubcommandsUse the ? after a command that requires subcommands to display all its corresponding subcommands. There must be a space between the ? and the preceding command name.

For example, enter show ip ? to list all subcommands under show ip.

Displaying Matching Commands for Partial InputsUse the ? at any point in a partially entered command to display a list of matching command names.

For example, enter i? at the prompt after command config to display all commands that begin with “i” and can be entered at the prompt.

Displaying Available Local and Global CommandsEnter a ? at a stopping point to display a list of local commands that can be issued from that stopping point.

Enter another ? from the stopping point to display a list of all global commands.

(Kentrox)>show ipCommands arp Displays the ARP cache. domain-name Displays the domain name. forward Displays the state of IP forwarding. name-server Displays DNS servers. route Displays routes.(Kentrox)>show ip

(Kentrox)>config iCommands interface(+) Configures an interface. ip(+) Configures IP settings. iptables Configures IP tables.(Kentrox)>config i

(Kentrox) config interface bridge switch ip->Commands address Configures the IP address of the device. no Deletes IP address information.Enter ? to see available global commands.(Kentrox) config interface bridge switch ip->

WESTELL.COM

1-800-377-8766

Page 1-9

Remote RMX-3200 Version 5.4x Command Reference GuideCLI Overview: CLI Command Descriptions

CLI Command DescriptionsThe remaining chapters in this document describe all of the CLI commands grouped by Command Types. Each command will have the following information.

DescriptionThis section includes a detailed description of the command.

FormatsThis section lists all valid format statements for the command. For example, the config timeout command has three valid formats:

config timeout minutes

config default timeout

config no timeout

The config, timeout, default and no parameters, which are shown in bold command font, are all commands or static parameters. Enter these values exactly as shown in the format statements. The minutes parameter, which is shown in italicized command font, is a variable parameter. Substitute the amount of time that can elapse before a Remote RMX-3200 session expires for this variable parameter. For more information on text formats, see Document Conventions.

ParametersThis section lists and describes possible parameters for the command. Valid values for each parameter are also provided, if applicable.

Command DefaultsThis section provides the default values of the command, if applicable.

Required User ProfilesThis section lists the user profiles needed to execute the command.

ExamplesThis section provides screen captures depicting actual command executions. An explanation of each example is provided.

See AlsoThis section lists commands that you may want to reference while executing the command. For example, if you plan to use the config timeout command to configure the session timeout, you may want to use the show timeout command to display the existing session timeout value.

WESTELL.COM

Page 1-10

1-800-377-8766

CHA

PTER 2

Configuration Commands

This chapter describes all of the Remote RMX-3200 configuration (config) commands. The config commands are listed in alphabetical order and each command is described in detail.


Config Command Overview

List of Config Commands

WESTELL.COM

Page 2-1

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: Config Command Overview

Config Command OverviewThe configuration commands are used to set up Remote RMX-3200.

Typically, the results of what you configure in Remote RMX-3200 with the config command can be displayed with the show command. See Show Command Overview for details.

Configuration commands usually require parameters and generally have default values. To use configuration commands, enter command config from the CLI.

WESTELL.COM

Page 2-2

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: List of Config Commands

List of Config Commands The following is a list of all of the config commands you will find in the CLI. The (+) sign after a command indicates that it has multiple arguments.

(Dub)> config ?

(Kentrox) config>Commands action(+) Configures an action. alarm-entry(+) Configures an alarm entry. apply-patch Modifies a configuration by applying commands from a patch configuration file. banner Configures the banner. clock(+) Configures clock time and date settings. controller(+) Configures a controller. correlation(+) Configures an event correlation. default Resets configuration parameters to the default values. dhcp-relay(+) Configures bootp/DHCP relay. dhcp-server(+) Configures DHCP Server settings. discrete(+) Configures discrete analog, input, and output points. event(+) Configures an event. hostname Configures a hostname. interface(+) Configures an interface. ip(+) Configures IP settings. iptables Configures iptables. iptables-v6 Configures ip6tables. jobs(+) Configures jobs. meas-table(+) Configures the measurement table. mediation(+) Configures mediation settings. no Negates a configuration command. ntp(+) Configures NTP settings. peripheral(+) Configures peripheral settings. pkgs(+) Configures packages. profile(+) Configures a user defined profile ras(+) Configures RAS settings. remote-access(+) Configures remote access settings. response(+) Configures a response. site(+) Configures the site for modules. sitebus(+) Configures sitebus. snmp(+) Configures SNMP. tbos(+) Configures TBOS parameters. timeout Configures the session timeout value. use-wizard Runs a configuration wizard. users(+) Configures users.

Enter ? to see available global commands.(Kentrox) config>

WESTELL.COM

1-800-377-8766

Page 2-3

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config action

config action

DescriptionThis command configures an action, which is a rule that associates a system event with a system response. The system response executes when the system event occurs.

Formatsconfig action action_name

description textevent event_nameresponse response_nameno description

For deleting actions:config no action { action_name | * }

Parameters

Required User Profilesmanagement, supervisor

action_name Defines the name of the action being configured. Maximum length is 128 characters.

description Configures an action description. There is no maximum description length or default description. The following parameter is accepted:

text—Defines a text description for an action.

event Associates an event with an action. An event is an expression that defines a system occurrence. The following parameter is accepted:

event_name—Specifies an existing event.

response Associates a response with an action. A response is an expression that defines a system activity that occurs in response to events. The following parameter is accepted:

response_name—Specifies an existing response.

no Deletes a specified parameter.

* Specifies all actions.

WESTELL.COM

Page 2-4

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config action

ExamplesThe following settings are configured for action doorOpenAlm:

Description Door open alarm action Event doorOpen Response doorOpenTl1Alm.

See Alsoshow running-config

show actions

(Dub)>config(Dub) config>action doorOpenAlm(Dub) config action doorOpenAlm>description Door open alarm action(Dub) config action doorOpenAlm>event doorOpen response doorOpenTl1Alm(Dub) config action doorOpenAlm>

WESTELL.COM

1-800-377-8766

Page 2-5

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config alarm-entry

config alarm-entry

DescriptionThis command configures an alarm entry and its associated settings.

Formats

For configuring an alarm:config alarm-entry alarm

category category_namedefaultdescription texthidden-severity { disabled | normal }ne-name ne_nameno { category | description | ne-name }raw { disable | enable }tl1ne ne_idtrap { disable | enable priority priority_level }

For configuring an alarm filter:config alarm-entry alarm_filter

raw { disable | enable }trap { disable | enable }

For deleting an alarm entry:config no alarm-entry { alarm | alarm_filter | * }

For deleting priorities for an alarm entry:config alarm-entry alarm trap no priority

Parameters

alarm Defines the name of an alarm entry for configuration in the central alarm table. Valid values are alphanumeric characters and underscores (_).

alarm_filter Defines a filter for configured groups of alarm entries. A period (.) is used for single character matching and an asterisk (*) is used for multiple character matching.

Note: There is no stopping point in the CLI after an alarm filter.

WESTELL.COM

Page 2-6

1-800-377-8766


category Configures a category for an alarm entry. The category associates the alarm table entry with a specific application or business task. The following parameter is accepted:

category_name—Defines a category name. Maximum length is 128 characters.

default Configures the default setting for the hidden-severity option.

description Configures an alarm entry description. There is no maximum description length or default description. The following parameter is accepted:

text—Defines a description for the alarm entry.

event Adds an alarm entry event. See config alarm-entry event.

hidden-severity

Configures the hidden-severity setting for alarm entries. When hidden-severity is enabled via the normal setting, alarms in their normal state will not be displayed in the alarm table. The following parameters are accepted: disabled-- Disables the hidden severity. This is the default

setting. normal--Configures the hidden severity to normal.

nagging Configures the alarm nagging settings for an alarm entry. See config alarm-entry nagging.

ne-name Configures text that identifies the network element that the Remote RMX-3200 alarm entry represents. The following parameter is accepted:

ne_name—Defines the network element name.

no Deletes an alarm entry, a group of alarm entries, or all alarm entries.

raw Configures the output of raw response information for an alarm entry or alarm entry filter. Raw response information contains all of the data for the alarm entry. Raw response information is disabled by default. The following parameters are accepted: disable—Disables the output of raw response information. enable—Enables the output of raw response information.

tl1 Configures the TL1 support settings for an alarm entry. See config alarm-entry tl1.

WESTELL.COM

1-800-377-8766

Page 2-7



ExamplesThe following settings are configured for alarm entry TL1_4:

Description TL1 NE 4 Category Environmental_Alarms Network element name MDR4000toDublin Raw response information enabled SNMP trap support enabled SNMP trap priority level high TL1 NE 4. Hidden-severity setting normal

tl1ne Configures the virtual TL1 NE that will receive TL1 alarms from the designated alarm entry. The following parameter is accepted:

ne_id—Defines the ID of the virtual TL1 NE. Valid values are 1 to 20. The default TL1 NE is 1.

trap Configures SNMP trap support for an alarm entry or alarm entry filter. Trap support is enabled by default. The following parameters are accepted: disable—Disables SNMP trap support. enable—Enables SNMP trap support. priority—Specifies the priority level for traps associated

with this alarm entry. In order to add new traps when the trap queue is full, Remote RMX-3200 drops the oldest, lowest-priority traps from the queue. Valid values for priority_level are highest, high, normal, low and lowest.

* Specifies all alarm entries.

(Dub)>config(Dub) config>alarm-entry TL1_4(Dub) config alarm-entry TL1_4>description TL1 NE 4(Dub) config alarm-entry TL1_4>category Environmental_Alarms(Dub) config alarm-entry TL1_4>ne-name MDR4000toDublin(Dub) config alarm-entry TL1_4>raw enable(Dub) config alarm-entry TL1_4>trap enable(Dub) config alarm-entry TL1_4>trap priority high(Dub) config alarm-entry TL1_4>tl1ne 4(Dub) config alarm-entry TL1_4>hidden-severity normal(Dub) config alarm-entry TL1_4>

WESTELL.COM

Page 2-8

1-800-377-8766


config alarm-entry event

DescriptionThis command configures a trigger event that will activate an alarm entry with the specified severity.

Formatsconfig alarm-entry alarm event event_originator event_type event_severity { critical | event | informational | minor | major | normal | warning } alarm_message

For deleting a trigger event:config alarm-entry alarm no event event_originator event_type

Parameters

alarm Defines the name of the alarm entry being configured. Valid values are alphanumeric characters and underscores (_).

Note: This parameter must start with an alphabetic

character.

alarm_message Defines the text string associated with the alarm.

critical Updates the state of the alarm entry to critical.

event Updates the severity level based on the information from the actual event message.

event_originator Defines the event originator, which is the system component that generates an event. For more information on event originators, refer to Table 2 on page 2-103.

event_type Defines the type of generated event. For more information on event types, refer to Table 3 on page 2-111.

informational Updates the state of the alarm to informational.

minor Updates the state of the alarm entry to minor.

major Updates the state of the alarm entry to major.

no Deletes a configured alarm text string.

normal Updates the state of the alarm entry to normal.

warning Updates the state of the alarm entry to warning.

WESTELL.COM

1-800-377-8766

Page 2-9


Command DefaultsNo alarm event configured


ExamplesThis example displays the configuration of an event for alarm entry tbos_2_2_5 with the following settings:

Event originator input 0/16 Event type open Severity level minor Alarm message Power Low

config alarm-entry nagging

DescriptionThis command configures the alarm nagging settings for an alarm entry. Alarm nagging lets an alarm entry periodically send its state information to all enabled protocols at a specific time interval.

Formatsconfig alarm-entry alarm nagging interval [ critical | informational | major | minor | normal | warning ]

For deleting the alarm nagging setting:config alarm-entry alarm no nagging

Parameters

(Dub)>config(Dub) config>alarm-entry tbos_2_2_5(Dub) config alarm-entry tbos_2_2_5>event input 0/16 open minor Power Low(Dub) config alarm-entry tbos_2_2_5>


Note: This parameter must start with an alphabetic character.

critical Activates alarm nagging for alarm entries with a critical severity level.

WESTELL.COM

Page 2-10

1-800-377-8766


Command Defaultsminor


ExamplesThis example displays the configuration of a 25 seconds interval when the tbos_2_2_5 alarm entry is in the major state.

config alarm-entry tl1

DescriptionThis command configures TL1 settings for an alarm entry.

Formatsconfig alarm-entry alarm tl1

aid aiddisable

informational Activates alarm nagging for alarm entries with an informational severity level or higher.

interval Defines the number of seconds between instances of the alarm sending its state to all enabled protocols.

major Activates alarm nagging for alarm entries with a major severity level or higher.

minor Activates alarm nagging for alarm entries with a minor severity level or higher.

no Disables alarm nagging.

normal Activates alarm nagging for alarm entries with a normal severity level or higher.

warning Activates alarm nagging for alarm entries with a warning severity level or higher.

(Dub)>config(Dub) config>alarm-entry tbos_2_2_5

(Dub) config alarm-entry tbos_2_2_5>nagging 25 major(Dub) config alarm-entry tbos_2_2_5>

WESTELL.COM

1-800-377-8766

Page 2-11


ds3ec1enableenveqptno { aid | type }nsaoc3sat1type type

For alarm filters:config alarm-entry alarm_filter tl1

disableenable

Parameters



alarm_filter Defines the filter for configured groups of alarm entries. A period (.) is used for single character matching and an asterisk (*) is used for multiple character matching.

aid Configures the TL1 AID for an alarm entry. An AID identifies a subcomponent (similar to a port number) for an NE. By default, Remote RMX-3200 uses the alarm entry’s name as the AID if no AID is configured. The following parameter is accepted:

aid—Defines the TL1 AID for the alarm entry. The AID identifies a subcomponent (similar to a port number) for an NE. The maximum length is 20 characters.

disable Disables TL1 support for an alarm entry or group of alarm entries. TL1 support is disabled by default.

ds3 Configures a TL1 alarm to signal the occurrence of an event related to a DS3 facility.

ec1 Configures a TL1 alarm to signal the occurrence of an event related to a EC1 facility.

enable Enables TL1 support for an alarm entry or group of alarm entries.

WESTELL.COM

Page 2-12

1-800-377-8766



ExamplesThe following TL1 settings are configured for alarm entry TL1_3:

Enabled TL1 support TL1 AID point2 Signals an equipment-related event (eqpt) Signals a service-affecting condition (sa) Condition type condition2.

env Configures a TL1 alarm to signal the occurrence of environmental events, such as temperature or pressure changes. This is the default setting.

eqpt Configures a TL1 alarm to signal the occurrence of an equipment-related event. By default, TL1 alarms signal the occurrence of environmental events.


nsa Configures a TL1 alarm to signal the occurrence of a non-service-affecting condition. This is the default setting.

oc3 Configures a TL1 alarm to signal the occurrence of an event related to a OC3 facility.

sa Configures a TL1 alarm to signal the occurrence of a service-affecting condition. By default, TL1 alarms signal the occurrence of non-service-affecting conditions.

t1 Configures a TL1 alarm to signal the occurrence of an event related to a T1 facility.

type Configures a condition type for a TL1 environmental or equipment alarm. By default, Remote RMX-3200 uses MISC until a condition type is configured. The following parameter is accepted:

type—Defines the condition type for the generated TL1 alarm. Maximum length is 128 characters.

Note: For more on alarm condition types, refer to the Telcordia

(formerly Bellcore) GR-833-CORE documentation.

WESTELL.COM

1-800-377-8766

Page 2-13


See Alsoconfig controller serial

config event content

show running-config

show alarm-entries

show correlations

(Dub)>config(Dub) config>alarm-entry TL1_3(Dub) config alarm-entry TL1_3>tl1(Dub) config alarm-entry TL1_3 tl1->enable(Dub) config alarm-entry TL1_3 tl1->aid point2(Dub) config alarm-entry TL1_3 tl1->eqpt(Dub) config alarm-entry TL1_3 tl1->sa(Dub) config alarm-entry TL1_3 tl1->type condition2(Dub) config alarm-entry TL1_3 tl1->

WESTELL.COM

Page 2-14

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config apply-patch

config apply-patch

DescriptionThis command adds a configuration fragment to an existing configuration file. This functionality allows users to apply a group of configuration commands without individually entering each one in the CLI. Additionally, applying a patch does not overwrite the existing configuration file.

Patch files are transferred to their own directory on Remote RMX-3200 (/config/patches) using an FTP utility. Once a patch file is in this directory, the user can show, copy, or erase it using the existing CLI commands.

Note: For more information about creating patch files, refer to the Remote RMX-

3200 Configuration Guide.

Formatsconfig apply-patch patch_file config_file

Parameters


ExamplesThe following example displays the modification of configuration file running-startup with patch file ConfigUpdate5-10.

patch_file Specifies an existing patch file.

Note: All patch files in the /config/patches directory have a

.pat extension. However, you should not include the extension when entering the patch file name in the CLI. For example, config1.pat would be entered as config1.

config_file Defines the user-defined or special configuration file to modify. For information about the available special configuration files, refer to command copy.

(Dub)>config(Dub) config>apply-patch ConfigUpdate5-10 running-startup(Dub) config>

WESTELL.COM

1-800-377-8766

Page 2-15

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config apply-patch

See Alsocopy

erase

show running-config

show config-file

WESTELL.COM

Page 2-16

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config banner

config banner

DescriptionThis command configures the banner for Remote RMX-3200. The banner appears when connecting to Remote RMX-3200.

Formatsconfig banner delimiting_character

For resetting the banner:config default banner

Parameters

This command accepts escape codes that are used to include variable text within the banner. For more information on the escape codes, refer to Table 1.

delimiting_character Defines the beginning and ending of the banner. Most characters, such as @, (, ), #, ~, % and *, can be applied as the delimiting character.Important: Do not use the following characters for the

delimiting character:d, s, l, m, n, o, r, t, u, U, V, ‘, “ and \

default Resets the banner to the default banner.

Table 1 Escape Codes

Codes Descriptions

\d Includes the current date in the banner.

\s Includes the name of the operating system in the banner.

\l Includes the name of the logical terminal from which the user is operating.

\m Includes the architecture of the system (for example, i686), in the banner.

\n Includes the host name of the system (for example, localhost) in the banner.

\o Includes the domain name of the system in the banner.

\r Includes the release number of the Linux kernel in the banner.

\t Includes the current time in the banner.

WESTELL.COM

1-800-377-8766

Page 2-17

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config banner

Command DefaultKentrox banner


ExamplesThis example displays the configuration of the delimiting character as #, the banner text as This is my banner., the current date (\d) and the time (\t).

See Alsoshow banner

\u Includes the number of users currently logged into Remote RMX-3200 in the banner.

\U Includes the number of users currently logged into Remote RMX-3200 with the addition of the words “user” or “users” (for example, 10 users) following the number in the banner.

\v Includes the build date of the Linux kernel in the banner.

\\ Includes a backward slash character (\) in the banner.

_ __ _____ _ _ _______ _____ ____ __ __ | | / / | ___|| \ | ||___ ___|| _ \ / \ \ \ / / | |/ / | |___ | \ \| | | | | (_) || -- | \ \/ / | ( | ___|| |\ \ | | | | _ / | ( ) | ) ( | |\ \ | |___ | | \ | | | | | \ \ | -- | / /\ \ |_| \_\ |_____||_| \_| |_| |_| \_\ \____/ /_/ \_\

Remote RMXlogin:

(Dub)>config(Dub) config>banner #Enter the banner text. End the banner with a # character.This is my banner.\d\t#(Dub) config>

Table 1 Escape Codes (Continued)

Codes Descriptions (Continued)

WESTELL.COM

Page 2-18

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config clock

config clock

DescriptionThis command configures clock and timestamp settings for Remote RMX-3200.

Formatsconfig clock

default timestamplocal-time { hh:mm:ss | MM/DD/YYYY | hh:mm:ss MM/DD/YYYY }timestamp { GMT | local-time }timezone { [ custom ] timezone_string hh_offset:mm_offset |

from-file indicator }

Parameters

default Resets the timestamp to its default value (local-time).

local-time Configures the date and/or local time in 24-hour format for Remote RMX-3200. Local time is defined by the configured timezone and daylight savings. Either the date or local time must be configured.

Note: Users cannot modify the local time if NTP is enabled. For

more about NTP, refer to config ntp on page 2-194.

The following parameters are accepted: hh—Defines the hour value of the local time. This parameter

accepts values 0 to 23. mm—Defines the minute value of the local time. This parameter

accepts values 0 to 59. ss—Defines the second value of the local time. This parameter

accepts values 0 to 59. MM—Defines the month value of the date. This parameter

accepts values 1 to 12. DD—Defines the day value of the date. This parameter accepts

values from 1 to the total number of days in the month specified in MM.

YYYY—Defines the year value of the date. Valid values are 1970 to 2037.

WESTELL.COM

1-800-377-8766

Page 2-19



timestamp Configures the logging timestamp option. The following parameters are accepted: GMT—Displays logging timestamps in Greenwich Mean Time. local-time—Displays logging timestamps in standard local

time. This is the default setting.

timezone Configures the timezone for Remote RMX-3200. The default is standard GMT +0:00. The following parameters are accepted: custom—Puts command config clock daylight-savings

into custom mode. This allows users to configure their own daylight savings time parameters. For information on configurable parameters when the timezone is in custom mode, refer to command config clock daylight savings on page 2-21.

timezone_string—Defines text to represent the desired timezone, which accepts alphabetic strings of 1 to 10 characters in length.

hh_offset—Defines a value to represent the number of hours difference between the desired timezone and default timezone, which is standard GMT +0.00. Values take the form of hh or -hh and must be between 0 and 12.

mm_offset—Defines a value to represent the number of minutes difference between the desired timezone and the default timezone, which is standard GMT +0.00. Values take the form of mm and must be between 0 and 59.

from-file—Loads and applies timezone information from file timezones.def, which contains associated daylight savings rules. For information on accessing or updating the timezone definition file, refer to the Remote RMX-3200 Configuration Guide.

Note: When a user invokes the from-file keyword, command

config clock daylight-savings becomes unavailable in the CLI. If an indicator in the timezone definition file becomes unavailable, the timezone will default to GMT and generate a log message.

indicator—Specifies a timezone indicator (1 to 10 alphanumeric characters) in file timezones.def.

WESTELL.COM

Page 2-20

1-800-377-8766


ExamplesThe following clock settings are configured:

Local time 16:45:30 and date 12/14/2008 Timestamp option gmt Timezone custom EST -5:00.

config clock daylight savings

DescriptionThis command configures daylight savings time settings.

Notes: When the timezone on Remote RMX-3200 is set to custom, users can enter

specific parameters for the daylight savings start time, end time and length.

When the timezone information is loaded and applied from file timezones.def, all daylight savings configuration options are disabled in the CLI.

Formats

When Remote RMX-3200 is in standard mode:config clock daylight-savings indicator

When Remote RMX-3200 is in custom mode:config clock daylight-savings

end-day { day | occurrence day_of_week }end-month monthend-time hh:mm:ssindicator indicatorsave-amount hh:mm:ssstart-day { day | occurrence day_of_week }start-month monthstart-time hh:mm:ss

config clock no daylight-savings

(Dub)>config(Dub) config>clock(Dub) config clock>local-time 16:45:30 12/14/2009(Dub) config clock>timestamp gmt(Dub) config clock>timezone custom EST -5:00(Dub) config clock>

WESTELL.COM

1-800-377-8766

Page 2-21


Parameters

indicator Defines a name (up to 10 alphanumeric characters) to be displayed when daylight savings time is in effect.

end-day Configures the day when daylight savings time ends. The following parameters are accepted: day—Defines the day of the month when daylight savings

time ends. Valid values are 1 to 31. occurrence—Defines the occurrence of a day in a month

when daylight savings time ends. Valid values are first, second, third, fourth and last.

day_of_week—Defines the day of the week when daylight savings time ends. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

end-month Configures the month when daylight savings time ends. The following parameter is accepted:

month—Defines the month that daylight savings time ends.

end-time Configures the time when daylight savings time ends: hh—Defines the hour when daylight savings time ends. This

parameter accepts values 0 to 23. mm—Defines the minute when daylight savings time ends. This

parameter accepts values 0 to 59. ss—Defines the second when daylight savings time ends.

This parameter accepts values 0 to 59.

indicator Configures the name (up to 10 alphanumeric characters) to be displayed when daylight savings time is in effect. The following parameter is accepted:

indicator—Defines the name to be displayed when daylight savings time is in effect. Maximum length is 10 alphanumeric characters.

save-amount Configures the amount of time to save during daylight savings time. The following parameters are accepted: hh—Defines the number of hours to save. This parameter

accepts values 0 to 23. mm—Defines the number of minutes to save. This parameter

accepts values 0 to 59. ss—Defines the number of seconds to save. This parameter

accepts values 0 to 59.

WESTELL.COM

Page 2-22

1-800-377-8766



ExamplesIn the following standard example, the daylight savings indicator is set to DST:

start-day Configures the day when daylight savings time starts. The following parameters are accepted: day—Defines the day of the month when daylight savings

time starts. Valid values are 1 to 31. occurrence—Defines the occurrence of a day in a month

when daylight savings time starts. Valid values are first, second, third, fourth and last.

day_of_week—Defines the day of the week when daylight savings time starts. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

start-month Configures the month when daylight savings time starts. The following parameter is accepted:

month—Defines the month that daylight savings time starts.

start-time Configures the time when daylight savings time starts: hh—Defines the hour when daylight savings time starts. This

parameter accepts values 0 to 23. mm—Defines the minute when daylight savings time starts.

This parameter accepts values 0 to 59. ss—Defines the second when daylight savings time starts.

This parameter accepts values 0 to 59.

no Disables daylight savings and the display of the daylight savings time indicator.

(Dub)>config(Dub) config>clock(Dub) config clock>daylight-savings DST(Dub) config clock>

WESTELL.COM

1-800-377-8766

Page 2-23


In the following custom example, daylight savings time settings are configured:

Indicator EDT Start month march Start day 14 Start time 1:00:00 (AM) End month november End day last Sunday End time 02:00:00 (AM) Time to save 01:45:00.

See Also show clock

(Dub)>config(Dub) config>clock(Dub) config clock>daylight-savings(Dub) config clock daylight-savings->indicator EDT(Dub) config clock daylight-savings->start-month march(Dub) config clock daylight-savings->start-day 14(Dub) config clock daylight-savings->start-time 01:00:00(Dub) config clock daylight-savings->end-month november(Dub) config clock daylight-savings->end-time 02:00:00(Dub) config clock daylight-savings->save-amount 01:45:00(Dub) config clock daylight-savings->

WESTELL.COM

Page 2-24

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller bridge switch

config controller bridge switch

DescriptionThis command configures bridge group switch or restores the settings associated with bridge group switch to their default values. A bridge group is a set of switch controllers or WAN ports assigned to a single bridge unit and network interface. Bridge group switch is the only bridge group that can be configured for Remote RMX-3200.

Note: A bridge group must be defined before you can configure an interface for it.

Formatsconfig controller bridge switch

description textno description

For resetting the bridge group:config default controller bridge switch

Parameters

Command DefaultsBridge group switch is configured by default


description Configures a description for bridge group switch. The following parameter is accepted:

text—Defines the description for bridge group switch. Maximum length is 60 characters.

no Deletes the description for bridge group switch.

default Restores the settings associated with bridge group switch to their default values.

WESTELL.COM

1-800-377-8766

Page 2-25


ExamplesThis example displays the configuration of bridge group switch with description Switch controller.

config controller bridge switch stp

DescriptionThis command configures spanning tree protocol (STP) settings for bridge group switch.

Formatsconfig controller bridge switch stp

default { forward-delay | hello-time | max-age | priority }disableenableforward-delay secondshello-time secondsmax-age secondspriority priority

Parameters

(Dub)>config(Dub) config>controller bridge switch(Dub) config controller bridge switch>description Switch controller(Dub) config controller bridge switch>

default Resets the specified setting to its default value.

disable Disables the STP for bridge group switch.

enable Enables the STP for a bridge group switch.

WESTELL.COM

Page 2-26

1-800-377-8766



ExamplesThe following STP settings are configured for bridge group switch:

Enabled STP 15 second forward delay 4 second hello time 22 second maximum message age 65535 bridge priority level

forward-delay

Configures the STP forward delay time. Forward delay defines the following settings: The amount of time a controller spends in the listening state before

entering the learning state The amount of time a controller spends in the learning state before

entering the forwarding state The aging time for dynamic entries in the filtering database during

a network topology change.The following parameter is accepted:

seconds—Defines the forward delay value in seconds. Valid values are 4 to 30 seconds. Default length is 15 seconds.

hello-time

Configures the spanning tree protocol hello time. The hello time is the interval between the generation of configuration bridge PDUs when the bridge is either the root bridge or when it is trying to become the root bridge. The following parameter is accepted:

seconds—Defines the hello time value in seconds. Valid values are 1 to 10 seconds. The default length is 2 seconds.

max-age Configures the max age for STP protocol information.seconds—Defines the maximum age in seconds for STP information.Valid values are 6 to 40 seconds. Default length is 20 seconds.

priority Configures the bridge priority value, which represents the desirability of one bridge group among all others on a network.

priority—Defines the bridge priority level. Valid priority levels are 0 to 65535. The highest level is 0. The default level is 32768.

WESTELL.COM

1-800-377-8766

Page 2-27


See Alsoconfig controller bridge switch

show controllers

(Dub)>config(Dub) config>controller bridge switch(Dub) config controller bridge switch>stp(Dub) config controller bridge switch stp->enable(Dub) config controller bridge switch stp->forward-delay 15(Dub) config controller bridge switch stp->hello-time 4(Dub) config controller bridge switch stp->max-age 22(Dub) config controller bridge switch stp->priority 65535(Dub) config controller bridge switch stp->

WESTELL.COM

Page 2-28

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller ethernet

config controller ethernet

DescriptionThis command configures a Remote RMX-3200 Ethernet controller and its associated settings. An Ethernet controller describes the hardware and associated system software that manages an Ethernet link.

Formatsconfig controller ethernet { port | wan/port | unit/port}

assigndefault { hardware-address | speed }description textdisableenableencapsulation { no | ppp }hardware-address mac_addressproxy-arp { enable | disable }speed { auto | 10h | 10f | 10hx | 10fx | 100h | 100f | 100hx |

100fx | 1000f | 1000fx }unassign

For resetting Ethernet controllers:config default controller ethernet { * | port | wan/port | unit/port }

Parameters

* Specifies all controllers or all Ethernet controllers.

assign Specifies that the Ethernet controller should be tracked as a resource. This lets the user determine Ethernet port availability.

default Resets a specified parameter to its default value.

description Configures a controller description. The following parameter is accepted:

text—Defines the text description for the Ethernet controller. Maximum length is 60 characters.

WESTELL.COM

1-800-377-8766

Page 2-29


disable Disables the specified Ethernet port from passing data.

Note: When a port is disabled, its link state may still be listed

as up in command show controllers ethernet on page 3-30. The link state represents the presence of a cable connection on the port, whereas the port status represents the port’s ability to pass data.

enable Enables the specified Ethernet port to pass data.

encapsulation Configures the communication encapsulation mode. The following parameters are accepted: no—Sets raw mode. ppp—Sets PPP mode.

hardware-address

Configures the hardware address for a Remote RMX-3200 Ethernet controller. A hardware address is a data-link layer address associated with a particular network device. It is entered in hexadecimal form. The default hardware address is 00:40:72:01:62:18. The following parameter is accepted:

mac_address—Defines the hardware (MAC) address value. Enter MAC addresses as 6-byte, hexadecimal formatted values with a colon separating each byte (for example, 00:e0:52:cc:0b:00).


port Defines the physical connector associated with the controller on Remote RMX-3200. Valid Ethernet port values are 1 to 8. You may also see an Ethernet port 0, which is associated with the expansion slot. If the WGBE card is installed in the expansion slot, ports wan/1 and wan/2 represent WGBE’s 1000baseT ports, while wan/3 and wan/4 represent WGBE’s fiber SFP ports.For information about valid WAN Ethernet port values on Remote RMX-3200 models, refer to Appendix : .

WESTELL.COM

Page 2-30

1-800-377-8766


proxy-arp Configures proxy ARP on an Ethernet controller. Proxy ARP is the technique by which a host answers ARP requests intended for another machine. By doing this, the host accepts responsibility for routing packets to a destination. Proxy ARP can help machines on a subnet reach remote subnets without configuring routing or a default gateway. The following parameters are accepted: disable—Disables proxy ARP on an Ethernet controller.

Proxy ARP is disabled by default. enable—Enables proxy ARP on an Ethernet controller.

speed Configures the following settings for an Ethernet controller: Speed (in megabits per second) Duplex operation—Refers to the simultaneous

transmission and reception of signals by a single device. Half duplex operation (not available for Gigabit Ethernet) allows a controller to transmit and receive, but not at the same time. Full duplex operation allows a controller to transmit and receive simultaneously.

Tip: For full duplex operation, the controller must have full duplex capabilities.

MDI-X capabilities—Refers to a physical connection in a controller that includes an internal crossover of transmit and receive signals. This capability lets like devices communicate with each other directly, without crossover cables or switches.

The default controller speed is auto, which automatically negotiates for the fastest controller speed possible between the controller and the Remote RMX-3200.

unassign Specifies that the Ethernet controller should no longer be tracked as a resource.

unit Defines the peripheral expansion unit where the physical port associated with the RME-E8 controller is located. Valid values are 1 to 12.

Note: Only a subset of the parameters are available for

RME-E8 controllers.

WESTELL.COM

1-800-377-8766

Page 2-31



ExamplesThe following Ethernet controller settings are configured for controller ethernet 2:

Enabled controller ethernet 2 00:E0:52:CC:0B:00 for the MAC address 10h for the speed Enabled proxy ARP Resource tracking assigned Ethernet 2 for the description.

See Alsoconfig controller ethernet bridge switch stp

config controller ethernet mac-security


(Dub)>config(Dub) config>controller ethernet 2(Dub) config controller ethernet 2>enable(Dub) config controller ethernet 2>hardware-address 00:E0:52:CC:0B:00(Dub) config controller ethernet 2>speed 10h(Dub) config controller ethernet 2>description Ethernet 2(Dub) config controller ethernet 2>

WESTELL.COM

Page 2-32

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller ethernet bridge switch

config controller ethernet bridge switch

DescriptionThis command associates an Ethernet controller with bridge group switch and configures the bridging mode and VLAN identifier for the Ethernet controller.

Formatconfig controller ethernet port bridge switch

default { mode | vlan }mode { native | port-vlan }vlan vlan_id

For removing the Ethernet controller from the bridge group:config controller ethernet port no bridge

Parameters


mode Configures the controller’s bridging mode. The bridging mode defines how Remote RMX-3200 handles 802.1Q tags and port VLANs. The following parameters are accepted: native—Specifies native mode, which causes the port to transmit

and receive all traffic without modifying any tags. Traffic received that is already in use by another port VLAN mode will be dropped. All other traffic is forwarded to other native mode ports and any trunk ports.

port-vlan—Specifies port VLAN mode, which causes the port to be grouped with other port VLAN mode ports with the same VLAN identifier. Traffic from ports in a port VLAN is isolated from native ports or those ports with a different VLAN identifier. The VLAN identifier is used to tag port VLAN traffic on a trunking port.

no Removes the Ethernet controller from bridge group switch.

port Defines the physical connector associated with the controller on Remote RMX-3200. Valid Ethernet port values are 1 to 8. You may also see an Ethernet port 0, which is associated with the expansion slot. For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

vlan Configures the port’s VLAN identifier. This setting only applies when the port is in port-vlan mode. The following parameter is accepted:

vlan_id—Defines the port's 802.1Q VLAN identifier. Valid values are 1 to 499. The default value is 1.

WESTELL.COM

1-800-377-8766

Page 2-33

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller ethernet bridge switch


ExamplesThe following settings are configured for controller ethernet 2 on bridge switch:

Bridging mode port-vlan VLAN ID 22.

See Alsoconfig controller ethernet

config controller ethernet bridge switch stp


show controllers ethernet

(Dub)>config(Dub) config>controller ethernet 2(Dub) config controller ethernet 2>bridge switch(Dub) config controller ethernet 2 bridge switch->mode port-vlan(Dub) config controller ethernet 2 bridge switch->vlan 22(Dub) config controller ethernet 2 bridge switch->

WESTELL.COM

Page 2-34

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller ethernet bridge switch stp


DescriptionThis command associates an Ethernet controller with bridge group switch and configures STP settings for the Ethernet controller. Bridge group switch is a set of controllers that act like a single Ethernet network and can be assigned to a single routable interface.

Formatconfig controller ethernet port bridge switch stp

cost path_costdefault { cost | priority }priority priority

For removing the Ethernet controller from the bridge:config controller ethernet port no bridge

Parameters

cost Configures the path cost for an Ethernet controller in a bridge group. Cost is a metric used in spanning tree calculations to determine the best path for reaching a destination. The higher the cost for a path, the less desirable it is to use that path and the more likely the spanning tree algorithm is to disable the port if a network loop occurs. The following parameter is accepted:

path_cost—Defines the path cost. Valid values are 1 to 65,535. The default path cost is 10.



port Defines the physical connector associated with the controller on Remote RMX-3200. Valid Ethernet port values are 1 to 8. You may also see an Ethernet port 0, which is associated with the expansion slot. For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

priority Configures the priority level for an Ethernet controller in a bridge group. The following parameter is accepted:

priority—Defines the STP port priority. Valid values are 0 to 255. The highest priority level is 0. The default priority level is 128.

WESTELL.COM

1-800-377-8766

Page 2-35

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller ethernet bridge switch stp


ExamplesThe following settings are configured of controller ethernet 3 on bridge switch:

Path cost 45 Priority level 50


config controller ethernet bridge switch



(Dub)>config(Dub) config>controller ethernet 3(Dub) config controller ethernet 3>bridge switch(Dub) config controller ethernet 3 bridge switch->stp(Dub) config controller ethernet 3 bridge switch stp->cost 45(Dub) config controller ethernet 3 bridge switch stp->priority 50(Dub) config controller ethernet 3 bridge switch stp->

WESTELL.COM

Page 2-36

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller ethernet mac-security


DescriptionThis command configures MAC security settings for an Ethernet controller.

Formatsconfig controller ethernet port mac-security

address mac_addresscapture { count number | start | time duration }disableenableno address { mac_address | * }

For removing MAC security:config controller ethernet port no mac-security

Parameters

* Specifies all MAC addresses.

address Configures a MAC address table entry for the Ethernet controller. A MAC address table is a list containing the MAC addresses of all devices permitted access to Remote RMX-3200 through a controller. A MAC address table can contain a maximum of 32 MAC addresses. The following parameter is accepted:

mac_address—Defines the MAC address. Enter MAC addresses as 6-byte, hexadecimal formatted values with a colon separating each byte (for example, 00:e0:52:cc:0b:00).

WESTELL.COM

1-800-377-8766

Page 2-37



capture Captures and adds any MAC addresses heard on a controller to the MAC address table. The following parameters are accepted: count—Configures the number of MAC addresses an Ethernet

controller will learn before they are captured and added to the controller's MAC address table. A MAC address table can contain a maximum of 32 MAC addresses.Important: MAC addresses cannot be captured when MAC

security is enabled on a controller.

number—Defines the number of MAC addresses an Ethernet controller will learn before they are captured and added to the controller’s MAC address table. Valid values are 1 to 32.

start—Configures an Ethernet controller to listen to traffic and capture MAC addresses in the controller’s MAC address table. Remote RMX-3200 captures MAC addresses until CTRL+c is pressed.

time—Configures the amount of time for a Ethernet controller to listen to traffic.

Note: When the MAC address table fills up, a message is

displayed that says Maximum number of MAC addresses has been reached.

duration—Defines the number of seconds a controller will listen for MAC addresses. Valid values are 1 to 300.

disable Disables MAC security on an Ethernet controller.

enable Enables MAC security on an Ethernet controller.


port Defines the physical connector associated with a controller on Remote RMX-3200. Valid Ethernet port values are 1 to 8. You may also see an Ethernet port 0, which is associated with the expansion slot. For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

WESTELL.COM

Page 2-38

1-800-377-8766


ExamplesThe following MAC security settings are configured for controller ethernet 2:

MAC security is disabled MAC address 00:e0:52:cc:0b:00 is added to the MAC address table Capture count is set to 26 Capture time is set to 55 seconds The controller starts capturing MAC addresses.


config controller bridge switch



(Dub)>config(Dub) config>controller ethernet 2(Dub) config controller ethernet 2>mac-security(Dub) config controller ethernet 2 mac-security->disable(Dub) config controller ethernet 2 mac-security->address 00:e0:52:cc:0b:00(Dub) config controller ethernet 2 mac-security->capture count 26Existing address:00:E0:52:CC:0B:00

Press ctrl-c to terminate capture[UCLI0063] Interrupted.(Dub) config controller ethernet 2 mac-security->capture time 55Existing address:00:E0:52:CC:0B:00

Press ctrl-c to terminate capture[UCLI0063] Interrupted.(Dub) config controller ethernet 2 mac-security->capture startExisting address:00:E0:52:CC:0B:00

Press ctrl-c to terminate capture[UCLI0063] Interrupted.(Dub) config controller ethernet 2 mac-security->

WESTELL.COM

1-800-377-8766

Page 2-39

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller nat64

config controller nat64

DescriptionThis command adds the nat64 controller which manages the NAT64 feature.

Formatsconfig controller nat64

disableenableipv4-pool { ipv4 network/subnet mask length }ipv6-address { ipv6 address }no { ipv4-pool | ipv6-address }no map { real address | * }map { real address } { mapped address }

For resetting the nat64 controller to default:config default controller nat64

For removing nat64 controller:config no controller nat64

Parameters

* Specifies all addresses

disable Disables the nat64 controller (default)

enable Enables the nat64 controller

ipv4-pool Configures NAT64 controller’s IPv4 pool address and mask

ipv6-address Configures NAT64 controller’s IPv6 address

no Negates a controller command

no map Removes a map or, with the “*” wildcard, removes all maps

map Configures static IP address map

mapped address The mapped IPv6 or IPv4 address

real address The real IPv4 or IPv6 address

subnet mask length

Length of the subnet mask

WESTELL.COM

Page 2-40

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller nat64


ExamplesThe following maps IPv6 address fd11::39:0:0:c1a9:640a for a device with the real IPv4 address 193.169.100.10:

The following maps IPv6 address fd11::39:0:0:193.169.200.10 for a device with the real IPv4 address 193.169.200.10:

See Alsoconfig interface nat64

show controllers nat64

(Kentrox)>(Kentrox)>config(Kentrox) config>cont nat64(Kentrox) config controller nat64>map 193.169.100.10 fd11::39:0:0:c1a9:640a(Kentrox) config controller nat64>

(Kentrox) config>(Kentrox) config>cont nat64(Kentrox) config controller nat64>map 193.169.200.10 fd11::39:0:0:193.169.200.10 (Kentrox) config controller nat64>

WESTELL.COM

1-800-377-8766

Page 2-41

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller openvpn

config controller openvpn

DescriptionThis command configures an OpenVPN controller and its associated settings. An OpenVPN controller describes the system software that manages an OpenVPN client, server or site-server.

Formatsconfig controller openvpn name

allow-access ip_address {{ udp | tcp } { port | start_port-end_port}}...

cipher { blowfish-128 | aes-128 | aes-256 }client-route interface instancedefault { cipher | hardware-address | keep-alive | port |

protocol}description textdisableenablehardware-address mac_addresskeep-alive inactive disconnected mode { client | server | site-server}no { description | server | allow-access | client-route}port server_portprotocol { udp | tcp }server ip_address [ port ]

For resetting the OpenVPN controller:config default controller openvpn name

For deleting OpenVPN controllers:config no controller openvpn { name | * }

WESTELL.COM

Page 2-42

1-800-377-8766


Parameters

Note: Depending on the mode that is configured, there will be different parameters available. For example, the keep-alive and port parameters are not available when the mode is set to client.

* Specifies all OpenVPN controllers.

allow-access Configures the IP address and the UDP or TCP ports to allow access to the site VPN connection. ICMP ping requests and replies are automatically allowed for each IP address specified with the allow-access parameter. When configuring rules for an IP address, the rules for all ports and protocols must be specified in the same command. For example,allow-access ip_address tcp 20-80 tcp 443 udp 161

Note: This command is only available in the site-server

mode.

cipher Configures the algorithm used to encrypt the data on the VPN. The following parameters are accepted: aes-128—Specifies the 128-bit AES algorithm. aes-256—Specifies the 256-bit AES algorithm. blowfish-128—Specifies the 128-bit Blowfish algorithm.

This is the default cipher option.

client-route Configures the interface (Ethernet or bridge) whose networks are used to route clients to the Remote via the VPN connection.


mode.

default Resets a parameter to its default setting.

description Configures a description for the OpenVPN controller. The following parameter is accepted:

text—Defines a description for the controller. The maximum length for a controller description is 60 characters.

disable Disables the OpenVPN controller.

enable Enables the OpenVPN controller.

WESTELL.COM

1-800-377-8766

Page 2-43


hardware-address

Configures the hardware address for an OpenVPN controller. The default hardware address is assigned by the underlying system driver. The following parameter is accepted:

mac_address—Defines the MAC address. Enter MAC addresses as 6-byte, hexadecimal formatted values with a colon separating each byte (for example, 00:e0:52:cc:0b:00).

Note: This command is not available in the site-server

mode.

keep-alive Configures the keep-alive parameters for clients and servers in the VPN. The keep-alive feature transmits ping packets from both the client and server when no user data is being transmitted. When one side of the connection fails to receive packets, a notification is sent to indicate a disconnected peer. These packets also maintain an active firewall state.

Note: This command is available only when the mode is set

to server and site-server modes. The settings are pushed to clients when the connect to the server.

The following parameters are accepted: inactive—Defines the number of seconds that a

session must be inactive before a ping packet is transmitted. Valid values are 5 to 60. The default value is 30 seconds.

disconnected—Defines the number of seconds that a peer receives no packets before it is considered to be disconnected. Valid values are 20 to 3600. The default value is 120 seconds.

Notes: The disconnected value must be larger than the

inactive timeout value.

This command is not available in the client mode.

WESTELL.COM

Page 2-44

1-800-377-8766


mode Configures the OpenVPN controller in client or server mode. The following parameters are accepted: client—Specifies client mode. This is the default value. server—Specifies server mode. Typically, Remote RMX-

3200 will not be configured to run in server mode. site-server-Specifies site-server mode.

Note: When the OpenVPN controller is configured for the

site-server mode, the following parameters are also available:

allow-access

client-route

port

protocol


port Configures the port a server uses to communicate with clients for an OpenVPN controller. The following parameter is accepted:

port—Defines the port a server uses to communicate with clients. Valid values are 1024 to 65535. The default value is OpenVPN standard port 1194.

Note: This command is only available in the server and site-

server modes.

protocol Configures the protocol (TCP or UDP) used for communication between the site server and clients.


mode.

server Configures the address of the peer OpenVPN server. The following parameters are accepted: ip_address—Configures the IP address used to

communicate with the server. server_port—Configures the port used to communicate

with the server. Valid values are 1024 to 65535. The default value is OpenVPN standard port 1194.

Note: This command is only available in client mode.

WESTELL.COM

1-800-377-8766

Page 2-45



ExamplesThe following settings are configured for OpenVPN controller cmhclient1:

Enabled OpenVPN controller Description VPN client controller CMH1 Hardware-address 00:FF:17:8A:D4:1B Server IP address 172.16.220.1 and port number 2294 256-bit AES encryption cipher

See Alsoconfig interface openvpn

show controllers openvpn

(Dub)>config(Dub) config>controller openvpn cmhclient1(Dub) config controller openvpn cmhclient1>enable(Dub) config controller openvpn cmhclient1>description VPN client controller CMH1(Dub) config controller openvpn cmhclient1>hardware-address 00:FF:17:8A:D4:1B(Dub) config controller openvpn cmhclient1>server 172.16.220.1 2294(Dub) config controller openvpn cmhclient1>cipher aes-256(Dub) config controller openvpn cmhclient1>

WESTELL.COM

Page 2-46

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config controller serial

config controller serial

DescriptionThese commands configure a serial controller. A serial controller describes the hardware and software that communicate on a serial link.

Format

For asynchronous controllers:config controller serial { port | unit/port }

application { destination | source | destination source }assignbaud { 300 | 600 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 |

57600 | 115200 }databits { 6 | 7 | 8 }default dial-timerdescription textdial-timer intervaldisableenableencapsulation pppflow { none | xonxoff | hardware }linemode { rs232 | rs422 | rs485f | rs485h }lineterm { disable | enable }no descriptionparity { none | even | odd }stopbits { 1 | 2 }unassign

For E1 controllers:config controller serial port

assignchannel-group group-id

encapsulation hdlcencapsulation ppp

clock { internal | loop }default { framing | linecode }description textdisableenableframing { crc-4 | no-crc4 }linecode { ami | hdb3 }no description

WESTELL.COM

1-800-377-8766

Page 2-47


unassign

For wireless modem controllers using an EVDO modem:config controller serial wan/1

assignconnectdescription textdisableenableencapsulationno descriptionno encapsulationno prl-updateprl-update network interval [ hour:minute ]unassign

For wireless modem controllers using an HSPA modem:config controller serial wan/1

assignconnectdescription textdisableenableencapsulationno descriptionno encapsulationno prl-updateno sim-pinsim-pinunassign

For wireless modem controllers using an LTE modem:config controller serial wan/1

apn apnassignauthentication { pap | chap } username [ password ]defaultroutedescription textdisableenableno apnno authenticationno defaultrouteno description

WESTELL.COM

Page 2-48

1-800-377-8766


no sim-pinsim-pin [pin]unassign

For T1 controllers:config controller serial port

assignbuildout { -15dB | -22.5dB | -7.5dB | 0dB | 0to133ft |

134to266ft | 267to399ft | 400to533ft | 534to655ft }channel-group group-id

encapsulation hdlcencapsulation ppp

clock { internal | loop }default { buildout | clock | framing | linecode }description textdisableenableframing { d4 | esf }linecode { ami | b8zs }loop-detect { disable | enable }no channel-group group-idno descriptionunassign

For resetting serial controllers:config default controller serial { * | port | unit/port | wan/1 | wan/2 }

Parameters

apn name Sets the optional specific access point name (APN) to use. If no APN is specified, the default settings in the SIM card are used.

application Configures the link application mode for an asynchronous serial controller. The application mode sets up a serial controller as a destination for internal connections, or gives the controller the ability to initiate internal connections when a system event occurs. The following parameters are accepted: destination—Sets the serial controller as the destination for

internal connections. source—Sets the serial controller as the initiator of internal

connections when the port associated with the controller responds to a system event.

By default, destination and source are both enabled. At least destination or source must be configured at all times.

WESTELL.COM

1-800-377-8766

Page 2-49


assign Specifies that the serial controller should be tracked as a resource. This lets the user determine serial port availability.

authentication Sets the optional authentication required by an LTE modem. The following parameters are accepted: chap -- Specifies the CHAP authentication method. CHAP is an

access protocol that uses encryption to avoid revealing passwords.

pap -- Specifies the PAP authentication method. PAP transmits unencrypted passwords. For this reason, it is less secure than CHAP.

baud Configures the baud rate for an asynchronous serial controller. The baud rate is the measurement of transmission speed over a serial cable. It represents the number of transitions (voltage or frequency changes) that are made per second over the line. The default baud rate is 9600.

buildout Sets the line buildout for a serial controller. Buildout refers to the length of the cable (in feet) that is connecting the devices on each end of a T1 line or the level of attenuation (in decibels) required for the devices on each end of a T1 line to communicate. Buildout is usually specified by the cable length for local communication and by the level of attenuation for non-local wide area communication.

channel-group Configures a channel group for a serial controller. The following parameter is accepted:

group id—Defines the channel group ID.

clock Configures a serial controller’s clock source. The available settings are loop and internal. The following parameters are accepted: internal—Sets Remote RMX-3200 to generate the clock

time, which causes the controller to generate transmitted T1/E1 frames based on the Remote RMX-3200 generated clock.

loop—Sets the T1/E1 line to generate the clock time, which causes the controller to generate transmitted T1/E1 frames based on received frame timing.

The default clock source is loop.

Note: This command is not available for DAC Remote RMX-3200

models. For more information about DAC, refer to the Remote RMX-3200 Configuration Guide.

connect Refer to config controller serial connect on page 2-62.

WESTELL.COM

Page 2-50

1-800-377-8766


databits Configures the number of databits in a databyte for an asynchronous serial controller. The default number of databits in a databyte is 8.


Note: All interfaces associated with the controller(s) being reset

are deleted.

defaultroute Sets whether the serial wan/1 interface will become the default route.

description Configures a description for the serial controller. The following parameter is accepted:

text—Defines a description for the controller. The maximum length for a controller description is 60 characters.

dial-timer Configures the amount of time Remote RMX-3200 will wait for an asynchronous port to come up before the connection fails. This feature applies to asynchronous ports in DCD connect mode only. The following parameter is accepted:

interval—Defines the amount of time in seconds before a connection to an asynchronous port fails. Valid range is 1 to 90 seconds. The default time is 1 second.

disable Disables the serial controller. Serial controllers are enabled by default.

enable Enables the serial controller. Serial controllers are enabled by default.

encapsulationencapsulation hdlcencapsulation ppp

Refer to config controller serial encapsulation on page 2-68.

WESTELL.COM

1-800-377-8766

Page 2-51


flow Configures flow control for an asynchronous serial controller. Flow control allows a receiving device to tell a sending device to stop sending data when the data comes in faster than the receiver can process it and to start sending it when the receiver is ready. The following parameters are accepted: none—Specifies no flow control. xonxoff—Specifies XON/XOFF flow control, which uses

binary characters “off” and “on” to tell the other device to stop and go. This type of flow control only works with ASCII data. If the data is binary, then the xoff and xon characters may appear as part of the data.

hardware—Specifies hardware flow control, which uses RTS and CTS control signals to tell the sending device when data can be sent. This type of flow control works with both binary and ASCII data.

Flow control is set to none by default.

framing Configures the T1/E1 line framing format. The following parameters are accepted for T1 lines: d4—Sets D4 T1 framing mode. D4 framing is usually used in

conjunction with AMI line coding, but may be used with B8ZS line coding.

esf—Sets T1 Extended SuperFrame framing mode. ESF framing is usually used in conjunction with B8ZS line coding, but may be used with AMI line coding.

The following parameters are accepted for E1 lines: crc4—Sets the E1 frame format to CRC4. no-crc4—Sets the E1 frame format to have no CRC4.The default framing format is esf for T1 lines and no-crc4 for E1 lines.

WESTELL.COM

Page 2-52

1-800-377-8766


linecode Configures the bit-level encoding method for a T1/E1 line on Remote RMX-3200. The following parameters are accepted for T1 lines:

ami—Sets the encoding method to AMI.

Tip: AMI encoding is typically applied to controllers that use D4 framing. However, it can be applied to controllers that use ESF framing.

b8zs—Sets the encoding method used on T1 lines to B8ZS.

Tip: B8ZS encoding is typically applied to controllers that use ESF framing.

The following parameters are accepted for E1 lines: ami hdb3—Sets the encoding method used on E1 lines to HDB3,

which is similar to the B8ZS encoding method on T1 lines.

Note: The default encoding methods are b8zs for T1 lines and

hdb3 for E1 lines.

linemode Configures the linemode for an asynchronous serial controller. The linemode sets the electrical encoding for data and the definition for control leads on a serial interface. The following parameters are accepted: rs-232 rs-422 rs-485f (full duplex) rs-485h (half duplex)The default linemode is rs-232.

lineterm Configures line termination (available in RS485 mode). disable—Disables line termination. enable—Enables line termination. Useful if this Remote RMX-

3200 is the first or last device in a daisy chain. This is the default setting.

loop-detect Configures loopback detection on the WAN serial controller. The following parameters are accepted: disable—Disables loopback detection on the WAN serial

controller. enable—Enables loopback detection on the WAN serial

controller.

WESTELL.COM

1-800-377-8766

Page 2-53



parity Configures the parity for an asynchronous serial controller. Parity is a process for detecting whether or not bits of data have been altered during data transmission. The following parameters are accepted: even—Sets the parity mode to even, which sets the parity bit to

0 if the total number of ones in a bit is an even number. odd—Sets the parity mode to odd, which sets the parity bit to 0

if the total number of ones in a bit is an odd number. none—Sets the parity mode to none.Parity is set to none by default.

port Defines the physical connector associated with a controller on Remote RMX-3200. Valid asynchronous port values are 1 through 8 and wan/1. For information about valid T1/E1 port values, refer to Appendix : .

prl-update Configures updates to the Preferred Roaming List (PRL) for CDMA/EvDO modems. The following parameters are accepted: network—Identifies the network to which Remote RMX-3200

is connected. Valid values are alphanumeric characters. interval—Specifies the number of days between updates.

Valid values are 7 to 90. hour:minute—Specifies the time of day to update the PRL.

Valid range is 00:00 to 23:59. The default value is 00:00 (midnight).

By default, PRL updates are disabled.

sim-pin Configures the Personal Identification Number (PIN) that is sent to the SIM for authentication: pin - Configures the PIN. If the PIN is not specified, the CLI

will prompt the user without echo to the screen. The PIN must have 4-8 digits. The PIN displayed in running-config is obfuscated to prevent a reader from easily determining it.

Important: Three incorrect entries will lock the SIM, and the PIN Unlock Key (PUK) will be required to unlock it. Refer to the diagnostic command diag controller serial wan/1 on page 4-13.

There is no sim-pin by default.

WESTELL.COM

Page 2-54

1-800-377-8766



ExamplesThe following settings are configured for controller serial 2:

Description Sample controller description Application type destination Baud rate 57600 7 databits per byte Dial timer of 15 seconds xonxoff flow control Linemode rs422 even bit parity Stop bit 2.

The following settings are configured for T1 controller serial wan/1:

267to399ft buildout esf framing

stopbits Configures the stop bits for an asynchronous link on an asynchronous serial controller. A stop bit is an extra bit at the end of an asynchronous character that helps the receiver recognize the end of the character. The following parameters are accepted: 1—Sets the stop bit to one. 2—Sets the stop bit to two.By default, the stop bit is set to 1.

unassign Specifies that the serial controller should no longer be tracked as a resource.

unit Defines the peripheral expansion unit in which the physical port associated with this controller is located. Valid values are 1 to 12.

(Dub)>config(Dub) config>controller serial 2(Dub) config controller serial 2>description Sample controller description(Dub) config controller serial 2>application destination(Dub) config controller serial 2>baud 57600(Dub) config controller serial 2>databits 7(Dub) config controller serial 2>dial-timer 15(Dub) config controller serial 2>flow xonxoff(Dub) config controller serial 2>linemode rs422(Dub) config controller serial 2>parity even(Dub) config controller serial 2>stopbits 2(Dub) config controller serial 2>

WESTELL.COM

1-800-377-8766

Page 2-55


b8zs linecode disable loop-detect

To configure a sim-pin that has been enabled, run this command:

The user will be prompted to enter the PIN. The PIN entry display will be obfuscated. For confirmation, the user will be prompted to enter the PIN a second time.

The PIN that is configured with this command must match the PIN that is contained in the SIM. See diag controller serial wan/1 on page 4-13 for commands to enable and disable the sim-pin feature and/or change the SIM’s PIN.

(Dub)>config(Dub) config>controller serial wan/1(Dub) config controller serial wan/1>buildout 267to399ft(Dub) config controller serial wan/1>framing esf(Dub) config controller serial wan/1>linecode b8zs(Dub) config controller serial wan/1>loop-detect disable

(Kentrox)>config controller serial modem sim-pinEnter the PIN for the SIM card: ****Confirm the PIN for the SIM card: ****

WESTELL.COM

Page 2-56

1-800-377-8766


config controller serial bridge switch

DescriptionThese commands configure a serial controller as part of bridge group switch. A bridge group is a set of controllers that act like a single switch and can be assigned to a single routable interface. Bridge group switch is the only bridge group that can be configured for Remote RMX-3200.

Important: Serial ports must be configured with PPP encapsulation before this command can be executed. If they are not, an error will occur. Refer to command config controller serial encapsulation on page 2-68 for more information.

Format

For asynchronous controllers:config controller serial port bridge switch

stp cost path_coststp default { cost | priority }stp priority priority

For T1/E1 controllers:config controller serial port channel-group group bridge switch

stp cost path_coststp default { cost | priority }stp priority priority

For removing the serial controller from the bridge group:config controller serial port no bridge

config controller serial wan/1 no bridge

config controller serial port channel-group group no bridge

Parameters

channel-group

Specifies a serial port channel group. For information about configuring a range of channels, refer to command config controller serial channel-group group on page 2-59.

WESTELL.COM

1-800-377-8766

Page 2-57



ExamplesThe following bridge group settings are configured for controller serial 4:

STP path cost 21000 STP port priority 210

cost Configures the STP path cost for a serial controller in a bridge group. Cost is a metric used in spanning tree calculations to determine the best path for reaching a destination. The higher a path's cost, the less desirable it is to use that path and the more likely the spanning tree algorithm is to disable the port if a network loop occurs. The following parameter is accepted:

path_cost—Defines the path cost. Valid values are 1 to 65,535.

default Resets the specified parameter to its default value.

group Specifies the only configurable serial port channel group on Remote RMX-3200.

no Removes a serial controller from the bridge group.

port Defines the physical connector associated with a controller on Remote RMX-3200. Valid asynchronous port values are 1 to 8. For information about valid T1/E1 port values, refer to Appendix :

priority Configures the STP port priority for a serial controller in a bridge group. The port priority is a parameter used by STP to determine which ports will be disabled when a network loop occurs. The following parameter is accepted:

priority—Defines the STP port priority. Valid values are 0 to 255. The highest priority is 0.

stp Configures the spanning tree protocol (STP) settings for a serial controller in a bridge group.

WESTELL.COM

Page 2-58

1-800-377-8766


config controller serial channel-group group

DescriptionThese commands configure a channel group for a serial controller. The only configurable serial controller channel group on Remote RMX-3200 is named group.

Formatsconfig controller serial port channel-group group

default { speed | timeslot }disableenablespeed { 56 | 64 }timeslot range

For deleting a channel group:config controller serial port no channel-group group

Parameters

(Dub)>config(Dub) config>controller serial 4(Dub) config controller serial 4>bridge switch(Dub) config controller serial 4 bridge switch->stp(Dub) config controller serial 4 bridge switch stp->cost 21000(Dub) config controller serial 4 bridge switch stp->priority 210(Dub) config controller serial 4 bridge switch stp->


disable Disables a channel group for a serial controller.

enable Enables a channel group for a serial controller.

port Defines the physical connector associated with a controller on Remote RMX-3200. Valid asynchronous port values are 1 to 8. For information about valid T1/E1 port values, refer to Appendix : .

WESTELL.COM

1-800-377-8766

Page 2-59



ExamplesThe following settings are configured for controller serial wan/1 in channel group group:

Channel group enabled Speed 56 DS0 channels 1-4, 6-8 and 10.

speed Configures the throughput speed (in kilobits per second) for a channel group. The following parameters are accepted: 56—Sets the throughput speed to 56 kilobits per second. 64—Sets the throughput speed to 64 kilobits per second.

Note: 64 can only be used when the bit-level encoding method for the

controller is B8ZS.

Tip: The total speed for a channel group is calculated by multiplying the number of DS0 channels in the group by the throughput speed per channel.

timeslot Configures the DS0 channels to include in a channel group. Users can include any combination of DS0 channels 1 to 24 for T1 applications and channels 1 to 31 for E1 applications. The following parameter is accepted:

range—Defines the DS0 channels available for serial communication in a channel group. The following values are valid: A single channel number (for example, 2) A series of channel numbers separated by commas (for

example, 2,4,6,8) A range of channel numbers separated by a dash (for example,

1-24) Any combination of a single channel number and/or a series of

channel numbers and/or a range of channel numbers (for example, 1-2,4,6-10).

WESTELL.COM

Page 2-60

1-800-377-8766


(Dub)>config(Dub) config>controller serial wan/1(Dub) config controller serial wan/1>channel-group group(Dub) config controller serial wan/1 channel-group group->enable(Dub) config controller serial wan/1 channel-group group->speed 56(Dub) config controller serial wan/1 channel-group group->timeslot 1-4,6-8,10(Dub) config controller serial wan/1 channel-group group->

WESTELL.COM

1-800-377-8766

Page 2-61


config controller serial connect

DescriptionThis command configures the connection settings for an asynchronous serial controller or modem.

Formatconfig controller serial { port | unit/port } connect

dtr { on | off }mode { dcd | activity | dcd activity }no { mode | string }rts { on | off | followdsr }string { connect_string | @chat_file }

For wireless modem controllers using EVDO or HSPA modems:config controller serial wan/1 connect

string { connect_string | @chat_file }no string

Note: LTE modems do not support this command.

Parameters

dtr Configures the state of the DTR output signal when an asynchronous serial controller is connected. DTR is a control signal on an asynchronous RS-232 serial port. The following parameters are accepted: on—Sets the DTR signal state to on when the serial controller

connects. off—Sets the DTR signal state to off when the serial controller

connects.By default, the DTR signal state is on.

WESTELL.COM

Page 2-62

1-800-377-8766


mode Configures the connect mode for an asynchronous serial controller. The connect mode is a handshake from a device attached to Remote RMX-3200 that initiates or accepts an asynchronous connection. By default, no connection mode is configured.

Note: If the asynchronous port is configured to be always up (i.e., no

connect mode is configured) and a mediation connection to or from the asynchronous port terminates or fails, the port will briefly cycle down and come up again so that it generates an up event.

The following parameters are accepted: dcd—Specifies the DCD connect option. After the device connected

to the port asserts DCD, this option generates a controller up event (unless the activity option is also enabled and is satisfied first).

activity—Specifies the connect-on-activity option. This option causes the controller to wait for incoming characters before generating a link up event (unless the DCD option is also enabled and is satisfied first). If the DSR option is enabled and incoming characters are received before DSR is asserted, the controller may connect without sending a connect string.


port Defines the physical connector associated with the asynchronous controller. Valid values are 1 to 8 and wan/1.

rts Configures the state of the RTS output signal when an asynchronous serial controller is connected. RTS may be used as part of the connect and disconnect handshake or for hardware flow control.

Note: The RTS signal is ignored if hardware flow control is enabled. To

enable hardware flow control, refer to command config controller serial on page 2-47.

The following parameters are accepted: on—Sets the RTS signal state to on when the serial controller makes

a connection. off—Sets the RTS signal state to off when the serial controller

makes a connection. followdsr—Sets the RTS signal state to follow the associated DSR

input signal.The default RTS signal state is set to on.

WESTELL.COM

1-800-377-8766

Page 2-63



ExamplesThe following serial controller connect settings are configured for controller serial 3:

DTR signal state on Connect mode dcd RTS signal state on Connection string ATDT1234567

string Configures the connection initialization string for an asynchronous serial controller. Depending on the connection settings, this string may or may not be sent to the UART. The following parameters are accepted: connect_string—Defines the connection string. The maximum

length is 128 characters. The following standard AT commands configure the modem to place a call and answer a call: ATS0=1 configures the modem to answer incoming calls. ATDTcall_string configures the modem to dial a phone number

(for example, ADTD6145556767). This call string works with virtually any asynchronous modem.

@chat_file—Defines the name of a chat file in the /config/chat directory on Remote RMX-3200.

Notes: A chat file can only be configured as the connection

initialization string for ports that are configured for PPP encapsulation.

A user must FTP the chat file to the /config/chat directory on Remote RMX-3200 prior to configuring the file as the connection initialization string.


WESTELL.COM

Page 2-64

1-800-377-8766


(Dub)>config(Dub) config>controller serial 3(Dub) config controller serial 3>connect(Dub) config controller serial 3 connect->dtr on(Dub) config controller serial 3 connect->mode dcd(Dub) config controller serial 3 connect->rts on(Dub) config controller serial 3 connect->string ATDT1234567(Dub) config controller serial 3 connect->

WESTELL.COM

1-800-377-8766

Page 2-65


config controller serial disconnect

DescriptionThis command configures the disconnect settings for an asynchronous serial controller.

Formatconfig controller serial { port | unit/port } disconnect

dtr { on | off | pulse }mode { dcd | break }no moderts { on | off | pulse }

Parameters

dtr Configures the state of the DTR output signal when an asynchronous serial controller is disconnected. DTR is a control signal on an asynchronous RS-232 serial port. The following parameters are accepted: on—Sets the DTR signal state to on when the serial controller

disconnects. off—Sets the DTR signal state to off when the serial controller

disconnects. pulse—Causes the DTR signal to change state to the opposite of the

connect DTR state for one second, then return to the connect DTR state.

By default, the DTR signal state is set to off.

mode Configures the disconnect mode for an asynchronous serial controller. The disconnect mode is a handshake from a device attached to Remote RMX-3200 that terminates or accepts termination of an asynchronous connection. The following parameters are accepted: dcd—Specifies the DCD disconnect mode option. When a DCD has

been deasserted, this option generates a controller down event. If the DSR option is enabled and DCD is deasserted before DSR, the controller may disconnect without sending a disconnect string.

break—Specifies that the serial port disconnects when a serial break is received.

By default, no disconnect mode is configured.

no Deletes the specified parameter.

port Defines the physical connector associated with the asynchronous controller. Valid values are 1 to 8.

WESTELL.COM

Page 2-66

1-800-377-8766



ExamplesThe following serial controller disconnect settings are configured for controller serial 3:

DTR signal state on Disconnect mode dcd RTS signal state on

rts Configures the state of an RTS output signal when a serial controller disconnects. RTS may be used as part of the connect and disconnect handshake or for hardware flow control. The following parameters are accepted: on—Sets the RTS signal state to on when the serial controller

disconnects. off—Sets the RTS signal state to off when the serial controller

disconnects. pulse—Causes the RTS signal to change state to the opposite of the

connect RTS state for 1 second, then return to the connect RTS state. The connect RTS state is configured with command config controller serial on page 2-47.

By default, the RTS signal state is set to off.


(Dub)>config(Dub) config>controller serial 3(Dub) config controller serial 3>disconnect(Dub) config controller serial 3 disconnect

->dtr on(Dub) config controller serial 3 disconnect->mode dcd(Dub) config controller serial 3 disconnect->rts on(Dub) config controller serial 3 disconnect->

WESTELL.COM

1-800-377-8766

Page 2-67


config controller serial encapsulation

DescriptionThese commands configure the encapsulation protocol for a serial controller. The encapsulation protocol is the mechanism for framing data across a serial port. The available encapsulation formats for Remote RMX-3200 are HDLC and PPP.

Notes: Asynchronous and wireless serial ports do not support HDLC encapsulation.

Asynchronous PPP encapsulation only works if the asynchronous port is cabled directly to a modem.

LTE modems do not support the encapsulation command.

Formats

For asynchronous controllers:config controller serial port encapsulation ppp

default { defaultroute | mru | mtu }defaultrouteinactivity-timeout inactivity-time lcp-requests [ disable | enable ]local identity identity secret local method { chap | pap | none }no { defaultroute | inactivity-timeout | mru | mtu }remote identity identity secret noremote method { chap | pap | none }mru unitsmtu units

For T1/E1 controllers:config controller serial port channel-group group encapsulation hdlc

config controller serial port channel-group group encapsulation ppp

default { defaultroute | mru | mtu }defaultrouteinactivity-timeout inactivity-time lcp-requests [ disable | enable ]local identity identity secret local method { chap | pap | none }no { defaultroute | inactivity-timeout | mru | mtu }remote identity identity secretremote method { chap | pap | none }

WESTELL.COM

Page 2-68

1-800-377-8766


mru unitsmtu units

For wireless modem controllers using an EVDO or HSPA modem:config controller serial wan/1 encapsulation ppp

default { defaultroute | mru | mtu }defaultrouteinactivity-timeout inactivity-time lcp-requests [ disable | enable ]local identity identity secret local method { chap | pap | none }no { defaultroute | inactivity-timeout | mru | mtu }remote identity identity secretremote method { chap | pap | none }mru unitsmtu units

For resetting encapsulation:config controller serial port default encapsulation

config controller serial port channel-group group default encapsulation

Parameters

channel-group

Specifies a serial port channel group. For information about configuring a range of channels, refer to config controller serial channel-group group on page 2-59.

default Resets the encapsulation protocol to the default value.

defaultroute Configures a default route that uses the same subnet as the corresponding interface. For example, if a T1 port goes down and an asynchronous serial port takes over the connection, the route will automatically default to the asynchronous serial port’s subnet value.

Important: An interface must be configured that corresponds to the specified controller for this command to operate properly.


WESTELL.COM

1-800-377-8766

Page 2-69


hdlc Specifies that HDLC will be used as the link-level encapsulation protocol to facilitate point-to-point transmission of data packets.

Note: HDLC encapsulation cannot be selected for

asynchronous serial ports.

identity Configures the identity and secret, which are similar to a user name and password, for CHAP and PAP authentication on a serial controller. The local identity and password are supplied by the local site and sent to a remote device. The following parameters are accepted: identity—Defines either the name of the peer (remote)

device that will be authenticated locally, or the name of the local Remote RMX-3200 card that will be sent and authenticated by the remote peer.

secret—Defines the password of the peer (remote) device that will be authenticated locally, or the password of the local Remote RMX-3200 card that will be sent and authenticated by the remote peer.

inactivity-timeout

Configures the frequency (in minutes) that received packet (Rx) statistics will be checked on a link in the event that a wireless service provider does not provide lcp-requests (keep-alives) in their network, or imposes time limitations on the network connections. The valid values are 0 to 30.For example, if you configure the inactivity-timeout for 5 minutes, the Rx statistics will be checked every 5 minutes; if there is any traffic, Remote RMX-3200 will maintain the connection. If the PPP is terminated, then the Rx statistics will stop incrementing, resulting in no change the next time the statistics are checked. Remote RMX-3200 will then restart the PPP connection. inactivity-time—Defines the inactivity time in minutes.

lcp-requests Configures Remote RMX-3200’s ability to initiate or terminate a PPP link based on the presence of LCP echo requests. The following parameters are accepted: disable—Disables LCP echo requests on the serial

controller. enable—Enables LCP echo requests on the serial controller.This feature is enabled by default.

local Configures the local settings for CHAP and PAP authentication on a serial controller. The local settings are supplied by the local site and sent to a remote device.

WESTELL.COM

Page 2-70

1-800-377-8766


method Configures the method Remote RMX-3200 uses to authenticate a peer device on a serial controller PPP link, or the method used by a peer device to authenticate Remote RMX-3200 for a controller PPP link. The two available methods are challenge handshake authentication protocol (CHAP) and password authentication protocol (PAP). The following parameters are accepted: chap—Specifies the CHAP authentication method. CHAP is

an access control protocol that uses encryption to avoid revealing passwords.

pap—Specifies the PAP authentication method. PAP transmits unencrypted passwords. For this reason, it is less secure than CHAP.

none—Specifies that no PPP authentication will be performed.

mru Configures the maximum number of databytes that can be received in a single PPP frame on a serial port. The following parameter is accepted:

units—Defines the maximum number of bytes that can be received in a single encapsulation packet. Valid range is 128 to 10000.

mtu Configures the maximum number of data bytes that can be transmitted in a single PPP frame on a WAN port. The following parameter is accepted:

units—Defines the maximum number of bytes that can be transmitted in a single encapsulation packet. Valid range is 128 to 10000.


port Defines the physical connector associated with a controller on Remote RMX-3200. Valid asynchronous port values are 1 to 8 and wan/1. For information about valid T1/E1 port values, refer to Appendix : .

ppp Specifies that PPP will be used as the link-level encapsulation protocol to facilitate point-to-point transmission of data packets.

remote Configures the remote settings for CHAP and PAP authentication on a serial controller. The remote settings are supplied by the peer device and sent to Remote RMX-3200.

wan/1 Specifies the serial port that is permanently connected to the internal modem on a RMX-WWAN expansion card.

WESTELL.COM

1-800-377-8766

Page 2-71



ExamplesThis example displays the configuration of hdlc encapsulation for channel group group on WAN controller serial wan/1.

The following PPP encapsulation settings are configured for controller serial 4:

Defaultroute functionality enabled Identity userb and secret newpass Local authentication method pap 5200 for the MRU 4500 for the MTU Remote identity user2 and secret remuse Remote authentication method chap.

See Also

(Dub)>config(Dub) config>controller serial wan/1(Dub) config controller serial wan/1>channel-group group(Dub) config controller serial wan/1 channel-group group->encapsulation hdlc(Dub) config controller serial wan/1 channel-group group->

(Dub)>config(Dub) config>controller serial 4(Dub) config controller serial 4>encapsulation ppp(Dub) config controller serial 4 encapsulation ppp->defaultroute(Dub) config controller serial 4 encapsulation ppp->local(Dub) config controller serial 4 encapsulation ppp local->identity userb newpass(Dub) config controller serial 4 encapsulation ppp local->method pap(Dub) config controller serial 4 encapsulation ppp local->exit(Dub) config controller serial 4 encapsulation ppp->mru 5200(Dub) config controller serial 4 encapsulation ppp->mtu 4500(Dub) config controller serial 4 encapsulation ppp->remote(Dub) config controller serial 4 encapsulation ppp remote->identity user2 remuse(Dub) config controller serial 4 encapsulation ppp remote->method chap(Dub) config controller serial 4 encapsulation ppp remote->

WESTELL.COM

Page 2-72

1-800-377-8766


show controllers

WESTELL.COM

1-800-377-8766

Page 2-73

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config correlation

config correlation

DescriptionThis command manages mediation event correlations. A correlation is a type of event originator that reports a correlated condition to a network management system.

Formatsconfig correlation namedefault durationdescription textduration default true_duration false_durationexpression term operator termno { correlation_name | * }

For deleting a correlation:config no correlation { name | * }

Parameters

* Deletes all configured events.

name Defines the name of the event correlation being configured. Maximum length is 128 characters.

default Resets the true and false duration parameters to their default values (0 and 0).

description Configures a description for a correlation. The following parameter is accepted:

text—Defines the textual description of the configured event correlation.

duration Defines the duration a correlation expression must remain in the true or false state before the correlation itself matches the expression’s state. The following parameters are accepted:

true_duration—Defines the number of seconds the expression must remain true. Valid value range is 0-86400.false_duration—Defines the number of seconds the expression must remain false. Valid value range is 0-86400.default—Resets the true and false duration parameters to their default values (0 0).

WESTELL.COM

Page 2-74

1-800-377-8766


Command DefaultsNo correlations configured.


expression Configures a boolean correlation expression, which evaluates the states of other correlation originators to derive an aggregate true or false state. A correlation expression consists of the following parameters: term—A term collectively consists of the following parameters:

originator_type—One of the Remote RMX-3200 originator types (analog, input, output, correlation, measurement)

instance—A valid instance of the specified originator, for example, 0/1, 2, or the name of a measurement.

state—A valid state for the originator, for example close, open, true, false, as well as in-band, high, low, input-saturated and loss-of-signal.

When a relational operator is used, a numeric value can serve as a term; for example, battVoltage < 10.2.

operator—Specifies a link between two terms, for example and, all, any, not, or. For a measurement, six standard relational operators are supported: less than (<), less than or equal to (<=), equal to (=), greater than (>), greater than or equal to (>=) and not equal to (!=).

Note: The = and != operators can result in incorrect evaluations.

It is recommended to use >, >=, < or <=.

See the Remote RMX-3200 Configuration Guide for more information about configuring event correlations.

no Initiates the deletion of a correlation or all correlations.

WESTELL.COM

1-800-377-8766

Page 2-75


ExamplesThis example configures a correlation named BothClosed with the following parameters:

Description Correlation for two discrete inputs

Duration of 900 seconds (15 minutes) true and 0 seconds (immediate) false.

Expression input 0/1 close and input 0/2 close

This example configures a correlation named LowVoltage with the following parameters:

Description Correlation for low battery voltage

Duration of 300 seconds (5 minutes) true and 0 seconds (immediate) false.

Expression measurement battVoltage < 10.2

See Alsoconfig action

config alarm-entry

config response

show correlations

(Dub)>config(Dub) config>correlation BothClosed(Dub) config correlation BothClosed>description Correlation for two discrete inputs(Dub) config correlation BothClosed>duration 900 0(Dub) config correlation BothClosed>expression input 0/1 close and input 0/2 close

(Dub)>config(Dub) config>correlation LowVoltage(Dub) config correlation LowVoltage>description Correlation for low battery voltage(Dub) config correlation LowVoltage>duration 300 0(Dublin-TC) config correlation LowVoltage>expression measurement battVoltage < 10.2

WESTELL.COM

Page 2-76

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config dhcp-relay

config dhcp-relay

DescriptionThis command configures BOOTP/DHCP relay on Remote RMX-3200. When BOOTP/DHCP relay is enabled, Remote RMX-3200 acts as a BOOTP/DHCP relay agent, passing BOOTP/DHCP configuration information between BOOTP/DHCP clients and servers.

Formatsconfig dhcp-relay [ disable | enable | server ip_address ]

config dhcp-relay no server { ip_address | * }

Parameters


disable Disables BOOTP/DHCP relay on Remote RMX-3200. When BOOTP/DHCP relay is disabled, Remote RMX-3200 does not act as a BOOTP/DHCP relay agent, therefore, it does not pass BOOTP/DHCP configuration information between BOOTP/DHCP clients and servers. This is the default value.

enable Enables BOOTP/DHCP relay on Remote RMX-3200. When BOOTP/DHCP relay is enabled, Remote RMX-3200 acts as a BOOTP/DHCP relay agent, passing BOOTP/DHCP configuration information between BOOTP/DHCP clients and servers.

server Configures the BOOTP/DHCP server(s) to which Remote RMX-3200 forwards BOOTP and DHCP packets when BOOTP/DHCP relay is enabled. A maximum of three BOOTP/DHCP server(s) can be configured.

ip_address Defines the IP address of the BOOTP/DHCP server being added or deleted.

no Initiates the deletion of a BOOTP/DHCP server or all BOOTP/DHCP servers.

* Deletes all BOOTP/DHCP servers.

WESTELL.COM

1-800-377-8766

Page 2-77

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config dhcp-relay

ExamplesThis example displays the enabling of BOOTP/DHCP relay and the configuration of a BOOTP/DHCP server with IP address 12.67.34.5.

See Alsoshow dhcp-relay

(Dub)>config(Dub) config>dhcp-relay(Dub) config dhcp-relay>enable(Dub) config dhcp-relay>server 12.67.34.5(Dub) config dhcp-relay>

WESTELL.COM

Page 2-78

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config dhcp-server

config dhcp-server

DescriptionThis command configures the DHCP server and its associated settings.

Formatsconfig dhcp-server

authoritybroadcastconfig-file filenamedisableenableno { authority | broadcast | config-file }

Parameters

authority Configures the DHCP server to respond to misconfigured DHCP clients with DHCP negative acknowledgement (DHCPNAK) messages. If this option is not configured, a client must wait until the old IP address lease has expired before obtaining correct IP address information after moving to a new subnetwork. By default, DHCPNAK messages are not sent.

broadcast Configures the DHCP server to send DHCP request responses as broadcast packets instead of unicast packets. By default, DHCP request responses are sent as unicast packets.

WESTELL.COM

1-800-377-8766

Page 2-79



config-file

Configures the name of a file that contains DHCP server configuration information for Remote RMX-3200. If a file name is configured, Remote RMX-3200 obtains the DHCP server configuration from the file instead of using the configuration that was entered in the CLI. A DHCP server configuration file should be created when the user needs to implement a complex DHCP server configuration. The following parameter is accepted:

filename—Defines the name of the DHCP server configuration file. Enter the name of an existing DHCP server configuration file located in the /config/dhcp directory on Remote RMX-3200. File names are case-sensitive.

Notes: Before configuring the DHCP server configuration file

name, the user must FTP the file to the /config/dhcp directory on Remote RMX-3200.

There can be multiple DHCP server configuration files in the /config/dhcp directory, but only one file name can be active at a time.

For more information on creating a DHCP server configuration file, refer to the man page for dhcpd.conf.

disable Disables the DHCP server on Remote RMX-3200. The DHCP server provides automatic IP address and network configurations to remote devices. The DHCP server is disabled by default.

enable Enables the DHCP server on Remote RMX-3200. The DHCP server provides automatic IP address and network configurations to remote devices. The DHCP server is disabled by default.

no Deletes or disables a parameter.

WESTELL.COM

Page 2-80

1-800-377-8766


ExamplesThe following settings are configured for the DHCP server:

DHCP server enabled DHCPNAK messages enabled Broadcast packets enabled DHCP server configuration file name dhcpconfig1.conf.

config dhcp-server host

DescriptionThis command configures hosts that will accept fixed (static) IP addresses from the DHCP server.

Formatsconfig dhcp-server host hostname

hardware-address mac_addressip address ip_addressno { hardware-address | ip address }

For deleting a host:config dhcp-server no host hostname

Parameters

(Dub)>config(Dub) config>dhcp-server(Dub) config dhcp-server>enable(Dub) config dhcp-server>authority(Dub) config dhcp-server>broadcast(Dub) config dhcp-server>config-file dhcpconfig1.conf(Dub) config dhcp-server>

hostname Defines the name of the host.

Note: A hostname can consist of alphanumeric characters

or dashes (-); however, the first character cannot be a dash. The maximum length for a hostname is 30 characters.

WESTELL.COM

1-800-377-8766

Page 2-81



ExamplesThe following settings are configured for DHCP server host priv-lan:

Hardware address 00:40:72:00:99:2a IP address 10.39.59.33.

hardware-address

Configures the hardware address for a host that will be assigned a fixed (static) IP addresses by the DHCP server. A hardware address is a data-link layer address associated with a particular network device. It is entered in hexadecimal form. The following parameter is accepted:

mac_address—Defines the hardware (MAC) address value for the host. Enter MAC addresses as 6-byte, hexadecimal formatted values with a colon separating each byte (for example, 00:e0:52:cc:0b:00).

ip address Configures a fixed (static) IP address for a host. The DHCP server will assign this IP address to the host whenever it receives a DHCP request from the host.

Note: The host IP address must be within one of the

subnetworks being served by the DHCP server. For more information, refer to command config dhcp-server subnet on page 2-84.

The following parameter is accepted:ip_address—Defines the IP address for the host.


(Dub)>config(Dub) config>dhcp-server(Dub) config dhcp-server>host priv-lan(Dub) config dhcp-server host priv-lan->hardware-address 00:40:72:00:99:2a(Dub) config dhcp-server host priv-lan->ip address 10.39.59.33(Dub) config dhcp-server host priv-lan->

WESTELL.COM

Page 2-82

1-800-377-8766


config dhcp-server interface

DescriptionThis command configures DHCP server operation on an interface.

Formatsconfig dhcp-server interface

bridge switchethernet ethernet_portopenvpn nameserial { async_port | wan_port channel-group group }

For deleting DHCP server operation from interfaces:config dhcp-server no interface

bridge switchethernet ethernet_portopenvpn nameserial { async_port | wan_port | wan/1 }

Parameters

bridge Specifies the bridge interface for DHCP server operation. The following parameter is accepted:

switch—Specifies the only valid bridge name.

ethernet Specifies an Ethernet interface for DHCP server operation.

Note: When entering this command, ethernet port can be

substituted with the system name for the Ethernet interface. For example, config dhcp-server interface mii1 can be entered instead of config dhcp-server interface ethernet 2.

The following parameter is accepted:ethernet_port—Defines the physical connector associated with an interface on Remote RMX-3200. Valid values are 1 to 8.

no Deletes DHCP server operation from an interface.

openvpn Specifies an OpenVPN interface for DHCP server operation. The following parameter is accepted:

name—Defines the name of the OpenVPN interface.

WESTELL.COM

1-800-377-8766

Page 2-83



ExamplesThe following settings are configured for the DHCP server:

DHCP server operation on interface ethernet 3 DHCP server operation on interface serial 6 DHCP server operation on interface openvpn cmhclient1 DHCP server operation on interface bridge switch.

config dhcp-server subnet

DescriptionThis command configures the subnetworks that will be served by the DHCP server. When a subnetwork is served by the DHCP server, devices on that subnetwork can access and obtain IP address and network configurations from the server. The user should configure a subnetwork for each Remote RMX-3200 interface on which the DHCP server is operating.

Note: To avoid errors, you should disable HTTP before configuring the DHCP server.

For more information on disabling HTTP, refer to command config remote-access on page 2-217.

serial Specifies a serial interface for DHCP server operation. The following parameters are accepted: async_port—Defines the asynchronous physical connector

associated with the interface on Remote RMX-3200. Valid values are 1 to 8.

wan_port—Defines the WAN physical connector associated with the interface on Remote RMX-3200. For information about valid serial WAN port values, refer to Appendix : .

channel-group—Specifies a serial port channel group. group—Specifies the only configurable serial port channel group

on Remote RMX-3200.

(Dub)>config(Dub) config>dhcp-server(Dub) config dhcp-server>interface ethernet 3(Dub) config dhcp-server>interface serial 6(Dub) config dhcp-server>interface openvpn cmhclient1(Dub) config dhcp-server>interface bridge switch(Dub) config dhcp-server>

WESTELL.COM

Page 2-84

1-800-377-8766


Formatsconfig dhcp-server subnet { ip_address subnet_mask | ip_address/subnet_mask_length }

default { default-lease | max-lease }default-lease secondsdomain-name-server ip_addressmax-lease secondsno { domain-name-server ip_address | range | router }range minimum_ip_address maximum_ip_addressrouter router_ip_address ]

For deleting subnets:config dhcp-server no subnet ip_address

Parameters

ip_address Defines the IP address for the subnetwork. The subnetwork IP address is the network address for the Remote RMX-3200 interface on which the DHCP server is operating.

subnet_mask Defines the subnet mask for the subnetwork in dotted decimal format.

subnet_mask_length Defines the subnet mask length for the subnetwork. Valid values are 1 to 32.


default-lease Configures the default lease time for a subnetwork being served by the DHCP server. The lease time is the amount of time, in seconds, a device can use an IP address assigned by the DHCP server. The default lease time is assigned to a device when no other lease time is specified. The following parameter is accepted:

seconds—Defines the default lease time for the subnetwork. Valid values are 1 to 31,536,000.

domain-name-server Configures one or more DNS servers for a subnetwork being served by the DHCP server. A DNS server translates domain names into corresponding IP addresses. The following parameter is accepted:

ip_address—Defines the IP address for the subnetwork. The subnetwork IP address is the network address for the Remote RMX-3200 interface on which the DHCP server is operating.

WESTELL.COM

1-800-377-8766

Page 2-85


Command DefaultsNo subnetworks configured


ExamplesThe following settings are configured for the DHCP server subnet 10.39.59.0/24:

Default lease time of 1800 seconds DNS server with IP address 10.39.59.1 Maximum lease time of 36000 seconds Minimum IP address 10.39.59.0 Maximum IP address 10.39.59.31 A router with IP address 10.39.59.1

max-lease Configures the maximum lease time for a subnetwork being served by the DHCP server. The maximum lease time is the maximum amount of time, in seconds, a device can use an IP address assigned by the DHCP server. The following parameter is accepted:

seconds—Defines the maximum lease time for the subnetwork. Valid values are 1 to 31,536,000.


range Configures the range of IP addresses that the DHCP server can assign to devices. The user can configure one IP address range for each subnetwork being served by the DHCP server. The following parameters are accepted: minimum_ip_address—Defines the lowest IP address

that the DHCP server can assign to a device. maximum_ip_address—Defines the highest IP

address that the DHCP server can assign to a device.

Note: DHCP does not accept network or broadcast

addresses as part of range.

router Configures a router for a subnetwork being served by the DHCP server. A router is used as the gateway for all IP traffic on the subnetwork. The following parameter is accepted:

ip_address—Defines the IP address of the router.

WESTELL.COM

Page 2-86

1-800-377-8766


See Alsoconfig dhcp-server


show dhcp-server

(Dub)>config(Dub) config>dhcp-server(Dub) config dhcp-server>subnet 10.39.59.0/24(Dub) config dhcp-server subnet 10.39.59.0/24->default-lease 1800(Dub) config dhcp-server subnet 10.39.59.0/24->domain-name-server 10.39.59.1(Dub) config dhcp-server subnet 10.39.59.0/24->max-lease 36000(Dub) config dhcp-server subnet 10.39.59.0/24->range 10.39.59.0 10.39.59.31(Dub) config dhcp-server subnet 10.39.59.0/24->router 10.39.59.1(Dub) config dhcp-server subnet 10.39.59.0/24->

WESTELL.COM

1-800-377-8766

Page 2-87

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config discrete analog

config discrete analog

DescriptionThis command configures the settings for a discrete analog input.

Formatsconfig discrete analog { unit/point | unit/point_range | unit/power | unit/powerB | unit/temperature | unit/humidity | unit/* | * }

assignaveraging [ high | medium | low | none ]band low_band high_bandcelsiusdescription [ text ]disableenablefahrenheithysteresis sensor_valueinterval durationmaximum current_loop sensor_readingminimum current_loop sensor_readingunassign

config discrete analog { unit/point | unit/point_range | unit/* | * }

currentunits unit_namevoltage

Parameters

* Specifies all analog inputs for a specified peripheral unit or all analog inputs. Supports assign, averaging, current, disable, enable, unassign and voltage parameters.

assign Specifies that the discrete analog should be tracked as a resource. This lets the user determine discrete analog point availability.

WESTELL.COM

Page 2-88

1-800-377-8766


averaging Specifies the level by which Remote RMX-3200 will average, or smooth, measurement values in order to compensate for rapid fluctuations. Valid values include the following: medium - The typical value used when the unscaled value

fluctuates by +/- .01 V or mA. high - Provides the most averaging, but provides slower

response to value fluctuation. low - Provides faster response to value fluctuation while still

providing a minimal level of averaging. none - No averaging is used.

Note: Averaging is not available for the unit/temperature or

unit/humidity input.

band Configures the high and low values for analog input event generation. Whenever the sensor input falls below the low level, a low event is generated. Whenever the sensor input goes above the high level, a high event is generated. When the input falls below the high level or rises above the low level, an in-band event is generated. The following parameters are accepted: low_band—Defines the low input value in sensor units. Valid

values are numeric characters. The default value is 0. high_band—Defines the high input value in sensor units. Valid

values are numeric characters. The default value is 0.

Note: To disable the generation of level events (all analog events

besides “interval”), set low_band to a higher value than high_band.

celsius Sets the unit/temperature input to report values in degrees Celsius. Celsius is the default setting for all temperature points.

current Sets the analog input mode to current input.

description Configures an analog input description. The following parameter is accepted:

text—Defines a description for the analog input.

disable Disables event generation for analog inputs. Analog inputs are disabled by default.

enable Enables event generation for analog inputs.

fahrenheit Sets the unit/temperature input to report values in degrees Fahrenheit. Celsius is the default setting for all temperature points.

WESTELL.COM

1-800-377-8766

Page 2-89


humidity Specifies the humidity sensor on an RMB peripheral unit, which is an analog input that is dedicated to monitoring the ambient humidity.

hysteresis Configures hysteresis, which works as a guard between the high and low band thresholds. For example, if a high band value is set to 10 and the hysteresis is set to 1, a high event will be generated when the input goes above 10 and an in-band event will be generated when the input goes below 9. The following parameter is accepted:

sensor_value—Defines the size of the hysteresis in sensor units. Valid values are numeric characters. The default hysteresis value is 0.

interval Configures the interval rate at which events are generated for an analog input. The following parameter is accepted:

duration—Defines the time (in seconds) between generated interval events. 0 disables the generation of interval events. The default interval rate is 0.

Note: Command config response content on page 2-222 also

configures the interval rate at which events are generated for an analog input. The most recently executed of these two commands takes precedence.

WESTELL.COM

Page 2-90

1-800-377-8766


maximum Configures the maximum current allowed on a specified analog input and the sensor value associated with that current. If the input is enabled and the current is higher than the highest valid sensor output current, Remote RMX-3200 generates an input_saturated event. The following parameters are accepted: current_loop—Defines the maximum valid sensor output

current (in milliamps). This is the current that will be sensed by the product. The default maximum current is 20 milliamps.

Notes: The maximum and sensor output current can be

configured as any value. However, Remote RMX-3200 only supports between 4 and 20 milliamps.

Setting the maximum sensor output current lower than the minimum configured sensor output current is a valid configuration. Doing this causes the sensor output to have a negative coefficient.

sensor_reading—Defines the sensor input associated with the given sensor output. This parameter is measured in sensor units, such as volts, PSI, or amps.

Note: Setting the maximum sensor input lower than the

minimum configured sensor input is a valid configuration. Doing this causes the sensor input to have a negative coefficient.

WESTELL.COM

1-800-377-8766

Page 2-91


minimum Configures the lowest valid current that will be present on the specified analog input and the sensor value associated with that current. If the input is enabled and a current lower than the lowest valid sensor output current is present, a loss-of-signal event will be generated. The following parameters are accepted:

current_loop—Defines the minimum valid sensor output current (in milliamps). This is the current that will be sensed by the product. The default minimum current is 4 milliamps.

Notes: The minimum sensor output current can be configured

as any value. However, Remote RMX-3200 only supports between 4 and 20 milliamps.

Setting the maximum sensor output current lower than the minimum configured sensor output current is a valid configuration. Doing this causes the sensor output to have a negative coefficient.

sensor_reading—Defines the sensor input associated with the given sensor output. This parameter is measured in sensor units, such as volts, PSI, or amps.

Note: Setting the maximum sensor input lower than the

minimum configured sensor input is a valid configuration. Doing this causes the sensor input to have a negative coefficient.

point Defines the analog input number within the unit. Valid values for on-board analog inputs are 1 to 12. Other values may be available for expansion peripheral units.

point_range Defines a set of analog input numbers within the unit. Valid values for on-board analog inputs are 1 to 12, power, powerB and temperature. Other values may be available for expansion peripheral units. Individual values are separated by commas (,) and hyphens (-). For example, 1,4-6 specifies points 1, 4, 5 and 6.

power Specifies the primary power monitor, which is an analog input that is dedicated to monitoring the unit’s primary incoming power supply voltage.

powerB Specifies the secondary power monitor, which is an analog input that is dedicated to monitoring the unit's secondary incoming power supply voltage.

WESTELL.COM

Page 2-92

1-800-377-8766



ExamplesThe following settings are configured for analog input 0/4:

Description Amp_meter Low band input level 20 and high band input level 30.5 Hysteresis 2 Interval of 10 seconds Maximum input value of 72 volts and corresponding maximum output value of

20 milliamps Minimum input value of 7 volts and corresponding minimum output value of 8

milliamps Averaging level medium Analog input enabled Enabled resource tracking

temperature Specifies the temperature sensor, which is an analog input that is dedicated to monitoring internal chassis temperature. temperature can also specify the temperature sensor on an RMB peripheral unit, which is an analog input that is dedicated to monitoring the ambient temperature.

units Configures unit names for measurements associated with analog inputs. The names are displayed whenever the values of inputs are included in an event. The following parameter is accepted:

unit_name—Specifies a text description for the units. The maximum string length is 32 characters.

voltage This command sets the analog input mode to voltage input.

unassign Specifies that the discrete analog should no longer be tracked as a resource.

unit Defines the peripheral unit number. Valid values are 0 to 12.

Note: 0 represents the on-board discrete I/O subsystem.

WESTELL.COM

1-800-377-8766

Page 2-93


The following settings are configured for analog input 0/3:

Analog input mode voltage Unit Volts

See Alsoconfig discrete analog

config discrete output

show discrete

(Dub)>config(Dub) config>discrete(Dub) config discrete>analog 0/4(Dub) config discrete analog 0/4->description Amp_meter(Dub) config discrete analog 0/4->band 20 30.5(Dub) config discrete analog 0/4->hysteresis 2(Dub) config discrete analog 0/4->interval 10(Dub) config discrete analog 0/4->maximum 20 72(Dub) config discrete analog 0/4->minimum 7 8(Dub) config discrete analog 0/4->averaging medium(Dub) config discrete analog 0/4->enable(Dub) config discrete analog 0/4->assign(Dub) config discrete analog 0/4

(Dub)>config(Dub) config>discrete(Dub) config discrete>analog 0/3(Dub) config discrete analog 0/3->voltage(Dub) config discrete analog 0/3->unit Volts(Dub) config discrete analog 0/3->

WESTELL.COM

Page 2-94

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config discrete input

config discrete input

DescriptionThis command configures settings for digital inputs.

Formatsconfig discrete input { unit/point | unit/point_range | unit/* | * }

alarm-defaultassigndisableenableunassign

config discrete input unit/point description [ text ]

Notes: Entering TAB twice after unit/ does not display point and point range hints.

This functionality is not available because there are too many possible range values that would need to be displayed in the CLI.

Entering ? after unit/ displays this command’s usage statement, not the available points and point ranges.

Parameters

* Specifies all digital inputs for a specified peripheral unit or all digital inputs.

alarm-default

Configures default alarm-table entries for digital inputs.

assign Specifies that the discrete input should be tracked as a resource. This lets the user determine discrete input point availability.

description Configures a description for a digital input. The following parameter is accepted:

text—Defines a description for a digital input. The maximum length is 256 characters.

WESTELL.COM

1-800-377-8766

Page 2-95



disable This command disables event generation for a digital input. Digital inputs are disabled by default.


disables event generation for digital inputs. The most recently executed of these two commands takes precedence.

enable This command enables event generation for a digital input. Digital inputs are disabled by default.


disables event generation for digital inputs. The most recently executed of these two commands takes precedence.

point Defines the digital input number within the unit. Valid values for on-board digital inputs are 1 to 64. Other values may be available for expansion peripheral units.

point_range Defines a set of digital input numbers within the unit. Valid values for on-board digital inputs are 1 to 64. Other values may be available for expansion peripheral units. Individual values are separated by commas (,) and hyphens (-). For example, 1,4-6 specifies points 1, 4, 5 and 6.

unassign Specifies that the discrete input should no longer be tracked as a resource.



WESTELL.COM

Page 2-96

1-800-377-8766


ExamplesThe following settings are configured for digital input 0/16:

Default alarm-table entry configured Input enabled Description Alarm 16 Enabled resource tracking.



show discrete

(Dub)>config(Dub) config>discrete(Dub) config discrete>input 0/16(Dub) config discrete input 0/16->alarm-default(Dub) config discrete input 0/16->enable(Dub) config discrete input 0/16->description Alarm 16(Dub) config discrete input 0/16->assign(Dub) config discrete input 0/16

WESTELL.COM

1-800-377-8766

Page 2-97

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config discrete output


DescriptionThis command configures a digital output.

Formatsconfig discrete output unit/point

assigndescription [ text ]unassign

Parameters


assign Specifies that the discrete output should be tracked as a resource. This lets the user determine discrete output point availability.

description Configures a description for a digital output. The following parameter is accepted:

text—Defines a text description for a digital output. The maximum length is 256 characters.

point Defines the digital output number within the unit. Valid values for on-board digital outputs are 1 to 4. Other values may be available for expansion peripheral units.

unassign Specifies that the discrete output should no longer be tracked as a resource.



WESTELL.COM

Page 2-98

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config discrete output

ExamplesThe following settings are configured for discrete output 0/1:

Description Critical alarm output Enabled resource tracking


config discrete inputt

show discrete

(Dub)>config(Dub) config>discrete(Dub) config discrete>output 0/1(Dub) config discrete output 0/1->description Critical alarm output(Dub) config discrete output 0/1->assign(Dub) config discrete output 0/1->

WESTELL.COM

1-800-377-8766

Page 2-99

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config event

config event

DescriptionThis command configures or deletes an event. An event is an expression that defines a system occurrence in terms of an event originator and an event type. For more information on event originators and event types, refer to command config event content on page 2-102.

Formatsconfig event event_name


For deleting an event:config no event { event_name | * }

Parameters

Command DefaultsNo events configured


* Deletes all configured events.

description Configures a description for an event. The following parameter is accepted:

text—Defines the description for the configured event.

event_name Defines the name of the event being configured. Maximum length is 128 characters.

Note: This event name is the same as the event name used for the

corresponding config action command.

no Initiates the deletion of an event or all events.

WESTELL.COM

Page 2-100

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config event

ExamplesThis example displays the configuration of description Door open event for event doorOpen.



config response

show actions

show events

show responses

(Dub)>config(Dub) config>event doorOpen(Dub) config event doorOpen>description Door open event(Dub) config event doorOpen>

WESTELL.COM

1-800-377-8766

Page 2-101

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config event content


DescriptionThis command configures an event with an associated event originator and event type.

Formatsconfig event event_name content event_originator event_type

Parameters

event_name Defines the name of the event being configured. Maximum length is 128 characters.

event_originator Defines the event originator, which is the system component that generates an event. For more information on event originators, refer to Table 2 on page 2-103.

event_type Defines the type of generated event. For more information on event types, refer to Table 3 on page 2-111.

WESTELL.COM

Page 2-102

1-800-377-8766


Table 2 Valid Event Originators

Event Originator Description

analog instance Specifies an analog input as the event originator. Valid value for instance is:

unit/{ point | power | powerB | temperature } unit

Defines the peripheral unit number. Valid values are 0 to 12.

pointDefines the analog input point number within the unit. Valid values for on-board analog inputs are 1 to 12. Other values may be available for expansion peripheral units.

powerSpecifies the power monitor, which is an analog input that is dedicated to monitoring the unit’s incoming power supply voltage.

powerBSpecifies the secondary power monitor, which is an analog input that is dedicated to monitoring the unit's secondary incoming power supply voltage.

temperatureSpecifies the temperature sensor, which is an analog input that is dedicated to monitoring internal chassis temperature. Can also specify the temperature sensor on an RMB peripheral unit, which is an analog input that is dedicated to monitoring the ambient temperature.

humiditySpecifies the humidity sensor on an RMB peripheral unit, which is an analog input that is dedicated to monitoring the ambient humidity.

The following event types are valid for this originator: high in-band input-saturated interval loss-of-signal low offline signal-good

WESTELL.COM

1-800-377-8766

Page 2-103


bridge instance Specifies a bridge group controller as the event originator. Valid value for instance is:

switchBridge group switch is the only bridge group that can be configured for Remote RMX-3200.

The following event types are valid for this originator: down up

control control name

Specifies a control as the event originator. The control names are defined by the applications.

correlation instance

Specifies a correlation as the event originator. Valid value for instance is:

nameDefines the name of the correlation. Maximum length is 128 characters.

The following event types are valid for this originator: false true unknown

ethernet instance Specifies an Ethernet controller as the event originator. Valid value for instance is:

portDefines the physical connector associated with a controller on Remote RMX-3200. Valid Ethernet port values are 1 to 8. For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

The following event types are valid for this originator: down mac-violation up

Table 2 Valid Event Originators (Continued)

Event Originator Description (Continued)

WESTELL.COM

Page 2-104

1-800-377-8766


input instance Specifies a digital input as the event originator. Valid values for instance are:

unit/point unit


pointDefines the digital input point number for the unit. Valid values for on-board digital inputs are 1 to 64. Other values may be available for expansion peripheral units.

The following event types are valid for this originator: close offline open

measurement instance

Specifies a measurement as the event originator. Valid value for instance is:

nameIdentifies the measurement name. Valid values are alphanumeric characters and underscores.

The following event types are valid for this originator: high in-band input-saturated loss-of-signal low offline signal-good

openvpn instance Configures an event that is generated by an OpenVPN controller. Valid value for instance is:

nameIdentifies the OpenVPN controller name.




WESTELL.COM

1-800-377-8766

Page 2-105


output instance Specifies a digital output as the event originator. Valid value for instance is:

unit/point unit


pointDefines the digital output number within the unit. Valid values for on-board digital outputs are 1 to 4. Other values may be available for expansion peripheral units.

The following event types are valid for this originator: close offline open

peripheral instance

Specifies an expansion peripheral unit (including Expand D, RME-S8, RME-E8 and RME-B64) as the event originator. Valid value for instance is:

unitDefines the peripheral unit number. Valid values are 1 to 12.

The following event types are valid for this originator: offline online



WESTELL.COM

Page 2-106

1-800-377-8766


serial instance Specifies a serial controller as the event originator. Valid values for instance are: port

Defines the physical connector associated with the controller on Remote RMX-3200. Valid asynchronous port values are 1 to 8 for Remote RMX-3200. Other values may be available for expansion peripheral units. For information about valid WAN port values, refer to Appendix : .

unit/portDefines the peripheral unit number and the serial port number within the unit. Valid unit values are 1 to 12. Valid port values are 1 to 8.

The following event types are valid for this originator: conn-cancelled conn-down conn-failed conn-inactivity conn-timeout conn-up data-rcvd down up

serial instancechannel-group group

Specifies a channel group on a serial WAN controller as the event originator. Valid value for instance is:

portDefines the physical connector associated with the controller on Remote RMX-3200. For information about valid WAN port values, refer to Appendix : .


serial wan/1serial wan/2

Specifies the T1/E1 port or ports, or the port that is permanently connected to the internal modem on a Remote RMX-WWAN expansion card.The following event types are valid for this originator: down up



WESTELL.COM

1-800-377-8766

Page 2-107


snmp Specifies the Remote RMX-3200 SNMP agent as the event originator. Event type manager-set is valid for this originator.

snmpne instance Specifies the Remote RMX-3200 SNMP network element as the event originator. Valid value for instance is:

nameIdentifies the SNMP network element name. Valid values are alphanumeric characters.

snmpne instance point instance

Specifies the Remote RMX-3200 SNMP network element and associated point as the event originator. Valid values are: snmpne name

Identifies the SNMP network element name. Valid values are alphanumeric characters.

point nameIdentifies the associated point name for the SNMP NE.

ssh instance Specifies a SSH connection as the event originator. Valid values for instance are:

[ ip_address: ] portDefines the optional IP address and port number for the SSH connection. Valid values for port are 1000 to 65535. If present, ip_address should be an IP address assigned to Remote RMX-3200.

The following event types are valid for this originator: auth-success conn-cancelled conn-down conn-failed conn-inactivity conn-timeout conn-up incoming-connection

status-point Specifies an event originated by a status point within a network element.



WESTELL.COM

Page 2-108

1-800-377-8766


system Specifies the system as a whole (not one particular subsystem) as the event originator.The following event types are valid for this originator: fan-good fan-fail init power-fail-24 power-fail-connector power-good-1.8 power-good-5 power-good-24 power-good-connector

tbos-alarm instance

Specifies a TBOS alarm as the event originator. Valid value for instance is:

serial port display point serial

Specifies port type serial. port

Defines the physical connector associated with the controller on Remote RMX-3200. Valid values are 1 to 8 for Remote RMX-3200. Other values may be available for expansion peripheral units.

displayDefines the TBOS alarm display number. Valid values are 1 to 8.

pointDefines a TBOS alarm display point number. Valid values are 1 to 64.

The following event types are valid for this originator: close open



WESTELL.COM

1-800-377-8766

Page 2-109


tcp instance Specifies a TCP connection as the event originator. Valid value for instance is:

[ ip_address: ] portDefines the optional IP address and port number for the TCP connection. Valid values for port are 1000 to 65535. If present, ip_address should be an IP address assigned to Remote RMX-3200.

The following event types are valid for this originator: conn-cancelled conn-down conn-failed conn-inactivity conn-timeout conn-up incoming-connection

telnet instance Specifies a Telnet connection as the event originator. Valid value for instance is:

[ ip_address: ] portDefines the optional IP address and port number for the Telnet connection. Valid values for port are 1000 to 65535. If present, ip_address should be an IP address assigned to Remote RMX-3200.

The following event types are valid for this originator: conn-cancelled conn-down conn-failed conn-inactivity conn-timeout conn-up incoming-connection

timer instance Specifies a system timer as the event originator. Valid value for instance is:

timer_nameDefines the unique name of the timer.

The following event type is valid for this originator:timer-expire



WESTELL.COM

Page 2-110

1-800-377-8766


tl1mux instance Specifies a TL1 multiplexer as the event originator. Valid value for instance is:

mux_idDefines the identifier for the TL1 multiplexer. Valid values are 1 to 4.

The following event types are valid for this originator: conn-cancelled conn-down conn-failed conn-timeout conn-up

tl1ne instance Specifies a virtual TL1 NE as the event originator. Valid value for instance is:

ne_idDefines the ID of the virtual TL1 NE. Valid values are 1 to 20.

The following event type is valid for this originator:tl1cmd-rcvd

Table 3 Valid Event Types

Event Type Description

auth-success Specifies that a connection was successfully authenticated.

close Specifies that a digital input or output has changed from having no current flow to having current flow.

conn-cancelled Specifies that a connection has been cancelled, which means that the connection originator has terminated the connection. If this event occurs, a conn-down event will also be generated.

conn-down Specifies that a connection has gone down.

conn-failed Specifies that a connection has failed to establish an initial connection.



WESTELL.COM

1-800-377-8766

Page 2-111


conn-inactivity Specifies that an inactivity timer has expired on a mediation connection originated by an asynchronous serial controller.

conn-timeout Specifies that a connection attempt has timed-out without establishing a connection. If this event occurs, a conn-failed event will also be generated.

conn-up Specifies that a connection has been successfully established.

data-rcvd Specifies that data was received while an asynchronous serial controller was up (had an active async connection), but had no active mediation connection.

down Specifies that a system component has gone down.

false Specifies that a logical expression has evaluated to false.

fan-good Specifies that the Remote RMX-3200 cooling fan is functional.

fan-fail Specifies that the Remote RMX-3200 cooling fan has failed to function.

high Specifies that an analog input has exceeded the high band threshold.

in-band Specifies that an analog input has passed above a low band threshold or below a high band threshold.

incoming-connection Specifies that an incoming TCP connection request was received.

init Specifies that Remote RMX-3200 has completed all its initialization tasks.

input-saturated Specifies that an analog input has gone above the maximum configured value. This state is indicative of either a serious problem with or faulty configuration of the sensor.

interval Specifies that a periodic sampling interval has expired.

Table 3 Valid Event Types (Continued)

Event Type Description (Continued)

WESTELL.COM

Page 2-112

1-800-377-8766


loss-of-signal Specifies that an analog input has gone below a minimum configured value. This state is indicative of either a serious problem with the sensor or the faulty configuration.

low Specifies that an analog input has passed below a low band threshold.

mac-violation Specifies that an Ethernet controller has received a MAC security violation.

manager-set Specifies that an SNMP set of MIB object aiMediationEvent was received by Remote RMX-3200's SNMP agent. The format for this event type looks like this:

manager-set set_name

Parameter set_name defines the name used within the set event.

Note: The OID for the aiMediationEvent MIB object is

.1.3.6.1.4.1.539.42.1.0.

offline Specifies that an expansion peripheral unit has gone offline.

online Specifies that an expansion peripheral unit has come online.

open Specifies that a digital input or output has gone from having current flow to having no current flow.

power-fail-24 Specifies that the Remote RMX-3200 24-Volt power supply has failed.

power-fail-connector

Specifies that voltage for a connector is no longer present. This usually occurs when the wetting voltage on the external connectors has shorted out.

power-good-1.8 Specifies that the Remote RMX-3200 1.8-Volt power supply is operating properly.

power-good-5 Specifies that the Remote RMX-3200 5-Volt power supply is operating properly.



WESTELL.COM

1-800-377-8766

Page 2-113



ExamplesThis example displays the configuration of interval event analogInterval for analog 0/5.

power-good-24 Specifies that the Remote RMX-3200 24-Volt power supply is operating properly.

power-good-connector

Specifies that the connector wetting voltage is present.

signal-good Specifies that an analog input signal is between minimum and maximum configured sensor readings. This event’s primary purpose is to clear alarms that go off when the analog input signal goes outside minimum and maximum boundaries.

timer-expire Specifies that a mediation timer has expired.

tl1cmd-rcvd Specifies that a TL1 command matching a configured pattern has been received by an Remote RMX-3200 virtual TL1 NE. The format for this event type looks like this:

tl1cmd-rcvd command_name

Parameter command_name defines the TL1 command pattern used to match incoming TL1 commands.

Note: The command pattern should be a valid TL1

command code (for example, opr-ext-cont). Common TL1 command codes are documented in Telcordia GR 833-CORE.

true Specifies that a logical expression has evaluated to true.

unknown Specifies that a logical expression cannot be evaluated as true or false; for example, if a peripheral device is offline and is no longer reporting to Remote RMX-3200.

up Specifies that a system component has come up.



WESTELL.COM

Page 2-114

1-800-377-8766


(Dub)>config(Dub) config>event analogInterval(Dub) config event analogInterval>content(Dub) config event analogInterval content->analog 0/5(Dub) config event analogInterval content analog 0/5->interval(Dub) config event analogInterval content analog 0/5->

WESTELL.COM

1-800-377-8766

Page 2-115


This example displays the configuration of up event chanGroupUp for channel group group on controller serial wan/1.


config event

show correlations

show events

(Dub)>config(Dub) config>event chanGroupUp(Dub) config event chanGroupUp>content(Dub) config event chanGroupUp content->serial wan/1(Dub) config event chanGroupUp content serial wan/1->channel-group group(Dub) config event chanGroupUp content serial wan/1 channel-group group->up(Dub) config event chanGroupUp content serial wan/1 channel-group group->

WESTELL.COM

Page 2-116

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config hostname

config hostname

DescriptionThis command configures a hostname for Remote RMX-3200.

Formatsconfig hostname hostname

Parameters

Command DefaultsKentrox


ExamplesThis example displays the configuration of hostname DublinCo for Remote RMX-3200. Notice that the command prompt changes from Dub to DublinCo.

hostname Defines the hostname to assign to Remote RMX-3200. A hostname can consist of alphanumeric characters or hyphens (-); however, the first character cannot be a dash. The maximum length for a hostname is 30 characters.

(Dub)>config(Dub) config>hostname DublinCo(DublinCo) config>

WESTELL.COM

1-800-377-8766

Page 2-117

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config interface bridge switch

config interface bridge switch

DescriptionThis command configures the interface to bridge group switch.

Note: Before a bridge interface can be configured, bridge group switch must be

configured with command config controller bridge switch on page 2-25. The bridge interface is deleted automatically when bridge switch is deleted.

Formatsconfig interface bridge switch

description [ text ]no

Parameters


ExamplesThe following settings are configured for bridge interface switch:

Description Bridge switch interface

See Alsoconfig interface ethernet

config interface serial

diag controller bridge switch dhcp

show interfaces

description Configures the description for bridge interface switch. The following parameter is accepted:

text—Defines the description for bridge interface switch.


(Dub)>config(Dub) config>interface bridge switch(Dub) config interface bridge switch>description Bridge switch interface(Dub) config>interface bridge switch->

WESTELL.COM

Page 2-118

1-800-377-8766


config interface bridge switch ip

DescriptionThis command configures the interface’s IP address to bridge group switch.

Note: Before a bridge interface IP address can be configured, bridge group switch

must be configured with command config controller bridge switch on page 2-25. The bridge interface is deleted automatically when bridge switch is deleted.

Formatsconfig interface bridge switch ip

address { ip_address subnet_mask | ip_address/subnet_mask_length } [ secondary ]

no

Parameters


address Configures an IP address for the bridge switch interface. The following parameters are accepted: ip_address—Defines the IP address for the interface. subnet_mask—Defines the subnet mask for the interface in

dotted decimal format. subnet_mask_length—Defines the length of the subnet

mask. Valid values are 1 to 32. secondary—Designates an IP address as a backup to the

primary IP address.


WESTELL.COM

1-800-377-8766

Page 2-119


ExamplesThe following settings are to configure the IP of a bridge interface switch:

Description Bridge switch interface IP address 12.85.32.4 and subnet mask 255.255.0.0 Secondary IP address 12.85.32.5 and subnet mask 255.255.0.0.

config interface ethernett



show interfaces

config interface bridge switch ip dhcp

DescriptionThis command configures DHCP client support for the interface to bridge group switch.

Note: DHCP client support cannot be enabled on the bridge group switch if a static

IP address has already been configured. You must remove the static IP address before enabling DHCP client support.

Formatsconfig interface bridge switch ip dhcp

disableenableretry-timeout timeoutdefault retry-timeout

For removing DHCP client support and deleting the retry-timeout value:config interface bridge switch ip no dhcp

(Dub)>config(Dub) config>interface bridge switch(Dub) config interface bridge switch>description Bridge switch interface(Dub) config interface bridge switch>ip(Dub) config interface bridge switch ip->address 12.85.32.4 255.255.0.0(Dub) config interface bridge switch ip->address 12.85.32.5 255.255.0.0 secondary(Dub) config interface bridge switch ip->

WESTELL.COM

Page 2-120

1-800-377-8766


Parameters



DHCP client support enabled Retry-timoute value 15 minutes

See Alsoconfig interface ethernett



show interfaces

disable Disables DHCP client support for bridge interface switch. The retry-timeout value is retained, should you decide to re-enable DHCP client support.

enable Enables DHCP client support for bridge interface switch.

retry-timeout

Configures the time to wait between attempts to contact a DHCP server. The following parameter is accepted:

timeout—Defines the time (in minutes) to wait between attempts to contact the DHCP server. The default value is five minutes.

no Disables DHCP client support for bridge interface switch and deletes the retry-timeout value.

(Dub)>config(Dub) config>interface bridge switch(Dub) config interface bridge switch>ip(Dub) config interface bridge switch ip>dhcp(Dub) config interface bridge switch ip dhcp->(Dub) config interface bridge switch ip dhcp->enable

(Dub) config interface bridge switch ip dhcp->retry-timeout 15(Dub) config interface bridge switch ip dhcp->

WESTELL.COM

1-800-377-8766

Page 2-121


config interface bridge switch ipv6

DescriptionThis command configures the interface’s IPv6 address to bridge group switch.

Note: Before a bridge interface IPv6 address can be configured, bridge group

switch must be configured with command config controller bridge switch on page 2-25. The bridge interface is deleted automatically when bridge switch is deleted.

Formatsconfig interface bridge switch ipv6

address ip_address/prefix_lengthdisableenableno

Parameters


address Configures an IP address for the bridge switch interface. The following parameters are accepted: ip_address—Defines the IP address for the interface. prefix_length—Defines the length of the network prefix in

decimal format. Valid values are 1 to 128.

disable Disables the IPv6 protocol.

enable Enables the IPv6 protocol.


WESTELL.COM

Page 2-122

1-800-377-8766



Description Bridge switch interface IPv6 address fd10::39:0:0:100/64

config interface ethernet


show interfaces

(Dub)>config(Dub) config>interface bridge switch(Dub) config interface bridge switch>description Bridge switch interface(Dub) config interface bridge switch>ipv6(Dub) config interface bridge switch ipv6->address fd10::39:0:0:100/64(Dub) config interface bridge switch ipv6->

WESTELL.COM

1-800-377-8766

Page 2-123

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config interface ethernet


DescriptionThese commands configure settings for an Ethernet interface. An interface is a source and sink for IP packets that is associated with a controller.

Formatsconfig interface ethernet { port | wan/port}

description textdisableenableno description

For deleting Ethernet interfaces:config no interface ethernet { port | wan/port | * }

Parameters


Examples

* Specifies all Ethernet interfaces or all interfaces from the Remote RMX-3200 configuration.

port Defines the physical connector associated with an Ethernet interface on Remote RMX-3200. Valid Ethernet port values are 1 to 8. You may also see an Ethernet port 0, which is associated with the expansion slot. If the WGBE card is installed in the expansion slot, ports wan/1 and wan/2 represent WGBE’s 1000baseT ports, while wan/3 and wan/4 represent WGBE’s fiber SFP ports.For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

description Configures a description for an Ethernet interface. The following parameter is accepted:

text—Defines the description for the Ethernet interface.

disable Disables an Ethernet interface.

enable Enables an Ethernet interface.


WESTELL.COM

Page 2-124

1-800-377-8766


The following settings are configured for interface ethernet 2:

Enabled interface ethernet 2 Description Ethernet 2

See Alsoconfig interface bridge switch


show interfaces ethernet

config interface ethernet ip

DescriptionThese commands configure settings for an Ethernet interface IP address.

Formatsconfig interface ethernet { port | wan/port} ip

address { ip_address subnet_mask | ip_address/subnet_mask_length } [ secondary ]

no address [ ip_address | * ]

Parameters

(Dub)>config(Dub) config>interface ethernet 2(Dub) config interface ethernet 2>enable(Dub) config interface ethernet 2>description Ethernet 2(Dub) config interface ethernet 2->

address Configures an IP address for an Ethernet interface. The following parameters are accepted: ip_address—Defines the IP address for the interface. subnet_mask—Defines the subnet mask for the interface in

dotted decimal format. subnet_mask_length—Defines the length of the subnet mask.

Valid values are 1 to 32. secondary—Designates an IP address as a backup to the

primary IP address.


WESTELL.COM

1-800-377-8766

Page 2-125



ExamplesThe following settings are configured for interface ethernet 2:

Enabled interface ethernet 2 Description Ethernet 2 IP address 12.35.92.4 and subnet mask length 16.




port Defines the physical connector associated with an Ethernet interface on Remote RMX-3200. Valid Ethernet port values are 1 to 8. You may also see an Ethernet port 0, which is associated with the expansion slot. If the WGBE card is installed in the expansion slot, ports wan/1 and wan/2 represent WGBE’s 1000baseT ports, while wan/3 and wan/4 represent WGBE’s fiber SFP ports.

For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

* Specifies all Ethernet interfaces or all interfaces from the Remote RMX-3200 configuration.

(Dub)>config(Dub) config>interface ethernet 2(Dub) config interface ethernet 2>enable(Dub) config interface ethernet 2>description Ethernet 2(Dub) config interface ethernet 2>ip->address 12.35.92.4/16(Dub) config interface ethernet 2 ip->

WESTELL.COM

Page 2-126

1-800-377-8766


config interface ethernet ipv6

DescriptionThese commands configure settings for an Ethernet interface IPv6 address.

Formatsconfig interface ethernet { port | wan/port} ipv6

address ip_address/prefix_length disableenableno

Parameters


ExamplesThe following settings are configured for interface ethernet 2:

Enabled interface ethernet 2

port Defines the physical connector associated with an Ethernet interface on Remote RMX-3200. Valid Ethernet port values are 1 to 8. You may also see an Ethernet port 0, which is associated with the expansion slot. If the WGBE card is installed in the expansion slot, ports wan/1 and wan/2 represent WGBE’s 1000baseT ports, while wan/3 and wan/4 represent WGBE’s fiber SFP ports.

For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

address Configures an IP address for the bridge switch interface. The following parameters are accepted: ip_address—Defines the IP address for the interface. prefix_length—Defines the length of the network prefix in

decimal format. Valid values are 1 to 128.

disable Disables the IPv6 protocol.

enable Enables the IPv6 protocol.


WESTELL.COM

1-800-377-8766

Page 2-127


Description Ethernet 2 IPv6 address fd10::39:0:0:1/64.




(Dub)>config(Dub) config>interface ethernet 2(Dub) config interface ethernet 2>enable(Dub) config interface ethernet 2>description Ethernet 2(Dub) config interface ethernet 2>ipv6(Dub) config interface ethernet 2 ipv6->address fd10::39:0:0:1/64(Dub) config interface ethernet 2 ipv6->

WESTELL.COM

Page 2-128

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config interface nat64

config interface nat64

DescriptionThese commands enable or disable nat64 participation by an interface.

Formatsconfig interface { ethernet { port } | bridge switch } nat64

disableenable

Parameters


ExampleThe following enables nat64 on a bridge interface:

See Alsoconfig controller nat64


disable Disables nat64 on the interface

enable Enables nat64 on the interface

ethernet Selects ethernet interface for nat64 enabling or disabling

bridge switch

Selects bridge switch interface for nat64 enabling or disabling

(Kentrox)>(Kentrox)>config(Kentrox) config>interface bridge switch(Kentrox) config interface bridge switch>nat64 enable

(Kentrox) config interface bridge switch>

WESTELL.COM

1-800-377-8766

Page 2-129

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config interface openvpn

config interface openvpn

DescriptionThis command configures an OpenVPN interface and its associated settings. An interface is an entity to which you can route IP packets. All interfaces are associated with an underlying controller.

Formatsconfig interface openvpn name

description textdisableenableip address { ip_address subnet_mask |

ip_address/subnet_mask_length } [ secondary ]ip no address { ip_address | * }no description

For deleting OpenVPN interfaces:config no interface openvpn { name | * }

Parameters

* Specifies all OpenVPN interfaces.

description Configures a description for the OpenVPN interface. The following parameter is accepted:

text—Defines the description for the OpenVPN interface.

disable Disables the OpenVPN interface.

enable Enables the OpenVPN interface. The interface is enabled by default.

ip address This command configures the IP address(es) on an OpenVPN interface. The configured network for the interface must not overlap with any other configured interface. The following parameters are accepted: ip_address—Defines the IP address for the interface. subnet_mask—Defines the subnet mask for the interface in

dotted decimal format. subnet_mask_length—Defines the length of the subnet mask.

Valid values are 1 to 30. secondary—Designates an IP address as a backup to the

primary IP address.

WESTELL.COM

Page 2-130

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config interface openvpn


ExamplesThe following settings are configured for OpenVPN interface cmhclient1:

Enabled OpenVPN interface cmhclient1 Description VPN client interface CMH1 IP address 12.35.64.34 and subnet mask length 16

See Alsoconfig controller openvpn

show interfaces openvpn

name Defines the name of the OpenVPN interface.


(Dub)>config(Dub) config>interface openvpn cmhclient1(Dub) config interface openvpn cmhclient1>enable(Dub) config interface openvpn cmhclient1>description VPN client interface CMH1(Dub) config interface openvpn cmhclient1>ip address 12.35.64.34/16(Dub) config interface openvpn cmhclient1>

WESTELL.COM

1-800-377-8766

Page 2-131

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config interface serial


DescriptionThis command deletes a serial interface or takes the user to the CLI stopping point that precedes serial interface configuration. An interface is an entity to which you can route IP packets. All interfaces are associated with an underlying controller.

Note: The asynchronous PPP feature only works if the asynchronous port is cabled

directly to a modem.

Formatsconfig interface serial async_port { channel-group group }

description textdisableenableip address ip_address pointopoint peer_ip_addressno { description | ip address ip_address }

For wireless modems:config interface serial wan_port

description textdisableenableip address ip_address pointopoint peer_ip_addressno { description | ip address ip_address }

For deleting a serial interface:config no interface serial { async_port | wan_port | * }

Parameters

* Specifies all serial interfaces.

async_port Defines the asynchronous physical connector associated with the interface on Remote RMX-3200. Valid values are 1 to 8.

channel-group

Specifies a serial port channel group. The only configurable serial port channel group on Remote RMX-3200 is named group.

description Configures a description for a serial interface. The following parameter is accepted:

text—Defines a description for the serial interface. The maximum length for an interface description is 60 characters.

WESTELL.COM

Page 2-132

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config interface serial


ExamplesThe following settings are configured for interface serial 3:

Description This is serial interface 3 IP address 10.37.45.2 and peer IP address 10.37.45.5 Enabled interface serial 3.



show interfaces

disable Disables a serial interface.

enable Enables a serial interface.


ip address Configures an IP address for the serial interface. The following parameters are accepted: ip_address—Defines the IP address for the interface. pointopoint—Initiates the definition of the remote device IP

address. peer_ip_address—Defines the remote device IP address

for the interface.


wan_port Defines the WAN physical connector associated with the interface on a Remote RMX-3200 expansion card. For information about valid serial WAN port values, refer to Appendix : .

(Dub)>config(Dub) config>interface serial 3(Dub) config interface serial 3>description This is serial interface 3(Dub) config interface serial 3>ip address 10.37.45.2 pointopoint 10.37.45.5(Dub) config interface serial 3>enable(Dub) config interface serial 3>

WESTELL.COM

1-800-377-8766

Page 2-133

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config ip

config ip

DescriptionThis command configures various IP settings for Remote RMX-3200.

Formatsconfig ip

arp ip_address mac_addressdomain-name domain_nameforwardname-server ip_addressno { arp ip_address | domain-name | forward | name-server

{ ip_address | * }route { destination_address subnet_mask |

destination_address/subnet_mask_length } { gateway__address | interface type instance }[ preference ]

route default { gateway_address | interface type instance} no route {default | * }route-v6 ipv6_prefix/prefix_length

{ gateway_address | interface type instance | preference }route-v6 default { gateway_address | interface type instance }no route-v6 {default | * }

For deleting a route:config ip no route { destination_address subnet_mask | destination_address/subnet_mask_length | * }{ gateway_address | interface type instance }

config ip no route-v6 { ipv6_prefix/prefix_length }{ gateway_address | interface type instance }

For restoring the default route (which routes to the bridge switch interface):config ip default route default

config ip default route-v6 default

WESTELL.COM

Page 2-134

1-800-377-8766


Parameters

* Specifies all IP addresses or routes.

arp Configures an Remote RMX-3200 ARP cache entry. The following parameters are accepted: ip_address—Defines an IP address. mac_address—Defines a MAC address. This parameter must

be entered as a 6-byte, hexadecimal formatted value with a colon separating each byte (for example, 00:E0:52:CC:0B:00).

default Sets a default static route, which is used to route a packet to a destination when there is no better route in the IP routing table.

domain-name Configures a domain name for Remote RMX-3200. Domain names are used to represent IP addresses on a network and are formatted as a series of characters separated by periods (for example, www.domainname.com).

domain_name—Defines the name of the configured domain (up to 80 characters). This parameter will accept any text value that is entered.

forward Enable or disable IP forwarding for Remote RMX-3200. IP forwarding allows IP packets received on an interface to be forwarded to other interfaces. The default is disabled IP forwarding.

name-server Adds or deletes DNS servers. A DNS server translates domain names into corresponding IP addresses. Primary and secondary DNS servers are configurable. The first instance of this command configures the primary server and the second instance configures the secondary server. The following parameter is accepted:

ip_address—Defines the IP address of the DNS server.


WESTELL.COM

1-800-377-8766

Page 2-135



route Configures or deletes a static route. The following parameters are accepted: destination_address—Defines an IP address for a network. subnet_mask—Defines the number used to identify a

subnetwork. A subnet mask is needed so that an IP address can be shared on a LAN.

subnet_mask_length—Defines the subnet mask length. Valid values are 1 to 32.

gateway_address—Defines the IP address of the next node location in a route.

interface—Defines the IP interface name for the next node in a route and:type is the type of network interface.instance is an instance of the type of network interface.

preference—Defines a preference value for a configured route. Remote RMX-3200 selects configured routes with low preference values before routes with high preference values. Valid values are 0 to 100 with a default preference value of 60.

route-v6 Configures static IPv6 routes. The following parameters are accepted: ipv6_prefix—Defines the IPv6 address prefix for a network. prefix_length—Defines the length of the network prefix in

decimal format. Valid values are 1 to 128. gateway_address—Defines the IPv6 address of the next node

location in the route. interface—Defines the IP interface name for the next node in

a route and:type is the type of network interface.

instance is an instance of the type of network interface. preference—Defines a preference value for a configured

route. Remote RMX-3200 selects configured routes with low preference values before routes with high preference values. Valid values are 0 to 100 with a default preference value of 60.

WESTELL.COM

Page 2-136

1-800-377-8766


ExamplesThe following IP settings are configured:

An ARP cache entry with IP address 10.40.5.11 and MAC address 00:01:03:1C:A2:E4

Domain name www.firewalldomain.com Enabled IP forwarding DNS server 12.55.68.4 Default route 10.40.0.1.

The following IPv6 setting is configured:

Default route fd10::39:0:0:1

See Alsoshow ip

(Dub)>config(Dub) config>ip(Dub) config ip>arp 10.40.5.11 00:01:03:1C:A2:E4(Dub) config ip>domain-name www.firewalldomain.com(Dub) config ip>name-server 12.55.68.4(Dub) config ip>route default 10.40.0.1(Dub) config ip> route-v6 default fd10::39:0:0:1(Dub) config>ip

WESTELL.COM

1-800-377-8766

Page 2-137

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config iptables

config iptables

DescriptionThis command configures iptables for Remote RMX-3200. IP packets are filtered, manipulated, or re-addressed with the following types of tables:

filter

This table filters IP packets as they go out through a Remote RMX-3200 interface.

mangle

This table manipulates IP packets as they go out through a Remote RMX-3200 interface.

nat

This table re-addresses IP addresses and/or port numbers for IP packets as they go out through a Remote RMX-3200 interface.

The filter, mangle and nat tables contain one or more chains. Each chain is a list of rules that can match a set of packets. Each rule specifies criteria for a packet and specifies what to do with the packet if it matches the criteria.

For information on the available options and parameters for this command, which is based on Linux command iptables, refer to http://ipset.netfilter.org/iptables.man.html.

Tip: For step-by-step scenarios on how to configure NAT for Remote RMX-3200 using this command, refer to the Remote RMX-3200 Configuration Guide.

See Alsoshow iptables

WESTELL.COM

Page 2-138

1-800-377-8766

http://ipset.netfilter.org/iptables.man.html


Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config iptables-v6

config iptables-v6

DescriptionThis command configures iptables for IPv6 addresses for Remote RMX-3200. IP packets are filtered, manipulated, or re-addressed with the following types of tables:

filter

This table filters IP packets as they go out through a Remote RMX-3200 interface.

mangle

This table manipulates IP packets as they go out through a Remote RMX-3200 interface.

The filter, mangle and nat tables contain one or more chains. Each chain is a list of rules that can match a set of packets. Each rule specifies criteria for a packet and specifies what to do with the packet if it matches the criteria.

For information on the available options and parameters for this command, which is based on Linux command iptables, refer to http://ipset.netfilter.org/iptables.man.html.

Tip: For step-by-step scenarios on how to configure NAT for Remote RMX-3200 using this command, refer to the Remote RMX-3200 Configuration Guide.

See Alsoshow iptables

WESTELL.COM

1-800-377-8766

Page 2-139



Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config jobs

config jobs

DescriptionThese commands configure job history and statistics settings.

Formatsconfig jobs

default history-runshistory-runs countno historyreset-stats

Parameters

default Resets the history run count to its default of 25.

history-runs

Sets the number of job runs for which Remote RMX-3200 keeps records. This feature cannot be disabled. The following parameter is accepted:

count—Defines the number of job runs for which Remote RMX-3200 saves history. Valid values are 1 to 100.

Notes: History entries that exceed the maximum run count are

deleted every 15 minutes. If you execute command show jobs on page 3-100 within 15 minutes of the maximum run count being exceeded, you could see more job runs listed than the amount specified in the maximum run count.

Error information can fill the history database to capacity if many jobs have histories with abnormal runs. When the history database reaches its capacity, Remote RMX-3200 will not be able to record the results of completed jobs. If this is the case, you should remove unneeded history entries. You should also correct the problem causing the abnormal job terminations. If the problem cannot be corrected and the history database continues to reach capacity, you should decrease the number of job runs that get recorded to history.

no history Purges the history of all jobs for Remote RMX-3200

WESTELL.COM

Page 2-140

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config jobs

Command Defaults25 runs


ExamplesThe following job history and statistics settings are configured:

13 history runs Reset job statistics.

This example displays the configuration of the history run count to its default value.

See Alsoconfig jobs name

show jobs

config jobs name

reset-stats Resets the statistical counts displayed by command show jobs on page 3-100.

(Dub)>config(Dub) config>jobs(Dub) config jobs>history-runs 13(Dub) config jobs>reset-stats(Dub) config jobs>

(Dub)>config(Dub) config>jobs(Dub) config jobs>default history-runs(Dub) config jobs>

WESTELL.COM

1-800-377-8766

Page 2-141

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config jobs name

config jobs name

DescriptionThis command configures a job and its associated settings.

Important: You must stop running jobs before deleting them with this command.

Formatsconfig jobs name job_name

capturecron-startdefault { memory | start-attempts }history run_idmemory mem_limit [ stack_size ]no { capture | cron-start | history { run_id | * } | property

property | start-at start_index | start-boot | title }property property prop_valuescript package script [ min_version ]start-at month day hour minute weekdaystart-attempts countstart-boottitle title

For deleting a job:config jobs no name job_name

Parameters

* Specifies that all history for a job will be deleted.

capture Enables the capture of job standard output (stdout) and standard error (stderr) into job.out and job.err files when the job is run. By performing the capture, users can review the standard output and standard error information for debugging purposes. Job capture is disabled by default.

cron-start Configures a job to start automatically after a specific event has occurred, such as arrival at a specified time/date. The job can still be run manually after this command has been enabled. Cron-start is disabled by default.


WESTELL.COM

Page 2-142

1-800-377-8766


history Specifies the history of all Remote RMX-3200 jobs. The following parameter is accepted:

run_id—Defines the specific execution of a job for which history will be purged.

job_name Defines the name of the job being added or deleted. Job names are stored in lowercase. Valid entries are alphanumeric characters and underscores (_).

memory Configures the amount of dynamic memory (in kilobytes) allowed for storing and running a particular job.The following parameters are accepted: mem_limit—Defines the number of kilobytes being

allocated for storing and running a particular job. Valid values are 1200 to 122880. The default memory limit is 2560 kilobytes.

stack_size—Defines the number of kilobytes being allocated for the stack per thread. Valid values are 128 to 8192. The default stack per thread is 1024 kilobytes.

Note: Memory is not unlimited. Concurrently running jobs

cannot exceed a total of 122880 kilobytes of memory.


property Configures a property for a job. Properties are parameters defined in a script that control or alter the operation of a job. The following parameters are accepted: property—Defines the property that will be configured for a

job. Acceptable values for the job property are based on parameters defined in the script.

prop_value—Defines the value of the configured property. Acceptable values are dependent on the indicated property.

Tip: In order to have spaces in the value, the value must be in quotes.

WESTELL.COM

1-800-377-8766

Page 2-143


script Associates a script with a job and allows the user to select a package version level for that job. Jobs are likely to vary from one card installation to another due to the uniqueness of device IP addresses. The following parameters are accepted: package—Defines the package containing the script. script—Defines the script to be run by the job. min_version—Defines a minimum acceptable package

version level. If no version level is specified, any version of the package may be used.

Tip: If the package referred to by the job has not been installed, Remote RMX-3200 will attempt to find and install it when executing the job if the on-demand-install flag is enabled.

start-at Adds a start time specification to a job and assigns a start index for Remote RMX-3200. The following characteristics apply: Multiple start times can be specified, but two or more

identical start times will cause an error. Start times can overlap, but the job will only be started once. A start time is ignored if the job is already running when that

time arrives. All configured start times are ignored if the cron-start

command is disabled.The following parameters are accepted: day—Defines the day that the job will start. Valid values are

1 to 31. hour—Defines the hour that the job will start. Valid values

are 0 to 23. minute—Defines the minute that the job will start. Valid

values are 0 to 59. month—Defines the month that the job will start. Valid

values are 1 to 12. start_index—Defines the index number associated with a

start time specification for a job. weekday—Defines the day of the week that the job will start.

Valid values are 0, which represents Sunday, to 7, which represents the following Sunday.

WESTELL.COM

Page 2-144

1-800-377-8766



ExamplesThe following settings are configured for job samplejob:

Enabled capture capabilities Enabled automatic start capabilities Enabled start at boot up Job memory limit of 24368 kilobytes and stack size of 4000 kilobytes Job property duration, which sets the runtime for a job in seconds, with a

property value of 10 seconds Script package jobtestutils, script normal and minimum required version

level 2.0.0 10 start attempts Job title New Sample Job

start-attempts Configures the number of times Remote RMX-3200 will attempt to restart a job if it stops abnormally. If a user manually stops the job, it will not be restarted (even if the stop is abnormal). The following parameter is accepted:

count—Defines the number of times that Remote RMX-3200 will attempt to restart a job. Valid values are 1 or more. The default number of start attempts is 1.

start-boot Configures a specified job to start whenever Remote RMX-3200 boots up. This functionality is disabled by default.

title Configures the title of the job. The title should be a comprehensible description of the job. The following parameter is accepted:

title—Defines the title of the job. The title can be up to 80 characters long and it can contain spaces.

WESTELL.COM

1-800-377-8766

Page 2-145


This example displays the configuration of the following start times for job samplejob:

Month 4 Days 15-24 Hours 3,5,7 Minute 30 No weekday

The configured start times for samplejob are April 15th to 24th at 3:30 AM, 5:30 AM and 7:30 AM. The start-at index number is 2.

This example displays the removal of the history associated with run ID 14 for job myjob.

(Dub)>config(Dub) config>jobs(Dub) config jobs>name samplejob(Dub) config jobs name samplejob->capture(Dub) config jobs name samplejob->cron-start(Dub) config jobs name samplejob->start-boot(Dub) config jobs name samplejob->memory 24368 4000(Dub) config jobs name samplejob->property duration 10(Dub) config jobs name samplejob->script jobtestutils normal 2.0.0(Dub) config jobs name samplejob->start-attempts 10(Dub) config jobs name samplejob->title New Sample Job(Dub) config jobs name samplejob->

(Dub)>config(Dub) config>jobs(Dub) config jobs>name samplejob(Dub) config jobs name samplejob->start-at 4 15-24 3,5,7 30 *Start-at index: 2(Dub) config jobs name samplejob->

(Dub)>config(Dub) config>jobs(Dub) config jobs>name myjob(Dub) config jobs name myjob->no history 14(Dub) config jobs name myjob->

WESTELL.COM

Page 2-146

1-800-377-8766


See Alsoconfig jobs

config jobs name task

show jobs

show jobs name

WESTELL.COM

1-800-377-8766

Page 2-147

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config jobs name task


DescriptionThese commands configure a job task and its associated settings. A task is a function of a job that operates only during the job execution period.

Formatsconfig jobs name job_name task task

no property propertyposition positionproperty property valuetype task_type

For deleting a task:config jobs name job_name no task task

Parameters

job_name Defines the name of the job for which the task is being configured or deleted.

no Deletes a task or task property.

position Specifies a position for a task in the task list. Remote RMX-3200 lists tasks in the order they will execute. The position indicates where in the list order a task should appear. Unless a user specifies a new position, Remote RMX-3200 adds new tasks to the end of the list. The following parameter is accepted:

position—Moves a task to a specific location in the task list. Valid values are 1 to the new total number of tasks. Command show jobs name on page 3-103 displays the total number of tasks.

WESTELL.COM

Page 2-148

1-800-377-8766


datadirTask type datadir creates a directory that retains data for a job after that job has been deleted. A stable data directory is useful for logging permanent data with temporary jobs and sharing data between multiple jobs. Under normal circumstances, a working directory for a job is deleted when the associated job is deleted. The directory created by task type datadir can only be deleted by a job or by using FTP commands. Table 4 lists the available datadir task properties that can be configured by the user.

Note: Multiple jobs that refer to the same name will correspond to the same

directory.

property Configures a task property for a job. Each task type has a set of configurable properties. A task type must be configured before an associated property is configured. Remote RMX-3200 validates task properties upon job execution. The following parameters are accepted: property—Defines a user-configurable property for a task. Each

task type has its own set of properties. Refer to Table 4 on page 2-150 and Table 6 on page 2-151 for more information about user-configurable property sets.

value—Defines a value for a property.

Tip: In order to have spaces in the value, the value must be in quotes.

task Defines the name of the task being configured or deleted for the job. Task names are stored in lowercase. Valid entries are alphanumeric characters and underscores (_).

type Assigns a type to a job task. The following parameter is accepted:task_type—Defines the task type. Remote RMX-3200 has six available task types: datadir ifconfig processmonitor serversocket watchdog

WESTELL.COM

1-800-377-8766

Page 2-149


Table 4 User-Configurable Properties for datadir Tasks

Property Description Required

create Specifies that the data directory should be created if it doesn’t already exist. The task fails if the data directory does not exist and this property is not present. Valid values are true and false.

No

name Specifies the logical name for the data directory. Valid values are letters, numbers and underscores. This value must begin with a letter.

Note: If not defined by the user, the data directory name

automatically defaults to the task name.

No

WESTELL.COM

Page 2-150

1-800-377-8766


Table 5 lists the runtime datadir task property that is configured by the script engine.

ifconfigTask type ifconfig has been deprecated. It can be replaced by configuring a secondary address on an interface and creating a job property that tells the script which address to bind.

processmonitorTask type processmonitor allows the script engine to terminate any remaining additional sub-processes spawned by the script when a script ends.

This task type has no task properties associated with it. The process information is sent to the script engine at runtime by the script.

resourceTask type resource has been deprecated.

serversocketTask type serversocket specifies a server socket configuration for a task. It binds the socket to the job for the lifetime of the script. Table 6 lists the available properties for task type serversocket.

Table 5 Script Engine-Defined Property for datadir Tasks

Property Description

path Specifies the absolute path to the directory created by the script engine.

Table 6 Properties for Task Type serversocket


address Specifies the configuration of an IP address or hostname.

Yes (if ifconfig or interface are not specified)

defer Specifies that only the runtime address property should be determined. The socket is not created.

No. When specified, the port, type and listen properties should not be specified.

ifconfig Specifies a previously configured address value from an ifconfig task.

Yes (if interface or address are not specified)

WESTELL.COM

1-800-377-8766

Page 2-151


Table 7 lists the runtime serversocket task properties that are configured by the script engine.

watchdogTask type watchdog allows the script engine to terminate a script if it fails to “check in” in the task’s specified time frame. This task type has no associated properties.


interface Specifies a previously configured interface value, such as Eth0_1.

Tip: For valid interface values, refer to the system-name values listed in command show interfaces on page 3-78.

Yes (if ifconfig or address are not specified)

listen Specifies the number of connections allowed in the socket’s listen queue. This property’s value is valid only if stream is configured.

No

port Specifies the numeric port value to which the socket binds. A value of 0 causes the script engine to bind to an ephemeral port.

Yes

type Specifies the type of socket Remote RMX-3200 configures. Valid values are stream and dgram. If not specified, the default is stream.

No

Table 7 Script Engine-Defined Property for serversocket Tasks

Property Description

socket Specifies the socket file descriptor that is opened for the job. A script can use the following Python code to create a corresponding socket object:

fd = int(properties[“taskname.socket”])socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM)

port Specifies a script engine-selected port number (ephemeral port). When the user enters 0 to bind to an ephemeral port, the script engine selects an unused port to pass on to the script.

Table 6 Properties for Task Type serversocket (Continued)


WESTELL.COM

Page 2-152

1-800-377-8766


ExamplesThis example displays the configuration of task ipconfig for job samplejob.

This example displays the deletion of task ipconfig from job samplejob.

See Also show jobs

show jobs name

(Dub)>config(Dub) config>jobs(Dub) config jobs>name samplejob(Dub) config jobs name samplejob->task ipconfig(Dub) config jobs name samplejob task ipconfig->

(Dub)>config(Dub) config>jobs(Dub) config jobs>name samplejob(Dub) config jobs name samplejob->no task ipconfig(Dub) config jobs name samplejob->

WESTELL.COM

1-800-377-8766

Page 2-153

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config meas-table

config meas-table

DescriptionThis command configures the measurement table, which stores analog measurement values.

Formatsconfig meas-table

defaultinterval interval

Parameters


ExamplesThis example configures an interval of 30 minutes over which measurement values are averaged and archived:

default Configures the default value (15 minutes) for the interval parameter.

Note: If you are using Remote RMX-3200 with the Optima

Management Portal, the default value (15 minutes) for the interval parameter should be retained.

interval Configures the time interval over which measurement values are averaged and archived. The following parameter is accepted:

interval—Defines the time interval in minutes. Valid values are whole numbers between 1 and 1440.

(Dub)>config(Dub) config>meas-table(Dub) config meas-table>interval 30(Dub) config meas-table>(Dub)>

WESTELL.COM

Page 2-154

1-800-377-8766


This example configures the default value (15 minutes) for the interval parameter:

config meas-table entry

DescriptionThis command configures entries in the measurement table.

Formatsconfig meas-table entry { name | filter | * }

band low highcategory category_namedefaultdescription textdisableenablehysteresis hysteresis_valuemaximum maximum_valueminimum minimum_valuene-name ne_namenooriginator originatorreport-interval report_intervalunits units

For deleting measurement table entries:config meas-table no entry { name | filter | * }

(Dub)>config(Dub) config>meas-table(Dub) config meas-table>default interval(Dub) config meas-table>(Dub)>

WESTELL.COM

1-800-377-8766

Page 2-155


Parameters

* Specifies all event templates.

band Configures the high and low levels for a measurement table entry. When the measurement value falls below the low level, a low event is generated. When the measurement value exceeds the high level, a high event is generated. When the measurement value lies between the high and low levels, an in-band event is generated. The following parameters are accepted:

low—Defines the low measurement table value in sensor units. Valid values are numeric characters. The default value is 0.high—Defines the high measurement table value in sensor units. Valid values are numeric characters. The default value is 0.

category Configures a category for a measurement table entry. The category associates the measurement table entry with a specific application or task. The following parameter is accepted:

category_name—Defines a category name. Maximum length is 128 characters.

default Configures the default value for a specified parameter (band, hysteresis, maximum, minimum, or report-interval).

description Configures a measurement table entry description. The following parameter is accepted:

text—Defines a description

disable Disables measurement keeping for a measurement table entry.

enable Enables measurement keeping for a measurement table entry.

filter Configures a filter for configured groups of measurement table entries. A period (.) is used for single character matching and an asterisk (*) is used for multiple character matching.

WESTELL.COM

Page 2-156

1-800-377-8766


hysteresis Configures hysteresis, which works as a guard between the high and low band thresholds. For example, if a high band value is set to 10 and the hysteresis is set to 1, a high event is generated when the measured value goes above 10 and an in-band event is generated when the measured value goes below 9. The following parameter is accepted:

hysteresis_value—Defines the hysteresis value in sensor units. Valid values are numeric characters. The default value is 0.

maximum Configures the maximum value allowed for the measurement table entry. If the measured value exceeds the maximum value, an input-saturated event is generated. The following parameter is accepted:

maximum_value—Defines the maximum value in sensor units. Valid values are numeric characters.

minimum Configures the minimum value for the measurement table entry. If the measured value falls below the minimum value, a loss-of-signal event is generated. The following parameter is accepted:

minimum_value—Defines the minimum value. Valid values are numeric characters.

name Configures the name of the measurement table entry. Valid values are alphanumeric characters.

ne-name Configures the name of the network element whose data is being measured. The following parameter is accepted:

ne_name—Defines a network element name. Valid values are alphanumeric characters.

no Deletes a specified parameter (category, description, ne-name, originator, or units).

originator Identifies the origin of the measured data; for example, an analog input, a script, or SNMP proxy measurement. The following parameter is accepted:

originator—Defines the source of the measured data.

Note: Refer to Table 8 on page 2-158 for more information

about valid measurement originators.

WESTELL.COM

1-800-377-8766

Page 2-157


report-interval Configures the interval for reporting updated measurement values by sending a trap or some other external message. The following parameter is accepted:

report-interval—Defines time interval in minutes. Valid values are integers. The default value, 0, disables the reporting of updated measurement values.

units Configures the unit of measure for this measurement table entry. The following parameter is accepted:

units—Defines a unit of measure; for example, V or deg C. Valid values are alphanumeric characters.

Table 8 Valid Measurement Originators

Measurement Originator Description

analog instance Specifies an analog input as the measurement originator. Valid value for instance is:

unit/{ point | power | powerB | temperature } unit






WESTELL.COM

Page 2-158

1-800-377-8766


script instance Specifies the script as the measurement originator. Valid value for instance is:

jobname measurementname

instance signal-strength

Specifies the wireless modem controller’s signal-strength as the originator of the fractional bar signal-strength value calculated for the modem. Valid value for instance is:

controller name For example: serial wan/1 signal-strengthThe signal-strength originator periodically updates the measurement table with fractional bar values ranging from 0.00 to 5.00. A signal-strength value of 0.00 equals “none/horrible,” while a value of 4.00 to 5.00 equals “excellent.”

sitebus instance Specifies the sitebus as the measurement originator. Valid value for instance is:

device_name/device_point Identifies the sitebus where device_name is the name of the sitebus device and device_point is the sitebus device point.

Refer to config sitebus for more information.

snmpne instance Specifies a SNMP proxy measurement template as the measurement originator. Valid value for instance is:

NEname_measurementnameWhere NEname is the name of the SNMP network element and measurementname is the name of the measurement on the SNMP network element.

An SNMP NE table also can serve as the originator for a measurement table entry. Valid value for instance is:

NEname_measurementname_rowIDWhere rowID is the row’s unique identifier obtained from the row ID column.


Measurement Originator Description (Continued)

WESTELL.COM

1-800-377-8766

Page 2-159


system Specifies the type of system as the measurement originator. Valid value for instance is:

system/{ cpu-load | mem-usage | disk-usage } system

Indicates the system as a whole (not one particular subsystem) as the measurement originator.

cpu-load Monitors the CPU’s load. CPU load is the 5-minute load average for the Remote.

mem-usageMonitors memory usage. Memory usage is the percentage of memory used on the Remote.

disk-usageMonitors file system usage. File system usage is the maximum percentage used of all disk partitions on the Remote.

@state-transitions( instance )

Specifies a function that counts the number of times an originator transitions to a particular state within the measurement interval. Format for instance is:

statefulOriginator, ActiveState where statefulOriginator is the alarm entry or a status point and ActiveState is the severity of the alarm or the state of the status point.

Valid values for instance are: alarm-entry alarm_name, alarm_severity where

alarm_name is the name of the alarm and alarm_severity is the severity of the alarm (i.e., critical, major, minor, warning, etc.)

status-point ne ne_name statuspoint_name, statuspoint_state where ne_name is the name of the network element, statuspoint_name is the name of the network element status point and statuspoint_state is the state of the status point (i.e., opened, closed, etc.).

For example: @state-transitions ( alarm-entry Indoor_HighTemp, Major )



WESTELL.COM

Page 2-160

1-800-377-8766



ExamplesThe following settings are configured for the measurement table entry Voltage1:

In-band range from 13 to 15 Maximum value 18 Minimum value 12 Network element name Generator1 Measurement units VDC

@state-duration ( instance )

Specifies a function that counts the number of seconds an originator is in a particular state within the measurement interval.Format for instance is:

statefulOriginator, ActiveState where statefulOriginator is the alarm entry or a status point and ActiveState is the severity of the alarm or the state of the status point.

Valid values for instance are: alarm-entry alarm_name, alarm_severity where

alarm_name is the name of the alarm and alarm_severity is the severity of the alarm (i.e., critical, major, minor, warning, etc)

status-point ne ne_name statuspoint_name, statuspoint_state where ne_name is the name of the network element, statuspoint_name is the name of the network element status point and statuspoint_state is the state of the status point (i.e., opened, closed, etc.)

For example: @state-duration ( status-point ne SideDoor Door_Open, Opened )



WESTELL.COM

1-800-377-8766

Page 2-161


See Alsoconfig mediation snmp measurement-template

config mediation snmpne

debug mediation

diag mediation snmpne poll

show meas-table

show mediation

(Dub)>config(Dub) config>meas-table entry Voltage1(Dub) config meas-table entry Voltage1->band 50 52(Dub) config meas-table entry Voltage1->maximum 54(Dub) config meas-table entry Voltage1->minimum 48(Dub) config meas-table entry Voltage1->ne-name Generator1(Dub) config meas-table entry Voltage1->units VDC(Dub) config meas-table entry Voltage1(Dub)>

WESTELL.COM

Page 2-162

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation snmp event-template

config mediation snmp event-template

DescriptionThis command configures the event template for a proxied SNMP network element.

Formatsconfig mediation snmp event-template name

description descriptionmessage messagenotrap-oid trap_oidvarbind-match varbind_oid varbind_value

For deleting SNMP event templates:config mediation snmp no event-template { name | * }

Parameters

* Specifies all event templates.

description This command configures a textual description for an event template. The following parameter is accepted:

description—Configures the name of the event template. Valid values are alphanumeric characters.

message Configures the event template’s alarm message. The message may contain parameters which are replaced by the SNMP NE or by the mediation response. The SNMP NE parameters are set when the alarm table entry is added. The response parameters are set from the mediation event. The following parameter is accepted:

message—Defines the template’s alarm message.

name Configures the name of the event template. Valid values are alphanumeric characters.

trap-oid Configures the trap OID (Object Identifier) for an event template. This value will be matched against the OID for a trap. The OID is a SNMP v2 trap OID. SNMP v1 trap fields are converted to a SNMP v2 trap OID according to the rules in RFC 2576. The following parameter is accepted:

trap_oid—Configures the name of the OID which is matched against the OID of an incoming trap. Valid values are dotted number OID strings, for example, .1.2.3.4.

WESTELL.COM

1-800-377-8766

Page 2-163



ExamplesThe following mediation SNMP event-template settings are configured:

Event-template name coldstart Description Reboot event Message $(event) event on $(snmpne) Trap OID .1.3.6.1.6.3.1.1.5.1 Varbind-match .1.3.6.1.2.1.2.2.1.1 $(ifIndex)


varbind-match

Configures a matching varbind OID and value for an event template. If multiple varbind matches exist, the trap must match all of the varbinds matches to match the event. The following parameters are accepted: varbind_oid—Configures the OID which is matched against

one of the varbind OIDs of an incoming trap. The OID may contain parameters.

varbind_value—Configures the value which must match the value in an incoming trap for the configured varbind OID. The value may contain parameters.

Note: Parameters are of the form $(name) where the name is a

sequence of alphanumeric characters.

(Dub)>config(Dub) config mediation snmp event-template coldstart>description Reboot event(Dub) config mediation snmp event-template coldstart>message $(event) event on $(snmpne)(Dub) config mediation snmp event-template coldStart>trap-oid .1.3.6.1.6.3.1.1.5.1(Dub) config mediation snmp event-template coldStart>varbind-match .1.3.6.1.2.1.2.2.1.1 $(ifIndex)(Dub)>

WESTELL.COM

Page 2-164

1-800-377-8766


See Also config mediation snmpne

config mediation snmp manager

config mediation snmp measurement-template

config mediation snmp ne-template

config mediation snmp point-template

debug mediation


show mediation

WESTELL.COM

1-800-377-8766

Page 2-165

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation snmp manager


DescriptionThis command configures the mediation SNMP manager.

Formatsconfig mediation snmp manager

port port

Parameters


ExampleThe following mediation SNMP manager is configured for port 2162:

See Also config mediation snmp event-template





show mediation

port Configures the port on which the SNMP manager listens for incoming SNMP notifications. The following parameter is accepted:

port—Configures the port number for the SNMP manager. The default port is 162.

(Dub) config mediation snmp manager(Dub) config mediation snmp manager>port 2162(Dub) config mediation snmp manager>(Dub)>

WESTELL.COM

Page 2-166

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation snmp measurement-template


DescriptionThis command configures a measurement template for a proxied SNMP network element. The measurement template describes how a mediation SNMP NE will obtain the value for a measurement on an actual NE, either by polling a point or by matching incoming SNMP traps.

Formatsconfig mediation snmp measurement-template name

defaultdescription descriptionnopoll-oid oidpoll-table poll_table_oid id_column value_columntrap trap_name default no trap-oid oid value-match index varbind-id oid varbind-match oid value varbind-value oidvalue-conversion default multiply multipliervalue-match index

For deleting SNMP measurement templates:config mediation snmp no measurement-template { name | * }

Parameters

* Specifies all measurement templates.

default Configures the default value (1) for the value-match and value-conversion parameters.

description This command configures a textual description for a measurement template. The following parameter is accepted:

description—Configures a description for the measurement template. Valid values are string characters.

WESTELL.COM

1-800-377-8766

Page 2-167


name Configures the name of the measurement template. Valid values are alphanumeric characters.


poll-oid Configures the OID used to poll the proxied NE for the measurement’s current value. By default, the OID is empty which indicates no poll is performed. The following parameter is accepted:

oid—Configures the name of the OID which is used to poll the proxied NE.

Note: You can configure the measurement template for polling by

OID (using poll-oid) or for polling by table (using poll-table). If poll-oid has been configured, executing poll-table will override the existing command. Conversely, executing poll-oid will override an existing poll-table command.

poll-table Configures a poll table for this measurement template. The following parameters are accepted: poll_table_oid—Configures the OID used to poll the table. id_column—Configures the column to check for a matching ID

value when polling the table. Valid values are integers. value_column—Configures the column number to check for a

matching measurement value. Valid values are numeric characters.

WESTELL.COM

Page 2-168

1-800-377-8766


trap Describes trap parameters that the measurement template will compare with incoming traps in order to determine a match. The following parameters are accepted: name—Configures the name of the trap. Valid values are

alphanumeric characters. default—Configures the default value (1) for the value-

match parameter. trap-oid—Configures the trap OID (Object Identifier) for a

measurement template. This value will be matched against the OID for an incoming trap. The following parameter is accepted:oid—Configures the name of the OID which is matched against the OID of an incoming trap. Valid values are dotted number OID strings, for example, .1.2.3.4.

value-match—Configures which numeric value in a string is the desired value. The following parameter is accepted:index—Configures which numeric value in a string is desired. Valid values are whole numbers.

varbind-id—Used only with the poll-table parameter. Configures the OID to match against one of the varbind OIDS of an incoming trap. The value of the varbind is used to identify a measurement table entry and retrieve the measurement name. The following parameter is accepted:oid—The OID which is matched against one of the varbind OIDs of an incoming trap. Valid values are dotted number OID strings, for example, .1.2.3.4.

varbind-match—Configures a matching varbind OID and value to match against the varbind OID and value of an incoming trap. The following parameters are accepted:oid—The OID which is matched against one of the varbind OIDs of an incoming trap. Valid values are dotted number OID strings, for example, .1.2.3.4.value—The value which must match the varbind value in an incoming trap for the configured varbind OID. The value may contain parameters.

varbind-value—Configures the OID to match against one of the varbind OIDs of an incoming trap. The following parameter is accepted:oid—The OID value used to find the measurement value. Valid values are dotted number OID strings, for example, .1.2.3.4.

WESTELL.COM

1-800-377-8766

Page 2-169



ExamplesThe following example configures a measurement template for a single measurement. The following settings are configured:

Measurement-template name alDef Poll OID .1.3.6.1.4.1.539.42.2.2.1.5.$(alIndex) Value match 2 Trap name critical Trap OID .1.3.6.1.4.1.539.42.2.0.5 Varbind match OID .1.3.6.1.4.1.539.42.2.2.1.1 and value $alIndex Varbind value from OID .1.3.6.1.4.1.539.42.2.2.1.5

value-conversion

Configures an amount by which any value in the measurement table will be multiplied. For example, a multiplier of 60 could be used to convert minutes to seconds, or a multiplier of 0.01667 to convert seconds to minutes. The following parameter is accepted:

multiplier—The value by which measurements are multiplied. Valid values are floating-point numbers.

value-match If the response is a string containing multiple numeric values, the value-match parameter configures which numeric value is the desired value. The following parameter is accepted:

index—Configures which numeric value in a string is desired. Valid values are whole numbers. For example, if the string response is The voltage is 32.6, the current is 5.7 and value-match is set to 2, the second numeric value in the string (5.7) will be considered valid and will be used to update the measurement table entry.

WESTELL.COM

Page 2-170

1-800-377-8766


The following example configures a measurement template for a group of measurements in a poll table. The following settings are configured:

Measurement-template name alTableDef Poll table with OID .1.3.6.1.4.1.539.42.2.2, ID column 7 and value

column 5 Value match 2 Trap name critical Trap OID .1.3.6.1.4.1.539.42.2.0.5 Varbind match on ID .1.3.6.1.4.1.539.42.2.2.1.7 and value $alIndex Varbind value from OID .1.3.6.1.4.1.539.42.2.2.1.5

(Dub)>config(Dub)>config(Dub) config>mediation snmp measurement-template alDef(Dub) config mediation snmp measurement-template alDef->poll-oid .1.3.6.1.4.1.539.42.2.2.1.5.$(alIndex)(Dub) config mediation snmp measurement-template alDef->value-match 2(Dub) config mediation snmp measurement-template alDef->trap critical(Dub) config mediation snmp measurement-template alDef trap critical->trap-oid .1.3.6.1.4.1.539.42.2.0.5(Dub) config mediation snmp measurement-template alDef trap critical->varbind-match .1.3.6.1.4.1.539.42.2.2.1.1 $alIndex(Dub) config mediation snmp measurement-template alDef trap critical->varbind-value .1.3.6.1.4.1.539.42.2.2.1.5(Dub) config mediation snmp measurement-template alDef trap critical->value-match 2(Dub) config mediation snmp measurement-template alDef trap critical(Dub)>

(Dub)>config(Dub) config>mediation snmp measurement-template alTableDef(Dub) config mediation snmp measurement-template alTableDef->poll-table .1.3.6.1.4.1.539.42.2.2 7 5(Dub) config mediation snmp measurement-template alTableDef->value-match 2(Dub) config mediation snmp measurement-template alTableDef->trap critical(Dub) config mediation snmp measurement-template alTableDef trap critical->trap-oid .1.3.6.1.4.1.539.42.2.0.5(Dub) config mediation snmp measurement-template alTableDef trap critical->varbind-id .1.3.6.1.4.1.539.42.2.2.1.7(Dub) config mediation snmp measurement-template alTableDef trap critical->varbind-value .1.3.6.1.4.1.539.42.2.2.1.5(Dub) config mediation snmp measurement-template alTableDef trap critical->value-match 2(Dub) config mediation snmp measurement-template alTableDef trap critical(Dub)>

WESTELL.COM

1-800-377-8766

Page 2-171


See Alsoconfig meas-table





debug mediation


show mediation

WESTELL.COM

Page 2-172

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation snmp ne-template


DescriptionThis command configures a template containing device model definitions for a proxied SNMP network element. This template can then be referenced by other NEs of a similar model.

Formatsconfig mediation snmp ne-template name

description descriptionevent event_name template [ { param param_value } ... ]measurement measurement_name template [ { param param_value }

... ]ne-template reference_name template [ { param param_value } ...

]no [ description | event | ne-template | point ]point point_name template [ { param param_value } ... ]

For deleting SNMP NE templates:config mediation snmp no ne-template { name | * }

Parameters

* Specifies all NE templates.

description This command configures a textual description for an NE template. The following parameter is accepted:

description—Configures the name of the NE template.

event This command configures an event for this NE template by referring to an existing event template. The following parameters are accepted:

event_name—Configures the name of the event. Valid values are alphanumeric characters. Event names can also contain replaceable parameters in the format $(param). These parameters will be substituted when the template is applied to an NE.

template—Specifies the name of an existing event template.

param—Specifies a parameter in the event template. The value for this parameter is then specified by param_value.

WESTELL.COM

1-800-377-8766

Page 2-173



measurement Configures a measurement for this NE template by referring to an existing measurement template. The following parameters are accepted: measurement_name—Configures the name of the

measurement. Valid values are alphanumeric characters. template—Specifies the name of an existing measurement

template.param—Specifies a replaceable parameter in the measurement template. The value for this parameter is then specified by param_value.

name Configures the name of the NE template. Valid values are alphanumeric characters.

ne-template This command specifies values for this NE template by referring to a different NE template. The following parameters are accepted:

reference_name—Configures the name of the event. Valid values are alphanumeric characters. NE template reference names can also contain replaceable parameters in the format $(param). These parameters will be substituted when the template is applied to an NE.

template—Specifies the name of an existing NE template.

param—Specifies a parameter in the NE template. The value for this parameter is then specified by param_value.


point This command configures a point for this NE template by referring to an existing point template. The following parameters are accepted:

point_name—Configures the name of the point. Valid values are alphanumeric characters. Point names can also contain replaceable parameters in the format $(param). These parameters will be substituted when the template is applied to an NE.

template—Specifies the name of an existing point template.

param—Specifies a parameter in the point template. The value for this parameter is then specified by param_value.

WESTELL.COM

Page 2-174

1-800-377-8766


ExamplesThe following mediation SNMP NE template settings are configured:

Event template name Template1 Description Sample template Point modem, which refers to the existing point template ifEntryDef and

specifies the value serial_modem for the parameter ifDescr Event runningConfigChange, which refers to the existing event template

configChangeDef and specifies the value running-config for the parameter file

NE template alarm1, which refers to the existing NE template alarms and specifies the value 1 for the parameter num

See Alsoconfig mediation snmpne





show mediation

(Dub)>config(Dub) config mediation snmp ne-template Template1>description Sample template(Dub) config mediation snmp ne-template Template1>point modem ifEntryDef ifDescr serial_modem(Dub) config mediation snmp ne-template Template1>event runningConfigChange configChangeDef file running-config(Dub) config mediation snmp ne-template Template1>ne-template alarm1 alarms num 1(Dub)>

WESTELL.COM

1-800-377-8766

Page 2-175

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation snmp point-template


DescriptionThis command configures the point template for a proxied SNMP network element.

Formatsconfig mediation snmp point-template name

default [ offline-message | offline-severity ]description descriptionno [ description | offline message | poll-oid | poll-table |

state ]offline-message message offline-severity severity poll-default-state statepoll-oid oidpoll-table poll_table_oid match_column match_value state_columnstate name message message poll-value value severity [ critical | major | minor | normal | warning |

informational ] trap-oid oid varbind-match varbind_oid varbind_value

For deleting SNMP point templates:config mediation no point-template { name | * }

Parameters

* Specifies all point templates.

default Resets a mediation SNMP point template parameter to its default value.

description This command configures a textual description for a point template. The following parameter is accepted:

description—Configures the name of the point template. Valid values are alphanumeric characters.

name Configures the name of the point template. Valid values are alphanumeric characters.


WESTELL.COM

Page 2-176

1-800-377-8766


offline-message

Configures the alarm message for the offline state of a mediation SNMP point. The default message is $(point) is offline. The following parameter is accepted:

message—Configures the offline alarm message. Valid values are alphanumeric characters.

offline-severity

Configures the alarm severity for the offline state of a mediation SNMP point. The following parameter is accepted:

severity—The offline alarm severity. The valid severity values are critical, informational, major, minor, normal and warning. The default value is major.

poll-default-state

Configures the default polling state for points in this template. Possible values are offline and any states created by the state parameter. The default value is offline.

poll-oid Configures the OID used to poll the proxied NE for the point's current state. By default, the OID is empty which indicates no poll is performed. The following parameter is accepted:

oid—Configures the name of the OID which is used to poll the proxied NE.

Note: You can configure the point template for polling by OID

(using poll-oid) or for polling by table (using poll-table). If poll-oid has been configured, executing poll-table will override the existing command. Conversely, executing poll-oid will override an existing poll-table command.

poll-table Configures a poll table for this point template. The following parameters are accepted: match_column—Configures the column number to check for a

matching value when polling the table. Valid values are integers.

match_value—Configures the value to match within the specified column. Valid values are alphanumeric characters and may contain parameters.

poll_table_OID—Configures the name of the OID which is used to poll the table.

state_column—Configures the table column whose state will be reported if a match is found. Valid values are integers.

WESTELL.COM

1-800-377-8766

Page 2-177



state This command begins the configuration of a state for a point in a template. The following parameters are accepted: name—Configures the name of the point's state. Valid values

are alphanumeric characters. message—Configures the alarm message for the point template

state. The message may contain parameters which are replaced by the SNMP NE or by the mediation alarm table. The SNMP NE parameters are set when the alarm table entry is added. The alarm table parameters are set from the mediation event.

poll-value—Configures the poll value for a point template state. The value will be matched against the value returned from the poll OID to determine the point's state.

severity—Configures the severity for a point template state. This value is used to set the alarm table entry's severity for the state.

trap-oid—Configures the OID to match against a trap for a mediation SNMP template state.

varbind-match—Configures a matching varbind OID and value for a point template state. If multiple varbind matches exist, the trap must match all of the varbinds matches to match the state The following parameters are used:varbind_oid—The OID which is matched against one of the varbind OIDs of an incoming trap. The OID may contain parameters.varbind_value—The value which must match the value in an incoming trap for the configured varbind OID. The value may contain parameters.

WESTELL.COM

Page 2-178

1-800-377-8766


ExamplesThe following mediation SNMP point-template settings are configured:

Point-template name ifEntryDef Description Entry in ifTable State up and then the following associated parameters:

poll value 1 message $(point) is up trap-oid .1.3.6.1.6.3.1.1.5.4 varbind-match .1.3.6.1.2.1.2.2.1.1 $(ifIndex) severity normal

State down and then the following associated parameters: poll value 2 message $(point) is down trap-oid .1.3.6.1.6.3.1.1.5.3 varbind-match .1.3.6.1.2.1.2.2.1.1 $(ifIndex) severity major

(Dub)>config mediation snmp (Dub) config mediation snmp>point-template ifEntryDef (Dub) config mediation snmp point-template ifEntryDef>description Entry in ifTable(Dub) config mediation snmp point-template ifEntryDef>poll-oid .1.3.6.1.2.1.2.2.1.8.$(ifIndex)(Dub) config mediation snmp point-template ifEntryDef>state up(Dub) config mediation snmp point-template ifEntryDef state up>poll value 1(Dub) config mediation snmp point-template ifEntryDef state up>trap-oid .1.3.6.1.6.3.1.1.5.4(Dub) config mediation snmp point-template ifEntryDef state up>varbind-match .1.3.6.1.2.1.2.2.1.1 $(ifIndex)(Dub) config mediation snmp point-template ifEntryDef state up>severity normal(Dub) config mediation snmp point-template ifEntryDef state up

>message $(point) is up(Dub) config mediation snmp point-template ifEntryDef>state down(Dub) config mediation snmp point-template ifEntryDef state up>poll value 2(Dub) config mediation snmp point-template ifEntryDef state down>trap-oid .1.3.6.1.6.3.1.1.5.4(Dub) config mediation snmp point-template ifEntryDef state down>varbind-match .1.3.6.1.2.1.2.2.1.1 $(ifIndex)(Dub) config mediation snmp point-template ifEntryDef state down>severity major(Dub) config mediation snmp point-template ifEntryDef state up>message $(point) is down(Dub)>

WESTELL.COM

1-800-377-8766

Page 2-179


This example defines the message Interface is offline and the critical severity for the offline state on a point template:






debug mediation


show mediation

(Dub)>config mediation snmp point-template ifEntry(Dub) config mediation snmp point-template ifEntry>offline-message Interface is offline(Dub) config mediation snmp point-template ifEntry>

(Dub) config mediation snmp point-template ifEntry>offline-state critical(Dub) config mediation snmp point-template ifEntry>

WESTELL.COM

Page 2-180

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation snmpne


DescriptionThis command configures mediation SNMP network elements (NEs). The name of the NE is used in the name of the alarm table entry and can be substituted in the message text.

Formatsconfig mediation snmpne name

category categoryconnectivity-oid oiddefault [ connectivity-oid | host ]description descriptionevent event_name template [ { param param_value } ... ]host ip_addr [ port [ community [ { v1 | v2 } ] ] ]measurement measurement_name template [ { param param_value }

... ]measurement-poll-interval measurement_intervalne-name ne-namepoint point_name template [ { param param_value } ... ]point-poll-interval point_intervaltemplate reference_name template [ { param param_value } ... ]

For deleting mediation SNMP network elements:config mediation no snmpne { name | * }

Parameters

* Specifies all SNMP network elements.

category Configures the category for a mediation SNMP NE. The following parameter is accepted:

category—Specifies a category name for the SNMP NE.

description This command configures a textual description for an SNMP NE. The following parameter is accepted:

description—Specifies a description for the SNMP NE. Valid values are alphanumeric characters.

WESTELL.COM

1-800-377-8766

Page 2-181


connectivity-oid

This command configures the OID used to poll for connectivity to the SNMP NE. If no OID is configured, the NE is not polled for connectivity. The following parameter is accepted:

oid—The OID which is used to poll the device for connectivity. The default is .1.3.6.1.2.1.1.2.0, which is the standard sysObjectID MIB variable.

default Resets a mediation SNMP network element option to its default value.

event Configures an event for a mediation SNMP NE and the SNMP notification mediation response for the event. The following parameters are accepted: event_name—The name of the event on the mediation

SNMP NE. Valid values are alphanumeric characters. template—The name of a configured event template which

defines the event. param—The name of a replaceable parameter in the point

template. Valid values are alphanumeric characters. param_value—The value of a named replaceable

parameter in the point template.

host Configures the SNMP options for the proxied NE. The port, community string and SNMP version options are used for polling the NE. At a minimum, the IP address must be configured. The following parameters are accepted: ip_addr—The IP address of the proxied network element.

The default value is 0.0.0.0. port —The port on the proxied network element which is

used for polling. The default port is 161. community—The SNMP community string which is used for

polling. The default value is public. v1 —Specifies that SNMP version 1 is used for polling. v2 —Specifies that SNMP version 2 is used for polling. This

is the default SNMP version.

WESTELL.COM

Page 2-182

1-800-377-8766


measurement Configures a measurement for a mediation SNMP NE. The following parameters are accepted: measurement_name—The name of the measurement on the

mediation SNMP NE. Valid values are alphanumeric characters.

template—The name of a configured measurement template which defines the measurement.

param—The name of a replaceable parameter in the measurement template. Valid values are alphanumeric characters.

param_value—The value of a named replaceable parameter in the measurement template.

measurement-poll-interval

Configures the interval to wait when polling the NE for the current value of a measurement. The following parameter is accepted:

measurement_interval—The measurement polling interval (in seconds). Valid values are 10 to 86400. The default value is 60.

name Configures the name of the mediation SNMP NE. Valid values are alphanumeric characters.

ne-name Configures the network element name for a mediation SNMP NE. The following parameter is accepted:

ne_name—The network element name of the mediation SNMP NE.


point Configures a status point on a mediation SNMP NE. The following parameters are accepted: point_name—The name of the point on the mediation

SNMP NE. Valid values are alphanumeric characters. template—The name of a configured point template which

defines the point. param —The name of a replaceable parameter in the point

template. Valid values are alphanumeric characters. param_value—The value of a named replaceable

parameter in the point template.

point-poll-interval

Configures the interval to wait when polling an NE for the current value of a point. The following parameter is accepted:

point_interval—The point polling interval (in seconds). Valid values are 60 to 86400. The default value is 3600.

WESTELL.COM

1-800-377-8766

Page 2-183



ExamplesThe following mediation SNMP NE settings are configured:

SNMP NE name MyNE Description My proxied NE Category reboot event NE name MyNE Host with IP address 10.40.65.90, port 16, community administrator and

version v1 Event name reboot and template coldStart Point ethernet1, template ifEntry, parameter ifIndex and parameter

value 1.

template Configures an SNMP NE by referring to an existing NE template. The following parameters are accepted: reference_name—A unique name that identifies this

particular reference to the NE template. Valid values are alphanumeric characters.

template—The name of a configured template which defines parameters for this type of network element.

param —The name of a replaceable parameter in the NE template. Valid values are alphanumeric characters.

param_value—The value of a named replaceable parameter in the NE template.

(Dub)>config(Dub) config mediation snmpne MyNE(Dub) config mediation snmpne MyNE>description My proxied NE(Dub) config mediation snmpne MyNE>category reboot event(Dub) config mediation snmpne MyNE>ne-name MyNE(Dub) config mediation snmpne MyNE>host 10.40.65.90 161 administrator v1(Dub) config mediation snmpne MyNE>event reboot coldstart(Dub) config mediation snmpne MyNE>point ethernet1 ifEntry ifIndex 1>(Dub)>

WESTELL.COM

Page 2-184

1-800-377-8766


The following mediation SNMP NE settings are configured:

SNMP NE name YourNE Category SampleCategory Host with IP address 10.44.57.30, port 161, community administrator and

version v1 Measurement name newMeasurement, template myMeasTmpl, parameter

ifIndex with a value of 10 Measurement polling interval of 120 seconds.

See Also config mediation snmp event-template





debug mediation


show mediation

(Dub)>config(Dub) config>mediation snmpne YourNE(Dub) config mediation snmpne YourNE->host 10.44.57.30 161 administrator v1(Dub) config mediation snmpne YourNE->measurement newMeasurement myMeasTmpl ifIndex 10(Dub) config mediation snmpne YourNE->category SampleCategory(Dub) config mediation snmpne YourNE->measurement-poll-interval 120(Dub) config mediation snmpne YourNE(Dub)>

WESTELL.COM

1-800-377-8766

Page 2-185

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation tacacs-service

config mediation tacacs-service

DescriptionThis command configures the name of the service that is passed to a TACACS+ server when authenticating users for mediation. The value is used only if TACACS+ is configured as the RAS option for the device. A value of shell may be used to match the service passed during normal CLI authentication.

Formatsconfig mediation tacacs-service service

config mediation default tacacs-service

Parameters

Command DefaultsThe default service name is aimediation.

Required User Profilessupervisor

ExamplesThis example configures the TACACS+ service name to shell.

This example configures the default TACACS+ service name to aimediation.

See Alsoshow mediation

default Resets the service to the default value, aimediation.

service Configures the name of the TACACS+ service used for mediation authentication.

(Dub)>config(Dub) config>mediation tacacs-service(Dub) config mediation tacacs-service>service shell(Dub)>

(Dub)>config(Dub) config>mediation default tacacs-service(Dub)>

WESTELL.COM

Page 2-186

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation tl1command

config mediation tl1command

DescriptionThis command configures a TL1 command pattern that generates a system event. The user can specify that when a particular command is received, a mediation event will be generated. The event can then be paired with a response by using the command config action on page 2-4.

Formatsconfig mediation tl1command name command_pattern tid aid

config mediation no tl1command { name | * }

Parameters

Command Defaults

* Selects all TL1 commands for deletion from the system.

aid Defines the access identifier (AID) to match with incoming TL1 commands. The AID identifies a subcomponent (similar to a port number) for an NE. The maximum length is 32 characters.

command_pattern Defines the TL1 command pattern used to match incoming TL1 commands. TL1 commands are delivered through a communication path to a virtual NE. The maximum length is 32 characters.

Note: The command pattern should be a valid TL1

command code (for example, opr-ext-cont). Common TL1 command codes are documented in Telcordia GR 833-CORE.

name Defines the name associated with the TL1 command pattern. This name can be used by the action/response subsystem to trigger specific actions. The maximum length is 20 characters.

no Initiates the deletion of a TL1 command or all TL1 commands from the system.

tid Defines the target identifier (TID) to match with incoming TL1 commands. The TID acts as an application level address (similar to an IP address) for an NE. The maximum length is 20 characters.

WESTELL.COM

1-800-377-8766

Page 2-187

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation tl1command

No TL1 commands configured


ExamplesThis example displays the configuration of a TL1 command with the following values:

Command name relrelay2 Command pattern rls-ext-cont TID colne1 AID point2.

This example displays the deletion of TL1 command relrelay2.

This example displays the deletion of all configured TL1 commands.

See Alsoconfig mediation tl1mux

config mediation tl1ne

show mediation

(Dub)>config(Dub) config>mediation(Dub) config mediation>tl1command relrelay2 rls-ext-cont colne1 point2(Dub) config mediation>

(Dub)>config(Dub) config>mediation(Dub) config mediation>no tl1command relrelay2(Dub) config mediation>

(Dub)>config(Dub) config>mediation(Dub) config mediation>no tl1command *(Dub) config mediation>

WESTELL.COM

Page 2-188

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation tl1mux

config mediation tl1mux

DescriptionThis command configures, enables, or disables a TL1 multiplexer. A TL1 multiplexer provides connectivity to multiple TL1 NEs (both virtual and real devices). The TL1 multiplexer uses the TID in TL1 commands to demultiplex the commands from the TCP connection to a management system. The TL1 commands are then distributed to the target NEs.

Formatsconfig mediation tl1mux mux_id

conn { asyncid-tid | ip_address:port-tid | tl1neid }disableenableno conn { asyncid-tid | ip_address:port-tid | tl1neid | * }

For deleting TL1 multiplexers:config mediation no tl1mux { mux_id | * }

Parameters

* Specifies all parameters.

conn Configures a connection string for a TL1 multiplexer. A connection string connects a multiplexer to a virtual or real network device. A maximum of 16 connection strings can be configured for a TL1 multiplexer. The following parameters are accepted to make up the connection string: async—Specifies a connection where external NEs are connected

by way of an asynchronous port. id—Defines the identifiers for asynchronous and TL1 NE

connections. When id is used with parameter async, it identifies a serial port. When id is used with parameter tl1ne, it identifies a virtual NE. Valid values are 1 to 20.

ip_address—Defines the IP address for the device at the end of the connection.

port—Defines the port number for the device at the end of the connection.

tid—Defines the target identifier for the connection. The target identifier acts as an application level address for an NE.

tl1ne—Specifies a connection to an internal virtual NE.

disable Disables a TL1 multiplexer. TL1 multiplexers 2 through 4 are disabled by default.

WESTELL.COM

1-800-377-8766

Page 2-189

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation tl1mux

Command DefaultsOne TL1 multiplexer is configured by default


ExamplesThis example displays the configuration of TL1 multiplexer 4 with connection string async2-asy2. TL1 multiplexer 4 is then enabled.

See Alsoconfig mediation tl1command


show mediation

enable Enables a TL1 multiplexer. TL1 multiplexer 1 is enabled by default.

mux_id Defines the ID of the TL1 multiplexer being added or deleted. Valid values are 1 to 4. TL1 multiplexer 1 is configured by default.


(Dub)>config(Dub) config>mediation(Dub) config mediation>tl1mux 4(Dub) config mediation tl1mux-4->conn async2-asy2(Dub) config mediation tl1mux-4->enable(Dub) config mediation tl1mux-4->

WESTELL.COM

Page 2-190

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config mediation tl1ne


DescriptionThis command configures a virtual TL1 NE and its associated settings. Virtual TL1 NE 1 is enabled by default.

Formatsconfig mediation tl1ne ne_id

automsgs { logon | nologon }description textdisableenableno { description | user { uid | * }rtrvhdr { logon | nologon }tid tid_stringuser uid pid

For deleting virtual TL1 NEs:config mediation no tl1ne [ ne_id | * ]

Parameters

* Specifies all parameters.

automsgs Configures the logon requirement for a Remote RMX-3200 TL1 session when it receives autonomous messages from a virtual TL1 NE. The following parameters are accepted: logon—Specifies that a management system must logon to a

virtual TL1 NE for Remote RMX-3200 to send autonomous messages to the management system. This is the default requirement for sending autonomous messages.

nologon—Specifies that a management system does not need to logon to a virtual TL1 NE for Remote RMX-3200 to send autonomous messages to the management system.

description Configures a text description for a virtual TL1 NE. The following parameter is accepted:

text—Defines a description for a virtual TL1 NE.

disable Disables a virtual TL1 NE. TL1 NEs 2 through 20 are disabled by default.

enable Enables a virtual TL1 NE. TL1 NE 1 is enabled by default.

WESTELL.COM

1-800-377-8766

Page 2-191



ne_id Defines the ID of the virtual TL1 NE. Valid values are 1 to 20.


rtrvhdr Configures the TL1 logon requirement for execution of the rtrv-hdr command. The following parameters are accepted: logon—Specifies that unless a user is logged into the virtual

TL1 NE, Remote RMX-3200 will not respond to received rtrv-hdr commands. This is the default setting for receiving rtrv-hdr commands.

nologon—Specifies that even if no user is logged into the virtual TL1 NE, Remote RMX-3200 will respond to received rtrv-hdr commands.

tid Configures the TID for a virtual TL1 NE. A TID is a target identifier used within TL1 commands to reference a specific TL1 device. The following parameter is accepted:

tid_string—Defines the text used to identify a specific TL1 device. The maximum length is 20 alphanumeric characters. By default, TID Remote is configured for TL1 NE 1.

user Configures a username and password for a virtual TL1 NE. A maximum of four users can be configured for a virtual TL1 NE. The following parameters are accepted: uid—Defines the user identifier for TL1 device security. The

maximum length is 10 alphanumeric characters. By default, UID ai is configured for TL1 NE 1.

pid—Defines the password identifier. The maximum length is 10 alphanumeric characters. By default, PID ai is configured for TL1 NE 1.

WESTELL.COM

Page 2-192

1-800-377-8766


ExamplesThe following settings are configured for virtual TL1 NE tl1ne-4:

Description Virtual TL1 NE 4 Required logon for sending autonomous messages to the management

system No required logon for responding to received rtrv-hdr commands TID DUBLINAINE UID timmy12 and PID hilltop Enabled virtual TL1 NE 4.

See Alsoconfig mediation tl1command


show mediation

(Dub)>config(Dub) config>mediation(Dub) config mediation>tl1ne 4(Dub) config mediation tl1ne-4->description Virtual TL1 NE 4(Dub) config mediation tl1ne-4->automsgs logon(Dub) config mediation tl1ne-4->rtrvhdr nologon(Dub) config mediation tl1ne-4->tid DUBLINAINE(Dub) config mediation tl1ne-4->user timmy12 hilltop(Dub) config mediation tl1ne-4->enable(Dub) config mediation tl1ne-4->

WESTELL.COM

1-800-377-8766

Page 2-193

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config ntp

config ntp

DescriptionThese commands configure NTP settings for Remote RMX-3200. NTP maintains a common clock time among hosts within a network.

Formatsconfig ntp

default poll-intervaldisableenablepoll-interval min_poll max_pollserver ip_address [ prefer ]

For deleting NTP servers:config ntp no server { ip_address | * }

Parameters

* Specifies all NTP servers.

default Resets the poll interval to its default value.

poll-interval

Configures the minimum and maximum intervals for NTP polling. Polling enables hosts on a network to individually contact and communicate with the server. The polling intervals specify the time frame each host on a network has to connect to the NTP server to retrieve and transmit data. The following parameters are accepted: min_poll—Defines the minimum time frame limit that a host

on a network has to receive and transmit data. Enter x where x is 2x. For example, entering 4 specifies that the minimum interval is set to 16 seconds. The valid range is 4 (16 seconds) to 16 (65,536 seconds). The default is 6 (64 seconds).

max_poll—Defines the maximum time frame limit that a host on a network has to receive and transmit data. Enter x where x is 2x. For example, entering 5 specifies that the maximum interval is set to 32 seconds. The valid range is 5 (32 seconds) to 17 (131,072 seconds). The default maximum poll interval is 10 (1024 seconds).Important: The value for the maximum polling interval must

always be greater than the value for the minimum polling interval.

WESTELL.COM

Page 2-194

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config ntp


ExamplesThe following NTP settings are configured:

Minimum poll interval 4 (16 seconds) Maximum poll interval 9 (512 seconds) NTP server 12.99.23.4 Enabled NTP

See Also show ntp

disable Disables NTP for Remote RMX-3200.

enable Enables NTP for Remote RMX-3200.Important: When NTP is initially enabled, the clock for Remote

RMX-3200 is adjusted. After the initial adjustment, if the clock skew exceeds 1000 seconds, NTP is disabled.

no Deletes the specified NTP server or all NTP servers.

server Configures preferred and secondary NTP servers. An NTP server maintains a common clock time among hosts in a network.

Note: The first server configured becomes the preferred server

and the second server configured becomes the secondary server, unless you indicated otherwise by entering prefer.

The following parameters are accepted: ip_address—Defines the IP address for an NTP server. prefer—Sets the specified IP address as the preferred

server.

(Dub)>config(Dub) config>ntp(Dub) config ntp>poll-interval 4 9(Dub) config ntp>server 12.99.23.4(Dub) config ntp>enable(Dub) config ntp>

WESTELL.COM

1-800-377-8766

Page 2-195

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config peripheral

config peripheral

DescriptionThis command configures a peripheral unit or resets a peripheral unit to its default settings. Currently available peripheral units include Expand D, RME-S8, RME-E8, RME-B64, RMB-1 and RMB-2. These units allow users to add discrete inputs, analog inputs, asynchronous serial ports, relay outputs and a four-terminal SiteBus to Remote RMX-3200. While managed through Remote RMX-3200, users will never connect directly to peripheral units. Instead, all user contact with peripheral units takes place through the Remote RMX-3200.

Formatsconfig peripheral unit

description textmanage nameno { description | manage }type type

For resetting the unit:config default peripheral unit

Parameters

default Resets a peripheral unit to its default values, which causes it to become unmanaged. When a unit becomes unmanaged, all device configuration information that references the unit is removed. This includes events, responses, point configuration and central alarm table entries.

description Configures a description for a peripheral unit. The following parameter is accepted:

text—Defines the description for the peripheral unit. The maximum length is 128 characters.

WESTELL.COM

Page 2-196

1-800-377-8766


Command DefaultsNo peripheral units configured

manage Configures an association between a discovered peripheral and a unit number on Remote RMX-3200. If the unit has no assigned type, this command will let you associate it with any unmanaged peripheral and will assume the type of that peripheral. If the peripheral unit has an assigned type, this command will only let you associate it with an unmanaged peripheral that has a matching type. The following parameter is accepted:

name—Selects the name of a managed peripheral unit. This name consists of a series of letters followed by six hexadecimal digits representing the low order three bytes (the unique part) of the peripheral unit’s MAC address. Names are formatted as follows, where each X represents a hexadecimal digit: DEP-XXXXXX for Expand D units FB64-XXXXXX for RME-B64 units FE8-XXXXXX for RME-E8 units SER8-XXXXXX for RME-S8 units RMB1-XXXXXX for RMB-1 and RMB-2 units


type Configures the peripheral type for the specified unit. If a unit’s peripheral type is changed, all configuration on the peripheral device gets deleted and the device becomes unmanaged.

Note: To remove the peripheral type configuration, reset the

peripheral unit to its default values with command config default peripheral.

The following parameter is accepted:type—Defines a supported peripheral type. Supported types include the following: discrete-expansion for Expand D units RME-B64 for RME-B64 units RME-E8 for RME-E8 units RME-S8 for RME-S8 units RMB-1 for RMB-1 and RMB-2 units


WESTELL.COM

1-800-377-8766

Page 2-197



ExamplesThe following settings are configured for peripheral unit 3:

Description Alarm control panel first floor Managed Expand D DEP-012ABC Type discrete-expansion.

See Alsodiag peripheral reload

show peripherals

(Dub)>config(Dub) config>peripheral 3(Dub) config peripheral 3>description Alarm control panel first floor (Dub) config peripheral 3>manage DEP-012ABC(Dub) config peripheral 3>type discrete-expansion(Dub) config peripheral 3>

WESTELL.COM

Page 2-198

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config pkgs install

config pkgs install

DescriptionThese commands configure package installation settings.

Formatsconfig pkgs install

all [ fromserver ]name package [ min_version ] [ fromserver ]referenced [ fromserver ]

Parameters

all Installs all available script packages on to Remote RMX-3200. The following characteristics apply: The highest script package versions found are installed from the

Remote RMX-3200 /pkgstage staging area or from the central FTP package server, whichever one is specified.

Tip: The staging area is the /pkgstage directory on Remote RMX-3200 that stores package files to be installed. Files must be downloaded to the staging area before they can be used in the CLI unless fromserver is specified.

A package will not be installed if the highest available version level is lower than the currently installed version level.

Packages can be downgraded to a lower version after they have been manually uninstalled.

The following parameter is accepted:fromserver—Specifies the configured server as the location from which the package or packages will be installed. Specify fromserver only if Remote RMX-3200 is configured with an FTP server.

Tip: If fromserver is specified, Remote RMX-3200 will only check the FTP server for available packages. Likewise, if fromserver is not specified, Remote RMX-3200 will check only the staging area for available packages.

WESTELL.COM

1-800-377-8766

Page 2-199


name Installs an individual script package on to Remote RMX-3200. The following characteristics apply: The highest script package version found is installed from the

Remote RMX-3200 staging area or from the configured FTP server, whichever is specified.

Remote RMX-3200 installs the file that matches format package-nn.nn.nn.pkg. If no file in this format exists, Remote RMX-3200 searches for one in format package.pkg.


If the highest available package version level is less than the minimum specified version level, then the package will not be installed.


A package can be downgraded to a lower version after it has been manually uninstalled.

The following parameters are accepted: package—Defines the name of the package that will be

installed. min_version—Defines the minimum acceptable version level

for an installed package. fromserver—Specifies the configured server as the location

from which the package or packages will be installed. Specify fromserver only if Remote RMX-3200 is configured with an FTP server.


WESTELL.COM

Page 2-200

1-800-377-8766



referenced Installs the highest available versions of missing script packages referenced by a job or group of jobs. The following characteristics apply: The highest script package versions found are installed from the

Remote RMX-3200 staging area or from the configured FTP server, whichever is specified.




Packages can be downgraded to a lower version after they have been manually uninstalled.

The following parameter is accepted: fromserver—Specifies the configured server as the location

from which the package or packages will be installed. Specify fromserver only if Remote RMX-3200 is configured with an FTP server.


WESTELL.COM

1-800-377-8766

Page 2-201


ExamplesThis example displays the installation of all available packages from the configured central package FTP server.

This example displays the installation of script package testi from the configured FTP server. The minimum acceptable version level for the package is 1.1.2.

This example displays the installation of all packages referenced by configured jobs.

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>install(Dub) config pkgs install->all fromserverPackage pkgtestutils, version 1.0.0 installedPackage testa, version 1.3.0 installedPackage testb, version 2.2.0 installedPackage testimpa, version 1.0.0 installedPackage testimpb, version 2.1.0 installedPackage testimpc, version 1.2.0 installedPackage testimpd, version 2.1.1 installedPackage testimpe, version 2.0.0 installedPackage testp, version 1.0.0 installedPackage testq, version 1.0.0 installedPackage testr, version 1.0.0 installed(Dub) config pkgs install->

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>install(Dub) config pkgs install->name testi 1.1.2 fromserverPackage testi, version 2.0.1 installed.(Dub) config pkgs install->

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>install(Dub) config pkgs install->referenced fromserverPackage testi, version 2.0.1 installedPackage testg, version 1.0.0 installedPackage testj, version 2.0.1 installed(Dub) config pkgs install->

WESTELL.COM

Page 2-202

1-800-377-8766


See Also config pkgs on-demand-install

config pkgs server

config pkgs uninstall

show pkgs

WESTELL.COM

1-800-377-8766

Page 2-203

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config pkgs on-demand-install

config pkgs on-demand-install

DescriptionThis command enables the automatic installation of missing packages for a job at the time the job runs. Missing packages are those that are uninstalled and required by a running job. The following characteristics apply:

The highest script package versions found are installed from the Remote RMX-3200 staging area or from the configured central FTP package server (if it is configured).



Tip: If the package server is configured and enabled, Remote RMX-3200 will only check the central FTP package server for available packages. Likewise, if the server is not configured, Remote RMX-3200 will only check the staging area for available packages.

Packages that do not meet the minimum required version level for a job will not be installed.

Formatsconfig pkgs on-demand-install

config pkgs no on-demand-install

Parameters

Command DefaultsDisabled


no Disables on demand install.

WESTELL.COM

Page 2-204

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config pkgs on-demand-install

ExamplesThis example displays the enabling of on demand install.

This example displays the disabling of on demand install.

See Also config pkgs install

config pkgs server


show pkgs

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>on-demand-install(Dub) config pkgs>

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>no on-demand-install(Dub) config pkgs>

WESTELL.COM

1-800-377-8766

Page 2-205

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config pkgs server

config pkgs server

DescriptionThis command configures the IP address of the central package FTP server, which Remote RMX-3200 will use to install script packages onto the staging area of the card.

Formatsconfig pkgs server

address ip_address [ port ]default { directory | user }directory directorydisableenableuser username password

For deleting the server:config pkgs no server

Parameters

address Configures the IP address of the central package FTP server, which Remote RMX-3200 will use to install script packages onto the staging area of the card. The following parameters are accepted: ip_address—Defines the IP address of the central package

FTP server. port—Defines the port number of the central package FTP

server. Valid values are 1 to 65535. The default port number is 21.

default Resets the specified parameter to its default value.

directory Configures Remote RMX-3200 to use the directory on the central package FTP server that contains script packages. The default directory is /. The following parameter is accepted:

directory—Defines the directory on the central package FTP server that contains the script packages.

disable Disables remote FTP access.

enable Enables remote FTP access.

WESTELL.COM

Page 2-206

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config pkgs server


ExamplesThe following settings are configured for the central package FTP server:

IP address 10.50.13.12 Port number 50 Directory /remote/packages Username test Password test Central package FTP server enabled.

See Alsoconfig pkgs install



show pkgs

user Configures Remote RMX-3200 to use the user name and password configured on the central FTP package server for server access. The following parameters are accepted: username—Defines the user name configured on the central

FTP package server. The default user name is anonymous. password—Defines the password configured on the central FTP

package server. The default password is script@ai.

no Deletes Remote RMX-3200’s IP configuration for the central FTP package server and resets the user name, password and directory to the default values.

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>server(Dub) config pkgs server->address 10.50.13.12 50(Dub) config pkgs server->directory /remote/packages

(Dub) config pkgs server->user test test(Dub) config pkgs server->enable(Dub) config pkgs server->

WESTELL.COM

1-800-377-8766

Page 2-207

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config pkgs uninstall


DescriptionThis command uninstalls a specified package or all packages. Remote RMX-3200 will uninstall a package even if that package is referred to by non-running jobs. However, it will not uninstall a package referred to by one or more running jobs.

Formatsconfig pkgs uninstall

allname package

Parameters


ExamplesThis example displays the uninstallation of package testg.

This example displays the uninstallation of all configured packages.

all Uninstalls all packages.

name Uninstalls a specified package. The following parameter is accepted:package—Defines the name of the package being uninstalled.

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>uninstall(Dub) config pkgs uninstall->name testgPackage testg uninstalled(Dub) config pkgs uninstall->

(Dub)>config(Dub) config>pkgs(Dub) config pkgs>uninstall allPackage jobtestutils uninstalled.Package testg uninstalled.Package testh uninstalled.Package testj uninstalled.(Dub) config pkgs>

WESTELL.COM

Page 2-208

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config pkgs uninstall


show pkgs

WESTELL.COM

1-800-377-8766

Page 2-209

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config profile

config profile

DescriptionThis command configures a user-defined command profile and adds or excludes commands for that profile.

Formatsconfig profile profile_name

copy { management | restricted | status | supervisor | user_defined }

exclude command_idinclude command_idno { exclude | include }priv-lvl level

For deleting a profile:config no profile profile_name

Parameters

copy Copies one profile and all its associated commands to another profile. The following parameters are accepted: management—Copies the management-level profile. restricted—Copies the restricted-level profile. status—Copies the status-level profile. supervisor—Copies the supervisor-level profile. user_defined—Copies a user-defined profile.

exclude Excludes a command from a user-defined profile. The following parameter is accepted:

command_id—Defines the ID of the command to be excluded from the profile. The ID is checked against the supervisor command tree to ensure that it is valid. For a list of all available command IDs, refer to Appendix : Command Identifications.

include Includes a command in a user-defined profile. The following parameter is accepted:

command_id—Defines the ID of the command to be included in the profile. The ID is checked against the supervisor command tree to ensure that it is valid. For a list of all available command IDs, refer to Appendix : Command Identifications.

WESTELL.COM

Page 2-210

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config profile


ExamplesThe following settings are configured for profile SuperStatus:

Included command sets /config/controller/eth and /config/interface/eth

Copied profile status Privilege level 3

See Alsoshow profiles


priv-lvl Configures the privilege level for a profile. The privilege level is used when RAS mode authorization is set to priv-lvl. The RAS server returns a privilege level to Remote RMX-3200 that is matched with the correct profile. management is the default level for profiles with no configured privilege level. You can assign only one profile to each privilege level. The following parameter is accepted:

level—Defines the privilege level. Valid values are 2 to 14 for user-defined privilege levels. System privilege levels are: 0 is for status 1 is for management 15 is for supervisor

profile_name Defines the new profile name.

(Dub)>config(Dub) config>profile SuperStatus(Dub) config profile SuperStatus>include /config/controller/eth(Dub) config profile SuperStatus>include /config/interface/eth

(Dub) config profile SuperStatus>copy status(Dub) config profile SuperStatus>priv-lvl 3(Dub) config profile SuperStatus>

WESTELL.COM

1-800-377-8766

Page 2-211

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config ras

config ras

DescriptionThis command configures RAS settings for Remote RMX-3200. RAS provides user authentication and authorization for remote access into a network.

Formatsconfig ras

accounting { disable | enable }authorization { command | privilege }default { retry | timeout }no shellretry countshell { radius | tacacs+ } [ fallback ]timeout seconds

Parameters

accounting Configures TACACS+ accounting of user login events and shell command events. An accounting start packet or stop packet is issued each time a user logs into or out of Remote RMX-3200. An accounting start packet is also issued for each shell command that is run. The following parameters are accepted: disable—Disables TACACS+ accounting. enable—Enables TACACS+ accounting.

authorization Configures TACACS+ authorization for Remote RMX-3200 command shell access. The following parameters are accepted: command—Configures the TACACS+ authorization method

that requires Remote RMX-3200 to contact the TACACS+ server for each shell command run by a user. Individual commands are then allowed or denied.

privilege—Configures the TACACS+ authorization method based on the privilege returned from the TACACS+ server.



WESTELL.COM

Page 2-212

1-800-377-8766



retry Configures the number of consecutive connection attempts that are made to a TACACS+ server before the attempt fails.

Note: Consecutive attempts are made only if the TACACS+

server responds but refuses a connection. If no response is received from a TACACS+ server before the configured timeout period, then no further connection attempts are made.

The following parameters are accepted:count—Defines the number of consecutive connection attempts that are made. Valid values are 1 to 100.

shell Configures the type of remote user authentication server. Remote RMX-3200 provides either RADIUS or TACACS+ support for the RAS server configurations. Remote user server authentication will take effect only if the RAS servers have been configured properly. The following parameters are accepted: fallback—Allows local authentication in case attempts to

contact the servers fail. radius—Sets RADIUS as the RAS server type.

Note: If a user changes the server authentication to

RADIUS from TACACS+ and the server is configured without a port, the port number will automatically be changed to 1812.

tacacs—Sets TACACS+ as the RAS server type.

Note: If a user changes the server authentication to

TACACS+ from RADIUS and the server is configured without a port, the port number will automatically be changed to 49.

timeout Configures the fallback timeout period. This is the amount of time that the device waits for a response from the RAS servers before falling back on local authentication. The following parameter is accepted:

seconds—Defines the number of seconds that the device waits for a response from the RAS servers.

WESTELL.COM

1-800-377-8766

Page 2-213


ExamplesThe following RAS settings are configured:

Enabled RAS accounting Command-level authorization 5 connection retry attempts RAS server type TACACS+ with fallback enabled 10 second timeout.

config ras server

DescriptionThis command configures a preferred and secondary RAS server for Remote RMX-3200. A RAS server is a device that provides user authentication and authorization for remote access into the network using either the RADIUS or TACACS+ protocol.

Formatsconfig ras server ip_address

default phasephase { [ accounting ] [ authentication ] [ authorization ] }port portsecret secret

For deleting a server:config ras no server { ip_address | * }

Parameters

(Dub)>config(Dub) config>ras(Dub) config ras>accounting enable(Dub) config ras>authorization command(Dub) config ras>retry 5(Dub) config ras>shell tacacs+ fallback(Dub) config ras>timeout 10(Dub) config ras>

* Deletes all configured RAS servers from Remote RMX-3200.


WESTELL.COM

Page 2-214

1-800-377-8766


ip_address Defines the IP address for the preferred or secondary RAS server.

Note: The preferred RAS server is configured the first time the

user enters an IP address value. The secondary RAS server is configured the second time the user enters an IP address value. Existing preferred and secondary RAS server IP addresses must be deleted before new ones can be configured.

no Deletes a specified server or all servers.

phase Specifies the AAA phases handled by the TACACS+ server. By default, all phases are supported. The following parameters are accepted: accounting—Specifies that the TACACS+ server will handle

TACACS+ accounting of user login events and shell command events. An accounting start packet or stop packet is issued each time a user logs into or out of Remote RMX-3200. An accounting stop packet is also issued for each shell command that is run.

authentication—Specifies that the TACACS+ server will handle TACACS+ authentication for the Remote RMX-3200 command shell access.

authorization—Specifies that the TACACS+ server will handle the TACACS+ authorization for the Remote RMX-3200 shell. The authorization method can be either privilege level or per-command. Privilege level authorization is based on the privilege level returned from the TACACS+ server. Per-command authorization requires Remote RMX-3200 to contact the TACACS+ server for each shell command run by a user. Individual commands are then allowed or denied.

port Configures a server port for a RAS server. A RAS server is a device that provides user authentication and authorization for remote access into the network with either a RADIUS or TACACS+ protocol. The following parameter is accepted:

port—Defines the port number for the RAS server being configured. Valid values are 1 to 65,535.

secret Initiates the configuration of the RAS server password. The following parameter is accepted:

secret—Defines the RAS server password. Maximum length is 24 characters. The default secret is applied.

WESTELL.COM

1-800-377-8766

Page 2-215


Command DefaultsNo RAS servers configured


ExamplesThe following settings are configured for RAS server 10.50.18.32:

Phases accounting, authentication and authorization Port 4003 Secret mypassword.

This example displays the deletion of all configured RAS servers.

See Alsoshow ras

(Dub)>config(Dub) config>ras(Dub) config ras>server 10.50.18.32(Dub) config ras server 10.50.18.32->phase accounting authentication authorization(Dub) config ras server 10.50.18.32->port 4003(Dub) config ras server 10.50.18.32->secret mypassword(Dub) config ras server 10.50.18.32->

(Dub)>config(Dub) config>ras(Dub) config ras>no server *(Dub) config ras>

WESTELL.COM

Page 2-216

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config remote-access

config remote-access

DescriptionThis command configures the remote access protocol. The remote access protocol configures the method by which users are allowed to remotely log into Remote RMX-3200.

Formatsconfig remote-access

http { default port | disable | enable | port port }https { default port | disable | enable | port port }ssh-sftp { disable | enable }telnet-ftp { default port | disable | enable | port telnet_port

ftp_port }

Parameters

http Configures the HTTP remote access protocol for web browser access to the web server. The following parameters are accepted: default—Resets the port number to its default value. disable—Disables the remote access protocol. enable—Enables the remote access protocol. This protocol is

disabled by default. port—Configures the HTTP port number. This value defines the

TCP port number at which web browsers access the web server. port—Defines the port number for the HTTP server. Valid range

is 80 or 1024 to 65535. The default port number is 80.

https Configures the HTTPS remote access protocol for web browser access to the web server. The following parameters are accepted: default—Resets the port number to its default value (443). disable—Disables the remote access protocol. enable—Enables the remote access protocol. This protocol is

disabled by default. port—Configures the HTTPS port number. This value defines

the TCP port number at which web browsers access the web server.

port—Defines the port number for the HTTPS server. Valid range is 443 or 1024 to 65535. The default port number is 443.

WESTELL.COM

1-800-377-8766

Page 2-217



ExamplesThe following remote access protocol settings are configured:

Enabled SSH and SFTP Enabled Telnet and FTP with Telnet server port number 3001 and FTP server

port number 5001 HTTP port number 12450.

ssh-sftp Specifies SSH and SFTP remote access protocols. These protocols are disabled by default. The following parameters are accepted: disable—Disables the remote access protocol.

Note: The disable fails if there is no other enabled remote

access protocol.

enable—Enables the remote access protocol.

telnet-ftp

Specifies Telnet and FTP remote access protocols. These protocols are enabled by default. The following parameters are accepted: default—Resets the port number to its default value. disable—Disables the remote access protocol.

Note: The disable fails if there is no other enabled remote

access protocol.

enable—Enables the remote access protocol. port—Configures the Telnet and FTP port numbers. telnet_port—Defines the port number for the Telnet server.

Valid values are 23 or 1024 to 65535. ftp_port—Defines the port number for the FTP server. Valid

values are 21 or 1024 to 65535.

(Dub)>config(Dub) config>remote-access(Dub) config remote-access>ssh-sftp enable(Dub) config remote-access>telnet-ftp enable(Dub) config remote-access>telnet-ftp port 3001 5001(Dub) config remote-access>http port 12450(Dub) config remote-access>

WESTELL.COM

Page 2-218

1-800-377-8766


The following example enables HTTPS access to the default port (443).

This example displays the error that occurs if you attempt to disable the SSH and SFTP remote access protocols when no other remote access protocols are enabled.

See Alsoshow remote-access

(Dub)>config(Dub)>config remote-access (Dub) config remote-access> https enable(Dub) config remote-access https default port(Dub) config remote-access>

(Dub)>config(Dub) config>remote-access(Dub) config remote-access>ssh-sftp(Dub) config remote-access ssh-sftp->disable[REMM0002] At least one remote access protocol must be enabled at all times.(Dub) config remote-access ssh-sftp->

WESTELL.COM

1-800-377-8766

Page 2-219

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config response

config response

DescriptionThese commands

Configure a response

Delete a response

Delete all configured responses

Configure a description for a response

A response is an expression that defines a system action that occurs in response to a system event.

Formatsconfig response response_name


For deleting a response:config no response { response_name | * }

Parameters


ExamplesThis example displays the configuration of response doorOpenTl1Alm with description Door open TL1 alarm.

response_name Defines the name of the response being configured.

description Configures a description for a response. The following parameter is accepted:

text—Defines a description for a response.


* Deletes all configured responses.

WESTELL.COM

Page 2-220

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config response

See Alsoconfig response content

show responses

(Dub)>config(Dub) config>response doorOpenTl1Alm(Dub) config response doorOpenTl1Alm>description Door open TL1 alarm(Dub) config response doorOpenTl1Alm>

WESTELL.COM

1-800-377-8766

Page 2-221

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config response content

config response content

DescriptionThese commands configure response content settings.

Formatsconfig response response_name content responder

close [ duration period ]critical [ message message_text ]disableenableinformational [ message message_text ]interval [ duration period ]latch-offlatch-onmomentarymajor [ message message_text ]minor [ message message_text ]normal [ message message_text ]open [ duration period ]restart-timerstop-timerwarning [ message message_text ]user.log

Parameters

close Configures a response that closes a relay output for a set length of time or until it is reopened with parameter open. Valid responder is output. The following parameters are accepted: duration—Specifies that the relay output will close for a set

length of time. period—Defines the length of time in seconds that Remote

RMX-3200 closes the relay output.

critical Updates the state of the alarm entry to critical. Valid responder is alarm-entry. The following parameters are accepted: message—Configures an alarm entry response and the

associated alarm message text. message_text—Defines the text that describes why the

alarm was activated. Maximum length is 128 characters.

WESTELL.COM

Page 2-222

1-800-377-8766


disable Configures a response that disables a Remote RMX-3200 system component. Valid responders are: analog ethernet input openvpn serial serial channel-group group tbos-port.

enable Configures a response that enables a Remote RMX-3200 system component. Valid responders are: analog ethernet input openvpn serial serial channel-group group tbos-port.

informational Updates the state of the alarm entry to informational. Valid responder is alarm-entry. The following parameters are accepted: message—Configures an alarm entry response and the



interval Configures an interval response for an associated responder, which processes the response. An interval response causes the responder to generate events that contain the current value of a sensor at a set time rate. Valid responder is analog.

latch-off Configures a response that drives a TBOS control point into an “off” state. Valid responder is tbos-control.

latch-on Configures a response that drives a TBOS control point into an “on” state. The TBOS protocol is used for transmitting alarm, status and control points between network elements and operating systems. TBOS defines one physical interface for direct connections between remote and monitored equipment. Valid responder is tbos-control.

WESTELL.COM

1-800-377-8766

Page 2-223


major Updates the state of the alarm entry to major. Valid responder is alarm-entry. The following parameters are accepted: message—Configures an alarm entry response and the



momentary Configures a response that puts a TBOS control point into an “on” state and then back into an “off” state. Valid responder is tbos-control.

minor Updates the state of the alarm entry to minor. Valid responder is alarm-entry. The following parameters are accepted: message—Configures an alarm entry response and the



normal Updates the state of the alarm entry to normal. Valid responder is alarm-entry. The following parameters are accepted: message—Configures an alarm entry response and the



open Configures a response that opens a relay output. Valid responder is output.

responder Defines the responder, which is the system component that processes the response. For more information on available responders for this command, refer to Table 9 on page 2-225.

response_name Defines the name of the response being configured. Maximum length is 128 characters.

restart-timer Configures a response that restarts a mediation timer when an event occurs. The response will restart a mediation timer that is currently running. If the named timer is not currently running, this response has no effect. Valid responder is timer.

stop-timer Configures a response that stops a mediation timer when an event occurs. Valid responder is timer.

timer-life Configures a response that specifies whether a mediation timer should disappear when it is finished running or start over when it is finished running. Valid responder is timer.

WESTELL.COM

Page 2-224

1-800-377-8766


user.log Configures a response that logs events to a two megabyte file named user.log. The primary purpose of event logging is to store analog values in a file for later analysis, but it can be used to log any events. File user.log can be retrieved with FTP for offline analysis. Valid responder is logfile.

warning Updates the state of the alarm entry to warning. Valid responder is alarm-entry. The following parameters are accepted: message—Configures an alarm entry response and the



Table 9 Valid Responders

Responder Description

alarm-entry instance

Defines a central alarm table entry as the system component that processes the response. Valid values for instance are names of existing central alarm table entries.

WESTELL.COM

1-800-377-8766

Page 2-225


analog instance

Specifies an analog input as the responder. Valid value for instance is:

unit/{ point | power | powerB | temperature | humidity }

unitDefines the peripheral unit number. Valid values are 0 to 12.





humiditySpecifies the humidity sensor on an RMB peripheral unit, which is an analog input that is dedicated to monitoring the ambient humidity.

ethernet instance

Specifies an Ethernet controller as the responder. Valid values for instance are Ethernet port values 1 to 8. Other values may be available for expansion peripheral units. For information about valid WAN Ethernet port values on some Remote RMX-3200 models, refer to Appendix : .

Table 9 Valid Responders (Continued)

Responder Description (Continued)

WESTELL.COM

Page 2-226

1-800-377-8766


input instance Specifies a digital input as the responder. Valid value for instance is:

unit/point unit


pointDefines the digital input point number for the unit. Valid values for on-board digital inputs are 1 to 64. Other values may be available for expansion peripheral units.

logfile Specifies the Remote RMX-3200 user log file as the responder.

openvpn instance

Specifies an OpenVPN controller as the responder. Valid values for instance are names of existing OpenVPN controllers.

output instance

Defines a relay output point number as the responder. Valid value for instance is:

unit/point unit


pointDefines the digital output point number within the unit. Valid values for on-board digital outputs are 1 to 4. Other values may be available for expansion peripheral units.

serial instance

Specifies a serial controller as the responder. Valid values for instance are: port

Defines the physical connector associated with the controller on Remote RMX-3200. Valid asynchronous port values are 1 to 8 for Remote RMX-3200. Other values may be available for expansion peripheral units. For information about valid WAN port values, refer to Appendix : .

serial instance channel-group group

Specifies a channel group on a serial controller as the responder. Valid value for instance is:

portDefines the physical connector associated with the controller on Remote RMX-3200. For information about valid WAN port values, refer to Appendix : .



WESTELL.COM

1-800-377-8766

Page 2-227



snmp instance Specifies the SNMP agent as the system component that processes a response. The SNMP control instance is entered in the following format:

trap category message ne-name category configures the name network element category

contained in the trap. message configures the text message contained in the trap. ne-name configures the network element name contained

in the trap.

tbos-control instance

Specifies a TBOS control point as the system component that processes the response. The TBOS control instance is entered in the following format:

serial port display_number point_number Valid values for port are 1 to 6 for Remote RMX-3200.

Other values may be available for expansion peripheral units.

Valid values for display_number are 1 to 8. Valid values for point_number are 1 to 64.

Note: For more information about the listed parameters, refer

to command config tbos port serial display point on page 2-273.

tbos-port instance

Specifies a TBOS port as the responder. Valid value for instance is:

serial port serial

Specifies port type serial. port

Defines the physical connector associated with the controller on Remote RMX-3200. Valid values are 1 to 6.

timer instance Defines a mediation timer as the system component that processes the response. Valid values for instance are any name the user wants to assign to the timer.



WESTELL.COM

Page 2-228

1-800-377-8766


ExamplesThis example displays the configuration of close response latchAlm for output 0/7.

This example displays the configuration of critical response waterLevel for alarm entry tbos_2_2_2.

This example displays the configuration of response momentaryLatch with TBOS control point responder tbos-control serial 2:2:2 in the momentary latch state.

(Dub)>config(Dub) config>response latchAlm(Dub) config response latchAlm>content(Dub) config response latchAlm content->output 0/7(Dub) config response latchAlm content output 0/7->close(Dub) config response latchAlm content output 0/7->

(Dub)>config(Dub) config>response waterLevel(Dub) config response waterLevel>content(Dub) config response waterLevel content->alarm-entry tbos_2_2_2(Dub) config response waterLevel content alarm-entry tbos_2_2_2->critical

(Dub)>config(Dub) config>response momentaryLatch(Dub) config response momentaryLatch>content(Dub) config response momentaryLatch content->tbos-control serial 2 2 2(Dub) config response momentaryLatch content tbos-control serial 2:2:2->momentary(Dub) config response momentaryLatch content tbos-control serial 2:2:2->

WESTELL.COM

1-800-377-8766

Page 2-229


This example displays the configuration of response timeStart for timer callAttempt. The timer runs once and then disappears.

config response content connect

DescriptionThese commands configure responses that create mediation connections between responders and destinations.

Formatsconfig response response_name content responder connect

breakdest destinationdest-data dest_textinactivity intervalno { dest | dest-data | inactivity | source-data |

suppress-inactivity-disc }options [ -b ] [ -l ]source-data source_data_textsuppress-inactivity-disc

Parameters

(Dub)>config(Dub) config>response timeStart(Dub) config response timeStart>content(Dub) config response timeStart content->timer callAttempt(Dub) config response timeStart content timer callAttempt->start-timer(Dub) config response timeStart content timer callAttempt start-timer->timer-life one-shot(Dub) config response timeStart content timer callAttempt start-timer->



WESTELL.COM

Page 2-230

1-800-377-8766


break Configures break propagation for a Telnet or SSH to asynchronous serial connection, which is defined by a connect response. When break propagation is configured, all break sequences received on incoming Telnet or SSH connections are passed through Remote RMX-3200 and then sent out a Remote RMX-3200 asynchronous serial port. In addition, all asynchronous break sequences received on Remote RMX-3200 asynchronous serial ports are translated to Telnet break sequences and then sent out on the Telnet connection.

dest Configures a destination for a mediation connection, which is defined by a connect response. The following parameter is accepted:

destination—Defines the destination that is the receiving end-point for the connection. For more information on available destinations, refer to Table 11 on page 2-234.

dest-data Configures a destination data string for a connect response. A destination data string is sent as data in the direction of the connection by the destination side of the connection. Its primary purpose is to provide a per-call modem dial string. The following parameter is accepted:

destination_text—Defines the text string that gets sent to the destination upon connection. There are no limitations on the printable characters that you can enter for this parameter.

Note: You can enter binary character values by

using the format %xx where xx is two hexadecimal digits representing the character's binary value. For example, %0d is a carriage return character and %0a is a linefeed character.

WESTELL.COM

1-800-377-8766

Page 2-231


inactivity Configures an inactivity timer for a mediation connection. The inactivity timer disconnects a mediation connection if no data is transmitted in either direction for a set length of time. The following parameter is accepted:

interval—Defines the length of time in seconds that a mediation connection must be inactive before it is disconnected. Valid values are 1 to 7200.

options Configures the data transmission mode for a Telnet connection, which is defined by a connect response. By default, no mode is defined. The client determines the mode through negotiations. The following parameters are accepted: -b—Specifies that data will be passed in 8-bit

format (binary mode). -l—Specifies that data will be passed one line

at a time (line mode).

source-data Configures a source data string for a connect response. The source data string is one that will be sent as data by the source side of the connection (the responder) in the opposite direction of the connection. This occurs when a connection response is received. The source data string’s primary use is to provide a per-call modem dial string. The following parameter is accepted:

source_data_text—Defines the text string that gets sent by the origin of the mediation connection. There are no limitations on the printable characters that you can enter for this parameter.

Note: You can enter binary character values by

using the format %xx where xx is two hexadecimal digits representing the character's binary value. For example, %0d is a carriage return character and %0a is a linefeed character.

WESTELL.COM

Page 2-232

1-800-377-8766


suppress-inactivity-disc

Prevents a mediation connection from disconnecting when the inactivity timer expires. If no inactivity interval is configured for the mediation connection, this command has no effect. By default, the mediation connection disconnects when the inactivity timer expires.




serial instance

Specifies an asynchronous serial controller system component that processes the response. Valid values for instance are asynchronous ports 1 to 8.

ssh instance Specifies a SSH connection as the system component that processes the response. The SSH instance is entered in the following format:

[ ip_address: ] portDefines the SSH port number and optional IP address for the SSH connection. Valid values for port are 1000 to 65535.

tcp instance Specifies a listening TCP port as the system component that processes the response. The TCP instance is entered in the following format:

[ ip_address: ] portDefines the TCP port number and optional IP address for the TCP connection. Valid values for port are 1000 to 65535.

telnet instance

Specifies a Telnet connection as the system component that processes the response. The Telnet instance is entered in the following format:

[ ip_address: ] portDefines the Telnet port number and optional IP address for the Telnet connection. Valid values for port are 1000 to 65535.

tl1mux instance

Specifies a TL1 multiplexer as the system component that processes the response. Valid values for instance are TL1 multiplexers 1 to 4.

WESTELL.COM

1-800-377-8766

Page 2-233



Table 11 Valid Destinations

Destination Description

script instance

Specifies a script as the receiving end-point for the connection. The script instance has the following format:

job_name listener job_name defines the name of an existing job in which the

script resides. listener defines the listener for incoming connections.

This name is defined by the job's script.

serial instance

Specifies an asynchronous serial controller as the receiving end-point for the connection. Valid values for instance are asynchronous ports 1 to 8 and wan/1.

tcp instance Specifies a listening TCP port as the receiving end-point for the connection. The TCP instance is entered in the following format:

[ ip_address: ] portValid values for port are 1 to 65535.

tl1mux instance

Specifies a TL1 multiplexer as the receiving end-point for the connection. Valid values for instance are TL1 multiplexers 1 to 4.

tl1ne instance Specifies a virtual TL1 NE as the receiving end-point for the connection. Valid values for instance are virtual TL1 NE IDs 1 to 20.

WESTELL.COM

Page 2-234

1-800-377-8766


ExamplesThe following settings are configured for response connResp:

Responder serial 1 Destination endpoint tl1mux 4 Destination data string ATDT 6145553410, which causes a Hayes-compatible

modem attached to serial port 1 to dial phone number 614-555-3410. 30 second disconnect inactivity time Source data string ATDT 6145554298, which causes a Hayes-compatible

modem attached to serial port 1 to dial the number 614-555-4298.

The following settings are configured for response telnetConnection:

Responder telnet 50001 Enabled break propagation Binary transmission mode No disconnect when the inactivity timer expires.

(Dub)>config(Dub) config>response connResp(Dub) config response connResp>content(Dub) config response connResp content->serial 1(Dub) config response connResp content serial 1->connect(Dub) config response connResp content serial 1 connect->dest tl1mux 4(Dub) config response connResp content serial 1 connect->dest-data ATDT 6145553410(Dub) config response connResp content serial 1 connect->inactivity 30(Dub) config response connResp content serial 1 connect->source-data ATDT 6145554298(Dub) config response connResp content serial 1 connect->

(Dub)>config(Dub) config>response telnetConnection(Dub) config response telnetConnection>content(Dub) config response telnetConnection content->telnet 50001(Dub) config response telnetConnection content telnet 50001->connect(Dub) config response telnetConnection content telnet 50001 connect->break(Dub) config response telnetConnection content telnet 50001 connect->options -b(Dub) config response telnetConnection content telnet 50001 connect->suppress-inactivity-disc(Dub) config response telnetConnection content telnet 50001 connect->

WESTELL.COM

1-800-377-8766

Page 2-235


config response content tl1alarm

DescriptionThese commands configure TL1 alarm settings for a TL1 alarm response. The alarm response is converted to a TL1 autonomous message by the destination virtual TL1 NE.

Formatsconfig response response_name content responder tl1alarm

almcde { CR | MJ | MN | NA }textblk texttl1msg message_text

Parameters

almcde Configures a TL1 alarm code for a TL1 alarm response. The following parameters are accepted: CR—Specifies a critical alarm condition. MJ—Specifies a major alarm condition. MN—Specifies a minor alarm condition. NA—Specifies a nonalarmed autonomous message.



textblk Configures a TL1 text block for a TL1 alarm response. The TL1 text block is a quoted text line in the response block of a TL1 autonomous message. The exact format of a TL1 text block varies based on the type of autonomous message being created.

Note: For more information about the exact TL1 text block

formats for different types of TL1 autonomous messages, refer to the Telcordia GR-833-CORE documentation.

The following parameter is accepted:text—Defines the TL1 text block that is used within a TL1 alarm.

WESTELL.COM

Page 2-236

1-800-377-8766



ExamplesThe following settings are configured for response doorOpenTl1Alm:

Responder tl1ne 2 TL1 alarm code cr (critical) Text block point1:CR,DOOR TL1 message string REPT ALM ENV.

tl1msg Configures a TL1 message string for a TL1 alarm response. A TL1 message string is a text string that indicates the report type within the TL1 alarm. Some examples are REPT ALM ENV, which represents an environmental alarm and REPT ALM EQPT, which represents an equipment alarm.

Note: For more information about available TL1 message

strings, refer to the Telcordia GR-833-CORE documentation.

The following parameter is accepted:message_text—Defines the message text for the TL1 alarm response.



tl1ne ne_id

Defines a virtual TL1 NE as the responder. Parameter ne_id defines the identifier for the virtual TL1 NE. Valid values are 1 to 20.

(Dub)>config(Dub) config>response doorOpenTl1Alm(Dub) config response doorOpenTl1Alm>content(Dub) config response doorOpenTl1Alm content->tl1ne 2(Dub) config response doorOpenTl1Alm content tl1ne 2->tl1alarm(Dub) config response doorOpenTl1Alm content tl1ne 2 tl1alarm->almcde cr(Dub) config response doorOpenTl1Alm content tl1ne 2 tl1alarm->textblk point1:CR,DOOR(Dub) config response doorOpenTl1Alm content tl1ne 2 tl1alarm->tl1msg REPT ALM ENV(Dub) config response doorOpenTl1Alm content tl1ne 2 tl1alarm->

WESTELL.COM

1-800-377-8766

Page 2-237


config response content tl1envalarm

DescriptionThese commands configure a TL1 environmental alarm response.

Formatsconfig response response_name content responder tl1envalarm

aid aid_stringalmcde { CR | MJ | MN | NA }almmsg message_textalmtype almtype_textntfcncde { CR | MJ | MN | CL }srveff { SA | NSA }

Parameters

aid Configures an AID for a TL1 environmental alarm response. An AID identifies the NE system component to which the alarm applies. The following parameter is accepted:

aid_string—Defines the AID string for the TL1 environmental alarm.

almcde Configures an alarm code for a TL1 environmental alarm response. The alarm code identifies the severity of an automatic alarm message based on a condition.

Note: For more information about alarm codes, refer to the

Telcordia GR-833-CORE documentation.

The following parameters are accepted: CR—Specifies a critical alarm condition. MJ—Specifies a major alarm condition. MN—Specifies a minor alarm condition. NA—Specifies a non-alarmed autonomous message.

almmsg Configures the alarm message text for a TL1 environmental alarm response. The alarm message text displays when a specified environmental event occurs. The following parameter is accepted:

message_text—Defines the message text for the TL1 environmental alarm response. The maximum length is 40 characters.

WESTELL.COM

Page 2-238

1-800-377-8766


Command DefaultsNo AIDs configured


almtype Configures the alarm type for a TL1 environmental alarm response.

Note: For valid alarm type values, refer to the Telcordia GR-

833-CORE documentation.

The following parameter is accepted:almtype_text—Defines the alarm type for the generated TL1 environmental alarm. The maximum length is 20 characters.

ntfcncde Configures a notification code for a TL1 environmental alarm response. The notification code provides an indication of the severity of an alarm.



srveff Configures the effect on service caused by the TL1 environmental alarm condition. The following parameters are accepted: SA—Specifies a service-affecting condition for the TL1

environmental alarm response. NSA—Specifies a non-service-affecting condition for the TL1

environmental alarm response.



tl1ne ne_id


WESTELL.COM

1-800-377-8766

Page 2-239


ExamplesThe following settings are configured for response doorOpenTl1Alarm:

Responder tl1ne 1 AID POINT1 Major alarm condition Alarm message Door is open Alarm type OPENDR Major notification code Service-affecting condition.

config response content tl1eqptalarm

DescriptionThese commands configure the settings for a TL1 equipment alarm response.

Formatsconfig response response_name content responder tl1eqptalarm

aid aid_stringalmcde { CR | MJ | MN | NA }conddescr conddescr_stringcondtype condtype_stringntfcncde { CR | MJ | MN | CL }srveff { SA | NSA }

Parameters

(Dub)>config(Dub) config>response doorOpenTl1Alarm(Dub) config response doorOpenTl1Alarm>content(Dub) config response doorOpenTl1Alarm content->tl1ne 1(Dub) config response doorOpenTl1Alarm content tl1ne 1->tl1envalarm(Dub) config response doorOpenTl1Alarm content tl1ne 1 tl1envalarm->aid POINT1(Dub) config response doorOpenTl1Alarm content tl1ne 1 tl1envalarm->almcde mj(Dub) config response doorOpenTl1Alarm content tl1ne 1 tl1envalarm->almmsg Door is open(Dub) config response doorOpenTl1Alarm content tl1ne 1 tl1envalarm->almtype OPENDR(Dub) config response doorOpenTl1Alarm content tl1ne 1 tl1envalarm->ntfcncde mj(Dub) config response doorOpenTl1Alarm content tl1ne 1 tl1envalarm->srveff sa(Dub) config response doorOpenTl1Alarm content tl1ne 1 tl1envalarm->

WESTELL.COM

Page 2-240

1-800-377-8766


aid Configures an AID for a TL1 equipment alarm response. An AID identifies the NE system component to which the alarm applies.The following parameter is accepted:

aid_string—Defines the AID for the TL1 equipment alarm. The maximum length is 32 characters.

almcde Configures an alarm code for a TL1 equipment alarm response. The alarm code identifies the severity of an automatic alarm message based on a condition.

Note: For more information about alarm codes, refer to the

Telcordia GR-833-CORE documentation.

The following parameters are accepted: CR—Specifies a critical alarm condition. MJ—Specifies a major alarm condition. MN—Specifies a minor alarm condition. NA—Specifies a non-alarmed autonomous message.

conddescr Configures a text alarm condition description for a TL1 equipment alarm response. The following parameter is accepted:

conddescr_string—Defines the text alarm condition description within the generated TL1 alarm. The maximum length is 64 characters.

condtype Configures an alarm condition type for a TL1 equipment alarm response.

Note: For more information about alarm condition types, refer

to the Telcordia GR-833-CORE documentation.

The following parameter is accepted:condtype_string—Defines the alarm condition type within the generated TL1 alarm. Maximum length is 20 characters.

ntfcncde Configures a notification code for a TL1 equipment alarm response. The notification code provides an indication of the severity of an alarm. The following parameters are accepted: CR—Specifies a critical alarm condition. MJ—Specifies a major alarm condition. MN—Specifies a minor alarm condition. CL—Specifies a cleared alarm.

WESTELL.COM

1-800-377-8766

Page 2-241




responder Defines the responder, which is the system component that processes the response. For more information on available responders for this command, refer toTable 9 on page 2-225.

srveff Configures the effect on service caused by the TL1 equipment alarm condition. The following parameters are accepted: SA—Specifies a service-affecting condition for the TL1

equipment alarm response. NSA—Specifies a non-service-affecting condition for the TL1

equipment alarm response. This is the default setting.



tl1ne ne_id


WESTELL.COM

Page 2-242

1-800-377-8766


ExamplesThe following settings are configured for tl1eqptalarm response powerLevelTl1Alm:

Responder tl1ne 1 Alarm code cr (critical) Condition description Power Low Condition type condition1 Notification code cr Service-affecting condition.

See Alsoconfig response

config response content connect

show responses

(Dub)>config(Dub) config>response powerLevelTl1Alm(Dub) config response powerLevelTl1Alm>content(Dub) config response powerLevelTl1Alm content->tl1ne 1(Dub) config response powerLevelTl1Alm content tl1ne 1->tl1eqptalarm(Dub) config response powerLevelTl1Alm content tl1ne 1 tl1eqptalarm->almcde cr(Dub) config response powerLevelTl1Alm content tl1ne 1 tl1eqptalarm->conddescr Power Low(Dub) config response powerLevelTl1Alm content tl1ne 1 tl1eqptalarm->condtype condition1(Dub) config response powerLevelTl1Alm content tl1ne 1 tl1eqptalarm->ntfcncde cr(Dub) config response powerLevelTl1Alm content tl1ne 1 tl1eqptalarm->srveff sa(Dub) config response powerLevelTl1Alm content tl1ne 1 tl1eqptalarm->

WESTELL.COM

1-800-377-8766

Page 2-243

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config site control

config site control

DescriptionThese commands configure a control at a site. A control manages the state of a component; for example, turning a switch on or off, or adjusting the temperature of a thermostat. Control names and parameter names are determined by the module packages installed on the Remote RMX-3200.

Formats

For configuring a site control:config site control control_name

disable enable param param_name param_value

For returning a control’s parameters to their default value:config site no control { control_name | * }

For removing the value of a control parameter:config site control control_name no param { param_name | * }

Parameters


ExamplesThe following control settings are specified/configured:

Control name generator Parameter name mode, with value normal

* Specifies all control names or all parameter names.

control_name Specifies a name for a control.

param Configures a parameter for a control. The following values are accepted: param_name—Specifies a name for a control parameter. param_value—Specifies a value for a control parameter.

WESTELL.COM

Page 2-244

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config site control

See Also show site controls

exec site control-action

(Dub)>config(Dub) config>site(Dub) config site>control generator param mode normal

WESTELL.COM

1-800-377-8766

Page 2-245

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config site module

config site module

DescriptionA module is a pre-packaged, turn-key solution built to address a specific area of site management, such as Power Management or Environmental/HVAC Monitoring and Control. Each module is composed of individual applications that provide a slice of functionality and equipment (alarms, measurements, sensors, etc.) used to address a specific purpose within a module.

Formats

For disabling\enabling an application:config site module module_name

application application_name { disable | enable }

For deleting the configuration for a module:config site no module { module_name | * }

For deleting the configuration for an application:config site module module_name no application { application_name | * }

Parameters


* Specifies all modules at a site, or all applications that pertain to a module.

application Configures an application that pertains to a module. The following parameter is accepted:

application_name—Specifies a name for an individual application.

module_name Specifies a name for a module. A selection of values will be available based on the module packages that have been installed on the Remote RMX-3200.

WESTELL.COM

Page 2-246

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config site module

ExamplesIn this example, the following module settings are configured/specified:

Module name Environmental Application name HVACMonitoring

See Also show site modules

exec site install

(Dub)>config(Dub) config>site(Dub) config site>module Environmental->application HVACMonitoring enable

WESTELL.COM

1-800-377-8766

Page 2-247

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config site network-element

config site network-element

DescriptionThese commands configure a network element (NE) and sub-components at a site.

Formats

For configuring a NE:config site network-element ne_name

param param_name param_valuetype typecomponent component_name param param_name param_value

For deleting a NE:config site no network-element { ne_name | * }

Important: This command removes all of the component NE properties as well as the component NE instances themselves.

For deleting the value of a NE parameter (or resetting to default):config site network_element ne_name no param { param_name | * }

For clearing the NE type:config site network_element ne_name no type { type | * }

For deleting the configuration of a sub-component or all sub-components:

config site network-element ne_name no component ( component_name | * )

For configuring sub-component parameters:

config site network-element ne_name component component_name param param_name param_value

For deleting one or more, or all, sub-component parameters:

config site network-element ne_name component component_name no param ( param_name | * )

Parameters

* Specifies all NE names, all NE parameter names, all NE types, all sub-components, or all sub-component parameters.

WESTELL.COM

Page 2-248

1-800-377-8766



ExamplesThe following network element settings are configured for NE hvacSystem:

Parameter name emergencyShutoffTemperature, with value 95 NE type MarvairCS4HVACSystem

The following configures the parameter model as “Model_3.5” in NE das2’s sub-component das2Remote_1_6_2:

component Configures a Network Element’s sub-component. The following parameters are accepted: component_name -- Specifies a name for the sub-

component. no component { component_name | * } -- Deletes the

configuration of a sub-component or of all sub-components. component_name param param_name param_value --

Specifies a sub-component’s parameter name and a value for that named parameter.

param Configures a parameter for a network element. The following parameters are accepted: param_name—Specifies a name for an NE parameter. param_value—Specifies a value for an NE parameter.

type Configures an NE type for this network element. The following parameter is accepted:

type—Defines an NE type.

Note: Changing the NE type value will clear all parameter

values for this NE.

(Dub)>config(Dub) config>site(Dub) config site>network-element hvacSystem(Dub) config site network-element hvacSystem>type MarvairCS4HVACSystem(Dub) config site network-element hvacSystem>param emergencyShutoffTemperature 95

(RMX104)>config(RMX104) config>site network-element das2 component das2Remote_1_6_2 param model Model_3.5(RMX104) config>

WESTELL.COM

1-800-377-8766

Page 2-249


See Also show site network-elements

WESTELL.COM

Page 2-250

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config site network-element-set

config site network-element-set

DescriptionThese commands configure network element sets. NE sets provide a way to configure a user-defined number of NEs of a specific type at a site. For example, multiple generators, battery strings, multiple rectifiers and/or multiple tenants can be configured at one site.

Once the NE set has been configured and each NE (instance) to be included in the set has been defined, you can configure the details for each NE instance.

Formats

For configuring an NE set:config site network-element-set set_name

For configuring an NE (instance) in a set:config site network-element-set set_name instance ne_name

For configuring details for an NE (instance) in a set:config site network-element-set set_name instance ne_name

description descriptiondisplay-name display_namedefault {description | display-name}

For deleting NE set configurations:config site no network element-set {set_name | *}

For deleting NEs (instances) from a set:config site network-element-set set_name no instance {ne_name | *}

Parameters

set_name Identifies the name of the NE set to be configured. The NE set name is defined within a module. You must use this module-defined name to identify which NE set you are configuring. To display a list of valid module-defined NE set names, use TAB completion or enter config site network-element-set ?.

instance Configures an NE (instance) to be included in a set.

WESTELL.COM

1-800-377-8766

Page 2-251


Command DefaultsNo NE sets configured


ExamplesThis example displays the configuration of NE set TenantPowerMeter.

This example displays the configuration of NE (instance) KentroxPower in NE set TenantPowerMeter.

ne_name Defines a name for the NE (instance) to be included in a set. This name must be unique within the site. In addition, a module may define a format to which the NE name must conform. For example, the module may allow you to enter any characters for the beginning of an NE name but require that the name end with certain characters (for example, Power).

description Configures a description for an NE (instance) in a set.

description Defines a description for an NE (instance) in a set.

display-name Configures a display name for an NE (instance) in a set. This name will be used within the Optima application. This name also must be unique within the site.

display_name Defines a display name for an NE (instance).

default Resets the NE (instance) description or display name to its default value.

no Deletes NE set configurations or NEs (instances) from a set.

* Specifies all NE sets or NEs (instances).

(Dub)>config(Dub) config>site(Dub) config site>network-element-set TenantPowerMeter(Dub) config site network-element-set TenantPowerMeter->

WESTELL.COM

Page 2-252

1-800-377-8766


This example displays the configuration of description This is KentroxPower. for NE (instance) KentroxPower in NE set TenantPowerMeter.

This example displays the deletion of NE (instance) KentroxPower from NE set TenantPowerMeter.

See Also show site network-elements-sets

(Dub)>config(Dub) config>site(Dub) config site>network-element-set TenantPowerMeter(Dub) config site network-element-set TenantPowerMeter->instance KentroxPower(Dub) config site network-element-set TenantPowerMeter instance KentroxPower->

(Dub)>config(Dub) config>site(Dub) config site>network-element-set TenantPowerMeter(Dub) config site network-element-set TenantPowerMeter->instance KentroxPower(Dub) config site network-element-set TenantPowerMeter instance KentroxPower->description This is KentroxPower.(Dub) config site network-element-set TenantPowerMeter instance KentroxPower->

(Dub)>config(Dub) config>site(Dub) config site>network-element-set TenantPowerMeter(Dub) config site network-element-set TenantPowerMeter->no instance KentroxPower(Dub) config site network-element-set TenantPowerMeter->

WESTELL.COM

1-800-377-8766

Page 2-253

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config site param

config site param

DescriptionThis command configures a site parameter. A site parameter is a configuration value that is global to all modules on a site.

FormatsFor configuring a module parameter:

config site

param param_name param_value

For deleting the value of a module parameter (or resetting to default):config site no param { param_name | * }

Parameters


ExamplesThe following module parameter is displayed:

Parameter name temperatureUnits Parameter value F

See Also show site params

* Specifies all module parameters.

param Configures a parameter for a module. The following parameters are accepted:

param_name—Specifies a name for a module parameter.param_value—Specifies a value for a module parameter.

(SystemTest-ModulesRMM)>config(SystemTest-ModulesRMM) config>site(SystemTest-ModulesRMM) config site>param temperatureUnits F

WESTELL.COM

Page 2-254

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config sitebus

config sitebus

DescriptionThese commands configure devices connected to the SiteBus terminals on an RMB peripheral unit.

Formatsconfig sitebus name

description text id hex_idtype device_type

For deleting a SiteBus device:config no sitebus name

For deleting a SiteBus description:config sitebus name no description

For deleting a SiteBus device ID:config sitebus name no id { hex_id | * }

For deleting a SiteBus device type:config sitebus name no type { device_type | * }

Parameters

* Specifies all SiteBus device IDs or all SiteBus device types.

description Configures a description for a SiteBus device. There is no maximum description length or default description. The following parameter is accepted:

text—Defines a text description for a SiteBus device.

id Configures the hexidecimal ID for a SiteBus device. The following parameter is accepted:

hex_id—Defines a 14-digit hexidecimal ID; for example, 280023AB5A120F. Every device is hard-coded with a unique hexidecimal ID, which is discovered by RMB and reported to Remote RMX-3200.

name Configures a name for the SiteBus device. Each SiteBus device should be assigned a unique name in order to track and store its reported values in the measurement table.

WESTELL.COM

1-800-377-8766

Page 2-255

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config sitebus


ExamplesThe following SiteBus device settings are configured:

Device name temp1 Device ID 280000561000F1 Device type sbTemp Device description Heating core temp probe

See Also show sitebus

type Configures the device type for a SiteBus device. The following parameter is accepted:

device_type—Defines the device type, which determines how data from the device will be interpreted and what points will be created for the device.

Note: The only device type supported for Remote RMX-3200

Version 5.4x is sbTemp. Points created for the sbTemp device type include temperatureF and temperatureC.

(Dub)>config(Dub) config>sitebus temp1(Dub) config sitebus temp1>(Dub) config sitebus temp1>id 280000561000F1(Dub) config sitebus temp1>type sbTemp(Dub) config sitebus temp1>description Heating core temp probe(Dub) config sitebus temp1>

WESTELL.COM

Page 2-256

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config snmp

config snmp

DescriptionThese commands configure SNMP settings for Remote RMX-3200.

Formatsconfig snmp

auth-trap { disable | enable }community name { v1 | v2 | v3 user user_name { noauth | auth |

priv} } { readonly | readwrite }trap-queue { disable | enable | priority oid priority_level }user name [ {md5 | sha} auth_passphrase [ {des | aes-128} [

priv_passphrase ] ] ]

For a v1 or v2 host:host ip_address [ port_number [ community [ {v1 | v2 | v2-

inform} ] ] ]

For a v3 host:host ip_address port_number user {v3 | v3-inform} {noauth |

auth | priv}

For removing an SNMP community:config snmp no community name

For removing SNMP hosts:config snmp no host { ip_address | * }

For removing trap OID priority entries:config snmp trap-queue no priority { oid | * }

For removing a user:

config snmp no user name

WESTELL.COM

1-800-377-8766

Page 2-257


Parameters

* Specifies all communities, hosts, or OIDs.

auth-trap Configures the transmission of authentication failure traps from the SNMP agent. Authentication failure traps are transmitted when a device has attempted to access objects in the Remote RMX-3200 MIB file using an invalid community string. The default is disabled transmission of authentication failure traps. The following parameters are accepted: disable—Disables the transmission of authentication failure

traps. enable—Enables the transmission of authentication failure

traps.

community Configures community strings and group names accepted by the SNMP agent. SNMP community strings and group names provide embedded password access to MIB contents. The following parameters are accepted: name—Defines the community string. v1—Sets the SNMP community type as version 1. v2—Sets the SNMP community type as version 2. v3—Sets the SNMP group type as version 3. user_name—Defines the v3 user name. noauth—Specifies no packet authentication or encryption. auth—Specifies packet authentication but no encryption. priv—Specifies packet authentication and encryption. readonly—Permits read only access to all objects in the MIB. readwrite—Permits read and write access to all objects in the

MIB.

WESTELL.COM

Page 2-258

1-800-377-8766


host Configures management stations in the SNMP trap table. Management stations are used to oversee network activity generated by SNMP agents, which are hardware and/or software processes that report on each network device. The trap table is a list of all available management stations. The following parameters are accepted: ip_address—Defines the management station IP address. port number—Defines the management station port number.

The default port number is 162. community—Defines the community string. The default

Community string public. user—Defines the v3 User. v1—Sets the SNMP community type as version 1. v2—Sets the SNMP community type as version 2. This is the

default SNMP community type. v2-inform—Specifies that an SNMP version 2 inform request is

sent to this management station. v3—Sets the SNMP community type as version 3. v3-inform—Specifies that an SNMP version 3 inform request is

sent to this management station. noauth—Specifies no packet authentication or encryption. auth—Specifies packet authentication but no encryption. priv—Specifies packet authentication and encryption. no—Initiates the deletion of a specified management station or

all management stations from the trap table. *—Deletes all management stations from the trap table.

no Negates an SNMP configuration command.

WESTELL.COM

1-800-377-8766

Page 2-259



trap-queue

Configures the ability to save SNMP traps in a queue. This queue can contain up to 100 of the most recent traps. When trap queuing is enabled, Remote RMX-3200 sends a ping to the SNMP host before sending a trap. If the ping is successful, Remote RMX-3200 sends the trap to the host. If the ping is unsuccessful, Remote RMX-3200 saves the trap in a queue and continues to ping the host. When a ping finally succeeds, Remote RMX-3200 forwards all queued traps to the host. The following parameters are accepted: disable—Disables the SNMP trap queue. The queue is

disabled by default.

Note: Any queued traps are sent immediately when command

config snmp trap-queue disable is executed. If the connection to the host is down, these traps will be lost.

enable—Saves SNMP traps in a queue if the connection to the host is down.

oid—Specifies the Object Identifier (OID) of a trap sent by a monitored device. Valid values are dotted number OID strings; for example, .1.2.3.4.

priority_level—Specifies the priority for this trap OID. In order to add new traps when the trap queue is full, Remote RMX-3200 drops the oldest, lowest-priority traps from the queue. Valid values are highest, high, normal, low and lowest.

Note: A priority level on an alarm table entry will override any

priority on the OIDs used for alarm table traps.

user Configures the user. The following parameters are accepted: name—Specifies the name for the user. md5—Specifies the MD5 authentication protocol. sha—Specifies the SHA-1 authentication protocol. auth_passphrase—Specifies the authentication passphrase for

the user. Minimum length is 8 characters. des—Specifies DES as the privacy (encryption) protocol. aes-128—Specifies AES-128 as the privacy (encryption)

protocol. priv_passphrase—Specifies the privacy passphrase for the

user. Minimum length is 8 characters. If not specified, auth_passphrase used by default.

WESTELL.COM

Page 2-260

1-800-377-8766


ExamplesThe following SNMP settings are configured:

Community string mycomm SNMP community type v1 Read and write access to MIB objects (readwrite) Management station IP address 10.40.56.3 Management station port number 21 Enabled transmission of authentication failure traps Enabled queuing of SNMP traps.

The following example configures Remote RMX-3200 to have a single inform request host:

The following example configures traps from OID .1.3.6.1.6.4.1.1.3.1 to have high priority:

The following example configures a v3 user (eric) with md5 authentication (passphrase: ericauthphrase) and des encryption (passphrase: ericprivphrase):

(Dub)>config(Dub) config>snmp(Dub) config snmp>community mycomm v1 readwrite(Dub) config snmp>host 10.40.56.3 21 mycomm(Dub) config snmp>auth-trap enable(Dub) config snmp>trap-queue enable(Dub) config snmp>

(Dub)>config(Dub) config>snmp(Dub) config snmp>host 10.40.56.3 21 mycomm v2-inform

(Dub)>config(Dub) config>snmp(Dub) config snmp>trap-queue(Dub) config snmp trap-queue>priority .1.3.6.1.6.4.1.1.3.1 high(Dub) config snmp trap-queue>

(Dub)>config(Dub) config>snmp(Dub) config snmp>user eric md5 ericauthphrase des ericprivphrase(Dub) config snmp>

WESTELL.COM

1-800-377-8766

Page 2-261


The following example configures a community (dublinusers) with a v3 user (eric) that has authentication and encryption (priv) with read and write access (readwrite):

The following example configures a host with the IP address of 12.34.56.78, port number 2, user name eric, community type v3, with authentication (auth) but no encryption:

See Also show snmp

(Dub)>config(Dub) config>snmp(Dub) config snmp>community dublinusers v3 user eric priv readwrite(Dub) config snmp>

(Dub)>config(Dub) config>snmp(Dub) config snmp>host 12.34.56.78 2 eric v3 auth(Dub) config snmp>

WESTELL.COM

Page 2-262

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config tbos load

config tbos load

DescriptionThese commands load a TBOS definition file for Remote RMX-3200. TBOS definition files are tab-delimited or comma-separated files that contain equipment type definitions (TBOS NE display templates). These let users quickly configure TBOS displays without configuring every point manually. After TBOS definition files are loaded into Remote RMX-3200, the equipment type definitions are used to configure TBOS displays.

Formatsconfig tbos load file_name [ fromserver ]

Parameters

Command DefaultsNo TBOS definition files loaded


ExamplesThis example displays the loading of TBOS definition file tbos.def from the configured server.

file_name Defines the name of the TBOS definition file to load into Remote RMX-3200.

fromserver Specifies that the TBOS definition file is to be loaded from a server. Refer to command config tbos server on page 2-276. for information about server configuration. If no server is specified, the file is loaded from Remote RMX-3200 directory /config/tbos. The file can be downloaded into that directory via FTP.

(Dub)>config(Dub) config>tbos(Dub) config tbos>load tbos.def fromserver(Dub) config tbos>

WESTELL.COM

1-800-377-8766

Page 2-263

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config tbos load

This example displays the loading of TBOS definition file tbos.def from the Remote RMX-3200 configuration directory (/config/tbos).

See Alsoconfig tbos port serial

config tbos port serial cut-through

config tbos port serial display

config tbos port serial display point

config tbos server

show tbos

(Dub)>config(Dub) config>tbos(Dub) config tbos>load tbos.def(Dub) config tbos>

WESTELL.COM

Page 2-264

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config tbos port serial

config tbos port serial

DescriptionThis command configures settings for a TBOS serial port.

Formatsconfig tbos port serial { port | unit/port }

description textdisableenableno descriptionpoll-delay timeresponse-timeout timetimed-response { disable | enable }

Parameters

description Configures the description for a TBOS serial port. The following parameter is accepted:

text—Defines the description of the TBOS serial port.

disable Disables TBOS polling on a TBOS serial port. Disabling polling on a TBOS port disables polling on all of its TBOS alarm displays, thus disabling polling on all of its TBOS status points.

enable Enables TBOS polling on a TBOS alarm display. When a TBOS alarm display is enabled (on an enabled TBOS serial port) the TBOS subsystem will begin to sequentially poll each enabled status point within the display for status information.

Note: An enabled point on an enabled display must be

present before enabling the associated TBOS serial port.

no Deletes the configured description.

poll-delay Configures the amount of time Remote RMX-3200 waits between receiving a response and sending the next poll. The following parameter is accepted:

time—Defines the amount of time (in tenths of seconds) between polls on a TBOS port. Valid values are 0 to 200.

WESTELL.COM

1-800-377-8766

Page 2-265



ExamplesThe following settings are configured for TBOS serial port 3:

Description TBOS port 3 5 second poll delay 8 second response timeout Response time is enabled TBOS serial port 3 is enabled.

port Defines the physical connector associated with the controller on Remote RMX-3200. Valid values are 1 to 8 for Remote RMX-3200. Other values may be available for expansion peripheral units.

response-timeout

Configures the amount of time Remote RMX-3200 waits for a response before moving on to the next poll. The following parameter is accepted:

time—Defines the amount of time (in tenths of seconds) Remote RMX-3200 waits for a response to a TBOS poll. Valid values are 10 to 200.

timed-response Enables or disables the discarding and logging of responses that are received too soon after a TBOS poll. The following parameters are accepted: disable—Disables the response time. enable—Enables the response time.

unit Defines the peripheral expansion unit in which the physical port port is located. Valid values are 1 to 12.

(Dub)>config(Dub) config>tbos(Dub) config tbos>port serial 3(Dub) config tbos port serial 3->description TBOS port 3(Dub) config tbos port serial 3->poll-delay 50(Dub) config tbos port serial 3->response-timeout 80(Dub) config tbos port serial 3->timed-response enable(Dub) config tbos port serial 3->enable(Dub) config tbos port serial 3->

WESTELL.COM

Page 2-266

1-800-377-8766



DescriptionThese commands configure cut-through support for a TBOS serial port. Cut-through support lets users connect directly to a TBOS serial port and issue TBOS commands directly to TBOS network elements.

Note: Refer to the Remote RMX-3200 Configuration Guide for information about

issuing TBOS commands.

Formatsconfig tbos port serial { port | unit/port } cut-through

disableenableport tcp

Parameters


disable Disables cut-through support for a TBOS serial port. Cut-through support is disabled by default.

enable Enables cut-through support for a TBOS serial port.

port Configures the TCP port number for cut-through support on a TBOS serial port. The TCP port number is used to telnet to Remote RMX-3200. Cut-through support allows users to connect directly to a TBOS serial port and issue TBOS commands directly to a TBOS network elements. The following parameter is accepted:

tcp—Defines the TCP port number. Valid values are 1000 to 65535.



WESTELL.COM

1-800-377-8766

Page 2-267


ExamplesThe following cut-through settings are configured for TBOS serial port 3:

Port 1002 Cut-through enabled.

config tbos port serial display

DescriptionThese commands configure the settings associated with the TBOS alarm display. A TBOS serial port can have eight TBOS alarm displays. Each TBOS alarm display can have 64 TBOS status (alarm) points.

Note: Refer to the Remote RMX-3200 Configuration Guide for information about

automatically configuring status points to be polled on a TBOS alarm display.

Formatsconfig tbos port serial { port | unit/port } display display

category categorydescription textdisableenablename name_textne-name ne-nameno [ description category ne-name ]points { all | none | type equipment_type [ tl1ne ne_id ]

[ substitution=value ] [ substitution=value ] }timeout-alarm { disable | enable }

For deleting a TBOS alarm display:config tbos port serial port no display display

(Dub)>config(Dub) config>tbos(Dub) config tbos>port serial 3(Dub) config tbos port serial 3->cut-through port 1002(Dub) config tbos port serial 3->enable(Dub) config tbos port serial 3->

WESTELL.COM

Page 2-268

1-800-377-8766


Parameters

category Configures the category for a TBOS alarm display. The following parameters are accepted:

category—Defines the category of the TBOS alarm display. This name cannot contain any spaces and no other fields may follow it. Maximum length is 128 characters.no—Removes the category from the TBOS alarm display.

description Configures the description for a TBOS alarm display. The following parameter is accepted:

text—Defines the description of the TBOS alarm display.

disable Disables TBOS polling on a TBOS alarm display. The TBOS alarm display is disabled by default.

display Defines the TBOS alarm display number. Valid values are 1 to 8.

enable Enables TBOS polling on a TBOS alarm display.

name Configures a name for the TBOS alarm display. The following parameter is accepted:

name_text—Defines the name text for the TBOS alarm display.

ne-name Configures the network element name for the TBOS alarm display. The following parameters are accepted:

category—Defines the network elements name for the TBOS alarm display. This name cannot contain any spaces and no other fields may follow it. Maximum length is 128 characters.no—Removes the network element name from the TBOS alarm display.

no Removes TBOS port configuration settings.

WESTELL.COM

1-800-377-8766

Page 2-269


points Configures the status points to be polled on a TBOS alarm display. The following parameters are accepted: all—Specifies that all status points in the TBOS alarm display

are to be polled. When issuing this parameter, make sure that you wait until the points are actually configured before issuing any additional commands for the display. This typically takes 8 to 10 seconds.

none—Specifies that none of the status points in the TBOS alarm display are to be polled.

type—Specifies the type of equipment to be polled. The TBOS configuration file must be loaded before an equipment type can be specified. To use the equipment types after a reboot, the TBOS file must be reloaded.Important: You must change and reconfigure the display’s

equipment type if a mistake is made when you enter the TL1 NE or substitution values. TBOS only re-adds the alarm configuration if the equipment type has changed. This greatly impacts efficiency.

equipment_type—Defines the equipment type to be polled. The TBOS configuration file must be loaded before an equipment type can be specified. The TBOS configuration file must be reloaded after a reboot in order to use the equipment types.

tl1ne—Specifies that a virtual TL1 NE will receive alarms from the TBOS alarm entry. If no virtual TL1 NE is entered, default NE 1 is used. Additionally, more than one display can be configured with alternate TL1 NEs.

ne_id—Defines the ID of the virtual TL1 NE. Valid values are 1 to 20.

substitution—Defines free-form text that corresponds to the TL1 AID fields in the TBOS definition file. This parameter must match values in the AID fields for the specified equipment type. If the substitution value does not match, the raw AID text from the definition file is loaded into the alarm table entry as the AID.

Note: For more information on this feature, refer to the

Remote RMX-3200 Configuration Guide.

value—Defines the free-form text value that substitutes for the TL1 AID in the TBOS definition file.

WESTELL.COM

Page 2-270

1-800-377-8766



ExamplesThe following settings are configured for TBOS alarm display 5 on serial port 1:

Description Kentroxequipment Polling on equipment type Alcatel_MDR4000E Setup of tl1ne 2 to receive alarms Category TBOS-points NE-name Alcatel_MDR4000E Setup of substitutions farend=florida and nearend=ohio Enabled TBOS alarm display 5.

Note: Category and ne-name should be configured before the points to avoid re-

configuration of alarm entries.



timeout-alarm

Configures whether a timeout alarm is created and updated for a TBOS display. This major-severity alarm will use the same timing parameters as the parent TBOS port to determine if a display has timed out. By default, no alarm is created. The following parameters are accepted:disable -- Disables the timeout alarm for a TBOS display .enable -- Enables the timeout alarm for a TBOS display.


WESTELL.COM

1-800-377-8766

Page 2-271


(Dub)>config(Dub) config>tbos(Dub) config tbos>port serial 1(Dub) config tbos port serial 1->display 5(Dub) config tbos port serial 1 display 5->description Kentroxequipment(Dub) config tbos port serial 1 display 5->category TBOS-points(Dub) config tbos port serial 1 display 5->ne-name Alcatel_MDR4000E(Dub) config tbos port serial 1 display 5->points type Alcatel_MDR4000E tl1ne 2 farend=florida nearend=ohio(Dub) config tbos port serial 1 display 5->enable

WESTELL.COM

Page 2-272

1-800-377-8766



DescriptionThese commands configure TBOS polling on individual status points, or sets of points, on a TBOS alarm display. A TBOS serial port has eight alarm displays. Each TBOS alarm display has eight status (alarm) points.

Formatsconfig tbos port serial { port | unit/port } display display point point

description textdisableenablemessage { critical | major | minor | warning } alarm_messageno { description | message }

Parameters

description Configures the description for a status (alarm) point. The following parameter is accepted:

text—Defines the description of the status (alarm) point.

disable Disables TBOS polling on individual status points, or sets of points, on a TBOS alarm display. Status points are disabled by default.

display Defines the TBOS alarm display number. Valid values are 1 to 8.

enable Enables TBOS polling on individual status points, or sets of points, on a TBOS alarm display.

WESTELL.COM

1-800-377-8766

Page 2-273


message Configures a message for a TBOS status point, which is associated with a specific alarm state. A status point can be configured to display a different message for the critical, major, minor, normal and warning alarm states. The following parameters are accepted: critical—Specifies the critical alarm level for a TBOS status

point or set of points. major—Specifies the major alarm level for a TBOS status point

or set of points. minor—Specifies the minor alarm level for a TBOS status point

or set of points. normal—Specifies the normal alarm level for a TBOS status

point or set of points. warning—Specifies the warning alarm level for a TBOS status

point or set of points. alarm_message—Defines the alarm message associated with

a specified alarm level for a status point.


point Defines the status point or points to be disabled on a TBOS alarm display. Valid values are 1 to 64.

Notes: Multiple status points can be entered by separating the

status point numbers with a comma (,) and by entering ranges with a dash (-) between the status point numbers. For example, entering 1,4,13-30, selects status point numbers 1, 4 and 13 to 30.



WESTELL.COM

Page 2-274

1-800-377-8766



ExamplesThe following settings are configured for status points 23 on TBOS display 5 on serial port 1:

Alarm message Major Alarm Status with an associated major alarm level Enabled status point 23.

See Alsoconfig tbos load

config tbos server

show tbos

(Dub)>config(Dub) config>tbos(Dub) config tbos>port serial 1(Dub) config tbos port serial 1->display 5(Dub) config tbos port serial 1 display 5->point 23(Dub) config tbos port serial 1 display 5 point 23->message major Major Alarm Status(Dub) config tbos port serial 1 display 5 point 23->enable(Dub) config tbos port serial 1 display 5 point 23->

WESTELL.COM

1-800-377-8766

Page 2-275

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config tbos server

config tbos server

DescriptionThese commands configure the central server that is used to install TBOS definition files onto the Remote RMX-3200 configuration directory.

Formatsconfig tbos server

address ip_address [ port ]directory directoryno { address | directory | user }user username password

Parameters


address Configures the IP address and port number for the central server. The following parameters are accepted: ip_address—Defines the IP address for the central server. port—Defines the port number for the central server. Valid

values are 1000 to 65535. The default port number is 21.

directory Configures Remote RMX-3200 to use the directory on the central server that contains TBOS definition files. The default directory is / (root directory). The following parameter is accepted:

directory—Defines the directory on the central server that contains TBOS definition files.

user Configures the login information Remote RMX-3200 will use to access the TBOS central server. The following parameters are accepted: username—Defines the user name configured on the central

server. password—Defines the password configured on the central

server.

no Deletes the configured IP address or user login information. Resets the configured IP port number or IP directory to its default value.

WESTELL.COM

Page 2-276

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config tbos server

ExamplesThe following settings are configured for the central server:

IP address 192.168.5.1 and port number 1001 Directory /tmp/tbos User name test and password test.


config tbos port serial



show tbos

(Dub)>config(Dub) config>tbos(Dub) config tbos>server(Dub) config tbos server->address 192.168.5.1 1001(Dub) config tbos server->directory /tmp/tbos(Dub) config tbos server->user test test(Dub) config tbos server->

WESTELL.COM

1-800-377-8766

Page 2-277

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config timeout

config timeout

DescriptionThis command configures the amount of time that can elapse before a Remote RMX-3200 session expires due to inactivity.

Note: The timeout configured does not take effect on any open Remote RMX-3200

CLI sessions; it takes effect on new sessions only.

Formatsconfig timeout minutes

config default timeout

config no timeout

Parameters

Command Defaults10 minutes


ExamplesThis example displays the configuration of the CLI timeout value as 20 minutes.

minutes Defines the amount of time (0 to 60 minutes) that can elapse before a Remote RMX-3200 session expires.

Note: An indefinite login occurs when minutes is set to 0. This means

that the user will never be logged out due to inactivity.

default Resets the timeout to the default (10 minutes).

no Sets a Remote RMX-3200 session to never timeout due to inactivity.

(Dub)>config(Dub) config>timeout 20(Dub) config>

WESTELL.COM

Page 2-278

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config timeout

This example displays the resetting of the CLI timeout to its default value (10 minutes).

This example displays the setting of a Remote RMX-3200 timeout session to never time out.

See Alsoshow timeout

(Dub)>config(Dub) config>default timeout(Dub) config>

(Dub)>config(Dub) config>no timeout(Dub) config>

WESTELL.COM

1-800-377-8766

Page 2-279

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config use-wizard

config use-wizard

DescriptionThe config use-wizard command invokes a configuration wizard that prompts you for configuration information and generates and applies configuration commands. Three wizard scripts are provided:

A setup wizard for initial connectivity configuration on an unconfigured device

A wizard for common serial port setups

A wizard that configures a bi-state point through the alarm table.

Note: For more information about configuration wizards, refer to the Remote RMX-

3200 Configuration Guide.

Formatsconfig use-wizard

bistate-alarms [ debug ]initsetup [ debug ]serial-port [ debug ]

Parameters

bistate-alarms

Specifies the wizard that allows the user to configure any or all of the bi-state points on the base unit or on an expansion unit. The following parameter is accepted:

debug—Displays debugging information during wizard execution.

initsetup Specifies the wizard that performs the initial Remote RMX-3200 setup tasks, including: Connecting to a network by configuring the device’s IP

address, subnet mask and default gateway Configuring the device’s SNMP settings Configuring login accounts Configuring a wireless WAN connection.The following parameter is accepted:


WESTELL.COM

Page 2-280

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config use-wizard


ExamplesThe following example displays the initsetup wizard.

serial-port Specifies the wizard that allows the user to configure serial ports on Remote RMX-3200. This wizard can configure any of the three most common serial port setups, which include terminal server, serial-to-IP and TBOS. The following parameter is accepted:


debug Displays debugging information during wizard execution.

(Dub)>config(Dub) config>use-wizard initsetup

-------------------------- initsetup --------------------------

This wizard configures initial connectivity settings.

An asterisk (*) in a selection list denotes the default value.

Ctrl-c aborts the wizard.

NOTE:This wizard provides only basic configuration. For additionalconfiguration options, consult the command reference guide.

Hostname of this device:

WESTELL.COM

1-800-377-8766

Page 2-281

Remote RMX-3200 Version 5.4x Command Reference GuideConfiguration Commands: config users

config users

DescriptionThese commands:

Add new users

Delete existing users

Reset existing users

Change passwords for existing users

Optionally enable a strong password

Note: Remote RMX-3200 allows for the configuration of up to 20 users.

Formatsconfig users

add username profile password confirm_passworddelete usernamepassword usernamestrong-password { enable | disable }

For resetting users:config default users

Parameters

add Adds a new user to the Remote RMX-3200 configuration. The following parameters are accepted: username—Defines the name of the new user. The length for a

user name is 2 to 20 alphanumeric characters. This value is case-sensitive.

profile—Defines a profile to assign to the new user. A profile gives the user designated permissions in Remote RMX-3200. User profiles can be status, management, supervisor, or restricted.

password—Defines a password for the new user. The length for a password is 2 to 20 alphanumeric characters. This value is case-sensitive. If you neglect to specify password, Remote RMX-3200 prompts you to do so.

confirm_password—Requires the user to re-enter the assigned password.

WESTELL.COM

Page 2-282

1-800-377-8766


Table 15 lists available user profiles and permission levels for Remote RMX-3200.

Command DefaultsUsername admin

delete Deletes a user from the Remote RMX-3200 configuration. The following parameter is accepted:

username—Defines the name of the new user. The length for a user name is 2 to 20 alphanumeric characters. This value is case-sensitive.

password Configures a new password for a user. The following parameter is accepted:

username—Defines the name of the new user. The length for a user name is 2 to 20 alphanumeric characters. This value is case-sensitive.

strong-password

Establishes additional validations on new or changed user passwords. When the strong password option is enabled, user passwords must contain at least three of the following character types: upper case, lower case, numerical and symbols. The minimum length for a strong password is eight characters and when the password is changed, the new password must differ from the old one by at least three characters. The following parameters are accepted: enable—Enables the strong password feature. disable—Disables the strong password feature. This feature is

disabled by default.

default Resets the primary user to default user ai and deletes all other users from Remote RMX-3200.

Table 15 User Profiles and Permission Levels

User Profile Permission

status Provides permission to all show commands (for example, display options, status and settings) and most utility commands.

management Provides permission to all show commands, most config commands and all utility commands.

supervisor Provides permission to all show commands, config commands, utility commands and most diag commands.

restricted Allows access to the terminal server, but restricts CLI activity to logging out only. No files are available for retrieval using FTP.

WESTELL.COM

1-800-377-8766

Page 2-283


Password password


ExamplesThis example displays enabling the strong password feature.

This example displays adding user jeff and profile status. Note that the initial password entered did not meet the criteria for the strong password feature.

This example displays the deletion of the user johndoe from Remote RMX-3200.

This example displays the configuration of a new password for user brb22.

This example displays the resetting of the default username and password.

See Also

(Dub)>config(Dub) config>users(Dub) config users>strong-password enabled(Dub) config users>

(Dub) config users>add jeff statusPlease enter the new password. *********Please confirm the new password. *********[ATHM0029] Password must contain at least one character from three of the following types: upper-case, lower-case, numerical and special punctuation.(Dub) config users>add jeff statusPlease enter the new password. *********Please confirm the new password. *********(Dub) config users>

(Dub)>config(Dub) config>users(Dub) config users>delete johndoe(Dub) config users>

(Dub)>config(Dub) config>users(Dub) config users>password brb22Please enter the new password. ******Please confirm the new password. ******(Dub) config users>

(Dub)>config(Dub) config>default users(Dub) config>

WESTELL.COM

Page 2-284

1-800-377-8766


password

show users

WESTELL.COM

1-800-377-8766

Page 2-285


WESTELL.COM

Page 2-286

1-800-377-8766

CHA

PTER 3

Show Commands

This chapter describes the Remote RMX-3200 show commands. The show commands are listed in alphabetical order and each command is described in detail.


Show Command Overview

List of Show Commands

Page 3-1

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: Show Command Overview

Show Command OverviewShow commands display Remote RMX-3200 options, statuses and settings. Typically, the results of what you configure in Remote RMX-3200 with the config command can be displayed with the show command.

The show commands do not have default values and generally only require optional parameters. To use show commands, enter command show from the CLI.

WESTELL.COM

Page 3-2

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: List of Show Commands

List of Show CommandsThe following is a list of all of the show commands as displayed from the CLI. The (+) sign after a command indicates that it has multiple arguments.

(Dub)>show [? does not display in CLI]Commands actions Displays a summary for all configured actions or a detailed summary for a specific action. alarm-entries Displays alarm entries. audit(+) Displays reports of actions, events, and responses that are missing associations. banner Displays the configured banner. clock Displays the clock time and date settings. compact-flash Displays compact flash size. config-file Displays a configuration or patch configuration file. connections Displays summary information for all mediation connections or a detailed summary for a specific mediation connection. controllers Displays information for configured controllers. correlations Displays a summary of all configured event correlations or a detailed summary for a specific event correlation. debugging(+) Displays information relating to the status of debugging on the device. dhcp-relay Displays the bootp/DHCP relay configuration. dhcp-server Displays the DHCP server configuration. discrete(+) Displays configured discrete points. events Displays a summary of all configured events or a detailed summary for a specific event. expansion-images Displays the peripheral expansion image headers. fan Displays fan status. interfaces Displays information for configured interfaces. inventory Displays hardware inventory. ip(+) Displays IP settings. iptables(+) Displays iptables configuration information. jobs(+) Displays job information. licenses Lists each of the open source packages and the entire contents of their license files and copyright statements. listeners Displays the destinations that are listening for mediation connections in the system. log-file Displays the current debug log file. meas-table Displays the attributes of the measurement table. mediation(+) Displays mediation settings.show--More-- [press space bar to continue list]

WESTELL.COM

1-800-377-8766

Page 3-3

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: List of Show Commands

ntp Displays the NTP configuration. peripherals Displays the peripherals that have been discovered or configured pkgs(+) Displays package information. product Displays product information. profiles Displays all profiles. ras Displays RAS parameters. remote-access Displays the remote access configuration. resource-tracking Displays items that have been marked for resource usage tracking. responses Displays a summary of all configured responses or a detailed summary for a specific response. running-config Displays the current operating configuration. site(+) Display information about modules. sitebus Displays the sitebus devices that have been discovered or configured. snmp(+) Displays SNMP configuration information. tbos(+) Displays TBOS configuration information. test(+) Displays test settings. timeout Displays the session timeout. timers Display timers. users Displays all users. version Displays the currently installed software version.

Enter ? to see available global commands.(Dub)>show

WESTELL.COM

Page 3-4

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show actions

show actions

DescriptionThis command displays a basic summary of all actions or a detailed summary for a specific action.

Formatsshow actions [ action_name ]

Parameters

Required User Profilesstatus, management, supervisor

ExamplesThis example displays a summary of all configured actions.

action_name Defines the name of the action being displayed.

Tip: To display summarized information for all actions with names beginning with a specific character or characters, enter a partial action name followed by *. For example, to display all Telnet connection actions, enter show actions Telnet*.

(Dub)>show(Dub)show>actions Name Event Name Response Name Description------------------------------------------------------------------------------ doorOpenAlm doorOpen doorOpenTl1Alm Door open alarm a... waterLvlAlm waterLvlHigh waterLvlTl1Alm Water level alarm

(Dub)show>

Column Description

Description Displays the configured action descriptions.

Event Name Displays the events that are associated with corresponding actions.

Name Displays the names of configured actions.

Response Name

Displays the responses that are associated with corresponding actions.

WESTELL.COM

1-800-377-8766

Page 3-5


This example displays a detailed summary of action doorOpenAlm.

(Dub)>show(Dub)show>actions doorOpenAlmAction Name : doorOpenAlmAction Description : Door open alarm action

Event Name : doorOpenEvent Description : Door open indicatorEvent Originator : input 1Event Type : open

Response Name : doorOpenTl1AlmResponse Description : Door open alarm responseResponse Responder : tl1ne 2Response Type : tl1alarmResponse Parameters : almcde=CR tl1msg=REPT ALM ENV textblk=point1:CR,DOOR(Dub)show>

Column Description

Action Description Displays the description for a specified action.

Action Name Displays the name of a specified action.

Event Description Displays a description for the displayed event.

Event Name Displays the name of an event associated with the specified action.

Event Originator Displays an event originator, which generates an event.

Event Type Displays the event type for the displayed event.

Response Description

Displays a description for the response.

Response Name Displays the response that is associated with the specified action. A response is an expression that defines a system activity that occurs in response to events.

Response Parameters

Displays the configured response parameters for various types of TL1 alarm responses. For more information about response parameters, refer to the response configuration commands.

Response Responder Displays a response responder, which processes a response.

WESTELL.COM

Page 3-6

1-800-377-8766



config event

config response

Response Type Displays a response type.

Column Description (Continued)

WESTELL.COM

1-800-377-8766

Page 3-7

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show alarm-entries

show alarm-entries

DescriptionThis command displays all central alarm table entries, an individual alarm table entry, or all alarm table entries with a specified severity level.

Formatsshow alarm-entries

[ name alarm | severity severity_level ][ nopage ]

Parameters


name Initiates the selection of an alarm name from the central alarm table. The following parameter is accepted:

alarm—Defines the name of an alarm entry for which detailed information will be displayed. Valid values are existing alarm entries.

Tip: To display information for all alarm entries that have names starting with a specific character or characters, enter a partial alarm entry name followed by *. For example, to display all TBOS alarm entries, enter show alarm-entries name TBOS*.

nopage Displays the entire list of alarm entries upon execution of the command. When this parameter is not specified, Remote RMX-3200 outputs the list of alarm entries one page at a time.

severity Initiates the selection of an alarm severity level. The following parameter is accepted:

severity_level—Defines the alarm severity level for which associated alarm entries will be displayed.

WESTELL.COM

Page 3-8

1-800-377-8766


ExamplesThis example displays all central alarm table entries.

This example displays specific information for alarm table entry input0_1.

(Dub)>show(Dub)show>alarm-entries Name State Trap Local Raw Tl1 Current alarm message------------------------------------------------------------------------------input0_1 normal + + + +input0_2 normal + - - -input0_3 normal + - - -input0_4 normal + - - -input0_5 normal + - - -input0_6 normal + - - -input0_7 normal + - - -input0_8 normal + - - -input0_9 normal + - - -input0_10 normal + - - -input0_11 normal + - - -input0_12 normal + - - -input0_13 normal + - - -input0_14 normal + - - -input0_15 normal + - - -input0_16 normal + - - -input0_17 normal + - - -input0_18 normal + - - -input0_19 normal + - - -input0_20 normal + - - -input0_21 normal + - - -(Dub)show>

(Dub)>show(Dub)show>alarm-entries name input0_1Name - input0_1State - normalCurrent Message -Description - Monitors MAC securityNagging Interval - 10Nagging Level - majorTrap - enabledTrap Priority - highRaw - enabledTL1 - enabledTL1 AID - input1TL1 Class - eqptTL1 Affect - saTL1 Type - eqptTL1NE - 1Category - SecurityNE Name - EthMonitorOriginator - ethernet5Alarm Actions: Severity Trigger Message------------------------------------------------------------------ major mac-violat MAC security violati(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-9


Display Item Description

Category Displays a category for an alarm entry. The category associates the alarm table entry with a specific application or business task.

Current Message

Displays the text message associated with the current state of the alarm.

Description Displays the text description for the alarm entry.

Message Displays the text string associated with the alarm.

Nagging Interval

Displays the time between occurrences of sending the alarm to all enabled protocols.

Nagging Level Displays the severity level at which the alarm gets sent repeatedly. Possible values are: normal warning minor major critical

Name Displays the name of the alarm entry.

NE Name Displays text that identifies the network element that the Remote RMX-3200 alarm entry represents.

Originator Displays the system component that generates the alarm.

Raw Displays the raw output status for an alarm entry as enabled or disabled. Raw output contains all of the data from the central alarm table.

Severity Displays the severity levels for associated alarm actions.

State Displays the alarm state. Possible states are: normal warning minor major critical

TL1 Displays the status of TL1 output for an alarm entry as enabled or disabled.

TL1 Affect Displays the TL1 alarm service-affecting status as service-affecting (sa) or non-service-affecting (nsa).

WESTELL.COM

Page 3-10

1-800-377-8766


See Alsoconfig alarm-entry

TL1 AID Displays the TL1 AID for an alarm entry. An AID identifies a NE subcomponent (similar to a port number).

TL1 Class Displays the TL1 alarm class as env, which signals the occurrence of an environmental event, or eqpt, which signals the occurrence of an equipment-related event.

TL1 Type Displays the configured alarm type for a TL1 environmental alarm or the configured condition type for a TL1 equipment alarm.

Note: For more information about alarm condition types, refer

to the Telcordia GR-833-CORE documentation.

TL1NE Displays the ID for the configured virtual TL1 NE.

Trap Displays the status of SNMP trap output for the specified alarm entry as enabled or disabled.

Trap Priority Displays the priority level for traps from the specified alarm entry as disabled, highest, high, normal, low, or lowest.

Trigger Displays the type of event that will set off the alarm.

Display Item Description (Continued)

WESTELL.COM

1-800-377-8766

Page 3-11

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show audit

show audit

DescriptionThese commands display all actions, events and responses that are missing data required for proper operation.

Formatsshow audit

actionseventsresponses

Parameters


actions Displays all actions that meet any or all of the following criteria: Contain no associated event Contain no associated response Contains an associated event that is not configured Contains an associated response that is not configured Contain an event/response pair that matches the event/response

pair of another action.

events Displays all events that meet any or all of the following criteria: Are not used by any actions Are not fully configured Contain content that duplicates another event’s content.

responses Displays all responses that meet any or all of the following criteria: Are not used by any actions Are not fully configured Contain content that duplicates another response’s content.

WESTELL.COM

Page 3-12

1-800-377-8766


ExamplesThis example displays all audited actions:

(Dub)>show(Dub)show>audit(Dub)show audit>actionsAction : latchOpenIssue : No response configured

Action : waterLvlIssue : No event configured

Action : airPressureIssue : Event e2 missingIssue : Response r2 missing

Action : a1Issue : Duplicate event/response pairs: (a1, a2)

Action : a2Issue : Duplicate event/response pairs: (a1, a2)

(Dub)show audit>


Action Displays an audited action.

Issue Displays one of the following issues associated with a flagged action: No event configured No response configured Event event name missing Response response name missing Duplicate event/response pairs.

WESTELL.COM

1-800-377-8766

Page 3-13


This example displays all audited events.

This example displays all audited responses.

(Dub)>show(Dub)show>audit(Dub)show audit>eventsEvent : e1Issue : Duplicate content: (e1, e2)

Event : analogIntervalIssue : Not used in any actions

Event : tempHighIssue : Not used in any actionsIssue : Not fully configured

Event : e2Issue : Duplicate content: (e1, e2)

(Dub)show audit>


Event Displays an audited event.

Issue Displays one of the following issues associated with a flagged event: Not used in any actions Not fully configured Duplicate content.

(Dub)>show(Dub)show>audit(Dub)show audit>responsesResponse : waterLvlAlmIssue : Not used in any actionsIssue : Not fully configured

Response : ethernetDisableIssue : Not used in any actions

Response : doorOpenIssue : Not used in any actionsIssue : Duplicate content: (doorOpen, connDestData)

Response : connDestDataIssue : Not used in any actionsIssue : Duplicate content: (doorOpen, connDestData)

(Dub) show audit>

WESTELL.COM

Page 3-14

1-800-377-8766




Issue Displays one of the following issues associated with a flagged response: Not used in any actions Not fully configured Duplicate content

Response Displays an audited response.

WESTELL.COM

1-800-377-8766

Page 3-15

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show banner

show banner

DescriptionThis command displays the Remote RMX-3200 banner.

Formatsshow banner


ExamplesThis example displays the banner configuration for Remote RMX-3200 with the time and date displaying with the text, This is my banner.

See Alsoconfig banner

(Dub)>show(Dub)show>bannerThis is my banner.\d\t(Dub)show>

WESTELL.COM

Page 3-16

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show clock

show clock

DescriptionThis command displays the configured date and time for Remote RMX-3200.

Formatsshow clock


ExamplesThis example displays the time and date information for Remote RMX-3200. Display items are:

The date, time and year The Remote RMX-3200 card uptime (the time since the card was last reset) The timezone (EST) and offset The daylight savings time start and end parameters The log timestamp parameters.

See Also config clock

(Dub)>show(Dub)show>clockTue Jul 31 16:28:44 EDT 2009Uptime 13 days, 5:56The timezone is named EST and has an offset of -05:00 GMT.Daylight savings time is named EDT and using default U.S. rules.Log timestamps are using local-time.(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-17

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show compact-flash

show compact-flash

DescriptionThis command displays the compact flash memory card size.

Formatsshow compact-flash


ExamplesThis example displays the size of the compact flash card.

(Dub)>show(Dub)show>compact-flashCompact Flash Size: 248472 kbytes(Dub)show>

WESTELL.COM

Page 3-18

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show config-file

show config-file

DescriptionThis command displays a configuration file. Remote RMX-3200 configuration files contain initialization information.

Note: Users with a supervisor profile can view the entire configuration; however,

users with management and status profiles cannot view configuration information pertaining to users.

Formatsshow config-file

[ filename ][ nopage ]

Note: When entered without parameter filename, this command lists the names

of all available configuration files (files listed in Table 1, plus any additional user-defined configuration files).

Parameters

filename Defines the name of the configuration file. File names are case-sensitive.

Note: There are three common values that can be entered as a file

name. Refer to Table 1.

nopage Displays the entire configuration file upon execution of the command. When this parameter is not specified, Remote RMX-3200 outputs the configuration file one page at a time.

Table 1 Special Values for File Names

Special File Name Description

running-config This configuration file contains the configuration that controls current operation of Remote RMX-3200. For more information, refer to running-config on page 5-42.

startup-config This configuration file contains the configuration at start-up time for Remote RMX-3200.

WESTELL.COM

1-800-377-8766

Page 3-19



ExamplesThis example displays all the available configuration files.

factory-config This configuration file contains the factory defaults for Remote RMX-3200.

Note: If factory-config is entered for filename, no

information will be displayed. This is because Remote RMX-3200 displays only the differences between system defaults and the configuration itself. Because the factory configuration contains nothing but defaults, no information will appear.

(Dub)>show(Dub)show>config-filefactory-configrunning-configstartup-config(Dub)show>

Table 1 Special Values for File Names (Continued)

Special File Name Description

WESTELL.COM

Page 3-20

1-800-377-8766


This example displays configuration file startup-config.

See Alsocopy

erase

running-config

(Dub)> show config-file startup-config# Product: Remote RMX# Version: 3.30# Created: 2010-11-01,14:52:35.0,-0500# User: test# Stage2 Version: 4.06config clock timezone est 12:00config clock daylight-savings edtconfig clock timestamp GMTconfig dhcp-relay server 10.39.70.40config ip name-server 10.25.2.5config ip name-server 10.25.2.20config ip route default 10.43.0.1config mediation tacacs-service shellconfig ras shell tacacs+ fallbackconfig remote-access ssh-sftp enableconfig snmp host 10.34.3.84 162 public v1config snmp host 10.34.3.83 162 public v2-informconfig snmp host 10.34.3.86 162 public v2config timeout 0config users add test supervisor -e$1$Qzv94sky$J/XFok7lVjo8E/lmbH9fh. -e$1$Qzv94

sky$J/XFok7lVjo8E/lmbH9fh.config users add ebh restricted -e$1$GIr1Aifc$vpg8Zu1JMBLZQUHPMDM31. -e$1$GIr1Ai--More--

WESTELL.COM

1-800-377-8766

Page 3-21

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show connections

show connections

DescriptionThis command displays summary information for all mediation connections or detailed information for a specified mediation connection. A mediation connection is a connection between two dissimilar communication technologies, such as a TCP session and an asynchronous serial link.

Formatsshow connections [ connection_point ]

Parameters


ExamplesThis example displays summary information for all mediation connections.

connection_point Defines a mediation connection end point or filter that is part of a connection for which detailed information will be displayed.

(Dub)>show(Dub)show>connectionsserial6TbosPortMgr6 -> serial 6tcp 10.40.57.5:40001:3 -> tl1mux 1tl1mux 1-ne:1 -> tl1ne 1(Dub)show>


Connection Endpoints Displays the originating and accepting connection endpoints for all configured connections. The second displayed connection has the following characteristics: Originating endpoint type TCP IP address 10.40.57.5 Port number 40001 Internal reference number 3 Accepting endpoint tl1mux 1

WESTELL.COM

Page 3-22

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show connections

This example displays detailed information for a connection that terminates with endpoint tl1mux 1. The statistics are from the point of view of the originating end of the connection (tcp 10.40.57.5:40001:3).

See Alsoconfig event content


(Dub)>show(Dub)show>connections tl1mux 1tcp 10.40.57.5:40001:3 -> tl1mux 1

State: CONNECTED Bytes Sent: 7Bytes received: 90 Conn Duration: 1051

(Dub)show>


Bytes Sent Displays the number of bytes sent across the connection.

Bytes received Displays the number of bytes received from the connection.

Conn Duration Displays the length of time (in seconds) that the connection has been up.

Connection Endpoints Displays the originating and accepting connection endpoints for a specific connection.

State Displays the state of the connection as RESOLVING_ADDRESS, CONNECTING, END-TO-END-CONNECTING, or CONNECTED.

WESTELL.COM

1-800-377-8766

Page 3-23

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show controllers

show controllers

DescriptionThis command displays configuration information for all Remote RMX-3200 controllers.

Formatsshow controllers [ * ]

Parameters


ExamplesThis example displays the first screen of detailed information for all configured Remote RMX-3200 controllers.

* Displays configuration information for all controllers.

(Dub)>show(Dub)show>controllers *bridge switch system-name=br_switch status=enabled oper-state=up stp=enabled forward-delay=15 hello-time=4 max-age=22 priority=65535 description=Switch controller ethernet 1 cost=100 priority=128 stp_state=forwarding stp_root_port ethernet 3 cost=45 priority=50 stp_state=disabled ethernet 4 cost=100 priority=128 stp_state=disabled ethernet 5 cost=100 priority=128 stp_state=disabled ethernet 6 cost=100 priority=128 stp_state=disabled serial 4 cost=21000 priority=210 stp_state=unmanaged

ethernet 1 system-name=mii0 status=enabled link-state=up admin-speed=auto oper-speed=100F hardware-address=00:40:72:04:2D:9B default-address=00:40:72:04:2D:9B desc=Switch port mac-security admin-state=disabled oper-state=disabled

ethernet 2 system-name=mii1 status=enabled link-state=down admin-speed=auto oper-speed=10H hardware-address=00:40:72:04:2D:9C default-address=00:40:72:04:2D:9C--More--

WESTELL.COM

Page 3-24

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show controllers

For more information about the command output, refer to commands show controllers bridge on page 3-26, show controllers ethernet on page 3-30, show controllers serial on page 3-40 and show controllers openvpn on page 3-35.






show controllers serial

WESTELL.COM

1-800-377-8766

Page 3-25

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show controllers bridge

show controllers bridge

DescriptionThis command displays configuration information for all Remote RMX-3200 bridge controllers or for a specified Remote RMX-3200 bridge controller.

Formatsshow controllers bridge

*switch [ mac ]

Parameters


* Displays configuration information for all controllers or for all controllers of a specified type.

switch Displays bridge switch configuration information along with cost and priority information for the associated Ethernet and serial controllers. The following parameter is accepted:

mac—Displays all MAC addresses with their associated ports for the specified bridge group.

WESTELL.COM

Page 3-26

1-800-377-8766


ExamplesThis example displays information for Remote RMX-3200 controller bridge switch along with cost and priority information for the associated Ethernet controllers.

This example displays MAC addresses with their associated ports on bridge switch.

(Dub)>show(Dub)show>controllers bridge switchbridge switch system-name=br_switch status=enabled oper-state=up stp=enabled forward-delay=15 hello-time=2 max-age=20 priority=32768 description=10/100 ethernet switch

ethernet 0 mode=native cost=100 priority=128 stp_state=forwarding ethernet 1 mode=native cost=100 priority=128 stp_state=forwarding stp_root_port ethernet 2 mode=native cost=100 priority=128 stp_state=unmanaged ethernet 3 mode=native cost=100 priority=128 stp_state=unmanaged ethernet 4 mode=native cost=100 priority=128 stp_state=unmanaged ethernet 5 mode=native cost=100 priority=128 stp_state=unmanaged ethernet 6 mode=native cost=100 priority=128 stp_state=unmanaged ethernet 7 mode=native cost=100 priority=128 stp_state=unmanaged ethernet 8 mode=native cost=100 priority=128 stp_state=unmanaged(Dub)show>

(Dub)>show(Dub)show>controllers bridge switch macController MAC Address Is Local? Age(sec)-------------------------------------------------------------------------ethernet 1 00:01:02:ea:d3:ba no 245ethernet 1 00:01:02:ec:04:b1 no 289ethernet 1 00:01:02:ee:3c:30 no 197ethernet 1 00:01:02:ee:f6:70 no 284ethernet 1 00:04:75:96:31:dd no 90ethernet 1 00:04:75:96:63:5d no 90ethernet 1 00:06:5b:a8:05:74 no 12ethernet 1 00:0c:29:02:62:ff no 117ethernet 1 00:0c:29:08:da:7a no 178ethernet 1 00:0c:29:2a:0b:24 no 282ethernet 1 00:0c:29:77:32:fe no 197ethernet 1 00:0c:29:7a:99:39 no 79ethernet 1 00:0c:29:81:19:58 no 259ethernet 1 00:0c:29:fa:2f:a3 no 245ethernet 1 00:0d:56:0e:17:99 no 228ethernet 1 00:0d:56:0f:33:8e no 238ethernet 1 00:10:4b:cd:41:f6 no 197ethernet 1 00:10:83:fd:df:1b no 30ethernet 1 00:14:22:46:29:c9 no 196ethernet 1 00:14:22:46:2a:1f no 245ethernet 1 00:40:72:00:7f:96 no 156ethernet 1 00:40:72:04:2d:9a yes 0ethernet 1 00:40:72:0a:03:6a no 260ethernet 1 00:50:da:16:dc:ac no 2ethernet 1 00:60:08:ad:a6:ff no 245ethernet 1 00:e0:52:cc:0b:00 no 2(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-27


Example DescriptionsThe following table defines the display items that appear in the previous examples. Display items are listed in alphabetical order.


Age(sec) Displays the MAC address age in seconds.

Controller Displays the controller associated with the MAC address.

cost Displays the cost for a corresponding Ethernet or serial controller. Cost is a metric used in route calculations to determine the best path for reaching a destination. The higher a path's cost, the less desirable it is to use that path.

description Displays the configured bridge controller description.

forward-delay

Displays the forward delay time for STP. Forward delay time specifies: The amount of time a controller spends in the listening state

before entering the learning state The amount of time a controller spends in the learning state

before entering the forwarding state The aging time for dynamic entries in the filtering database

during a network topology change.

hello-time Displays the hello time for STP. The hello time is the interval between the generation of configuration bridge PDUs when the bridge is either the root bridge or when it is trying to become the root bridge.

Is Local? Displays if the MAC address and associated controller are local or remote.

MAC Address Displays a list of MAC addresses on the bridge controller.

max-age Displays the maximum age before protocol information for STP is discarded.

oper-state Displays the operational state of the controller (the state the controller is actually in) as up or down.

priority Displays the priority value for a bridge, Ethernet, or serial controller. The priority value represents the desirability of one controller over another.

status Displays the controller or channel group state as enabled or disabled.

WESTELL.COM

Page 3-28

1-800-377-8766



show controllers

stp Displays the status of the STP as enabled or disabled. STP deactivates bridged links so that forwarding loops do not occur in bridged networks.

stp_state Displays the state of the spanning tree protocol for an Ethernet controller.

system-name Displays the controller’s system name (for example, br_br1, hdlc0, or eth0_1).


WESTELL.COM

1-800-377-8766

Page 3-29

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show controllers ethernet


DescriptionThis command displays configuration information for all Remote RMX-3200 Ethernet controllers or for a specified Remote RMX-3200 Ethernet controller.

Formatsshow controllers ethernet [ * | port | wan/port | unit/port ]

Parameters


ExamplesThis example displays detailed information for controller ethernet 2.

* Displays configuration information for all Ethernet controllers.

port Selects an Ethernet port number. If the WGBE card is installed in the expansion slot, ports wan/1 and wan/2 represent WGBE’s 1000baseT ports, while wan/3 and wan/4 represent WGBE’s fiber SFP ports.

unit Defines the peripheral expansion unit where the physical port associated with the RME-E8 controller is located. Valid values are 1 to 12.

(Dub)>show(Dub)show>controllers ethernet 2ethernet 2 system-name=mii1 status=enabled link-state=down admin-speed=auto oper-speed=10H hardware-address=00:40:72:04:2D:9C default-address=00:40:72:04:2D:9C proxy-arp=enabled resource-state=assigned desc=Ethernet 2 mac-security admin-state=disabled oper-state=disabled address=00:E0:52:CC:0B:00 address=22:22:22:22:22:22 ppp defaultroute=false local-method=none local-identity= remote-method=none remote-identity= mru=1492 mtu=1492 lcp-requests=enabled inactivity-timeout=20(Dub)show>

WESTELL.COM

Page 3-30

1-800-377-8766




admin-speed Displays the configured speed for the port. admin-speed=auto means that the fastest port speed possible is automatically negotiated between the controller and the remote device.

default-address Displays the default hardware address, which represents the controller’s hardware address when Remote RMX-3200 first starts up.

Note: The hardware address and default hardware

address values are almost always identical. If the user does change the hardware address, the default address will display the original hardware address.

defaultroute Displays the status of the default route option as true or false. When this option is true, Remote RMX-3200 dynamically creates a default route with a peer as the gateway. The gateway address value is added to the routing table when the interface successfully negotiates and acquires a remote address from the peer.

desc Displays the configured controller description.

hardware-address Displays the port hardware address, which represents the controller's current MAC address.

inactivity-timeout Displays the time frequency (in minutes) that received packet (Rx) statistics will be checked on a portto determine if it is still active.

lcp-requests Displays the status of Remote RMX-3200’s ability to initiate or terminate a PPP link based on the presence of LCP echo requests.

WESTELL.COM

1-800-377-8766

Page 3-31


link-state Displays the state of the controller’s link as up or down.

Note: When a port is disabled (or enabled), its link

state may be listed as up or down. The link-state represents the presence of a cable connection on the port, whereas the port status represents the port’s ability to pass data.

local-identity Displays the local identity, which is similar to a user name, for CHAP and PAP authentication on a serial WAN controller. The local identity is supplied by the local site and sent to a remote device.

local-method Displays the method Remote RMX-3200 uses to authenticate a peer device on an Ethernet WAN controller PPP link. The two available methods are challenge handshake authentication protocol (CHAP) and password authentication protocol (PAP).

mac-security address

Displays each MAC address in the controller’s MAC address table.

mac-security admin-state

Displays the configured state of MAC security on the controller as enabled or disabled.

mac-security oper-state

Displays the actual state of MAC security on the controller as enabled or disabled.

mru Displays the maximum number of data bytes that can be received in a single PPP frame.For the Ethernet controller this is hard-coded at 1492.

mtu Displays the maximum number of data bytes that can be transmitted in a single PPP frame.For the Ethernet controller, this is hard-coded at 1492.

oper-speed Displays the speed that the port is currently using. This value will always be the same as the admin-speed value (unless admin-speed is auto).

ppp Displays the encapsulation protocol for the ethernet controller as PPP.


WESTELL.COM

Page 3-32

1-800-377-8766




show controllers

proxy-arp Displays the status of proxy ARP on a Ethernet controller as enabled or disabled. Proxy ARP is the technique by which a host answers ARP requests intended for another machine.

remote-identity Displays the remote identity, which is similar to a user name, for CHAP and PAP authentication on an Ethernet WAN controller. The remote identity is supplied by the peer device and sent to Remote RMX-3200.

remote-method Displays the method used by a peer device to authenticate Remote RMX-3200 for an Ethernet controller PPP link. The two available methods are challenge handshake authentication protocol (CHAP) and password authentication protocol (PAP).

resource-state Displays if the Ethernet controller is assigned to be tracked as a resource or not.


system-name Displays the controller’s system name (for example, hdlc0, or eth0_1).


WESTELL.COM

1-800-377-8766

Page 3-33

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show controllers nat64


DescriptionThis command displays configuration and runtime state for the nat64 controller, plus the dynamic mappings from the IPv4 pool.

Formatsshow controllers nat64

ParametersNone.

Example:The following shows the show controllers nat64 command CLI output with the following parameters configured:

nat64 enabled on an IPv6 and an IPv4 interface

NAT64 controller IPv6 address fc11::39:0:0:abd:def

IPv4 address pool 192.169.100.0/24

Static mapping of IPv4 address 193.169.100.10 fd11::39:0:0:c1a9:640a

See Also:config controller nat64

config interface nat64

(Kentrox)>show(Kentrox) show>controller nat64nat64 system-name=nat64 status=enabled link-state=up ipv4-pool=192.169.100.0/24 ipv6-address=fc11::39:0:0:abd:def

Static Map: 193.169.100.10 fd11::39:0:0:c1a9:640a(Kentrox) show>

WESTELL.COM

Page 3-34

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show controllers openvpn


DescriptionThis command displays configuration information for:

All OpenVPN controllers

A specified OpenVPN controller

Clients that are connected to an OpenVPN server.

Formatsshow controller openvpn [name [ clients | client-count]

Parameters

Note: The parameters clients and client counts apply only to server and site-server mode and not to client mode.


ExamplesThis example displays detailed information for OpenVPN controller client:

name Specifies the name of the OpenVPN controller.

clients Displays the clients connected to an OpenVPN server or site server. This parameter is only available for OpenVPN controllers in server mode or site-server mode. However, typically, the Remote RMX-3200 will not be configured to run in server mode. A client name may be shown as (unknown) if it has connected to the server but has not yet finished authentication.

Note: Only available in server or site-server modes.

client- count

Displays information about the number of clients connected to the site VPN server.

Note: Only available in server or site-server modes.

* Displays configuration information for all openvpn controllers or for all controllers of a specified type.

WESTELL.COM

1-800-377-8766

Page 3-35



(Dub)>show controllers openvpn clientopenvpn client system-name=ovpn_client status=enabled link-state=down hardware-address=00:FF:DD:22:60:57 default-address=00:FF:DD:22:60:57 mode=client server=192.228.36.48:1194 cipher=aes-256 vpn-state=waiting-response, Sat Apr 11 16:42:40 GMT 2009 cert-subject=/O=AI/CN=ATTRemoteRMX cert-validity-start=Fri Nov 7 05:00:00 GMT 2008 cert-validity-end=Thu Nov 7 05:00:00 GMT 2013 vpn-rx-bytes=0 vpn-tx-bytes=0(Dub)>


addr Displays the address and port number for a client connected to the OpenVPN server.

cert-subject

cert-validity-end Displays the date and time at which this certificate token will become invalid.

cert-validity-start

Displays the date and time at which this certificate token became valid.

cipher Displays the cryptographic cipher for encrypting packets on an OpenVPN controller. One of the following options may appear: 128-bit Blowfish, which is the fastest option. This

algorithm is the default. 256-bit AES, which is the most secure, but slowest

option. 128-bit AES, which is similar in strength to 128-bit

Blowfish algorithm, but slower.

client-route Displays the interface (Ethernet or bridge) whose networks are used to route clients to the Remote by the way of VPN connection.

connected Displays the time and date that a client was connected to the OpenVPN server.

WESTELL.COM

Page 3-36

1-800-377-8766


default-address Displays the default hardware address, which represents the controller’s hardware address when Remote RMX-3200 first starts up.

Note: The hardware address and default hardware

address values are almost always identical. If the user does change the hardware address, the default address will display the original hardware address.

desc Displays the configured controller description.

hardware-address Displays the port hardware address, which represents the controller's current MAC address.

keep-alive-inactive

Displays the number of seconds that a session must be inactive before a ping packet is transmitted.

keep-alive-disconnect

Displays the number of seconds that a peer can go without receiving packets before it is considered disconnected.


mode Displays if the OpenVPN controller is in client or server mode.

port Displays the port a server uses to communicate with clients for an OpenVPN controller. The following parameter is accepted:

port—Displays the port a server uses to communicate with clients. Valid values are 1024 to 65535. The default value is OpenVPN standard port 1194.

protocol Displays the protocol (TCP or UDP) used for communication between the site server and clients.

server Displays the address and port number for an OpenVPN server.


system-name Displays the controller’s system name (for example, br_bg2, hdlc0, or eth0_1).

vpn-rx-bytes Displays how many bytes have been received on the VPN.


WESTELL.COM

1-800-377-8766

Page 3-37


vpn-state Displays the VPN state and connection date. One of the following VPN states may appear: initial—The VPN daemon is running. connecting—The VPN daemon is connecting to the

server (if running in client mode) or its local socket (if running in server mode).

assigning-IP—The VPN daemon is assigning an IP address to the local network interface.

adding-routes—The VPN daemon is adding routes to the local device.

connected—The VPN daemon is fully authenticated and connected to the server (client mode) or able to accept client connections (server mode).

reconnecting—The VPN daemon is attempting to reconnect to the server (client mode).

exiting—The VPN daemon is exiting. waiting-response—The VPN daemon is waiting for a

response from the server (client mode). authenticating—The VPN daemon is authenticating

with the server (client mode). retrieving-config—The VPN daemon is retrieving

configuration from the server (client mode). disabled—The VPN daemon controller is disabled

and the daemon is fully stopped. waiting-config—The VPN manager is waiting for

configuration information to be supplied. waiting-token—The VPN manager is waiting for a

valid certificate token to be installed. waiting-crl—The VPN manager is waiting for a valid

certificate revocation list (CRL) to be installed. waiting-daemon—The VPN manager is waiting for the

VPN daemon to be started. waiting-daemon-stop—The VPN manager is waiting

for the VPN daemon to be stopped. daemon-stopped—The VPN daemon has been

stopped.

vpn-tx-bytes Displays how many bytes have been transmitted on the VPN.


WESTELL.COM

Page 3-38

1-800-377-8766





show controllers

WESTELL.COM

1-800-377-8766

Page 3-39

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show controllers serial


DescriptionThis command displays configuration information for all Remote RMX-3200 serial controllers or for a specified Remote RMX-3200 serial controller. It also displays G.826 and RFC-1406 statistics.

Formatsshow controllers serial

*{ async_port | unit/async_port }{ EVDO port | HSPA_port } [ nai | namval | diagnostics ]LTE_port diagnosticswan_port [ statistics G.826 | statistics RFC-1406 [ current |

interval intervals | total ] ]

Parameters

* Displays configuration information for all serial controllers.

async_port Selects an asynchronous serial port number.

EVDO_portHSPA_port

Displays serial controller information about the EVDO or HSPA wireless modem on an RMX-WWAN expansion card, such as wan/1. The following parameters are accepted: diagnostics—Displays detailed diagnostic information about

the modem.

namval—Displays the Directory Number, Mobile ID Number, System ID and Network ID.

nai—Displays the Network Access ID.

Note: Make sure that the serial controller is disabled before

running the namval or nai commands. For more information, see the config controller serial command.

LTE_port Displays serial controller information about the LTE wireless modem on an RMX-WWAN expansion card, such as wan/1. The following parameter is accepted: diagnostics—Displays detailed diagnostic information about

the modem.

WESTELL.COM

Page 3-40

1-800-377-8766



ExamplesThis example displays the configuration information for asynchronous serial controller serial 2.

unit Defines the peripheral expansion unit in which the asynchronous serial port async_port is located. Valid values are 1 to 12.

wan_port Selects a WAN serial port number (such as wan/1 or wan/2) on an RMX-WTE expansion card. The following parameters are accepted: current—Displays the RFC 1406 current table. G.826—Displays G.826 statistics for WAN serial controllers. interval—Displays a specified number of intervals from the

RFC 1406 interval table (starting with the last tables). intervals—Specifies the number of intervals to display from

the RFC 1406 interval table. RFC-1406—Displays RFC 1406 statistics for WAN serial

controllers. statistics—Displays statistics for WAN serial controllers. total—Displays the RFC 1406 total table.

(Dub)>show(Dub)show>controllers serial 2serial 2 status=enabled link-state=up encapsulation= baud=4800 databits=8 stopbits=1 parity=none resource-state=unassigned flow-control=none linemode=rs485h dial-timer=1 init-string= connect-mode=

rts-connect-mode=on dtr-connect-mode=on disconnect-mode= rts-disconnect-mode=off dtr-disconnect-mode=off parity-errors=0 lineterm=enabled description=Asynchronous port application=source destination(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-41


This example displays the configuration information for controller serial wan/1 using an RMX-WTE expansion card.

This example displays the configuration information for controller serial wan/1 using an RMX-WWAN expansion card.

(Dub)>show(Dub)show>controllers serial wan/1serial wan/1 status=enabled resource-state=unassigned rx-link-state=LOF tx-link-state=RAI local-loop=norm clock=loop framing=no-crc4 oper-framing=no-crc4 linecode=hdb3

framer-crc-errors=0 framing-errors=0 line-coding-violations=1 far-end-block-errors=0

desc=E1 port channel-group=group status=enabled system-name=hdlc0 speed=64 encap=hdlc timeslot=1-31(Dub)show>

(Dub)>show(Dub)>show controllers serial wan/1serial wan/1 status=enabled link-state=up encapsulation=ppp init-string=AT+CGDCONT=1,"IP","isp.cingular" AT ATD*99***1# resource-state=assigned signal-strength=excellent (-74 dBm) service-level=3G sim=ready description=Wireless Modem ppp defaultroute=false local-method=none local-identity= remote-method=chap [email protected] mru=1520 mtu=1520 lcp-requests=disabled inactivity-timeout=3(Dub)show>

WESTELL.COM

Page 3-42

1-800-377-8766


This example displays the configuration information for controller serial wan/1 using an LTE modem:

This example displays the diagnostic output for a Sierra Wireless phone module with EVDO service.

(RMX105) show>(RMX105) show>cont ser wan/1serial wan/1 status=enabled link-state=down resource-state=unassigned signal-strength=excellent (-77 dBm) service-level=3G sim=pin-locked apn= default-route=false auth-method=none auth-username= description=LTE Modem(RMX105) show>

(Dublin)>show controllers serial wan/1 diagnostics ESN (hex): 60EF1234Modem manufacturer: Sierra WirelessModem model: MC5728Firmware version: p2813301 (06-24-10)Hardware version: MC5728V Rev 1.0PRL version: 53070Phone number: 6141234567MSID: 6141234567RSSI: -106dBmService: 3G EVDO Rev A and 2G 1xRTTRoaming: Not roamingMIP NAI: (Unavailable while controller is enabled)Activation: ProvisionedMIP error code: 0Channel: 875PN offset: 164Subnet color code:241Subnet mask: 100HDR session state: OpenUATI: 0x0080058000000000000ABC1E0BD0632FHDR authentication: AuthenticatedSingle-user packet error rate: 0%Multi-user packet error rate: 0%DRC value: 13SID: 21NID: 13Band: Cellular, 1X band class 1, EVDO band class 1(Dublin)>show

WESTELL.COM

1-800-377-8766

Page 3-43


This example displays the diagnostic output for an Ericsson wireless phone module with GSM service.

(Dublin)>show controllers serial wan/1 diagnostics Modem manufacturer: Ericsson Modem model: F3607gw Firmware version: R1K06IMEI: 353234030071797SIM locking: enabledSIM status: READYIMSI: 310410099157155SIM PIN remaining attempts: 3SIM PUK remaining attempts: 10SIM ICCID: 89014104200991571551Functionality: FullRegistration: Registered, home networkOperator: CingularService details: 3G WCDMA II (1937.50MHz) Supported bands: GSM850, EGSM900, DCS1800, PCS1900, WCDMA I, WCDMA II, WCDMA V, WCDMA VI Enabled bands: GSM850, EGSM900, DCS1800, PCS1900, WCDMA I, WCDMA II, WCDMA V, WCDMA VI

WESTELL.COM

Page 3-44

1-800-377-8766


This example displays the diagnostic output for a phone module with LTE service:

(RMX105) show>controllers serial wan/1 diagnosticsModem manufacturer: Sierra Wireless, IncorporatedModem model: MC7354Firmware version: SWI9X15C_05.05.16.02 r21040 carmd-fwbuild1 2014/03/17 23:49:48

Current firmware: modem id: 005.010_001, build: 05.05.16.02_ATTCurrent firmware: pri id: 005.010_001, build: 05.05.16.02_ATTPreferred firmware: modem id: 005.010_001, build: 05.05.16.02_ATTPreferred firmware: pri id: 005.010_001, build: 05.05.16.02_ATTESN (hex): 8033BFD7IMEI: 359225050043264MEID: 35922505004326SIM locking: disabledSIM status: READYQMI raw status: DISABLEDSIM PIN remaining attempts: 3SIM PUK remaining attempts: 10IMSI: unknownSIM ICCID: 89014102276197452459Home network: unknownPhone number: unknownAN-AAA status: no-requestService: WCDMA, limitedSIM reject information: unavailableSignals: RSSI -77 dBm, Ec/Io -10.5 dBDomain: noneService capability: cs-psRoaming status: offLocation area code: 17651Cell ID: 82343811MCC: 310MNC: 410High-speed service: hsdpa-hsupa-supportedRF band: wcdma-pcs-1900, channel 437Mode preferences: cdma-1x, cdma-1xevdo, gsm, umts, lteBand preferences: gsm-dcs-1800, gsm-900-extended, gsm-900-primary, gsm-850, gsm-pcs-1900, wcdma-2100, wcdma-pcs-1900, wcdma-850-us, wcdma-800, bc-15LTE Band preferences: 2, 4, 5, 17Default profile: 1Profile: 1: AT&T Mobile, APN: Broadband, Auth: None, User: , EnabledProfile: 16: AT&T Mobile, APN: Broadband, Auth: None, User: , Enabled(RMX105) show>

WESTELL.COM

1-800-377-8766

Page 3-45


This example displays the G.826 statistics for controller serial wan/1:

This example displays the contents of the RFC-1406 current table for controller serial wan/1.

(Dub)>show(Dub)show>controllers serial wan/1 statistics G.826serial wan/1 G.826 Statistics framer-crc-errors=0 framing-errors=0 line-coding-violations=1 far-end-block-errors=0

total-seconds=8343 available-seconds=0 unavailable-seconds=8343

total-errored-seconds=8343 total-severely-errored-seconds=8343 total-background-block-errors=0

available-errored-seconds=0 available-severely-errored-seconds=0 available-background-block-errors=0

errored-seconds-ratio=.00 severely-errored-seconds-ratio=.000 background-block-errors-ratio=.0000

(Dub)show>

(Dub)>show(Dub)show>controllers serial wan/1 statistics RFC-1406 currentserial wan/1 RFC 1406 Current Table Statistics index=102 errored-seconds=919 severely-errored-seconds=919 severely-errored-framing-seconds=919 unavailable-seconds=919 controlled-slip-seconds=0 path-coding-violations=0 line-errored-seconds=0 bursty-errored-seconds=0 degraded-minutes=0 line-code-violations=0

(Dub)show>

WESTELL.COM

Page 3-46

1-800-377-8766


This example displays the contents of the last 2 tables in the RFC-1406 interval table for controller serial wan/1.

This example displays the RFC-1406 total table for controller serial wan/1.

(Dub)>show(Dub)show>controllers serial wan/1 statistics RFC-1406 interval 2serial wan/1 RFC 1406 Interval Table Statistics index=102 number=1 errored-seconds=919 severely-errored-seconds=919 severely-errored-framing-seconds=919 unavailable-seconds=919 controlled-slip-seconds=0 path-coding-violations=0 line-errored-seconds=0 bursty-errored-seconds=0 degraded-minutes=0 line-code-violations=0 valid-data=true

index=102 number=2 errored-seconds=918 severely-errored-seconds=918 severely-errored-framing-seconds=918 unavailable-seconds=918 controlled-slip-seconds=0 path-coding-violations=0 line-errored-seconds=0 bursty-errored-seconds=0 degraded-minutes=0 line-code-violations=0 valid-data=true

(Dub)show>

(Dub)>show(Dub)show>controllers serial wan/1 statistics RFC-1406 totalserial wan/1 RFC 1406 Total Table Statistics index=102 errored-seconds=8183 severely-errored-seconds=8183 severely-errored-framing-seconds=8183 unavailable-seconds=8183 controlled-slip-seconds=0 path-coding-violations=0 line-errored-seconds=0 bursty-errored-seconds=0 degraded-minutes=0 line-code-violations=1

(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-47




application Displays the link application mode for the controller. The application mode sets up a serial controller as a destination for internal connections or gives the controller the ability to initiate internal connections when a system event occurs.

available-background-block-errors

Displays the number of available background block errors on a link as defined in ITU-T G.826.

available-errored-seconds Displays the number of available errored seconds on a link as defined in ITU-T G.826.

available-seconds Displays the number of available seconds on a link as defined in ITU-T G.826.

available-severely-errored-seconds

Displays the number of available severely errored seconds on a link as defined in ITU-T G.826.

background-block-errors-ratio

Displays the ratio of Background Block Errors (BBEs) on a link as defined in ITU-T G.826.

baud Displays the controller baud rate. The baud rate is the speed of the asynchronous connection in bits per second.

buildout Displays the line buildout for the controller. Buildout refers to the length of the cable (in feet) that is connecting the devices on each end of a T1 line or the level of attenuation (in decibels) required for the devices on each end of a T1 line to communicate.

WESTELL.COM

Page 3-48

1-800-377-8766


bursty-errored-seconds Displays the number of bursty errored seconds (also known as type B errored second). These are seconds with the following: Fewer than 320 and more than one path

coding violation error event No severely errored frame defects No detected incoming AIS defects.

channel

channel-group Displays the name of the configured channel group. For Remote RMX-3200, the only channel group that can be configured is group.

clock Displays the controller’s clock source. The available settings are loop and internal.

connect-mode Displays the connect mode for the controller. The connect mode sets the condition for the generation of a controller up event. Possible values are dcd, activity and no value.

controlled-slip-seconds Displays the number of controlled slip seconds. These are one-second intervals that contain one or more controlled slips. A controlled slip is the replication or deletion of the payload bits on a DS1 frame. A controlled slip may be performed when there is a difference between the timing of a synchronous receiving terminal and the received signal.

databits Displays the number of databits in a data byte transmitted or received by the controller.

defaultroute Displays the status of the default route option as true or false. When this option is true, Remote RMX-3200 dynamically creates a default route with a peer as the gateway. The gateway address value is added to the routing table when the interface successfully negotiates and acquires a remote address from the peer.


WESTELL.COM

1-800-377-8766

Page 3-49


degraded-minutes Displays the number of degraded minutes, which are minutes in which the estimated error rate exceeds 1E-6 but does not exceed 1E-3. Degraded minutes are determined by collecting all of the available seconds, removing any severely errored seconds, grouping the result in 60-second long groups and counting 60-second long groups as degraded if the cumulative errors during the seconds present exceed 1E-6.

dial-timer Displays the amount of time Remote RMX-3200 will wait for an asynchronous port to come up before the serial connection fails. This feature applies to asynchronous ports in DCD connect mode only.

disconnect-mode Displays the disconnect mode for the controller. The disconnect mode sets the condition for the generation of a controller down event. Possible values are dcd, break and no value.

dtr-connect-mode Displays the state of a DTR signal when a controller is connected. A DTR signal is a control signal on an RS-232 serial port. When a terminal device is powered on and initialized, the DTR signal is turned on.

dtr-disconnect-mode Displays the state of a DTR signal when a controller disconnects. A DTR signal is a control signal on an RS-232 serial port. When a terminal device is powered on and initialized, the DTR signal is turned on.

encap Displays the encapsulation format for the controller. This is the protocol that carries IP or Ethernet packets over the serial link.

encapsulation Displays the encapsulation protocol for the serial controller as PPP.


WESTELL.COM

Page 3-50

1-800-377-8766


errored-seconds For ESF and E1-CRC links, an errored second is one with: One or more path code violations One or more out of frame defects One or more controlled slip events A detected AIS defect.For D4 and E1-noCRC links, the presence of Bipolar causes errored seconds.

errored-seconds-ratio Displays the ratio of Errored Seconds (ESs) to total seconds on a link as defined in ITU-T G.826.

flow-control Displays the flow control for the method used by the controller. Flow control is a mechanism used to make sure that data is not lost if a receiver is slower than a transmitter. The possible methods are hardware, xon/xoff and none. Hardware flow control uses electrical signals to control the flow of data and works for either binary or ASCII data. xon/xoff flow control uses the transmission of special characters to control the flow of data and works only for ASCII data (not for binary data).

framer-crc-errors Displays the number of cyclic redundancy check (CRC) errors. These occur when the CRC of a frame calculated by the receiver does not match the CRC calculated by the transmitter (meaning that a frame has been corrupted).

framing Displays the framing format for the T1/E1 line. The framing format determines how data is organized to accomplish multiplexing, signaling and testing.

framing-errors Displays the number of framing errors that occurred on the serial link.


WESTELL.COM

1-800-377-8766

Page 3-51


inactivity-timeout Displays the time frequency (in minutes) that polling will occur on a link to determine if it is still active. This prevents disconnection of a link if it is still being used but is temporarily inactive.

index Displays a reference number for RFC 1406 current table statistics.

init-string Displays the connection initialization string for the controller. Depending on the connection settings, this string may or may not get sent to the UART.

lcp-requests Displays the status of Remote RMX-3200’s ability to initiate or terminate a PPP link based on the presence of LCP echo requests.

line-coding-violations Displays the number of line coding violations (LCVs) that have occurred on a controller. LCVs can be either bipolar violations (BPVs) or pulse density violations. BPVs occur when the receiver receives a pulse that has the opposite polarity of what it expects. Pulse density violations occur when the receiver does not receive enough pulses in a specific amount of time.

line-errored-seconds A Line Errored Second, according to T1M1.3, is a second in which one or more Line Code Violation error events were detected. While many implementations are currently unable to detect the zero strings, it is expected that interface manufacturers will add this capability in deference to ANSI; therefore, it will become available in time. In the T1M1.3 specification, near end Line Code Violations and far end Line Errored Seconds are counted. For consistency, we count Line Errored Seconds at both ends.

linecode Displays the bit-level electrical encoding method for the T1 line on Remote RMX-3200. The two line coding options are B8ZS and AMI.


WESTELL.COM

Page 3-52

1-800-377-8766


linemode Displays the linemode for the controller. The linemode sets the electrical encoding for data and the definition for control leads on a serial link.


local-identity Displays the local identity, which is similar to a user name, for CHAP and PAP authentication on a serial WAN controller. The local identity is supplied by the local site and sent to a remote device.

local-loop Displays the loopback setting for the Remote RMX-3200 port. The following values may appear: line specifies line loopback mode on the

controller. When this value is displayed, the controller returns the received signal to the sender without modification. A sender testing the line receives a bit-for-bit reproduction of the signal, including any intentionally inserted framing errors.

norm specifies normal loopback operation. payload specifies payload loopback

mode on the controller. When this value is displayed, the controller returns the received signal to the sender after regenerating the framing information. A sender testing the line receives a signal free of framing errors even if the sender intentionally inserted framing errors into the signal.

local-method Displays the method Remote RMX-3200 uses to authenticate a peer device on a serial WAN controller PPP link. The two available methods are challenge handshake authentication protocol (CHAP) and password authentication protocol (PAP).

loop-detect Displays the status of loopback detection on the WAN serial controller.


WESTELL.COM

1-800-377-8766

Page 3-53


mru Displays the maximum number of data bytes that can be received in a single PPP frame on a serial port.

mtu Displays the maximum number of data bytes that can be transmitted in a single PPP frame on a WAN port.

number Displays the interval number associated with the RFC 1406 interval table entry.

parity Displays the parity setting for the controller. Parity is a process for detecting whether or not bits of data have been altered during data transmission.

parity-errors Displays the number of bit parity errors on the controller.Parity errors will be displayed only if a mediation connection is configured and a link is established.

path-coding-violations Displays the number of path coding violation error events, which are frame synchronization bit errors in the D4 and E1-noCRC formats, or CRC errors in the ESF and E1-CRC formats.

remote-identity Displays the remote identity, which is similar to a user name, for CHAP and PAP authentication on a serial WAN controller. The remote identity is supplied by the peer device and sent to Remote RMX-3200.

prl-version Displays the Preferred Roaming List (PRL) version number for the modem.


WESTELL.COM

Page 3-54

1-800-377-8766


remote-loop Displays the loopback setting for the device port at the far end of the link. The following values may appear: line specifies line loopback mode on the

controller. When this value is displayed, the controller returns the received signal to the sender without modification. A sender testing the line receives a bit-for-bit reproduction of the signal, including any intentionally inserted framing errors.

norm specifies normal loopback operation. payload specifies payload loopback

mode on the controller. When this value is displayed, the controller returns the received signal to the sender after regenerating the framing information. A sender testing the line receives a signal free of framing errors even if the sender intentionally inserted framing errors into the signal.

remote-method Displays the method used by a peer device to authenticate Remote RMX-3200 for a controller PPP link. The two available methods are challenge handshake authentication protocol (CHAP) and password authentication protocol (PAP).

resource-state Displays if the serial controller is assigned to be tracked as a resource or not.

rts-connect-mode Displays the state of an RTS output signal when a controller is connected. This signal is activated by a terminal device that needs to send data. RTS signals are used mostly for hardware flow control on asynchronous ports.

rts-disconnect-mode Displays the state of an RTS output signal when a controller disconnects. This signal is activated by a terminal device that needs to send data. RTS signals are used mostly for hardware flow control on asynchronous ports.


WESTELL.COM

1-800-377-8766

Page 3-55


rx-link-state Displays the receive link state, which summarizes the state of the WAN receiver. The following values may appear: up specifies that framing is OK. LOF specifies a loss of framing (red alarm). RAI specifies that a remote alarm

indication (yellow alarm) is being received from the far end.

AIS specifies that an alarm indication signal (blue alarm) is being received from the far end.

test specifies that the link is in a testing state.

severely-errored-framing-events

Displays if a severe framing error event has been detected since the last time the controller's counters were cleared.

severely-errored-framing-seconds

Displays the number of severely errored framing seconds, which are seconds with one or more out of frame defects OR a detected AIS defect.

severely-errored-seconds Displays the number of severely errored seconds, which have the following characteristics: For ESF signals, they are seconds with

320 or more path code violation error events or one or more out of frame defects or a detected AIS defect.

For E1-CRC signals, they are seconds with 832 or more path code violation error events or one or more out of frame defects.

For E1-noCRC signals, they are seconds with 2048 LCVs or more.

For D4 signals, they are a count of one-second intervals with framing error events, an OOF defect, or 1544 LCVs or more.

severely-errored-seconds-ratio

Displays the ratio of Severely Errored Seconds (SESs) on a link as defined in ITU-T G.826.


WESTELL.COM

Page 3-56

1-800-377-8766


speed Displays the speed (in kbps) for each DS0 channel within a channel group. Available speeds are 56 and 64.

signal-strength Displays the signal strength (in dBm) for the EVDO modem along with an associated rating of very poor (less than -90 dBm), poor (-90 to -86 dBm), fair (-85 to -81 dBm), good (-80 to -76 dBm), or excellent (greater than -76 dBm).


stopbits Displays the number of stop bits per byte transmitted and received by the controller. A stop bit is a bit added to the end of a byte that helps to synchronize the transmitter and receiver on an asynchronous link.

system-name Displays the controller’s system name (for example, br_bg2, hdlc0, or eth0_1).

timeslot Displays the DS0 channels that are included in the channel group.

total-background-block-errors

Displays the total number of background block errors on a link as defined in ITU-T G.826.

total-errored-seconds Displays the total number of errored seconds on a link as defined in ITU-T G.826.

total-seconds Displays the total seconds on a link as defined in ITU-T G.826.

total-severely-errored-seconds

Displays the total number of severely errored seconds on a link as defined in ITU-T G.826.


WESTELL.COM

1-800-377-8766

Page 3-57





show controllers

tx-link-state Displays the transmit link state, which summarizes the state of the WAN transmitter. The following values may appear: up specifies that framing is OK. LOF specifies a loss of framing (red alarm). RAI specifies that a remote alarm

indication (yellow alarm) is being sent to the far end.

AIS specifies an alarm indication signal (blue alarm) is being sent to the far end.

test specifies that the link is in a testing state.

unavailable-seconds Displays the unavailable seconds on a link as defined in ITU-T G.826.

valid-data Displays if controller data is valid or not.


WESTELL.COM

Page 3-58

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show correlations

show correlations

DescriptionThis command displays the configured event correlations, including the current expressions and associated values.

Formatsshow correlations [ name | name_filter ]

Parameters


ExamplesThis example displays summarized information for all event correlations.

name Specifies one event correlation for which detailed information will be displayed.

name_filter Filters groups of event correlations. An asterisk (*) can be used to match multiple correlation names.

Tip: To display summarized information for all event correlations with names beginning with a specific character or characters, enter a partial event correlation name followed by *. For example, to display all event correlations that begin with Input, enter show correlations Input*.

(Dub)>show correlationsName Value Expression Description-----------------------------------------------------------------------------BothClosed false input 0/1 close and input 0/2 Correlation for two discrete inputsDoorAlarms false input 0/1 open and input 0/2 Correlation for open door alarms(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-59

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show correlations

This example displays detailed information for correlation event BothClosed.

See Alsoconfig event


config correlation

(Dub)>show correlation BothClosedName: BothClosedExpression: input 0/1 close and input 0/2 closeTrue Duration: 900False Duration: 0Evaluation: true and true = trueValue: trueDescription: Correlation for two discrete inputs(Dub)>


Description Displays the configured description for the event correlation.

Expression Displays the configured expression for the event correlation.

Evaluation Displays the results of the expression evaluation.

False Duration

Displays the number of seconds the expression must remain false.

True Duration Displays the number of seconds the expression must remain true.

Value Displays the correlated value (response) that is reported to the alarm table.

WESTELL.COM

Page 3-60

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show debugging

show debugging

DescriptionThese commands display the status of event debugging on Remote RMX-3200.

Formatsshow debugging

dhcp-clientethernetlevelmediationopenvpnpppserialsnmp

Parameters


dhcp-client

Displays the status of event debugging for DHCP client.

ethernet Displays the status of event debugging for Ethernet controllers and interfaces.

level Displays the level of debug messages that is currently being displayed on the CLI.

mediation Displays the status of each of the mediation debugging functions

openvpn Displays the status of event debugging for OpenVPN controllers and interfaces.

ppp Displays the status of event debugging for controllers configured with PPP encapsulation.

serial Displays the status of event debugging for serial controllers and interfaces.

snmp Displays the status of event debugging for SNMP events.

WESTELL.COM

1-800-377-8766

Page 3-61

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show debugging

ExamplesThis example displays the status of debug information logging for Ethernet controllers and interfaces.

See Alsodebug ethernet

debug level

debug mediation

debug openvpn

debug ppp

debug serial

debug snmp

(Dub)>show(Dub)show>debugging(Dub)show debugging>ethernetDebug controller: enabledDebug interface: disabled(Dub)show debugging>

WESTELL.COM

Page 3-62

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show dhcp-relay

show dhcp-relay

DescriptionThis command displays BOOTP/DHCP relay configuration information for Remote RMX-3200.

Formatsshow dhcp-relay


ExamplesThis example displays BOOTP/DHCP relay configuration information for Remote RMX-3200.

See Alsoconfig dhcp-relay

(Dub)>show(Dub)show>dhcp-relaybootp/DHCP relay is enabledbootp/DHCP relay servers:10.40.57.5010.40.2.210.40.57.60(Dub)show>


bootp/DHCP relay is Displays one of the following: enabled if BOOTP/DHCP relay is enabled on

Remote RMX-3200 disabled if BOOTP/DHCP relay is disabled on

Remote RMX-3200

bootp/DHCP relay servers

Displays the IP address of each BOOTP/DHCP server.

WESTELL.COM

1-800-377-8766

Page 3-63

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show dhcp-server

show dhcp-server

DescriptionThis command displays DHCP server configuration information for Remote RMX-3200.

Formatsshow dhcp-server


ExamplesThis example displays DHCP server configuration information for Remote RMX-3200.

(Dub)>show(Dub)show>dhcp-serverAdmin State: enabledBroadcast: enabledAuthority: enabledConfig file: Note: User specified configuration files will overide configured settings.Interfaces: bridge switch

Subnets: 192.168.10.0/24 range=192.168.10.2/192.168.10.50 router=192.168.10.1 default-lease=3600 max-lease=28800 DNS:

Hosts: priv-lan MAC=00:40:72:00:99:2A IP=0.0.0.0 tech-laptop1 MAC=00:60:08:AD:86:FF IP=198.168.10.51(Dub)show>


Admin State

Displays the status of the DHCP server on Remote RMX-3200.

Authority One of the following appears: enabled—The DHCP server will respond to misconfigured

DHCP clients with DHCPNAK messages. disabled—The DHCP server will not respond to misconfigured

DHCP clients with DHCPNAK messages.

WESTELL.COM

Page 3-64

1-800-377-8766


Broadcast One of the following appears: enabled—The DHCP server will send DHCP request

responses as broadcast packets. disabled—The DHCP server will send DHCP request

responses as unicast packets.

Config file

Displays the name of the file that contains the DHCP server configuration for Remote RMX-3200 (if a file name has been configured on Remote RMX-3200).

Hosts Displays the following for each host being served by the DHCP server: Hostname Hardware address (MAC) IP address (IP)

Notes: 0.0.0.0 for MAC specifies that a hardware address has not

been configured.

0.0.0.0 for IP specifies that an IP address has not been configured.

Interfaces Displays the name of each Remote RMX-3200 interface on which the DHCP server is operating.

Subnets Displays the following for each subnetwork being served by the DHCP server: IP address Subnet mask length Range of IP addresses the DHCP server can assign to a device

(range) Router IP address (router) Default lease time (default-lease) Maximum lease time (max-lease) IP addresses of all DNS servers (DNS)

Notes: 0.0.0.0 for range specifies that an IP address range has

not been configured.

0.0.0.0 for router specifies that a router IP address has not been configured.


WESTELL.COM

1-800-377-8766

Page 3-65


See Alsoconfig dhcp-server


config dhcp-server subnet

WESTELL.COM

Page 3-66

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show discrete

show discrete

DescriptionThese commands display information for all discrete points or for a specified discrete point.

Formatsshow discrete

analogs [ unit/analog_point | unit/power | unit/powerB | unit/temperature | unit/humidity | unit/* | * ]

inputs [ unit/input_point | unit/* | * ]outputs [ unit/output_point | unit/* | * ]

Parameters

analogs Displays information for all analog inputs or for a specified analog input. The following parameters are accepted: *—Displays information for all analog inputs for a specified

peripheral unit or all analog inputs. analog_point—Defines the point number for the analog input

being displayed. Valid values for on-board analog inputs are 1 to 12. Other values may be available for expansion peripheral units.

power—Displays information for the power monitor, which is an analog input that is dedicated to monitoring the unit’s incoming power supply voltage.

powerB—Displays information for the secondary power monitor, which is an analog input that is dedicated to monitoring the unit's secondary incoming power supply voltage.

temperature—Displays information for the temperature sensor, which is an analog input that is dedicated to monitoring internal chassis temperature. Can also display information for the temperature sensor on an RMB peripheral unit, which is an analog input that is dedicated to monitoring the ambient temperature.

humidity—Displays information for the humidity sensor on an RMB peripheral unit, which is an analog input that is dedicated to monitoring the ambient humidity.

unit—Defines the peripheral unit number. Valid values are 0 to 12.


WESTELL.COM

1-800-377-8766

Page 3-67



ExamplesThis example displays information for all available digital analog inputs.

inputs Displays information for all configured digital inputs or for a specified digital input. *—Displays information for all digital inputs for a specified peripheral

unit or all digital inputs. input_point—Defines the digital input number within the unit. Valid

values for on-board digital inputs are 1 to 64. Other values may be available for expansion peripheral units.



outputs Displays information for all configured digital outputs or for a specified digital output. *—Displays information for all digital outputs for a specified

peripheral unit or all digital outputs. output_point—Defines the digital output number within the unit.

Valid values for on-board digital outputs are 1 to 4. Other values may be available for expansion peripheral units.



(Dub)>show(Dub)show>discrete(Dub)show discrete>analogsID State Resource State Value Mode Interval Description 0/1 enable assigned 0.2 V voltage 1 Battery A 0/2 enable assigned 0.2 V voltage 0 Battery B 0/3 enable assigned -20 Gallon current 0 Fuel Level 0/4 enable assigned 0.1 V voltage 0 Battery 0/5 enable assigned 0.2 RelHum voltage 0 Humidity 0/6 enable assigned -20 degC current 0 Temperature 0/7 enable assigned 0.1 V voltage 0 Battery 0/8 enable assigned 0.2 RelHum voltage 0 Humidity 0/9 enable assigned -20 degC current 0 Temperature 0/10 enable assigned 0.1 V voltage 0 analog810 0/11 disable unassigned -20 mA current 0 0/12 disable unassigned -20 mA current 0 0/power disable unassigned 28.0 V voltage 0 0/powerB disable unassigned 9.7 V voltage 0 0/temperature disable unassigned 42 C celsius 0(Dub)show discrete>

WESTELL.COM

Page 3-68

1-800-377-8766


This example displays information for input analog 0/3.

Column Description

Description Displays the configured descriptions for associated analog inputs.

ID Displays the unit numbers and point numbers for all analog inputs.

Interval Displays the configured analog input intervals. These values represent the rate at which interval events are generated.

Mode Displays the input analog mode as current or voltage input.

Resource State

Displays whether an analog input has been assigned for resource tracking (assigned or unassigned).

State Displays the status of all analog inputs as enable or disable.

Value Displays the values and units of measurement for all analog inputs. offline specifies that an analog input is associated with an offline peripheral.

(Dub)>show(Dub)show>discrete(Dub) show discrete>analogs 0/3ID - 0/3Description - Gas SensorState - enableResource State - unassignedLow Band - 8High Band - 14Hysteresis - 2Interval - 17Max Loop Value - 13Min Loop Value - 5Max Sensor Reading - 15Min Sensor Reading - 7

Units - mAMode - currentValue - 2.00 mA(Dub)show discrete>


Description Displays the description for the analog input.

High Band Displays the high band level in sensor units for an analog input.

Hysteresis Displays the hysteresis for an analog input. Hysteresis works as a guard between the high and low band thresholds.

WESTELL.COM

1-800-377-8766

Page 3-69


This example displays information for all digital outputs.

ID Displays the unit number and point number for the analog input.

Interval Displays the configured analog input interval. This value represents the rate at which interval events are generated.

Low Band Displays the low band level in sensor units for an analog input.

Max Loop Value Displays the maximum voltage allowed (in milliamps) on the specified analog input if the mode is set to voltage.

Max Sensor Reading

Displays the sensor value associated with the maximum current allowed on the analog input.

Min Loop Value Displays the minimum voltage allowed (in milliamps) on the specified analog input if the mode is set to voltage.

Min Sensor Reading

Displays the sensor value associated with the minimum current allowed on the analog input.

Mode Displays the input analog mode as current or voltage input.

Resource State Displays whether this input has been assigned for resource tracking.

State Displays the status of the analog input as enable or disable.

Units Displays the configured unit of measurement.

Value Displays the value and unit of measurement for the analog input. offline specifies that the analog input is associated with an offline peripheral.

(Dub)>show(Dub)show>discrete(Dub)show discrete>outputsID Resource State Value Description 0/1 unassigned open Connection up 0/2 unassigned closed 0/3 unassigned closed 0/4 unassigned open(Dub)show discrete>


WESTELL.COM

Page 3-70

1-800-377-8766


This example displays information for discrete output 0/4.




(Dub)>show(Dub)show>discrete(Dub) show discrete>outputs 0/4ID - 0/4Description - This is the output point for a pressure gaugeValue - open(Dub)show discrete>

Column Description

Description Displays configured descriptions for all digital outputs or a specific digital output.

ID Displays the unit numbers and digital output numbers for all digital outputs or for a specific digital output.

Resource State

Displays whether this input has been assigned for resource tracking.

Value Displays values for all digital outputs or a specific digital output as open, which indicates that an output has a current flow, closed, which indicates that an output has no current flow, or offline, which indicates that a digital output is associated with an offline peripheral.

WESTELL.COM

1-800-377-8766

Page 3-71

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show events

show events

DescriptionThis command displays summarized information for all events or detailed information for a specific event.

Formatsshow events [ event_name ]

Parameters


ExamplesThis example displays summarized information for all events.

This example displays detailed information for event doorOpen.

event_name Specifies the event for which detailed information will be displayed.

Tip: To display summarized information for all events with names beginning with a specific character or characters, enter a partial event name followed by *. For example, to display all Telnet connection events, enter show events Telnet*.

(Dub)>show(Dub)show>events Name Originator Type Description------------------------------------------------------------------------------ doorOpen input 0/3 open This event signal... e1 tcp 40001 incoming-connectio This event accept... psi analog 0/power high This event signal... waterLvl input 0/4 close This event signal...(Dub)show>

(Dub)>show(Dub)show>events doorOpenEvent Name : doorOpenEvent Description : This event signals when a door is opened.Event Originator : input 0/3Event Type : open(Dub)show>

WESTELL.COM

Page 3-72

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show events

See Alsoconfig event



Description Displays all configured event descriptions.

Event Description

Displays a description for a configured event.

Event Name Displays the name of a configured event.

Event Originator

Displays the originator for a configured event, which is a system component that generates an event. For more information about event originators, refer to the event configuration commands.

Event Type Displays a configured event type. For more information about available event types, refer to the event configuration commands.

Name Displays the names of all configured events or a specific event.

Originator Displays the configured event originators, which are system components that generate events. For more information about event originators, refer to the event configuration commands.

Type Displays the configured event type. For more information about available event types, refer to the event configuration commands.

WESTELL.COM

1-800-377-8766

Page 3-73

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show expansion-images

show expansion-images

DescriptionThis command displays the expansion peripheral executable images and expansion peripheral stage 2 bootloader images that are installed on Remote RMX-3200.

Note: For information about installing discrete expansion peripheral executable and

stage 2 bootloader images, refer to the Remote Release Notes, version 3.30.

Formatsshow expansion-images


ExamplesThis example displays the installed discrete expansion peripheral executable image, serial expansion peripheral executable image, bistate expansion peripheral executable image and their associate stage 2 bootloader images.

WESTELL.COM

Page 3-74

1-800-377-8766


(Dub)>show(Dub)show>expansion-images

discrete-expansion/boot.img--------------------------------------------------Product: AIExpansion-ShelfVersion: 1.60Build date: 2010-07-29,16:46:54.0,-04:00Build ID: 006Image type: AIModExpan-ProductionProduction release.

discrete-expansion/stage2boot.img--------------------------------------------------Version: 3.10Build date: Thu Jul 6 13:52:11 EDT 2006Image type: AI160-Stage2Boot

serial8-expansion/boot.img--------------------------------------------------Product: AIExpansion-ShelfVersion: 1.60Build date: 2010-07-29,16:46:54.0,-04:00Build ID: 006Image type: AIModExpan-ProductionProduction release.

serial8-expansion/stage2boot.img--------------------------------------------------Version: 3.11Build date: Thu Jul 27 11:38:32 EDT 2006Image type: AI670-Stage2Boot

bistate48-expansion/boot.img--------------------------------------------------Product: AIExpansion-ShelfVersion: 1.60Build date: 2010-07-29,16:46:54.0,-04:00Build ID: 006Image type: AIModExpan-ProductionProduction release.

bistate48-expansion/stage2boot.img--------------------------------------------------Version: 3.11Build date: Thu Jul 27 11:38:38 EDT 2006Image type: AI680-Stage2Boot

fb64-expansion/boot.img----------------------------------------------------More--

WESTELL.COM

1-800-377-8766

Page 3-75


See Alsoconfig peripheral

Display Items Description

Build date Displays the build date.

Build ID Displays the build ID number.

Image type Displays the image type.

Product Displays the product associated with the software image.

Version Displays the software image version number.

WESTELL.COM

Page 3-76

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show fan

show fan

DescriptionThis command displays information about the built-in cooling fan on Remote RMX-3200.

Formatsshow fan


ExamplesThis example displays the current status of the Remote RMX-3200 cooling fan.

See Alsodiag fan

(Dub)>show(Dub)show>fanFan 1: RUNNING_OK

(Dub)show>

Status Description

RUNNING_OK Remote RMX-3200 is attempting to test the fane and the test is successful.

RUNNING_FAILED Remote RMX-3200 is attempting to test the fane and the test has failed.

STOPPED_OK The fan is currently stopped and the last test of the fan was successful.

STOPPED_FAILED The fan is currently stopped and the last test of the fan failed.

WESTELL.COM

1-800-377-8766

Page 3-77

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show interfaces

show interfaces

DescriptionThis command displays information and statistics for Remote RMX-3200 interfaces.

Note: The output of the show interface command will change based on the

available IPv6 configuration.

Formatsshow interfaces [ * ]

Parameters


ExamplesThis example displays the first screen of detailed information for all configured Remote RMX-3200 interfaces.

* Displays information and statistics for all Remote RMX-3200 interfaces.

WESTELL.COM

Page 3-78

1-800-377-8766


Note: Statistics not collected by Remote RMX-3200 will display as zeroes.



config interface openvpn


show interfaces bridge


(Kentrox) show>interface *bridge switch system-name=br_switch status=enabled link-state=up nat64=enabled address=10.39.50.10/16 link-local-address=169.254.21.27/16 ipv6 admin-state=enabled oper-state=enabled mode=host address=fc10::39:0:0:a27:320a/64 valid=forever preferred=forever address=fc10::39:240:72ff:fe0e:678d/64 valid=2591720sec preferred=604520sec dynamic address=fd20:39:abfe:0:240:72ff:fe0e:678d/64 valid=955sec preferred=955sec dynamic address=fde7:716:6ffe:0:240:72ff:fe0e:678d/64 valid=45sec preferred=15sec dynamic address=fe80::240:72ff:fe0e:678d/64 valid=forever preferred=forever Stats: Bytes Packets Errors Dropped Overrun Framing Rx 692337196 6150603 0 0 0 0 Tx 234223653 1186132 0 0 0 0

ethernet 0 Stats: Bytes Packets Errors Dropped Overrun Framing Rx 52020579 491826 0 0 0 0 Tx 768909076 6137389 0 0 0 0



ethernet 3 Stats: Bytes Packets Errors Dropped Overrun Framing Rx 782843728 6153704 4 0 0 4 Tx 205037023 715606 0 0 0 0--More--

WESTELL.COM

1-800-377-8766

Page 3-79



show interfaces serial

WESTELL.COM

Page 3-80

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show interfaces bridge

show interfaces bridge

DescriptionThis command displays information and/or statistics for the bridge interface on Remote RMX-3200.

Formatsshow interfaces bridge [ switch | * ]

Parameters


* Displays configuration information and statistics for the bridge interface.

switch Displays configuration information and statistics for the bridge switch interface.

WESTELL.COM

1-800-377-8766

Page 3-81


ExamplesThis example displays information and statistics for interface bridge switch and statistics for all the ports included in bridge switch.

(Kentrox) show>interfaces bridge switchbridge switch system-name=br_switch status=enabled link-state=up address=10.39.50.10/16 link-local-address=169.254.247.26/16 Stats: Bytes Packets Errors Dropped Overrun Framing Rx 445263771 5311799 0 0 0 0 Tx 249372992 1170575 0 0 0 0









ethernet 8 Stats: Bytes Packets Errors Dropped Overrun Framing Rx 222917410 607149 0 0 0 0 Tx 450999963 4995708 0 0 0 0(Kentrox) show>

WESTELL.COM

Page 3-82

1-800-377-8766




address Displays the IP address for the bridge interface.

link-state Displays the state of the link (up or down) that connects the interface to another device.

status Displays the status of the interface (enabled or disabled).

system-name

Displays the system name for the interface (for example, br_switch for interface bridge switch).

desc Displays a description for the interface.

Rx Bytes Displays the number of bytes received in error-free packets by the interface.

RX Dropped Displays the number of packets received by the interface that were dropped.

Rx Errors Displays the number of errors that have occurred while receiving data on the interface.

Rx Framing Displays the number of framing errors that have occurred while receiving data on the interface.

Rx Overrun Displays the number of packets not received by the interface because of a receiver overrun.

Rx Packets Displays the number of error-free packets received by the interface.

Tx Bytes Displays the number of bytes transmitted in error-free packets from the interface.

Tx Dropped Displays the number of packets that were dropped before they could be transmitted by the interface.

Tx Errors Displays the number of errors that have occurred while transmitting data from the interface.

Tx Framing Displays the number of framing errors that have occurred while transmitting data from the interface.

Tx Overrun Displays the number of packets not transmitted from the interface because of a transmitter overrun.

WESTELL.COM

1-800-377-8766

Page 3-83



show interfaces

Tx Packets Displays the number of error-free packets transmitted from the interface.


WESTELL.COM

Page 3-84

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show interfaces ethernet


DescriptionThis command displays information and/or statistics for Ethernet interfaces on Remote RMX-3200.

Formatsshow interfaces ethernet [ * | port | wan/port ]

Parameters


ExamplesThis example displays information for all configured Ethernet interfaces.


* Displays information and statistics for all Ethernet interfaces.

port Selects an Ethernet port number for display. If the WGBE card is installed in the expansion slot, ports wan/1 and wan/2 represent WGBE’s 1000baseT ports, while wan/3 and wan/4 represent WGBE’s fiber SFP ports.

(Dub)>show(Dub)show>interfaces ethernet *ethernet 2 system-name=mii1 status=enabled link-state=down desc=Ethernet interface 2 address=23.67.0.4/16 Stats: Bytes Packets Errors Dropped Overrun Framing

Rx 0 0 0 0 0 0 Tx 0 0 0 0 0 0

ethernet 3 system-name=mii2 status=enabled link-state=down address=23.68.0.3/16 secondary-address=23.69.0.3/16 Stats: Bytes Packets Errors Dropped Overrun Framing Rx 0 0 0 0 0 0 Tx 0 0 0 0 0 0(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-85



address Displays the IP address for the interface.









secondary-address

Displays each secondary IP address for the interface.


system-name Displays the system name for the interface (for example, br_switch for interface bridge switch).






WESTELL.COM

Page 3-86

1-800-377-8766


See Alsoconfig interface ethernet

show interfaces



WESTELL.COM

1-800-377-8766

Page 3-87

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show interfaces openvpn


DescriptionThis command displays information and/or statistics for OpenVPN interfaces on Remote RMX-3200.

Formatsshow interfaces openvpn [ name | * ]

Parameters


ExamplesThis example displays information and statistics for all configured openvpn interfaces.


name Specifies the name of an OpenVPN interface.

* Displays information and statistics for all OpenVPN interfaces.

(Dub)>show(Dub)show>interfaces openvpn *openvpn client system-name=ovpn_client status=enabled link-state=down desc=VPN client interface CMH1 address=12.35.64.34/16 Stats: Bytes Packets Errors Dropped Overrun Framing Rx 0 0 0 0 0 0 Tx 0 0 0 0 0 0(Dub)show>





WESTELL.COM

Page 3-88

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show interfaces openvpn

See Alsoconfig interface openvpn

show interfaces







secondary-address

Displays the secondary IP address for the interface.


system-name Displays the system name for the interface (for example, opvn_client for interface opvn client).








WESTELL.COM

1-800-377-8766

Page 3-89

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show interfaces serial

show interfaces serial

DescriptionThis command displays information and/or statistics for serial interfaces on Remote RMX-3200.

Formatsshow interfaces serial [ port | wan/1 | wan/2 | * ]

Parameters


ExamplesThis example displays information and statistics for interface serial 2.


* Displays information and statistics for all interfaces or for all interfaces of a specified type.

port Selects an Ethernet or serial port number.

(Dub)>show(Dub)show>interface serial 2serial 2 name=serial 2 system-name= status=enabled link-state=down desc=Serial interface 2 address=12.41.82.4 pointopoint=12.41.82.5 Stats: Bytes Packets Errors Dropped Overrun Framing Rx 0 0 0 0 0 0 Tx 0 0 0 0 0 0(Dub)show>





WESTELL.COM

Page 3-90

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show interfaces serial

See Alsoconfig interface serial

pointopoint Displays the remote device IP address for the interface.








system-name Displays the system name for the interface (for example, br_switch for interface bridge switch).








WESTELL.COM

1-800-377-8766

Page 3-91

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show inventory

show inventory

DescriptionThis command displays information for each existing Remote RMX-3200 hardware component.

Formatsshow inventory


ExamplesThis example displays information for each existing Remote RMX-3200 hardware component.

(Dub)>show(Dub)show>inventoryName Slot Manufacturer Part no. Serial Manf. date VersionKTX535 Kentrox B535-02.B:0 29011762 03/13/09 4.06(Dub)show>

Column Description

Manf. Date Displays the date the hardware component was manufactured.

Manufacturer Displays the name of the manufacturer of the hardware component.

Name Displays hardware component KTX535, which is the Remote RMX-3200 motherboard.

Part no. Displays the part number for the hardware component.

Serial Displays the serial number for the hardware component.

Slot Displays the expansion slot where the hardware component is located. The expansion slot on Remote RMX-3200 is identified as ExpSl. This example shows no device in the slot.

Version Displays the version of the stage 1 bootloader.

WESTELL.COM

Page 3-92

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show ip

show ip

DescriptionThis command displays the configured IP settings for Remote RMX-3200.

Formatsshow ip

arp [ configured ]domain-nameforwardname-serverroute [ configured ]

Parameters

arp Displays the Remote RMX-3200 ARP cache. The ARP cache is a memory bank that associates IP addresses with their corresponding physical addresses. The following parameter is accepted:

configured—Displays ARP cache entries that were explicitly configured by the user.

domain-name

Displays the domain name, if one is configured. Domain names are used to represent IP addresses on a network and are formatted as a series of characters separated by periods (for example, www.domainname.com).

Note: Domain names can be comprised of alphanumeric

characters, periods and hyphens.

forward Displays the IP forwarding status for Remote RMX-3200. IP forwarding allows IP packets received on an interface to be forwarded to other interfaces.

name-server

Displays the available DNS servers. A DNS server translates alphanumeric addresses into corresponding IP addresses. A primary and secondary DNS server can be present.

route Displays the current contents of the Remote RMX-3200 routing table. A routing table is a database that keeps track of paths to particular network destinations. More specifically, it associates network addresses with gateway addresses.

configured—Displays static routes that were explicitly configured by the user.

WESTELL.COM

1-800-377-8766

Page 3-93



ExamplesThis example displays all ARP cache entries.

Note: Manually entered ARP cache entries (entries that were configured by a user)

appear only if the IP address for the entry is in the network configured for one of the Ethernet interfaces or a bridge interface on Remote RMX-3200.

This example displays the configured domain name as www.kentrox.com.

This example displays the IP forwarding status as disabled.

This example displays the configured primary and secondary DNS servers.

(Dub)>show(Dub)show>ip(Dub)show ip>arpIP Address MAC Address10.40.3.15 08:00:09:E8:03:0E10.40.0.1 00:E0:52:CC:0B:0010.40.5.31 00:0C:29:18:BD:2610.40.5.25 00:06:5B:60:9D:6310.40.3.91 00:0B:DB:69:90:6210.40.3.54 00:01:02:EE:EB:2610.40.5.20 00:01:02:EE:A8:30(Dub)show ip>

(Dub)>show(Dub)show>ip(Dub)show ip>domain-nameDomain Name: www.kentrox.com(Dub)show ip>

(Dub)>show(Dub)show>ip(Dub)show ip>forwardIP forwarding: disabled(Dub)show ip>

(Dub)>show(Dub)show>ip(Dub)show ip>name-serverPrimary DNS Server: 10.45.73.2Secondary DNS Server: 12.74.56.26(Dub)show ip>

WESTELL.COM

Page 3-94

1-800-377-8766


This example displays the contents of the IP routing table for Remote RMX-3200.

(Dub)>show(Dub)show>ip(Dub)show ip>routeDestination Gateway Interface Flags0.0.0.0/0 10.34.0.1 bridge switch Up10.34.0.0/16 0.0.0.0 bridge switch Up127.0.0.0/8 0.0.0.0 * Reject Up127.0.0.1/32 0.0.0.0 lo Host Up169.254.0.0/16 0.0.0.0 bridge switch Up(Dub)show ip>

Column Description

Destination Displays the destination network or destination host address. The default destination is 0.0.0.0 (or default).

Flags Displays flags that specify the status of routes. The following list displays all possible flags: Dynamic specifies that the route has been dynamically

installed by a daemon or a redirect. Host specifies that the route’s target is a host. Modified specifies that a route has been modified by the

routing daemon or a redirect. Reinstate specifies a reinstate route for dynamic routing. Reject specifies a blocking route. This forces a route lookup

to fail. Static specifies a static route. Up specifies that the interface through which the route will send

packets is up.

Gateway Displays the next-hop gateway address.

Note: In this sense, “gateway” is synonymous with “router.”

Interface Displays the interface to which packets to this destination are sent.

WESTELL.COM

1-800-377-8766

Page 3-95


This example displays routes that have been manually configured by users for Remote RMX-3200.

See Alsoconfig ip

(Dub)>show(Dub)show>ip(Dub) show ip>route configuredDestination Gateway/Interface Preferencedefault openvpn client10.40.65.76/32 ethernet 1 60 192.168.100.0/25 192.168.100.1 100192.168.100.128/25 192.168.100.1 90192.167.20.0/24 10.45.0.2 50192.167.20.0/24 serial 7 70(Dub)show ip>

WESTELL.COM

Page 3-96

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show iptables

show iptables

DescriptionThis command displays either the current iptables configuration or detailed information for each iptables rule.

Formatshow iptables [ configuration | details ]

Parameters

configuration Displays the current iptables configuration.

details Displays detailed information for each IP table rule.

WESTELL.COM

1-800-377-8766

Page 3-97


ExamplesThis example displays the current iptables configuration. All existing chains and rules are listed for the filter, mangle and nat iptables.

(Dub)>show(Dub)show>iptables(Dub)show iptables>configurationTable nat-------------------------------------------------------Chain PREROUTING (policy ACCEPT)

Chain POSTROUTING (policy ACCEPT)

Chain OUTPUT (policy ACCEPT)

Table filter-------------------------------------------------------Chain INPUT (policy ACCEPT) -i lo -j ACCEPT

Chain FORWARD (policy ACCEPT)

Chain OUTPUT (policy ACCEPT) -d 127.0.0.0/8 -j ACCEPT

Table mangle-------------------------------------------------------Chain PREROUTING (policy ACCEPT) -i lo -j ACCEPT

Chain INPUT (policy ACCEPT) -i lo -j ACCEPT

Chain FORWARD (policy ACCEPT)

Chain OUTPUT (policy ACCEPT) -d 127.0.0.0/8 -j ACCEPT

Chain POSTROUTING (policy ACCEPT) -d 127.0.0.0/8 -j ACCEPT

(Dub)show iptables>

WESTELL.COM

Page 3-98

1-800-377-8766


This example displays detailed information for all existing rules in the filter, mangle and nat iptables.

Note: This screen shot displays the first portion of the CLI output for this command.

Note: For more information on iptables and how to read IP table rules, refer to

http://ipset.netfilter.org/iptables.man.html.

See Alsoconfig iptables

(Dub)>show(Dub)show>iptables(Dub)show iptables>detailsTable nat-------------------------------------------------------Chain PREROUTING (policy ACCEPT 58101 packets, 5095K bytes) pkts bytes target prot opt in out source destination

Chain POSTROUTING (policy ACCEPT 3420 packets, 205K bytes) pkts bytes target prot opt in out source destination

Chain OUTPUT (policy ACCEPT 3420 packets, 205K bytes) pkts bytes target prot opt in out source destination

Table filter-------------------------------------------------------Chain INPUT (policy ACCEPT 19407 packets, 2897K bytes) pkts bytes target prot opt in out source destination

475K 26M ACCEPT all -- lo * 0.0.0.0/0 0.0.0.0/0

Chain FORWARD (policy ACCEPT 0 packets, 0 bytes) pkts bytes target prot opt in out source destination

WESTELL.COM

1-800-377-8766

Page 3-99



Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show jobs

show jobs

DescriptionThis command displays information related to jobs and job runs.

Formatsshow jobs

historyhistory-runsstatisticssummary

Parameters


history Displays information about the most recent run of each configured Remote RMX-3200 job.

Note: History entries that exceed the maximum run count are

deleted every 15 minutes. If you execute this command within 15 minutes of the maximum run count being exceeded, you could see more job runs listed than the amount specified in the maximum run count.

history-runs

Displays the maximum job run history count for Remote RMX-3200. The job run history count defines the amount of job runs for which Remote RMX-3200 keeps records. Once the maximum count is exceeded, the oldest runs are deleted from history.

Note: History entries that exceed the maximum run count are

deleted every 15 minutes. If you execute this command within 15 minutes of the maximum run count being exceeded, you could see more job runs listed than the amount specified in the maximum run count.

statistics Displays the job statistics for Remote RMX-3200. These include the current number of configured, running and completed jobs along with their completion states.

summary Lists a summary of all Remote RMX-3200 jobs and their related attributes.

WESTELL.COM

Page 3-100

1-800-377-8766


ExamplesThis example displays information about the most recent execution of each configured Remote RMX-3200 job.

This example displays the current maximum run history count of 25.

(Dub)>show(Dub)show>jobs(Dub)show jobs>historyJob Run ID Start time End time Exit statejob1 1 2008/07/14 14:15:39 2008/07/14 14:17:21 killedjob2 2 2008/07/14 14:15:54 2008/07/14 14:16:05 abnormaljob3 1 2008/07/14 14:16:14 2008/07/14 14:16:09 abnormaljob4 1 2008/07/14 14:16:40 2008/07/14 14:16:55 abnormaljob5 1 2008/07/14 14:19:11 2008/07/14 14:19:22 normal(Dub)show jobs>

Column Description

End time Displays the date and time that the job ended.

Exit state

Displays the state of the job upon exit. The following states are possible: normal specifies that the job exited under normal conditions. abnormal specifies that the job ended under abnormal conditions,

such as a system error. killed specifies that the job exited due to a manual stop.

Job Displays the job names.

Run ID Displays the job run ID number.

Start time

Displays the date and time that the job started.

(Dub)>show(Dub)show>jobs(Dub)show jobs>history-runsMaximum history runs: 25(Dub)show jobs>

WESTELL.COM

1-800-377-8766

Page 3-101


This example displays Remote RMX-3200 job statistics. Display items Normal, Killed and Abnormal refer to possible job states upon completion.

Note: The completed counts are since the last time the stats were reset. They do not

correspond to the number of history entries.

This example displays three Remote RMX-3200 jobs along with their related characteristics.

See Alsoconfig iptables-v6

(Dub)>show(Dub)show>jobs(Dub)show jobs>statisticsJobs configured: 7Jobs running: 1Jobs completed: 14 Normal: 4 Killed: 5 Abnormal: 5(Dub)show jobs>

(Dub)>show(Dub)show>jobs(Dub)show jobs>summaryJob Title Script Stateauto_ping Automatically pings a location autoping idlebackup_file Backs up the configuration backup idlecall_test Call Test calltest idledata_throughput Data throughput datathroughput idle(Dub)show jobs>

Column Description

Job Displays the configured jobs for Remote RMX-3200.

Script Displays the scripts used by the job.

State Displays the states of jobs as either idle or running.

Title Displays a user-configured description of the job.

WESTELL.COM

Page 3-102

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show jobs name

show jobs name

DescriptionThese commands display information about a specified job.

Formatsshow jobs name job_name

data { cat | head | more | tail } filenamehistory [ run_id ]propertiesstarts { start_index | * }statustask { task | * }

Parameters

job_name Specifies the job for which information will be displayed.

data Displays the contents of log files and other files in the jobdata directory. The following parameters are accepted: cat—Displays the entire contents of the file. head—Displays the first ten lines of the file. more—Displays the entire contents of the file in a page-by-page

format. tail—Displays the last ten lines of the file. filename—Specifies the file whose contents will be displayed,

such as active.log or stderr.log.

history Displays the known history of a job for Remote RMX-3200. The following parameter is accepted:

run_id—Defines the ID of a job run for which history will be displayed.

properties Displays the names and values of configured Remote RMX-3200 job properties.

starts Displays a list of start times for a Remote RMX-3200 job. The following parameters are accepted: *—Specifies that all starts times will be displayed for a job. start_index—Defines the index number associated with the

start information to display for the defined job.

status Displays the status of a job, including all its configurable attributes. If the job is running, runtime information will also appear.

WESTELL.COM

1-800-377-8766

Page 3-103



ExamplesThis example displays the known history of job myjob.

This example displays the history for run ID 3 of job myjob.

task Displays a specified task or all tasks along with their respective types and values. The following parameters are accepted: *—Specifies that all tasks will be displayed for a job. task—Defines the task that will be displayed.

(Dub)>show(Dub)show>jobs(Dub)show jobs>name myjob(Dub)show jobs name myjob->historyRun ID Start time End time Exit state 1 2008/09/15 21:24:54 2008/09/15 21:25:12 killed 2 2008/09/15 21:25:25 2008/09/15 21:25:29 normal 3 2008/09/15 21:25:32 2008/09/15 21:26:09 killed 4 2008/09/15 21:26:19 2008/09/15 21:26:30 normal 5 2008/09/15 21:26:34 2008/09/15 21:26:39 abnormal(Dub)show jobs name myjob->

(Dub)>show(Dub)show>jobs(Dub)show jobs>name myjob(Dub)show jobs name myjob->history 3Run ID: 3Start: 2008/09/15 21:25:32End: 2008/09/15 21:26:09Exit state: killed(Dub) show jobs name myjob->

Column Description

End time Displays the date and time that the job ended.

WESTELL.COM

Page 3-104

1-800-377-8766


This example displays the property names and values for job anotherjob.

This example displays the start specifications for job AnotherJob.

Exit state

Displays the state of the job upon exit. The following states are possible: normal specifies that the job exited under normal conditions. abnormal specifies that the job ended under abnormal conditions,

such as a system error. killed specifies that the job exited due to a manual stop.

Run ID Displays the job run ID number.

Start time

Displays the date and time that the job started.

(Dub)>show(Dub)show>jobs(Dub)show jobs>name anotherjob(Dub)show jobs name anotherjob->propertiesName Valueduration 1000exitcode 245stopdelay 10(Dub)show jobs name anotherjob->

Column Description

Name Displays the configurable job properties.

Note: Values displayed in this column depend on the script that the job

is executing.

Value Displays values for the corresponding job properties.


WESTELL.COM

1-800-377-8766

Page 3-105


This example displays the status of job samplejob.

(Dub)>show(Dub)show>jobs(Dub)show jobs>name anotherjob(Dub)show jobs name anotherjob->starts *Cron start: disabledStart at bootup: disabledStart-at index: 1 Month: 8 Day: 4 Hour: 12 Minute: 35 Weekday: 4No scheduled start time(Dub)show jobs name anotherjob->


Cron start Specifies that a job will start automatically after a specific event has occurred, such as arrival at a specified time/date. Possible values are Enabled and Disabled.

Day Displays the day that the job is configured to start.

Hour Displays the hour that the job is configured to start.

Minute Displays the minute that the job is configured to start.

Month Displays the month that the job is configured to start.

Start at bootup

Specifies that a job will start at Remote RMX-3200 bootup. Possible values are Enabled and Disabled.

Start-at index

Displays a value associated with a job start time. The start index represents each occurrence of a job start. Values increase by 1 each time a job starts.

Weekday Displays the day of the week that the job will start. Values can be 0, which represents Sunday, to 7, which represents the following Sunday.

WESTELL.COM

Page 3-106

1-800-377-8766


(Dub)>show(Dub)show>jobs(Dub)show jobs>name samplejob(Dub)show jobs name samplejob->statusJob: samplejobPackage: jobtestutilsMin version: anyScript: normalTitle: SampleJobCron start: disabledStart at boot: disabledMemory limit (Kb): 2560Stack size (Kb): 1024Output capture: disabledMax start attempts: 1Run state: running Run ID: 4 Start attempt: 1 Start time: 2008/09/08 18:41:29 Debugging: disabled Checking: disabled Memory usage (Kb): 2026(Dub)show jobs name samplejob->


Cron start Displays the cron start status.

Job Displays the job name.

Max start attempts

Displays the number of times that Remote RMX-3200 will attempt to start the job.

Memory limit Displays the amount of memory that can be used for the job.

Min version Displays the minimum acceptable version for the specified package.

Output capture Displays the status of the job capture option, which retrieves standard output (stdout) and standard error (stderr) information, then places that information into stdout.txt and stderr.txt files.

Package Displays the package containing the script code, manifest and optional supporting files required by the job.

Run state Displays the job run state as Running or Idle.

Script Displays the script to which the job will send runtime and parameter use instructions.

WESTELL.COM

1-800-377-8766

Page 3-107


Note: The following display items appear only if the status display is for a running

job.

This example displays the configured tasks and task properties configured for job AnotherJob.

Stack size Displays the maximum stack size for the job.

Start at boot Displays if the job will start when the system boots up.

Title Displays the title of the job, if a title has been configured.


Checking Displays the checking status as disabled or enabled.

Debugging Displays the debugging status as disabled or enabled.

Memory usage (Kb)

Displays the amount of memory being used by the job in kilobytes.

Run ID Displays the ID for job run.

Start attempt Displays the number of times that Remote RMX-3200 has attempted to start the job.

Start time Displays the date and time that the job started.

(Dub)>show(Dub)show>jobs(Dub)show jobs>name anotherjob(Dub)show jobs name anotherjob->task *Task: serverconfig Position: 1 Type: serversocket Properties: Name Value port 33Task: ipconfig Position: 2 Type: ifconfig Properties: Name Value address 132.45.6.78 controller eth0_1(Dub)show jobs name anotherjob->


WESTELL.COM

Page 3-108

1-800-377-8766


See Alsoconfig iptables-v6

config jobs name



Position Displays the task position.

Properties Displays the properties for the configured tasks. Each type of task has its own set of configurable properties.

Type Displays the task type. The type can be either ifconfig or serversocket.

WESTELL.COM

1-800-377-8766

Page 3-109

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show licenses

show licenses

DescriptionThis command displays entire license files and copyright statements for all open source code used in this product.

Formatsshow licenses

nopage

Parameters


ExamplesThis example displays the initial portion of a show licenses CLI display.

nopage Displays the entire list upon execution of command. The list displays one page at a time if nopage is not specified.

(rmc27) show>licensesPackage 'ACE':ace/Get_Opt.cpp ;/* * Copyright (c) 1987, 1993, 1994 * The Regents of the University of California. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the University of * California, Berkeley and its contributors. * 4. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

WESTELL.COM

Page 3-110

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show listeners

show listenersDescription

This command displays the destinations that are listening for mediation connections in the system. This serves as a diagnostic tool that allows the user to determine the destinations that are actively listening.

Formatsshow listeners


ExamplesThis example displays destinations that are listening for mediation connections in the system.

(Dub)>show(Dub)show>listenersListeners:serial 1serial 2serial 3serial 4serial 5serial 6serial 7serial 8tcp 0.0.0.0:40001telnettl1mux 1tl1ne 1(Dub)show>


serial 1 to serial 8

Displays the serial ports that are listening for mediation connections.

tcp 0.0.0.0:40001

Displays the TCP destinations that are listening for mediation connections.

telnet Indicates that the Telnet filter connection mid-point that is listening for mediation connections.

tl1mux 1 Displays the TL1 multiplexers that are listening for mediation connections.

WESTELL.COM

1-800-377-8766

Page 3-111

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show listeners

tl1ne 1 Displays the TL1 NEs that are listening for mediation connections.

Display Items Description (Continued)

WESTELL.COM

Page 3-112

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show log-file

show log-file

DescriptionThis command displays the Remote RMX-3200 log file. A log file is a record of system activity used for statistical purposes as well as backup and recovery. Log files are written by the operating system for purposes such as recording incoming dialogs and displaying error messages, status message and certain transaction details. In Remote RMX-3200, all activity listed in the log file is accompanied by a date and time.

Formatsshow log-file [ auth ] [ terse | verbose ] [ line_count ] [ search pattern ]

Parameters

auth Displays the contents of the authentication log file.

line_count Defines the number of lines (most recent) from the log file that Remote RMX-3200 will display. Valid values are 1 to 999,999,999.

Note: Because the terse version of the log file display is

limited to 32 kilobytes for Remote RMX-3200, a large line_count value can exceed the largest display allowed by card memory.

search pattern Displays the results of specific search criteria from a log file that matches a regular expression entered into the Remote RMX-3200. The pattern is case insensitive and any spaces must be enclosed by quotes.

Notes: Precede a special character (for example, a period)

with a backslash. The backslash instructs the regular expression compiler not to interpret it as a special character.

If the pattern is enclosed in quotes, the Remote's command line processor removes backslash characters. Two backslashes are required to precede a special character when the pattern is enclosed in quotes.

WESTELL.COM

1-800-377-8766

Page 3-113


Command DefaultsTerse

20 lines


ExamplesThis example displays the last (most recent) 10 lines of a less-detailed (terse) version of the Remote RMX-3200 log file.

terse Displays a less-detailed version of the Remote RMX-3200 log file.

Note: All terse information is cleared from the log file each

time Remote RMX-3200 is reset.

verbose Displays a more-detailed version of the Remote RMX-3200 log file.

(Dub)>show(Dub)show>log-file 1020080810:163621: ***** AI101999 Aug 10 11:36:20 gated[174]: EVENT <Delete> ppp0index 3837 <PointToPoint Multicast ChangeQueued> address Unknown 6e:69:6c20080810:163622: Aug 10 11:36:22 pppd[14684]: Warning: plugin wanppp.so has no version information20080810:163622: Aug 10 11:36:22 pppd[14684]: Plugin wanppp.so loaded.20080810:163622: Aug 10 11:36:22 pppd[14684]: wanppp compiled against pppd 2.4.120080810:163622: Aug 10 11:36:22 pppd[14684]: pppd 2.4.1 started by LOGIN, uid 020080810:163622: ***** AI101999 Aug 10 11:36:22 gated[174]: EVENT <UpDown> hdlc1 index 13 <Up ChangeQueued> address Unknown 020080810:163622: Aug 10 11:36:22 pppd[14684]: Using interface ppp020080810:163622: Aug 10 11:36:22 pppd[14684]: Connect: ppp0 <--> hdlc120080810:163622: Aug 10 11:36:22 pppd[14684]: Warning - secret file /etc/ppp/pap-secrets has world and/or group access20080810:163623: ***** AI101999 Aug 10 11:36:22 gated[174]: EVENT <Add> ppp0 index 3838 <PointToPoint Multicast> address Unknown 6e:69:6c(Dub)show>

WESTELL.COM

Page 3-114

1-800-377-8766


This example shows how to search the last 200 lines of the log for the text “ethernet X” where X represents ports 1 through 4.

See Alsodebug level

(Dub)>show log-file 200 search “ethernet [1-4]”20130324:225251:-0400: ethernet 2: port state down20130324:225251:-0400: ethernet 3: port state down20130324:225251:-0400: ethernet 1: port state up20130324:225251:-0400: ethernet 4: port state up(Dub)>show

WESTELL.COM

1-800-377-8766

Page 3-115

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show meas-table

show meas-table

DescriptionThis command displays configuration information for the measurement table, a summary of all configured measurement table entries, or details about an individual measurement table entry.

Formatsshow meas-table

entries [ name | filter | nopage ]

Parameters


ExamplesThis example displays a summary of measurement table configuration parameters.

entries Displays a list of measurement table entries with the name, state, current value and units for each entry. The following parameters are accepted: name—Specifies the name of an individual measurement table

entry. Detailed information about this entry will display upon execution of the command.

filter—Configures a filter for configured groups of measurement table entries. A period (.) is used for single character matching and an asterisk (*) is used for multiple character matching.

nopage—Displays the entire list of measurement table entries upon execution of the command. When this parameter is not specified, Remote RMX-3200 outputs the list of measurement table entries one page at a time.

(Dub)>show meas-tableNumber of measurements - 28Length of History - 7 day(s), 0 hour(s)Time Interval - 15(Dub)>

WESTELL.COM

Page 3-116

1-800-377-8766


This example displays a list of measurement table entries.

(Dub)>show(Dub)show>meas-table entriesName State Value Units------------------------------------------------------------------------------Entry1 offline ? deg CEntry2 offline ? deg FVoltage1 offline ? VDCjltest high 89.3 gallons(Dub)>


Name Displays the name of the measurement table entry.

State Displays the current status of the measurement table entry. Possible values include:loss-of-signal—The current value is below the configured minimum valuelow—The current value is below the in-band range, but above the minimum valuein-band—The current value lies within the in-band rangehigh—The current value is above the in-band range, but below the maximum valueinput-saturated—The current value is above the configured maximum valueoffline—Remote is not receiving a value from the originator.

Value Displays the current value of the measurement.

Units Displays the unit of measure.

WESTELL.COM

1-800-377-8766

Page 3-117


This example displays detailed information for measurement table entry jltest.

(Dub)>show(Dub)show>meas-table entries jltestName - jltest (static)Status - highOriginator - analog 0/1Description -NE Name - neNameOfJltestCategory - categoryOfJltestReport Interval - 5Low-Band - 20.0High-Band - 80.0Hysteresis - 0.0Max-Limit - 90.0Min-Limit - 10.0Units - gallons

Current Value - 89.3Interval Value - 89.3Interval Minimum - 89.3Interval Maximum - 89.3Interval Average - 89.3(Dub)>


Name Displays the name of the measurement table entry.

Status Displays the current status of the measurement table entry. Possible values include:loss-of-signal—The current value is below the configured minimum valuelow—The current value is below the in-band range, but above the minimum valuein-band—The current value lies within the in-band rangehigh—The current value is above the in-band range, but below the maximum valueinput-saturated—The current value is above the configured maximum valueoffline—Remote is not receiving a value from the originator.

Originator Displays the origin of the measured data; for example, an analog input, a script, or SNMP proxy.

Description Displays a description of the measurement table entry.

NE Name Displays the name of the network element whose data is being measured.

WESTELL.COM

Page 3-118

1-800-377-8766


See Alsoconfig meas-table


show mediation

Category Displays a category for the measurement table entry. The category associates the measurement table entry with a specific application or task.

Report Interval

Displays the interval (in minutes) for storing updated measurement values.

Low-Band Displays the lowest measured value that will be considered an in-band, or normal, condition.

High-Band Displays the highest measured value that will be considered an in-band, or normal, condition.

Hysteresis Displays hysteresis, which works as a guard between high-band and low-band thresholds.

Max-Limit Displays the highest measured value that will be considered a high condition. Values higher than this will result in an input-saturated condition.

Min-Limit Displays the lowest measured value that will be considered a low condition. Values lower than this will result in a loss-of-signal condition.

Units Displays the unit of measure.

Current Value Displays the current value of the measurement.

Interval Value Displays the last measurement value stored during the most recent measurement interval.

Interval Minimum

Displays the lowest value measured during the last report interval.

Interval Maximum

Displays the highest value measured during the last report interval.

Interval Average

Displays the average value measured during the last report interval.


WESTELL.COM

1-800-377-8766

Page 3-119

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show mediation

show mediation

DescriptionThis command displays summaries of all configured TL1 commands, TL1 multiplexers, virtual TL1 NEs, SNMP options, SNMP network elements and TACACS+ services.

Formatsshow mediation

snmp { event-templates [ name ] | manager | measurement-templates [ name ] | ne-templates [ name ] | point-templates [ name ] }

snmpnes [ name ]tacacs-servicetl1commands [ command_name ]tl1muxes [ mux_id ]tl1nes [ ne_id ]

WESTELL.COM

Page 3-120

1-800-377-8766


Parameters

snmp Displays a summary of the SNMP options. The following parameters are accepted: event-templates—Displays all event templates or a detailed

view of an instance of an event template. The following parameter is accepted:name—Specifies the name of an event template for which information will be displayed.

measurement-templates—Displays all measurement templates or a detailed view of an instance of a measurement template. The following parameter is accepted:name—Specifies the name of a measurement template for which information will be displayed.

ne-templates—Displays all NE templates or a detailed view of an instance of an NE template. The following parameter is accepted:name—Specifies the name of an NE template for which information will be displayed.

manager—Displays the settings for the mediation SNMP manager.

point-templates—Displays all point templates or a detailed view of an instance of a point template. The following parameter is accepted:name—Specifies the name of a point template for which information will be displayed.

snmpnes Displays a summary of the SNMP network elements, including the name, the host address and description. The following parameter is accepted:

name—Specifies the name of a network element for which information will be displayed.

tacacs-service

Displays the TACACS+ service used for mediation authentication.

tl1commands Displays a summary of all configured TL1 commands or information for a specified TL1 command. TL1 commands contain command patterns, which are used to generate system events, along with target identifiers and access identifiers. The following parameter is accepted:

command_name—Defines the name of the command for which information will be displayed.

WESTELL.COM

1-800-377-8766

Page 3-121



ExamplesThis example displays a summary of all configured TL1 commands.

This example displays information for TL1 command pt1rls.

tl1muxes Displays a summary of all configured TL1 multiplexers or detailed information for a specified TL1 multiplexer. A TL1 multiplexer provides connectivity to TL1 NEs (both virtual and real devices), multiplexing more than one TL1 data stream onto a single TCP connection. The following parameter is accepted:

mux_id—Defines the ID of the TL1 multiplexer for which detailed information will be displayed.

tl1nes Displays a summary of all configured virtual TL1 NEs or detailed information for one virtual TL1 NE. A virtual TL1 NE models a virtual TL1 NE device for the purpose of alarm reporting. The following parameter is accepted:

ne_id—Defines the ID of the TL1 NE for which detailed information will be displayed.

(Dub)>show(Dub)show>mediation(Dub)show mediation>tl1commands Name Command Pattern TID AID----------------------------------------------------------------------------- equipCheck set-attr-eqpt term1 point3 messInhib inh-msg-all term2 point2 rerelay rls-ext-cont colne1 point1 pt1opr opr-ext-cont dubco2fl3brect reset pt1rls rls-ext-cont dubco2fl3brect reset(Dub)show mediation>

(Dub)>show(Dub)show>mediation(Dub)show mediation>tl1commands pt1rlsName - pt1rlsCommand Pattern - rls-ext-contTID - dubco2fl3brectAID - reset(Dub)show mediation>


AID Displays the access identifiers for the configured commands.

WESTELL.COM

Page 3-122

1-800-377-8766


This example displays a summary of all configured TL1 multiplexers.

This example displays detailed information for TL1 multiplexer 2.

Command Pattern

Displays the configured command patterns. For more information about command patterns, refer to config mediation tl1command on page 2-187.

Name Displays the configured command names.

TID Displays the target identifiers for the configured commands.

(Dub)>show(Dub)show>mediation(Dub)show mediation>tl1muxes Mux-ID State----------------------- 1 enabled 3 disabled 4 disabled 2 enabled(Dub)show mediation>

(Dub)>show(Dub)show>mediation(Dub)show mediation>tl1mux 2Mux-ID - 2State - enabledConnection Strings: 173.45.20.2:33-dubco(Dub)show mediation>


Connection Strings

Displays the configured TL1 multiplexer connection strings. A connection string connects a multiplexer to a virtual or real network device.

Mux-ID Displays the ID of the TL1 multiplexer.

State Displays the state of the TL1 multiplexer as enabled or disabled.


WESTELL.COM

1-800-377-8766

Page 3-123


This example displays a summary of all configured virtual TL1 NEs.

This example displays detailed information for virtual TL1 NE 3.

(Dub)>show(Dub)show>mediation(Dub)show mediation>tl1nes ID State AutoMsgs RtrvHdr TID Description-----------------------------------------------------------------------1 enabled logon logon RemoteRMX Default Virtual N...2 disabled logon logon device1 This is for devic...4 disabled logon logon3 disabled logon logon Sensor This Virtual NE i...(Dub)show mediation>

(Dub)>show(Dub)show>mediation(Dub)show mediation>tl1nes 3NE-ID - 3State - disabledAutoMsgs - logonRtrvHdr - logonTID - SensorDescription: This Virtual NE is used for a light sensor.Users: UID PID ---------- ---------- brian82 brian jimmy jimmy bobby bobby billy billy(Dub)show mediation>


AutoMsgs Displays the TL1 logon requirements (logon or nologon) for TL1 NEs sending autonomous messages.

Description Displays the descriptions for the configured virtual TL1 NEs.

ID (NE-ID) Displays the IDs of virtual TL1 NEs.

PID Displays the configured passwords for a specified virtual TL1 NE.

RtrvHdr Displays the TL1 logon requirements (logon or nologon) for execution of the rtrv-hdr command.

State Displays the states of virtual TL1 NEs as enabled or disabled.

TID Displays the target identifiers used by TL1 commands to reference specific TL1 devices.

WESTELL.COM

Page 3-124

1-800-377-8766


This example displays a summary of all configured SNMP event templates.

This example displays the details of the coldStartDef SNMP event template.

This example displays the settings for the mediation SNMP manager.

UID Displays the configured user identifiers for a specified virtual TL1 NE.

(Dub) show mediation snmp(Dub) show mediationsnmp>event-templatesName Description--------------------------------------coldStartDef configChangeDefifDownDefifUpDefpeiphDef peripheral online/offline event-template description(Dub) show mediation snmp>

(Dub) show mediation snmp(Dub) show mediation snmp>event-templates coldStartDefName: coldStartDefDescription:Message: $(event) event on NE $(snmpne)Trap OID: .1.3.6.1.6.3.1.1.5.1(Dub) show mediation snmp>


Description Displays the description for the mediation SNMP event template.

Message Displays the event template’s alarm message. The message may contain parameters which are replaced by the SNMP NE or by the mediation response. The SNMP NE parameters are set when the alarm table entry is added. The response parameters are set from the mediation event.

Name Displays the name of the event template.

Trap OID Displays the trap OID (Object Identifier) for an event template. This value will be matched against the OID for a trap.

Varbind-match Displays the mediation SNMP event template varbind to match against a trap.


WESTELL.COM

1-800-377-8766

Page 3-125


This example displays a summary of all configured SNMP point templates.

This example displays the details of the ifEntryDef SNMP point template.

(Dub) show mediation snmp(Dub) show mediationsnmp>managerManager Port: 162(Dub) show mediation snmp>


Manager Port Displays the port number for the SNMP manager.

(Dub) show mediation snmp(Dub) show mediation snmp>point-templatesName Description--------------------------------------alarmTableDefifEntryDef Entry in ifTable(Dub) show mediation snmp>

(Dub)>show mediation snmp(Dub) show mediation snmp>point-templates ifEntryName: ifEntryDescription: Entry in ifTablePoll OID: .1.3.6.1.2.1.2.2.1.8.$(ifIndex)Offline Severity: criticalOffline Message: Interface $(point) is offlineState: up Message: $(point) is up Poll Value: 1 Severity: normal Trap OID: .1.3.6.1.6.3.1.1.5.4 Varbind Match: .1.3.6.1.2.1.2.2.1.1 = $(ifIndex)State: down Message: $(point) is down Poll Value: 2 Severity: critical Trap OID: .1.3.6.1.6.3.1.1.5.3 Varbind Match: .1.3.6.1.2.1.2.2.1.1 = $(ifIndex)(Dub) show mediation snmp>


Description Displays a textual description for a point template.

Name Displays the name of the point template.

Poll OID Displays the OID used for polling the point.

WESTELL.COM

Page 3-126

1-800-377-8766


This example displays a summary of all configured SNMP measurement templates.

This example displays the details of the alDef SNMP measurement template.

Offline Severity

Displays the severity for the offline state of the point.

Offline Message

Displays the alarm message for the offline state of the point.

State Displays the name of the point's state and the following information: Message—Displays the alarm message for the point

template state. The message may contain parameters which are replaced by the SNMP NE or by the mediation alarm table.

Poll Value—Displays the poll value for a point template state. The value will be matched against the value returned from the poll OID to determine the point's state.

Severity—Displays the severity for a point template state. This value is used to set the alarm table entry's severity for the state.

Trap-OID—Displays the OID to match against a trap for a mediation SNMP point template state.

Varbind-Match—Displays a matching varbind OID and value for a mediation SNMP point template state.

(Dub) show mediation snmp->measurement-templatesName Description-------------------------------------------------------------------------------alDef Single measurementalTableDef Measurement group

(Dub) show mediation snmp>

(Dub)>show mediation snmp->measurement-templates alDefName: alDefDescription: Single measurementPoll OID: .1.3.6.1.4.1.539.42.2.2.1.5.$(alIndex)Value Match Index: 2Value Conversion Multiplier: 1Trap: critical Trap OID: .1.3.6.1.4.1.539.42.2.0.5 Varbind Value: .1.3.6.1.4.1.539.42.2.2.1.5 Value Match Index: 2 Varbind Match: .1.3.6.1.4.1.539.42.2.2.1.1 = $(alIndex)(Dub) show mediation snmp>


WESTELL.COM

1-800-377-8766

Page 3-127


This example displays a summary of all configured SNMP NE templates.

This example displays the details of the Template1 SNMP NE template.


Description Displays a textual description for a measurement template.

Poll OID Displays the OID (Object Identifier) used to poll the proxied NE for the measurement’s current value.

Value Match Index

Displays which numeric value in a string response should be considered as the desired measured value.

Value Conversion Multiplier

Displays the amount by which the measured value will be multiplied before it is reported or stored.

Trap Displays the name of the trap.

Trap OID Displays the trap OID to match against incoming traps.

Varbind Value Displays a varbind OID used to find the collected measurement.

Varbind Match Displays a varbind OID and value to match against incoming traps.

(Dub) show mediation snmp(Dub) show mediation snmp>ne-templatesName Description-------------------------------------------------------------------------------Template1 Sample templateTemplate2 DeviceB Template(Dub) show mediation snmp>

WESTELL.COM

Page 3-128

1-800-377-8766


This example displays a summary of all configured SNMP network elements.

(Dub)>show mediation snmp(Dub) show mediation snmp>ne-templates Template1Name: Template1Description: Sample templateEvent: runningConfigChange Template: configChangeDef Parameter: file = running-configMeasurement: Meas1 Template: alDef Parameter: current = 1Point: modem Template: ifEntryDef Parameter: ifDescr = serial_modemTemplate Reference: alarm1 Template: alarms Parameter: num = 1(Dub) show mediation snmp>


Description Displays a textual description for an NE template.

Event Displays the name of an event that has been configured for this NE template.

Measurement Displays the name of a measurement that has been configured for this NE template.

Parameter Displays a parameter that is specified for this NE template and the value that is specified for this parameter.

Point Displays the name of a point that has been configured for this NE template.

Template Displays the name of an existing event, point, or NE template that is referenced by this NE template.

Template Reference

Displays a name that uniquely identifies a reference to an existing NE template.

(Dub) show mediation (Dub) show mediation snmpnes>Name Host Description-------------------------------------------------------------------remoteslow 10.34.68.60 remoteslowv1 10.34.68.60MyNE 10.40.65.90 My proxied NE(Dub) show mediation snmp>

WESTELL.COM

1-800-377-8766

Page 3-129


This example displays the details of the MyNE mediation SNMP NE.

(Dub) show mediation (Dub) show mediation>snmpnes MyNEName: MyNEDescription: My proxied NEHost: 10.40.65.90:161SNMP Community: administratorSNMP Version: v1NE Name: MyNECategory: some-categoryConnectivity OID: .1.3.6.1.2.1.1.2.0Connectivity State: OnlineLast Connectivity Poll Reply: Mon Jun 25 17:49:24 GMT 2008Event: reboot Template: coldStart Last Trap: Mon Jun 25 17:49:24 GMT 2008Measurement: newMeasurement Template: myMeasTmpl Last Poll Reply: unknown Parameter: ifIndex = 10Point: ethernet1 Template: ifEntry Current State: up Last Trap: Mon Jun 25 17:49:24 GMT 2008 Last Poll Reply: Mon Jun 25 17:49:24 GMT 2008 Parameter: ifIndex = 1Point: ethernet2 Template: ifEntry Current State: Point Offline Last Trap: unknown Last Poll Reply: unknown Parameter: ifIndex = 2(Dub) show mediation>


Category Displays the category for a mediation SNMP NE.

Description Displays a textual description for an SNMP NE.

Connectivity OID

Displays the OID used to poll for connectivity to the SNMP NE.

Connectivity State

Displays the connectivity state of the SNMP NE: Online or Offline.

WESTELL.COM

Page 3-130

1-800-377-8766


Event Displays the event name for a mediation SNMP NE and the following associated information: Template—The name of a configured event template

which defines the event. Parameter—The name of a replaceable parameter in the

point template and the associated value. Last Trap—The time that a trap last matched the event.

The default value is unknown, for when no trap has yet been received.

Host Displays the SNMP options for the proxied NE and the following associated information: ip_addr—The IP address of the proxied network element.

The default value is 0.0.0.0. port —The port on the proxied network element which is

used for polling. community—The SNMP community string which is used

for polling. v1 —Specifies that SNMP version 1 is used for polling. v2 —Specifies that SNMP version 2 is used for polling.

Measurement Displays the name of a measurement on a mediation SNMP NE and includes the following information: Template—The name of a configured measurement

template which defines the measurement. Last Poll Reply—The time that a poll reply last matched

the measurement. The default value is unknown, for when no poll reply has yet been received.

Parameter —The name of a replaceable parameter in the measurement template and its associated value.

Name Configures the name of the mediation SNMP NE.

Ne Name Displays the network element name for a mediation SNMP NE.


WESTELL.COM

1-800-377-8766

Page 3-131


This example displays the TACACS+ service configured for mediation authentication.

This example displays the default TACACS+ service configured for mediation authentication, which is aimediation.

See Alsoconfig mediation snmpne






config mediation tacacs-service

config mediation tl1command



Point Displays the name of a status point on a mediation SNMP NE and includes the following information: Template—The name of a configured point template

which defines the point. Parameter —The name of a replaceable parameter in the

point template and its associated value. Last Trap—The time that a trap last matched the point.

The default value is unknown, for when no trap has yet been received.

Last Poll Reply—The time that a poll reply last matched the point. The default value is unknown, for when no poll reply has yet been received.

(Dub) show mediation>tacacs-serviceTACACS+ service: shell

(Dub) show mediation>tacacs-serviceTACACS+ service: aimediation


WESTELL.COM

Page 3-132

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show ntp

show ntp

DescriptionThis command displays the current NTP configuration for Remote RMX-3200.

Formatsshow ntp


ExamplesThis example displays NTP in an enabled state, the configuration of the preferred server with the IP address of 10.50.18.33, the configuration of the secondary server with the IP address of 10.50.18.32 and the default configuration of the minimum and maximum polling intervals

This example displays NTP in a disabled state.

See Also config ntp

(Dub)>show(Dub)show>ntpNTP is enabled.Preferred NTP server: 10.50.18.33Secondary NTP server: 10.50.18.32Poll interval is 2^6 (64) - 2^10 (1024) seconds(Dub)show>

(Dub)>show(Dub)show>ntpNTP is disabled.Preferred NTP server: 10.50.18.33Secondary NTP server: 10.50.18.32

Poll interval is 2^6 (64) - 2^10 (1024) seconds(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-133

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show peripherals

show peripherals

DescriptionThese commands display information for all peripherals discovered by Remote RMX-3200 or information for a specified peripheral. Both the administrative and operational management status elements are displayed. The administrative status elements show what has been configured for a peripheral unit. The operational status elements show the runtime states for the peripheral devices.

Formatsshow peripherals

name nameunit unit

Parameters


name Specifies the name of a peripheral device for display. The following parameter is accepted:

name—Selects the name of a managed peripheral device. This name consists of a series of letters followed by six hexadecimal digits representing the low order three bytes (the unique portion) of the peripheral’s MAC address. Names are formatted as follows, where each X represents a hexadecimal digit: RMB1-XXXXXX for RMB-1 and RMB-2 units DEP-XXXXXX for Expand D units FB64-XXXXXX for RME-B64 units FE8-XXXXXX for RME-E8 units SER8-XXXXXX for RME-S8 units.

unit Specifies a peripheral unit number for display. The following parameter is accepted:


WESTELL.COM

Page 3-134

1-800-377-8766


ExamplesThis example displays information pertaining to all discovered peripherals.

This example displays administrative and operational information for managed peripheral DEP-04A0A9.

(Dub)>show(Dub)show>peripheralsName State IP Manager IP Manager Name------------------------------------------------------------------------------DEP-04A0A9 Online 169.254.16.199 10.34.64.101 A101DEP-04A0C8 Online 169.254.188.1 10.34.64.101 A101FB64-0D1C39 Online 169.254.222.236 10.34.64.101 A101SER8-045158 Online 169.254.121.234 10.34.64.101 A101SER8-045171 Online 169.254.88.83 10.34.64.101 A101SER8-04A0DD Online 169.254.21.218 10.34.64.101 A101

Unit Name IP Description------------------------------------------------------------------------------1 SER8-045158 169.254.121.234 DES2 DEP-04A0A9 169.254.16.1993 SER8-04A0DD 169.254.21.21845 FB64-0D1C39 169.254.222.2366789 SER8-045171 169.254.88.83101112 DEP-04A0C8 169.254.188.1(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-135


(Dub)>show(Dub)show>peripherals unit 2Unit number: 2Description:Type: discrete-expansionAdmin state: Managed

Name: DEP-04A0A9IP address: 169.254.16.199Oper state: OnlineManager name: A101Manager IP address: 10.34.64.101Type: discrete-expansionModel: B160.BFirmware version: 1.10Firmware build date: 2006-09-12,18:37:03.0,-04:00Firmware build ID: 005Serial number: 23028069Manufacture date: 07/01/05Stage2 bootloader version: 3.10Stage2 bootloader build date: Thu Jul 6 13:52:11 EDT 2006MAC address: 00:40:72:04:A0:A9

Discrete-I/O 2 subsystem: Online(Dub)show>


Admin state Displays the current administrative state of the peripheral.

Description Displays the user-configured description for the peripheral.

Discrete-I/O subsystem Displays the current operational state of the discrete I/O subsystem on the peripheral.

Firmware build date Displays the build date of the firmware executing on the peripheral.

Firmware build ID Displays the build ID of the firmware executing on the peripheral.

Firmware version Displays the version number of the firmware executing on the peripheral.

IP address Displays the IP address of the peripheral.

MAC address Displays the hardware address of the peripheral.

Manager IP address Displays the IP address of the Remote RMX-3200 currently managing the peripheral, or no text if the peripheral is unmanaged.

WESTELL.COM

Page 3-136

1-800-377-8766



Manager name Displays the host name of the Remote RMX-3200 currently managing the peripheral, or no text if the peripheral is unmanaged.

Manufacture date Displays the manufacturing date of the peripheral.

Model Displays the hardware model name of the peripheral.

Name Displays the host name of the peripheral.

Oper state Displays the current management state of the peripheral.

Serial number Displays the serial number of the peripheral.

Stage 2 bootloader build date

Displays the build date of the second stage bootloader executing on the peripheral.

Stage 2 bootloader version

Displays the version number of the second stage bootloader executing on the peripheral.

Type Displays the type of the peripheral as follows: discrete-expansion for Expand D units RMB-1 for RMB-1 and RMB-2 units serial8-expansion for RME-S8 units fb64-expansion for RME-B64 units FE8-expansion for RME-E8 units

Unit number Displays the unit number of the peripheral.


WESTELL.COM

1-800-377-8766

Page 3-137

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show pkgs

show pkgs

DescriptionThis command displays a summary of a specified package for Remote RMX-3200. All items listed in the summary are displayed in alphabetical order by script name.

Formatsshow pkgs

name packageon-demand-installserversummary

Parameters


name Displays a summary of a specified package for Remote RMX-3200. All items listed in the summary are displayed in alphabetical order by script name. The following parameters are accepted:

package—Defines the name of the package being displayed.

on-demand-install

Displays the status of the on demand install option. When this option is enabled, Remote RMX-3200 will retrieve missing packages from the FTP server or the staging area as they are required by a starting job. When this option is disabled, jobs dependent on missing packages will not be started.

Tip: The staging area is a directory in Remote RMX-3200 that stores files downloaded from the FTP server. If an FTP server has been specified, packages will be downloaded to the staging area when on-demand-install is enabled.

server Displays the status and settings for the configured FTP server.

summary Displays a list of all packages installed on Remote RMX-3200. Package names are listed alphabetically.

WESTELL.COM

Page 3-138

1-800-377-8766


ExamplesThis example displays package examplescript along with its associated characteristics and settings.

(Dub)>show(Dub)show>pkgs(Dub)show pkgs>name examplescriptPackage: examplescript Version: 1.0.0 Running job count: 0Imports: Package Min version Presence testimpb 2.1.0 missingScript: capture_example Author: Applied Innovation Inc. Description: This prints a property to stdout and stderr. Language: Python Module: exampleScript.script Class: CaptureExample Properties: Name Required? capture_text requiredScript: echo_example Author: Applied Innovation Inc. Description: This is an echo server example script. Language: Python Module: exampleScript.script Class: EchoExample Tasks: Name Type Required? new_ip ifconfig optional server_sock serversocket required Properties: Name Required? strip_spaces optional upper_case optional(Dub)show pkgs>


Imports Displays the status of package imports, which are additional modules for use during script execution. The following information related to imports is also displayed: Package displays the script package import that is required by

the main package. Required version displays the minimum version of the

imported script package that is compatible with the main package.

Installed version displays the currently installed script package import.

WESTELL.COM

1-800-377-8766

Page 3-139


This example displays the status of the on-demand-install option as disabled.

Package Displays the package name along with the following characteristics: Version displays the version number. Running job count displays the number of running jobs that

are currently using the package.

Properties Displays the job properties expected by the script. The following job property characteristics are listed: Name displays the job property names. Required? displays if the job properties are required or not.

Script Displays a script within the package. The following script characteristics are listed: Author displays the author of the script. Description displays a description of the script. Language displays the language used to create the script. It

includes the sub-headings Module, which indicates the package for which the script was created and Class which indicates the script name.

Note: Multiple scripts can be contained in a package.

Tasks Displays the tasks expected by the script. The following task characteristics are listed: Name displays the task names. Type displays the task types (ifconfig or serversocket). Required? displays if the tasks are required or not.

(Dub)>show(Dub)show>pkgs(Dub)show pkgs>on-demand-installOn demand install: disabled(Dub)show pkgs>


WESTELL.COM

Page 3-140

1-800-377-8766


This example displays the status and settings of the configured FTP server.

This example displays a summary of all packages. The information includes package names with corresponding version numbers.



config pkgs server


(Dub)>show(Dub)show>pkgs(Dub)show pkgs>serverFTP server: enabledAddress: 10.50.37.9Port: 21User: newPassword: serverDirectory: /tmpdir/test/ftp8/packages/server(Dub)show pkgs>


Address Displays the IP address of the server.

Directory Displays the directory in which the packages reside.

FTP server Displays the status of the remote FTP server as enabled or disabled.

Password Displays the password for the server.

Port Displays the port number for the server.

(Dub)>show(Dub)show>pkgs(Dub)show pkgs>summaryPackage Versiongoodpkg 1.0.0jobtestutils 1.0.0testi 2.0.1

testj 2.0.1(Dub)show pkgs>

WESTELL.COM

1-800-377-8766

Page 3-141

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show product

show product

DescriptionThis command displays product information for Remote RMX-3200.

Formatsshow product


ExamplesThis example displays the product information for Remote RMX-3200.

(Dub)>show(Dub)show>productProduct code: RMX3200Part number: B535-01.2:0RMX with POE(Dub)show>


Hardware components Displays the hardware components that are associated with Remote RMX-3200. The example displays component RMX with POE. If you have an expansion card plugged into the expansion slot, its information will appear as well (for example, T1/E1 WAN card or Wireless Modem Card).

Part number Displays a part number for Remote RMX-3200. The example displays part number B535-01.2:0.

Product code Displays the product code from the Kentrox product catalog for this particular model of Remote RMX-3200. The example displays the product code as RMX3200.

WESTELL.COM

Page 3-142

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show profiles

show profiles

DescriptionThis command displays all profiles, or detailed information for a specified profile.

Formatsshow profiles [ profile_name ]

Parameters


ExamplesThis example displays information for all user-defined profiles:

This example displays detailed information for user-defined profile tech:

profile_name Specifies the profile to display.

(Dub)>show(Dub)show>profilesProfile Name Base Type priv-lvlnew1 supervisor 3SuperStatus status 6new3 management 10tech status 5(Dub)show>

(Dub)>show(Dub)show>profiles tech

Name: techBase Type: statusPrivilege Level: 5

Command ID Action/config/controller/eth include/config/interface/eth include/show/resource-tracking exclude(Dub)show>

Column Description

Action Displays if the command IDs are included or excluded for the user-defined profile.

WESTELL.COM

1-800-377-8766

Page 3-143

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show profiles

See Alsoconfig profile

Base Type Displays the system profile on which the user-defined profile is based.

Command ID Displays the IDs for the commands to include or exclude with the user-defined profile. For a list of valid command IDs, refer to Appendix : Command Identifications.

Name Displays the name of the user-defined profile.

priv-lvl Displays the privilege level for a profile. The privilege level is used when RAS mode authorization is set to priv-lvl. The RAS server returns a privilege level to Remote RMX-3200 that is matched with the correct profile.

Privilege Level

Displays the privilege level for a profile. The privilege level is used when RAS mode authorization is set to priv-lvl. The RAS server returns a privilege level to Remote RMX-3200 that is matched with the correct profile.

Profile Name Displays the name of the user-defined profile.


WESTELL.COM

Page 3-144

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show ras

show ras

DescriptionThis command displays the current RAS configuration for Remote RMX-3200.

Formatsshow ras

statistics

Parameters


ExamplesThis example displays the configured RAS settings:

statistics Displays AAA specific counters and statistics.

(Dub)>show rasShell RAS option: TACACS+ with Local FallbackRAS Accounting: disabledRAS Authorization: privilegeRAS Retry: 1RAS Timeout: 15

RAS ServersIP Port Secret Phases10.50.18.32 4004 secret word authen author account10.50.18.33 4003 newpass author account

(Dub)>


Shell RAS option

Displays the remote user authentication server and fallback status. Remote RMX-3200 provides either RADIUS or TACACS+ support. Remote user authentication takes effect only if the RAS servers have been properly configured.

RAS Accounting

Displays the status of TACACS+ accounting of user login events and shell command events. An accounting start packet or stop packet is issued each time a user logs into or out of Remote RMX-3200. An accounting start packet is also issued for each shell command that is run.

WESTELL.COM

1-800-377-8766

Page 3-145


RAS Authorization

Displays the status of TACACS+ authorization as either privilege or command. Privilege level authorization is based on the priv-lvl returned from the TACACS+ server. Per-command authorization requires Remote RMX-3200 to contact the TACACS+ server for each shell command run by a user. Individual commands are then allowed or denied.

RAS Retry Displays the number of consecutive connection attempts that are made to a TACACS+ server before the attempt fails.

Note: Consecutive attempts are made only if the TACACS+

server responds but refuses a connection. If no response is received from a TACACS+ server before the configured timeout period, then no further connection attempts are made.

RAS Timeout Displays the fallback timeout period. This is the amount of time that the device waits for a response from the RAS servers before falling back on local authentication.

RAS Servers Displays information for configured RAS servers. The following subheadings are included: IP—Displays IP addresses for the preferred and secondary

RAS servers. Existing preferred and secondary RAS server IP addresses must be deleted before new ones can be configured.

Phases—Displays the AAA phases handled by the TACACS+ server.

Port—Displays a server port for a RAS server. A RAS server is a device that provides user authentication and authorization for remote access into the network with either a RADIUS or TACACS+ protocol.

Secret—Displays the RAS server password.


WESTELL.COM

Page 3-146

1-800-377-8766


This example displays the RAS AAA statistics:

See Alsoconfig ras

config ras server

(Dub)>show(Dub)show>ras statisticsRAS Statistics:Authentication Attempts: 5Authentication Failures: 0Authentication Fallbacks: 2

Authorization Attempts: 5Authorization Failures: 0Authorization Fallbacks: 2

Accounting Attempts: 5Accounting Failures: 0Accounting Fallbacks: 2(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-147

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show remote-access

show remote-access

DescriptionThis command displays the remote access protocol configuration.

Formatsshow remote-access


ExamplesThis example displays the remote access protocol configuration.

See Alsoconfig remote-access

(Dub)>show remote-accessSSH and SFTP: EnabledTelnet and FTP: EnabledTelnet port: 23FTP port: 21HTTP: DisabledHTTP port: 80HTTPS: EnabledHTTPS port: 443(Dub)>

WESTELL.COM

Page 3-148

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show resource-tracking

show resource-tracking

DescriptionThis command displays the items that have been marked for resource usage tracking.

Formatsshow resource-tracking


ExamplesThis example displays the items that have been marked for resource tracking.



config discrete analog



(Dub)>show(Dub)show>resource-tracking ID Resource State analog 0/3 assigned input 0/4 assigned output 0/4 assigned serial wan/1 assigned(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-149

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show responses

show responses

DescriptionThis command displays summary information for all responses or displays for a specified response.

Formatsshow responses [ response_name ]

Parameters


ExamplesThis example displays summary information for all responses.

response_name Defines the response for which detailed information will be displayed.

Tip: To display summarized information for all responses with names beginning with a specific character or characters, enter a partial response name followed by *. For example, to display all Telnet connection responses, enter show responses Telnet*.

(Dub)>show(Dub)show>responses Name Type Responder Description------------------------------------------------------------------------------ closedoor tl1alarm tl1ne 1 Activates an alar... doorOpenTl1Alarm interval analog 0/1 Activates an alar... equipAlm tl1eqptalarm tl1ne 3 Activates an alar... pressureGauge connect serial 6 Activates an alar...(Dub)show>

Column Description

Description Displays the configured response descriptions.

Name Displays the names of all configured responses.

WESTELL.COM

Page 3-150

1-800-377-8766


This example displays detailed information for response equipAlm.

Responder Displays the responders associated with the configured responses. Responders are system components that process responses. For descriptions of all available responders, see the response configuration commands.

Type Displays the response types associated with the configured responses. For descriptions of all available response types, refer to the response configuration commands.

(Dub)>show(Dub)show>responses powerFeedDownResponse Name : powerFeedDownResponse Description : This response activates when a power feed goes downResponse Responder : tl1ne 3Response Type : tl1eqptalarmResponse Parameters : aid=PWRA almcde=CR conddescr=Activates an alarm when a power feed fails condtype=condition1 ntfcncde=CR srveff=SA(Dub)show>


Response Description

Displays the configured response description.

Response Name Displays the name of the configured response.

Response Parameters

Displays the configured response parameters for the response type. For descriptions of all configurable response parameters, see the response configuration commands.

Response Responder

Displays the responder associated with the configured response. A responder is a system component that processes a response. For descriptions of all available responders, see the response configuration commands.

Response Type Displays the response type associated with the configured response. For descriptions of all available response types, refer to the response configuration commands.


WESTELL.COM

1-800-377-8766

Page 3-151


See Alsoconfig response


WESTELL.COM

Page 3-152

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show running-config

show running-config

DescriptionThis command compiles and displays the current Remote RMX-3200 configuration. It displays recent user modifications to the configuration. The running configuration can be accessed anytime and by any user.


users with management and status profiles cannot view configuration information pertaining to users and other sensitive data.

Tip: This command performs the same function as command running-config on page 5-42.

Formatsshow running-config [ nopage ]

Parameters


nopage Displays the entire running configuration upon execution of the command. When this parameter is not specified, Remote RMX-3200 outputs the running configuration one page at a time.

WESTELL.COM

1-800-377-8766

Page 3-153

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show running-config

ExamplesThis example displays the running configuration where default route 10.40.0.1 is set, the Remote RMX-3200 session is configured to never time out and users test and techcomm are added to the system.

See Alsocopy

running-config

(Dub)>show running-config# Product: Remote RMX# Version: 3.30# Created: 2010-11-01,14:52:35.0,-0500# User: test# Stage2 Version: 4.06config clock timezone est -5:00config clock daylight-savings edtconfig clock timestamp ESTconfig dhcp-relay server 10.39.70.40config ip name-server 10.25.2.5config ip name-server 10.25.2.20config ip route default 10.40.0.1config mediation tacacs-service shellconfig ras shell tacacs+ fallbackconfig remote-access ssh-sftp enableconfig snmp host 10.34.3.84 162 public v1config snmp host 10.34.3.83 162 public v2-informconfig snmp host 10.34.3.86 162 public v2config timeout 0config users add techcomm supervisor -e$1$Qzv94sky$J/XFok7lVjo8E/lmbH9fh. -e$1$Qzv94

WESTELL.COM

Page 3-154

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show sitebus

show sitebus

DescriptionThis command displays a summary of all devices connected to the SiteBus terminals on an RMB peripheral unit, or details about a specific SiteBus device.

Formatsshow sitebus

id hex_idname name

Parameters


id Displays detailed information about a specific SiteBus device, identified by its hexidecimal ID. The following parameter is accepted:

hex_id—Identifies the 14-digit hexidecimal ID for a SiteBus device; for example, 280023AB5A120F. Every device is hard-coded with a unique hexidecimal ID, which is discovered by RMB and reported to Remote RMX-3200.

name Displays detailed information about a specific SiteBus device, identified by its name. The following parameter is accepted:

name—Identifies the name for a SiteBus device.

WESTELL.COM

1-800-377-8766

Page 3-155


ExamplesThis example displays a summary of discovered and/or configured SiteBus devices. Information is displayed for three devices:

Device ID 280000561000F1, which has been discovered by RMB and has been configured with device name Temp1.

Device ID 2800006F5AA522, which has been configured with device name temp2, but has not been discovered by RMB.

Device ID 28004564AE05A5, which has been discovered by RMB, but has not been configured with a device name in the Remote RMX-3200 CLI.

(Dub)>show(Dub)show>sitebus

ID Periph:Bus State Managed Name------------------------------------------------------------------------------28004564AE05A5 1:2 Unmanaged280000561000F1 1:1 Managed temp1

Name ID State Type Description-----------------------------------------------------------------------------temp1 280000561000F1 Online sbTemp Heating core temp prtemp2 2800006F5AA522 Offline sbTemp Exterior temp probe(Dub)show>

Column Description

Description Displays the text description for a SiteBus device.

ID Displays the unique 14-digit hexidecimal ID value for each SiteBus device. Every device is hard-coded with a unique hexidecimal ID, which is discovered by RMB and reported to Remote RMX-3200.

Name/Managed Name

Displays the name that was configured for each SiteBus device. This field will be blank for devices that have been discovered by RMB, but have not been configured in the Remote RMX-3200 CLI.

Periph:Bus Displays the SiteBus terminal and peripheral unit to which this device is connected. For example, the value 1:2 indicates the device is connected to the second SiteBus terminal on the first RMB peripheral unit.

WESTELL.COM

Page 3-156

1-800-377-8766


This example displays details about device 28004564AE05A5, which has been discovered, but has not been configured.

This example displays details about device 280000561000F1, which has been discovered and configured.

State The following State values are listed: Managed indicates that the device has been discovered by

RMB and configured in the Remote RMX-3200 CLI. Unmanaged indicates that the device has been discovered by

RMB, but has not been configured in the Remote RMX-3200 CLI.

Online indicates that a configured device has a valid device type and has been discovered by RMB.

Offline indicates that a configured device has an invalid device type and/or has not been discovered by RMB.

Type Displays the device type, which determines how data from the device will be interpreted and what points will be created for the device.

Note: The only SiteBus device type supported for Remote RMX-

3200 Version 5.4x is sbTemp.

(Dub)>show(Dub)show>sitebus id 28004564AE05A5

Discovered ID: 28004564AE05A5Supported Types: sbTempPeripheral: 1Bus: 2Admin State: UnmanagedLast Updated Time: Mon Feb 1 16:42:46 EDT 2010(Dub)show>


WESTELL.COM

1-800-377-8766

Page 3-157


(Dub)>show(Dub)show>sitebus id 280000561000F1

Name: temp1Description: Heating core temp probeID: 280000561000F1Type: sbTempPeripheral: 1Bus: 1Admin State: ManagedOper State: OnlineLast Updated Time: Mon Feb 1 16:42:46 EDT 2010(Dub)show>

Column Description

Admin State The following Admin State values are listed: Managed indicates that the device has been discovered by

RMB and configured in the Remote RMX-3200 CLI. Unmanaged indicates that the device has been discovered by

RMB, but has not been configured in the Remote RMX-3200 CLI.

Bus Displays the SiteBus terminal to which this device is connected.

Discovered ID/ID

Displays the unique 14-digit hexidecimal ID value for each SiteBus device. Every device is hard-coded with a unique hexidecimal ID, which is discovered by RMB and reported to Remote RMX-3200.

Last Updated Time

Displays the date and time when device status was last updated.

Oper State The following Oper State values are listed: Online indicates that a configured device has a valid device

type and has been discovered by RMB. Offline indicates that a configured device has an invalid

device type and/or has not been discovered by RMB.

Peripheral Displays the RMB peripheral to which this device is connected.

Supported Types

Displays the device types a discovered (but unconfigured) device can support.

Note: The only SiteBus device type supported for Remote

RMX-3200 Version 5.4x is sbTemp.

WESTELL.COM

Page 3-158

1-800-377-8766


See Also config sitebus

Type Displays the device type, which determines how data from the device will be interpreted and what points will be created for the device.

Note: The only SiteBus device type supported for Remote

RMX-3200 Version 5.4x is sbTemp.


WESTELL.COM

1-800-377-8766

Page 3-159

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show site controls

show site controls

DescriptionThis command shows the status of a control and lists control parameters along with their current values. Control names and parameter names are determined by the module packages installed on the Remote RMX-3200.

FormatsFor showing a site’s controls:

show site controls

For showing a site control’s status and parameters:

show site controls [control_name]

Parameters


ExamplesThis example displays a summary of a site’s controls:

control_name Displays the status and parameters for a control.

(Dub)>show site controlsControl Category State Admin------------------------------------------------------------------------------generator Generator Online enabledhvacSystem HVACSystem Offline enabled(Dub)>

Column Description

Admin Displays the administrative state of the control as enabled or disabled.

Category Displays the category for the control.

Control Displays the name for the control.

State Displays the status of the control. Possible states are Online, Offline, fatal-error, or other custom states as defined by the module.

WESTELL.COM

Page 3-160

1-800-377-8766


In this example, the details of the following control and its parameters are shown:

Control name hvacSystem

(Dub)>show site controls hvacSystemName - hvacSystemDescription - HVAC System ControlsCategory - HVACSystemAdmin - enabledState - Offline

Parameters------------------------------------------------------------------------------Name - coolingSetpointValue - ?Type - integer (18 - 95)Description - Cooling Setpoint

Name - leadSwapDelayValue - 7Type - integer (1 - 7)Description - Lead Swap Delay (days)


Admin Displays the administrative state of the control as enabled or disabled.

Category Displays the category for the parameter.

Description Displays the text description for the control and its parameters.

Name Displays the name for the control and its parameters.

State Displays the status of the control. Possible states are Online, Offline, fatal-error, or other custom states as defined by the module.

WESTELL.COM

1-800-377-8766

Page 3-161


See Alsoconfig site control


Type Displays the type for the parameter. Possible types are: integer floating-point string enumeration group analog-input discrete-input discrete-output serial-port ethernet-port reference

The valid values for the enumeration type are displayed in the command line hints for the parameter configuration commands.

Value Displays the value for the parameter.


WESTELL.COM

Page 3-162

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show site modules

show site modules

DescriptionThis command shows the status and configurations of a module and its applications at a site. A module is a software package that supports several sets of related tasks (for example, Power Management). Each module contains one or more applications. An application is a collection of software and hardware componentry that supports a specific set of tasks (for example, a battery monitoring application, or a generator management application).

FormatsFor showing the modules installed on a Remote RMX-3200:

show site modules

For showing the configuration for a module and its applications:show site modules [module_name]

Parameters


ExamplesThis example displays a summary of modules installed on the Remote RMX-3200:

module_name Specifies a name for a module. A selection of values will be available based on the module packages that have been installed on the Remote RMX-3200.

(Dub)>show site moduleModule Version Description Date------------------------------------------------------------------------------Common 1.0.0 Common Library 2011.09.30 10:32:19Environmental 1.0.0 Environmental Management 2011.09.30 10:31:42Power 1.0.0 Power Management 2011.09.30 10:32:27(Dub)>

Column Description

Date Displays the date the module was built.

Description Displays the text description of the module.

WESTELL.COM

1-800-377-8766

Page 3-163


In this example, the following module configuration and applications are shown:

Module name Power

Module Displays the name for the module.

Version Displays the version number of the module.

(Dub)>show site module PowerName - PowerDescription - Power ManagementProduct Version - 1.0.0Compatibility Version - 1.0.0Build ID - 012Build Date - 2011.09.30 10:32:27.801 -0400

Application Type State Description------------------------------------------------------------------------------ACPowerMonitoring optional disabled An application for monitoring AC PoBatteryMonitoring included enabled An application for monitoring batteFuelMonitoring optional disabled An application for monitoring fuelGeneratorManagement optional enabled An application for monitoring and cHybridPowerManagemen optional disabled An application for managing hybridRectifierMonitoring included enabled An application for monitoring the r(Dub)>

Column Description

Application Displays the name of the application.

Description Displays the text description of the application.

State Displays the state of the control as enabled or disabled.

Type Displays whether the application is optional or included in the module.


Build Date Displays the build date of the module.

Build ID Displays the build ID of the module.

Compatibility Version

Displays the compatibility version of the module.

Description Displays the text description of the module.


WESTELL.COM

Page 3-164

1-800-377-8766


See Also config site module

exec site install

exec site uninstall

Name Displays the name of the module.

Product Version

Displays the version number of the module.


WESTELL.COM

1-800-377-8766

Page 3-165

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show site network-elements

show site network-elements

DescriptionThis command displays a site’s network elements (NEs) and sub-components status, parameters and status points.

Note: There can be 0 or more status points or parameters for any given NE.

FormatsTo display the NEs on a site:

show site network-elements

To display the status and parameters of an individual NE:

show site network-elements ne_name

To display the summary list of status points for an individual NE:

show site network-elements ne_name status-points

To display the details of a specific status point of an individual NE:

show site network-elements ne_name status-points statuspoint_name

To display the summary list of an NE’s sub-components:

show site network-element ne_name components

To display an NE’s specific sub-component:

show site network-elements ne_name components sub-component_name

To display the summary list of an NE’s sub-component’s status points:

show site network-elements ne_name components sub-component_name status-points

To display a summary of a specific sub-component status point:

show site network-element ne_name components sub-component_name status-points statuspoint_name

Parameters

ne_name Identifies the NE being shown.

statuspoint_name Identifies the status point being shown for the selected NE.

sub-component name Identifies the sub-component being shown

WESTELL.COM

Page 3-166

1-800-377-8766



ExamplesIn this example, all the NEs on a site are shown:

(Dub)>show site network-elementsNetwork Element Category Type State------------------------------------------------------------------------------acPowerDistributi ACPowerDistribution LovatoRGK60ATS onlinebatteryString BatteryString BatteryStringVoltageSen onlinebatteryStringTemp TemperatureSensor SiteBusTemperature onlinedoor DoorSensor DiscreteDoor onlinefuelTank RectangularFuelTankPresgenerator Generator LovatoRGK60Generator onlinegeneratorPower GeneratorThreePhasePowehvac1IntakeTemper TemperatureSensor SiteBusTemperature onlinehvac1OutletTemper TemperatureSensor SiteBusTemperature onlinehvac2IntakeTemper TemperatureSensor offlinehvac2OutletTemper TemperatureSensor offlinehvacEquipmentLoad HVACEquipmentLoadEnergy offlinehvacSystem HVACSystem MarvairCS4HVACSystem onlinehvacSystemEnergy HVACEnergyMeter offlinehvacUnit1 HVACUnit MarvairCS4HVACUnit onlinehvacUnit1Energy HVACEnergyMeter offlinehvacUnit1Power ElkorThreePhasePowerMethvacUnit2 HVACUnit offlinehvacUnit2Energy HVACEnergyMeter offlinehvacUnit2Power ElkorThreePhasePowerMethybridPowerManage KentroxHybridPowerManagindoorHumidity HumiditySensor RMBHumidity onlineindoorTemperature TemperatureSensor RMBTemperature onlinemainsPower LovatoRGK60MainsPowerMeoutdoorHumidity HumiditySensor RMBHumidity onlineoutdoorTemperatur TemperatureSensor RMBTemperature onlinerectifier Rectifier EmersonVEC onlinesiteEquipmentLoad KentroxSiteEquipmentLoasitePower ElkorThreePhasePowerMetsmokeDetector SmokeDetector MarvairCS4SmokeDetector online(Dub)>

Column Description

Category Displays the category of the NE.

Network Element

Displays the name of the NE.

State Displays the state of the NE as online or offline.

Type Displays the type of NE. The valid values for the enumeration type are displayed in the command line hints for the parameter configuration commands.

WESTELL.COM

1-800-377-8766

Page 3-167


In this example, the following NE and its parameters are shown:

NE name door

Status points can be displayed in a summary view or a detailed view. In this example, the status point summary for a NE is shown:

Status points for NE generator

(Dub)>show site network-elements doorName - doorDescription - Site door sensorCategory - DoorSensorType - DiscreteDoorState - onlineInternalState - Online

Parameters------------------------------------------------------------------------------Name - discreteValue - input 1/5 (configured)Type - discrete-inputDescription - Input for discrete door sensor

Name - normalStateValue - closeType - enumerationDescription - Discrete state while door is closed (open or close)(Dub)>


Category Displays the category of the NE.

Description Displays the text description of the NE or parameter.

Internal State

Displays the internal state of the NE as online or offline.

Name Displays the name of the NE or parameter.

State Displays the state of the NE as online or offline.

Type Displays the type of NE or parameter. The valid values for the enumeration type are displayed in the command line hints for the parameter configuration commands.

Value Displays the value of the parameter.

WESTELL.COM

Page 3-168

1-800-377-8766


In this example, the status points details for a NE is shown:

Status point Operating_State for NE generator

This example shows a summary list of an NE’s sub-components:

(Dub)>show site>network-elements generator status-points

Status Point State Message------------------------------------------------------------------------------Operating_State running The generator is running normallyTesting_Mode inactive The testing mode is inactive


Status Point Displays the name of the status point.

State Displays the state of the NE’s status point

Message Displays a brief message about the NE’s status points.

(Dub)>show site>network-elements generator status-points Operating_State

Name - Operating_StateDescription - The current state of the generator.State - runningMessage - The generator is running normally

(Dub)>


Name Displays the name of the NE status point.

Description Displays the description of the NE status point.

State Displays the state of the NE’s status point

Message Displays a brief message about the NE’s status points.

WESTELL.COM

1-800-377-8766

Page 3-169


This example shows details about an NE’s specific sub-component:

(RMX104) show>site network-elements das2 componentsNetwork Element Component Type State------------------------------------------------------------------------------das2Local_1 AndrewIONDASLocalUnit online|-- das2Remote_1_10_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_10_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_10_3 AndrewIONDASRemoteUnit online|-- das2Remote_1_10_4 AndrewIONDASRemoteUnit online|-- das2Remote_1_11_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_11_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_11_3 AndrewIONDASRemoteUnit online|-- das2Remote_1_11_4 AndrewIONDASRemoteUnit online|-- das2Remote_1_12_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_12_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_12_3 AndrewIONDASRemoteUnit online|-- das2Remote_1_12_4 AndrewIONDASRemoteUnit online|-- das2Remote_1_3_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_3_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_3_3 AndrewIONDASRemoteUnit online|-- das2Remote_1_3_4 AndrewIONDASRemoteUnit online|-- das2Remote_1_4_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_4_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_4_3 AndrewIONDASRemoteUnit online|-- das2Remote_1_4_4 AndrewIONDASRemoteUnit online|-- das2Remote_1_5_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_5_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_5_3 AndrewIONDASRemoteUnit online|-- das2Remote_1_5_4 AndrewIONDASRemoteUnit online|-- das2Remote_1_6_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_6_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_6_3 AndrewIONDASRemoteUnit online|-- das2Remote_1_6_4 AndrewIONDASRemoteUnit online|-- das2Remote_1_9_1 AndrewIONDASRemoteUnit online|-- das2Remote_1_9_2 AndrewIONDASRemoteUnit online|-- das2Remote_1_9_3 AndrewIONDASRemoteUnit online\-- das2Remote_1_9_4 AndrewIONDASRemoteUnit online(RMX104) show>


Network Element Component Displays the name of the NE’s sub-component

Type Displays the type of sub-component

State Displays the state (online or offline) of the sub-component

WESTELL.COM

Page 3-170

1-800-377-8766


(RMX104) show>(RMX104) show>site network-elements das2 components das2Remote_1_6_2Name - das2Remote_1_6_2Display name - das2Remote_1_6_2Description -Category - DASRemoteUnitType - AndrewIONDASRemoteUnitState - onlineInternalState - Online

Parameters------------------------------------------------------------------------------Name - descriptionDisplay Name - descriptionValue - (default)Type - stringDescription - Extra description about this NE

Name - modelDisplay Name - modelValue - (default)Type - stringDescription - Extra model information about this NE

Name - parentNameDisplay Name - parentNameValue - (default)Type - stringDescription - Name of this units parent DAS NE

(RMX104) show>


Name Displays name of the NE’s specified sub-component

Display name Displays the display name of the NE’s specified sub-component

Description Displays a description of the sub-component or parameter

Category Displays category of the NE’s specified sub-component

Type Displays the type of the NE’s specified sub-component or parameter

State Displays the state (online or offline) of the NE’s specified sub-component

InternalState Displays additional detail about the state which can be useful for diagnostic purposes

Value Displays the value of the parameter

WESTELL.COM

1-800-377-8766

Page 3-171


See Alsoconfig site network-element

WESTELL.COM

Page 3-172

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show site network-elements-sets

show site network-elements-sets

DescriptionThis command displays summary information for all NE sets or detailed information for a specified NE set.

Formatsshow site network-elements-sets [set_name]

Parameters


ExamplesThis example displays summary information for all NE sets.

set_name Defines the name of the NE set for which detailed information will be displayed.

(Dub)>show(Dub)show>site(Dub)show site>network-elements-setsNetwork Element Set Category------------------------------------------------------------------------------TenantPowerMeter PowerMeterCategory(Dub)show site>

Column Description

Network Element Set Displays the name of each NE set.

Category Displays the category for each NE set. The category is defined within a module and designates the NE category for all NEs (instances) in the set. It also determines which NE types can be used when configuring NEs (instances) to be included in a set.

WESTELL.COM

1-800-377-8766

Page 3-173


This example displays detailed information for NE set TenantPowerMeter.

(Dub)>show(Dub)show>site(Dub)show site>network-elements-sets TenantPowerMeterName - TenantPowerMeterDescription - NE Set for TenantPowerMeterCategory - PowerMeterCategoryMax Elements - 3Name Restriction - (.*Power)

Instances------------------------------------------------------------------------------Name - KentroxPowerDescription - This is KentroxPower.Display Name - KentroxPowerActivity State - Active

(Dub)show site>


Name Displays the name of the specified NE set.

Description Displays the description for the specified NE set.

Category Displays the category for the specified NE set. The category is defined within a module and designates the NE category for all NEs (instances) in the set. It also determines which NE types can be used when configuring NEs (instances) to be included in a set.

Max. Elements Displays the maximum number of NEs that can be included in the specified NE set. The maximum number of NEs is defined within a module.

Name Restriction Displays the name restriction for the specified NE set. The name restriction is defined within a module and designates the format of user-defined names for each NE (instance) in a set. For example, an NE set for power meters might enforce a format where the name can begin with any characters but always end with Power (i.e., KentroxPower).

Name Displays the name of each NE (instance) in the specified NE set.

Description Displays the description for each NE (instance) in the specified NE set.

WESTELL.COM

Page 3-174

1-800-377-8766


See Alsoconfig site network-element-set

Display Name Displays the display name for each NE (instance) in a set. This name is used within the Optima application.

Activity State Displays one of the following for each NE (instance): Active indicates the NE (instance) is ready to be

configured. Inactive indicates the NE (instance) is not ready to be

configured.


WESTELL.COM

1-800-377-8766

Page 3-175

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show site params

show site params

DescriptionThis command shows the module parameters at a site. A module parameter is a configuration value that is used to customize a module.

Formatshow site params


Example

See Alsoconfig site param

(Dub)>show site paramsName - averageFuelConsumptionValue - 2Type - floating-pointDescription - Average fuel consumption of the generator

Name - defaultCriticallyHighTemperatureValue - 105Type - floating-pointDescription - Critically High Temperature Alarming Point

Name - defaultCriticallyLowTemperatureValue - 32Type - floating-pointDescription - Critically Low Temperature Alarming Point

(Dub)>


Description Displays the text description of the parameter.

Name Displays the name of the parameter.

Type Displays the parameter type. The valid values for the enumeration type are displayed in the command line hints for the parameter configuration commands.

Value Displays the value of the parameter.

WESTELL.COM

Page 3-176

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show snmp

show snmp

DescriptionThis command displays currently configured SNMP settings. SNMP community strings provide embedded password access to MIB contents.

Formatsshow snmp

communitieshostssummary

Parameters


ExamplesThis example displays the currently configured community strings in alphabetical order.

communities Displays currently configured SNMP community strings. SNMP community strings provide embedded password access to MIB contents.

hosts Displays the current management stations in the trap table. Management stations are used to oversee network activity generated by SNMP agents, which are hardware and/or software processes that report on each network device. The trap table is a list of all available management stations.

summary Displays a summary of the SNMP agent configuration. SNMP agents are hardware and/or software processes that report activity for each network device.

WESTELL.COM

1-800-377-8766

Page 3-177


This example displays the current management stations in the trap table.

(Dub)>show(Dub)>show snmp(Dub) show snmp>communitiesName User Type Auth Modeadministrator v1 noauth readwritepublic v1 noauth readonlyv3comm v3user v3 priv readwrite

v3 Users:Username Auth Privv3user md5 aes-128(Dub) show snmp>

Column Description

Auth Displays the type of authentication and encryption. Possible types are: noauth, no packet authentication or encryption auth, packet authentication but no encryption priv, packet authentication and encryptionFor v3 users: md5, privacy (encryption) protocol sha, privacy (encryption) protocol

Mode Displays the community string modes. Possible modes are: readonly, which permits read only access to all objects in the MIB readwrite, which permits read and write access to all objects in the

MIB.

Name Displays the community string names.

Type Displays the community string types. Possible types are v1 (which specifies SNMP version 1), v2 (which specifies SNMP version 2c) and v3 (which specifies SNMP version 3).

User Displays the SNMP v3 user name.

(Dub)>show(Dub)show>snmp(Dub) show snmp>hostsIP Address Port Type Auth Community/User Queue192.168.7.2 162 v1 noauth administrator sending(Dub)show snmp>

WESTELL.COM

Page 3-178

1-800-377-8766


This example displays a summary of the SNMP agent configuration.

(Dub)>show(Dub)show>snmp(Dub)show snmp>summaryAuthentication traps: enabledTrap queue: disabledCommunities: Name User Type Auth Mode administrator v1 noauth readwrite public v1 noauth readonly v3comm v3user v3 priv readwriteV3 Users: Username Auth Priv v3user md5 aes-128Hosts: IP Address Port Type Auth Community/User Queue 192.168.7.2 162 v1 noauth administrator sendingPriority: Trap OID Priority .1.3.6.1.6.4.1.2.4.1 low(Dub)show snmp>

Column Description

Auth Displays the type of authentication and encryption. Possible types are: noauth, no packet authentication or encryption auth, packet authentication but no encryption priv, packet authentication and encryptionFor v3 users: md5, privacy (encryption) protocol sha, privacy (encryption) protocol

Authentication traps

Displays the status of authentication failure trap transmission from the SNMP agent.

Community/User Displays the community string that represents the management station.

IP Address Displays the IP address for the management station.

Mode Displays the community string modes. Possible modes are: readonly, which permits read only access to all objects in

the MIB readwrite, which permits read and write access to all

objects in the MIB.

Name Displays the community string names.

WESTELL.COM

1-800-377-8766

Page 3-179


See Alsoconfig snmp

Port Displays the port number for the management station.

Priority Displays the priority level that is assigned to traps that match the specified Trap OID value.

Priv Displays the privacy (encryption) protocol. Possible protocols are: aes-128, which indicates AES-128 as the privacy

(encryption) protocol des, which indicates DES as the privacy (encryption)

protocol.

Trap OID Displays the OID (Object Identifier) value that is matched against the OID of an incoming trap.

Queue Displays the status of trap queuing for the management station. Possible values are: sending, which indicates that all traps are immediately

sent to the host queuing, which indicates that trap queuing is enabled

and traps are being saved in a queue.

Type Displays the version of community strip type of SNMP traps sent to the management station. Possible types are: v1, which specifies SNMP version 1 v2, which specifies SNMP version 2c v2-inform, which specifies that an SNMP version 2

inform request is sent to a management station v3-inform, which specifies that an SNMP version 3

inform request is sent to a management station v3, which specifies SNMP version 3.

User Displays the community user type.

Username Displays the user name of v3 users.


WESTELL.COM

Page 3-180

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show tbos

show tbos

DescriptionThese commands display a TBOS serial port configuration or a TBOS server configuration.

Formatsshow tbos

port serial { port | unit/port } [ display display ] [ point point ]

servertypes

Parameters


port serial

Specifies a TBOS serial port for display. The following parameters are accepted: unit—Selects a peripheral expansion unit to display. Valid

values are 1 to 12. port—Selects a TBOS serial port to display. Valid values are 1

to 6 for Remote RMX-3200. Other values may be available for expansion peripheral units

display—Specifies a TBOS display. display—Selects a TBOS display to display. Valid values are 1

to 8. point—Specifies a TBOS point. point—Selects a TBOS point to display. Valid values are 1 to

64.

server Displays configuration information for the server that stores TBOS definition files.

types Displays a list of TBOS equipment types.The TBOS configuration file must be loaded before the list of TBOS equipment types can be displayed. See command config tbos load on page 2-263 for more information.

WESTELL.COM

1-800-377-8766

Page 3-181


ExamplesThis example displays the configuration information for TBOS port serial 2.

This example displays the configuration information for display 4 on TBOS port serial 2.

(Dub)>show(Dub)show>tbos(Dub)show tbos>port serial 2

State: enabledDescription: Microwave radio control

Cut-Through:IP Port: 60000State: enabled

Display Poll State Points Description------------------------------------------------------------------ 1 disabled none Microwave radio 1 2 disabled all Microwave radio 2 3 enabled all Microwave radio 3 4 enabled Alcatel_MDR4000E Microwave radio 4 5 disabled DM-TERM-DISP_#1 Microwave radio 5 6 enabled DM-TERM-DISP_#2 Microwave radio 6 7 disabled none Microwave radio 7 8 enabled CE6C-DISP_#2 Microwave radio 8

(Dub)show tbos>

(Dub)>show(Dub)show>tbos(Dub)show tbos>port serial 2 display 4

State: enabledTimeout Alarm: 11disabledDescription: Microwave radio 4TLINE:Substitutional Key:Substitutional Value:Substitutional Key:Substitutional Value:Category TBOS-pointsNE Name Alcatel-MDR4000E

Point Poll State Severity Alarm Message------------------------------------------------------------------ 1 enabled critical Link Down 2 disabled major Volume failure 3 enabled minor Temp high 4 disabled 5 disabled--More--

WESTELL.COM

Page 3-182

1-800-377-8766


This example displays the configuration information for point 3 in display 4 on TBOS port serial 2.

This example displays the initial portion of the configuration information for display 5 on TBOS port serial 3 with the timeout-alarm enabled:

(Dub)>show(Dub)show>tbos(Dub)show tbos>port serial 2 display 4 point 3

Number: 3Name : tbos_2_4 3Poll State: enabledSeverity : minorAlarm Message: Temp highNormal Message: tbos_2_4 3 NormalDescription :

(RMX105) show tbos>(RMX105) show tbos>port serial 3 display 5

State: enabledTimeout Alarm: enabledDescription: tbos port serial 3 display 5TL1NE:Substitution1 Key:Substitution1 Value:Substitution2 Key:Substitution2 Value:Category:NE Name:


Category Displays the configured category of the TBOS display.

Cut-Through Displays the configured cut-through settings. Cut-through support allows users to connect directly to a TBOS serial port and issue TBOS commands directly to TBOS network elements.

Description Displays the configured description for a TBOS serial port, a TBOS display, or a TBOS point.

Display Lists all TBOS display numbers (1 to 8).

IP Port (for cut-through)

Displays the TCP port number for cut-through support.

Name Displays the name of a specified TBOS point.

WESTELL.COM

1-800-377-8766

Page 3-183


This example displays the configuration information for the TBOS definition file server.


config tbos server

NE-name Displays the configured network element name for the TBOS display.

Normal Message Displays the message associated with a point in its normal state.

Number Defines the number of the TBOS point being displayed.

Points Lists the equipment type points that are polled within a specific display. The following values may appear: All specifies that all points are polled. None specifies that no equipment type has been

applied, but individual points can still be configured. Any other value specifies an equipment type from

the TBOS definition file. The equipment type defines the points that will be polled. Refer to command config tbos port serial display on page 2-268 for more information.

Poll State Displays the TBOS polling status as enabled or disabled.

State Displays the state of a TBOS serial port, a TBOS display, or cut-through mode as enabled or disabled.

Timeout Alarm Displays the state of a TBOS serial port display timeout-alarm as enabled or disabled.

(Dub)>show(Dub)show>tbos(Dub) show tbos>serverIP Address: 192.168.5.1IP Port: 33Directory: /tmp/tbosUser: test

(Dub)show tbos>


WESTELL.COM

Page 3-184

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show test alarm-entries

show test alarm-entries

DescriptionThis command displays the alarm entries that are currently being simulated (in test mode).

Note: Alarm entries also can be simulated from the Alarms page in the Remote

RMX-3200 Web interface.

Formatsshow test alarm-entries [ nopage ]


Parameters

ExamplesThis example displays an alarm entry currently being simulated in test mode.

nopage Displays the entire list of alarm entries upon execution of the command. When this parameter is not specified, Remote RMX-3200 outputs the list of alarm entries one page at a time.

(Dub)>show(Dub)show>test(Kentrox)>show test alarm-entriesName State Remaining Current alarm message----------------------------------------------------------------------door__Open normal 9 min. Door Closed

(Dub)show test

Column Description

Current alarm message

Displays the current alarm message for the simulation.

Name Displays the name of the alarm entry being simulated.

Remaining Displays the remaining time for the alarm simulation.

WESTELL.COM

1-800-377-8766

Page 3-185

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show test alarm-entries

See Also diag test alarm-entry

diag test mode

State Displays the simulation mode. The following values may appear: normal specifies simulation mode for first normal state. non-normal specifies simulation mode for first non-normal

state


WESTELL.COM

Page 3-186

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show test mode

show test mode

DescriptionThis command displays whether the alarm table testing mode is enabled or disabled. If testing mode is enabled, this command also displays how much longer testing mode will remain enabled.

Formatsshow test mode


ExamplesThis example displays the current test mode as Disabled.

This example displays the current test mode as Enabled and that test mode will remain enabled for 290 seconds before reverting to Disabled.

See Also diag test mode

diag test alarm-entry

(Dub)>show test modeTest Mode: Disabled(Dub)>

(Dub)>show test modeTest Mode: EnabledTest Duration: 290 second(s)(Dub)>

WESTELL.COM

1-800-377-8766

Page 3-187

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show timeout

show timeout

DescriptionThis command displays the amount of time that can elapse before a Remote RMX-3200 session expires due to inactivity.

Formatsshow timeout


ExamplesThis example displays the current timeout configuration, which is set to 60 minutes.

This example displays the current timeout configuration, which is set to never time out.

See Also config timeout

(Dub)>show(Dub)show>timeoutThe session timeout is set to 60 minutes.(Dub)show>

(Dub)>show(Dub)show>timeoutThe session timeout is set to never time out.(Dub)show>

WESTELL.COM

Page 3-188

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show timers

show timers

DescriptionThis command displays information for all currently running Remote RMX-3200 mediation timers.

Formatsshow timers


ExamplesThis example displays the name, duration and life-cycle for all running mediation timers.

See Alsoconfig event content


debug mediation

(Dub)>show(Dub)show>timers

Timer Name: contUp Duration: 500 Life cycle: one-shot

Timer Name: downTime Duration: 300 Life cycle: one-shot(Dub)show>

WESTELL.COM

1-800-377-8766

Page 3-189

Remote RMX-3200 Version 5.4x Command Reference GuideShow Commands: show users

show users

DescriptionThis command displays the locally configured Remote RMX-3200 users with their corresponding profiles.

Formatsshow users


ExamplesThis example displays the Remote RMX-3200 users with their corresponding profiles.

Note: For descriptions of the profile types, refer to command config users on page 2-

282.

(Dub)>show usersStrong Password Support: enabled Login Name Profile 1. techcomm management 2. test supervisor 3. jeff status 4. ebh restricted(Dub)>

WESTELL.COM

Page 3-190

1-800-377-8766

CHA

PTER 4

Diagnostic Commands

This chapter describes all of the Remote RMX-3200 diagnostic (diag) commands. The diag commands are listed in alphabetical order and each command is described in detail.


Diag Command Overview

List of Diag Commands

Page 4-1

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: Diag Command Overview

Diag Command OverviewDiagnostic commands display system-wide diagnostics, including information about logged in users, running processes, controllers and peripherals.

To use diagnostic commands, enter command diag from the CLI.

WESTELL.COM

Page 4-2

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: List of Diag Commands

List of Diag CommandsThe following is a list of all of the diag commands from the CLI. The (+) sign after a command indicates that it has multiple arguments.

(Dub)>diag [? does not display in CLI]Commandsbreak Terminates a shell connection. clear(+) Clears statistical counters. controller(+) Displays diagnostic information for a controller. fan(+) Provides internal fan diagnostics. ip(+) Displays diagnostic IP information. line-monitor Provides low-level monitoring of asynchronous serial ports. line-status Provides control signal status of asynchronous serial ports. mediation(+) Provides diagnostic mediation commands. mmdisplay Displays mediation messages. output Controls a relay output. peripheral(+) Provides diagnostic commands for peripherals. ps Displays process status. snapshot Captures current system diagnostics for analysis. tcpdump Displays the headers of packets received on an interface. test(+) Provides access to diagnostic testing commands. top Displays top CPU processes (the most CPU intensive tasks). usb Displays devices on the USB bus. who Displays users currently logged in. whoami Displays login name of current user.

(Dub)>diag

WESTELL.COM

1-800-377-8766

Page 4-3

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag break

diag break

DescriptionThis command terminates a Remote RMX-3200 shell connection. Remote RMX-3200 shell connections are terminated using the terminal name for a connection.

Formatsdiag break tty

Parameters


ExamplesThis example displays the termination of a shell connection with terminal name ttyp1.

See Alsodiag who

tty Defines the terminal name for the shell connection being terminated. Terminal names appear in the second column of the output for command diag who.

(Dub)>diag(Dub) diag>break ttyp1(Dub) diag>

WESTELL.COM

Page 4-4

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag clear

diag clear

DescriptionThese commands reset alarm settings to their default values, clear IP table rule and interface counters and RAS counters.

Formatsdiag clear

alarm-entry { alarm | * }countersras

Parameters


alarm-entry

Resets an alarm state to normal and clears the associated alarm message for a specified alarm entry or for all alarm entries. These alarm entries appear in the output for command show alarm-entries on page 3-8. The following parameters are accepted: alarm—Defines the name of an alarm entry for configuration in

the central alarm table. Valid values are alphanumeric characters and underscores (_).


*—Clears the severity level and alarm message for all alarm entries.

counters Clears IP table rule and interface counters. These counters appear in the output for commands show interfaces on page 3-78 and show iptables on page 3-97.

ras Clears RAS authentication, authorization and fallback counters. These counters appear in the output for command show ras on page 3-145.

WESTELL.COM

1-800-377-8766

Page 4-5

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag clear

ExamplesThis example displays:

The clearing of alarm entry tbos_6_1_36 The clearing of IP table rule and interface counters

See Alsoconfig alarm-entry

show alarm-entries

show interfaces

show ras

(Dub)>diag(Dub) diag>clear(Dub) diag clear>alarm-entry tbos_6_1_36(Dub) diag clear>counters(Dub) diag clear>

WESTELL.COM

Page 4-6

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag controller bridge switch dhcp


DescriptionThis command manually releases or renews the current DHCP lease.

Formatsdiag controller bridge switch dhcp

releaserenew

Parameters


ExamplesThis example displays releasing the current DHCP lease.


release Releases the current DHCP lease and attempts to acquire a new DHCP lease. Because the lease is released immediately, the IP address will be removed, possibly interrupting remote access to the Remote RMX-3200 device. The device may acquire a new IP address from the DHCP server.

renew Renews the current DHCP lease. If the lease can be renewed without any changes, remote access to the Remote RMX-3200 device will not be interrupted.

(Dublin-TC)>diag(Dublin-TC) diag>controller bridge switch

(Dublin-TC) diag controller bridge switch>dhcp(Dublin-TC) diag controller bridge switch dhcp->release(Dublin-TC) diag controller bridge switch dhcp->

WESTELL.COM

1-800-377-8766

Page 4-7

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag controller openvpn

diag controller openvpn

DescriptionThis command provides a diagnostic interface to an OpenVPN controller. It connects the user to a management interface on the running OpenVPN instance. Only one diagnostic session at a time can be connected.

Formatsdiag controller openvpn name [ management ]

Parameters


name Defines the name of the OpenVPN controller.

management Connects the user to a management interface on the running OpenVPN instance.

WESTELL.COM

Page 4-8

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag controller openvpn

ExamplesThis example displays a diagnostic connection made to OpenVPN controller cmh1.

See Alsoconfig controller openvpn


(Dub)>diag controller openvpn cmh1 management>INFO:OpenVPN Management Interface Version 1 -- type 'help' for more infohelpManagement Interface for OpenVPN 2.0.6 i686-pc-linux [SSL] [LZO] [EPOLL] built on Sep 26 2006Commands:auth-retry t : Auth failure retry mode (none,interact,nointeract).echo [on|off] [N|all] : Like log, but only show messages in echo buffer.exit|quit : Close management session.help : Print this message.hold [on|off|release] : Set/show hold flag to on/off state, or release current hold and start tunnel.kill cn : Kill the client instance(s) having common name cn.kill IP:port : Kill the client instance connecting from IP:port.log [on|off] [N|all] : Turn on/off realtime log display + show last N lines or 'all' for entire history.mute [n] : Set log mute level to n, or show level if n is absent.net : (Windows only) Show network info and routing table.password type p : Enter password p for a queried OpenVPN password.signal s : Send signal s to daemon, s = SIGHUP|SIGTERM|SIGUSR1|SIGUSR2.state [on|off] [N|all] : Like log, but show state history.status [n] : Show current daemon status info using format #n.test n : Produce n lines of output for testing/debugging.username type u : Enter username u for a queried OpenVPN username.verb [n] : Set log verbosity level to n, or show if n is absent.version : Show current version number.ENDquit(Dub)>

WESTELL.COM

1-800-377-8766

Page 4-9

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag controller serial

diag controller serial

DescriptionThis command configures the diagnostic settings or clears the counters for a serial WAN link.

Formatsdiag controller serial port

bert { 0 | 1 | qr }clear-countersno bert

Parameters

bert Starts or stops a bit error rate test (BERT) on a serial WAN link. A BERT transmits a pattern on a WAN link and compares the received signal to the transmitted signal.

Notes: Before executing this command, the far-end device is

typically put into loopback mode using parameter loopback or using administrative commands on the far-end device.

This test disrupts normal WAN link operation.

Results are reported when the test is stopped. The following parameters are accepted: 0—Specifies the all-zeros test pattern, which transmits a

signal consisting of all zeros. 1—Specifies the all-ones test pattern, which transmits a

signal consisting of all ones. qr—Specifies the quasi-random test pattern. This pattern

consists of a bit sequence that approximates a random signal by creating artificial constraints on the maximum number of zeros in the sequence.

clear-counters

Clears the error and statistical counters for a serial WAN port. Refer to command show controllers on page 3-24 for information about these counters.

no Stops the BERT.

WESTELL.COM

Page 4-10

1-800-377-8766



ExamplesThis example displays the start-up of a quasi-random BERT.

This example displays the termination of a quasi-random BERT.

This example displays the clearing of error and statistical counters for WAN controller serial wan/1.

This example enables line loopback mode on controller serial wan/1.

See Also

port Defines the physical connector associated with a controller on Remote RMX-3200. Valid values are WAN ports. For information about valid WAN port values, see WAN Port Availability.

(Dub)>diag(Dub) diag>controller serial wan/1(Dub) diag controller serial wan/1>bert qr(Dub) diag controller serial wan/1>

(Dub)>diag(Dub) diag>controller serial wan/1(Dub) diag controller serial wan/1>no bertserial wan/1 BERT results: Errors/Bits=0/30136294 Received all zeros during test.(Dub) diag controller serial wan/1>


Errors/Bits Displays the number of errors and number of bits that were received during the BERT.

(Dub)>diag(Dub) diag>controller serial wan/1(Dub) diag controller serial wan/1>clear-counters(Dub) diag controller serial wan/1>

(Dub)>diag(Dub) diag>controller serial wan/1(Dub) diag controller serial wan/1>loopback local line(Dub) diag controller serial wan/1>

WESTELL.COM

1-800-377-8766

Page 4-11


diag controller serial loopback

WESTELL.COM

Page 4-12

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag controller serial wan/1

diag controller serial wan/1

DescriptionProvisions the wireless phone module/modem.

Formats

For use with HSPA or EVDO modems:diag controller serial wan/1

activate { vzw | sprint-config | sprint-factory-reset { msl } | sprint-firmware | sprint-prl }

namval dir min sid nidsim-pin { enable | disable | change-pin | unlock-sim }

For use with LTE modems:diag controller serial wan/1

select-carrier { carrier }sim-pin { enable | disable | change-pin | unlock-sim }

Parametersactivate Valid for EVDO phone modules only. Performs over-the-air activation

of a modem. The following commands are valid: sprint-config—Activates the modem on the Sprint network. sprint-factory-reset—Resets the modem on the Sprint

network to factory defaults. Requires a MSL (Master Subsidy Lock) number. msl—Master subsidy lock code for the operation.

sprint-firmware—Updates the modem’s firmware. sprint-prl—Updates the PRL on the modem. vzw—Activates the modem on the Verizon Wireless network. If the

modem is already activated, this parameter updates the PRL.

Note: Make sure that the serial controller is disabled before running

this command. For more information, see the config controller serial command.

WESTELL.COM

1-800-377-8766

Page 4-13



ExamplesThis example provisions the modem phone numbers, system ID and network ID.


namval Valid for EVDO phone modules only. Provisions the modem using the following parameters: dir—Directory Number. Must be a 10 digit number. min—Mobile ID Number. Must be a 10 digit number. sid—System ID. Number range is from 0 - 32767. nid—Network lD. Number range is from 0 - 65535.

Note: Make sure that the serial controller is disabled before running

this command. For more information, see the config controller serial command.

select-carriercarrier

Valid for LTE phone modules only. Provisions the modem using a parameter contained in the modem firmware (frequently the carrier name).

sim-pin Allows user to lock the SIM until a valid PIN unlocks it.Important: The SIM is either PIN- or PUK-locked/unlocked, and

comes with a default PIN and PUK set by the phone carrier. Users must obtain these codes from their carriers.

The following commands are valid: enable -- Enables the PIN locking feature of the SIM card. disable -- Disables the locking feature of the SIM card. change-pin -- Allows user to change from old to new PIN. unlock-sim -- Unlocks a SIM card using the PUK; user is

prompted for the PUK and the new PIN. New PIN is set on the SIM.

Important: When incorrect PINs are entered three or more times, the PUK will be required to unlock the SIM. When incorrect PUKs are entered 10 times, the SIM is deactivated.

(Dub)>diag(Dub) diag>controller serial wan/1(Dub) diag controller serial wan/1 namval 6145557890 6145557891 0 12345

WESTELL.COM

Page 4-14

1-800-377-8766



WESTELL.COM

1-800-377-8766

Page 4-15

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag controller serial loopback

diag controller serial loopback

DescriptionControls loopback mode on a Remote RMX-3200 serial controller or on a device connected to a Remote RMX-3200 serial controller (a remote device).

Note: Loopback mode interrupts the normal operation of a controller.

Formatsdiag controller serial port loopback

local { line | payload }remote { line | payload }

For deleting loopback mode:diag controller serial port no loopback

local [ line | payload ]remote [ line | payload ]

Parameters

local Enables or disables loopback mode on the Remote RMX-3200 controller. The following parameters are accepted: line—Enables or disables line loopback mode on the controller.

When enabled, the controller returns the received signal to the sender without modification. A sender testing the line receives a bit-for-bit reproduction of the signal, including any intentionally inserted framing errors.

payload—Enables or disables payload loopback mode on the controller. When enabled, the controller returns the received signal to the sender after regenerating the framing information. A sender testing the line receives a signal free of framing errors even if the sender intentionally inserted framing errors into the signal.

no Stops the BERT.

port Defines the physical connector associated with a controller on Remote RMX-3200. Valid values are WAN ports. For information about valid WAN port values, refer to section WAN Port Availability.

WESTELL.COM

Page 4-16

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag controller serial loopback


ExamplesThis example enables line loopback mode on controller serial wan/1.

See Alsodiag controller serial wan/1

remote Enables or disables loopback mode on the device connected to the Remote RMX-3200 controller (the remote device).

Note: E1 controllers do not support loopback mode on remote devices.

The following parameters are accepted: line—Enables or disables line loopback mode on the controller.

When enabled, the controller returns the received signal to the sender without modification. A sender testing the line receives a bit-for-bit reproduction of the signal, including any intentionally inserted framing errors.

payload—Enables or disables payload loopback mode on the controller. When enabled, the controller returns the received signal to the sender after regenerating the framing information. A sender testing the line receives a signal free of framing errors even if the sender intentionally inserted framing errors into the signal.

(Dub)>diag(Dub) diag>controller serial wan/1(Dub) diag controller serial wan/1>loopback local line(Dub) diag controller serial wan/1>

WESTELL.COM

1-800-377-8766

Page 4-17

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag fan

diag fan

DescriptionThis command manually starts or stops the Remote RMX-3200 cooling fan for a pre-specified time interval. This functionality allows a technician to verify that the fan is operational, or to change a fan filter while the fans are not running. When the time interval expires, the fan returns to normal operation.

Formatsdiag fan

suppresstest

Parameters


ExamplesThis example displays the suppression of the Remote RMX-3200 fan for a ten-minute interval.

See Alsoshow fan

suppress Stops the cooling fan for a ten-minute interval.

test Runs the cooling fan for a one-minute interval.

(Dub)>diag(Dub) diag>fan suppress(Dub) diag>

WESTELL.COM

Page 4-18

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag ip address show

diag ip address show

DescriptionThese commands display diagnostic IP address information for Remote RMX-3200. Remote RMX-3200 displays information for all known IP addresses that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMX-3200 displays information for all known IP addresses.

Formatsdiag ip address show

[ deprecated ][ dev interface_name ][ dynamic ][ label pattern ][ permanent ] [ primary ][ scope { global | host | link } ] [ secondary ][ tentative ][ to prefix ]

Parameters

deprecated Displays deprecated IP addresses. Deprecated IP addresses are valid, but cannot be used by newly created connections.

dev Initiates the display of IP addresses for a specified Remote RMX-3200 interface. The following parameter is accepted:

interface_name—Defines the system name for the interface being displayed. Some examples include lo, eth0, mii0, mii1, br_switch, hdlc0, hdlc1 and ppp_wan_1.

dynamic Displays dynamic IP addresses.

label Initiates the display of IP addresses with labels that have a specified pattern. The following parameter is accepted:

pattern—Defines the pattern of IP addresses being displayed.

permanent Displays permanent IP addresses.

primary Displays primary IP addresses.

WESTELL.COM

1-800-377-8766

Page 4-19



scope Initiates the display of IP addresses that have a specified scope. The following parameters are accepted: global—IP address is valid globally. host—IP address is valid only on the local host. link—IP address is valid only on Remote RMX-3200.

secondary Displays secondary IP addresses.

tentative Displays tentative IP addresses. Tentative IP addresses are not used because duplicate address detection has still not been completed or has failed.

to Initiates the display of IP addresses with a specified destination prefix. The following parameter is accepted:

prefix—Defines the destination prefix of IP addresses being displayed. An IP address prefix is the first part of an IP address with a subnet mask length (for example, 10.40/16).

WESTELL.COM

Page 4-20

1-800-377-8766


ExamplesThis example displays diagnostic information for all known Remote RMX-3200 IP addresses.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>address(Dub) diag ip address->show1: lo: <LOOPBACK,UP> mtu 16436 qdisc noqueue link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 inet 127.0.0.1/8 scope host lo2: eth0: <BROADCAST,MULTICAST,ALLMULTI,PROMISC,SLAVE,UP> mtu 1514 qdisc pfifo_fast qlen 100 link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff3: eth1: <BROADCAST,MULTICAST> mtu 1500 qdisc noop qlen 100 link/ether 00:40:72:0e:65:e5 brd ff:ff:ff:ff:ff:ff4: mii0: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e5 brd ff:ff:ff:ff:ff:ff5: mii1: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e6 brd ff:ff:ff:ff:ff:ff6: mii2: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e7 brd ff:ff:ff:ff:ff:ff7: mii3: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e8 brd ff:ff:ff:ff:ff:ff8: mii4: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e9 brd ff:ff:ff:ff:ff:ff9: mii5: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:ea brd ff:ff:ff:ff:ff:ff10: mii6: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:eb brd ff:ff:ff:ff:ff:ff11: mii7: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:ec brd ff:ff:ff:ff:ff:ff12: mii8: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff13: mii9: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:ed brd ff:ff:ff:ff:ff:ff14: mii10: <BROADCAST,MULTICAST,PROMISC,MASTER,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff15: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff inet 10.39.80.13/16 brd 10.39.255.255 scope global br_switch16: hdlc0: <POINTOPOINT,NOARP> mtu 1500 qdisc noop link/[513]17: hdlc1: <POINTOPOINT,NOARP> mtu 1500 qdisc noop link/[513](Dub) diag ip address->


Sequential number Displays a sequential number for the Remote RMX-3200 interface associated with each IP address.

WESTELL.COM

1-800-377-8766

Page 4-21


System name Displays the system name for the Remote RMX-3200 interface associated with each IP address.

Flags < > Displays information for the interface associated with each IP address. One or more of the following can appear: UP—The interface is turned on and ready to accept

packets for transmission onto the network. The interface may receive packets from other nodes on the network.

LOOPBACK—The interface does not communicate with other hosts. All packets are sent to the loopback IP address for Remote RMX-3200.

BROADCAST—The interface has the ability to send packets to all other hosts that share the same physical link.

POINTOPOINT—The interface has only two ends with two nodes attached. All packets sent to the link will reach the peer interface and all received packets are originated by the peer.

MULTICAST—The interface can multicast. PROMISC—The interface listens and feeds all the traffic on

the link to the kernel. ALLMULTI—The interface receives all mulitcast packets. NOARP—The interface does not need any address

resolution. Packets can be delivered without any help from the protocol stacks.

DYNAMIC—The interface was dynamically created. SLAVE—The interface is bonded to other interfaces in

order to share link capacities.

mtu Displays the maximum transmission unit for the interface associated with each IP address. The maximum transmission unit is the largest packet that the interface can support.

qdisc Displays the queuing algorithm for the interface associated with each IP address. One of the following appears: noop—The interface is in “black hole” mode. All packets

sent to the interface are discarded. noqueue—The interface queues nothing. pfifo_fast—The interface queues packets using any of

the three available bands based on the packet’s TOS bits or assigned priority.


WESTELL.COM

Page 4-22

1-800-377-8766


This example displays diagnostic information for primary IP addresses associated with interface bridge switch (br_switch).

See Alsodiag ip link show

diag ip neighbor show

diag ip route get

diag ip route and route-v6 show

qlen Displays the default transmit queue length (measured in packets) for the interface associated with each IP address. Interfaces that do not queue packets (qdisc set to noop or noqueue) do not have a default transmit queue length.

link/ Displays information about the link layer addresses for the interface associated with each IP address. The link type and hardware address for the interface is also displayed, if appropriate.

inet Displays version 4 IP addresses accompanied by additional attributes, such as scope value, flags (dynamic, tentative deprecated, secondary) and address label.

Note: The internal interface (such as mii0, mii1 and so

forth) do not have IP addresses.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>address(Dub) diag ip address->show dev br_switch primary15: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff inet 10.39.80.13/16 brd 10.39.255.255 scope global br_switch(Dub) diag ip address->


WESTELL.COM

1-800-377-8766

Page 4-23

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag ip link show

diag ip link show

DescriptionThese commands display diagnostic link information for Remote RMX-3200. Remote RMX-3200 displays information for all links that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMX-3200 displays information for all links.

Formatsdiag ip link show

[ dev interface_name ][ up ]

Parameters


dev Initiates the display of links for a specified Remote RMX-3200 interface. The following parameter is accepted:

interface_name—Defines the system name for the interface being displayed. Some examples include lo, eth0, eth1, mii0, mii1, br_switch, hdlc0, hdlc1 and ppp_wan_1.

up Displays information for links that are enabled and functioning.

WESTELL.COM

Page 4-24

1-800-377-8766


ExamplesThis example displays diagnostic information for all Remote RMX-3200 links.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>link(Dub) diag ip link->show1: lo: <LOOPBACK,UP> mtu 16436 qdisc noqueue link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:002: eth0: <BROADCAST,MULTICAST,ALLMULTI,PROMISC,SLAVE,UP> mtu 1514 qdisc pfifo_fast qlen 100 link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff3: eth1: <BROADCAST,MULTICAST> mtu 1500 qdisc noop qlen 100 link/ether 00:40:72:0e:65:e5 brd ff:ff:ff:ff:ff:ff4: mii0: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e5 brd ff:ff:ff:ff:ff:ff5: mii1: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e6 brd ff:ff:ff:ff:ff:ff6: mii2: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e7 brd ff:ff:ff:ff:ff:ff7: mii3: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e8 brd ff:ff:ff:ff:ff:ff8: mii4: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:e9 brd ff:ff:ff:ff:ff:ff9: mii5: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:ea brd ff:ff:ff:ff:ff:ff10: mii6: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:eb brd ff:ff:ff:ff:ff:ff11: mii7: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:ec brd ff:ff:ff:ff:ff:ff12: mii8: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff13: mii9: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:40:72:0e:65:ed brd ff:ff:ff:ff:ff:ff14: mii10: <BROADCAST,MULTICAST,PROMISC,MASTER,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff15: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff16: hdlc0: <POINTOPOINT,NOARP> mtu 1500 qdisc noop link/[513]17: hdlc1: <POINTOPOINT,NOARP> mtu 1500 qdisc noop link/[513](Dub) diag ip link->


Sequential number Displays a sequential number for the Remote RMX-3200 interface associated with each link.

System name Displays the system name for the Remote RMX-3200 interface associated with each link.

WESTELL.COM

1-800-377-8766

Page 4-25


Flags < > Displays information for the interface associated with each link. One or more of the following can appear: UP—The interface is turned on and ready to accept

packets for transmission onto the network. The interface may receive packets from other nodes on the network.

LOOPBACK—The interface does not communicate with other hosts. All packets are sent to the loopback IP address for Remote RMX-3200.

BROADCAST—The interface has the ability to send packets to all other hosts that share the same physical link.

POINTOPOINT—The interface has only two ends with two nodes attached. All packets sent to the link will reach the peer interface and all received packets are originated by the peer.

MULTICAST—The interface can multicast. PROMISC—The interface listens and feeds all the traffic on

the link to the kernel. ALLMULTI—The interface receives all mulitcast packets. NOARP—The interface does not need any address

resolution. Packets can be delivered without any help from the protocol stacks.

DYNAMIC—The interface was dynamically created. SLAVE—The interface is bonded to other interfaces in

order to share link capacities.

mtu Displays the maximum transmission unit for the interface associated with each link. The maximum transmission unit is the largest packet that the interface can support.

qdisc Displays the queuing algorithm for the interface associated with each link. One of the following appears: noop—The interface is in “black hole” mode. All packets

sent to the interface are discarded. noqueue—The interface queues nothing. pfifo_fast—The interface queues packets using any of

the three available bands based on the packet’s TOS bits or assigned priority.

qlen Displays the default transmit queue length (measured in packets) for the interface associated with each link. Interfaces that do not queue packets (qdisc set to noop or noqueue) do not have a default transmit queue length.


WESTELL.COM

Page 4-26

1-800-377-8766


This example displays diagnostic information for enabled and functioning links associated with interface bridge switch (br_switch).

See Alsodiag ip address show


diag ip route get


link/ Displays information about the link layer addresses for the interface associated with each link. The link type and hardware address for the interface is also displayed, if appropriate.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>link(Dub) diag ip link->show dev br_switch up15: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue link/ether 00:40:72:0e:65:e4 brd ff:ff:ff:ff:ff:ff(Dub) diag ip link->


WESTELL.COM

1-800-377-8766

Page 4-27

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag ip neighbor show


DescriptionThese commands display diagnostic neighbor information for Remote RMX-3200. Remote RMX-3200 displays information for all neighbors that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMX-3200 displays information for all neighbors.

Formatsdiag ip neighbor show

[ to prefix ][ dev interface_name ][ unused ][ nud { delay | failed | incomplete | noarp | none | permanent

| probe | reachable | stale } ]

Parameters

to Initiates the display of neighbors with a specified destination IP address prefix. The following parameter is accepted:

prefix—Defines the destination IP address prefix of neighbors being displayed. An IP address prefix is the first part of an IP address with a subnet mask length (for example, 10.40/16).

dev Initiates the display of neighbors attached to a specified Remote RMX-3200 interface. The following parameter is accepted:

interface_name—Defines the system name for the interface being displayed. Examples include br_switch.

unused Displays information for neighbors that are not currently in use.

nud Initiates the display of neighbors in a specified NUD state. The following parameters are accepted: delay—Packet has been sent to stale neighbor. failed—Resolution has failed. incomplete—Neighbor is in process of resolution. noarp—Neighbor is valid. none—State of neighbor is void. permanent—Neighbor is valid and can be removed only

administratively. probe—Delay timer expired, but no confirmation was received. reachable—Neighbor is valid and reachable. stale—Neighbor is valid, but probably already unreachable.

WESTELL.COM

Page 4-28

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag ip neighbor show


ExamplesThis example displays diagnostic information for all Remote RMX-3200 neighbors.

This example displays diagnostic information for neighbors with destination IP address prefix 10.40/16 and NUD state reachable.


diag ip link show

diag ip route get


(Dub)>diag(Dub) diag>ip(Dub) diag ip>neighbor(Dub) diag ip neighbor->show10.40.5.11 dev br_switch lladdr 00:06:5b:60:8a:40 nud reachable(Dub) diag ip neighbor->


Neighbor IP address Displays the IP address of each neighbor.

dev Displays the system name for the Remote RMX-3200 interface attached to each neighbor.

lladdr Displays the link layer address of each neighbor.

nud Displays the NUD state of each neighbor.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>neighbor(Dub) diag ip neighbor->show to 10.40/16 nud reachable

10.40.5.20 dev br_switch lladdr 00:01:02:ee:a8:30 nud reachable(Dub) diag ip neighbor->

WESTELL.COM

1-800-377-8766

Page 4-29

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag ip route get

diag ip route get

DescriptionThese commands find a route to a specified destination and then display diagnostic information for the route.

Formatsdiag ip route get destination_ip_address

[ connected ][ oif interface_name ][ tos tos ]

Parameters


connected Finds a route to a specified destination and then uses the route’s source IP address to find and display another route with the source IP address.

destination_ip_address Defines the destination IP address for the route being found and displayed.

oif Finds and displays a route that goes out from Remote RMX-3200 through a specified interface. The following parameter is accepted:

interface_name—Defines the system name for the interface being displayed. Examples include br_switch.

tos Finds and displays a route with a specified type of service value. The following parameter is accepted:

tos—Defines the type of service value for the route being found and displayed.

WESTELL.COM

Page 4-30

1-800-377-8766


ExamplesThis example displays diagnostic information for a route with destination IP address 128.5.99.2.

Note: Not all display items appear for each route.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>route(Dub) diag ip route->get 128.5.99.2128.5.99.2 via 10.40.0.1 dev br_switch src 10.40.57.5 cache mtu 1500 advmss 1460(Dub) diag ip route->


Destination IP address Displays the destination IP address for the route.

from Displays the source IP address for the route.

via Displays the gateway through which the route is reachable.

dev Displays the system name for the Remote RMX-3200 interface through which the route goes.

src Displays the source IP address for the route.

cache Displays route characteristics (for example, MTU).

mtu Displays the maximum transmission unit for the Remote RMX-3200 interface through which the route goes. The maximum transmission unit is the largest packet that the interface can support.

advmss Displays the largest TCP segment size that can be sent on the Remote RMX-3200 interface through which the route goes.

WESTELL.COM

1-800-377-8766

Page 4-31


This example displays diagnostic information for a route with destination IP address 128.25.45.2 that goes out from Remote RMX-3200 through interface bridge switch (br_switch).


diag ip link show



(Dub)>diag(Dub) diag>ip(Dub) diag ip>route(Dub) diag ip route->get 128.25.45.2 oif br_switch128.25.45.2 via 10.40.0.1 dev br_switch src 10.40.57.5 cache mtu 1500 advmss 1460(Dub) diag ip route->

WESTELL.COM

Page 4-32

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag ip route and route-v6 show


DescriptionThese commands display diagnostic route information for Remote RMX-3200. Remote RMX-3200 displays information for all routes in the IP routing table that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMX-3200 displays information for all routes in the IP routing table.

Note: This section contains information on how to display diagnostic information for

both the IPV4 and the IPV6 routes.

Formatsdiag ip route { route | route-v6 } show

[ dev interface_name ][ exact ip_address ][ from { prefix | root prefix | match prefix | exact ip_address

} ][ match prefix ][ protocol { boot | gated | kernel | ra | redirect } ][ root prefix ][ scope { global | host | link } ][ src prefix ][ table { all | cache | local | main | table_id } ][ to { prefix | root prefix | match prefix | exact ip_address }

][ tos tos ][ type { blackhole | broadcast | local | multicast | nat |

prohibit | throw | unicast | unreachable } ][ via prefix ]

Parameters

dev Initiates the display of routes going through a specified Remote RMX-3200 interface. The following parameter is accepted:

interface_name—Defines the system name for the interface being displayed. Some examples include lo, eth0, eth1, mii0, mii1, br_switch, hdlc0, hdlc1 and ppp_wan_1.

exact Displays a route with a specified IP address. The following parameter is accepted:

ip_address—Defines the IP address of routes being displayed.

WESTELL.COM

1-800-377-8766

Page 4-33


from Displays routes with specified source IP address parameters. The following parameters are accepted: exact—Displays routes with specified source IP addresses. ip_address—Defines the IP address of routes to be displayed. match—Displays routes with source IP address prefixes equal to

or shorter than a specified source IP address prefix. prefix—Defines the IP address prefix of routes to be displayed.

An IP address prefix is the first part of an IP address with a subnet mask length (for example, IPv4 10.40/16 and IPV6 fc10::39/48).

root—Displays routes with source IP address prefixes equal to or longer than a specified source IP address prefix.

match Displays routes with IP address prefixes equal to or shorter than a specified IP address prefix. The following parameter is accepted:

prefix—Defines the IP address prefix of routes to be displayed. An IP address prefix is the first part of an IP address with a subnet mask length (for example, IPv4 10.40/16 and IPV6 fc10::39/48).

protocol Displays routes associated with a specified routing protocol. The following parameters are accepted: boot—Route was received during the boot up sequence. gated—Route was entered using the CLI. kernel—Route was received as part of the route configuration

that occurs when Remote RMX-3200 is booted. ra—Route was received by the Router Discovery Protocol. The

default is boot. redirect—Route was received as the result of a redirect.

root Displays routes with IP address prefixes equal to or longer than a specified IP address prefix. The following parameter is accepted:


scope Displays routes that have a specified scope. The following parameters are accepted: global—Route is valid globally. host—Route is valid only on the local host. link—Route is valid only on Remote RMX-3200.

WESTELL.COM

Page 4-34

1-800-377-8766


src Initiates the display of routes with a preferred source IP address prefix. The following parameter is accepted:


table Displays routes in a specified IP routing table. The following parameters are accepted: all—Specifies all IP routing tables cache—Specifies the IP routing cache local—Specifies the local IP routing table main—Specifies the main IP routing table (IP routing table ID 254).

This is the default value. table_id—Defines any real IP routing table ID.

to Displays routes to destinations. The following parameters are accepted: exact—Displays routes with specified destination IP addresses. ip_address—Defines the IP address of routes to be displayed. match—Displays routes with destination IP address prefixes equal

to or shorter than a specified destination IP address prefix. prefix—Defines the IP address prefix of routes to be displayed.

An IP address prefix is the first part of an IP address with a subnet mask length (for example, IPv4 10.40/16 and IPV6 fc10::39/48).

root—Displays routes with destination IP address prefixes equal to or longer than a specified destination IP address prefix.

tos Displays routes with a specified type of service value. The following parameter is accepted:

tos—Defines the type of service value associated with routes being displayed.

WESTELL.COM

1-800-377-8766

Page 4-35



type Displays routes of a specified type. The following parameters are accepted: blackhole—The route destination is unreachable. Packets going

to route destination are silently dropped. broadcast—The route destination is a broadcast address. local—The route destination is assigned to Remote RMX-3200.

Packets are looped back and delivered locally. multicast—The route is a mulitcast route. nat—The route is a special NAT route. Route destination must be

translated before forwarding can occur. prohibit—The route destination is unreachable. Sender will

receive a message specifying that the route destination is unreachable.

throw—The route causes a route lookup in a routing table to fail, returning the routing selection process to the routing policy database.

unicast—The route is a real path to another host. unreachable—The route destination is unreachable. Sender will

receive a message specifying that the route destination is unreachable.

via Initiates the display of routes going through next hop routers with a specified IP address prefix. The following parameter is accepted:


WESTELL.COM

Page 4-36

1-800-377-8766


ExamplesThis example displays diagnostic information for all routes in the main IP routing table.

Note: The following example is for IPv4 routes.

Note: The following example is for IPv6 routes.

Note: Not all display items appear for each route.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>route(Dub) diag ip route->show127.0.0.1 dev lo proto kernel scope link src 127.0.0.110.40.0.0/16 dev br_switch proto kernel scope link src 10.40.57.5unreachable 127.0.0.0/8 proto gated scope nowheredefault via 10.40.0.1 dev br_switch proto gated(Dub) diag ip route->

(Dub)>diag(Dub) diag>ip(Dub) diag ip>route-v6(Dub) diag ip route-v6->showfc10:0:0:39::/96 dev br_switch proto kernel metric 256 expires 2591790sec mtu 1500 advmss 1440 hoplimit 0fe80::/64 dev br_switch proto kernel metric 256 mtu 1500 advmss 1440 hoplimit 0ff00::/8 dev br_switch metric 256 mtu 1500 advmss 1440 hoplimit 0default via fe80::e611:5bff:fecb:4e8b dev br_switch proto kernel metric 1024 expires 1590sec mtu 1500 advmss 1440 hoplimit 64(Dub) diag ip route-v6->


Destination IP address/ subnet mask

Displays the destination IP address and/or subnet mask of each route. unreachable specifies that the destination is unreachable. default specifies that the route is a default route.

via Displays the gateway through which the route is reachable.

dev Displays the system name for the Remote RMX-3200 interface through which each route goes.

WESTELL.COM

1-800-377-8766

Page 4-37


This example displays diagnostic information for routes going through interface bridge switch (br_switch).


diag ip link show


proto Displays the routing protocol for each route.

scope Displays the scope of each route. Scope specifies the area where the route is valid. Valid values are: global—Route is valid globally. host—Route is valid only on the local host. link—Route is valid only on Remote RMX-3200.

src Displays the source IP address for each route.

(Dub)>diag(Dub) diag>ip(Dub) diag ip>route(Dub) diag ip route->show dev br_switch10.40.0.0/16 proto kernel scope link src 10.40.57.5default via 10.40.0.1 proto gated(Dub) diag ip route->


WESTELL.COM

Page 4-38

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag line-monitor

diag line-monitor

DescriptionThis command provides an ongoing look at low-level monitoring of asynchronous serial ports. The results can be displayed in hexadecimal, mixed ASCII/hexadecimal, or two column formats. It is possible to switch between display formats during the monitoring session.

Notes: If a serial port is not in use, or is misconfigured, this command will display

input signal status changes and data transmitted and received by the serial port.

To end a monitoring session, enter Ctrl+c.

Important: This is an interactive interface. It is necessary to select an output format after entering the command. For options assistance, enter a question mark (?) after entering the command.

Formatsdiag line-monitor port [ port ... ]

Parameters


port Defines the physical connector associated with the controller on Remote RMX-3200. Valid values are serial-1 to serial-8 and console.

Note: A supervisor user profile is required to monitor a console.

WESTELL.COM

1-800-377-8766

Page 4-39

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag line-monitor

ExamplesThis example displays line monitoring for asynchronous serial port serial-1.

Note: This screen shot displays the command entered on the first line. Use the

following command keys to display line monitoring information:

Type h to display monitoring in hexadecimal format.

Type m to display monitoring in mixed ASCII/hexadecimal format.

Type c to display monitoring in two column format.

See Alsodiag line-status

(Dub)>diag(Dub) diag>line-monitor serial-1

[seria-1]T> 07 .[seria-1]T> 00 .[seria-1]T> 00 .[seria-1]T> 01 .h

***Starting Hex-Only Display Mode***

[serial-1]T> 01 02 02 03m

***Starting Mixed Display Mode***

[serial-1]T> <03> <04> <04> <05>c

***Starting 2 Column Display Mode***

[seria-1]T> 05 .[seria-1]T> 06 .[seria-1]T> 06 .[seria-1]T> 07 .

WESTELL.COM

Page 4-40

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag line-status

diag line-status

DescriptionThis command displays the asynchronous control signals and administrative states for an asynchronous port or group of ports.

Formatsdiag line-status port [ port ... ]

Parameters


ExamplesThis example displays the asynchronous control signals and administrative states for serial ports console, serial-2 and serial-3.

See Alsodiag line-monitor

port Defines the physical connector associated with the controller on Remote RMX-3200. Valid values are serial-1 to serial-8 and console.

(Dub)>diag(Dub) diag>line-status console serial-2 serial-3

IN OUT Port Status DSR DCD CTS DTR RTS------------------------------------------------------------------ serial-2 enabled - - - + + serial-3 enabled - - - + + console enabled + + + + +

(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-41

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag mediation snmpne poll


DescriptionThis command forces a poll for current point states on a mediation SNMP network element.

Formatsdiag mediation snmpne name poll

Parameters


ExamplesIn this example, mediation SNMP NE MyNE is set to be polled:





debug mediation

show mediation

name The name of the mediation SNMP NE. Valid values are alphanumeric characters.

(Dub) diag mediation snmpne MyNE(Dub) diag mediation snmpne MyNE>poll(Dub) diag mediation snmpne MyNE>

WESTELL.COM

Page 4-42

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag mmdisplay

diag mmdisplay

DescriptionThis command displays all mediation messages or a specific type of mediation message for Remote RMX-3200. A mediation message is an internal message used by the mediation subsystem. All events and responses are implemented as mediation messages, so this command can be useful for troubleshooting the configuration of actions, events and responses.

Formatsdiag mmdisplay

eventeventresponseregex regexresponseverbose

Parameters


event Displays event mediation messages.

eventresponse Displays event and response mediation messages.

regex Displays messages that match a regular expression. The following parameter is accepted:

regex—Defines a regular expression for the regex option.

response Displays response mediation messages.

verbose Displays verbose mediation message output. Verbose output displays more detailed mediation message information than regular output does.

WESTELL.COM

1-800-377-8766

Page 4-43

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag mmdisplay

ExamplesThis example displays all Remote RMX-3200 mediation messages.

This example displays Remote RMX-3200 event mediation messages only.

(Dub)>diag(Dub) diag>mmdisplayPress Ctrl-C to return to the CLI< router | command=register | destination=PrintLog7566 | regex=.* | size=10000 >< event | originator=analog 0/1 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/2 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/1 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/1 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/2 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/1 | triggerEvent=interval | value=0.00 mA >

(Dub) diag>

(Dub)>diag(Dub) diag>mmdisplay eventPress Ctrl-C to return to the CLI< event | originator=analog 0/1 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/1 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/2 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 0/1 | triggerEvent=interval | value=0.00 mA >

(Dub) diag>

WESTELL.COM

Page 4-44

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag output

diag output

DescriptionThese commands open or close a digital output. The output can optionally be opened or closed for a specified number of seconds.

Formatsdiag output unit/point

close [ momentary ]open [ momentary ]

Parameters


ExamplesThis example displays a digital output being opened for 12 seconds.

See Alsoconfig discrete output

show discrete

close Closes the digital output. The following parameter is accepted:momentary—Defines the amount of time (in seconds) that a digital output stays in the specified state.

open Opens the digital output. The following parameter is accepted:momentary—Defines the amount of time (in seconds) that a digital output stays in the specified state.

point Defines the digital output number within the unit. Valid values for on-board digital outputs are 1 to 4. Other values may be available for expansion peripheral units.



(Dub) diag>diag(Dub) diag>output 0/2 open 12(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-45

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag peripheral reload

diag peripheral reload

DescriptionThis command reboots the specified peripheral unit including Expand D, RME-S8, RME-E8, RME-B64, RMB-1 and RMB-2. If Remote RMX-3200 has a newer executable image from the one that the peripheral unit is currently running, this command will download the image to the peripheral unit before rebooting it.

Note: This command works only on peripheral units that are under management of

the Remote RMX-3200 on which the command is executed. The peripheral unit has to be in the Managed or Online state.

Formatsdiag peripheral { unit unit | name name | * } reload

[ force-download ]

Parameters

name Specifies the name of the managed peripheral unit. The following parameter is accepted:

name—This name consists of a series of letters followed by six hexadecimal digits representing the unique portion of the peripheral unit’s MAC address. Names are formatted as follows, where each X represents a hexadecimal digit: RMB1-XXXXXX for RMB-1 and RMB-2 units DEP-XXXXXX for Expand D units SER8-XXXXXX for RME-S8 units FB64-XXXXXX for RME-B64 units FE8-XXXXXX for RME-E8 units

force-download

Specifies that the executable image on Remote RMX-3200 will be downloaded to the peripheral unit, even if the image on Remote RMX-3200 is an older version. Remote RMX-3200 will not downgrade the image on the peripheral unless you specify the force-download parameter.

unit Specifies the peripheral unit number. The following parameter is accepted:


* Specifies all peripheral units.

WESTELL.COM

Page 4-46

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag peripheral reload


ExampleThis example displays the rebooting of Expand D DEP-083B62.


show peripherals

(Dub)>diag(Dub) diag>peripheral name DEP-083B62(Dub) diag peripheral name DEP-083B62>reloadAre you sure you wish to reset the peripheral? (y/N) y(Dub) diag peripheral name DEP-083B62>

WESTELL.COM

1-800-377-8766

Page 4-47

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag ps

diag ps

DescriptionThis command displays all running Remote RMX-3200 processes.

Formatsdiag ps


ExamplesThis example displays a sample of the currently running processes for Remote RMX-3200.

WESTELL.COM

Page 4-48

1-800-377-8766


Note: This screen shot displays the first portion of the CLI output for this command.

(Dub)>diag(Dub) diag>psUSER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMANDroot 1 0.0 0.4 1720 512 ? S Jul14 0:30 initroot 2 0.0 0.0 0 0 ? SW Jul14 0:00 [keventd]root 3 0.0 0.0 0 0 ? SWN Jul14 0:06 [ksoftirqd_CPU0]root 4 0.0 0.0 0 0 ? SW Jul14 0:01 [kswapd]root 5 0.0 0.0 0 0 ? SW Jul14 0:00 [bdflush]root 6 0.0 0.0 0 0 ? SW Jul14 0:03 [kupdated]root 7 0.0 0.0 0 0 ? SW Jul14 0:00 [mtdblockd]root 31 0.0 0.0 0 0 ? SW Jul14 0:00 [kjournald]root 42 0.0 0.2 1452 372 ? S Jul14 0:00 /usr/sbin/tempsenroot 40 0.0 0.0 0 0 ? SW Jul14 0:05 [modprobe]root 55 0.0 1.5 5256 2000 ? S Jul14 0:00 /usr/sbin/daemonrroot 56 0.0 14.4 24540 18452 ? S Jul14 1:32 logdroot 57 0.0 14.4 24540 18452 ? S Jul14 0:00 logdroot 58 0.0 14.4 24540 18452 ? S Jul14 5:34 logdroot 64 0.0 1.5 5256 2000 ? S Jul14 0:00 /usr/sbin/daemonrroot 65 0.0 2.0 12028 2632 ? S Jul14 0:01 evtdroot 85 0.0 1.5 5256 2000 ? S Jul14 0:00 /usr/sbin/daemonrroot 380 0.0 3.1 15568 4084 ? S Jul14 0:00 actionmgrdroot 391 0.0 1.5 5256 2000 ? S Jul14 0:00 /usr/sbin/daemonrroot 392 0.0 3.0 12436 3924 ? S Jul14 0:01 conndirdroot 475 0.0 3.3 17616 4308 ? S Jul14 0:00 peripheraldroot 480 0.0 3.3 17616 4308 ? S Jul14 0:00 peripheraldroot 485 0.0 1.5 5256 2000 ? S Jul14 0:00 /usr/sbin/daemonrroot 486 0.0 3.0 8660 3920 ? S Jul14 0:01 logmmdroot 487 0.0 3.3 17616 4308 ? S Jul14 0:00 peripheraldroot 507 0.0 1.5 5256 2000 ? S Jul14 0:00 /usr/sbin/daemonrroot 508 0.0 3.4 9204 4424 ? S Jul14 0:01 telnetfilterdroot 551 0.0 0.3 1484 504 ? S Jul14 0:00 /sbin/agetty ttySnobody 14667 0.0 4.9 12660 6336 ? SN 11:55 0:01 scriptrc -i /var/nobody 14668 0.0 4.9 12660 6336 ? SN 11:56 0:00 scriptrc -i /var/nobody 14669 1.4 4.9 12660 6336 ? SN 11:56 2:07 scriptrc -i /var/root 19067 0.0 0.9 2996 1168 ? S 13:51 0:01 telnetd -h -broot 19068 0.0 0.8 2948 1068 ? S 13:51 0:00 login -- techcommtechcomm 19073 0.5 5.1 15692 6620 ttyp0 S 13:51 0:09 -clitechcomm 19077 0.0 5.1 15692 6620 ttyp0 S 13:51 0:00 -clitechcomm 19078 0.0 5.1 15692 6620 ttyp0 S 13:51 0:01 -clitechcomm 19079 0.0 5.1 15692 6620 ttyp0 S 13:51 0:00 -cliroot 20293 0.2 0.8 2688 1028 ? S 14:20 0:00 pppd /dev/ttyS1 lroot 20297 0.3 0.4 1480 528 ? S 14:20 0:00 chat -v -f /etc/ptechcomm 20314 0.0 0.7 3268 1012 ttyp0 R 14:21 0:01 /bin/ps aux

Column Description

USER Displays the names of users who own the corresponding processes.

PID Displays process ID numbers. A process ID number is a value assigned to a process.

%CPU Displays the ratio of the total CPU time used to the total CPU time. This value is expressed as a percentage.

WESTELL.COM

1-800-377-8766

Page 4-49


See Alsodiag who

diag whoami

%MEM Displays the percentage of available memory that is being used by the process.

VSZ Displays the total size of a process in virtual memory. Size is measured in KB.

RSS Displays the resident set size (amount of physical memory), in KB.

TTY Displays the name of the controlling terminal of the process (if there is one).

STAT Displays the process status. Common indicators include the following values: S (Asleep) W (No resident pages) N (Positive nice value) R (Runnable) Z (Zombie)

START Displays the date the process was started.

TIME Displays the time the process was started.

COMMAND Displays the name of the command being executed.


WESTELL.COM

Page 4-50

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag snapshot

diag snapshot

DescriptionThis command creates a file named snapshot.tar.gz in the log directory. It contains current system diagnostics and can be accessed with an FTP application from the log directory.

Note: This command generates no output in the CLI.

Formatsdiag snapshot


ExamplesThis example displays the execution of command diag snapshot.

See Also diag ps

diag top

diag who

diag whoami

(Dub)>diag(Dub) diag>snapshot(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-51

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag tcpdump

diag tcpdump

DescriptionThis command displays the headers of packets received on a Remote RMX-3200 interface. Remote RMX-3200 displays the headers of all packets that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMX-3200 displays the headers of all packets received.

Note: When accessing the Remote RMX-3200 remotely over a WAN interface, this

command will generate a large amount of un-necessary traffic as the result of tcpdump reporting its own output between the client computer and the Remote RMX-3200. This situation can be avoided by including filter criteria that limits the output of tcpdump to only those packets of interest. For example, the filter “port 162” will only display packets to or from port 162. The filter “host 192.168.1.2” will only show packets to or from the device whose IP address is 192.168.1.2.

Note: For more detailed information about this command, refer to the man page for

command tcpdump.

Formatsdiag tcpdump [ -a ] [ -c count ] [ -d ] [ -e ] [ -E algo:secret ] [ -f ] [ -i interface ] [ -l ] [ -n ] [ -N ] [ -O ] [ -p ] [ -q ] [ -R ] [ -s snaplen ] [ -S ] [ -t ] [ -T type ] [ -u ] [ -v ] [ -x ] [ -X ] [ expression ]

Parameters

-a Attempts to convert network and broadcast addresses to names.

-c Terminates the packet header display after the Remote RMX-3200 interface receives a specified number of packets. The following parameter is accepted:

count—Defines the number of packets the Remote RMX-3200 interface receives before terminating the display of packet headers.

-d Displays the compiled packet-matching code in a human readable format and then stops the display.

-e Displays the link-level header for each displayed packet header.

WESTELL.COM

Page 4-52

1-800-377-8766


-E Initiates the decrypting of IPsec ESP packets based on a specified algorithm and secret. The following parameters are accepted: algo—Defines the algorithm used to decrypt IPsec ESP

packets. Valid values are des-cbc, 3des-cbc, blowfish-cbc, rc3-cbc, cast128-cbc and none.

secret—Defines the ASCII text for the ESP secret key.

-f Displays “foreign” IP addresses numerically rather than symbolically.

-i Specifies the interface for which packet headers are being displayed.

Note: If an interface is not specified, packet headers are

displayed for the lowest numbered, enabled, non-loopback interface.

The following parameter is accepted:interface—Defines the name of the interface for which packet headers are being displayed.

-l Displays packet headers in a line-buffered format.

-n Specifies that Remote RMX-3200 will not convert addresses to names.

-N Specifies that Remote RMX-3200 will not display domain name qualifications for host names.

-O Specifies that Remote RMX-3200 will not run the packet-matching code optimizer.

-p Specifies that Remote RMX-3200 will not put the interface in promiscuous mode when displaying packet headers.

-q Displays less protocol information so the display for each packet header is shorter.

-R Specifies that Remote RMX-3200 will not display the replay prevention field for the header.

-s Grabs a specified number of bytes of data from each packet instead of the default of 68. The following parameter is accepted:

snaplen—Defines the number of bytes of data to grab from each packet.

-S Displays absolute, rather than relative, TCP sequence numbers.

WESTELL.COM

1-800-377-8766

Page 4-53



-t Specifies that Remote RMX-3200 will not display a timestamp for each displayed packet header.

-T Initiates the interpretation of packets of a specific type. The following parameters are accepted: cnfp—Cisco NetFlow Protocol packets rpc—Remote Procedure Call packets rtcp—Real-Time Applications Control Protocol packets rtp—Real-Time Applications Protocol packets snmp—Simple Network Management Protocol packets vat—Visual Audio Tool packets wb—Distributed White Board packets.

-u Displays undecoded NFS handles.

-v Displays a slightly more verbose output for each packet header. For example, TTL, identification, total length and options in an IP packet are displayed.

-x Displays each packet header (without the link-level header) in hexadecimal format.

-X Displays each packet header in ASCII format.

expression Defines the packets for which headers are being displayed. For more information on defining an expression, refer to the man page for command tcpdump.

WESTELL.COM

Page 4-54

1-800-377-8766


ExamplesThis example displays the headers of all packets received on the default interface (br_switch or bridge switch). Remote RMX-3200 displays packet headers in a line-buffered format.

Note: Press CTRL+c to terminate the display of packet headers.

(Dub)>diag(Dub) diag>tcpdump -ltcpdump: listening on br_switch13:56:04.879703 10.40.57.5.telnet > brianb-w2k.1260: P 552427076:552427103(27) ack 893410854 win 5840 (DF)13:56:04.885634 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:04.906373 arp who-has ba1-vlan40-ve40.kentrox.priv tell 10.40.57.513:56:04.906963 arp reply ba1-vlan40-ve40.kentrox.priv is-at 0:e0:52:cc:b:013:56:04.907244 10.40.57.5.1025 > ns1-auth.kentrox.priv.domain: 41486+[|domain](DF)13:56:04.908560 ns1-auth.kentrox.priv.netbios-ns > 10.40.57.5.netbios-ns: NBT UDP PACKET(137): QUERY; REQUEST; UNICAST13:56:04.909852 10.40.57.5 > ns1-auth.kentrox.priv: icmp: 10.40.57.5 udp port netbios-ns unreachable [tos 0xc0]13:56:04.982858 brianb-w2k.1260 > 10.40.57.5.telnet: . ack 27 win 64042 (DF)13:56:05.065180 arp who-has 10.40.65.101 (Broadcast) tell nms3s.kentrox.priv13:56:05.092865 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:05.158040 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:05.192639 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:05.258000 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:05.284947 arp who-has 10.40.65.100 (Broadcast) tell nms3s.kentrox.priv13:56:05.385629 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:05.592925 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:05.658039 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:05.885671 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.065192 arp who-has 10.40.65.101 (Broadcast) tell nms3s.kentrox.priv13:56:06.092889 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.158033 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.285030 arp who-has 10.40.65.100 (Broadcast) tell nms3s.kentrox.priv13:56:06.385749 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.403846 ns1-auth.kentrox.priv.netbios-ns > 10.40.57.5.netbios-ns: NBT UDP PACKET(137): QUERY; REQUEST; UNICAST13:56:06.404307 10.40.57.5 > ns1-auth.kentrox.priv: icmp: 10.40.57.5 udp port netbios-ns unreachable [tos 0xc0]13:56:06.592962 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.658089 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.692642 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.758053 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.885685 0.0.0.0.8116 > 10.40.0.0.8116: udp 3613:56:06.960610212 packets received by filter0 packets dropped by kernel(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-55


This example displays the headers of all packets received on interface serial wan/1 channel-group group. Remote RMX-3200 displays absolute, rather than relative, TCP sequence numbers and does not display a timestamp for each packet header.


tcpdump Displays the system name for the interface for which packets are being displayed.

Packet headers Displays all packet headers that match the specified criteria.

packets received by filter

Displays the number of packets received on the interface while the command was executing.

packets dropped by kernel

Displays the number of packets dropped by the kernel.

(Dub)>diag(Dub) diag>tcpdump -i serial wan/1 channel-group group -S -ttcpdump: WARNING: hdlc0: no IPv4 address assignedtcpdump: listening on hdlc0tcpdump: pcap_loop: recvfrom: Network is down(Dub) diag>

WESTELL.COM

Page 4-56

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag test alarm-entry

diag test alarm-entry

DescriptionThis command specifies alarms in the alarm table to be tested. Test notifications will be sent for all alarm states for each alarm entry specified.

Formatsdiag test alarm-entry { alarm_name | alarm_name_filter }

mode { disabled | normal [ duration ] | non-normal [ duration ]

Parameters


ExamplesIn this example, simulation mode for door_Open is set to normal with a duration of 10 minutes:

See Also diag test mode


alarm_name The name of the alarm entry to simulate.

alarm_name_filter

A filter for configured groups of alarm entries. Parameters include: A period (.) for single character matching An asterisk (*) for multiple character matching.

mode Configures the simulation mode. The following parameters are accepted: disabled—Disables simulation mode. duration—Specifies the duration in minutes of simulation mode.

Default is 1 minute, valid range: 1-60. non-normal—Enables simulation mode for first non-normal

state. normal—Enables simulation mode for first normal state.

(Dub)>diag(Dub) diag>test(Dub) diag test alarm-entry door__Open mode normal 10(Dub) diag test>

WESTELL.COM

1-800-377-8766

Page 4-57

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag test alarm-entry

show test mode

WESTELL.COM

Page 4-58

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag test mode

diag test mode

DescriptionThis command puts the alarm table into test mode so that users may simulate test traps from the alarm table. When test mode is enabled, all notifications sent from the alarm table will be marked as test notifications.

Formatsdiag test mode { disable | enable [ timeout ] }

Parameters


ExamplesIn this example, the alarm table is put into test mode for a period of 15 minutes.

In this example, test mode is disabled for the alarm table.

See Also diag test alarm-entry


show test mode

enable Enables the test mode for the alarm table. The following parameter is accepted:

timeout — Specifies an automatic timeout period for ending test mode. The default is 10 minutes.

disable Disables the alarm table test mode.

(Dub)>diag(Dub) diag>test(Dub) diag test>mode enable 15(Dub) diag test>

(Dub)>diag(Dub) diag>test(Dub) diag test>mode disable(Dub) diag test>

WESTELL.COM

1-800-377-8766

Page 4-59

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag top

diag top

DescriptionThis command provides an ongoing look at processor activity in real time. It displays a listing of the most CPU-intensive tasks on the system and can provide an interactive interface for manipulating the process display.

Important: The interactive interface for manipulating the process display is not available when displaying top CPU processes using batch mode (batch).

Formatsdiag top [ batch [ iterations ] ]

Parameters

Command DefaultsOne iteration for batch mode


batch Displays the top CPU processes using batch mode. In batch mode, the top CPU processes will be displayed a specified number of times in a row. The following parameter is accepted:

iterations—Defines the number of times the top CPU processes will be displayed.

WESTELL.COM

Page 4-60

1-800-377-8766


ExamplesThis example displays the top CPU processes.

Notes: This screen shot displays the first portion of the CLI output for this command.

Type h to display a menu of the commands that are available for manipulating diag top. This menu of commands is not available when displaying the top CPU processes using batch mode (batch).

Type q to exit the display of top CPU processes.

(Dub)>diag(Dub) diag>top

13:49:35 up 3 days, 21:33, 1 user, load average: 0.01, 0.03, 0.00134 processes: 133 sleeping, 1 running, 0 zombie, 0 stoppedCPU states: 6.2% user, 13.9% system, 0.0% nice, 79.9% idleMem: 127896K total, 118796K used, 9100K free, 3416K buffersSwap: 0K total, 0K used, 0K free, 69408K cached

PID USER PRI NI SIZE RSS SHARE STAT %CPU %MEM TIME COMMAND18992 techcomm 16 0 1304 1304 980 R 17.6 1.0 0:04 top 118 root 9 0 4584 4584 4020 S 0.9 3.5 30:56 netifd12949 root 9 0 1168 1168 920 S 0.6 0.9 0:01 telnetd 1 root 8 0 512 512 436 S 0.0 0.4 0:30 init 2 root 9 0 0 0 0 SW 0.0 0.0 0:00 keventd 3 root 19 19 0 0 0 SWN 0.0 0.0 0:06 ksoftirqd_CPU0 4 root 9 0 0 0 0 SW 0.0 0.0 0:01 kswapd 5 root 9 0 0 0 0 SW 0.0 0.0 0:00 bdflush 6 root 9 0 0 0 0 SW 0.0 0.0 0:03 kupdated 7 root 9 0 0 0 0 SW 0.0 0.0 0:00 mtdblockd 31 root 9 0 0 0 0 SW 0.0 0.0 0:00 kjournald 32 root 9 0 0 0 0 SW 0.0 0.0 0:11 kjournald 33 root 9 0 0 0 0 SW 0.0 0.0 0:00 kjournald 34 root 9 0 0 0 0 SW 0.0 0.0 0:00 kjournald 35 root 9 0 0 0 0 SW 0.0 0.0 0:00 kjournald 42 root 9 0 372 372 316 S 0.0 0.2 0:00 tempsensord 40 root 9 0 0 0 0 SW 0.0 0.0 0:05 modprobe

Column Description

PID Displays the process ID for each task.

USER Displays the user name of the task's owner.

PRI Displays the priority for each task.

NI Displays the “nice” value of the task. Negative nice values are higher priority.

SIZE Displays the virtual size of the process.

WESTELL.COM

1-800-377-8766

Page 4-61


See Also diag ps

diag who

diag whoami

RSS Displays the total amount of physical memory used by the task (in kilobytes).

SHARE Displays the amount of shared memory used by the task.

STAT Displays the state of the task. The following items may be displayed in the STAT column: S (sleeping) D (uninterruptible sleep) R (running) Z (zombie) T (stopped or traced)

%CPU Displays the cputime/realtime percentage in the time between updates. For the first update, a short delay is used and top itself uses a very high percentage of the CPU usage.

%MEM Displays the task's share of physical memory.

TIME Displays the total CPU time the task has used since it started.

COMMAND Displays task command names, which will be truncated if they are too long to be displayed on one line.


WESTELL.COM

Page 4-62

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag usb

diag usb

DescriptionThis command displays information about any device connected to the Remote RMX-3200 USB bus. The USB bus is located in the expansion slot.

Note: For Remote RMX-3200 Version 5.4x, the RMX WWAN card is the only device

that makes use of the USB bus.

Formatsdiag usb


ExamplesThis example displays information about an RMX WWAN card connected to the USB hub.

(Dub)>diag(Dub) diag>usbName Vendor ProdID USB Bus USB Device USB Parent USB PortUSB Hub 01.1 0x0000 0x0000 1 1 0 0 USB Hub 01.2 0x04cc 0x1520 1 2 1 0 serial wan/1 0x1199 0x0024 01 3 02 00(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-63

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag who

diag who

DescriptionThis command displays all users logged into Remote RMX-3200.

Formatsdiag who


ExamplesThis example displays the terminal names, login dates/times and workstation IP addresses for all users logged into Remote RMX-3200.

See Alsodiag break

diag whoami

show users

(Dub)>diag(Dub) diag>whoai ttyp0 Sep 14 14:36 (10.40.5.11)brb22 ttyp1 Sep 14 14:43 (10.40.5.20)(Dub) diag>

WESTELL.COM

Page 4-64

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag whoami

diag whoami

DescriptionThis command displays the terminal name for a user logged into Remote RMX-3200.

Formatsdiag whoami


ExamplesThis example displays the terminal name (brb22) for the user logged into Remote RMX-3200.

See Also diag who

show users

(Dub)>diag(Dub) diag>whoamibrb22(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-65

Remote RMX-3200 Version 5.4x Command Reference GuideDiagnostic Commands: diag whoami

WESTELL.COM

Page 4-66

1-800-377-8766

CHA

PTER 5

Utility Commands

This chapter describes the Remote RMX-3200 utility commands. Utility commands handle administrative tasks such as copying files, displaying the running configuration and logging out of Remote RMX-3200.


Utility Commands Overview

List of Utility Commands

Page 5-1

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: Utility Commands Overview

Utility Commands OverviewThe utility commands consist of multi-purpose administrative commands which manage such administrative tasks as copying files, displaying the running configuration and logging out of Remote RMX-3200. All are executable from any level of the CLI.

WESTELL.COM

Page 5-2

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: List of Utility Commands

Page 5-3

List of Utility CommandsThe following is a partial list of the global commands from the CLI, displaying only those in the utility category. This is followed by the listing of the debug subcommands. Remember that a command with a (+) indicates subcommands.

(Dub)> [? does not display in CLI]Global Commands [displaying only utility commands]

copy Creates a copy of a configuration or patch configuration file. datactx Displays a data context. debug(+) Enables or disables session log output. diag(+) Displays system diagnostics. erase Erases (removes) a configuration or patch configuration file. exec(+) Executes system command. exec-job(+) Controls the execution of jobs. exec-kill(+) Terminates a specified mediation connection. exit Exits up one level in the command hierarchy. help Describes how to access help. logout Logs out and terminates the session. password Changes the password for the current user. ping Tests network connectivity to a remote host. reload Resets the system. running-config Displays the current operating configuration. show(+) Displays parameters. ssh Establishes a SSH session. telnet Establishes a Telnet session. trace-route Traces network routing to a remote host.

(Dub)>debugCommands ethernet(+) Enables or disables debug information logging for Ethernet controller and interface events. level(+) Configures the level of debug messages displayed on the CLI. mediation(+) Configures mediation debugging. openvpn(+) Enables or disables debug information logging for OpenVPN events. ppp(+) Enables or disables debug information logging for PPP. serial(+) Enables or disables debug information logging for serial controller and interface events. snmp(+) Configures SNMP debugging.

(Dub)>debug

WESTELL.COM

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: copy

Page 5-4

copy

DescriptionThis command copies a configuration file to the specified file name in the /config directory on the Remote RMX-3200 FTP server.

Formatscopy source_filename destination_filename

Parameters

The following special files can be entered as source file names, destination file names, or both.

source_filename Defines the configuration file being copied. The maximum length for a file name is 64 characters, consists of alphanumeric characters and/or underscores and must start with an alphabetic character. File names are case-sensitive

destination_filename

Defines the destination file name for the source configuration file. The maximum length for a file name is 64 characters, consists of alphanumeric characters, and/or underscores and must start with an alphabetic character. File names are case-sensitive.

Special File Description

factory-config

This configuration file contains the factory defaults for Remote RMX-3200. For example, if you copy the factory-config to the running-config, Remote RMX-3200 is reset to its default configuration.Important: New information cannot be copied to the

factory-config file. Additionally, if you copy factory-config to running-config, you will have to reconfigure all previously configured settings.

running-config

This configuration file contains any recent user modifications to the Remote RMX-3200 configuration. For more information, refer to running-config. When executing the copy command, the running-config file can be used as the source or destination file name.

WESTELL.COM

1-800-377-8766


Note: Users with a management profile can copy only a partial configuration file.

Configurations pertaining to user accounts, hostnames and system timeout settings can be copied only by a user with a supervisor profile.


ExamplesThis example displays the copying of the current running configuration file(running-config), which contains all the current configuration settings and customization, to the startup configuration file (startup-config).

This example displays the copying of the configuration file (running-config) to a destination file named myconfig.

See Alsoerase

running-config

running-startup

This file copies a configuration to both the running-config and startup-config files at the same time. The following rules apply to running-startup: It is write-only. It is valid only as a destination file name. Users cannot copy

running-startup to another file. Users cannot copy running-config or startup-config to

running-startup.

startup-config

This configuration file contains the configuration at start-up time for Remote RMX-3200. If running-config is copied to startup-config, the settings in the running-config file become the settings applied at start-up time. When executing the copy command, the startup-config file can be used as the source or destination file name.

(Dub)>copy running-config startup-config(Dub)>

(Dub)>copy running-config myconfig(Dub)>

Special File Description (Continued)

WESTELL.COM

1-800-377-8766

Page 5-5


show config-file

WESTELL.COM

Page 5-6

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug ethernet

debug ethernet

DescriptionThis command enables or disables debug information logging for a variety of events. When enabled, debug information is written to the Remote RMX-3200 log file.

Tip: To enable the display of debug information for Ethernet controller events on the CLI, use command debug level.

Formatsdebug ethernet

all { disable | enable }controller { disable | enable }interface { disable | enable }

Parameters



all Specifies that debug information logging is disabled or enabled for controllers and interfaces. The following parameters are accepted: disable—Disables debug information logging. enable—Enables debug information logging.

controller Specifies that debug information logging is disabled or enabled for controllers only. The following parameters are accepted: disable—Disables debug information logging. enable—Enables debug information logging.

interface Specifies that debug information logging is disabled or enabled for interfaces only. The following parameters are accepted: disable—Disables debug information logging. enable—Enables debug information logging.

WESTELL.COM

1-800-377-8766

Page 5-7

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug ethernet

ExamplesThis example displays the enabling of debug information logging for Ethernet controller events.

This example displays the disabling of debug information logging for Ethernet controller events.

See Alsorunning-config

show debugging

show log-file

(Dub)>debug(Dub) debug>ethernet(Dub) debug ethernet>controller enable(Dub) debug ethernet>

(Dub)>debug(Dub) debug>ethernet(Dub) debug ethernet>controller disable(Dub) debug ethernet>

WESTELL.COM

Page 5-8

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug level

debug level

DescriptionThis command enables or disables the display of debug messages. When enabled, debug messages are displayed on the CLI.

Formatsdebug level

allauthenticationcriticalnone

Parameters

Command Defaultscritical


ExamplesThis example displays the enabling of all Remote RMX-3200 debug messages.

Note: Enter CTRL+r to redisplay the command prompt. This is useful if the CLI

display becomes polluted with debug messages.

See Alsoshow debugging

all Enables the display of all debug messages.

authentication Enables the display of Authentication and RAS debug messages only the CLI.

critical Enables the display of critical debug messages.

none Disables the display of debug messages.

(Dub)>debug(Dub) debug>level(Dub) debug level>all(Dub) debug level>

WESTELL.COM

1-800-377-8766

Page 5-9

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug mediation

debug mediation

DescriptionThis command enables or disables verbose debug information logging for the Remote RMX-3200 subsystems or components. When enabled, debug information is written to the Remote RMX-3200 log file. Debug information logging is disabled by default.

Tip: To enable the display of debug information at the CLI level, use command debug level.

Formatsdebug mediation

actions { disable | enable }alarm { disable | enable }connections { disable | enable }log { disable | enable }netif { disable | enable }peripheral { disable | enable }python { disable | enable }snmp { disable | enable }snmp-trap { disable | enable }tbos { disable | enable }tcp { disable | enable }telnet { disable | enable }timer { disable | enable }tl1 { disable | enable }uart { disable | enable }

Parameters

actions Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles action mediation. The following parameters are accepted: disable enable.

alarm Specifies verbose debug information logging for central alarm table entries. The following parameters are accepted: disable enable.

WESTELL.COM

Page 5-10

1-800-377-8766


connections Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles connection mediation. The following parameters are accepted: disable enable.

log Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles logging mediation. The following parameters are accepted: disable enable.

netif Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles interface mediation. The following parameters are accepted: disable enable.

peripheral Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles peripheral mediation. The following parameters are accepted: disable enable.

python Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles Python mediation. The following parameters are accepted: disable enable.

snmp Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles SNMP mediation. The following parameters are accepted: disable enable.

snmp-trap Specifies verbose debug information logging of the SNMP traps received by the mediation SNMP manager. The following parameters are accepted: disable enable.

tbos Specifies verbose debug information logging for the TBOS subsystem. The following parameters are accepted: disable enable.

WESTELL.COM

1-800-377-8766

Page 5-11



tcp Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles TCP mediation. The following parameters are accepted: disable enable.

telnet Specifies verbose debug information logging for the telnet filter. The following parameters are accepted: disable enable.

timer Specifies debug information logging for timer mediation. The following parameters are accepted: disable enable.

tl1 Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles TL1 mediation. The following parameters are accepted: disable enable.

uart Specifies verbose debug information logging for the Remote RMX-3200 software subsystem that handles UART mediation. The following parameters are accepted: disable enable.

disable Disables all debug information logging for the Remote RMX-3200 software subsystem that handles action mediation. All debug information logging is disabled by default. The following parameters are accepted: disable enable.

enable Enables all debug information logging for the Remote RMX-3200 software subsystem that handles action mediation. The following parameters are accepted: disable enable.

WESTELL.COM

Page 5-12

1-800-377-8766


ExamplesThis example displays the enabling of debug information logging for action mediation and peripheral mediation.

See Alsoshow debugging

show log-file

(Dub)>debug(Dub) debug>mediation(Dub) debug mediation>actions enable(Dub) debug mediation>peripheral enable(Dub) debug mediation>

WESTELL.COM

1-800-377-8766

Page 5-13

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug modem

debug modem

DescriptionThis command enables or disables debug information logging for serial modem events. When enabled, debug information is written to the Remote RMX-3200 log file.

Formatsdebug modem

all { enable | disable }controller { enable | disable }

Parameters



ExamplesThis example displays the enabling of debug information logging for modem controller events.


all Enables or disables all debug information logging for serial modem controller and interface events. The following parameters are accepted: disable enable

controller Enables or disables debug information logging for modem controller events. The following parameters are accepted: disable enable

(Kentrox)>debug(Kentrox) debug>modem(Kentrox) debug modem>controller enable(Kentrox) debug serial>

WESTELL.COM

Page 5-14

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug openvpn

debug openvpn

DescriptionThis command enables or disables debug information logging for OpenVPN controller events and/or interface events. When enabled, debug information is written to the Remote RMX-3200 log file.

Tip: To enable the display of all debug information for OpenVPN controller and interface events on the CLI, use command debug level.

Formatsdebug openvpn

all { disable | enable }controller { disable | enable }

Parameters



ExamplesThis example displays the enabling of debug information logging for OpenVPN controller events.

all Specifies that debug information logging is disabled or enabled for controllers and interfaces. The following parameters are accepted: disable—Disables debug information logging. enable—Enables debug information logging.

controller Specifies that debug information logging is disabled or enabled for controllers only. The following parameters are accepted: disable—Disables debug information logging. enable—Enables debug information logging.

(Dub)>debug(Dub) debug>openvpn(Dub) debug openvpn>controller enable(Dub) debug openvpn>

WESTELL.COM

1-800-377-8766

Page 5-15

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug openvpn

This example displays the disabling of debug information logging for OpenVPN controller events.


show debugging

show log-file

(Dub)>debug(Dub) debug>openvpn(Dub) debug openvpn>controller disable(Dub) debug openvpn>

WESTELL.COM

Page 5-16

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug ppp

debug ppp

DescriptionThis command enables or disables all debug information logging for controllers configured with PPP encapsulation. When enabled, debug information is written to the Remote RMX-3200 log file.

Tip: To enable the display of all debug information for controllers configured with PPP encapsulation on the CLI, use command debug level.

Formatsdebug ppp

all { enable | disable }error { enable | disable }negotiation { enable | disable }packet { enable | disable }

Parameters


all Specifies debug information logging for all controllers configured with PPP encapsulation. The following parameters are accepted: disable enable.

error Specifies debug information logging for PPP error events and statistics. The following parameters are accepted: disable enable.

negotiation Specifies debug information logging for the negotiation of LCP (link) and NCP (network) settings. The following parameters are accepted: disable enable.

packet Specifies packet-level debug information logging for PPP. The following parameters are accepted: disable enable.

WESTELL.COM

1-800-377-8766

Page 5-17

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug ppp


ExamplesThis example displays the enabling of all debug information logging for controllers configured with PPP encapsulation.

This example displays the disabling of all debug information logging for controllers configured with PPP encapsulation.


show debugging

show log-file

(Dub)>debug(Dub) debug>ppp(Dub) debug ppp>all enable(Dub) debug ppp>

(Dub)>debug(Dub) debug>ppp(Dub) debug ppp>all disable(Dub) debug ppp>

WESTELL.COM

Page 5-18

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug serial

debug serial

DescriptionThis command enables or disables debug information logging for serial controller and interface events. When enabled, debug information is written to the Remote RMX-3200 log file.

Tip: To enable the display of debug information for serial controller and interface events on the CLI, use command debug level.

Formatsdebug serial

all { enable | disable }controller { enable | disable }interface { enable | disable }

Parameters



all Specifies debug information logging for serial controller and interface events. The following parameters are accepted: disable enable.

controller Specifies debug information logging for serial controller events only. The following parameters are accepted: disable enable.

interface Specifies debug information logging for serial interface events only. The following parameters are accepted: disable enable.

WESTELL.COM

1-800-377-8766

Page 5-19

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug serial

ExamplesThis example displays the enabling of debug information logging for serial controller events.


show debugging

show log-file

(Dub)>debug(Dub) debug>serial(Dub) debug serial>controller enable(Dub) debug serial>

WESTELL.COM

Page 5-20

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug snmp

debug snmp

DescriptionThis command enables or disables debug information logging for SNMP events. When enabled, debug information is written to the Remote RMX-3200 log file.

Formatsdebug snmp

all { enable | disable }traplog { enable | disable }

Parameters



ExamplesThis example displays the enabling of debug information logging for outgoing SNMP traps.


show debugging

all Specifies debug information logging for all SNMP events. The following parameters are accepted: disable enable.

traplog Specifies debug information logging for outgoing SNMP traps only. The following parameters are accepted: disable enable.

(Dub)>debug(Dub) debug>snmp(Dub) debug snmp>traplog enable(Dub) debug snmp>

WESTELL.COM

1-800-377-8766

Page 5-21

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: debug snmp

show log-file

WESTELL.COM

Page 5-22

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: erase

erase

DescriptionThis command deletes a configuration file from Remote RMX-3200.

Formatserase filename

Parameters


ExamplesThis example displays the deletion of the configuration file myconfig from Remote RMX-3200.

See Alsocopy

show config-file

filename Defines the name of the file being deleted from Remote RMX-3200. Valid values are any configuration file on Remote RMX-3200 or startup-config. File names are case-sensitive.

(Dub)>erase myconfigAre you sure you wish to erase 'myconfig'? (y/N) y(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-23

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exec site control-action


DescriptionThis command initiates a specific action on a control.

Formatsexec site control-action control_name action_name

Parameters


ExamplesThis example displays the starting of a generator from Remote RMX-3200.

See Also

show site controls

control_name Defines the name of the control receiving the action. Available controls are determined by the modules installed on the Remote RMX-3200.

action_name Defines the name of the control action being initiated. Available actions are determined by the controls within a module.

(Dub)>exec site control-action generator start

WESTELL.COM

Page 5-24

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exec site install

exec site install

DescriptionThis command can install a single, specific module or all available modules. If no modules or bundles are defined, all module or bundle files in the staging area are installed.

The highest module versions found are installed from the Remote RMX-3200 /modules staging area.

Tip: The staging area is the /modules directory on Remote RMX-3200 that stores module or bundle files to be installed. Files must be downloaded to the staging area before they can be used in the CLI.

A module will not be installed if the highest available version level is lower than the currently installed version level.

Formatsexec site install [module_name | bundle_file]

Parameters


ExamplesThis example displays the installation of the Environmental bundle (Common and Environmental modules) file Environmental-1.0.0.tgz on the Remote RMX-3200.

See Alsoexec site uninstall

show site modules

module_name Defines the name of the module being installed.

bundle_file Defines the name of the bundle file being installed.

(Dub)>exec site install Environmental-1.0.0.tgzThe modules Common and Environmental were installed successfully.(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-25

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exec site uninstall

exec site uninstall

DescriptionThis command uninstalls the specified module. If there is only one module installed on the Remote RMX-3200, running the command with no parameters will uninstall the module.

Formatsexec site uninstall [module_name]

Parameters


ExamplesThis example displays the uninstallation of the Environmental module from Remote RMX-3200.

See Alsoexec site install

show site modules

module_name Defines the name of the module being installed.

(Dub)>exec site uninstall EnvironmentalModule "Environmental" uninstalled successfully.(Dub)>

WESTELL.COM

Page 5-26

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exec job run

exec job run

DescriptionThis command starts a job for Remote RMX-3200. If the job is started successfully, a run ID number is displayed. Jobs can also start in debug mode or check mode.

Important: Packages cannot be removed while a running job is using them. Jobs cannot be deleted while they are running.

Tip: A job can be reconfigured while it is running. Changes from a reconfiguration take effect upon the next execution of the same job.

Tip: Approximately 1500 kilobytes of additional memory is required to use either the debug or check option. The minimum required memory for the debug and check options is 3072 kilobytes, but larger jobs will require correspondingly larger memory limits. Increase the job’s allocated memory with command config jobs name.

Formatsexec-job job_name run

debug [ tag=value... ]check [ tag=value... ]

WESTELL.COM

1-800-377-8766

Page 5-27


Parameters

check Specifies that the script will import modules with the PyChecker utility. This utility aids in capturing coding errors that are normally caught by a compiler in less dynamic languages. However, using the check option does not prevent the job from running, even if errors are encountered. The following characteristics apply to jobs running in check mode: Display of error related information only occurs after the job has

stopped. If the user manually stops a job, a message will appear stating that

warnings or errors were found in the script. If a job stops on its own (without manual intervention), the

message stating that errors or warnings were found can be seen when the user displays the history for that particular job's run ID.

Notes: In addition to displaying warnings for the script being run by

the job, warnings are also displayed for the entire package and all modules referenced by that job.

To view check mode error and warning details, FTP to Remote RMX-3200 and download the pycheck.out file in ASCII transfer mode. This file is stored in /jobdata/jobname/. (jobname specifies the job that ran in check mode.)

The following parameters are accepted: tag—Defines a property that controls a job for just one run. The

tag parameter is a temporary runtime property and is not stored in the running configuration. Multiple tag and value pairs can be present on the command line.

value—Defines the value of parameter tag.

WESTELL.COM

Page 5-28

1-800-377-8766



ExamplesThis example displays the running of job myjob, which is assigned a run ID of 9.

This example displays the running of job myjob in debug mode.

This example displays the running of job myjob in check mode.

debug Specifies that the job will run in debug mode. When in debug mode, prompt (Pdb) will appear. Several commands and key combinations are available for identifying debugging tools and options: ? (or help)—Lists all debug mode commands and topics or lists

information pertaining to a specific command (when entered directly preceding a command).

q (or CTRL+d)—Terminates the debug mode session.

Tip: Refer to www.python.org for how to use the debugger.

The following parameters are accepted: tag—Defines a property that controls a job for just one run. The

tag parameter is a temporary runtime property and is not stored in the running configuration. Multiple tag and value pairs can be present on the command line.

value—Defines the value of parameter tag.

job_name Defines the job being started.

(Dub)>exec-job myjob(Dub) exec-job myjob>runRun ID: 9(Dub) exec-job myjob>

(Dub)>exec-job myjob(Dub) exec-job myjob>run debugRun ID: 10Connecting to debugger session...> /var/ai-muse/jail/pkgdb/jobtestutils/JobTestUtils/JobTestUtils.py(35)run()-> def run (self, properties):(Pdb)

(Dub)>exec-job myjob(Dub) exec-job myjob>run checkRun ID: 11(Dub) exec-job myjob>

WESTELL.COM

1-800-377-8766

Page 5-29


This example displays the running of job myjob with tag polling_interval set to 60.


show jobs

show jobs name

(Dub)>exec-job myjob(Dub) exec-job myjob>run polling_interval=60

Column Description

Run ID Displays the job run ID.

WESTELL.COM

Page 5-30

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exec-job stop

exec-job stop

DescriptionThis command stops a job (or a group of jobs). When a job stops, a summary of its runtime statistics appears.

Formatsexec-job job_name stop

exec-job * stop [ using package ]

Parameters


ExamplesThis example displays the stopping of job myjob.

* Stops all jobs.

job_name Defines the job being started.

package Defines the package being used by jobs that will be stopped.

using Cancels all jobs using a specified package.

(Dub)>exec-job myjob(Dub) exec-job myjob>stopRun ID: 5Start: 2008/09/14 14:49:57End: 2008/09/14 14:50:06

Exit state: killed(Dub) exec-job myjob>

Column Description

Run id Displays the job run ID.

Start Displays the time the job started.

End Displays the time the job ended.

Exit state

Displays the state of the job upon exit. Possible values are normal, killed and abnormal.

WESTELL.COM

1-800-377-8766

Page 5-31

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exec-job stop

This example displays the stopping of all jobs that use package jobtestutils.


show jobs

show jobs name

(Dub)>exec-job *(Dub) exec-job *>stop using jobtestutilsJob Run ID Start time End time Exit statenewjob2 4 2008/09/15 11:34:45 2008/09/15 11:35:40 killedmyjob 8 2008/09/15 11:34:22 2008/09/15 11:35:41 killed(Dub) exec-job *>


Job Displays all jobs that were stopped.

Run ID Displays the run IDs for jobs that were stopped.

Start time Displays the times that running jobs started.

End time Displays the times that running jobs ended.

Exit state Displays the state of the job upon exit. Possible values are normal, killed and abnormal.

WESTELL.COM

Page 5-32

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exec-kill connection

exec-kill connection

DescriptionThis command terminates a specified mediation connection. A mediation connection is a point-to-point connection that goes through Remote RMX-3200.

Formatsexec-kill connection originator

Parameters


ExamplesThis example displays the termination of a mediation connection originated by tcp 10.40.57.5:40001:4.



show connections

originator Defines the event mediation connection originator. The following list gives examples of the structure of a mediation connection originator: tcp 10.40.57.5:40001:4

tl1mux 1-ne:1

Important: When entering the event originator for this command, be sure to include the internal reference number (4 and 1 in the examples) at the end of the entry.

Note: All active mediation connection originators are displayed with

command show connections on page 3-22. They can be cut-and-pasted into the exec-kill command to avoid excessive typing.

(Dub)>exec-kill(Dub) exec-kill>connection tcp 10.40.57.5:40001:4(Dub) exec-kill>

WESTELL.COM

1-800-377-8766

Page 5-33

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: exit

exit

DescriptionThis command navigates the user up one level within the command hierarchy. This command can navigate the user to the main prompt; however, it cannot be used to log out of the CLI.

Formatsexit


ExamplesThis example displays the exiting from the config ip command hierarchy and the returning of the user to the main prompt.

See Alsologout

(Dub)>config(Dub) config>ip(Dub) config ip>exit(Dub) config>exit(Dub)>

WESTELL.COM

Page 5-34

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: help

help

DescriptionThis command displays an explanation of how to use the ? command for Remote RMX-3200.

Formatshelp


ExamplesThis example displays an explanation of how to use the ? command.

(Dub)>helpYou can request help for a command at any time by enteringa question mark ('?'). The '?' displays the following typesof information for commands and/or command inputs:

- Usage statements- Available subcommands- Matching commands for partial inputs- Available local and global commands

The type of information displayed depends on where you enter the '?'.For more information on using help, refer to the command referenceguide.(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-35

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: logout

logout

DescriptionThis command ends a Remote RMX-3200 console or remote session.

Note: If a console session is terminated, a new login prompt and banner appear. If a

remote session is terminated, the connection is lost and the session window closes.

Formatslogout


ExamplesThis example displays the ending of a Remote RMX-3200 session.

See Alsoexit

(Dub)>logout

WESTELL.COM

Page 5-36

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: password

password

DescriptionThis command changes the password for the current user.

Formatspassword


ExamplesThis example displays the changing of the current user's password from test to test10.

See Alsoconfig users

(Dub)>passwordPlease enter the old password. ****Please enter the new password. ******Please confirm the new password. ******(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-37

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: ping

ping

DescriptionThis command sends a message (ICMP echo request packet) to a target device or network host to see if that device or host is online and responding. For Remote RMX-3200, this command will ping the specified address until CTRL+C is pressed.

Formatsping { hostname | ip_address }

[ size packet_size ][ source source_address ]

Parameters

Command Defaults56 for packet size


hostname Defines the hostname of the device that Remote RMX-3200 is attempting to ping.

ip_address Defines the IP address of the device that Remote RMX-3200 is attempting to ping.

size Initiates the specification of a size for the ICMP echo request packet being sent for each ping request. The following parameter is accepted:

packet_size—Defines the size (in bytes) of the ICMP echo request packet being sent for each ping request. Valid values are 1 to 65,507.

source Initiates the configuration of the source address from which ping request packets are sent. The following parameter is accepted:

source_address—Defines the source IP address. This IP address must be configured on a local interface.

WESTELL.COM

Page 5-38

1-800-377-8766


ExamplesThis example displays IP address 10.40.57.10 as it is pinged from Remote RMX-3200.

Important: To stop the execution of this command, press CTRL+c.

This example displays hostname www.yahoo.com as it is pinged from Remote RMX-3200.

(Dub)>ping 10.40.57.10PING 10.40.57.10 (10.40.57.10) from 10.40.57.13 : 56(84) bytes of data.64 bytes from 10.40.57.10: icmp_seq=1 ttl=60 time=4.66 ms64 bytes from 10.40.57.10: icmp_seq=2 ttl=60 time=2.91 ms64 bytes from 10.40.57.10: icmp_seq=3 ttl=60 time=2.87 ms64 bytes from 10.40.57.10: icmp_seq=4 ttl=60 time=2.87 ms

--- 10.40.57.10 ping statistics ---4 packets transmitted, 4 received, 0% loss, time 3029msrtt min/avg/max/mdev = 2.873/3.333/4.666/0.770 ms(Dub)>

Column Description

icmp_seq Displays the sequential value of each ICMP echo request packet that is sent. Sequential values increase by 1 with each packet that is sent.

ttl Displays the maximum number of IP routers that a packet can go through before being thrown away. TCP/IP specifications state that the TTL field for transmission control protocol packets should be set to 60.

time Displays the time in which each packet response was received.

(Dub)>ping www.yahoo.comPING www.yahoo.akadns.net (216.109.125.64) from 10.40.57.13 : 56(84) bytes of data.

64 bytes from w11.www.dcn.yahoo.com (216.109.125.64): icmp_seq=1 ttl=50 time=44.1 ms64 bytes from w11.www.dcn.yahoo.com (216.109.125.64): icmp_seq=2 ttl=50 time=37.3 ms64 bytes from w11.www.dcn.yahoo.com (216.109.125.64): icmp_seq=3 ttl=50 time=37.0 ms

--- www.yahoo.akadns.net ping statistics ---4 packets transmitted, 3 received, 25% loss, time 3031msrtt min/avg/max/mdev = 37.062/39.513/44.109/3.259 ms(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-39


This example displays IP address 10.25.2.5 as it is pinged from Remote RMX-3200 with packet size specification 70 and source address 10.40.57.5.

See Alsotelnet

ssh

(Dub)>ping 10.25.2.5 size 70 source 10.40.57.5PING 10.25.2.5 (10.25.2.5) from 10.40.57.5 : 70(98) bytes of data.78 bytes from 10.25.2.5: icmp_seq=1 ttl=126 time=1.07 ms78 bytes from 10.25.2.5: icmp_seq=2 ttl=126 time=0.874 ms78 bytes from 10.25.2.5: icmp_seq=3 ttl=126 time=0.977 ms78 bytes from 10.25.2.5: icmp_seq=4 ttl=126 time=0.892 ms78 bytes from 10.25.2.5: icmp_seq=5 ttl=126 time=0.879 ms78 bytes from 10.25.2.5: icmp_seq=6 ttl=126 time=0.977 ms

--- 10.25.2.5 ping statistics ---6 packets transmitted, 6 received, 0% loss, time 5048msrtt min/avg/max/mdev = 0.874/0.945/1.072/0.073 ms(Dub)>

WESTELL.COM

Page 5-40

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: reload

reload

DescriptionThis command resets Remote RMX-3200. Before a reset is issued, Remote RMX-3200 prompts to save the running configuration.

Formatsreload [ reason ]

Parameters


ExamplesThis example displays the saving of the running configuration and the resetting of Remote RMX-3200.


copy

reason Defines the reason why Remote RMX-3200 is being reset.

Tip: A system log file, which is generated before the reset, displays the reason why the reset occurred.

(Dub)>reloadDo you wish to save your running configuration? (y/N) nAre you sure you wish to reset? (y/N) y

System going down IMMEDIATELY!

WESTELL.COM

1-800-377-8766

Page 5-41

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: running-config

running-config

DescriptionThis command compiles and displays the current Remote RMX-3200 configuration. It displays recent user modifications to the configuration, such as interface configuration. The running configuration can be accessed anytime and by any user.


users with management and status profiles cannot view configuration information pertaining to users and other sensitive data.

Tip: This command performs exactly the same function as command show running-config.

Formatsrunning-config [ nopage ]

Parameters


ExamplesThis example displays the running configuration where the default route is set to 10.40.0.1, Remote RMX-3200 is set to never time out and a new user (techcomm) is configured.

nopage Displays the entire running configuration upon execution of the command. When this parameter is not specified, Remote RMX-3200 outputs the running configuration one page at a time.

(Dub)>running-config# Product: Remote RMX# Version: 3.30# Created: 2010-11-19,13:45:35.0,-0800# User: test# Stage2 Version: 4.06config clock timezone EST -05:00config clock daylight-savings DSTconfig ip route default 10.34.0.1config snmp host 10.34.3.102 162 public v2config ip route default 10.40.0.1config timeout 0config users add techcomm supervisor -e$1$A7S9eCkw$z9Vtb8r4SbCyO7RIZedt5/ -e$1$A

WESTELL.COM

Page 5-42

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: running-config

See Alsocopy

show running-config

WESTELL.COM

1-800-377-8766

Page 5-43

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: ssh

ssh

DescriptionThis command provides a secure encrypted connection that supports simple terminal and command access from the Remote RMX-3200 to remote network elements. The SSH client supports simple username/password authentication for outbound access to other network elements.

Formatsssh [-p port] [ user@ ] hostname [command]

Parameters

Command DefaultPort 22

Required User Profilesmanagement, supervisor, status

ExamplesThe following example displays the Remote RMX-3200 connecting to IP address 10.39.50.10.

See Alsotelnet

port Port being used to connect to a remote host.Default: 22.

user User name for authentication. If not specified, user will be prompted.

hostname IP address (v4 or v6) or host name of the remote host.

command Command to execute on the remote host. If a command is not provided, a login shell to the remote host is created.

(Dub)>ssh 10.39.50.10Please enter the user name: testWarning: Permanently added '10.39.50.10' (RSA) to the list of known hosts.

Password:(Dub)>

WESTELL.COM

Page 5-44

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: ssh

ping

WESTELL.COM

1-800-377-8766

Page 5-45

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: telnet

telnet

DescriptionThis command establishes a Telnet connection to a specified host or IP address.

Formatstelnet { hostname | ip_address } [ port ]

Parameters

Command DefaultsPort number 23


ExamplesThis example displays Remote RMX-3200 connecting to IP address 10.40.57.10.

See Alsoping

ssh

hostname Defines the host to which Remote RMX-3200 will establish a Telnet connection.

ip_address Defines the IP address to which Remote RMX-3200 will establish a Telnet connection.

port Defines the port number being used for Telnet service.

(Dub)>telnet 10.40.57.10Trying 10.40.57.10...Connected to 10.40.57.10.Escape character is '^]'.

AISwitch

login:

WESTELL.COM

Page 5-46

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: trace-route

trace-route

DescriptionThis command traces the route to a specified IP address or host and displays all hop numbers, locations and times associated with the route.

Formatstrace-route { hostname | ip_address } [ source source_address ]

Parameters


ExamplesThis example displays a traceroute to a device with IP address 10.40.57.10.

hostname Defines the hostname to which the traceroute will go.

ip_address Defines the IP address to which the traceroute will go.

source Initiates the configuration of the source address from which probe packets originate. The following parameter is accepted:

source_address—Defines the source IP address. This IP address must be configured on a local interface.

(Dub)>trace-route 10.40.57.10traceroute to 10.40.57.10 (10.40.57.10), 30 hops max, 40 byte packets 1 10.40.57.10 7.020 ms 3.860 ms 3.860 ms(Dub)>


40 byte packets

Displays the default length of individual probe datagram packets, which are empty packets sent to a specified address to determine if that address can be reached.

hops Displays the changes in location that probe datagram packets make from router to router on their way to a destination.

IP addresses Displays the addresses of devices on the route from the originating location to the destination location.

WESTELL.COM

1-800-377-8766

Page 5-47

Remote RMX-3200 Version 5.4x Command Reference GuideUtility Commands: trace-route

This example displays a traceroute to a host with hostname www.kentrox.com.

This example displays a traceroute from source address 10.40.57.5 to a host with IP address 10.25.2.20.

ms values Displays the amount of time it takes for probe datagram packets to make round trips to route locations (gateways). The default number of packets sent to each location is 3.

(Dub)>trace-route www.kentrox.comtraceroute to internet.kentrox.com (205.245.180.40), 30 hops max, 40 byte packets 1 ba1-vlan40-ve40.kentrox.priv (10.40.0.1) 1.074 ms 0.879 ms 0.841 ms 2 bigcore.kentrox.priv (10.1.0.1) 1.012 ms 0.707 ms 0.681 ms 3 host2500.kentrox.priv (10.0.0.1) 1.390 ms 1.377 ms 1.344 ms 4 web1.kentrox.com (205.245.180.40) 2.187 ms 1.438 ms 1.188 ms(Dub)>

(Dub)>trace-route 10.25.2.20 source 10.40.57.5traceroute to 10.25.2.20 (10.25.2.20) from 10.40.57.5, 30 hops max, 40 byte packets 1 10.40.0.1 2.681 ms 1.398 ms 1.415 ms 2 10.1.0.1 1.656 ms 1.323 ms 1.293 ms 3 10.25.2.20 1.671 ms 1.256 ms 1.222 ms(Dub)>


WESTELL.COM

Page 5-48

1-800-377-8766

APPEN

DIX A

Command Identifications

Command identifications are used when including and excluding commands for a user-defined profile. The IDs are contained in the supervisor command tree. For information on configuring user-defined profiles, refer to config profile on page 2-210.

Page A-1

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuideCommand Identifications

The following are some of the valid command identifications for Remote RMX-3200:

Commands Identifications

config /config

config action /config/action

config alarm-entry /config/alarm-entry

config apply-patch /config/apply-patch

config banner /config/banner

config clock /config/clock

config clock daylight-savings /config/clock/daylight-savings

config clock local-time /config/clock/local-time

config clock timezone /config/clock/timezone

config controller /config/controller

config controller bridge /config/controller/bridge

config controller ethernet /config/controller/eth

config controller ethernet assign /config/controller/eth/assign

config controller ethernet bridge /config/controller/eth/bridge

config controller ethernet description /config/controller/eth/description

config controller ethernet disable /config/controller/eth/disable

config controller ethernet enable /config/controller/eth/enable

config controller ethernethardware-address

/config/controller/eth/hwaddr

config controller ethernet mac-security /config/controller/eth/mac-security

config controller ethernet proxy-arp /config/controller/eth/proxy-arp

config controller ethernet speed /config/controller/eth/speed

config controller ethernet unassign /config/controller/eth/unassign

config controller nat64 /config/controller/nat64

WESTELL.COM

Page A-2

1-800-377-8766


config controller openvpn /config/controller/openvpn/

config controller serial (wan) /config/controller/wan

config correlation /config/correlation

config dhcp-relay /config/dhcp-relay

config dhcp-server /config/dhcp-server

config discrete /config/discrete

config event /config/event

config hostname /config/hostname

config interface /config/interface

config interface bridge /config/interface/bridge

config interface ethernet /config/interface/eth

config interface ethernet description /config/interface/eth/description

config interface ethernet disable /config/interface/eth/disable

config interface ethernet enable /config/interface/eth/enable

config interface ethernet ip /config/interface/eth/ip

config interface nat64 /config/interface/nat64

config interface openvpn /config/interface/openvpn

config interface serial /config/interface/wan

config ip /config/ip

config ip arp /config/ip/arp

config ip domain-name /config/ip/domain-name

config ip name-server /config/ip/name-server

config ip route /config/ip/route

config route-v6 /config/ip/route-v6

config iptables /config/iptables

Commands Identifications (Continued)

WESTELL.COM

1-800-377-8766

Page A-3


config iptables-v6 /config/iptables-v6

config jobs /config/jobs

config meas-table /config/meas-table

config mediation /config/mediation

config ntp /config/ntp

config ntp disable /config/ntp/disable

config ntp enable /config/ntp/enable

config ntp poll-interval /config/ntp/poll-interval

config ntp server /config/ntp/server

config peripheral /config/peripheral

config pkgs /config/pkgs

config profile /config/profile

config profile copy /config/profile/copy

config profile exclude /config/profile/exclude

config profile include /config/profile/include

config profile priv-lvl /config/profile/priv-lvl

config ras /config/ras

config ras accounting /config/ras/accounting

config ras authorization /config/ras/authorization

config ras retry /config/ras/retry

config ras server /config/ras/server

config ras shell /config/ras/shell

config ras timeout /config/ras/timeout

config remote-access /config/remote-access

config response /config/response


WESTELL.COM

Page A-4

1-800-377-8766


config snmp /config/snmp

config site control /config/site/control

config site module /config/site/module

config site network-element /config/site/network-element

config site network-element-set /config/site/network-element-set

config site network-elements status-points

/config/site/network-element/status-points

config site param /config/site/param

config snmp auth-trap /config/snmp/auth-trap

config snmp community /config/snmp/community

config snmp host /config/snmp/host

config tbos /config/tbos

config timeout /config/timeout

config use-wizard /config/use-wizard

config users /config/users

config users add /config/users/add

config users delete /config/users/delete

config users password /config/users/password

copy /copy

debug /debug

debug ethernet /debug/ethernet

debug ethernet all /debug/ethernet/all

debug ethernet controller /debug/ethernet/controller

debug ethernet interface /debug/ethernet/interface

debug level /debug/level

debug mediation /debug/mediation


WESTELL.COM

1-800-377-8766

Page A-5


debug serial /debug/serial/

diag /diag

diag break /diag/break

diag clear /diag/clear

diag controller /diag/controller

diag fan /diag/fan

diag ip route show /diag/ip/route/show

diag ip route-v6 show diag/ip/route-v6/show

diag line-monitor /diag/line-monitor

diag line-status /diag/line-status

diag mediation /diag/mediation

diag mmdisplay /diag/mmdisplay

diag output /diag/output

diag peripheral /diag/peripheral

diag ps /diag/ps

diag snapshot /diag/snapshot

diag tcpdump /diag/tcpdump

diag test /diag/test

diag top /diag/top

diag who /diag/who

diag whoami /diag/whoami

erase /erase

exec site control-action /exec/site/control-action

exec site install /exec/site/install

exec site uninstall /exec/site/uninstall


WESTELL.COM

Page A-6

1-800-377-8766


exec-job /exec-job

exit /exit

halt /halt

help /help

password /password

ping /ping

reload /reload

running-config /running-config

show /show

show actions /show/actions

show alarm-entries /show/alarm-entries

show audit /show/audit

show banner /show/banner

show bootp /show/bootp

show clock /show/clock

show compact-flash /show/compact-flash

show config-file /show/config-file

show connections /show/connections

show controllers /show/controllers

show controllers nat64 /show/controllers/nat64

show correlations /show/correlations

show debugging /show/debugging

show dhcp-relay /show/dhcp-relay

show dhcp-server /show/dhcp-server

show discrete /show/discrete


WESTELL.COM

1-800-377-8766

Page A-7


show events /show/events

show expansion-images /show/expansion-images

show interfaces /show/interfaces

show inventory /show/inventory

show ip /show/ip

show iptables /show/iptables

show jobs /show/jobs

show listeners /show/listeners

show licenses /show/licenses

show log-file /show/log-file

show meas-table /show/meas-table

show mediation /show/mediation

show ntp /show/ntp

show peripherals /show/peripherals

show pkgs /show/pkgs

show product /show/product

show profiles /show/profiles

show ras /show/ras

show remote-access /show/remote-access

show resource-tracking /show/resource-tracking

show responses /show/responses

show running-config /show/running-config

show site controls /show/site/controls

show site modules /show/site/modules

show site network-elements /show/site/network-elements


WESTELL.COM

Page A-8

1-800-377-8766


show site network-elements-sets /show/site/network-elements-sets

show site network-elementsstatus points

/show/site/network-elements/status-points

show site params /show/site/params

show snmp /show/snmp

show tbos /show/tbos

show test /show/test

show timeout /show/timeout

show users /show/users

show version /show/version

ssh /ssh

telnet /telnet

trace-route /trace-route


WESTELL.COM

1-800-377-8766

Page A-9


WESTELL.COM

Page A-10

1-800-377-8766

APPEN

DIX B

WAN Port Availability

This appendix provides information about WAN port availability on Remote RMX-3200.

Guide to this Appendix

WAN Port Availability

Remote RMX-3200 Models and Ports

Page B-1

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuideWAN Port Availability: WAN Port Availability

WAN Port AvailabilityTable 1 describes the expansion cards that support Remote RMX-3200 WAN ports.

Figure B-1 RMX WTE

Figure B-2 RMX WWAN

Table 1 WAN Expansion Cards

WAN Peripheral Description

RMX WTE A single card (shown in Figure B-1) that supports either Dual port or Drop and Continue (DAC) in either T1 or E1 mode, for a total of four permutations. See Table 2 for details.

RMX WWAN A single card (shown in Figure B-2) that supports an EvDO, HSPA or LTE phone module. See Table 2 for details.

RMX WGBE A single card (shown in Figure B-3) that supports 1000BaseT Ethernet and Fiber SFP connections. See Table 2 for details.

WESTELL.COM

Page B-2

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideWAN Port Availability: WAN Port Availability

Figure B-3 RMX WGBE

WESTELL.COM

1-800-377-8766

Page B-3

Remote RMX-3200 Version 5.4x Command Reference GuideWAN Port Availability: Remote RMX-3200 Models and Ports

Remote RMX-3200 Models and PortsTable 2 displays all available Remote RMX-3200 models, along with:

Associated WAN ports

Valid port number values as used in the CLI for corresponding WAN port types

Table 2 RMX-3200 Models and Associated Ports

Remote RMX-3200 Model WAN Port Option WAN Port Number

WTE-10 Dual T1 serial wan/1 and serial wan/2

WTE-11 T1 DAC serial wan/1 and serial wan/2

WTE-12 Dual E1 serial wan/1 and serial wan/2

WTE-13 E1 DAC serial wan/1 and serial wan/2

WWAN-21 EvDO serial wan/1

WWAN-31 HSPA serial wan/1

WWAN-43 LTE AT&T serial wan/1

WWAN-45 LTE SPRINT serial wan/1

WWAN-46 LTE VERIZON serial wan/1

WGBE-40 Gigabit Ethernet/Fiber SFP

ethernet wan/1, ethernet wan/2, ethernet wan/3, ethernet wan/4

WESTELL.COM

Page B-4

1-800-377-8766

IND

EX

Index

Symbols? (command) 5-35

Numerics802.1Q tags 2-33

Aaction

display 3-5address

ipv6 2-122address configuration for a TBOS

server 2-276AID configuration

for a TL1 environmental alarm response 2-238

for a TL1 equipment alarm response 2-241

for an alarm-entry 2-12alarm code configuration


for a TL1 equipment alarm response 2-241

alarm entry display 3-8alarm message text configuration


alarm states, resetting 4-5alarm type configuration for a TL1

environmental alarm response 2-239

alarm-entry configuration commands 2-6–2-11

alarm nagging settings 2-10events that activate an alarm-

entry 2-9

allow-access 2-43analog event originator 2-103application mode configuration for

an asynchronous serial controller 2-49

ARP cacheconfiguration 2-135display 3-93

asynchronous serial port monitoring 4-39

audited action display 3-12authority for a DHCP server 2-79

Bband configuration for a discrete

analog input 2-89banner

configuration of 2-17display of 3-16

baud rate configuration 2-50bit error rate test 4-10bit-level encoding 2-53BOOTP/DHCP

relay 3-63relay agent 2-77server 2-77, 3-63

break propagation 2-231bridge

PDU 2-27priority value 2-27

bridge controller configuration 2-25

STP 2-26bridge controller display 3-26bridge interface configuration 2-

118bridge interface display 3-81bridging mode 2-33

native 2-33

port VLAN 2-33broadcast configuration for a

DHCP server 2-79broadcast packets 2-79buildout 2-50

Ccapture of job output 2-142categories for alarm entries 2-7channel group

throughput speed 2-60timeslot 2-60

CHAP and PAP authenticationidentity 2-70local identity and secret

configuration 2-70method 2-71remote identity and secret

configuration 2-71check mode for a running job 5-28CLI, using the 1-1–1-9

abbreviated command entry 1-6

command help 1-7command types 2-4, 3-5, 4-4,

5-4navigation and command entry

1-4, 2-6client-route 2-43, 3-36clock configuration 2-19clock source for a serial controller

2-50command entry

abbreviated 1-6parameters with spaces 1-5

command help, overview 1-7command patterns 3-121command usage statements,

displaying 1-8

Page 1-1

WESTELL.COM

Remote RMX-3200 Version 5.4x Command Reference GuideIndex: D

compact flash card 3-18condition description configuration for a

TL1 equipment alarm response 2-241

condition type configuration for a TL1 equipment alarm response 2-241

config 2-176apply-patch 2-15banner 2-17clock 2-19dhcp-relay 2-77hostname 2-117ip 2-134iptables 2-138meas-table 2-154peripheral 2-196profile 2-210remote access 2-217remote-access 2-217response 2-220site control 2-244site module 2-246site param 2-254sitebus 2-255snmp 2-163, 2-166, 2-176, 2-181, 2-

257tbos load 2-263tbos port serial 2-265tbos server 2-276timeout 2-278users 2-282use-wizard 2-280

config alarm-entry 2-6event 2-9nagging 2-10tl1 2-11

config clock 2-19daylight-savings 2-21

config controller bridge switch 2-25stp 2-26

config controller ethernet 2-29bridge switch 2-33bridge switch stp 2-35mac-security 2-37

config controller nat64 2-40config controller openvpn 2-42

deleting 2-40, 2-42resetting 2-40, 2-42

config controller serial 2-47bridge switch 2-57channel-group group 2-59connect 2-62disconnect 2-66encapsulation 2-68

config dhcp-relay 2-77config dhcp-server 2-79

interface 2-83subnet 2-84

config discreteanalog 2-88input 2-95

config event 2-100content 2-102

config interfacebridge switch 2-118

ip 2-119ip dhcp 2-120ipv6 2-122

ethernet 2-124ip 2-125ipv6 2-127

openvpn 2-130serial 2-132

config interface nat64 2-129config iptables-v6 2-139config jobs

name 2-142config jobs name task 2-148config mediation

tl1 command 2-186, 2-187tl1mux 2-189tl1ne 2-191

config mediation snmpevent-template 2-163manager 2-166measurement-template 2-167ne-template 2-173point-template 2-176

config mediation snmpne 2-181config ntp 2-194config pkgs

install 2-199on-demand-install 2-204server 2-206server configuration 2-206uninstall 2-208

config ras 2-212server 2-214

config response 2-220content 2-222

config response contentconnect 2-230tl1alarm 2-236tl1envalarm 2-238tl1eqptalarm 2-240

config sitenetwork element 2-248

config site network-element-set 2-251config tbos

load 2-263config tbos port serial

cut-through 2-267display 2-268display point 2-273

configuration filescopy of 5-4display of 3-19for a DHCP server 2-80

configuration wizards 2-280connect response

configuration 2-230responders 2-233

connect string for a serial connection 2-64

connection event types 2-111connection string for a TL1 multiplexer 2-

189controller display 3-24, 3-35controllers

display of 3-24copy 5-4counters

for interfaces 3-78, 3-88cron start

display 3-106cron-start for a job 2-142cut-through support for a TBOS serial

port 2-267

Ddata received event type 2-112data-link layer address 2-30, 2-82daylight savings time

configuration 2-21display of 3-17

debugEthernet 5-7level 5-9mediation 5-10openvpn 5-15ppp 5-17serial 5-19snmp 5-14, 5-21

debug information loggingfor mediation 5-10for OpenVPN 5-15for PPP encapsulation 5-17for serial controllers and interfaces 5-

19debug mode for a running job 5-29debug modem 5-14debug status display 3-61debug wan/1 5-23default alarm-table entries for digital

inputs 2-95destination data string, for a connect

response 2-231destination for a mediation connection 2-

231dgram 2-152DHCP packets 2-77DHCP server

configuration 2-79DHCPNAK messages 2-79display of information 3-64hardware address for a host 2-82IP address for a host 2-82

DHCP server subnetdefault lease 2-85domain name server 2-85maximum lease 2-86

WESTELL.COM

Page 1-2

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideIndex: E

range 2-86router 2-86

dhcp-relay 2-77diag

break 4-4clear 4-5fan 4-18ip address show 4-19line-monitor 4-39line-status 4-41mediation snmpne poll 4-42mmdisplay 4-43peripheral reload 4-46ps 4-48snapshot 4-51tcpdump 4-52test alarm entry 4-57test mode 4-59top 4-60usb 4-63who 4-64whoami 4-65

diag controllerbridge switch dhcp 4-7openvpn 4-8serial 4-10serial loopback 4-16serial wan/1 4-13

diag controller serialbert 4-8loopback 4-13, 4-16

diag ipaddress show 4-19link show 4-24neighbor show 4-28

diag ip routeget 4-30show 4-33

diag ip route-v6show 4-33

diag mediation snmpne poll 4-42, 4-59diag peripheral

reload 4-46diagnostic commands 4-4–4-65

for creating file snapshot.tar.gz 4-51for displaying IP address information

4-19for displaying IP packet headers 4-52for displaying link information 4-24for displaying logged in users 4-64for displaying neighbor information 4-

28for displaying route information 4-30,

4-33for displaying running processes 4-48for displaying the terminal name 4-65for displaying top CPU processes 4-60for finding a route 4-30for resetting a peripheral 4-46for suppressing fan operation 4-18

for terminating a shell connection 4-4diagnostic settings for a serial WAN link

4-10digital input configuration 2-95digital output

opening and closing 4-45resource tracking 2-98

digital output configuration 2-98directory configuration for a TBOS server

2-276disconnect mode 2-66discrete analog input

band configuration 2-89disable of 2-89enable of 2-89lowest valid current 2-92maximum current configuration 2-91resource tracking 2-88voltage input 2-93

discrete expansion peripheral configuration 2-196

discrete point display 3-67DNS server

configuration 2-135display 3-93

domain nameconfiguration 2-135display 3-93

down event type 2-112DTR 2-62, 2-66Duplex operation 2-31dynamic entries 2-27

Eencapsulation formats for

communications 2-68erase 5-23Ethernet controller

configuration 2-29debugging 5-7description 2-29display 3-30hardware address 2-30path cost 2-35priority level 2-35speed 2-31

Ethernet event originator 2-104Ethernet interface

configuration 2-124debugging 5-7description 2-124display 3-85IP address 2-125

event 2-163configuration 2-100display 3-59, 3-72originators 2-103–2-111types 2-111–2-114

event correlation 2-74

event correlations 3-59event template 2-163event-templates 3-121exec site

control-action 5-24install 5-25uninstall 5-26

exec-jobrun 5-27stop 5-31

exec-kill connection 5-33exit 5-34exit states for a job 3-101, 3-105

Ffan suppression 4-18filter table 2-138, 2-139filtering database 2-27forward

delay time for STP 2-27status display 3-93

forwarding state 2-27framing format 2-52FTP server

server configuration 2-206

GGMT timestamp configuration 2-19

Hhardware

address 2-30components, display 3-92information display 3-142

hello time interval 2-27help 5-35high event 2-89, 2-90hostname configuration 2-117HTTP remote access protocol 2-217hysteresis configuration 2-90

IICMP echo request packet 5-38identity for CHAP and PAP

authentication 2-70in-band event 2-89, 2-90in-band event type 2-112incoming connection event type 2-112initialization event type 2-111input event originator 2-105input saturated event type 2-112input_saturated event 2-91interface configuration for a DHCP server

2-83interface display 3-78, 3-88

WESTELL.COM

1-800-377-8766

Page 1-3

Remote RMX-3200 Version 5.4x Command Reference GuideIndex: J

interface, adding to a bridge group 2-118interval event type 2-112IP address display 4-19IP configuration 2-134IP forwarding 2-135IP packet headers, display 4-52IP table rule and interface counters,

clearing 4-5iptables configuration 2-138, 2-139

Jjobs

attribute display 3-100configuration 2-142exit states 3-101, 3-102, 3-105, 5-31history display 3-100history runs display 3-100identical start times 2-144information display 3-100manually stopping 2-145package version level selection 2-144property configuration 2-143restart configuration 2-145run count 3-100runs, resetting 2-141runtime

information display 3-103statistics display 5-31

startID number assignment 2-144

start time specification 2-144statistics display 3-100summary display 3-100tasks

configuration 2-148

LLCP and NCP negotiation 5-17LCP echo requests 2-70learning state 2-27line loopback mode 4-16, 4-17linecode 2-53linemode

asynchronous serial controller configuration 2-53

settings 2-53listening state 2-27local and global commands, displaying

available 1-9local CHAP and PAP authentication

settings 2-70local time

display 3-17local time configuration 2-19log file 3-113logged in user display 4-64logging out of a console or remote

session 5-36

login bannerconfiguration 2-17display 3-16

logout 5-36loopback mode

configuration 4-16line 4-16, 4-17payload 4-16, 4-17

loss-of-signal event type 2-113low band threshold 2-113low event 2-89low event type 2-113

MMAC address

capture 2-38table entry 2-37

MAC security 2-37mac-violation event type 2-113management information base 2-258management station

configuration 2-259managing a peripheralperipheral

managing 2-197mangle table 2-138, 2-139maximum age for STP 2-27maximum current configuration for

discrete analog inputs 2-91MDI-X 2-31mediation configuration commands

TL1 command pattern configuration 2-186, 2-187

TL1 multiplexer configuration 2-189virtual TL1 NE configuration 2-191

mediation connection destination 2-231mediation connection listeners

displaying 3-111mediation connections

display 3-22termination 5-33

mediation debugging 5-10mediation display 3-120mediation messages

display 4-43display settings 4-43

mediation SNMP network elements 2-181

mediation timerdisplay 3-189

memory configuration for jobs 2-143memory limits for a job 2-143message string configuration for a TL1

alarm response 2-237metric, relationship to cost 2-35, 2-58MRU 2-71MTU 2-71

N

nagging 2-10nat table 2-138nat64 2-40navigating the command hierarchy 5-34navigation keys 1-4NE satus points 3-166NE template 2-173network element and alarm entries 2-7network element sets

configuring 2-251definition of 2-251displaying information for 3-173instance 2-251

network topology change 2-27notification code configuration for a TL1

environmental alarm response 2-239

notification code configuration for a TL1 equipment alarm response 2-241

NTPpoll interval 2-194preferred server 2-195server 2-195

ntp 2-194NTP configuration 2-194

display 3-133

Ooffline event type 2-113on demand install of packages 2-204online event type 2-113open event type 2-113OpenVPN debugging 5-15openVPN interface configuration 2-130originator 5-33output capture display 3-107

Ppackage display 3-138package installation 2-199package server

address configuration 2-206directory configuration 2-206user configuration 2-207

packagesminimum required version level 2-204missing packages 2-204on-demand-install 2-204uninstallation of 2-208version levels for 2-144

packet-level debugging 5-17parity, asynchronous serial controller

configuration of 2-54part number 3-142partial command inputs, displaying 1-9patch files 2-15path cost 2-35payload loopback mode 4-16, 4-17

WESTELL.COM

Page 1-4

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideIndex: R

per-call modem dial string 2-231, 2-232peripheral

display of information 3-134event originator 2-106management 2-197type configuration 2-197

ping 5-38point display 3-67point template 2-176point-template 2-176point-templates 3-121poll oid 2-177PPP 2-71, 5-17priority level 2-35product

components, display of 3-92information display 3-142

prompt display configuration 2-117proxy ARP 2-31PyChecker utility 5-28

RRADIUS 2-214RAS

configuration display 3-145RADIUS 2-214server configuration 2-214TACACS+ 2-214

RAS configuration commandsfor the primary and secondary server

2-214RAS counters, clearing 4-5raw response information for an alarm-

entries 2-7records of job runs 2-140reload 5-41remote CHAP and PAP authentication

settings 2-71remote identity and secret

configuration for CHAP and PAP authentication 2-71

remote-access status display 3-148reset for the system 5-41resource tracking

display 3-149for a digital output 2-98for digital inputs 2-95for Ethernet controllers 2-29of a discrete analog input 2-88

responders 2-225response configuration commands

connect response configuration 2-230response content settings 2-222response display 3-150responses

closing a relay output 2-222disabling a component 2-223enabling a component 2-223interval response 2-223

latch on/off for a TBOS control point 2-223

momentary "on" for a TBOS control point 2-224

opening an output 2-224restarting a timer 2-224stopping a timer 2-224timer life configuration 2-224user.log configuration 2-225

RMB peripheral unithumidity sensor 2-90sitebus 2-255

root bridge 2-27route-v6

configuration 2-136routing table display 3-93rtrv-hdr command logon requirement 2-

192RTS 2-63, 2-67run count history 3-100running a job 5-27running process display 4-48running-config 3-153, 5-42runtime statistics display for a job 5-31

Sscript configuration for a job 2-144sensor

input 2-89, 2-91, 2-92output current 2-91, 2-92

serial channel group event originator 2-107

serial controller configurationapplication mode 2-49disconnect mode 2-66encapsulation protocol 2-68in a bridge group 2-57linemode configuration 2-53parity configuration 2-54stop bit 2-55

serial controller connection settingsconnect mode 2-63connect string 2-64DTR 2-62RTS 2-63

serial controller description 2-51serial controller disconnect settings

disconnect mode 2-66DTR 2-66RTS 2-67

serial controller display 3-40serial event originator 2-107serial interface

configuration 2-132display 3-88, 3-90IP address 2-133

serial wan/1 event originator 2-107service effect caused by a TL1

equipment alarm condition 2-242

service effect configuration for a TL1 environmental alarm condition 2-239

severity levels 2-9shell connection termination 3-5, 4-4, 5-4show

actions 3-5, 5-4alarm-entries 3-8audit 3-12banner 3-16clock 3-17compact-flash 3-18config-file 3-19connections 3-22controllers 3-24, 3-35debugging 3-61dhcp-relay 3-63dhcp-server 3-64discrete 3-67events 3-59, 3-72expansion-images 3-74fan 3-77interfaces 3-78, 3-88inventory 3-92ip 3-93iptables 3-97jobs 3-100log-file 3-113meas-table 3-116mediation 3-120ntp 3-133peripherals 3-134pkgs 3-138product 3-142profiles 3-143ras 3-145remote-access 3-148resource-tracking 3-149responses 3-150running-config 3-153site controls 3-160site modules 3-163site network-elements-sets 3-173site param 3-176sitebus 3-155snmp 3-177tbos 3-181test alarm-entries 3-185test mode 3-187timeout 3-188timers 3-189users 3-190

show controllersbridge 3-26ethernet 3-30openvpn 3-35serial 3-40

show controllers nat64 3-34show correlations 3-59show interfaces

bridge 3-81

WESTELL.COM

1-800-377-8766

Page 1-5

Remote RMX-3200 Version 5.4x Command Reference GuideIndex: T

ethernet 3-85openvpn 3-88serial 3-90

show licenses 3-110show listeners 3-111show site

network-elements-sets 3-173params 3-176

signal good event type 2-114sitebus configuration 2-255SNMP 2-181

authentication failure traps 2-258community strings 2-258community types 2-258, 2-259event template 2-163management stations 2-259manager 2-166NE template 2-173network elements 2-181point template 2-176setting display 3-177trap support for alarm entries 2-8

snmpmanager 2-166measurement-template 2-167point template 2-176

SNMP displaycommunity strings 3-177management stations 3-177summary 3-177

SNMP event templates 3-125SNMP manager 3-121SNMP network elements 3-121source data string for a connect response

2-232spanning tree protocol 2-26speed, for a channel group 2-60ssh 5-44SSH and SFTP remote access protocols

2-218stage 2 bootloader 3-74standard error/output 2-142start at boot up for a job 2-145start attempt configuration for a job 2-145start time configuration for a job 2-144static route configuration 2-136statistical counters, clearing 4-10status point configuration on a TBOS

alarm display 2-270status point polling 2-273status points 3-166stderr 2-142stdout 2-142stop bits

asynchronous serial controller configuration of 2-55

stopping a job 5-31STP

path cost configurationfor a serial WAN controller 2-58

priority level configuration

for a serial WAN controller 2-58stream 2-152strong password 2-282subcommands, displaying 1-9summary display

of job runtime statistics 5-31system

configuration compilation 3-153, 5-42configuration display 3-153, 5-42log-file display 3-113timeout interval display 3-188

system event originator 2-109

TT1/E1

line framing format 2-52TAB key functionality in the CLI 1-5tacacs 2-186TACACS+ 2-214tacacs-service 2-186task display for a job 3-104TBOS

alarm display configuration 2-268definition files, loading 2-263equipment type definitions 2-263loading a TBOS definition file 2-263polling on individual status points 2-

273port configuration display 3-181server configuration 2-276server configuration display 3-181server login information 2-276status point messages 2-274

TCPevent originator 2-110

tcpdump 4-52telnet 5-46Telnet and FTP remote access protocols

2-218telnet event originator 2-110terminal name, for a connection 4-4TID for a virtual TL1 NE 2-192time and date display 3-17time configuration commands 2-19–2-21time, ping display 5-39timeout interval for the system 2-278timer

display 3-189timeslot, for a channel group 2-60timestamp configuration 2-19timezone

display of 3-17timezone configuration 2-19timing out the system 2-278title configuration for a job 2-145TL1 AID for an alarm-entry 2-12TL1 alarm

condition type 2-13for an environmental event 2-13

for equipment-related events 2-13for non-service-affecting condition 2-

13for service-affecting condition 2-13

TL1 alarm code for a TL1 alarm response 2-236

TL1 alarm responseTL1 message string 2-237

TL1 alarm response configuration 2-236TL1 command

command pattern generation 2-186, 2-187

TL1 environmental alarm response configuration 2-238

TL1 equipment alarm response configuration 2-240

TL1 message string for a TL1 alarm response 2-237

TL1 multiplexerconfiguration of a 2-189display 3-122event originator 2-111

TL1 multiplexer connection string 2-189TL1 NE

configuration of a 2-191TL1 session logon requirements 2-191TL1 settings for an alarm-entry 2-11TL1 text block for a TL1 alarm response

2-236tl1command 2-187tl1mux 2-189tl1ne 2-191top CPU process display 4-60trace-route 5-47trap table 2-259ttl 5-39

Uunit 2-31, 3-30units for analog inputs 2-93up event type 2-114usage statements 1-8user

authentication and provisioning 2-214user configuration commands

password 5-37username and password for a virtual TL1

NE 2-192users

adding 2-282authentication and provisioning 2-212deleting 2-282display of 3-190display of all 4-64password change 2-282resetting 2-282

utility commandscopy 5-4erase 5-23

WESTELL.COM

Page 1-6

1-800-377-8766

Remote RMX-3200 Version 5.4x Command Reference GuideIndex: V

exit 5-34help 5-35logout 5-36overview 1-3ping 5-38reload 5-41running-config 5-42telnet 5-46trace-route 5-47

Vvarbind 2-178virtual TL1 NE

configuration of a 2-191display of a 3-122

virtual TL1 NE configuration for TL1 alarms 2-8VLAN identifier configuration 2-33voltage input for a discrete analog input 2-93

WWAN

port types B-2WAN port availability B-2wizards 2-280

WESTELL.COM

1-800-377-8766

Page 1-7

Remote RMX-3200 Version 5.4x Command Reference GuideIndex: W

WESTELL.COM

Page 1-8

1-800-377-8766

Page Copyrights-1

WESTELL.COM

COPYRIG

HTS

Copyright © 1983-2014 by Kentrox® and/or Westell Technologies®, Inc.The material discussed in this publication is the proprietary property of Westell. Westell retains all rights to reproduction and distribution of this publication.

This product includes software copyrighted by the GNU General Public License and/or the GNU Lesser General Public License. The source for the GPL portions of the software is available at www.westell.com/support.

TRADEMARKS:Kentrox, the Kentrox logo, and other names are intellectual property of Westell, Inc.

Linux is a registered trademark of Linus Torvalds.

All other trademarks or registered trademarks appearing in this publication are property of their respective companies.

To view entire license files and copyright statements for all open source code used in this product, refer to the instructions in show licenses on page 3-110.

Copyrights and License Statements

http://www.westell.com/support