remote rmm-1400 command reference guide version...

© Westell Technologies

Part # 030-101896 Rev A

WESTELL.COM

COM

MA

ND

REFERENCE G

UID

E

Command Reference GuideVersion 6.4x

Remote RMM-1400

WESTELL.COM

Remote RMM-1400 Version 6.4x Command Reference Guide:

1-800-377-8766

Copyright © 2016 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 Aurora, Illinois, to verify current product information. Westell Inc. is an Equal Opportunity/Affirmative Action employer.

Westell, Inc.750 North Commons DriveAurora, Illinois 60504 USAToll Free: (800) 377-8766

International: +1 (630) 375-4950Fax: +1 (630) 375-4931

TABLE O

F CON

TENTS

Table of Contents

Preface.............................................................................................Preface-iAbout this Document............................................................................................Preface-iDocument Conventions....................................................................................... Preface-iiCustomer Assistance ......................................................................................... Preface-iv

Chapter 1: CLI Overview........................................................................1-1Accessing the Command Line Interface ...................................................................... 1-2

Viewing Global Commands .............................................................................. 1-2Command Types.......................................................................................................... 1-3

Configuration Commands................................................................................. 1-3Show Commands ............................................................................................. 1-3Diagnostic Commands ..................................................................................... 1-3Utility Commands ............................................................................................. 1-3

CLI Navigation and Command Entry............................................................................ 1-4Navigation Keys ............................................................................................... 1-4Parameter Values with Spaces ........................................................................ 1-5Abbreviated Command Entry ........................................................................... 1-6

Command Help ............................................................................................................ 1-7Using the Help Command ................................................................................ 1-7Using the ? ....................................................................................................... 1-7

CLI Command Descriptions ....................................................................................... 1-10

Chapter 2: Configuration Commands......................................................2-1Config Command Overview ......................................................................................... 2-2

Page TOC-1

WESTELL.COM

Remote RMM-1400 Version 6.4x Command Reference GuideTable of Contents

List of Config Commands............................................................................................. 2-3config action ................................................................................................................. 2-4config alarm-entry ........................................................................................................ 2-6

config alarm-entry event................................................................................... 2-8config alarm-entry nagging............................................................................. 2-11

config apply-patch ...................................................................................................... 2-13config banner ............................................................................................................. 2-15config clock ................................................................................................................ 2-17

config clock daylight savings .......................................................................... 2-19config controller bridge switch.................................................................................... 2-23config controller ethernet............................................................................................ 2-25config controller ethernet bridge switch...................................................................... 2-28config controller nat64................................................................................................ 2-29config controller openvpn ........................................................................................... 2-31config controller serial ................................................................................................ 2-36

config controller serial connect....................................................................... 2-41config controller serial disconnect .................................................................. 2-45config controller serial encapsulation ............................................................. 2-47

config correlation........................................................................................................ 2-51config dhcp-relay........................................................................................................ 2-54config dhcp-server...................................................................................................... 2-56

config dhcp-server host .................................................................................. 2-58config dhcp-server interface ........................................................................... 2-60config dhcp-server subnet .............................................................................. 2-61

config discrete analog ................................................................................................ 2-65config discrete input ................................................................................................... 2-71config discrete output ................................................................................................. 2-73config event................................................................................................................ 2-75config event content ................................................................................................... 2-77config hostname......................................................................................................... 2-87config interface bridge switch..................................................................................... 2-88

config interface bridge switch ip ..................................................................... 2-89config interface bridge switch ip dhcp ............................................................ 2-90config interface bridge switch ipv6 ................................................................. 2-92config interface bridge switch nat64 ............................................................... 2-94

config interface ethernet............................................................................................. 2-95config interface ethernet ip ............................................................................. 2-96config interface ethernet ipv6 ......................................................................... 2-98config interface ethernet nat64....................................................................... 2-99

config interface openvpn .......................................................................................... 2-100config interface serial ............................................................................................... 2-102

WESTELL.COM

Page TOC-2

1-800-377-8766


config ip ....................................................................................................................2-104config iptables ..........................................................................................................2-108config iptables-v6 .....................................................................................................2-109config jobs ................................................................................................................2-110config jobs name ......................................................................................................2-112config jobs name task...............................................................................................2-118config meas-table .....................................................................................................2-123

config meas-table entry ................................................................................ 2-124config mediation snmp event-template.....................................................................2-131config mediation snmp manager ..............................................................................2-134config mediation snmp measurement-template .......................................................2-135config mediation snmp ne-template .........................................................................2-141config mediation snmp point-template......................................................................2-144config mediation snmpne .........................................................................................2-149config mediation tacacs-service ...............................................................................2-154config ntp..................................................................................................................2-155config peripheral.......................................................................................................2-157config pkgs install .....................................................................................................2-160config pkgs on-demand-install..................................................................................2-164config pkgs server ....................................................................................................2-166config pkgs uninstall .................................................................................................2-168config profile .............................................................................................................2-170config ras..................................................................................................................2-172

config ras server ........................................................................................... 2-174config remote-access ...............................................................................................2-177config response ........................................................................................................2-180config response content ...........................................................................................2-182

config response content connect.................................................................. 2-188config site control .....................................................................................................2-194config site module ....................................................................................................2-196config site network-element......................................................................................2-198config site network-element-set................................................................................2-201config site param ......................................................................................................2-204config sitebus ...........................................................................................................2-205config snmp ..............................................................................................................2-207config timeout ...........................................................................................................2-213config use-wizard .....................................................................................................2-215config users ..............................................................................................................2-217

Chapter 3: Show Commands ................................................................. 3-1Show Command Overview...........................................................................................3-2

WESTELL.COM

1-800-377-8766

Page TOC-3


List of Show Commands .............................................................................................. 3-3List of Show Commands (continued) ........................................................................... 3-4show 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-29show controllers nat64 ............................................................................................... 3-32show controllers openvpn .......................................................................................... 3-33show controllers serial................................................................................................ 3-38show correlations ....................................................................................................... 3-44show debugging ......................................................................................................... 3-46show dhcp-relay ......................................................................................................... 3-48show dhcp-server....................................................................................................... 3-49show discrete ............................................................................................................. 3-52show events ............................................................................................................... 3-57show expansion-images............................................................................................. 3-59show interfaces .......................................................................................................... 3-62show interfaces bridge ............................................................................................... 3-64show interfaces ethernet ............................................................................................ 3-67show interfaces openvpn ........................................................................................... 3-70show interfaces serial modem.................................................................................... 3-72show inventory ........................................................................................................... 3-74show ip ....................................................................................................................... 3-75show iptables ............................................................................................................. 3-79show jobs ................................................................................................................... 3-82show jobs name ......................................................................................................... 3-85show licenses............................................................................................................. 3-91show listeners ............................................................................................................ 3-93show log-file ............................................................................................................... 3-94show meas-table ........................................................................................................ 3-96show mediation ........................................................................................................ 3-100show ntp................................................................................................................... 3-109show peripherals ...................................................................................................... 3-110show pkgs ................................................................................................................ 3-114

WESTELL.COM

Page TOC-4

1-800-377-8766


show product ............................................................................................................3-118show profiles ............................................................................................................3-119show ras ...................................................................................................................3-121show remote-access ................................................................................................3-124show resource-tracking ............................................................................................3-125show responses .......................................................................................................3-126show running-config .................................................................................................3-128show sitebus.............................................................................................................3-130show site controls.....................................................................................................3-134show site modules....................................................................................................3-137show site network-elements .....................................................................................3-140show site network-elements-sets .............................................................................3-147show site params .....................................................................................................3-150show snmp ...............................................................................................................3-152show test alarm-entries ............................................................................................3-156show test mode ........................................................................................................3-158show timeout ............................................................................................................3-159show timers ..............................................................................................................3-160show users ...............................................................................................................3-161show version ............................................................................................................3-162

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 modem ......................................................................................4-10diag ip address show..................................................................................................4-13diag ip link show .........................................................................................................4-18diag ip neighbor show ................................................................................................4-22diag ip route get..........................................................................................................4-24diag ip route and route-v6 show .................................................................................4-27diag line-monitor.........................................................................................................4-34diag line-status ...........................................................................................................4-36diag mediation snmpne poll........................................................................................4-37diag mmdisplay ..........................................................................................................4-38diag output..................................................................................................................4-40diag peripheral reload.................................................................................................4-41diag ps........................................................................................................................4-43

WESTELL.COM

1-800-377-8766

Page TOC-5


diag remote-access.................................................................................................... 4-46diag snapshot............................................................................................................. 4-49diag tcpdump.............................................................................................................. 4-50diag test alarm-entry .................................................................................................. 4-55diag test mode............................................................................................................ 4-57diag top ...................................................................................................................... 4-58diag who..................................................................................................................... 4-62diag whoami ............................................................................................................... 4-63

Chapter 5: Utility Commands ..................................................................5-1Utility Commands Overview ......................................................................................... 5-2List of Utility Commands .............................................................................................. 5-3copy.............................................................................................................................. 5-4debug ethernet ............................................................................................................. 5-8debug level................................................................................................................. 5-10debug mediation......................................................................................................... 5-11debug modem ............................................................................................................ 5-14debug openvpn .......................................................................................................... 5-15debug ppp .................................................................................................................. 5-17debug site................................................................................................................... 5-19debug snmp ............................................................................................................... 5-20erase .......................................................................................................................... 5-21exec site control-action .............................................................................................. 5-22exec site install........................................................................................................... 5-23exec site uninstall....................................................................................................... 5-24exec-job run ............................................................................................................... 5-25exec-job stop.............................................................................................................. 5-29exec-kill connection.................................................................................................... 5-31exit.............................................................................................................................. 5-32help ............................................................................................................................ 5-33logout ......................................................................................................................... 5-34password.................................................................................................................... 5-35ping ............................................................................................................................ 5-36reload ......................................................................................................................... 5-38running-config ............................................................................................................ 5-39ssh.............................................................................................................................. 5-41telnet .......................................................................................................................... 5-42trace-route.................................................................................................................. 5-44

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

WESTELL.COM

Page TOC-6

1-800-377-8766


Appendix B: Command Access by Permission Levels........................... B-1Access Levels for All Commands................................................................................ B-2

Index ...................................................................................................Index1

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

WESTELL.COM

1-800-377-8766

Page TOC-7


WESTELL.COM

Page TOC-8

1-800-377-8766

PREFACE

Preface

Page Preface-i

About this Document

This document provides a reference for all the commands in the Remote RMM-1400 intelligent remote site management device command line interface (CLI). For scenarios on using the Remote RMM-1400 commands, refer to the Remote RMM-1400 Configuration Guide. For instructions on using the Remote RMM-1400 web interface, refer to the Kentrox Remote Web Interface User Guide.

Remote RMM-1400 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 RMM-1400 Version 6.4x Command Reference GuidePreface:

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 (+).

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

WESTELL.COM

Page Preface-ii

1-800-377-8766


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.

CAUTION:

Caution messages indicate that failure to take a specified action could result in loss of data and/or harm to the software or hardware.

Table 1 Document Conventions (Continued)

Convention Meaning

WESTELL.COM

1-800-377-8766

Page Preface-iii


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

Pre-sales Support

Westell offers pre-sales technical support from 9 a.m. to 5 p.m. Eastern time, Monday - Friday. Representatives are standing by to assist with customer account information and product ordering and answer questions regarding Westell products and solutions.

Phone number: 800-377-8766, option 1

Before you call or email

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

The versions 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 Technical Support

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

To contact Technical Support, send email to:

[email protected]

Telephone Technical Support

Available to qualified Westell 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-377-8766, option 2

Normal Business Hours: 8 a.m. to 6 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 2, and follow the prompts for after-hours service.

Product DocumentationYou can also access and view the most current versions of Westell’s 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 RMM-1400 Version 6.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 RMM-1400, see chapter Getting Started in the Remote RMM-1400 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 RMM-1400 Version 6.4x Command Reference GuideCLI Overview: Command Types

Command TypesThere are four primary groups of Remote RMM-1400 commands:

Configuration Commands

Show Commands

Diagnostic Commands

Utility Commands

Configuration Commands The configuration commands are used to set up Remote RMM-1400. Typically, the results of what you configure in Remote RMM-1400 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 RMM-1400 options, statuses and settings. Typically, the results of what you configure in Remote RMM-1400 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 RMM-1400. All are executable from any level of the CLI.

WESTELL.COM

1-800-377-8766

Page 1-3

Remote RMM-1400 Version 6.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 RMM-1400 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.

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

Remote RMM-1400 accepts either single quotes (‘) or double quotes (“) for enclosing parameters.

(Kentrox) config controller ethernet 2>assign disable mac-security unassign

bridge enable no

default encapsulation proxy-arpdescription hardware-address speed

Global Commands

config exec logout showcopy exec-job password telnet

debug exec-kill ping trace-route

diag exit reloaderase help running-config

(Kentrox) config controller ethernet 2>

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 RMM-1400 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 RMM-1400 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 us

Strong 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 RMM-1400 Version 6.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 RMM-1400 help information. The following example displays the help screen.

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)>help

You can request help for a command at any time by enteringa question mark ('?'). The '?' displays the following types

of 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 reference

guide.

(Kentrox)>

WESTELL.COM

1-800-377-8766

Page 1-7


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.

(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

(Kentrox)>show ip

Commands

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

WESTELL.COM

Page 1-8

1-800-377-8766


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)>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 RMM-1400 Version 6.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 RMM-1400 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 RMM-1400 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

Page 2-1

WESTELL.COM

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: Config Command Overview

Config Command OverviewThe configuration commands are used to set up Remote RMM-1400. Typically, the results of what you configure in Remote RMM-1400 with the config command can be displayed with the show command. See Show Command Overview on page 3-2 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 RMM-1400 Version 6.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 ?

(rmm28)>config [ ? does not display in CLI ]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.

timeout Configures the session timeout value. use-wizard Runs a configuration wizard.

users(+) Configures users.

(rmm28)>config

WESTELL.COM

1-800-377-8766

Page 2-3

Remote RMM-1400 Version 6.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 RMM-1400 Version 6.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 Alsorunning-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 RMM-1400 Version 6.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_namedefault hidden-severitydescription texthidden-severity {disabled | normal }ne-name ne_nameno { category | description | ne-name }raw { disable | enable }trap { 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 hidden-severity

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 RMM-1400 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.

WESTELL.COM

1-800-377-8766

Page 2-7


Page 2-8


ExamplesThe following settings are configured for alarm entry ALM_4:

Description ALM NE 4 Category Environmental_Alarms Network element name MDR4000toDublin Raw response information enabled SNMP trap support enabled SNMP trap priority level high

config alarm-entry event

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

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 RMM-1400 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 ALM_4(Dub) config alarm-entry ALM_4>description ALM NE 4

(Dub) config alarm-entry ALM_4>category Environmental_Alarms

(Dub) config alarm-entry ALM_4>ne-name MDR4000toDublin(Dub) config alarm-entry ALM_4>raw enable

(Dub) config alarm-entry ALM_4>trap enable

(Dub) config alarm-entry ALM_4>trap priority high(Dub) config alarm-entry ALM_4>

WESTELL.COM

1-800-377-8766


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

Command DefaultsNo alarm event configured


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-78.

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

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


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

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

(Dub)>config

(Dub) config>alarm-entry ALM_2_2_5

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

WESTELL.COM

Page 2-10

1-800-377-8766


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

Command Defaultsminor

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.

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

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.

WESTELL.COM

1-800-377-8766

Page 2-11



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

See Alsoconfig correlation

config event content

running-config

show alarm-entries

show correlations

show events

(Dub)>config

(Dub) config>alarm-entry ALM_2_2_5

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

WESTELL.COM

Page 2-12

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400 (/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 RMM-1400 Configuration Guide.

Formatsconfig apply-patch patch_file config_file

Parameters

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 on page 5-4.

WESTELL.COM

1-800-377-8766

Page 2-13

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config apply-patch


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

See Alsocopy

erase

running-config

show config-file

(Dub)>config

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

(Dub) config>

WESTELL.COM

Page 2-14

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config banner

config banner

DescriptionThis command configures the banner that displays when connecting to the Remote RMM-1400.

Formatsconfig banner delimiting_character

For resetting the banner:config default banner

Parameters

This command accepts escape codes 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-15

Remote RMM-1400 Version 6.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 RMM-1400 in the banner.

\U Includes the number of users currently logged into Remote RMM-1400 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.

_ __ _____ _ _ _______ _____ ____ __ __

| | / / | ___|| \ | ||___ ___|| _ \ / \ \ \ / /

| |/ / | |___ | \ \| | | | | (_) || -- | \ \/ / | ( | ___|| |\ \ | | | | _ / | ( ) | ) (

| |\ \ | |___ | | \ | | | | | \ \ | -- | / /\ \

|_| \_\ |_____||_| \_| |_| |_| \_\ \____/ /_/ \_\

RMM-1400

login:

(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-16

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config clock

config clock

DescriptionThis command configures clock and timestamp settings for Remote RMM-1400.

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 RMM-1400. 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 information about NTP, refer to config mediation tacacs-service on page 2-154.

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-17



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 RMM-1400. 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-19.

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 RMM-1400 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-18

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 RMM-1400 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 RMM-1400 is in standard mode:config clock daylight-savings indicator

When Remote RMM-1400 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-19


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-20

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-21


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-22

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400.

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-23

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config controller bridge switch

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

See Alsoconfig controller bridge switch

show controllers

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

(Dub) config controller bridge switch>description Switch controller

(Dub) config controller bridge switch>

WESTELL.COM

Page 2-24

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config controller ethernet

config controller ethernet

DescriptionThis command configures a Remote RMM-1400 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 | unit/port }

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

100fx }unassign

For resetting Ethernet controllers:

config default controller ethernet { * | 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.

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-29. 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.

WESTELL.COM

1-800-377-8766

Page 2-25


enable Enables the specified Ethernet port to pass data.

hardware-address

Configures the hardware address for a Remote RMM-1400 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 RMM-1400. Valid Ethernet port values are 1 to 4.

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 This command 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 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 RMM-1400.

WESTELL.COM

Page 2-26

1-800-377-8766



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 Alsoshow controllers ethernet

unassign Specifies the Ethernet controller should not 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.

(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

1-800-377-8766

Page 2-27

Remote RMM-1400 Version 6.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.

Formatconfig controller ethernet port bridge switch

For removing the Ethernet controller from the bridge group:

config controller ethernet port no bridge

Parameters

Required User Profiles

management, supervisor

See Alsoconfig controller ethernet

show controllers ethernet

no Removes the Ethernet controller from bridge group switch.

port Defines the physical connector associated with the controller on Remote RMM-1400. Valid Ethernet port values are 1 to 4.

WESTELL.COM

Page 2-28

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 2-29

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config controller nat64


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

See Alsoshow 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>

WESTELL.COM

Page 2-30

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 2-31


Parameters

* 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.Note: This command is only available in the site-server

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

Page 2-32

1-800-377-8766


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 parameter 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. This parameter is not available in the client mode. The settings are pushed to clients when they 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.

Note: The disconnected value must be larger than the inactive timeout value.

WESTELL.COM

1-800-377-8766

Page 2-33



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 RMM-

1400 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 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.Note: This command is only available in the site-server

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

Page 2-34

1-800-377-8766


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

1-800-377-8766

Page 2-35

Remote RMM-1400 Version 6.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.

FormatFor asynchronous controllers:

config controller serial { port | unit/port }

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

57600 | 115200 }connectdatabits { 6 | 7 | 8 }defaultdescription textdial-timer intervaldisableenableflow { none | xonxoff | hardware }linemode { rs232 | rs422 | rs485h }no descriptionparity { none | even | odd }sim-pin [ pin ]stopbits { 1 | 2 }unassign

For wireless modem controllers using an EvDO modem:config controller serial modem

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

WESTELL.COM

Page 2-36

1-800-377-8766


For wireless modem controllers using an HSPA modem:

config controller serial modem

assignconnectdescription textdisableenableencapsulationno descriptionno encapsulationno sim-pinsim-pin [ pin ]unassign

For wireless modem controllers using an LTE modem:

config controller serial modem

apn apnassignauthentication { pap | chap} username [ password ]defaultroutedescription textdisableenableno apnno authenticationno defaultrouteno descriptionno sim-pinsim-pin [ pin ]unassign

For resetting serial controllers to the default configuration:config default controller serial { * | port | modem }

Parameters

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

WESTELL.COM

1-800-377-8766

Page 2-37


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.

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.

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

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

default Resets a specified parameter to its default value.Note: All interfaces associated with the controller(s) being reset are

deleted.

defaultroute Sets whether the serial modem 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.

WESTELL.COM

Page 2-38

1-800-377-8766


dial-timer Configures the amount of time Remote RMM-1400 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 ppp

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

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.

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-485h (half duplex)Note: Serial ports 1 and 2 operate only in rs-232 linemode. Serial

ports 3 and 4 operate in rs-422 or rs-485h linemode.


WESTELL.COM

1-800-377-8766

Page 2-39


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 RMM-1400. Valid values are 1 through 4.

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 RMM-1400 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 modem on page 4-10.

There is no sim-pin by default.

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 the serial controller should not be tracked as a resource.

WESTELL.COM

Page 2-40

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 even bit parity Stop bit 2

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 modem on page 4-10 for commands to enable and disable the sim-pin feature and/or change the SIM’s PIN.

config controller serial connect

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>parity even

(Dub) config controller serial 2>stopbits 2

(Dub) config controller serial 2>

(Kentrox)>config controller serial modem sim-pin

Enter the PIN for the SIM card: ****

Confirm the PIN for the SIM card: ****

WESTELL.COM

1-800-377-8766

Page 2-41


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

Format

For asynchronous serial controllers:

config controller serial 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:config controller serial modem 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-42

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 RMM-1400 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 4.

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-36.

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-43



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 RMM-1400.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 RMM-1400 prior to configuring the file as the connection initialization string.

(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

Page 2-44

1-800-377-8766


config controller serial disconnect

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

Formatconfig controller serial 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 RMM-1400 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 4.

WESTELL.COM

1-800-377-8766

Page 2-45



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-36.

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

Page 2-46

1-800-377-8766


config controller serial encapsulation

DescriptionThese commands configure the encapsulation protocol for the serial modem controller. The encapsulation protocol is the mechanism for framing data across a serial port. The only available encapsulation format for Remote RMM-1400 is PPP.

Note: LTE modems do not support the encapsulation command.

Formats

For the wireless modem controller using an EVDO or HSPA modem:config controller serial modem encapsulation ppp

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

For resetting encapsulation:

config controller serial modem default encapsulation

Parameters

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-47


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 RMM-1400 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 RMM-1400 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 RMM-1400 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. The Remote RMM-1400 will then restart the PPP connection. inactivity-time—Defines the inactivity time in minutes.

lcp-requests Configures Remote RMM-1400’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-48

1-800-377-8766



method Configures the method Remote RMM-1400 uses to authenticate a peer device on a serial controller PPP link, or the method used by a peer device to authenticate Remote RMM-1400 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 RMM-1400. Valid asynchronous port values are 1 to 4 and modem.

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 RMM-1400.

WESTELL.COM

1-800-377-8766

Page 2-49


ExamplesThe following PPP encapsulation settings are configured for controller serial modem:

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 Alsoshow controllers

(Dub)>config

(Dub) config>controller serial modem(Dub) config controller serial modem>encapsulation ppp

(Dub) config controller serial modem encapsulation ppp

->defaultroute(Dub) config controller serial modem encapsulation ppp

->local

(Dub) config controller serial modem encapsulation ppp local->identity userb newpass

(Dub) config controller serial modem encapsulation ppp local

->method pap(Dub) config controller serial modem encapsulation ppp local

->exit

(Dub) config controller serial modem encapsulation ppp->mru 5200

(Dub) config controller serial modem encapsulation ppp

->mtu 4500(Dub) config controller serial modem encapsulation ppp

->remote

(Dub) config controller serial modem encapsulation ppp remote->identity user2 remuse

(Dub) config controller serial modem encapsulation ppp remote

->method chap

(Dub) config controller serial modem encapsulation ppp remote->

WESTELL.COM

Page 2-50

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 2-51


Command DefaultsNo correlations configured


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

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 RMM-1400 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: Using the = and != operators with floating point measurement values may produce unexpected results. The following operators are recommended: >, >=, < or <=.

See the Remote RMM-1400 Configuration Guide for more information about configuring event correlations.

no Initiates the deletion of a correlation or all correlations.

WESTELL.COM

Page 2-52

1-800-377-8766


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 batter

y voltage(Dub) config correlation LowVoltage>duration 300 0

(Dublin-TC) config correlation LowVoltage>expression measurement battVoltage <

10.2

WESTELL.COM

1-800-377-8766

Page 2-53

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config dhcp-relay

config dhcp-relay

DescriptionThis command configures BOOTP/DHCP relay on Remote RMM-1400. When BOOTP/DHCP relay is enabled, Remote RMM-1400 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 RMM-1400. When BOOTP/DHCP relay is disabled, Remote RMM-1400 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 RMM-1400. When BOOTP/DHCP relay is enabled, Remote RMM-1400 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 RMM-1400 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

Page 2-54

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 2-55

Remote RMM-1400 Version 6.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

Page 2-56

1-800-377-8766



config-file

Configures the name of a file that contains DHCP server configuration information for Remote RMM-1400. If a file name is configured, Remote RMM-1400 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 RMM-1400. 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 RMM-1400.

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 RMM-1400. 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 RMM-1400. 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

1-800-377-8766

Page 2-57


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

Page 2-58

1-800-377-8766



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-61.

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

1-800-377-8766

Page 2-59


config dhcp-server interface

DescriptionThis command configures DHCP server operation on an interface.

Formatsconfig dhcp-server interface

bridge switchethernet ethernet_portopenvpn nameserial modem

For deleting DHCP server operation from interfaces:

config dhcp-server no interface

bridge switchethernet ethernet_portopenvpn nameserial modem

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 RMM-1400. Valid values are 1 to 4.

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.

serial Specifies a serial interface for DHCP server operation.

WESTELL.COM

Page 2-60

1-800-377-8766



ExamplesThe following settings are configured for the DHCP server:

DHCP server operation on interface ethernet 3 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 RMM-1400 interface on which the DHCP server is operating.

Note: To avoid errors, disable HTTP before configuring the DHCP server. For information on disabling HTTP, refer to command config remote-access on page 2-177.

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

(Dub)>config(Dub) config>dhcp-server

(Dub) config dhcp-server>interface ethernet 3

(Dub) config dhcp-server>interface openvpn cmhclient1(Dub) config dhcp-server>interface bridge switch

(Dub) config dhcp-server>

WESTELL.COM

1-800-377-8766

Page 2-61


Parameters

ip_address Defines the IP address for the subnetwork. The subnetwork IP address is the network address for the Remote RMM-1400 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 RMM-1400 interface on which the DHCP server is operating.

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.


WESTELL.COM

Page 2-62

1-800-377-8766


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

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.

(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-63


See Alsoconfig dhcp-server


show dhcp-server

WESTELL.COM

Page 2-64

1-800-377-8766

Remote RMM-1400 Version 6.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/powerMon | 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_readingunassignunits unit_name

Parameters

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

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

WESTELL.COM

1-800-377-8766

Page 2-65


averaging Specifies the level by which Remote RMM-1400 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: This parameter 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. Default value is 0. high_band—Defines the high input value in sensor units. Valid

values are numeric characters. 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.

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.

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

WESTELL.COM

Page 2-66

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 will be generated when the input goes above 10. 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. 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-182 also configures the interval rate at which events are generated for an analog input. The most recently executed of these two commands takes precedence.

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 RMM-1400 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. Default maximum current is 20 milliamps.Notes: The maximum and sensor output current can be

configured as any value. However, Remote RMM-1400 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-67


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) 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 RMM-1400 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.

point_range Defines a set of analog input numbers within the unit. 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 dedicated to monitoring the unit's secondary incoming power supply voltage.

powerMon Specifies a third power monitor, which is an analog input used to monitor voltage for an external, isolated power supply.

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

WESTELL.COM

Page 2-68

1-800-377-8766



ExamplesThe following settings are configured for analog input 1/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

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.

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-69


See Alsoconfig discrete input

config discrete output

show discrete

(Dub)>config(Dub) config>discrete

(Dub) config discrete>analog 1/4

(Dub) config discrete analog 1/4->description Amp_meter

(Dub) config discrete analog 1/4

->band 20 30.5(Dub) config discrete analog 1/4

->hysteresis 2

(Dub) config discrete analog 1/4->interval 10


->maximum 20 72(Dub) config discrete analog 1/4

->minimum 7 8

(Dub) config discrete analog 1/4->averaging medium


->enable(Dub) config discrete analog 1/4

->assign


WESTELL.COM

Page 2-70

1-800-377-8766

Remote RMM-1400 Version 6.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.

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

Note: Command config response content on page 2-182 also disables event generation for digital inputs. The most recently executed of these two commands takes precedence.

WESTELL.COM

1-800-377-8766

Page 2-71

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config discrete input


ExamplesThe following settings are configured for digital input 1/16:

Default alarm-table entry configured Input enabled Description Alarm 16 Enabled resource tracking

See Alsoconfig discrete analog


show discrete

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

Note: Command config response content on page 2-182 also enables event generation for digital inputs. The most recently executed of these two commands takes precedence.

point Defines the digital input number within a peripheral unit.

point_range Defines a set of digital input numbers within a peripheral unit. 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.

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


(Dub) config discrete>input 1/16

(Dub) config discrete input 1/16->alarm-default

(Dub) config discrete input 1/16

->enable(Dub) config discrete input 1/16

->description Alarm 16

(Dub) config discrete input 1/16->assign

(Dub) config discrete input 1/16

WESTELL.COM

Page 2-72

1-800-377-8766

Remote RMM-1400 Version 6.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 a peripheral unit.

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


WESTELL.COM

1-800-377-8766

Page 2-73

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config discrete output


ExamplesThe following settings are configured for discrete output 1/1:

Description Critical alarm output Enabled resource tracking



show discrete


(Dub) config discrete>output 1/1

(Dub) config discrete output 1/1->description Critical alarm output

(Dub) config discrete output 1/1

->assign(Dub) config discrete output 1/1

WESTELL.COM

Page 2-74

1-800-377-8766

Remote RMM-1400 Version 6.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-77.

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

1-800-377-8766

Page 2-75

Remote RMM-1400 Version 6.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

Page 2-76

1-800-377-8766

Remote RMM-1400 Version 6.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-78.

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

WESTELL.COM

1-800-377-8766

Page 2-77


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 | powerMon | temperature | humidity }

unit

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

point

Defines the analog input point number within the peripheral unit.

power

Specifies the power monitor, which is an analog input that is dedicated to monitoring the unit’s 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.

powerMon

Specifies a third power monitor, which is an analog input used to monitor voltage for an external, isolated power supply.

temperature

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

humidity

Specifies 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

Page 2-78

1-800-377-8766


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:

name

Defines 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:

port

Defines the physical connector associated with a controller on Remote RMM-1400. Valid Ethernet port values are 1 to 4.

The following event types are valid for this originator: down up

input instance Specifies a digital input as the event originator. Valid values for instance are:

unit/point unit


point

Defines the digital input point number for the unit. The following event types are valid for this originator: close offline open

Table 2 Valid Event Originators (Continued)

Event Originator Description (Continued)

WESTELL.COM

1-800-377-8766

Page 2-79


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:

name

Identifies the OpenVPN controller name.The following event types are valid for this originator: down up

output instance Specifies a digital output as the event originator. Valid value for instance is:

unit/point unit


point

Defines the digital output number within the unit. The following event types are valid for this originator: close offline open



WESTELL.COM

Page 2-80

1-800-377-8766


peripheral instance

Specifies an expansion peripheral unit as the event originator. Valid value for instance is:

unit


The following event types are valid for this originator: offline online

script-job job name

Specifies the script job state as an event originator whenever the script job starts or stops for any reason. Valid value for job name is the name of a configured script job.The following event types are valid for this originator: idle running

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 RMM-1400. Valid asynchronous port values are 1 to 4 for Remote RMM-1400.

unit/port

Defines the peripheral unit number and the serial port number within the unit. Valid unit values are 1 to 12.

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

snmp Specifies the Remote RMM-1400 SNMP agent as the event originator. Event type manager-set is valid for this originator.



WESTELL.COM

1-800-377-8766

Page 2-81


snmpne instance Specifies the Remote RMM-1400 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 RMM-1400 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 name

Identifies 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 RMM-1400.

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 instance

Specifies an event originated by a status point within a network element. Valid value for instance is:

status-point ne ne_name status-point_name

The event types for a status-point originator are defined by the application.Note: Alarm entries driven by status points are defined

by the application. Users typically will not have to configure alarm entries driven by status points.



WESTELL.COM

Page 2-82

1-800-377-8766


system Specifies the system as a whole (not one particular subsystem) as the event originator.The following event type is valid for this originator: init

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 RMM-1400.

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 RMM-1400.

The following event types are valid for this originator: conn-cancelled conn-down conn-failed conn-inactivity conn-timeout conn-up incoming-connection



WESTELL.COM

1-800-377-8766

Page 2-83


timer instance Specifies a system timer as the event originator. Valid value for instance is:

timer_name

Defines the unique name of the timer.The following event type is valid for this originator:

timer-expire

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.

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.



WESTELL.COM

Page 2-84

1-800-377-8766


false Specifies that a logical expression has evaluated to false.

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 RMM-1400 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.

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.

manager-set Specifies that an SNMP set of MIB object aiMediationEvent was received by Remote RMM-1400'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.

Table 3 Valid Event Types (Continued)

Event Type Description (Continued)

WESTELL.COM

1-800-377-8766

Page 2-85



ExamplesThis example displays the configuration of interval event analogInterval for analog 1/4.

See Alsoconfig correlation

config event

show correlations

show events

open Specifies that a digital input or output has gone from having current flow to having no current flow.

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.

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 RMM-1400.

up Specifies that a system component has come up.

(Dub)>config

(Dub) config>event analogInterval

(Dub) config event analogInterval>content(Dub) config event analogInterval content

->analog 1/4

(Dub) config event analogInterval content analog 1/4->interval

(Dub) config event analogInterval content analog 1/4

Table 3 Valid Event Types (Continued)

Event Type Description (Continued)

WESTELL.COM

Page 2-86

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config hostname

config hostname

DescriptionThis command configures a hostname for Remote RMM-1400.

Formatsconfig hostname hostname

Parameters

Command DefaultsKentrox


ExamplesThis example displays the configuration of hostname DublinCo for Remote RMM-1400. Notice that the command prompt changes from Dub to DublinCo.

hostname Defines the hostname to assign to Remote RMM-1400. 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-87

Remote RMM-1400 Version 6.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-23. 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-88

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-23. 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-89


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 ethernet



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-90

1-800-377-8766


Parameters



DHCP client support enabled Retry-timeout value 15 minutes




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-91


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-23. 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-92

1-800-377-8766



Description Bridge switch interface IPv6 address fd10::39:0:0:100/64



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-93


config interface bridge switch nat64

DescriptionThese commands enable or disable NAT64 participation by bridge group switch.

Formatsconfig interface bridge switch nat64

disableenable

Parameters


ExampleThe following enables nat64 on a bridge interface:

See Alsoconfig controller nat64

show controllers nat64

enable Enables NAT64 on the bridge group switch

disable Disables NAT64 on the bridge group switch

(Kentrox)>

(Kentrox)>config(Kentrox) config>interface bridge switch

(Kentrox) config interface bridge switch>nat64 enable

(Kentrox) config interface bridge switch>

WESTELL.COM

Page 2-94

1-800-377-8766

Remote RMM-1400 Version 6.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.

Note:

Formatsconfig interface ethernet port

description textdisableenableno description

For deleting Ethernet interfaces:

config no interface ethernet { port | * }

Parameters


* Specifies all Ethernet interfaces or all interfaces from the Remote RMM-1400 configuration.

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.


port Defines the physical connector associated with an Ethernet interface on Remote RMM-1400. Valid Ethernet port values are 1 to 4.

WESTELL.COM

1-800-377-8766

Page 2-95


ExamplesThe 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.

Note:

Formatsconfig interface ethernet 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

Page 2-96

1-800-377-8766




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 the Remote RMM-1400. Valid Ethernet port values are 1 to 4.

* Specifies all Ethernet interfaces or all interfaces from the Remote RMM-1400 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

1-800-377-8766

Page 2-97


config interface ethernet ipv6

DescriptionThese commands configure settings for an Ethernet interface IPv6 address.

Note:

Formatsconfig interface ethernet port ipv6

address ip_address/prefix_length disableenableno

Parameters



Enabled interface ethernet 2 Description Ethernet 2 IPv6 address fd10::39:0:0:1/64

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.


port Defines the physical connector associated with an Ethernet interface on Remote RMM-1400. Valid Ethernet port values are 1 to 4.

WESTELL.COM

Page 2-98

1-800-377-8766





config interface ethernet nat64

DescriptionThese commands enable or disable NAT64 participation by an ethernet interface.

Formatsconfig interface ethernet port nat64

disable enable

Parameters


ExamplesThe following enables NAT64 on ethernet port 8:

TSee Alsoconfig controller nat64


(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

->

disable Disables NAT64 on the ethernet interface

enable Enables NAT64 on the ethernet interface.

WESTELL.COM

1-800-377-8766

Page 2-99

Remote RMM-1400 Version 6.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-100

1-800-377-8766

Remote RMM-1400 Version 6.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-101

Remote RMM-1400 Version 6.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.

Formatsconfig interface serial modem

description textdisableenableip address ip_address pointopoint peer_ip_addressipv6 { enable | disable }no { description | ipv6 }

For deleting a serial interface:

config no interface serial modem

Parameters

* Specifies all serial interfaces.

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.

disable Disables a serial interface or IPv6 on the interface.

enable Enables a serial interface or IPv6 on the 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.

ipv6 Configures IPv6 for the interface.


WESTELL.COM

Page 2-102

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config interface serial


ExamplesThe following settings are configured for interface serial modem:

Description This is the serial interface for the wireless modem IP address 10.37.45.2 and peer IP address 10.37.45.5 Enabled interface serial modem



show interfaces

(Dub)>config(Dub) config>interface serial modem

(Dub) config interface serial modem>description This is the serial interface for

the wireless modem(Dub) config interface serial modem>ip address 10.37.45.2 pointopoint 10.37.45.5

(Dub) config interface serial modem>enable

(Dub) config interface serial modem>->

WESTELL.COM

1-800-377-8766

Page 2-103

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config ip

config ip

DescriptionThis command configures IP settings for Remote RMM-1400.

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-104

1-800-377-8766


Parameters

* Specifies all IP addresses or routes.

arp Configures an Remote RMM-1400 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 RMM-1400. 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 RMM-1400. 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-105



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 interfaceinstance is an instance of the type of network interface

preference—Defines a preference value for a configured route. Remote RMM-1400 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 RMM-1400 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-106

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-107

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config iptables

config iptables

DescriptionThis command configures iptables for Remote RMM-1400. 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 RMM-1400 interface.

mangle

This table manipulates IP packets as they go out through a Remote RMM-1400 interface.

nat

This table re-addresses IP addresses and/or port numbers for IP packets as they go out through a Remote RMM-1400 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 RMM-1400, refer to the Remote RMM-1400 Configuration Guide.

See Alsoshow iptables

WESTELL.COM

Page 2-108

1-800-377-8766

http://ipset.netfilter.org/iptables.man.html


Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config iptables-v6

config iptables-v6

DescriptionThis command configures iptables for IPv6 addresses for Remote RMM-1400. 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 RMM-1400 interface.

mangle

This table manipulates IP packets as they go out through a Remote RMM-1400 interface.

The filter and mangle 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 RMM-1400 using this command, refer to the Remote RMM-1400 Configuration Guide.

See Alsoshow iptables

WESTELL.COM

1-800-377-8766

Page 2-109



Remote RMM-1400 Version 6.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 RMM-1400 keeps records. This feature cannot be disabled. The following parameter is accepted:

count—Defines the number of job runs for which Remote RMM-1400 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-82 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 RMM-1400 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 RMM-1400.

reset-stats Resets the statistical counts displayed by show jobs on page 3-82.

WESTELL.COM

Page 2-110

1-800-377-8766

Remote RMM-1400 Version 6.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

show jobs name

(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-111

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config jobs name

config jobs name

DescriptionThis command configures a job and its associated settings.

Important: Always 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-112

1-800-377-8766


history Specifies the history of all Remote RMM-1400 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-113


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 RMM-1400 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 RMM-1400. 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-114

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 RMM-1400 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 RMM-1400 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 when the Remote RMM-1400 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-115


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.

(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


->property duration 10(Dub) config jobs name samplejob

->script jobtestutils normal 2.0.0

(Dub) config jobs name samplejob->start-attempts 10


->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


WESTELL.COM

Page 2-116

1-800-377-8766


This example displays the removal of the history associated with run ID 14 for job myjob.

See Alsoconfig jobs

config jobs name task

show jobs

show jobs name

(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

1-800-377-8766

Page 2-117

Remote RMM-1400 Version 6.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 RMM-1400 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 RMM-1400 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 on page 3-82 displays the total number of tasks.

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 RMM-1400 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-119 and Table 6 on page 2-120 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.

WESTELL.COM

Page 2-118

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.

Table 5 lists the runtime datadir task property that is configured by the script engine.

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 RMM-1400 has five available task types: datadir ifconfig processmonitor serversocket watchdog

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

1-800-377-8766

Page 2-119


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

Page 2-120

1-800-377-8766


Table 7 lists the runtime serversocket task properties that are configured by the script engine.

watchdog

Task 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.Tip: For valid interface values, refer to the

system-name values listed in command show interfaces on page 3-62.

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 RMM-1400 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

1-800-377-8766

Page 2-121


ExamplesThis example displays the configuration of task watchdog for job samplejob.

This example displays the deletion of task watchdog from job samplejob.

See Also config jobs

show jobs

show jobs name

(Dub)>config

(Dub) config>jobs

(Dub) config jobs>name samplejob(Dub) config jobs name samplejob

->task watchdog

(Dub) config jobs name samplejob task watchdog

(Dub)>config

(Dub) config>jobs

(Dub) config jobs>name samplejob(Dub) config jobs name samplejob

->no task watchdog


WESTELL.COM

Page 2-122

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400 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

1-800-377-8766

Page 2-123


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

Page 2-124

1-800-377-8766


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. Default value is 0.high—Defines the high measurement table value in sensor units. Valid values are numeric characters. 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.

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. Default value is 0.

WESTELL.COM

1-800-377-8766

Page 2-125


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 SiteBus terminal, 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-127 for more information on valid measurement originators.

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.

WESTELL.COM

Page 2-126

1-800-377-8766


config

Table 8 Valid Measurement Originators

Originator Description

analog instance Specifies an analog input as the measurement originator. Valid value for instance is:

unit/{ point | power | powerB | temperature } unit


point

Defines 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.

power


powerB


temperature

Specifies 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.

script instance Specifies the script as the measurement originator. Valid value for instance is:

jobname measurementname

instance signal-strength

Specifies the wireless modem controllers’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 modem signal-strength

The 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.”

WESTELL.COM

1-800-377-8766

Page 2-127


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_measurementname

Where 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_rowID

Where rowID is the row’s unique identifier obtained from the row ID column.

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-usage

Monitors memory usage. Memory usage is the percentage of memory used on the Remote.

disk-usage

Monitors file system usage. File system usage is the maximum percentage used of all disk partitions on the Remote.


Originator Description (Continued)

WESTELL.COM

Page 2-128

1-800-377-8766


@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 )

@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 )


Originator Description (Continued)

WESTELL.COM

1-800-377-8766

Page 2-129



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

See Alsoconfig mediation snmp measurement-template

config mediation snmpne

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-130

1-800-377-8766

Remote RMM-1400 Version 6.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-131



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)

See Also config mediation snmpne

config mediation snmp manager

config mediation snmp measurement-template

config mediation snmp ne-template

config mediation snmp point-template


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-132

1-800-377-8766


debug mediation


show mediation

WESTELL.COM

1-800-377-8766

Page 2-133

Remote RMM-1400 Version 6.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-134

1-800-377-8766

Remote RMM-1400 Version 6.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

defaultnotrap-oid oid value-match indexvarbind-id oid varbind-match oid value varbind-value oid

value-conversiondefaultmultiply multiplier

value-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-135


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-136

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-137



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-138

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-139


See Alsoconfig meas-table





debug mediation


show mediation

WESTELL.COM

Page 2-140

1-800-377-8766

Remote RMM-1400 Version 6.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-141



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-142

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-143

Remote RMM-1400 Version 6.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-144

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 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-145



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:

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-146

1-800-377-8766


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

This example defines the message Interface is offline and the critical severity for the offline state on a point template:




(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


>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


>message $(point) is down(Dub)>

(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

1-800-377-8766

Page 2-147




debug mediation


show mediation

WESTELL.COM

Page 2-148

1-800-377-8766

Remote RMM-1400 Version 6.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-149


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-150

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. 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. Default value is 3600.

WESTELL.COM

1-800-377-8766

Page 2-151



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


>category reboot event(Dub) config mediation snmpne MyNE

>ne-name MyNE

(Dub) config mediation snmpne MyNE>host 10.40.65.90 161 administrator v1


>event reboot coldstart(Dub) config mediation snmpne MyNE

>point ethernet1 ifEntry ifIndex 1

>(Dub)>

WESTELL.COM

Page 2-152

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-153

Remote RMM-1400 Version 6.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-154

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config ntp

config ntp

DescriptionThese commands configure NTP settings for Remote RMM-1400. 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

1-800-377-8766

Page 2-155

Remote RMM-1400 Version 6.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 RMM-1400.

enable Enables NTP for Remote RMM-1400.Important: When NTP is initially enabled, the clock for Remote

RMM-1400 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

Page 2-156

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config peripheral

config peripheral

DescriptionThis command configures a peripheral unit or resets a peripheral unit to its default settings. The only currently supported peripheral units for Remote RMM-1400 are RMB-1 and RMB-2. These units allow users to add discrete inputs, analog inputs, relay outputs and a four-terminal SiteBus to Remote RMM-1400. While managed through Remote RMM-1400, users will never connect directly to peripheral units. Instead, all user contact with peripheral units takes place through the Remote RMM-1400.

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

1-800-377-8766

Page 2-157


Command DefaultsNo peripheral units configured

manage Configures an association between a discovered peripheral and a unit number on Remote RMM-1400. 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: 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


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: RMB-1 for RMB-1 and RMB-2 units discrete-expansion for Expand D units RME-B64 for RME-B64 units RME-E8 for RME-E8 units RME-S8 for RME-S8 units


WESTELL.COM

Page 2-158

1-800-377-8766



ExamplesThe following settings are configured for peripheral unit 1:

Type RMB-1 Description RMB-1 smart block Managed RMB-1 RMB1-0E68FD

See Alsodiag peripheral reload

show peripherals

(Dub)>config(Dub) config>peripheral 1

(Dub) config peripheral 1>type RMB-1

(Dub) config peripheral 1>description RMB-1 smart block(Dub) config peripheral 1>manage RMB1-0E68FD

(Dub) config peripheral 1>

WESTELL.COM

1-800-377-8766

Page 2-159

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config pkgs install

config pkgs install

DescriptionThese commands configure package installation settings.

Note: Remote RMM-1400 supports only Kentrox-provided script packages that have been by Kentrox. Unauthorized script packages will fail to install.

Formatsconfig pkgs install

all [ fromserver ]name package [ min_version ] [ fromserver ]referenced [ fromserver ]

Parameters

all Installs all available script packages on to Remote RMM-1400. The following characteristics apply: The highest script package versions found are installed from the

Remote RMM-1400 /pkgstage staging area or from the central FTP package server, whichever one is specified. Tip: The staging area is the /pkgstage directory on Remote

RMM-1400 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 RMM-1400 is configured with an FTP server.Tip: If fromserver is specified, Remote RMM-1400 will only

check the FTP server for available packages. Likewise, if fromserver is not specified, Remote RMM-1400 will check only the staging area for available packages.

WESTELL.COM

Page 2-160

1-800-377-8766


name Installs an individual script package on to Remote RMM-1400. The following characteristics apply: The highest script package version found is installed from the

Remote RMM-1400 staging area or from the configured FTP server, whichever is specified.

Remote RMM-1400 installs the file that matches format package-nn.nn.nn.pkg. If no file in this format exists, Remote RMM-1400 searches for one in format package.pkg.Tip: The staging area is the /pkgstage directory on Remote


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 RMM-1400 is configured with an FTP server.Tip: If fromserver is specified, Remote RMM-1400 will only


WESTELL.COM

1-800-377-8766

Page 2-161



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 RMM-1400 staging area or from the configured FTP server, whichever is specified.

Remote RMM-1400 installs the file that matches format package-nn.nn.nn.pkg. If no file in this format exists, Remote RMM-1400 searches for one in format package.pkg.Tip: The staging area is the /pkgstage directory on Remote



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 RMM-1400 is configured with an FTP server.Tip: If fromserver is specified, Remote RMM-1400 will only


WESTELL.COM

Page 2-162

1-800-377-8766


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.

See Also config pkgs on-demand-install

config pkgs server

config pkgs uninstall

show pkgs

(Dub)>config(Dub) config>pkgs

(Dub) config pkgs>install

(Dub) config pkgs install->all fromserver

Package pkgtestutils, version 1.0.0 installed

Package testa, version 1.3.0 installedPackage testb, version 2.2.0 installed

Package testimpa, version 1.0.0 installed

Package testimpb, version 2.1.0 installedPackage testimpc, version 1.2.0 installed

Package testimpd, version 2.1.1 installed

Package testimpe, version 2.0.0 installedPackage testp, version 1.0.0 installed

Package testq, version 1.0.0 installed

Package 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 fromserver

Package 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 installed

Package testg, version 1.0.0 installed

Package testj, version 2.0.1 installed(Dub) config pkgs install

WESTELL.COM

1-800-377-8766

Page 2-163

Remote RMM-1400 Version 6.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 RMM-1400 staging area or from the configured central FTP package server (if it is configured).

Remote RMM-1400 installs the file that matches format package-nn.nn.nn.pkg. If no file in this format exists, Remote RMM-1400 searches for one in format package.pkg.

Tip: The staging area is the /pkgstage directory on Remote RMM-1400 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.

Tip: If the package server is configured and enabled, Remote RMM-1400 will only check the central FTP package server for available packages. Likewise, if the server is not configured, Remote RMM-1400 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-164

1-800-377-8766

Remote RMM-1400 Version 6.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-165

Remote RMM-1400 Version 6.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 RMM-1400 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 RMM-1400 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. Default port number is 21.

default Resets the specified parameter to its default value.

directory Configures Remote RMM-1400 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-166

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400 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 RMM-1400’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-167

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config pkgs uninstall


DescriptionThis command uninstalls a specified package or all packages. Remote RMM-1400 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 all

Package jobtestutils uninstalled.Package testg uninstalled.

Package testh uninstalled.

Package testj uninstalled.(Dub) config pkgs>

WESTELL.COM

Page 2-168

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config pkgs uninstall


show pkgs

WESTELL.COM

1-800-377-8766

Page 2-169

Remote RMM-1400 Version 6.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-170

1-800-377-8766

Remote RMM-1400 Version 6.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. 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-171

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config ras

config ras

DescriptionThis command configures RAS settings for Remote RMM-1400. 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 RMM-1400. 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 RMM-1400 command shell access. The following parameters are accepted: command—Configures the TACACS+ authorization method

that requires Remote RMM-1400 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-172

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 RMM-1400 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-173


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 RMM-1400. 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 RMM-1400.


WESTELL.COM

Page 2-174

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 RMM-1400. 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 RMM-1400 command shell access.

authorization—Specifies that the TACACS+ server will handle the TACACS+ authorization for the Remote RMM-1400 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 RMM-1400 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-175


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-176

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400.

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. This protocol is

enabled by default. enable—Enables the remote access protocol. 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-177



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-178

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-179

Remote RMM-1400 Version 6.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-180

1-800-377-8766

Remote RMM-1400 Version 6.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-181

Remote RMM-1400 Version 6.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 ]major [ 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

RMM-1400 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-182

1-800-377-8766


disable Configures a response that disables a Remote RMM-1400 system component. Valid responders are: analog ethernet input openvpn serial

enable Configures a response that enables a Remote RMM-1400 system component. Valid responders are: analog ethernet input openvpn serial

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.

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



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



WESTELL.COM

1-800-377-8766

Page 2-183


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-185.

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.

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



WESTELL.COM

Page 2-184

1-800-377-8766


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.

analog instance

Specifies an analog input as the responder. Valid value for instance is:

unit/{ point | power | powerB | powerMon | temperature | humidity}

unit


point

Defines the analog input point number within the unit. power


powerB


powerMon

Specifies a third power monitor, which is an analog input used to monitor voltage for an external, isolated power supply.

temperature

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

humidity

Specifies 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 4.

WESTELL.COM

1-800-377-8766

Page 2-185


input instance Specifies a digital input as the responder. Valid value for instance is:

unit/point unit


point

Defines the digital input point number for the unit.

logfile Specifies the Remote RMM-1400 user log file as the responder.

measurement instance

Specifies a measurement table entry as the responder. Valid values for instance are names of existing measurement table entries.

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


point

Defines the digital output point number within the unit.

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 RMM-1400. Valid asynchronous port values are 1 to 4 and modem for Remote RMM-1400.

Table 9 Valid Responders (Continued)

Responder Description (Continued)

WESTELL.COM

Page 2-186

1-800-377-8766



ExamplesThis example displays the configuration of close response latchAlm for output 1/4.

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.

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: ] port

Defines 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:


Defines the TCP port number and optional IP address for the TCP connection. Valid values for port are 1000 to 65535.

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.

Table 9 Valid Responders (Continued)

Responder Description (Continued)

WESTELL.COM

1-800-377-8766

Page 2-187


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 }source-data source_data_textsuppress-inactivity-disc

(Dub)>config(Dub) config>response latchAlm

(Dub) config response latchAlm>content

(Dub) config response latchAlm content->output 1/4

(Dub) config response latchAlm content output 1/4

->close(Dub) config response latchAlm content output 1/4

->

(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-188

1-800-377-8766


Parameters

response_name Defines the name of the response being configured. Maximum length is 128 characters.

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-185.

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 RMM-1400 and then sent out a Remote RMM-1400 asynchronous serial port. In addition, all asynchronous break sequences received on Remote RMM-1400 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-192.

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-189


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.

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.

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.


WESTELL.COM

Page 2-190

1-800-377-8766


Table 10 Valid Responders

Responder Description

serial instance

Specifies an asynchronous serial controller system component that processes the response. Valid values for instance are asynchronous ports 1 to 4 and modem.

ssh instance Specifies a SSH connection as the system component that processes the response. The SSH instance is entered in the following format:


Defines 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:


Defines 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:


Defines the Telnet port number and optional IP address for the Telnet connection. Valid values for port are 1000 to 65535.

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.

WESTELL.COM

1-800-377-8766

Page 2-191



ExamplesThe following settings are configured for response telnetConnection:

Responder telnet 50001 Enabled break propagation Binary transmission mode No disconnect when the inactivity timer expires.

See Alsoconfig response

config response content connect

show responses

serial instance

Specifies an asynchronous serial controller as the receiving end-point for the connection. Valid values for instance are asynchronous ports 1 to 4 and modem.

tcp instance Specifies a listening TCP port as the receiving end-point for the connection. The TCP instance is entered in the following format:


Valid values for port are 1 to 65535.

(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

Table 11 Valid Destinations (Continued)

Destination Description (Continued)

WESTELL.COM

Page 2-192

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400.

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

* 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

1-800-377-8766

Page 2-193

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config site control


ExamplesThe following control settings are specified/configured:

Control name generator Parameter name mode, with value normal

See Also show site controls

exec site control-action

(Dub)>config(Dub) config>site

(Dub) config site>control generator param mode normal

WESTELL.COM

Page 2-194

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400.

WESTELL.COM

1-800-377-8766

Page 2-195

Remote RMM-1400 Version 6.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 site>module Environmental

->application HVACMonitoring enable

WESTELL.COM

Page 2-196

1-800-377-8766

Remote RMM-1400 Version 6.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 network element:config site network-element ne_name

param param_name param_valuetype typecomponent component_name param param_name param_value

For deleting a network element:

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 network element parameter (or resetting to default):

config site network_element ne_name no param { param_name | * }

For clearing the network element 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, or all NE types.

WESTELL.COM

1-800-377-8766

Page 2-197



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.

ne_name Identifies the NE being configured.

(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

(RMM28)>config

(RMM28) config>site network-element das2 component das2Remote_1_6_2 param model

Model_3.5(RMM28) config>

WESTELL.COM

Page 2-198

1-800-377-8766


See Also show site network-elements

WESTELL.COM

1-800-377-8766

Page 2-199

Remote RMM-1400 Version 6.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

Page 2-200

1-800-377-8766


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

1-800-377-8766

Page 2-201


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 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 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

Page 2-202

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 2-203

Remote RMM-1400 Version 6.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 RMM-1400.

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

Page 2-204

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400 Version 6.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

1-800-377-8766

Page 2-205

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config snmp

config snmp

DescriptionThese commands configure SNMP settings for Remote RMM-1400.

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

Page 2-206

1-800-377-8766


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 RMM-1400 MIB file using an invalid community string. The default is disabled transmission of authentication failure traps. The following parameters are accepted: disable—Disables transmission of authentication failure traps. enable—Enables 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

1-800-377-8766

Page 2-207


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

Page 2-208

1-800-377-8766


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 RMM-1400 sends a ping to the SNMP host before sending a trap. If the ping is successful, Remote RMM-1400 sends the trap to the host. If the ping is unsuccessful, Remote RMM-1400 saves the trap in a queue and continues to ping the host. When a ping finally succeeds, Remote RMM-1400 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 RMM-1400 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

1-800-377-8766

Page 2-209



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 RMM-1400 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

Page 2-210

1-800-377-8766


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

1-800-377-8766

Page 2-211

Remote RMM-1400 Version 6.4x Command Reference GuideConfiguration Commands: config timeout

config timeout

DescriptionThis command configures the amount of time that can elapse before a Remote RMM-1400 session expires due to inactivity.

Note: The timeout configured does not take effect on any open Remote RMM-1400 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 RMM-1400 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 RMM-1400 session to never timeout due to inactivity.

(Dub)>config

(Dub) config>timeout 20(Dub) config>

WESTELL.COM

Page 2-212

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400 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-213

Remote RMM-1400 Version 6.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 RMM-1400 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 an expansion unit. The following parameter is accepted:

debug—Displays debugging information during wizard execution.

initsetup Specifies the wizard that performs the initial Remote RMM-1400 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 connectionThe following parameter is accepted:


WESTELL.COM

Page 2-214

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400. This wizard can configure any of the three most common serial port setups, which include terminal server and serial-to-IP. 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 additional

configuration options, consult the command reference guide.

Hostname of this device:

WESTELL.COM

1-800-377-8766

Page 2-215

Remote RMM-1400 Version 6.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

Limit a user’s maximum number of concurrent logins

Remove a user’s limit on concurrent logins

Note: Remote RMM-1400 allows for the configuration of up to 20 users.

Formatsconfig users

add username profile password confirm_passworddelete usernamepassword usernamestrong-password { enable | disable }limit username login login limitno limit username

For resetting users:config default users

WESTELL.COM

Page 2-216

1-800-377-8766


Parameters

add Adds a new user to the Remote RMM-1400 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 RMM-1400. 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 RMM-1400 prompts you to do so.

confirm_password—Requires the user to re-enter the assigned password.

delete Deletes a user from the Remote RMM-1400 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.

WESTELL.COM

1-800-377-8766

Page 2-217


Table 12 lists available user profiles and permission levels for Remote RMM-1400.

Command DefaultsUsername admin

Password password


ExamplesThis example displays enabling the strong password feature.

limit Configures a limit on the number of concurrent logins the user is allowed on any of the Remote’s interfaces. When the limit is exceeded, the user will not be allowed to login until the user logs out of another concurrent login. The following parameters are accepted:

username -- Specifies the user whose login limit is being configured.login limit -- Defines the login limit value (1-10).

no limit Removes a concurrent login limit for the named user. The following parameter is required:

username -- Specifies the user whose login limit is being removed.

default Resets the primary user to default user admin and deletes all other users from Remote RMM-1400.

Table 12 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

Page 2-218

1-800-377-8766


This example displays the addition of a user with the name jeff and profile status. Note that the initial password did not meet the criteria for the strong password feature.

This example displays the deletion of the user johndoe from Remote RMM-1400.

This example displays the configuration of a new password for user brb22.

This example displays the resetting of the default username and password.

This example configures a concurrent login limit of 10 for user janedoe:

This example removes a concurrent login limit for user janedoe:

(Dub)>config

(Dub) config>users

(Dub) config users>strong-password enabled

(Dub) config users>

(Dub) config users>add jeff status

Please 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 status

Please 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 brb22

Please enter the new password. ******

Please confirm the new password. ******(Dub) config users>

(Dub)>config

(Dub) config>default users(Dub) config>

(Dub) config>users limit janedoe login 10

(Dub) config>

(Dub) config>users no limit janedoe(Dub) config>

WESTELL.COM

1-800-377-8766

Page 2-219


See Also

password

show users

WESTELL.COM

Page 2-220

1-800-377-8766


WESTELL.COM

1-800-377-8766

Page 2-221


WESTELL.COM

Page 2-222

1-800-377-8766

CHA

PTER 3

Show Commands

This chapter describes all of the Remote RMM-1400 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 RMM-1400 Version 6.4x Command Reference GuideShow Commands: Show Command Overview

Show Command OverviewShow commands display Remote RMM-1400 options, statuses and settings. Typically, the results of what you configure in Remote RMM-1400 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 RMM-1400 Version 6.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. interfaces Displays information for configured

interfaces.

inventory Displays hardware inventory.

--More-- [press space bar to continue list]

WESTELL.COM

1-800-377-8766

Page 3-3

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: List of Show Commands (continued)

List of Show Commands (continued)

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.

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. 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 RMM-1400 Version 6.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 doorOpen332Alm Door open alarm a...

waterLvlAlm waterLvlHigh waterLvl332Alm 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 doorOpenAlm

Action Name : doorOpenAlm

Action Description : Door open alarm action

Event Name : doorOpen

Event Description : Door open indicatorEvent Originator : input 1/1

Event Type : open

Response Name : doorOpen332Alm

Response Description : Door open alarm response

Response Responder : snmpne 2Response Type : snmpalarm

Response Parameters :

almcde=CR msg=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 alarm responses. For more information about response parameters, refer to the response configuration commands.

WESTELL.COM

Page 3-6

1-800-377-8766



config event

config response

Response Responder

Displays a response responder, which processes a response.

Response Type Displays a response type.

Column Description (Continued)

WESTELL.COM

1-800-377-8766

Page 3-7

Remote RMM-1400 Version 6.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 *.

nopage Displays the entire list of alarm entries upon execution of the command. When this parameter is not specified, Remote RMM-1400 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 the first page of central alarm table entries.

This example displays specific information for alarm table entry input0_1.

(Dub)>show

(Dub) show>alarm-entries

Name State Trap Raw Current alarm message------------------------------------------------------------------------------

1_1 informatio + - offline

1_humidity informatio + - humidity offline1_temp informatio + - temp offline

input1_1 normal + - ---

input1_2 normal + - ---input1_3 normal + - ---











--More--

(Dub)>show(Dub) show>alarm-entries name input1_2

Name - input1_2

State - normalCurrent Message -

Description -

Nagging Interval - 0Nagging Level - major

Trap - enabled

Trap Priority - disabledRaw - disabled

Category -

NE Name -Originator - input 1/2

Alarm Actions:

Severity Trigger Message------------------------------------------------------------------

normal open input 1/2 open

critical close input 1/2 close(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 RMM-1400 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

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.

WESTELL.COM

Page 3-10

1-800-377-8766


See Alsoconfig alarm-entry

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 RMM-1400 Version 6.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 : latchOpen

Issue : No response configured

Action : waterLvl

Issue : No event configured

Action : airPressure

Issue : Event e2 missing

Issue : Response r2 missing

Action : a1

Issue : Duplicate event/response pairs: (a1, a2)

Action : a2

Issue : 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>events

Event : e1Issue : Duplicate content: (e1, e2)

Event : analogIntervalIssue : Not used in any actions

Event : tempHighIssue : Not used in any actions

Issue : Not fully configured

Event : e2

Issue : 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>responses

Response : waterLvlAlmIssue : Not used in any actions

Issue : Not fully configured

Response : ethernetDisable

Issue : Not used in any actions

Response : doorOpen

Issue : Not used in any actions

Issue : Duplicate content: (doorOpen, connDestData)

Response : connDestData

Issue : 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 RMM-1400 Version 6.4x Command Reference GuideShow Commands: show banner

show banner

DescriptionThis command displays the Remote RMM-1400 banner.

Formatsshow banner


ExamplesThis example displays the banner configuration for Remote RMM-1400 with the time and date displaying with the text, This is my banner.

See Alsoconfig banner

(Dub)>show(Dub) show>banner

This is my banner.

\d\t

(Dub) show>

WESTELL.COM

Page 3-16

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show clock

show clock

DescriptionThis command displays the configured date and time for Remote RMM-1400.

Formatsshow clock


ExamplesThis example displays the time and date information for Remote RMM-1400. Display items are:

The date, time and year The Remote RMM-1400 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>clock

Thu Jan 14 16:04:50 EST 2010Uptime 2 days, 4:48

The 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 RMM-1400 Version 6.4x Command Reference GuideShow Commands: show compact-flash

show compact-flash

DescriptionThis command displays the flash memory size.

Formatsshow compact-flash


ExamplesThis example displays the size of the compact flash memory.

(Dub)>show

(Dub) show>compact-flash

Compact Flash Size: 262144 kbytes(Dub) show>

WESTELL.COM

Page 3-18

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show config-file

show config-file

DescriptionThis command displays a configuration file. Remote RMM-1400 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 RMM-1400 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 RMM-1400. For more information, refer to running-config on page 5-39.

startup-config This configuration file contains the configuration at start-up time for Remote RMM-1400.

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 RMM-1400.Note: If factory-config is entered for filename, no

information will be displayed. This is because Remote RMM-1400 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-file

factory-config

running-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 RMM-1400

# Version: 2.00

# Created: 2010-11-22,15:40:55.0,+0000# User: janedoe

# Bootloader Version: 1.00

config clock timezone EST -05:00config clock daylight-savings EDT

config ip route default 192.168.105.1

config ip route 10.25.2.5/32 10.39.0.1config ip route 10.34.0.0/16 10.39.0.1

config ip route 10.44.0.0/16 10.39.0.1

config ip route 64.0.0.0/8 interface serial modemconfig ip route 192.168.105.0/25 192.168.105.1

config ip route 192.168.105.128/25 192.168.105.1

config ip route 192.228.36.48/32 interface serial modemconfig iptables -t filter -N bad_state

config iptables -t filter -N wan_input

config iptables -t filter -N wan_input_SCDconfig iptables -t filter -N wan_output

config iptables -t filter -N wan_output_SCD

config iptables -t filter -N vpn_inputconfig iptables -t filter -N vpn_input_SCD

config iptables -t filter -N vpn_output

config iptables -t filter -N vpn_output_SCD--More--

WESTELL.COM

1-800-377-8766

Page 3-21

Remote RMM-1400 Version 6.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.

See Alsoconfig event content

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>connections

script sdata_gc sdata_gcConnector -> serial 2

tcp 10.39.63.111:60003:4 -> serial 3

tcp 10.39.63.111:60004:3 -> serial 4(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.39.63.111 Port number 60003 Internal reference number 4 Accepting endpoint serial 3

WESTELL.COM

Page 3-22

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show connections


WESTELL.COM

1-800-377-8766

Page 3-23

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show controllers

show controllers

DescriptionThis command displays configuration information for all Remote RMM-1400 controllers.

Formatsshow controllers [ * ]

Parameters


ExamplesThis example displays the first screen of detailed information for all configured Remote RMM-1400 controllers.

* Displays configuration information for all controllers.

(Dub)>show(Dub) show>controllers *

bridge switch system-name=br_switch status=enabled oper-state=up

description=10/100 ethernet switch

ethernet 1 system-name=mii0

status=enabled link-state=up

admin-speed=auto oper-speed=10H hardware-address=00:40:72:0F:A8:CA

default-address=00:40:72:0F:A8:CA

proxy-arp=disabled resource-state=unassigned

desc=Switch port


status=enabled link-state=down

admin-speed=auto oper-speed=10H hardware-address=00:40:72:0F:A8:CB

default-address=00:40:72:0F:A8:CB

proxy-arp=disabled resource-state=unassigned

desc=Switch port

--More--

WESTELL.COM

Page 3-24

1-800-377-8766

Remote RMM-1400 Version 6.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-29, show controllers serial on page 3-38 and show controllers openvpn on page 3-33.




show controllers serial

WESTELL.COM

1-800-377-8766

Page 3-25

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show controllers bridge

show controllers bridge

DescriptionThis command displays configuration information for all Remote RMM-1400 bridge controllers or for a specified Remote RMM-1400 bridge controller.

Formatsshow controllers bridge

*switch [ mac ]

Parameters


ExamplesThis example displays information for Remote RMM-1400 controller bridge switch.

* 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.

(Dub)>show

(Dub) show>controllers bridge switch

bridge switch system-name=br_switch status=enabled oper-state=up description=10/100 ethernet switch

(Dub) show>

WESTELL.COM

Page 3-26

1-800-377-8766


This example displays MAC addresses with their associated ports on bridge switch.

(Dub)>show

(Dub) show>controllers bridge switch mac

Controller MAC Address Is Local? Age(sec)

-------------------------------------------------------------------------ethernet 3 00:01:02:CC:3E:8F no 19

ethernet 3 00:04:76:9C:39:01 no 247

ethernet 3 00:04:76:9C:3F:07 no 19ethernet 3 00:0B:DB:69:9F:19 no 57

ethernet 3 00:0B:DB:69:9F:4A no 19

ethernet 3 00:0B:DB:7A:BA:25 no 38ethernet 3 00:0B:DB:83:76:85 no 19

ethernet 3 00:0C:29:B8:A6:FF no 57

ethernet 3 00:0F:20:DB:39:F5 no 38ethernet 3 00:11:43:9C:B3:A7 no 19

ethernet 3 00:13:72:96:2F:65 no 171

ethernet 3 00:14:22:46:2C:A6 no 133ethernet 3 00:1A:A0:A1:59:37 no 0

ethernet 3 00:1A:A0:A1:65:A9 no 247

ethernet 3 00:1C:23:01:E8:1A no 133ethernet 3 00:1C:23:21:35:D9 no 209

ethernet 3 00:21:F7:6D:08:00 no 0

ethernet 3 00:40:72:00:CD:29 no 19ethernet 3 00:40:72:00:E9:01 no 38

ethernet 3 00:40:72:04:7C:34 no 133

ethernet 3 00:40:72:04:7C:67 no 38ethernet 3 00:40:72:04:A0:DB no 0

ethernet 3 00:40:72:08:3B:62 no 19

ethernet 3 00:40:72:0B:E7:32 no 0ethernet 3 00:40:72:0D:1C:72 no 0

ethernet 3 00:40:72:0D:1C:8D no 0

ethernet 3 00:40:72:0E:66:34 no 0ethernet 3 00:40:72:0E:67:10 no 171

ethernet 3 00:40:72:0E:68:F4 no 0

ethernet 1 00:40:72:0E:68:FD no 0ethernet 3 00:40:72:0F:A8:A1 no 209

ethernet 3 00:40:72:0F:A8:FB no 209

ethernet 3 00:40:72:0F:A9:19 no 171ethernet 3 00:80:F0:5F:87:7C no 19

(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.


show controllers


Age(sec) Displays the MAC address age in seconds.

Controller Displays the controller associated with the MAC address.

description Displays the configured bridge controller description.

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.

oper-state Displays the operational state of the controller (the state the controller is actually in) as up or down.

status Displays the controller state as enabled or disabled.

system-name Displays the controller’s system name (for example, br_switch).

WESTELL.COM

Page 3-28

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show controllers ethernet

show controllers ethernet

DescriptionThis command displays configuration information for all Remote RMM-1400 Ethernet controllers or for a specified Remote RMM-1400 Ethernet controller.

Formatsshow controllers ethernet [ * | 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.

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 2


status=enabled link-state=down admin-speed=auto oper-speed=10H

hardware-address=00:40:72:0F:A8:CB

default-address=00:40:72:0F:A8:CB proxy-arp=disabled

resource-state=unassigned

desc=Switch port(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-29


Example DescriptionsThe following table defines the display items that appear in the previous example. Display items are listed in alphabetical order.


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 RMM-1400 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.

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.

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).

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.

resource-state Displays if the Ethernet controller is assigned to be tracked as a resource or not.


WESTELL.COM

Page 3-30

1-800-377-8766




show controllers

system-name Displays the controller’s system name (for example, hdlc0 or eth0_1).


WESTELL.COM

1-800-377-8766

Page 3-31

Remote RMM-1400 Version 6.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

(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-32

1-800-377-8766

Remote RMM-1400 Version 6.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


name Specifies the name of the OpenVPN controller.

clients Displays the clients connected to an OpenVPN server or site server. Typically, the Remote RMM-1400 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-33


ExamplesThis example displays detailed information for OpenVPN controller client:

Example DescriptionsThe following table defines the display items that appear in the previous examples. Display items are listed in alphabetical order.

(Dub)>show controllers openvpn client

openvpn client system-name=ovpn_client

status=enabled link-state=up 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-response, Sat Apr 11 16:42:40 GMT 2009

cert-subject=/O=AI/CN=ATTRMM-1400

cert-validity-start=Fri Nov 7 05:00:00 GMT 2008 cert-validity-end=Thur 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 Displays the common name (CN) of this network element, configured using Director SCD or built-in the Remote RMM-1400 for the site-server.

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 way of a VPN connection.

WESTELL.COM

Page 3-34

1-800-377-8766


connected Displays the time and date that a client was connected to the OpenVPN server.

default-address Displays the default hardware address, which represents the controller’s hardware address when Remote RMM-1400 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.

link-state Displays the state of the controller’s link as up or down.

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.

status Displays the controller or channel group state as enabled or disabled.

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-35


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-36

1-800-377-8766





show controllers

WESTELL.COM

1-800-377-8766

Page 3-37

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show controllers serial


DescriptionThis command displays configuration information for all Remote RMM-1400 serial controllers or for a specified Remote RMM-1400 serial controller. It also displays G.826 and RFC-1406 statistics.

Formatsshow controllers serial

*port{ EVDO port | HSPA port } [ nai | namval | diagnostics]LTE port diagnostics

Parameters


Examples

* Displays configuration information for all serial controllers.

port Selects an asynchronous serial port number. Valid values for Remote RMM-1400 are 1 to 4.

EVDO portHSPA port

Displays serial controller information about the EVDO or HSPA wireless modem. 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 thenamval or nai commands. For more information, see the config controller serial command.

LTE port Displays serial controller information about the LTE wireless modem. The following parameter is accepted: diagnostics—Displays detailed diagnostic information about

the modem.

WESTELL.COM

Page 3-38

1-800-377-8766


This example displays the configuration information for asynchronous serial controller serial 2.

This example displays the configuration information for controller serial modem:

This example displays the configuration information for controller serial modem using an LTE modem:

Example Descriptions

(Dub)>show

(Dub) show>controllers serial 2serial 2 status=enabled link-state=up encapsulation= baud=9600 databits=8

stopbits=1 parity=none resource-state=unassigned

flow-control=none linemode=rs232

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

description=Asynchronous port

application=source destination(Dub) show>

(Dub)>show

(Dub) show>controllers serial modemserial modem status=enabled link-state=up encapsulation=ppp

init-string=AT+CGDCONT=1,"IP","isp.cingular" AT ATD*99***1#

resource-state=assigned signal-strength=fair (-88 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>

(RMM107) show>

(RMM107) show>cont ser modem

serial modem status=enabled link-state=up resource-state=unassigned signal-strength=excellent (-76 dBm) service-level=LTE sim=ready

apn= default-route=false

auth-method=none auth-username= prl-version=3

description=LTE Modem

(RMM107) show>

WESTELL.COM

1-800-377-8766

Page 3-39


The following table defines the display items that appear in the previous examples. Display items are listed in alphabetical order.


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.

baud Displays the controller baud rate. The baud rate is the speed of the asynchronous connection in bits per second.

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.

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 RMM-1400 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.

dial-timer Displays the amount of time Remote RMM-1400 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.

WESTELL.COM

Page 3-40

1-800-377-8766


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.

encapsulation Displays the encapsulation protocol for the serial controller as PPP.

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).

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.

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 RMM-1400’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-41


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.

link-state Displays the state of the controller’s link as up or down.

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 RMM-1400 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).

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.

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.

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 RMM-1400.


WESTELL.COM

Page 3-42

1-800-377-8766





show controllers

remote-method Displays the method used by a peer device to authenticate Remote RMM-1400 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.

signal-strength Displays the signal strength (in dBm) for the modem along with an associated rating of very poor, poor, fair, good, or excellent.


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.


WESTELL.COM

1-800-377-8766

Page 3-43

Remote RMM-1400 Version 6.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 inputs

DoorAlarms false input 0/1 open and input 0/2 Correlation for open door

alarms(Dub) show>

WESTELL.COM

Page 3-44

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show correlations

This example displays detailed information for correlation event BothClosed.

See Alsoconfig event


config correlation

(Dub)>show correlation BothClosed

Name: BothClosed

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

True Duration: 900False Duration: 0

Evaluation: true and true = true

Value: 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

1-800-377-8766

Page 3-45

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show debugging

show debugging

DescriptionThese commands display the status of event debugging on Remote RMM-1400.

Formatsshow debugging

dhcp-clientethernetlevelmediationopenvpnpppsnmp

Parameters

dhcp-client

Displays the status of event debugging for DCHP 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 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.

snmp Displays the status of event debugging for SNMP events.

WESTELL.COM

Page 3-46

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show debugging


ExamplesThis example displays the status of debug information logging for Ethernet controllers and interfaces.

See Alsodebug dhcp-client

debug level

debug mediation

debug openvpn

debug ppp

debug snmp

(Dub)>show

(Dub) show>debugging

(Dub) show debugging>ethernetDebug controller: enabled

Debug interface: disabled

(Dub) show debugging>

WESTELL.COM

1-800-377-8766

Page 3-47

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show dhcp-relay

show dhcp-relay

DescriptionThis command displays BOOTP/DHCP relay configuration information for Remote RMM-1400.

Formatsshow dhcp-relay


ExamplesThis example displays BOOTP/DHCP relay configuration information for Remote RMM-1400.

See Alsoconfig dhcp-relay

(Dub)>show

(Dub) show>dhcp-relaybootp/DHCP relay is enabled

bootp/DHCP relay servers:

10.40.57.5010.40.2.2

10.40.57.60

(Dub) show>


bootp/DHCP relay is Displays one of the following: enabled if BOOTP/DHCP relay is enabled on

Remote RMM-1400 disabled if BOOTP/DHCP relay is disabled on

Remote RMM-1400

bootp/DHCP relay servers

Displays the IP address of each BOOTP/DHCP server.

WESTELL.COM

Page 3-48

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show dhcp-server

show dhcp-server

DescriptionThis command displays DHCP server configuration information for Remote RMM-1400.

Formatsshow dhcp-server


ExamplesThis example displays DHCP server configuration information for Remote RMM-1400.

(Dub)>show(Dub) show>dhcp-server

Admin State: enabled

Broadcast: enabledAuthority: enabled

Config 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 RMM-1400.

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

1-800-377-8766

Page 3-49


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 RMM-1400 (if a file name has been configured on Remote RMM-1400).

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 RMM-1400 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

Page 3-50

1-800-377-8766


See Alsoconfig dhcp-server


config dhcp-server subnet

WESTELL.COM

1-800-377-8766

Page 3-51

Remote RMM-1400 Version 6.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/powerMon | 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. 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.

powerMon—Displays information for the third power monitor, which is an analog input used to monitor voltage for an external, isolated power supply.

temperature—Displays 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.Note: 0 represents the on-board discrete I/O subsystem.

WESTELL.COM

Page 3-52

1-800-377-8766



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. unit—Defines the peripheral unit number. Valid values are 0 to 12.

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

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. unit—Defines the peripheral unit number. Valid values are 0 to 12.

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

(Dub)>show

(Dub) show>discrete(Dub) show discrete>analogs

ID State Resource State Value Mode Interval Description

0/power disable unassigned 0.1 V voltage 0 0/powerB disable unassigned 41.0 V voltage 0

0/powerMon disable unassigned 0.4 V voltage 0

1/1 disable unassigned 0.00 V voltage 0 1/2 disable unassigned 7.01 V voltage 0

1/3 disable unassigned 0.00 V voltage 0

1/4 disable unassigned 7.00 V voltage 0 1/5 disable unassigned 0.006 mA current 0

1/6 disable unassigned 9.74 mA current 0

1/7 disable unassigned 0.006 mA current 0 1/8 disable unassigned 9.80 mA current 0

1/humidity disable unassigned 19 %RH 0

1/temperature disable unassigned 27 C celsius 0(Dub) show discrete>

Column Description

Description Displays the configured descriptions for associated analog inputs.

ID Displays the unit numbers and point numbers for all analog inputs.

WESTELL.COM

1-800-377-8766

Page 3-53


This example displays information for input analog 1/5.

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 1/5ID - 1/5

Description - Gas Sensor

State - enableResource State - unassigned

Low Band - 8

High Band - 14Hysteresis - 2

Interval - 17

Max Loop Value - 13Min Loop Value - 5

Max Sensor Reading - 15

Min Sensor Reading - 7

Units - mAMode - current

Value - 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.

ID Displays the unit number and point number for the analog input.


WESTELL.COM

Page 3-54

1-800-377-8766


This example displays information for all digital outputs.

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) if the specified analog input is operating in voltage mode.

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) if the specified analog input is operating in voltage mode.

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>outputs

ID Resource State Value Description

1/1 unassigned open Connection up 1/2 unassigned closed

1/3 unassigned closed

1/4 unassigned open(Dub) show discrete>


WESTELL.COM

1-800-377-8766

Page 3-55


This example displays information for discrete output 1/4.




(Dub)>show(Dub) show>discrete

(Dub) show discrete>outputs 1/4

ID - 1/4Description - This is the output point for a pressure gauge

Value - 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

Page 3-56

1-800-377-8766

Remote RMM-1400 Version 6.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 1/3 open This event signal...

40010 tcp 40010 incoming-connectiotcp_serial_0001 tcp 60001 incoming-connectio IP to serial port...

waterLvl input 1/4 close This event signal...

(Dub) show>

(Dub)>show

(Dub) show>events doorOpen

Event Name : doorOpenEvent Description : This event signals when a door is opened.

Event Originator : input 1/3

Event Type : open(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-57

Remote RMM-1400 Version 6.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

Page 3-58

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400.

Formatsshow expansion-images


WESTELL.COM

1-800-377-8766

Page 3-59


ExamplesThis example displays the installed discrete expansion peripheral executable image, serial expansion peripheral executable image, bistate expansion peripheral executable image and their associated stage 2 bootloader images.

(Dub)>show

(Dub) show>expansion-images

discrete-expansion/boot.img

--------------------------------------------------Product: AIExpansion-Shelf

Version: 1.60

Build date: 2010-07-29,16:46:54.0,-04:00Build ID: 006

Image type: AIModExpan-Production

Production release.

discrete-expansion/stage2boot.img

--------------------------------------------------Version: 3.10

Build date: Thu Jul 6 13:52:11 EDT 2006

Image type: AI160-Stage2Boot

serial8-expansion/boot.img

--------------------------------------------------Product: AIExpansion-Shelf

Version: 1.60

Build date: 2010-07-29,16:46:54.0,-04:00Build ID: 006

Image type: AIModExpan-Production

Production release.

serial8-expansion/stage2boot.img

--------------------------------------------------Version: 3.11

Build date: Thu Jul 27 11:38:32 EDT 2006


bistate48-expansion/boot.img

--------------------------------------------------

Product: AIExpansion-ShelfVersion: 1.60

Build date: 2010-07-29,16:46:54.0,-04:00

Build ID: 006Image type: AIModExpan-Production

Production release.

bistate48-expansion/stage2boot.img

--------------------------------------------------

Version: 3.11Build date: Thu Jul 27 11:38:38 EDT 2006


fb64-expansion/boot.img

--------------------------------------------------

--More--

WESTELL.COM

Page 3-60

1-800-377-8766


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

1-800-377-8766

Page 3-61

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces

show interfaces

DescriptionThis command displays information and statistics for Remote RMM-1400 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 RMM-1400 interfaces.

* Displays information and statistics for all Remote RMM-1400 interfaces.

WESTELL.COM

Page 3-62

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces



config interface openvpn


show interfaces bridge



show interfaces serial modem

(rmm28)>show

(rmm28) show>interface *

bridge switch system-name=br_switch

status=enabled link-state=up nat64=disabled address=10.39.73.28/16

link-local-address=169.254.70.95/16

Stats: Bytes Packets Errors Dropped Overrun Framing Rx 440730694 4549495 0 0 0 0

Tx 15889488 81533 0 0 0 0

ethernet 1

Stats: Bytes Packets Errors Dropped Overrun Framing

Rx 0 19182 0 0 0 0 Tx 0 7259 0 0 0 0

ethernet 2 Stats: Bytes Packets Errors Dropped Overrun Framing

Rx 0 0 0 0 0 0

Tx 0 0 0 0 0 0

ethernet 3


Tx 0 252 0 0 0 0

ethernet 4


Rx 0 0 0 0 0 0 Tx 0 0 0 0 0 0

(rmm28) show>

WESTELL.COM

1-800-377-8766

Page 3-63

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces bridge

show interfaces bridge

DescriptionThis command displays information and/or statistics for the bridge interface on Remote RMM-1400.

Formatsshow interfaces bridge [ switch | * ]

Parameters


ExamplesThis example displays information and statistics for interface bridge switch and statistics for all the ports included in bridge switch.

* Displays configuration information and statistics for the bridge interface.

switch Displays configuration information and statistics for the bridge switch interface.

WESTELL.COM

Page 3-64

1-800-377-8766


Note: Statistics not collected by Remote RMM-1400 will display as zeroes.

(RMM103)>show

(RMM103) show>interfaces bridge switch

bridge switch system-name=br_switch

status=enabled link-state=up nat64=disabled address=10.39.90.103/16

link-local-address=169.254.93.27/16

ipv6 admin-state=enabled oper-state=enabled mode=host address=fc10::39:0:0:a27:5a67/64

valid=forever preferred=forever

address=fc10::39:240:72ff:fe0f:a8f1/64 valid=2591683sec preferred=604483sec dynamic

address=fe80::240:72ff:fe0f:a8f1/64

valid=forever preferred=forever Stats: Bytes Packets Errors Dropped Overrun Framing

Rx 675362794 7322290 0 0 0 0

Tx 4611758 22795 0 0 0 0

ethernet 1


Tx 0 0 0 0 0 0

ethernet 2


Rx 0 0 0 0 0 0 Tx 0 0 0 0 0 0

ethernet 3 Stats: Bytes Packets Errors Dropped Overrun Framing

Rx 0 0 0 0 0 0

Tx 0 0 0 0 0 0

ethernet 4


Tx 0 22692 0 0 0 0

(RMM103) show>


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.

WESTELL.COM

1-800-377-8766

Page 3-65



show interfaces

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.

Tx Packets Displays the number of error-free packets transmitted from the interface.


WESTELL.COM

Page 3-66

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces ethernet


DescriptionThis command displays information and/or statistics for Ethernet interfaces on Remote RMM-1400.

Formatsshow interfaces ethernet [ * | 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.

(Dub)>show(Dub) show>interfaces ethernet *


status=enabled link-state=down desc=Ethernet interface 2

address=23.67.0.4/16


Tx 0 0 0 0 0 0


status=enabled link-state=down

address=23.68.0.3/16 secondary-address=23.69.0.3/16


Rx 0 0 0 0 0 0 Tx 0 0 0 0 0 0

(Dub) show>


address Displays the IP address for the interface.

desc Displays a description for the interface.

WESTELL.COM

1-800-377-8766

Page 3-67









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-68

1-800-377-8766



show interfaces

WESTELL.COM

1-800-377-8766

Page 3-69

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces openvpn


DescriptionThis command displays information and/or statistics for OpenVPN interfaces on Remote RMM-1400.

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

address=12.35.64.34/16


Tx 0 0 0 0 0 0

(Dub) show>






WESTELL.COM

Page 3-70

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces openvpn

See Alsoconfig interface openvpn

show interfaces














WESTELL.COM

1-800-377-8766

Page 3-71

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces serial modem

show interfaces serial modem

DescriptionThis command displays information and/or statistics for serial interfaces on Remote RMM-1400.

Formatsshow interfaces serial modem


ExamplesThis example displays information and statistics for interface serial modem.


(Dub)>show(Dub) show>interface serial modem

serial modem name=serial modem system-name=ppp_modem

status=enabled link-state=up address=32.178.157.24 pointopoint=10.64.64.64


Rx 2000533 17288 0 0 0 0 Tx 2885841 20472 0 0 0 0

(Dub) show>




pointopoint Displays the remote device IP address for the interface.




WESTELL.COM

Page 3-72

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show interfaces serial modem

See Alsoconfig interface serial













WESTELL.COM

1-800-377-8766

Page 3-73

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show inventory

show inventory

DescriptionThis command displays information for each existing Remote RMM-1400 hardware component.

Formatsshow inventory


ExamplesThis example displays information for each existing Remote RMM-1400 hardware component.

(Dub)>show

(Dub) show>inventoryName Slot Manufacturer Part no. Serial Manf. date Version

KTX544 Kentrox B544-0.0:0 09460064 12/01/09 1.00b001

(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 KTX544, which is the Remote RMM-1400 motherboard.

Part no. Displays the part number for the hardware component.

Serial Displays the serial number for the hardware component.

Slot Not used.

Version Displays the version of the stage 1 bootloader.

WESTELL.COM

Page 3-74

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show ip

show ip

DescriptionThis command displays the configured IP settings for Remote RMM-1400.

Formatsshow ip

arp [ configured ]domain-nameforwardname-serverroute [ configured ]

Parameters

arp Displays the Remote RMM-1400 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 RMM-1400. 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 RMM-1400 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-75



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 RMM-1400.

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 Address

10.39.0.1 00:21:F7:6D:08:00

192.168.105.1 00:FF:5C:D6:EB:9A10.39.3.102 00:01:02:CC:3E:8F

(Dub) show ip>

(Dub)>show(Dub) show>ip

(Dub) show ip>domain-name

Domain 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-server

Primary DNS Server: 10.45.73.2Secondary DNS Server: 12.74.56.26

(Dub) show ip>

WESTELL.COM

Page 3-76

1-800-377-8766


This example displays the contents of the IP routing table for Remote RMM-1400.

(Dub)>show

(Dub) show>ip

(Dub) show ip>route

Destination Gateway Interface Flags0.0.0.0/0 192.168.105.1 openvpn client Up

10.34.0.0/16 10.39.0.1 bridge switch Up

10.64.64.64/32 0.0.0.0 serial modem Up Host127.0.0.0/8 0.0.0.0 * Up Reject

127.0.0.1/32 0.0.0.0 lo Up Host

169.254.0.0/16 0.0.0.0 bridge switch Up192.168.105.0/24 0.0.0.0 openvpn client 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-77


This example displays routes that have been manually configured by users for Remote RMM-1400.

See Alsoconfig ip

(Dub)>show

(Dub) show>ip(Dub) show ip>route configured

Destination Gateway/Interface Preference

default openvpn client10.40.65.76/32 ethernet 1 60

192.168.100.0/25 192.168.100.1 100

192.168.100.128/25 192.168.100.1 90192.167.20.0/24 10.45.0.2 50

192.167.20.0/24 serial modem 70

(Dub) show ip>

WESTELL.COM

Page 3-78

1-800-377-8766

Remote RMM-1400 Version 6.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-79


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)


-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)


-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-80

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>details

Table 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)


Table filter

-------------------------------------------------------Chain INPUT (policy ACCEPT 19407 packets, 2897K bytes)


475K 26M ACCEPT all -- lo * 0.0.0.0/0 0.0.0.0/0

Chain FORWARD (policy ACCEPT 0 packets, 0 bytes)


WESTELL.COM

1-800-377-8766

Page 3-81



Remote RMM-1400 Version 6.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 RMM-1400 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 RMM-1400. The job run history count defines the amount of job runs for which Remote RMM-1400 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 RMM-1400. These include the current number of configured, running and completed jobs along with their completion states.

summary Lists a summary of all Remote RMM-1400 jobs and their related attributes.

WESTELL.COM

Page 3-82

1-800-377-8766


ExamplesThis example displays information about the most recent execution of each configured Remote RMM-1400 job.

This example displays the current maximum run history count of 25.

(Dub)>show(Dub) show>jobs

(Dub) show jobs>history

Job Run ID Start time End time Exit statejob1 1 2010/01/14 14:15:39 2010/01/14 14:17:21 killed

job2 2 2010/01/14 14:15:54 2010/01/14 14:16:05 abnormal

job3 1 2010/01/14 14:16:14 2010/01/14 14:16:09 abnormaljob4 1 2010/01/14 14:16:40 2010/01/14 14:16:55 abnormal

job5 1 2010/01/14 14:19:11 2010/01/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-runs

Maximum history runs: 25

(Dub) show jobs>

WESTELL.COM

1-800-377-8766

Page 3-83


This example displays Remote RMM-1400 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.

See Alsoconfig jobs

(Dub)>show

(Dub) show>jobs(Dub) show jobs>statistics

Jobs configured: 7

Jobs running: 1Jobs completed: 14

Normal: 4

Killed: 5 Abnormal: 5

(Dub) show jobs>

WESTELL.COM

Page 3-84

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400. 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 RMM-1400 job properties.

starts Displays a list of start times for a Remote RMM-1400 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-85



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 jobs>name myjob

(Dub) show jobs name myjob->history

Run ID Start time End time Exit state

1 2010/01/15 21:24:54 2010/01/15 21:25:12 killed 2 2010/01/15 21:25:25 2010/01/15 21:25:29 normal

3 2010/01/15 21:25:32 2010/01/15 21:26:09 killed

4 2010/01/15 21:26:19 2010/01/15 21:26:30 normal 5 2010/01/15 21:26:34 2010/01/15 21:26:39 abnormal

(Dub) show jobs name myjob->


(Dub) show jobs>name myjob

(Dub) show jobs name myjob

->history 3Run ID: 3

Start: 2010/01/15 21:25:32

End: 2010/01/15 21:26:09Exit state: killed

(Dub) show jobs name myjob->

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.

WESTELL.COM

Page 3-86

1-800-377-8766


This example displays the property names and values for job anotherjob.

This example displays the start specifications for job AnotherJob.

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 Value

duration 1000

exitcode 245stopdelay 10


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.

(Dub)>show

(Dub) show>jobs(Dub) show jobs>name anotherjob


->starts *Cron start: disabled

Start at bootup: disabled

Start-at index: 1 Month: 8

Day: 4

Hour: 12 Minute: 35

Weekday: 4

No scheduled start time(Dub) show jobs name anotherjob


WESTELL.COM

1-800-377-8766

Page 3-87


This example displays the status of job samplejob.


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 RMM-1400 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.

(Dub)>show

(Dub) show>jobs

(Dub) show jobs>name samplejob

(Dub) show jobs name samplejob->status

Job: samplejob

Package: jobtestutilsMin version: any

Script: normal

Title: SampleJobCron start: disabled

Start at boot: disabled

Memory limit (Kb): 2560Stack size (Kb): 1024

Output capture: disabled

Max start attempts: 1Run state: running

Run ID: 4

Start attempt: 1 Start time: 2010/01/08 18:41:29

Debugging: disabled

Checking: disabled Memory usage (Kb): 2026

(Dub) show jobs name samplejob

WESTELL.COM

Page 3-88

1-800-377-8766


Note: The following display items appear only if the status display is for a running job.


Cron start Displays the cron start status.

Job Displays the job name.

Max start attempts

Displays the number of times that Remote RMM-1400 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.

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 RMM-1400 has attempted to start the job.

WESTELL.COM

1-800-377-8766

Page 3-89


This example displays the configured tasks and task properties configured for job AnotherJob.

See Alsoconfig jobs

config jobs name


Start time Displays the date and time that the job started.


(Dub) show jobs>name anotherjob

(Dub) show jobs name anotherjob->task *

Task: xmlrpc

Position: 1 Type: serversocket

Properties:

Name Value defer true

interface br_switch



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

Page 3-90

1-800-377-8766

Remote RMM-1400 Version 6.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.

WESTELL.COM

1-800-377-8766

Page 3-91

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show licenses

(RMM103)>show

(RMM103) show>licenses

Package '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-92

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show listeners

show listeners

DescriptionThis 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>listeners

Listeners: serial 1

serial 2

serial 3 serial 4

tcp 0.0.0.0:40010

(Dub) show>


serial 1 to serial 4

Displays the serial ports that are listening for mediation connections.

tcp 0.0.0.0:40010

Displays the TCP destinations that are listening for mediation connections.

WESTELL.COM

1-800-377-8766

Page 3-93

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show log-file

show log-file

DescriptionThis command displays the Remote RMM-1400 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 messages and certain transaction details. In Remote RMM-1400, 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 RMM-1400 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 RMM-1400, 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 RMM-1400. 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.

terse Displays a less-detailed version of the Remote RMM-1400 log file.Note: All terse information is cleared from the log file each time

Remote RMM-1400 is reset.

verbose Displays a more-detailed version of the Remote RMM-1400 log file.

WESTELL.COM

Page 3-94

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show log-file

Command DefaultsTerse

20 lines


ExamplesThis example displays the last (most recent) 10 lines of a less-detailed (terse) version of the Remote RMM-1400 log file.

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

(Dub) show>log-file 1020090204:030113:-0500:

- ai-periph-ether:MgmtCommUp: Management communication established to peripher

al "RMB1-0E68FA".20090204:030113:-0500:

- ai-periph-ether:PeriphOnline: Peripheral "RMB1-0E68FA" Online.

20090204:030113:-0500:- ai-periph-ether:PeriphManaged: Peripheral "RMB1-0E68FA" Managed.

20090204:030114:-0500:

- :20090204:034747:-0500:

- ai-fnd-core:InternalLogicError: Internal logic error: Closing data manager w

ith open transaction(Dub) show>

(Dub)>show log-file 200 search “[ethernet 1-4]”

20130324:225251:-0400: ethernet 2: port state down20130324:225251:-0400: ethernet 3: port state down

20130324:225251:-0400: ethernet 1: port state up

20130324:225251:-0400: ethernet 4: port state up(Dub)>show

WESTELL.COM

1-800-377-8766

Page 3-95

Remote RMM-1400 Version 6.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 RMM-1400 outputs the list of measurement table entries one page at a time.

(Dub)>show meas-table

Number of measurements - 28Length of History - 7 day(s), 0 hour(s)

Time Interval - 15

(Dub)>

WESTELL.COM

Page 3-96

1-800-377-8766


This example displays a list of measurement table entries.

(Dub)>show

(Dub) show>meas-table entries

Name State Value Units

------------------------------------------------------------------------------phoenixBattCellTemp1 input-saturated 18 C

phoenixBattCellTemp2 input-saturated 18 C

phoenixBattString input-saturated 54.5 Volts(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-97


This example displays detailed information for measurement table entry jltest.

(Dub)>show(Dub) show>meas-table entries jltest

Name - jltest (static)

Status - highOriginator - analog 1/1

Description -

NE Name - neNameOfJltestCategory - categoryOfJltest

Report Interval - 5

Low-Band - 20.0High-Band - 80.0

Hysteresis - 0.0

Max-Limit - 90.0Min-Limit - 10.0

Units - gallons

Current Value - 89.3

Interval Value - 89.3

Interval Minimum - 89.3Interval Maximum - 89.3

Interval 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-98

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-99

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show mediation

show mediation

DescriptionThis command displays summaries of all configured SNMP options and SNMP network elements.

Formatsshow mediation

snmp { event-templates [ name ] | manager | measurement-templates [ name ] | ne-templates [ name ] | point-templates [ name ] }

snmpnes [ name ]tacacs-service

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.

WESTELL.COM

Page 3-100

1-800-377-8766



ExamplesThis example displays a summary of all configured SNMP event templates.

This example displays the details of the coldStartDef SNMP event template.

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.

(Dub) show mediation snmp(Dub) show mediationsnmp>event-templates

Name Description

--------------------------------------coldStartDef

configChangeDef

ifDownDefifUpDef

peiphDef peripheral online/offline event-template description

(Dub) show mediation snmp>

(Dub) show mediation snmp

(Dub) show mediation snmp>event-templates coldStartDef

Name: 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.

WESTELL.COM

1-800-377-8766

Page 3-101


This example displays the settings for the mediation SNMP manager.

This example displays a summary of all configured SNMP point templates.

This example displays the details of the ifEntryDef SNMP point 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.


(Dub) show mediationsnmp>managerManager Port: 162



Manager Port Displays the port number for the SNMP manager.


(Dub) show mediation snmp>point-templates

Name Description--------------------------------------

alarmTableDef

ifEntryDef Entry in ifTable(Dub) show mediation snmp>

(Dub)>show mediation snmp

(Dub) show mediation snmp>point-templates ifEntry

Name: ifEntryDescription: Entry in ifTable

Poll OID: .1.3.6.1.2.1.2.2.1.8.$(ifIndex)

Offline Severity: criticalOffline Message: Interface $(point) is offline

State: 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)



WESTELL.COM

Page 3-102

1-800-377-8766


This example displays a summary of all configured SNMP measurement templates.


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.

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.


->measurement-templates

Name Description-------------------------------------------------------------------------------

alDef Single measurement

alTableDef Measurement group(Dub) show mediation snmp>

WESTELL.COM

1-800-377-8766

Page 3-103


This example displays the details of the alDef SNMP measurement template.

This example displays a summary of all configured SNMP NE templates.

(Dub)>show mediation snmp->measurement-templates alDef

Name: alDef

Description: Single measurementPoll OID: .1.3.6.1.4.1.539.42.2.2.1.5.$(alIndex)

Value Match Index: 2

Value 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)



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-templates

Name Description

-------------------------------------------------------------------------------Template1 Sample template

Template2 DeviceB Template


WESTELL.COM

Page 3-104

1-800-377-8766


This example displays the details of the Template1 SNMP NE template.

This example displays a summary of all configured SNMP network elements.

(Dub)>show mediation snmp

(Dub) show mediation snmp>ne-templates Template1

Name: Template1

Description: 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.60remoteslowv1 10.34.68.60

MyNE 10.40.65.90 My proxied NE


WESTELL.COM

1-800-377-8766

Page 3-105


This example displays the details of the MyNE mediation SNMP NE.

(Dub) show mediation (Dub) show mediation>snmpnes MyNE

Name: MyNE

Description: My proxied NEHost: 10.40.65.90:161

SNMP Community: administrator

SNMP Version: v1NE Name: MyNE

Category: some-category

Connectivity OID: .1.3.6.1.2.1.1.2.0Connectivity State: Online

Last Connectivity Poll Reply: Mon Jun 25 17:49:24 GMT 2008

Event: reboot Template: coldStart

Last Trap: Mon Jun 25 17:49:24 GMT 2008

Measurement: 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-106

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-107


See Alsoconfig mediation snmpne






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.


WESTELL.COM

Page 3-108

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show ntp

show ntp

DescriptionThis command displays the current NTP configuration for Remote RMM-1400.

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 mediation tacacs-service

(Dub)>show

(Dub) show>ntp

NTP is enabled.Preferred NTP server: 10.50.18.33

Secondary NTP server: 10.50.18.32

Poll interval is 2^6 (64) - 2^10 (1024) seconds(Dub) show>

(Dub)>show

(Dub) show>ntpNTP is disabled.

Preferred NTP server: 10.50.18.33

Secondary NTP server: 10.50.18.32Poll interval is 2^6 (64) - 2^10 (1024) seconds

(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-109

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show peripherals

show peripherals

DescriptionThese commands display information for all peripherals discovered by Remote RMM-1400 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

Note: The only currently supported peripheral units for Remote RMM-1400 are RMB-1 and RMB-2. Other peripheral units managed by other Kentrox devices may appear in response to the show peripherals command, as shown in the example below.

unit Specifies a peripheral unit number for display. The following parameter is accepted:

unit—Defines the peripheral unit number. Valid values are 1 to 12.

WESTELL.COM

Page 3-110

1-800-377-8766


ExamplesThis example displays information pertaining to all discovered peripherals. Note that only peripheral RMB1-0E68FD is managed by Remote RMM-1400.

This example displays administrative and operational information for managed peripheral RMB1-0E68FD.

(Dub)>show(Dub) show>peripherals

Name State IP Manager IP Manager Name

------------------------------------------------------------------------------BIS48-0D1C8D Unmanaged 169.254.115.212 0.0.0.0

DEP-083B62 OtherManaged 169.254.44.105 10.39.64.81 AI

FB64-0D1C72 Unmanaged 169.254.88.111 0.0.0.0RMB1-0E68FD Online 0.0.0.0 10.39.90.2 RMM1400

SER8-04A0DB Unmanaged 169.254.171.198 0.0.0.0

Unit Name IP Description

------------------------------------------------------------------------------

1 RMB1-0E68FD 0.0.0.02

3

45

6

78

9

1011

12

(Dub) show>

(Dub)>show(Dub) show>peripherals unit 1

Unit number: 1

Description:Type: rmb-1

Admin state: Managed

Name: RMB1-0E68FD

IP address: 0.0.0.0

Oper state: OnlineManager name: RMM1400

Manager IP address: 10.39.90.2

Type: RMB-1Model: B684-00.A:0

Firmware version: 1.00

Firmware build date: Jan 11 2010 15:21:20Firmware build ID: 003

Serial number: 0000000001

Manufacture date: 12/18/09Stage2 bootloader version: 1.00

Stage2 bootloader build date: 11/05/09

MAC address: 00:40:72:0E:68:FD

(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-111



Admin state Displays the current administrative state of the peripheral.

Description Displays the user-configured description for 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 RMM-1400 currently managing the peripheral, or no text if the peripheral is unmanaged.

Manager name Displays the host name of the Remote RMM-1400 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.

WESTELL.COM

Page 3-112

1-800-377-8766



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-113

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show pkgs

show pkgs

DescriptionThis command displays a summary of a specified package for Remote RMM-1400. 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 RMM-1400. 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 RMM-1400 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 RMM-1400

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 RMM-1400. Package names are listed alphabetically.

WESTELL.COM

Page 3-114

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 examplescript

Package: examplescript Version: 1.0.0

Running job count: 0

Imports: Package Min version Presence

testimpb 2.1.0 missing

Script: 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 required

Script: 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-115


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-install

On demand install: disabled

(Dub) show pkgs>


WESTELL.COM

Page 3-116

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>server

FTP server: enabledAddress: 10.50.37.9

Port: 21

User: newPassword: server

Directory: /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 Version

goodpkg 1.0.0

jobtestutils 1.0.0testi 2.0.1

testj 2.0.1

(Dub) show pkgs>

WESTELL.COM

1-800-377-8766

Page 3-117

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show product

show product

DescriptionThis command displays product information for Remote RMM-1400.

Formatsshow product


ExamplesThis example displays the product information for Remote RMM-1400.

(Dub)>show

(Dub) show>product

Product code: RMM1400Part number: B544-0.0:0

Remote RMM-1400

(Dub) show>


Hardware components Displays the hardware components that are associated with Remote RMM-1400. The example displays component Remote RMM-1400.

Part number Displays a part number for Remote RMM-1400. The example displays part number B544-0.0:0.

Product code Displays the product code from the Kentrox product catalog for this particular model of Remote RMM-1400. The example displays the product code as RMM1400.

WESTELL.COM

Page 3-118

1-800-377-8766

Remote RMM-1400 Version 6.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-lvl

new1 supervisor 3

SuperStatus status 6new3 management 10

tech status 5

(Dub) show>

(Dub)>show

(Dub) show>profiles tech

Name: techBase Type: status

Privilege 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-119

Remote RMM-1400 Version 6.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.

Privilege Level

Displays the privilege level for a profile.

Profile Name Displays the name of the user-defined profile.


WESTELL.COM

Page 3-120

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show ras

show ras

DescriptionThis command displays the current RAS configuration for Remote RMM-1400.

Formatsshow ras

statistics

Parameters


ExamplesThis example displays the configured RAS settings:

statistics Displays AAA specific counters and statistics.

(Dub)>show ras

Shell RAS option: TACACS+ with Local Fallback

RAS Accounting: disabledRAS Authorization: privilege

RAS Retry: 1

RAS Timeout: 15

RAS Servers

IP Port Secret Phases10.50.18.32 4004 secret word authen author account

10.50.18.33 4003 newpass author account

(Dub)>


Shell RAS option

Displays the remote user authentication server and fallback status. Remote RMM-1400 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 RMM-1400. An accounting start packet is also issued for each shell command that is run.

WESTELL.COM

1-800-377-8766

Page 3-121


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 RMM-1400 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-122

1-800-377-8766


This example displays the RAS AAA statistics:

See Alsoconfig ras

config ras server

(Dub)>show

(Dub) show>ras statistics

RAS Statistics:

Authentication Attempts: 5Authentication Failures: 0

Authentication Fallbacks: 2

Authorization Attempts: 5

Authorization Failures: 0

Authorization Fallbacks: 2

Accounting Attempts: 5

Accounting Failures: 0Accounting Fallbacks: 2

(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-123

Remote RMM-1400 Version 6.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-access

SSH and SFTP: Enabled

Telnet and FTP: EnabledTelnet port: 23

FTP port: 21

HTTP: EnabledHTTP port: 80

HTTPS: Enabled

HTTPS port: 443HTTPS cert subject: /C=US/ST=OH/O=Kentrox, Inc./CN=JT-RMM

HTTPS cert validity start: Fri Jul 29 10:07:24 EDT 2016

HTTPS cert validity end: Sun Jul 14 10:07:24 EDT 2019(Dub)>show remote-access

WESTELL.COM

Page 3-124

1-800-377-8766

Remote RMM-1400 Version 6.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.

See Alsoconfig controller ethernet


config discrete analog



(Dub)>show

(Dub) show>resource-tracking

ID Resource Stateserial 1 assigned

serial 2 assigned

serial 3 assignedserial modem assigned

(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-125

Remote RMM-1400 Version 6.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

------------------------------------------------------------------------------connect_0001 connect tcp 60001 IP to serial port...

doorOpen421Alarm interval analog 1/1 Activates an alar...

pressureGauge connect serial 2 Activates an alar...(Dub) show>

Column Description

Description Displays the configured response descriptions.

Name Displays the names of all configured responses.

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.

WESTELL.COM

Page 3-126

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show responses

This example displays detailed information for response connect_0001.

See Alsoconfig response


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 connect_0001

Response Name : connect_0001

Response Description : IP to serial port 1 - outgoing serial connectionResponse Responder : tcp 60001

Response Type : connect

Response Parameters : dest=serial 1

dest-data=ATDT101

(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-127

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show running-config

show running-config

DescriptionThis command compiles and displays the current Remote RMM-1400 configuration. It displays recent user modifications to the configuration. The running configuration can be accessed anytime and by any user.

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 and other sensitive data.

Tip: This command performs the same function as command running-config on page 5-39.

Formatsshow running-config [ nopage ]

Parameters


nopage Displays the entire running configuration upon execution of the command. When this parameter is not specified, Remote RMM-1400 outputs the running configuration one page at a time.

WESTELL.COM

Page 3-128

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show running-config

ExamplesThis example displays the running configuration where, among other things, default route 10.39.0.1 is set, the Remote RMM-1400 session is configured to never timeout and user techcomm is added to the system.

See Alsocopy

running-config

(Dub)>show running-config

# Product: Remote RMM-1400# Version: 2.00

# Created: 2010-11-22,15:43:51.0,+0000

# User: janedoe# Bootloader Version: 1.00

config clock timezone EST -05:00

config clock daylight-savings EDTconfig ip route default 10.39.0.1

config dhcp-relay server 10.39.70.40

config peripheral 1 type rmb-1config peripheral 1 manage RMB1-0E68FD

config remote-access http disable

config remote-access https enableconfig snmp host 10.34.3.84 162 public v1

config snmp host 10.34.3.83 162 public v2-inform

config snmp host 10.34.3.86 162 public v2config timeout 0

config users add techcomm supervisor -e$1$Qzv94sky$J/XFok7lVjo8E/lmbH9fh. -

e$1$Qzv94config interface bridge switch ip address 10.39.90.2/16

--More--

WESTELL.COM

1-800-377-8766

Page 3-129

Remote RMM-1400 Version 6.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


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 RMM-1400 CLI.

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 RMM-1400.

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

Page 3-130

1-800-377-8766


(Dub)>show

(Dub) show>sitebus

ID Periph:Bus State Managed Name------------------------------------------------------------------------------

28004564AE05A5 1:2 Unmanaged

280000561000F1 1:1 Managed temp1

Name ID State Type Description

-----------------------------------------------------------------------------temp1 280000561000F1 Online sbTemp Heating core temp pr

temp2 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 RMM-1400.

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 RMM-1400 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.

State The following State values are listed: Managed indicates that the device has been discovered by

RMB and configured in the Remote RMM-1400 CLI. Unmanaged indicates that the device has been discovered by

RMB, but has not been configured in the Remote RMM-1400 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.

WESTELL.COM

1-800-377-8766

Page 3-131


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.

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 device type supported for Remote RMM-1400

Version 6.4x is sbTemp.

(Dub)>show

(Dub) show>sitebus id 28004564AE05A5

Discovered ID: 28004564AE05A5

Supported Types: sbTemp

Peripheral: 1Bus: 2

Admin State: Unmanaged

Last Updated Time: Mon Feb 1 16:42:46 EDT 2010(Dub) show>

(Dub)>show

(Dub) show>sitebus id 280000561000F1

Name: temp1

Description: Heating core temp probe

ID: 280000561000F1

Type: sbTempPeripheral: 1

Bus: 1

Admin State: ManagedOper State: Online

Last 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 RMM-1400 CLI. Unmanaged indicates that the device has been discovered by

RMB, but has not been configured in the Remote RMM-1400 CLI.

Bus Displays the SiteBus terminal to which this device is connected.

Column Description

WESTELL.COM

Page 3-132

1-800-377-8766


See Also config site control

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 RMM-1400.

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 device type supported for Remote RMM-1400


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 device type supported for Remote RMM-1400



WESTELL.COM

1-800-377-8766

Page 3-133

Remote RMM-1400 Version 6.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 RMM-1400.

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)>

WESTELL.COM

Page 3-134

1-800-377-8766


In this example, the details of the following control and its parameters are shown:

Control name hvacSystem

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.

(Dub)>show site controls hvacSystem

Name - hvacSystem

Description - HVAC System ControlsCategory - HVACSystem

Admin - enabled

State - Offline

Parameters

------------------------------------------------------------------------------Name - coolingSetpoint

Value - ?

Type - integer (18 - 95)Description - Cooling Setpoint

Name - leadSwapDelayValue - 7

Type - 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.

WESTELL.COM

1-800-377-8766

Page 3-135


See Alsoconfig site control


State Displays the status of the control. Possible states are Online, Offline, fatal-error, or other custom states as defined by the module.

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 referenceThe 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-136

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400:

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 RMM-1400:

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 RMM-1400.

(Dub)>show site module

Module Version Description Date------------------------------------------------------------------------------

Common 1.0.0 Common Library 2011.09.30 10:32:19

Environmental 1.0.0 Environmental Management 2011.09.30 10:31:42Power 1.0.0 Power Management 2011.09.30 10:32:27

(Dub)>

WESTELL.COM

1-800-377-8766

Page 3-137


In this example, the following module configuration and applications are shown:

Module name Power

Column Description

Date Displays the date the module was built.

Description Displays the text description of the module.

Module Displays the name for the module.

Version Displays the version number of the module.

(Dub)>show site module PowerName - Power

Description - Power Management

Product Version - 1.0.0Compatibility Version - 1.0.0

Build ID - 012

Build Date - 2011.09.30 10:32:27.801 -0400

Application Type State Description

------------------------------------------------------------------------------ACPowerMonitoring optional disabled An application for monitoring AC Po

BatteryMonitoring included enabled An application for monitoring batte

FuelMonitoring optional disabled An application for monitoring fuelGeneratorManagement optional enabled An application for monitoring and c

HybridPowerManagemen optional disabled An application for managing hybrid

RectifierMonitoring 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.

WESTELL.COM

Page 3-138

1-800-377-8766


See Also config site module

exec site install

exec site uninstall

debug site

Compatibility Version

Displays the compatibility version of the module.

Description Displays the text description of the module.

Name Displays the name of the module.

Product Version

Displays the version number of the module.


WESTELL.COM

1-800-377-8766

Page 3-139

Remote RMM-1400 Version 6.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 Displays the summary of the status points for the selected NE.

sub-component name Identifies the sub-component being shown

WESTELL.COM

Page 3-140

1-800-377-8766



ExamplesIn this example, all the NEs on a site are shown:

(Dub)>show site network-elements

Network Element Category Type State------------------------------------------------------------------------------

acPowerDistributi ACPowerDistribution LovatoRGK60ATS online

batteryString BatteryString BatteryStringVoltageSen onlinebatteryStringTemp TemperatureSensor SiteBusTemperature online

door DoorSensor DiscreteDoor online

fuelTank RectangularFuelTankPresgenerator Generator LovatoRGK60Generator online

generatorPower GeneratorThreePhasePowe

hvac1IntakeTemper TemperatureSensor SiteBusTemperature onlinehvac1OutletTemper TemperatureSensor SiteBusTemperature online

hvac2IntakeTemper TemperatureSensor offline

hvac2OutletTemper TemperatureSensor offlinehvacEquipmentLoad HVACEquipmentLoadEnergy offline

hvacSystem HVACSystem MarvairCS4HVACSystem online

hvacSystemEnergy HVACEnergyMeter offlinehvacUnit1 HVACUnit MarvairCS4HVACUnit online

hvacUnit1Energy HVACEnergyMeter offline

hvacUnit1Power ElkorThreePhasePowerMethvacUnit2 HVACUnit offline

hvacUnit2Energy HVACEnergyMeter offline

hvacUnit2Power ElkorThreePhasePowerMethybridPowerManage KentroxHybridPowerManag

indoorHumidity HumiditySensor RMBHumidity online

indoorTemperature TemperatureSensor RMBTemperature onlinemainsPower LovatoRGK60MainsPowerMe

outdoorHumidity HumiditySensor RMBHumidity online

outdoorTemperatur TemperatureSensor RMBTemperature onlinerectifier Rectifier EmersonVEC online

siteEquipmentLoad KentroxSiteEquipmentLoa

sitePower 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-141


In this example, the following network element and its parameters are shown:

Network element 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 door

Name - door

Description - Site door sensorCategory - DoorSensor

Type - DiscreteDoor

State - onlineInternalState - Online

Parameters------------------------------------------------------------------------------

Name - discrete

Value - input 1/5 (configured)Type - discrete-input

Description - Input for discrete door sensor

Name - normalState

Value - close

Type - 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-142

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 normally

Testing_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_State

Description - The current state of the generator.State - running

Message - 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-143


This example shows details about an NE’s specific sub-component:

(RMM28) 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_9_4 AndrewIONDASRemoteUnit online

(RMM28) 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-144

1-800-377-8766


(RMM28) show>

(RMM28) show>site network-elements das2 components das2Remote_1_6_2

Name - das2Remote_1_6_2

Display name - das2Remote_1_6_2Description -

Category - DASRemoteUnit

Type - AndrewIONDASRemoteUnitState - online

InternalState - Online

Parameters

------------------------------------------------------------------------------

Name - descriptionDisplay Name - description

Value - (default)

Type - stringDescription - Extra description about this NE

Name - modelDisplay Name - model

Value - (default)

Type - stringDescription - Extra model information about this NE

Name - parentNameDisplay Name - parentName

Value - (default)

Type - stringDescription - Name of this units parent DAS NE

(RMM28) 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-145


See Alsoconfig site network-element

WESTELL.COM

Page 3-146

1-800-377-8766

Remote RMM-1400 Version 6.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-sets

Network 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-147


This example displays detailed information for NE set TenantPowerMeter.

(Dub)>show(Dub) show>site

(Dub) show site>network-elements-sets TenantPowerMeter

Name - TenantPowerMeterDescription - NE Set for TenantPowerMeter

Category - PowerMeterCategory

Max Elements - 3Name Restriction - (.*Power)

Instances

------------------------------------------------------------------------------Name - KentroxPower

Description - 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-148

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-149

Remote RMM-1400 Version 6.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 Also

(Dub)>show site paramsName - averageFuelConsumption

Value - 2

Type - floating-pointDescription - Average fuel consumption of the generator

Name - defaultCriticallyHighTemperatureValue - 105

Type - floating-point

Description - Critically High Temperature Alarming Point

Name - defaultCriticallyLowTemperature

Value - 32Type - floating-point

Description - Critically Low Temperature Alarming Point

Name - defaultHighTemperatureValue - 90

Type - floating-point

Description - High 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-150

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show site params

config site param

WESTELL.COM

1-800-377-8766

Page 3-151

Remote RMM-1400 Version 6.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

Page 3-152

1-800-377-8766


This example displays the current management stations in the trap table.

(Dub)>show

(Dub)>show snmp

(Dub) show snmp>communities

Name User Type Auth Modeadministrator v1 noauth readwrite

public v1 noauth readonly

v3comm 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>hosts

IP Address Port Type Auth Community/User Queue192.168.7.2 162 v1 noauth administrator sending

(Dub) show snmp>

WESTELL.COM

1-800-377-8766

Page 3-153


This example displays a summary of the SNMP agent configuration.

(Dub)>show(Dub) show>snmp

(Dub) show snmp>summary

Authentication traps: enabledTrap queue: disabled

Communities:

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

Page 3-154

1-800-377-8766


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

1-800-377-8766

Page 3-155

Remote RMM-1400 Version 6.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 RMM-1400 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 RMM-1400 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

Page 3-156

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 3-157

Remote RMM-1400 Version 6.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 mode

Test Mode: Disabled(Dub)>

(Dub)>show test mode

Test Mode: Enabled

Test Duration: 290 second(s)

(Dub)>

WESTELL.COM

Page 3-158

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show timeout

show timeout

DescriptionThis command displays the amount of time that can elapse before a Remote RMM-1400 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>timeout

The session timeout is set to 60 minutes.

(Dub) show>

(Dub)>show(Dub) show>timeout

The session timeout is set to never time out.

(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-159

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show timers

show timers

DescriptionThis command displays information for all currently running Remote RMM-1400 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

Page 3-160

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show users

show users

DescriptionThis command displays the locally configured Remote RMM-1400 users with their corresponding profiles.

Formatsshow users


ExamplesThis example displays the Remote RMM-1400 users with their corresponding profiles.

Note: For descriptions of the profile types, refer to command config users on page 2-217.

(Dub) show>usersStrong Password Support: disabled

Login Name Profile 1. diag diagnostic

2. test supervisor

Login Limits:

User Name Login Limit

1. diag 10 2. test 10

(Dub) show>

WESTELL.COM

1-800-377-8766

Page 3-161

Remote RMM-1400 Version 6.4x Command Reference GuideShow Commands: show version

show version

DescriptionThis command displays the software version and the build information for Remote RMM-1400.

Formatsshow version


ExamplesThis example displays the Remote RMM-1400 version level.

(Dub)>show versionProduct: Remote RMM-1400

Version: 2.00

Build date: 2010-11-22,16:46:13.0,+0000Build ID: 015

Image type: KTX544-Production

Bootloader Version: 1.00(Dub)>

WESTELL.COM

Page 3-162

1-800-377-8766

CHA

PTER 4

Diagnostic Commands

This chapter describes all of the Remote RMM-1400 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 RMM-1400 Version 6.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 RMM-1400 Version 6.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]Commands

break Terminates a shell connection.

clear(+) Clears statistical counters. controller(+) Displays diagnostic information for a

controller.

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 RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag break

diag break

DescriptionThis command terminates a Remote RMM-1400 shell connection. Remote RMM-1400 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 usb

tty Defines the terminal name for the shell connection being terminated. Terminal names appear in the second column of the output for command diag usb.

(Dub)>diag

(Dub) diag>break ttyp1

(Dub) diag>

WESTELL.COM

Page 4-4

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag clear

diag clear

DescriptionThese commands reset alarm settings to their default values and clear IP table rule and interface counters.

Formatsdiag clear

alarm-entry { alarm | * }counters

Parameters


ExamplesThis example displays:

The clearing of alarm entry t_6_1_36 The clearing of IP table rule and interface counters

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 (_).Note: This parameter must start with an alphabetic character.

*—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-62 and show iptables on page 3-79.

(Dub)>diag

(Dub) diag>clear

(Dub) diag clear>alarm-entry t_6_1_36(Dub) diag clear>counters

(Dub) diag clear>

WESTELL.COM

1-800-377-8766

Page 4-5

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag clear

See Alsoconfig alarm-entry

show alarm-entries

show interfaces

WESTELL.COM

Page 4-6

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400 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 RMM-1400 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 RMM-1400 Version 6.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 RMM-1400 Version 6.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 info

helpManagement Interface for OpenVPN 2.0.6 i686-pc-linux [SSL] [LZO] [EPOLL] built

on Sep 26 2006

Commands: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.END

quit

(Dub) >

WESTELL.COM

1-800-377-8766

Page 4-9

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag controller serial modem

diag controller serial modem

Description

Provisions the wireless phone module/modem.

FormatsFor use with HSPA or EVDO modems:


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:


select-carrier carriersim-pin { enable | disable | change-pin | unlock-sim }

Parameters

activate 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 on the Sprint network.

sprint-prl—Updates the PRL on the modem on the Sprint network.

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 Sprint commands. For more information, see the config controller serial command.

WESTELL.COM

Page 4-10

1-800-377-8766



ExamplesThis example provisions the modem phone numbers, system ID and network ID.

See Alsoconfig controller serial

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—Syste 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 carrier carrier

Valid for LTE phone modules only. Provisions the modem using a parameter contained in the modem firmware (frequently the carrier name).

sim-pin Manages the PIN locking feature of the SIM card.Important: The SIM comes with a default PIN and PIN Unlock Key

(PUK) set by the phone carrier. Users must obtain these codes from their carriers.

The following commands are valid: enable -- Enable PIN locking of the SIM card. disable -- Disable PIN locking of the SIM card. change-pin -- Change the PIN on a SIM card. unlock-sim -- Unlock a SIM card using the PUK after too many

retries of an invalid PIN; user is prompted for the PUK and the new PIN. New PIN is set on the SIM.

Important: When one or more incorrect PINs are entered three times to attempt to unlock the SIM, the PUK will be required to unlock the SIM. When incorrect PUKs are entered 10 successive times, the SIM is deactivated and must be replaced.

(Dub)>diag(Dub) diag>controller serial modem

(Dub) diag controller serial modem namval 6145557890 6145557891 0 12345

WESTELL.COM

1-800-377-8766

Page 4-11



WESTELL.COM

Page 4-12

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag ip address show

diag ip address show

DescriptionThese commands display diagnostic IP address information for Remote RMM-1400. Remote RMM-1400 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 RMM-1400 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 RMM-1400 interface. The following parameter is accepted:

interface_name—Defines the system name for the interface being displayed.

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-13



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 RMM-1400.

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-14

1-800-377-8766


ExamplesThis example displays diagnostic information for all known Remote RMM-1400 IP addresses.

(Dub)>diag(Dub) diag>ip

(Dub) diag ip>address

(Dub) diag ip address->show

1: 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 lo

2: eth0: <BROADCAST,MULTICAST,PROMISC,SLAVE,UP> mtu 1514 qdisc pfifo_fast qlen 1

00 link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff

3: eth1: <BROADCAST,MULTICAST> mtu 1500 qdisc noop qlen 100

link/ether 00:40:72:0f:a8:ca brd ff:ff:ff:ff:ff:ff4: mii0: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:ca brd ff:ff:ff:ff:ff:ff

5: mii1: <BROADCAST,MULTICAST> mtu 1500 qdisc noqueue link/ether 00:40:72:0f:a8:cb brd ff:ff:ff:ff:ff:ff

6: mii2: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:cc brd ff:ff:ff:ff:ff:ff7: mii3: <BROADCAST,MULTICAST> mtu 1500 qdisc noop

link/ether 00:40:72:0f:a8:cd brd ff:ff:ff:ff:ff:ff

8: mii4: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff

9: mii5: <BROADCAST,MULTICAST,PROMISC,MASTER,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff10: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff

inet 10.39.90.80/16 brd 10.39.255.255 scope global br_switch11: ovpn_client: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc pfifo_fast qlen 100

link/ether 00:ff:fc:ca:c0:dc brd ff:ff:ff:ff:ff:ff

inet 192.168.105.110/24 brd 192.168.105.255 scope global ovpn_client28: ppp_modem: <POINTOPOINT,MULTICAST,NOARP,UP> mtu 1500 qdisc pfifo_fast qlen 1

00

link/ppp inet 166.217.154.167 peer 10.64.64.64/32 scope global ppp_modem

(Dub) diag ip address


Sequential number Displays a sequential number for the Remote RMM-1400 interface associated with each IP address.

System name Displays the system name for the Remote RMM-1400 interface associated with each IP address.

WESTELL.COM

1-800-377-8766

Page 4-15


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 RMM-1400.

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.

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.


WESTELL.COM

Page 4-16

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

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 ip>address

(Dub) diag ip address->show dev br_switch primary

10: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff inet 10.39.90.80/16 brd 10.39.255.255 scope global br_switch

(Dub) diag ip address


WESTELL.COM

1-800-377-8766

Page 4-17

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag ip link show

diag ip link show

DescriptionThese commands display diagnostic link information for Remote RMM-1400. Remote RMM-1400 displays information for all links that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMM-1400 displays information for all links.

Formatsdiag ip link show

[ dev interface_name ][ up ]

Parameters


dev Initiates the display of links for a specified Remote RMM-1400 interface. The following parameter is accepted:

interface_name—Defines the system name for the interface being displayed..

up Displays information for links that are enabled and functioning.

WESTELL.COM

Page 4-18

1-800-377-8766


ExamplesThis example displays diagnostic information for all Remote RMM-1400 links.

(Dub)>diag

(Dub) diag>ip

(Dub) diag ip>link(Dub) diag ip link

->show

1: lo: <LOOPBACK,UP> mtu 16436 qdisc noqueue link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00

2: eth0: <BROADCAST,MULTICAST,PROMISC,SLAVE,UP> mtu 1514 qdisc pfifo_fast qlen 1

00 link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff

3: eth1: <BROADCAST,MULTICAST> mtu 1500 qdisc noop qlen 100

link/ether 00:40:72:0f:a8:ca brd ff:ff:ff:ff:ff:ff4: mii0: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:ca brd ff:ff:ff:ff:ff:ff

5: mii1: <BROADCAST,MULTICAST> mtu 1500 qdisc noqueue link/ether 00:40:72:0f:a8:cb brd ff:ff:ff:ff:ff:ff

6: mii2: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:cc brd ff:ff:ff:ff:ff:ff7: mii3: <BROADCAST,MULTICAST> mtu 1500 qdisc noop

link/ether 00:40:72:0f:a8:cd brd ff:ff:ff:ff:ff:ff

8: mii4: <BROADCAST,MULTICAST> mtu 1500 qdisc noop link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff

9: mii5: <BROADCAST,MULTICAST,PROMISC,MASTER,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff10: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff

11: ovpn_client: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc pfifo_fast qlen 100 link/ether 00:ff:fc:ca:c0:dc brd ff:ff:ff:ff:ff:ff

28: ppp_modem: <POINTOPOINT,MULTICAST,NOARP,UP> mtu 1500 qdisc pfifo_fast qlen 1

00 link/ppp

(Dub) diag ip link


Sequential number Displays a sequential number for the Remote RMM-1400 interface associated with each link.

System name Displays the system name for the Remote RMM-1400 interface associated with each link.

WESTELL.COM

1-800-377-8766

Page 4-19


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 RMM-1400.

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-20

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 ip>link

(Dub) diag ip link->show dev br_switch up

10: br_switch: <BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue

link/ether 00:40:72:0f:a8:c9 brd ff:ff:ff:ff:ff:ff(Dub) diag ip link


WESTELL.COM

1-800-377-8766

Page 4-21

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag ip neighbor show


DescriptionThese commands display diagnostic neighbor information for Remote RMM-1400. Remote RMM-1400 displays information for all neighbors that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMM-1400 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.39/16).

dev Initiates the display of neighbors attached to a specified Remote RMM-1400 interface. The following parameter is accepted:


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-22

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag ip neighbor show


ExamplesThis example displays diagnostic information for all Remote RMM-1400 neighbors.

This example displays diagnostic information for neighbors with destination IP address prefix 10.39/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.39.0.1 dev br_switch lladdr 00:21:f7:6d:08:00 nud delay

192.168.105.1 dev ovpn_client lladdr 00:ff:5c:d6:eb:9a nud stale

10.39.3.102 dev br_switch lladdr 00:01:02:cc:3e:8f nud stale(Dub) diag ip neighbor


Neighbor IP address Displays the IP address of each neighbor.

dev Displays the system name for the Remote RMM-1400 interface attached to each neighbor.

lladdr Displays the link layer address of each neighbor.

nud Displays the NUD state of each neighbor.


(Dub) diag ip>neighbor

(Dub) diag ip neighbor->show to 10.39/16 nud reachable

10.39.0.1 dev br_switch lladdr 00:21:f7:6d:08:00 nud reachable

(Dub) diag ip neighbor

WESTELL.COM

1-800-377-8766

Page 4-23

Remote RMM-1400 Version 6.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 RMM-1400 through a specified interface. The following parameter is accepted:


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-24

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 ip>route

(Dub) diag ip route->get 128.5.99.2

128.55.99.2 via 192.168.105.1 dev ovpn_client src 192.168.105.110

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 RMM-1400 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 RMM-1400 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 RMM-1400 interface through which the route goes.

WESTELL.COM

1-800-377-8766

Page 4-25


This example displays diagnostic information for a route with destination IP address 128.25.45.2 that goes out from Remote RMM-1400 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_switch

128.25.45.2 dev br_switch src 10.39.90.80 cache mtu 1500 advmss 1460

(Dub) diag ip route

WESTELL.COM

Page 4-26

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag ip route and route-v6 show


DescriptionThese commands display diagnostic route information for Remote RMM-1400. Remote RMM-1400 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 RMM-1400 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 RMM-1400 interface. The following parameter is accepted:


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-27


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 RMM-1400 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 RMM-1400.

WESTELL.COM

Page 4-28

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-29



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 RMM-1400.

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-30

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

->show10.34.0.0/16 via 10.39.0.1 dev br_switch proto gated

10.39.0.0/16 dev br_switch proto kernel scope link src 10.39.90.80

169.254.0.0/16 dev br_switch scope link10.44.0.0/16 via 10.39.0.1 dev br_switch proto gated

64.0.0.0/8 dev ppp_modem proto gated scope link

unreachable 127.0.0.0/8 proto gated scope nowheredefault via 192.168.105.1 dev ovpn_client proto gated

(Dub) diag ip route

(Dub)>diag

(Dub) diag>ip

(Dub) diag ip>route-v6(Dub) diag ip route-v6

->show

fc10:0:0:39::/96 dev br_switch proto kernel metric 256 expires 2591790sec mtu 1500 advmss 1440 hoplimit 0

fe80::/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 0

default 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 RMM-1400 interface through which each route goes.

proto Displays the routing protocol for each route.

WESTELL.COM

1-800-377-8766

Page 4-31


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 RMM-1400.

src Displays the source IP address for each route.


WESTELL.COM

Page 4-32

1-800-377-8766


This example displays diagnostic information for routes going through interface bridge switch (br_switch).


diag ip link show


(Dub)>diag

(Dub) diag>ip(Dub) diag ip>route

(Dub) diag ip route

->show dev br_switch10.34.0.0/16 via 10.39.0.1 proto gated

10.39.0.0/16 proto kernel scope link src 10.39.90.80

169.254.0.0/16 scope link10.44.0.0/16 via 10.39.0.1 proto gated

(Dub) diag ip route

WESTELL.COM

1-800-377-8766

Page 4-33

Remote RMM-1400 Version 6.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 RMM-1400. Valid values are serial-1 to serial-4 and console.Note: A supervisor user profile is required to monitor a console.

WESTELL.COM

Page 4-34

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 4-35

Remote RMM-1400 Version 6.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 RMM-1400. Valid values are serial-1 to serial-4 and console.

(Dub)>diag

(Dub) diag>line-status console serial-2 serial-3

Port Admin Link DSR DCD CTS DTR RTS

------------------------------------------------------------------

serial-2 enabled up - - - + +

serial-3 enabled up - - - + +console enabled up + + - + +

(Dub) diag>

WESTELL.COM

Page 4-36

1-800-377-8766

Remote RMM-1400 Version 6.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

1-800-377-8766

Page 4-37

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag mmdisplay

diag mmdisplay

DescriptionThis command displays all mediation messages or a specific type of mediation message for Remote RMM-1400. 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

Page 4-38

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag mmdisplay

ExamplesThis example displays all Remote RMM-1400 mediation messages.

This example displays Remote RMM-1400 event mediation messages only.

(Dub)>diag

(Dub) diag>mmdisplay

Press Ctrl-C to return to the CLI< router | command=register | destination=PrintLog7566 | regex=.* | size=10000 >

< event | originator=analog 1/1 | triggerEvent=interval | value=0.00 mA >

< event | originator=analog 1/2 | triggerEvent=interval | value=0.00 mA >< event | originator=analog 1/1 | triggerEvent=interval | value=0.00 mA >



(Dub) diag>

(Dub)>diag

(Dub) diag>mmdisplay event

Press Ctrl-C to return to the CLI< event | originator=analog 1/1 | triggerEvent=interval | value=0.00 mA >



(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-39

Remote RMM-1400 Version 6.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 a peripheral unit.


(Dub) diag>diag(Dub) diag>output 1/2 open 12

(Dub) diag>

WESTELL.COM

Page 4-40

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag peripheral reload

diag peripheral reload

DescriptionThis command reboots the specified peripheral unit. If Remote RMM-1400 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 RMM-1400 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 RMM-1400 will be downloaded to the peripheral unit, even if the image on Remote RMM-1400 is an older version. Remote RMM-1400 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:

unit—Defines the peripheral unit number. Valid values are 1 to 12.

* Specifies all peripheral units.

WESTELL.COM

1-800-377-8766

Page 4-41

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag peripheral reload


ExampleThis example displays the rebooting of RMB unit RMB1-0E68FD.


show peripherals

(Dub)>diag

(Dub) diag>peripheral name RMB1-0E68FD(Dub) diag>peripheral name RMB1-0E68FD reload

Are you sure you wish to reset the peripheral(s)? (y/N) y

(Dub) diag peripheral name DEP-083B62>

WESTELL.COM

Page 4-42

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag ps

diag ps

DescriptionThis command displays all running Remote RMM-1400 processes.

Formatsdiag ps


WESTELL.COM

1-800-377-8766

Page 4-43


ExamplesThis example displays a sample of the currently running processes for Remote RMM-1400.

Note: This screen shot displays the first portion of the CLI output for this command.

(Dub)>diag

(Dub) diag>ps

USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMANDroot 1 0.0 0.2 1776 520 ? S 03:51 0:04 init

root 2 0.0 0.0 0 0 ? SW 03:51 0:00 [keventd]

root 3 0.0 0.0 0 0 ? RWN 03:51 0:00 [ksoftirqd_CPU0]root 4 0.0 0.0 0 0 ? SW 03:51 0:00 [kswapd]

root 5 0.0 0.0 0 0 ? SW 03:51 0:00 [bdflush]

root 6 0.0 0.0 0 0 ? SW 03:51 0:00 [kupdated]root 7 0.0 0.0 0 0 ? SW 03:51 0:00 [mtdblockd]

root 8 0.0 0.0 0 0 ? SW 03:51 0:00 [khubd]

root 56 0.0 0.0 0 0 ? SWN 03:51 0:00 [jffs2_gcd_mtd6]root 57 0.0 0.0 0 0 ? SWN 03:51 0:00 [jffs2_gcd_mtd7]

root 58 0.0 0.0 0 0 ? SWN 03:51 0:00 [jffs2_gcd_mtd9]

root 59 0.0 0.0 0 0 ? SWN 03:51 0:00 [jffs2_gcd_mtd8]root 60 0.0 0.0 0 0 ? SWN 03:51 0:00 [jffs2_gcd_mtd10]



root 105 0.0 0.8 5376 2228 ? S 03:51 0:00 /usr/sbin/daemonr

root 106 0.0 2.2 11268 5852 ? S 03:51 0:01 logdroot 107 0.0 2.2 11268 5852 ? S 03:51 0:00 logd

root 108 0.0 2.2 11268 5852 ? S 03:51 0:00 logd


root 115 0.0 0.9 11700 2464 ? S 03:51 0:00 evtd

root 116 0.0 0.9 11700 2464 ? S 03:51 0:00 evtd

root 117 0.0 0.9 11700 2464 ? S 03:51 0:00 evtdroot 118 0.0 0.9 11700 2464 ? S 03:51 0:00 evtd

root 119 0.0 0.9 11700 2464 ? S 03:51 0:00 evtd


root 123 0.0 2.8 27680 7360 ? S 03:51 0:06 umid

root 124 0.0 2.8 27680 7360 ? S 03:51 0:00 umidroot 127 0.0 2.8 27680 7360 ? S 03:51 0:00 umid

root 128 0.0 2.8 27680 7360 ? S 03:51 0:00 umid

root 129 0.0 2.8 27680 7360 ? S 03:51 0:03 umidroot 130 0.0 2.8 27680 7360 ? S 03:51 0:02 umid

root 131 0.0 2.8 27680 7360 ? S 03:51 0:04 umid

root 132 0.0 2.8 27680 7360 ? S 03:51 0:03 umidroot 154 0.0 0.7 4796 1972 ? S 03:51 0:00 /usr/sbin/gated


Column Description

USER Displays the names of users who own the corresponding processes.

WESTELL.COM

Page 4-44

1-800-377-8766


See Alsodiag usb

diag whoami

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.

%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

1-800-377-8766

Page 4-45

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag remote-access

diag remote-access

DescriptionThis command provides diagnostic remote-access commands.

Formatsdiag remote-access

[no] certificate

generate-csr subject

Parameters

The subject identifies the certificate owner, and is formatted as /type0=value0/type1=value1/, using the following types:

[no] certificate Installs HTTPS certificate(s) provided by an external certificate authority (CA). The command is followed by a list of one or more PEM-encoded certificates and concludes with @.The no option removes the provided certificates, causing the Remote to use its self-generated certificate.

generate-csr subject Generates an HTTPS certificate signing request (CSR) as a PKCS#10 format encoded in PEM form. The generated CSR is displayed on the screen. The contents, including BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST lines, can be saved to input into the external CA.

Type Value

C Country Name (2 letter code)

ST State or Province Name (full name)

L Locality Name (city)

O Organization Name (company)

OU Organizational Unit Name (section)

CN Common Name (server FQDN or YOUR name)

emailAddress Email

WESTELL.COM

Page 4-46

1-800-377-8766



ExamplesThis example command to generate a CSR reflects subject types for country (US), state (OH), organization name (Westell, Inc.), and common name (Dub).

The next step is to send the certificate request to the Certificate Authority. Once the CA responds with the signed certificate, the user installs the signed certificate with the diag remote-access certificate command as shown in the following example (which includes two certificates). The user copies and pastes in the certificate(s) starting at the first BEGIN CERTIFICATE line and ending at the last END CERTIFICATE line, and then enters an “@” on a separate line:

(Dub) diag>

(Dub) diag>remote-access generate-csr /C=US/ST=OH/O=Westell,Inc./CN=Dub/

-----BEGIN CERTIFICATE REQUEST-----MIIDeTCCAmECAQAwQjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk9IMRUwEwYDVQQK

EwxLZW50cm94LEluYy4xDzANBgNVBAMTBkpULVJNWDCCASIwDQYJKoZIhvcNAQEB

BQADggEPADCCAQoCggEBAJ49L//bR65hvVTBBcsK9lkQa0xZCfzsuFIsf3sM2+FLaHtRiuHxdLP/QUyhQ0Afo+ux7/Qv0XLzDm+4daJaFgKMLtpWhJdYQJ+MpQd8ZfPY

M/VSuUaPhMjk46IFKogRk7+w3+mP4TtOeHiQxzvUrodvSDXcU8xiZNbl8ra+DKLy

34h9XVdoCJPqEEmGUZMrqlE71klkH0KxAb+ZXcPTLT4K+4cp+lUkEQG2jkBpG7rCtXQ5YYQSz4Hzup4R5hgE6J/OCSUsezVW9t4eaGx2Y1kIsJmuA88HWbxyIukYHTNY

inXNDlK+89f6hpy6BWloO5YZTCKBoG/SmycLQfFTj50CAwEAAaCB8TCB7gYJKoZI

hvcNAQkOMYHgMIHdMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMIHCBgNVHREEgbowgbeHEPwQAAAAAAA5AkBy//4URDyCG2ZjMTA6OjM5OjI0MDo3MmZmOmZlMTQ6NDQz

Y4IdW2ZjMTA6OjM5OjI0MDo3MmZmOmZlMTQ6NDQzY12HEPwQAAAAAAA5AAAAAAon

SxiCFWZjMTA6OjM5OjA6MDphMjc6NGIxOIIXW2ZjMTA6OjM5OjA6MDphMjc6NGIxOF2HBKn+CgGCDDE2OS4yNTQuMTAuMYcECidLGIILMTAuMzkuNzUuMjQwDQYJKoZI

hvcNAQELBQADggEBAHVtJeCbFvfRPSpLgvDShQOIvcpiOW4rCgUcwNf4L2tEfMGV

QSEJX8BVykzX4t/b5FYhWUuFYdQsrIGBg6tW5jIrpiNaVGA99yqZljpg0i2PNNAQsRV8IShNIXTCs/KIjQVGONqyFhf6qzSKa346791OsKJfqVT/9w7V57Sc0ruvP/Rt

iUXbG7fPJlE73C9bfiRNm1ug1czhGOzbZfnt/Ne5gEKy9A9v02LSszApD8RX6g1c

ciV6P1j69SnJZcwuGXa/qBRUaCDARZKpXwOy3HRyIhg/zGAYe7WF1yyBb6HiJauUnofrg47t/FI+Sp0sUIv4ZMKATlclPi0aCIW2bhk=

-----END CERTIFICATE REQUEST-----

(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-47


See Also show remote-access

(Dub)>diag remote-access certificate-----BEGIN CERTIFICATE-----

MIID/DCCAuSgAwIBAgIJAK9L1CPMUwCvMA0GCSqGSIb3DQEBCwUAMIGVMQswCQYDVQQGEwJVUzERMA8

GA1UECAwISWxsaW5vaXMxDzANBgNVBAcMBkF1cm9yYTETMBEGA1UEAwwKUmVtb3Rlc1J1czEQMA4GA1UECgwHU3lzVGVzdDEWMBQGA1UECwwNV2VzdGVsbFJlbW90ZTEjMCEGCSqGSIb3DQEJARYUcmZvcmRAc

mVtb3RlY2l0eS5vcmcwHhcNMTYwNzExMjA0OTUxWhcNMTcxMTIzMjA0OTUxWjCBlTELMAkGA1UEBhMC

VVMxETAPBgNVBAgTCElsbGlub2lzMQ8wDQYDVQQHEwZBdXJvcmExEzARBgNVBAMTClJlbW90ZXNSdXMxEDAOBgNVBAoTB1N5c1Rlc3QxFjAUBgNVBAsTDVdlc3RlbGxSZW1vdGUxIzAhBgkqhkiG9w0BCQEWFH

Jmb3JkQHJlbW90ZWNpdHkub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvyrDKV20j

JfX0V0rkkitfyP9LIyu8PZfvCXKhgCKNpcfE3/pb+1wzvs5+3TK+s2wQ+XrXKfj4lA1cNfGfzqJhraBt8MGzYbP9QHcsPZepekO6XDhfgFarRElFtbjkYpYAdLno3egcc9O7ZmHSmq9qza7czlqscXFvGdypwr

6s0pbfB8CmNt5H6WnNhJ5lP40i/1cJTneeZ3U557pyO9m7hEwMq9AvIxvjA9R5/eWWuU9LQEZjMHbq7

IDfsK4VnmL93SqClaOIQCuGXOM7ik9hsb5suJoXBNC6PHZ6QGN5PF9Gb8hzadp+7mcBFuEdEpW0XS26ygkFO7VIEQmL7gW3wIDAQABo00wSzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAxBgNVHREEKjAohwSp

/lcdgg0xNjkuMjU0Ljg3LjI5hwQKEF0LggsxMC4xNi45My4xMTANBgkqhkiG9w0BAQsFAAOCAQEAkn1

nt1UyK2+1q8cTNum2iL4u6/t4Wma3r45UxvrektyWRJ3rHPSvJn+bBt0QSxij6XCnqdPWWlLI2F18kkvMN4uYQ9IZ8S3eOLjR8FAVavnn+VW+nDY8s+kIcTbtLd+REp/l8Cz/Hu0FUbj9JXa5A7mRYVKoelzEs

z36/ZkmxkczLhwV30WXsauy6byO8K8gSmVq9G79evB+ARw554OT3gH/35IiQU/RjHcx1HVz+v83AhhQ

X9goTrxfIiZxOtsoxW3ld+eFMW4NYvR6n+oQlpstecyA/4QPfDFBn4OB6OunAKlvDJWz6Ej4DRM/Jpq7Vq5Ss8Jfbh8KNTnkZeDZ3Q==

-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----MIID/zCCAuegAwIBAgIJANVOmzX/g6NiMA0GCSqGSIb3DQEBCwUAMIGVMQswCQYDVQQGEwJVUzERMA8

GA1UECAwISWxsaW5vaXMxDzANBgNVBAcMBkF1cm9yYTETMBEGA1UEAwwKUmVtb3Rlc1J1czEQMA4GA1

UECgwHU3lzVGVzdDEWMBQGA1UECwwNV2VzdGVsbFJlbW90ZTEjMCEGCSqGSIb3DQEJARYUcmZvcmRAcmVtb3RlY2l0eS5vcmcwHhcNMTYwNzExMjA0OTE3WhcNMTkwNTAxMjA0OTE3WjCBlTELMAkGA1UEBhMC

VVMxETAPBgNVBAgMCElsbGlub2lzMQ8wDQYDVQQHDAZBdXJvcmExEzARBgNVBAMMClJlbW90ZXNSdXM

xEDAOBgNVBAoMB1N5c1Rlc3QxFjAUBgNVBAsMDVdlc3RlbGxSZW1vdGUxIzAhBgkqhkiG9w0BCQEWFHJmb3JkQHJlbW90ZWNpdHkub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4BgBat36U

+2YFTwqRaCYY2bX9Me4Y6mtfcuuFxBS/fqAswQfCqKR3AXufj9Do5YVS6hU0vv5q50n12peDvU4YTq/

tcbNY2XgEQ5Gtot6LJiLqUKUrBizGINpNeSVlHulchgSBs7Kcs8m9cNFSQHxw5sYRJdfbOjqkjEoWHmrk5y4eGn04GrByD14B8vlTkVm0V8H/VtAtRpx1EotAkahYd91PAAs922/8tPUeXVA2dSzw+w7whIyNQ

X8TOiNQArsj+TObgg54C/X+JgNgpIl5cSTzikZvj5d7ngNCFthLpB+Pwmzx5lPnIx8NnvM5GpkX3THe

dFSOUvVsIHg8i8vTwIDAQABo1AwTjAdBgNVHQ4EFgQU6dcf+KM9kET+G2Bdnn7x+L3kBYIwHwYDVR0jBBgwFoAU6dcf+KM9kET+G2Bdnn7x+L3kBYIwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQE

AxW02KDTjmvGAMUZZwTvZMNduXeklzEqRZDYY+z2KiECyWWMvWTDPpPDkuQGwjiCSCPNEzFEDS78k8T

YQ8wkcoaGkY6Dfr1wXgdnWr2/8ZUfw0Dk3NijLwkcel/uOW9VuZZ1dfUfGf4GmRAavxKCtc8HjHorCW

yZ7fly/hETEvQnPpMFIfdbIqXeFEDmkjaw6ntwvftYl8XizibBR9JqJR4YzauCNE+KYU8VLmlGTzf41/kycbZG0z+lyfJlqtI1fJUaqVEkq8HxoEkcbpycvEtg6g3wKHCZXb2GvthEAlWs6SPpdYGAmkVJ2lDg

R9zM2pcWkK8i77vgMXV1bMsrf0w==

-----END CERTIFICATE-----

@

External certificate was successfully installed.

(Dub)>

WESTELL.COM

Page 4-48

1-800-377-8766

Remote RMM-1400 Version 6.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 usb

diag whoami

(Dub)>diag

(Dub) diag>snapshot(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-49

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag tcpdump

diag tcpdump

DescriptionThis command displays the headers of packets received on a Remote RMM-1400 interface. Remote RMM-1400 displays the headers of all packets that match the criteria specified in this command’s optional parameters. If no optional parameters are entered, Remote RMM-1400 displays the headers of all packets received.

Note: When accessing the Remote RMM-1400 remotely over a WAN interface, this command will generate a large amount of unnecessary traffic as the result of tcpdump reporting its own output between the client computer and the Remote RMM-1400. 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 RMM-1400 interface receives a specified number of packets. The following parameter is accepted:

count—Defines the number of packets the Remote RMM-1400 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-50

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 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 RMM-1400 will not convert addresses to names.

-N Specifies that Remote RMM-1400 will not display domain name qualifications for host names.

-O Specifies that Remote RMM-1400 will not run the packet-matching code optimizer.

-p Specifies that Remote RMM-1400 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 RMM-1400 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-51



Examples

This example displays the headers of all packets received on the default interface (br_switch or bridge switch). Remote RMM-1400 displays packet headers in a line-buffered format.

-t Specifies that Remote RMM-1400 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-52

1-800-377-8766


Note: Press CTRL+c to terminate the display of packet headers.

(Dub)>diag

(Dub) diag>tcpdump -l

tcpdump: listening on br_switch

16:37:01.696704 10.44.7.6.2384 > 10.39.90.80.telnet: . ack 2484415291 win 63642(DF)

16:37:01.696888 10.39.90.80.telnet > 10.44.7.6.2384: P 1:34(33) ack 0 win 5840 (

DF)16:37:01.869630 arp who-has 10.39.68.20 (3a:73:e7:30:18:6) tell 10.39.0.1

16:37:01.885581 arp who-has 10.39.68.21 (3a:73:e7:30:18:6) tell 10.39.0.1

16:37:01.894734 arp who-has 10.39.68.22 (3a:73:e7:30:18:6) tell 10.39.0.116:37:01.901773 arp who-has 10.39.68.23 (3a:73:e7:30:18:6) tell 10.39.0.1

16:37:01.905477 arp who-has 10.39.68.24 (3a:73:e7:30:18:6) tell 10.39.0.1

16:37:01.915458 10.44.7.6.2384 > 10.39.90.80.telnet: . ack 34 win 63609 (DF)16:37:01.915643 10.39.90.80.telnet > 10.44.7.6.2384: P 34:580(546) ack 0 win 584

0 (DF)

16:37:02.134204 10.44.7.6.2384 > 10.39.90.80.telnet: . ack 580 win 63063 (DF)16:37:02.134392 10.39.90.80.telnet > 10.44.7.6.2384: P 580:746(166) ack 0 win 58

40 (DF)

16:37:02.347449 0:40:72:e:68:f6 > 1:40:72:1:1:1 snap ui/C len=24116:37:02.352957 10.44.7.6.2384 > 10.39.90.80.telnet: . ack 746 win 64512 (DF)

16:37:02.353141 10.39.90.80.telnet > 10.44.7.6.2384: P 746:981(235) ack 0 win 58

40 (DF)16:37:02.571710 10.44.7.6.2384 > 10.39.90.80.telnet: . ack 981 win 64277 (DF)

16:37:02.571932 10.39.90.80.telnet > 10.44.7.6.2384: P 981:1149(168) ack 0 win 5

840 (DF)16:37:02.790470 10.44.7.6.2384 > 10.39.90.80.telnet: . ack 1149 win 64109 (DF)

16:37:02.790654 10.39.90.80.telnet > 10.44.7.6.2384: P 1149:1318(169) ack 0 win

5840 (DF)

23 packets received by filter

0 packets dropped by kernel(Dub) diag>


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.

WESTELL.COM

1-800-377-8766

Page 4-53


This example displays the headers of all packets received on interface serial modem. Remote RMM-1400 displays absolute, rather than relative, TCP sequence numbers and does not display a timestamp for each packet header.

(Dub)>diag

(Dub) diag>tcpdump -i serial modem -S -t

tcpdump: listening on ppp_modem166.217.154.167.32779 > 192.228.36.48.1194: udp 85 (DF)

166.217.154.167.32779 > 192.228.36.48.1194: udp 85 (DF)

166.217.154.167.32779 > 192.228.36.48.1194: udp 85 (DF)192.228.36.48.1194 > 166.217.154.167.32779: udp 69 (DF)

192.228.36.48.1194 > 166.217.154.167.32779: udp 133 (DF)

166.217.154.167.32779 > 192.228.36.48.1194: udp 85 (DF)166.217.154.167.32779 > 192.228.36.48.1194: udp 85 (DF)

166.217.154.167.32779 > 192.228.36.48.1194: udp 85 (DF)

8 packets received by filter

0 packets dropped by kernel

(Dub) diag>

WESTELL.COM

Page 4-54

1-800-377-8766

Remote RMM-1400 Version 6.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-55

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag test alarm-entry

show test mode

WESTELL.COM

Page 4-56

1-800-377-8766

Remote RMM-1400 Version 6.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-57

Remote RMM-1400 Version 6.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-58

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

16:46:03 up 6 days, 5:29, 4 users, load average: 1.00, 1.00, 0.91197 processes: 195 sleeping, 2 running, 0 zombie, 0 stopped

CPU states: 0.4% user, 0.5% system, 0.0% nice, 99.2% idle

Mem: 257152K total, 137132K used, 120020K free, 1296K buffersSwap: 0K total, 0K used, 0K free, 80640K cached

PID USER PRI NI SIZE RSS SHARE STAT %CPU %MEM TIME COMMAND14253 test 16 0 1264 1264 920 R 19.8 0.4 0:00 top

1 root 8 0 520 520 440 S 0.0 0.2 0:04 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:09 ksoftirqd_CPU0

4 root 9 0 0 0 0 SW 0.0 0.0 0:00 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:00 kupdated

7 root 9 0 0 0 0 SW 0.0 0.0 0:00 mtdblockd

8 root 9 0 0 0 0 SW 0.0 0.0 0:00 khubd 56 root 15 10 0 0 0 SWN 0.0 0.0 0:00 jffs2_gcd_mtd6

57 root 15 10 0 0 0 SWN 0.0 0.0 0:00 jffs2_gcd_mtd7

58 root 15 10 0 0 0 SWN 0.0 0.0 0:00 jffs2_gcd_mtd9 59 root 15 10 0 0 0 SWN 0.0 0.0 0:00 jffs2_gcd_mtd8

60 root 15 10 0 0 0 SWN 0.0 0.0 0:00 jffs2_gcd_mtd10

61 root 15 10 0 0 0 SWN 0.0 0.0 0:00 jffs2_gcd_mtd11 62 root 15 10 0 0 0 SWN 0.0 0.0 0:00 jffs2_gcd_mtd12

105 root 9 0 2228 2228 1968 S 0.0 0.8 0:00 daemonrunner

106 root 9 0 6100 6100 2212 S 0.0 2.3 0:04 logd 107 root 9 0 6100 6100 2212 S 0.0 2.3 0:00 logd

108 root 9 0 6100 6100 2212 S 0.0 2.3 0:02 logd

114 root 9 0 2200 2200 1944 S 0.0 0.8 0:00 daemonrunner 115 root 9 0 2472 2472 2132 S 0.0 0.9 0:01 evtd

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.

WESTELL.COM

1-800-377-8766

Page 4-59


See Also diag ps

diag usb

diag whoami

NI Displays the “nice” value of the task. Negative nice values are higher priority.

SIZE Displays the virtual size of the process.

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) N (low priority - “nice”) W (paging)

%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-60

1-800-377-8766


diag usbDescription

This command displays information about any device connected to the Remote RMM-1400 USB bus.

Note: For Remote RMM-1400, the modem is the only device that makes use of the USB bus.

Formatsdiag usb


ExamplesThis example displays information about a modem connected to the USB hub.

(Dub)>diag

(Dub) diag>usb

Name Vendor ProdID USB Bus USB Device USB Parent USB PortUSB Hub 01.1 0x0000 0x0000 1 1 0 0

serial modemzzzzzzzz 0x1199 0x0024 01 3 02 00

(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-61

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag who

diag who

DescriptionThis command displays all users logged into Remote RMM-1400.

Formatsdiag who


ExamplesThis example displays the terminal names, login dates/times and workstation IP addresses for all users logged into Remote RMM-1400.

See Alsodiag break

diag whoami

show users

(Dub)>diag(Dub) diag>who

ai 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-62

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag whoami

diag whoami

DescriptionThis command displays the terminal name for a user logged into Remote RMM-1400.

Formatsdiag whoami


ExamplesThis example displays the terminal name (brb22) for the user logged into Remote RMM-1400.

See Also diag usb

show users

(Dub)>diag(Dub) diag>whoami

brb22

(Dub) diag>

WESTELL.COM

1-800-377-8766

Page 4-63

Remote RMM-1400 Version 6.4x Command Reference GuideDiagnostic Commands: diag whoami

WESTELL.COM

Page 4-64

1-800-377-8766

CHA

PTER 5

Utility Commands

This chapter describes the Remote RMM-1400 utility commands. Utility commands handle administrative tasks such as copying files, displaying the running configuration and logging out of Remote RMM-1400.


Utility Commands Overview

List of Utility Commands

Page 5-1

WESTELL.COM

Remote RMM-1400 Version 6.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 RMM-1400. All are executable from any level of the CLI.

WESTELL.COM

Page 5-2

1-800-377-8766

Remote RMM-1400 Version 6.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)>

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.

(Dub)>

(Dub) debug>Commands

dhcp-client(+) Enables or disables debug information

logging for DHCP client events. 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. modem(+) Enables or disables debug information

logging for serial modem controller and

interface events. openvpn(+) Enables or disables debug information

logging for OpenVPN events.

ppp(+) Enables or disables debug information logging for PPP.

site(+) Enables or disables site debug

information logging.

snmp(+) Configures SNMP debugging.

Enter ? to see available global commands.

(Dub) debug>

WESTELL.COM

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: copy

copy

DescriptionThis command copies a configuration file to the specified file name in the /config directory on the Remote RMM-1400 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 RMM-1400. For example, if you copy the factory-config to the running-config, Remote RMM-1400 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 RMM-1400 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

Page 5-4

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

show config-file

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 RMM-1400. 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


debug dhcp-client

DescriptionThis command enables or disables debug information logging for DHCP client events. When enabled, debug information is written to the Remote RMM-1400 log file.

Formatsdebug dhcp-client

all { disable | enable }error { disable | enable }

Parameters


ExamplesThis example displays the enabling of debug information logging for DHCP client events.

all Specifies that debug information logging is disabled or enabled for all DHCP client events. The following parameters are accepted: disable—Disables debug information logging. enable—Enables debug information logging.

error Specifies that debug information logging is disabled or enabled for verbose DHCP client error events. The following parameters are accepted: disable—Disables debug information logging. enable—Enables debug information logging.

(RMM103) debug>(RMM103) debug>dhcp-client

(RMM103) debug dhcp-client>all enable

(RMM103) debug dhcp-client>

WESTELL.COM

Page 5-6

1-800-377-8766


This example displays the disabling of debug information logging for DHCP client events.

See Alsoshow debugging

(RMM103)>debug

(RMM103) debug>dhcp-client(RMM103) debug dhcp-client>all disable

(RMM103) debug dhcp-client>

WESTELL.COM

1-800-377-8766

Page 5-7

Remote RMM-1400 Version 6.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 RMM-1400 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

Page 5-8

1-800-377-8766

Remote RMM-1400 Version 6.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.


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

1-800-377-8766

Page 5-9

Remote RMM-1400 Version 6.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 RMM-1400 debug messages.

Note: Enter CTRL+r to redisplay the command prompt. This is useful if the CLI display becomes polluted with debug messages.


all Enables the display of all debug messages.

authentication Enables the display of Authentication and 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

Page 5-10

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: debug mediation

debug mediation

DescriptionThis command enables or disables verbose debug information logging for the Remote RMM-1400 subsystems or components. When enabled, debug information is written to the Remote RMM-1400 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 }tcp { disable | enable }telnet { disable | enable }timer { disable | enable }uart { disable | enable }

Parameters

actions Specifies verbose debug information logging for the Remote RMM-1400 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

connections Specifies verbose debug information logging for the Remote RMM-1400 software subsystem that handles connection mediation. The following parameters are accepted: disable enable

WESTELL.COM

1-800-377-8766

Page 5-11


log Specifies verbose debug information logging for the Remote RMM-1400 software subsystem that handles logging mediation. The following parameters are accepted: disable enable

netif Specifies verbose debug information logging for the Remote RMM-1400 software subsystem that handles interface mediation. The following parameters are accepted: disable enable

peripheral Specifies verbose debug information logging for the Remote RMM-1400 software subsystem that handles peripheral mediation. The following parameters are accepted: disable enable

python Specifies verbose debug information logging for the Remote RMM-1400 software subsystem that handles Python mediation. The following parameters are accepted: disable enable

snmp Specifies verbose debug information logging for the Remote RMM-1400 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

tcp Specifies verbose debug information logging for the Remote RMM-1400 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

WESTELL.COM

Page 5-12

1-800-377-8766



ExamplesThis example displays the enabling of debug information logging for action mediation and peripheral mediation.


show log-file

timer Specifies debug information logging for timer mediation. The following parameters are accepted: disable enable

uart Specifies verbose debug information logging for the Remote RMM-1400 software subsystem that handles UART mediation. The following parameters are accepted: disable enable

disable Disables all debug information logging for the Remote RMM-1400 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 RMM-1400 software subsystem that handles action mediation. The following parameters are accepted: disable enable

(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 RMM-1400 Version 6.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 RMM-1400 log file.

Formatsdebug modem

all { enable | disable }controller { enable | disable }

Parameters



ExamplesThis example displays the enabling of debug information logging for modem controller events.

See Alsoconfig controller serial

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 RMM-1400 Version 6.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 RMM-1400 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 RMM-1400 Version 6.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 RMM-1400 Version 6.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 RMM-1400 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 RMM-1400 Version 6.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 RMM-1400 Version 6.4x Command Reference GuideUtility Commands: debug site

debug site

DescriptionThis command enables or disables debug information logging for site events. When enabled, debug information is written to the Remote RMM-1400 log file.

Formatsdebug site

system-modification { enable | disable }

Parameters



Examples

This example displays the enabling of debug information logging for site system-modification events.

See Alsoshow site modules

system-modifications Enables or disables all debug information logging for site system-modification events. The following parameters are accepted: Disable Enable

(Dub)>(Dub)>debug(Dub) debug>site>(Dub) debug site>system-modifications enable(Dub) debug site>

WESTELL.COM

1-800-377-8766

Page 5-19

Remote RMM-1400 Version 6.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 RMM-1400 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

show log-file

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

Page 5-20

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: erase

erase

DescriptionThis command deletes a configuration file from Remote RMM-1400.

Formatserase filename

Parameters


ExamplesThis example displays the deletion of the configuration file myconfig from Remote RMM-1400.

See Alsocopy

show config-file

filename Defines the name of the file being deleted from Remote RMM-1400. Valid values are any configuration file on Remote RMM-1400 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-21

Remote RMM-1400 Version 6.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 RMM-1400.

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 RMM-1400.

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-22

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400 /modules staging area.

Tip: The staging area is the /modules directory on Remote RMM-1400 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 RMM-1400.

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.tgz

The modules Common and Environmental were installed successfully.

(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-23

Remote RMM-1400 Version 6.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 RMM-1400, 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 RMM-1400.

See Alsoexec site install

show site modules

module_name Defines the name of the module being installed.

(Dub)>exec site uninstall Environmental

Module "Environmental" uninstalled successfully.(Dub)>

WESTELL.COM

Page 5-24

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: exec-job run

exec-job run

DescriptionThis command starts a job for Remote RMM-1400. 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-25


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 RMM-1400 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.

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.

WESTELL.COM

Page 5-26

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.

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 debug

Run ID: 10

Connecting 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 check

Run ID: 11(Dub) exec-job myjob>

WESTELL.COM

1-800-377-8766

Page 5-27


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-28

1-800-377-8766

Remote RMM-1400 Version 6.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>stop

Run ID: 5

Start: 2009/09/14 14:49:57End: 2009/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-29

Remote RMM-1400 Version 6.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 jobtestutils

Job Run ID Start time End time Exit state

newjob2 4 2009/09/15 11:34:45 2009/09/15 11:35:40 killedmyjob 8 2009/09/15 11:34:22 2009/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 states of jobs upon exit. Possible values are normal, killed and abnormal.

WESTELL.COM

Page 5-30

1-800-377-8766

Remote RMM-1400 Version 6.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 RMM-1400.

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, such astcp 10.40.57.5:40001:4

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-31

Remote RMM-1400 Version 6.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-32

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: help

help

DescriptionThis command displays an explanation of how to use the ? command for Remote RMM-1400.

Formatshelp


ExamplesThis example displays an explanation of how to use the ? command.

(Dub)>helpYou can request help for a command at any time by entering

a question mark ('?'). The '?' displays the following types

of 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 reference

guide.(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-33

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: logout

logout

DescriptionThis command ends a Remote RMM-1400 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 RMM-1400 session.

See Alsoexit

(Dub)>logout

WESTELL.COM

Page 5-34

1-800-377-8766

Remote RMM-1400 Version 6.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-35

Remote RMM-1400 Version 6.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 RMM-1400, 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 RMM-1400 is attempting to ping.

ip_address Defines the IP address of the device that Remote RMM-1400 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-36

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: ping

ExamplesThis example displays IP address 10.44.57.5 as it is pinged from Remote RMM-1400.

Important: To stop the execution of this command, press CTRL+c.

This example displays IP address 10.25.2.5 as it is pinged from Remote RMM-1400 with packet size specification 70.

See Alsotelnet

ssh

(Dub)>ping 10.44.57.5PING 10.44.57.5 (10.44.57.5): 56 data bytes

64 bytes from 10.44.57.5: seq=0 ttl=63 time=3.508 ms

64 bytes from 10.44.57.5: seq=1 ttl=63 time=1.974 ms64 bytes from 10.44.57.5: seq=2 ttl=63 time=2.064 ms


--- 10.44.57.5 ping statistics ---

4 packets transmitted, 4 packets received, 0% packet loss

round-trip min/avg/max = 1.970/2.379/3.508 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 10.25.2.5 size 70PING 10.25.2.5 (10.25.2.5): 70 data bytes





--- 10.25.2.5 ping statistics ---6 packets transmitted, 6 packets received, 0% packet loss

round-trip min/avg/max = 0.971/1.073/1.254 ms

(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-37

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: reload

reload

DescriptionThis command resets Remote RMM-1400. Before a reset is issued, Remote RMM-1400 prompts to save the running configuration.

Formatsreload [ reason ]

Parameters


ExamplesThis example displays the saving of the running configuration and the resetting of Remote RMM-1400.


copy

reason Defines the reason why Remote RMM-1400 is being reset. Tip: A system log file, which is generated before the reset, displays the

reason why the reset occurred.

(Dub)>reload

Do you wish to save your running configuration? (y/N) n

Are you sure you wish to reset? (y/N) y

System going down IMMEDIATELY!

WESTELL.COM

Page 5-38

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: running-config

running-config

DescriptionThis command compiles and displays the current Remote RMM-1400 configuration. It displays recent user modifications to the configuration, such as interface configuration. The running configuration can be accessed anytime and by any user.

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 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, among other things, default route 10.39.0.1 is set, the Remote RMM-1400 session is configured to never timeout and user techcomm is added to the system.

nopage Displays the entire running configuration upon execution of the command. When this parameter is not specified, Remote RMM-1400 outputs the running configuration one page at a time.

WESTELL.COM

1-800-377-8766

Page 5-39

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: running-config

See Alsocopy

show running-config

(Dub)>running-config# Product: Remote RMM-1400

# Version: 2.00

# Created: 2010-11-22,16:46:13.0,+0000# User: janedoe

# Bootloader Version: 1.00

config clock timezone EST -05:00config clock daylight-savings EDT

config ip route default 10.39.0.1

config dhcp-relay server 10.39.70.40config peripheral 1 type rmb-1

config peripheral 1 manage RMB1-0E68FD

config remote-access http disableconfig remote-access https enable

config snmp host 10.34.3.84 162 public v1

config snmp host 10.34.3.83 162 public v2-informconfig snmp host 10.34.3.86 162 public v2

config timeout 0

config users add techcomm supervisor -e$1$Qzv94sky$J/XFok7lVjo8E/lmbH9fh. -e$1$Qzv94

config interface bridge switch ip address 10.39.90.2/16

--More--

WESTELL.COM

Page 5-40

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: ssh

ssh

Description

This command provides a secure encrypted connection that supports simple terminal and command access from the Remote RMM-1400 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 Default

Port 22

Required User Profiles

management, supervisor, status

Examples

The following example displays the Remote RMM-1400 connecting to IP address 10.39.50.10.

See Alsotelnet

ping

port Port being used to connect to a remote host.

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.10

Please enter the user name: testWarning: Permanently added '10.39.50.10' (RSA) to the list of known hosts.

Password:(Dub)>

WESTELL.COM

1-800-377-8766

Page 5-41

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: telnet

Page 5-42

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 RMM-1400 connecting to IP address 10.44.57.5 (another Kentrox Remote RMM-1400 device).

See Alsoping

ssh

hostname Defines the host to which Remote RMM-1400 will establish a Telnet connection.

ip_address Defines the IP address to which Remote RMM-1400 will establish a Telnet connection.

port Defines the port number being used for Telnet service.

(Dub)>telnet 10.44.57.5

Trying 10.44.57.5...

Connected to 10.44.57.5.Escape character is '^]'.

_ __ _____ _ _ _______ _____ ____ __ __

| | / / | ___|| \ | ||___ ___|| _ \ / \ \ \ / / | |/ / | |___ | \ \| | | | | (_) || -- | \ \/ /

| ( | ___|| |\ \ | | | | _ / | ( ) | ) (

| |\ \ | |___ | | \ | | | | | \ \ | -- | / /\ \ |_| \_\ |_____||_| \_| |_| |_| \_\ \____/ /_/ \_\

RMM-1400login:

WESTELL.COM

1-800-377-8766

Remote RMM-1400 Version 6.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.44.57.5.

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.44.57.5

traceroute to 10.44.57.5 (10.44.57.5), 30 hops max, 38 byte packets

1 10.39.0.1 1.172 ms 0.942 ms 0.938 ms 2 10.44.57.5 8.266 ms 2.142 ms 1.934 ms

(Dub)>


38 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-43

Remote RMM-1400 Version 6.4x Command Reference GuideUtility Commands: trace-route

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 10.25.2.20 source 10.40.57.5

traceroute 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-44

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-170.

The following are some of the valid command identifications for Remote RMM-1400:

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

Page A-1

WESTELL.COM

Remote RMM-1400 Version 6.4x Command Reference GuideAppendix A Command Identifications:

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

config controller openvpn /config/controller/openvpn/

config controller serial (modem) /config/controller/modem

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

Commands Identifications (Continued)

WESTELL.COM

Page A-2

1-800-377-8766


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 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 ip route-v6 /config/ip/route-v6

config iptables /config/iptables

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


WESTELL.COM

1-800-377-8766

Page A-3


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

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-element 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 timeout /config/timeout

config use-wizard /config/use-wizard


WESTELL.COM

Page A-4

1-800-377-8766


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 dhcp-client /debug/dhcp-client

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

debug serial /debug/serial

debug site /debug/site

diag /diag

diag break /diag/break

diag clear /diag/clear

diag controller /diag/controller

diag ip /diag/ip

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


WESTELL.COM

1-800-377-8766

Page A-5


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

exec-job /exec-job

exit /exit

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


WESTELL.COM

Page A-6

1-800-377-8766


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 correlations /show/correlations

show debugging /show/debugging

show dhcp-relay /show/dhcp-relay

show dhcp-server /show/dhcp-server

show discrete /show/discrete

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 licenses /show/licenses

show listeners /show/listeners

show log-file /show/log-file

show meas-table /show/meas-table

show mediation /show/mediation

show ntp /show/ntp


WESTELL.COM

1-800-377-8766

Page A-7


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

show site network-elements-sets /show/site/network-elements-sets

show site params /show/site/params

show snmp /show/snmp

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

Page A-8

1-800-377-8766

APPEN

DIX B

Command Access by Permission Levels

This appendix lists all Remote commands by user permission level, as set in each user’s profile. Refer to config users on page 2-217 for additional information about user profiles and permission levels.

Guide to this Appendix

Access Levels for All Commands

Page B-1

WESTELL.COM

Remote RMX-3200 Version 6.4x Command Reference GuideCommand Access by Permission Levels

Access Levels for All CommandsTable B-2 lists Remote CLI commands and the user access levels which can use each command. The Access Level abbreviations are shown in Table B-1.

Note: Unless noted otherwise, this appendix lists only the highest level commands

needed to convey the access level applied to those commands. Individual parameters are not listed unless their access level differs from that of the parent command. For example, there is a single listing for config controller ethernet showing the access level SM, because access level SM applies to all 10 config controller ethernet parameter subcommands.

Table B-1 Access Level Legend

Access Level(s) Abbreviation

Supervisor only S

Supervisor and Manager SM

Supervisor, Manager, and Status SMSt

Table B-2 Access Levels for All Commands

Command Access Level

config SM

config action SM

config alarm-entry SM

config apply-patch SM

config banner SM

config clock SM

config controller SM

config controller bridge SM

config controller ethernet SM

config controller nat64 SM

config controller openvpn SM

WESTELL.COM

Page B-2

1-800-377-8766


config controller serial SM

coinfig correlation SM

config dhcp-relay SM

config dhcp-server SM

config discrete SM

donfig event SM

config hostname SM

config interface SM

config ip SM

config route-v6 SM

config iptables SM

config iptables-v6 SM

config jobs SM

config meas-table SM

config mediation (see exception below) SM

config mediation tacacs-service S

config ntp SM

config peripheral SM

config pkgs SM

config profile S

config ras S

config remote-access SM

config response SM

config site SM



WESTELL.COM

1-800-377-8766

Page B-3


config sitebus SM

config snmp SM

config tbos SM

config timeout SM

config use-wizard SM

config users S

copy SM

debug dhcp-client SM

debug ethernet SM

debug level SMSt

debug mediation SM

debug serial SM

debug site SM

diag break S

diag clear SM

diag controller SM

diag fan S

diag ip SMSt

diag line-monitor SM

diag line-status SM

diag mediation SM

diag mmdisplay SM

diag output SMSt

diag peripheral SM



WESTELL.COM

Page B-4

1-800-377-8766


diag ps SMSt

diag remote-access S

diag snapshot S

diag test SM

diag tcpdump SMSt

diag top SMSt

diag who SMSt

diag whoami SMSt

erase SM

exec site SM

exec-job SM

exit SM

help SMSt

password SMSt

ping SMSt

reload SM

running-config SMSt

show SMSt

show actions SMSt

show alarm-entries SMSt

show audit SMSt

show banner SMSt

show clock SMSt

show compact-flash SMSt



WESTELL.COM

1-800-377-8766

Page B-5


show config-file SMSt

show connections SMSt

show controllers SMSt

show correlations SMSt

show debugging SMSt

show dhcp-relay SMSt

show discrete SMSt

show events SMSt

show expansion-images SMSt

show interfaces SMSt

show inventory SMSt

show ip SMSt

show iptables SMSt

show jobs SMSt

show listeners SMSt

show licenses SMSt

show log-file SMSt

show meas-table SMSt

show mediation SMSt

show ntp SMSt

show peripherals SMSt

show pkgs SMSt

show profiles S

show product SMSt



WESTELL.COM

Page B-6

1-800-377-8766


show ras S

show remote-access SMSt

show resource-tracking SMSt

show responses SMSt

show running-config SMSt

show site SMSt

show snmp SMSt

show tbos SMSt

show test SMSt

show timeout SMSt

show users S

show version SMSt

ssh SMSt

telnet SMSt

trace-route SM



WESTELL.COM

1-800-377-8766

Page B-7


WESTELL.COM

Page B-8

1-800-377-8766

IND

EX

Index

Symbols? (command) 33??? 41

AAccess Levels for All

Commands 2action

display 5address

ipv6 92alarm entry display 8alarm states, resetting 5alarm-entry configuration

commandsalarm nagging settings 11events that activate an

alarm-entry 8allow-access 32analog event originator 78application mode

configuration for an asynchronous serial controller 38

ARP cacheconfiguration 105display 75

asynchronous serial port monitoring 34

audited action display 12authority for a DHCP server

56

Bband configuration for a

discrete analog input 66

bannerconfiguration of 15display of 16

baud rate configuration 38BOOTP/DHCP

relay 48relay agent 54server 54, 48

break propagation 189bridge controller

configuration 23bridge controller display 26bridge interface

configuration 88bridge interface display 64broadcast configuration for a

DHCP server 56broadcast packets 56build time and date display

for software 162

Ccapture of job output 112categories for alarm entries

7CHAP and PAP

authenticationidentity 48local identity and secret

configuration 48method 49remote identity and secret

configuration 49check mode for a running job

26

CLI, using theabbreviated command

entry 6command help 7command types 4, 5, 4navigation and command

entry 4, 6client-route 32, 34clock configuration 17command entry

abbreviated 6parameters with spaces 5

command help, overview 7command usage

statements, displaying 7

compact flash card 18concurrent logins limit 217config 144

apply-patch 13banner 15clock 17dhcp-relay 54hostname 87ip 104iptables 108meas-table 123peripheral 157remote-access 177sitebus 194, 205snmp 131, 134, 144, 149,

170timeout 213users 217use-wizard 215

config alarm-entry 6event 8nagging 11

Page Index-1

WESTELL.COM

Remote RMM-1400 Version 6.4x Command Reference GuideIndex: D

config clock 17daylight-savings 19

config controller bridge switch 23config controller ethernet 25

bridge switch 28config controller nat64 29config controller openvpn

deleting 29resetting 29

config controller serial 36connect 41disconnect 45encapsulation 47

config dhcp-relay 54config dhcp-server 56

interface 60subnet 61

config discreteanalog 65input 71

config event 75content 77

config interfacebridge switch 88

ip 89ip dhcp 90ipv6 92nat64 94

ethernet 95ip 96ipv6 98nat64 99

openvpn 100serial 102

config jobs 110name 112

config jobs name task 118config mediation

tl1 command 154config mediation snmp

event-template 131manager 134measurement-template 135ne-template 141point-template 144

config mediation snmpne 149config ntp 154config pkgs

install 160on-demand-install 164server 166uninstall 168

config rasserver 174

config response 180content 182

config response contentconnect 188

configuration filescopy of 4display of 19

for a DHCP server 57configuration wizards 215connect response

configuration 188responders 191

connect string for a serial connection 44

connection event types 84controller display 24, 33controllers

display of 24copy 4counters

for interfaces 62, 70cron start

display 88cron-start for a job 112

Ddata received event type 84data-link layer address 26, 59daylight savings time

configuration 19display of 17

debugEthernet 6level 10mediation 11OpenVPN 15ppp 17site 19snmp 14, 20

debug dhcp-client 6debug information logging

for mediation 11for OpenVPN 15for PPP encapsulation 17

debug mode for a running job 26debug modem 14debug status display 46default alarm-table entries for digital

inputs 71destination data string, for a

connect response 190destination for a mediation

connection 189dgram 121DHCP packets 54DHCP server

configuration 56DHCPNAK messages 56display of information 49hardware address for a host 59IP address for a host 59

DHCP server subnetdefault lease 62domain name server 62maximum lease 62range 63router 63

dhcp-relay 54diag

break 5, 4clear 5line-monitor 34line-status 36mmdisplay 38ps 43snapshot 49tcpdump 50top 58who 61whoami 63

diag controller serialbert 8loopback 10

diag controller serial modem 10diag ip

address show 13link show 18neighbor show 22

diag ip routeget 24show 27

diag ip route-v6show 27

diag mediation snmpne poll 37, 57diag peripheral

reload 41diagnostic commands 4–63

for creating file snapshot.tar.gz 49

for displaying IP address information 13

for displaying IP packet headers 50

for displaying link information 18for displaying logged in users 61for displaying neighbor

information 22for displaying route information

24, 27for displaying running processes

43for displaying the terminal name

63for displaying top CPU processes

58for finding a route 24for resetting a peripheral 41for terminating a shell connection

5, 4digital input configuration 71digital output

opening and closing 40resource tracking 73

digital output configuration 73disconnect mode 45discrete analog input

band configuration 66disable of 66

WESTELL.COM

Page Index-2

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideIndex: E

enable of 66lowest valid current 68maximum current configuration

67resource tracking 65

discrete expansion peripheral configuration 157

discrete point display 52DNS server

configuration 105display 75

domain nameconfiguration 105display 75

down event type 84DTR 42, 45Duplex operation 26

Eencapsulation formats for

communications 47erase 21Ethernet controller

configuration 25debugging 6description 25display 29hardware address 26speed 26

Ethernet event originator 79Ethernet interface

configuration 95debugging 6description 95display 67IP address 96

event 131configuration 51, 75display 44, 57types 84–86

event correlation 51event correlations 44event template 131event-templates 100exec-job

run 22stop 29

exec-kill connection 31exit 32exit states for a job 83, 86

Ffilter table 108, 109forward

status display 75FTP server

server configuration 166

GGMT timestamp configuration 17

Hhardware

address 26components, display 74information display 118

Heading1config correlation 51

help 33high event 66, 67hostname configuration 87http

//ipset.netfilter.org/iptables.man.html 108

HTTP remote access protocol 177hysteresis configuration 67

IICMP echo request packet 36identity for CHAP and PAP

authentication 48in-band event 66, 67in-band event type 85incoming connection event type 85initialization event type 84input event originator 79input saturated event type 85input_saturated event 67interface configuration for a DHCP

server 60interface display 62, 70interface, adding to a bridge group

88interval event type 85IP address display 13IP configuration 104IP forwarding 105IP packet headers, display 50IP table rule and interface counters,

clearing 5iptables

display 79iptables configuration 108

Jjobs

attribute display 82configuration 112exit states 83, 84, 86, 29history display 82history runs display 82identical start times 114information display 82manually stopping 115package version level selection

114property configuration 113restart configuration 115run count 82runs, resetting 110runtime

information display 85statistics display 29

startID number assignment 114

start time specification 114statistics display 82summary display 82tasks

configuration 118

LLCP and NCP negotiation 17LCP echo requests 48limiting concurrent logins 217linemode

asynchronous serial controller configuration 39

settings 39local and global commands,

displaying available 9local CHAP and PAP authentication

settings 48local time

display 17local time configuration 17log file 94logged in user display 61logging out of a console or remote

session 34login banner

configuration 15display 16

logins limit 217logout 34loss-of-signal event type 85low band threshold 85low event 66low event type 85

Mmanagement information base 208management station

configuration 209managing a peripheral 158mangle table 108, 109maximum current configuration for

discrete analog inputs 67MDI-X 26mediation configuration commands

TL1 command pattern configuration 154

mediation connection destination 189

WESTELL.COM

1-800-377-8766

Page Index-3

Remote RMM-1400 Version 6.4x Command Reference GuideIndex: N

mediation connection listenersdisplaying 93

mediation connectionsdisplay 22termination 31

mediation debugging 11mediation display 100mediation messages

display 38display settings 38

mediation SNMP network elements 149

mediation timerdisplay 160

memory configuration for jobs 113memory limits for a job 113MRU 49MTU 49

Nnagging 11nat table 108nat64 29navigating the command hierarchy

32navigation keys 4NE satus points 140NE template 141network element and alarm entries

7network element sets

configuring 201definition of 201displaying information for 147instance 201

NTPpoll interval 155preferred server 156server 156

NTP configuration 154display 109

Ooffline event type 85on demand install of packages 164online event type 85open event type 86OpenVPN debugging 15openVPN interface configuration

100originator 31output capture display 89

Ppackage display 114package installation 160package server

address configuration 166directory configuration 166user configuration 167

packagesminimum required version level

164missing packages 164on-demand-install 164server configuration 166uninstallation of 168version levels for 114

packet-level debugging 17parity, asynchronous serial

controller configuration of 40part number 118partial command inputs, displaying

9patch files 13per-call modem dial string 190, 191peripheral

display of information 110event originator 81management 158type configuration 158

ping 36point display 52point template 144point-template 144point-templates 100poll oid 145PPP 49, 17product

components, display of 74information display 118

prompt display configuration 87proxy ARP 26PyChecker utility 26

RRADIUS 174RAS

configuration display 121RADIUS 174server configuration 174TACACS+ 174

RAS configuration commandsfor the primary and secondary

server 174raw response information for an

alarm-entries 7records of job runs 110reload 38remote access configuration 177remote CHAP and PAP

authentication settings 49remote identity and secret

configuration for CHAP and PAP authentication 49

remote-access status display 124reset for the system 38

resource trackingdisplay 125for a digital output 73for digital inputs 71for Ethernet controllers 25of a discrete analog input 65

responders 185response configuration commands

connect response configuration 188

initial configuration 180response content settings 182response display 126responses

closing a relay output 182disabling a component 183enabling a component 183interval response 183opening an output 184restarting a timer 184stopping a timer 184timer life configuration 184user.log configuration 184

RMB peripheral unitconfiguring 157humidity sensor 66rebooting 41sitebus 205temperature sensor 68

route-v6configuration 106

routing table display 75RTS 43, 46run count history 82running a job 22running process display 43running-config 128, 39runtime statistics display for a job 29

Sscript configuration for a job 114script-job

event originator 81sensor

input 66, 67, 68output current 67, 68

serial controller configurationapplication mode 38disconnect mode 45encapsulation protocol 47linemode configuration 39parity configuration 40stop bit 40

serial controller connection settingsconnect mode 43connect string 44DTR 42RTS 43

serial controller description 38serial controller disconnect settings

WESTELL.COM

Page Index-4

1-800-377-8766

Remote RMM-1400 Version 6.4x Command Reference GuideIndex: T

disconnect mode 45DTR 45RTS 46

serial controller display 38serial event originator 81serial interface

configuration 102display 70, 72IP address 102

severity levels 9shell connection termination 5, 4show

actions 5, 4alarm-entries 8audit 12banner 16clock 17compact-flash 18config-file 19connections 22controllers 24, 33debugging 46dhcp-relay 48dhcp-server 49discrete 52events 44, 57expansion-images 59interfaces 62, 70inventory 74ip 75iptables 79jobs 82licenses 91log-file 94meas-table 96mediation 100ntp 109peripherals 110pkgs 114product 118pydoc 121ras 121remote-access 124resource-tracking 125responses 126running-config 128site network-elements-sets 147sitebus 130snmp 134timeout 159timers 160users 161version 162

show controllersbridge 26ethernet 29serial 38

show controllers nat64 32show correlations 44show interfaces

bridge 64

ethernet 67serial 72

signal good event type 86sim pin 11sitebus configuration 194SNMP 149

authentication failure traps 208community strings 208community types 208, 209event template 131management stations 209manager 134NE template 141network elements 149point template 144setting display 152trap support for alarm entries 8

snmpmanager 134point template 144

SNMP displaycommunity strings 152management stations 152summary 152

SNMP event templates 101SNMP manager 100SNMP network elements 101source data string for a connect

response 191ssh 41SSH and SFTP remote access

protocols 178stage 2 bootloader 59standard error/output 112start at boot up for a job 115start attempt configuration for a job

115start time configuration for a job 114static route configuration 106status points 140stderr 112stdout 112stop bits

asynchronous serial controller configuration of 40

stopping a job 29stream 121strong password 217subcommands, displaying 8summary display

of job runtime statistics 29system

configuration compilation 128, 39configuration display 128, 39log-file display 94timeout interval display 159

system event originator 83

TTAB key functionality in the CLI 5

tacacs 154TACACS+ 174tacacs-service 154task display for a job 86TCP

event originator 83tcpdump 50telnet 42Telnet and FTP remote access

protocols 178telnet event originator 83terminal name, for a connection 4time and date display 17time configuration commands 17–

19time, ping display 37timeout interval for the system 213timer

display 160timestamp configuration 17timezone

display of 17timezone configuration 17timing out the system 213title configuration for a job 115TL1 command

command pattern generation 154top CPU process display 58trace-route 44trap table 209ttl 37

Uunit 27, 29units for analog inputs 69up event type 86usage statements 7user

authentication and provisioning 174

user configuration commandspassword 35

usersadding 217authentication and provisioning

172deleting 217display of 161display of all 61password change 217resetting 217

utility commandscopy 4erase 21exit 32help 33logout 34overview 3ping 36reload 38

WESTELL.COM

1-800-377-8766

Page Index-5

Remote RMM-1400 Version 6.4x Command Reference GuideIndex: V

running-config 39telnet 42trace-route 44

Vvarbind 146version level display 162

Wwizards 215

WESTELL.COM

Page Index-6

1-800-377-8766

COPYRIG

HTS

Copyrights and License Statements

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-91.

Page Copyrights-1

WESTELL.COM

http://www.westell.com/support

Remote RMM-1400 Version 6.4x Command Reference Guide:

WESTELL.COM

Page 2-2

1-800-377-8766

remote rmm-1400 command reference guide version...

Documents