Remote RMM 1400 Version 2 0x Command Reference Guide Revision 2

2010 by Kentrox, Inc. All rights reserved.
RemoteRMM-1400
IntelligentRemoteSiteManagementDevice
CommandReferenceGuide
Version2.0x
Part Number 65-000093 Rev 2
Copyright 2010 by Kentrox, Inc. All Rights Reserved. The material discussed in this publication
is the proprietary property of Kentrox, Inc. Kentrox retains all rights to reproduction and
distribution of this publication.
Kentrox is a registered trademark of Kentrox, Inc. Kentrox, the Kentrox logo, Applied Innovation,
Applied Innovation Inc., the AI logo, and other names are the intellectual property of Kentrox. All
other product names are trademarks or registered trademarks of their respective owners.
Information published here is current as of this documents date of publication, but is subject to
change without notice. You may verify product information by contacting our headquarters.
Kentrox is an Equal Opportunity/Affirmative Action employer.
Kentrox, Inc.
5800 Innovation Dr.
Dublin, Ohio USA 43016-3271
Toll Free: (800) 247-9482
International: +1 (614) 798-2000
Fax: +1 (614) 798-1770
i
AboutthisDocument
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.
Remote RMM-1400 system administrators should have a working knowledge of:
Telecommunications networks and TCP/IP networking (including Telnet and FTP)
FTP tools
SNMP
DHCP
IP tables
Remote RMM-1400 Version 2.0x Command Reference Guide
About this Document: Document Conventions
ii
DocumentConventions
Table 1 describes the text conventions used in this document.
Table 1 Document Conventions
Convention Meaning
Scr een Text , Syst em
Pr ompt s, Messages and
Repor t s
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.
About this Document: Document Conventions
iii
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
About this Document: Customer Assistance
iv
CustomerAssistance
All customers, partners, and resellers who have a valid Kentrox Support and Services
Agreement have complete access to the technical support resources.
Kentrox offers technical support from 8 a.m. to 8 p.m. Eastern time, Monday - Friday.
Before you contact Kentrox for assistance, please have the following information
available:
The version of hardware and software you are currently running
The error number and exact wording of any messages that appeared on your
screen
What happened and what you were doing when the problem occurred
How you tried to solve the problem
KentroxOnlineKnowledgeBase
The Kentrox Online Knowledge Base provides online documents and tools to help
troubleshoot and resolve technical issues with Kentrox products and technologies.
To access the Kentrox Online Knowledge Base, use this URL:
http://kb.kentrox.com
EmailSupport
Email support is available. You may send email at any time during the day; however,
responses will be only be provided during normal business hours, in accordance with
your Service and Support Agreement.
To contact Technical Support, send email to:
support@kentrox.com
TelephoneSupport
Pre-sales support
Available, at no charge, to anyone who needs technical assistance in determining
how Kentrox products or solutions can help solve your technical needs.
Phone number: 800-733-5511, option 2
Hours of Operation: 8 a.m. 8 p.m. Eastern Time
Post-sales support
Available to qualified Kentrox customers or partners who have not been able to
resolve their technical issue by using our online services. To qualify for support, you
must have a valid Support and Services Agreement.
v
Phone number: 800-733-5511, option 3
Normal Business Hours: 8 a.m. to 8 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-
hours support, you must have a valid 24x7 Support and Services Agreement. Call the
number above, option 3, and follow the prompts for after-hours service.
ProductDocumentation
You can also access and view the most current versions of Kentrox product
documentation on our Web site at:
http://www.kentrox.com
vi
TOC-1
TableofContents
Chapter1:CLIOverview ........................................................................ 1-1
Accessing the Command Line Interface ...................................................................... 1-2
Viewing Global Commands .............................................................................. 1-2
Command Types .......................................................................................................... 1-3
Configuration Commands ................................................................................. 1-3
Show Commands ............................................................................................. 1-3
Diagnostic Commands ..................................................................................... 1-3
Utility Commands ............................................................................................. 1-3
CLI Navigation and Command Entry ............................................................................ 1-4
Navigation Keys ............................................................................................... 1-4
Parameter Values with Spaces ........................................................................ 1-5
Abbreviated Command Entry ........................................................................... 1-6
Command Help ............................................................................................................ 1-7
Using the Help Command ................................................................................ 1-7
Using the ? ....................................................................................................... 1-7
CLI Command Descriptions ....................................................................................... 1-10
Chapter2:ConfigurationCommands..................................................... 2-1
The config Command Overview ................................................................................... 2-2
List of Config Commands ............................................................................................. 2-3
config action ................................................................................................................. 2-4
config alarm-entry ........................................................................................................ 2-6
config alarm-entry event ................................................................................... 2-9
config alarm-entry nagging ............................................................................. 2-10
config apply-patch ...................................................................................................... 2-12
config banner ............................................................................................................. 2-14
config clock ................................................................................................................ 2-16
config clock daylight savings .......................................................................... 2-18
config controller bridge switch .................................................................................... 2-22
config controller ethernet ............................................................................................ 2-24
config controller ethernet bridge switch ...................................................................... 2-28
config controller openvpn ........................................................................................... 2-29
config controller serial ................................................................................................ 2-32
config controller serial connect ....................................................................... 2-36
config controller serial disconnect .................................................................. 2-39
config controller serial encapsulation ............................................................. 2-41
TOC-2
Table of Contents
config correlation ........................................................................................................ 2-45
config dhcp-relay ........................................................................................................ 2-48
config dhcp-server ...................................................................................................... 2-50
config dhcp-server host .................................................................................. 2-52
config dhcp-server interface ........................................................................... 2-54
config dhcp-server subnet .............................................................................. 2-55
config discrete analog ................................................................................................ 2-59
config discrete input ................................................................................................... 2-66
config discrete output ................................................................................................. 2-69
config event ................................................................................................................ 2-71
config event content ................................................................................................... 2-73
config hostname ......................................................................................................... 2-83
config interface bridge switch ..................................................................................... 2-84
config interface bridge switch ip dhcp ............................................................ 2-85
config interface ethernet ............................................................................................. 2-87
config interface openvpn ............................................................................................ 2-89
config interface serial ................................................................................................. 2-91
config ip ...................................................................................................................... 2-93
config iptables ............................................................................................................ 2-96
config jobs .................................................................................................................. 2-97
config jobs name ........................................................................................................ 2-99
config jobs name task .............................................................................................. 2-105
config meas-table ..................................................................................................... 2-110
config meas-table entry ................................................................................ 2-111
config mediation snmp event-template .................................................................... 2-115
config mediation snmp manager .............................................................................. 2-118
config mediation snmp measurement-template ....................................................... 2-119
config mediation snmp ne-template ......................................................................... 2-125
config mediation snmp point-template ..................................................................... 2-128
config mediation snmpne ......................................................................................... 2-133
config ntp .................................................................................................................. 2-138
config peripheral ....................................................................................................... 2-140
config pkgs install ..................................................................................................... 2-143
config pkgs on-demand-install ................................................................................. 2-148
config pkgs server .................................................................................................... 2-150
config pkgs uninstall ................................................................................................. 2-152
config profile ............................................................................................................. 2-154
config remote-access ............................................................................................... 2-156
config response ........................................................................................................ 2-159
config response content ........................................................................................... 2-161
config response content connect .................................................................. 2-167
config sitebus ........................................................................................................... 2-172
config snmp .............................................................................................................. 2-174
TOC-3
Table of Contents
config timeout ........................................................................................................... 2-177
config use-wizard ..................................................................................................... 2-179
config users .............................................................................................................. 2-181
Chapter3:ShowCommands ................................................................. 3-1
The show Command Overview .................................................................................... 3-2
List of Show Commands .............................................................................................. 3-3
List of Show Commands (continued) ........................................................................... 3-4
show actions ................................................................................................................ 3-5
show alarm-entries ....................................................................................................... 3-8
show audit .................................................................................................................. 3-12
show banner ............................................................................................................... 3-16
show clock .................................................................................................................. 3-17
show compact-flash ................................................................................................... 3-18
show config-file .......................................................................................................... 3-19
show connections ....................................................................................................... 3-22
show controllers ......................................................................................................... 3-24
show controllers bridge .............................................................................................. 3-26
show controllers ethernet ........................................................................................... 3-29
show controllers openvpn .......................................................................................... 3-32
show controllers serial ................................................................................................ 3-37
show correlations ....................................................................................................... 3-43
show debugging ......................................................................................................... 3-45
show dhcp-relay ......................................................................................................... 3-47
show dhcp-server ....................................................................................................... 3-48
show discrete ............................................................................................................. 3-51
show events ............................................................................................................... 3-56
show expansion-images ............................................................................................. 3-58
show interfaces .......................................................................................................... 3-61
show interfaces bridge ............................................................................................... 3-63
show interfaces ethernet ............................................................................................ 3-66
show interfaces openvpn ........................................................................................... 3-69
show interfaces serial modem .................................................................................... 3-71
show inventory ........................................................................................................... 3-73
show ip ....................................................................................................................... 3-74
show iptables ............................................................................................................. 3-78
show jobs ................................................................................................................... 3-81
show jobs name ......................................................................................................... 3-84
show listeners ............................................................................................................ 3-90
show log-file ............................................................................................................... 3-91
show meas-table ........................................................................................................ 3-93
show mediation .......................................................................................................... 3-97
TOC-4
Table of Contents
show ntp ................................................................................................................... 3-106
show peripherals ...................................................................................................... 3-107
show pkgs ................................................................................................................ 3-111
show product ............................................................................................................ 3-115
show profiles ............................................................................................................ 3-116
show pydoc .............................................................................................................. 3-118
show remote-access ................................................................................................ 3-121
show resource-tracking ............................................................................................ 3-122
show responses ....................................................................................................... 3-123
show running-config ................................................................................................. 3-125
show sitebus ............................................................................................................ 3-127
show snmp ............................................................................................................... 3-131
show test alarm-entries ............................................................................................ 3-134
show test mode ........................................................................................................ 3-135
show timeout ............................................................................................................ 3-136
show timers .............................................................................................................. 3-137
show users ............................................................................................................... 3-138
show version ............................................................................................................ 3-139
Chapter4:DiagnosticCommands ......................................................... 4-1
The diag Command Overview ...................................................................................... 4-2
List of diag Commands ................................................................................................ 4-2
diag break .................................................................................................................... 4-3
diag clear ...................................................................................................................... 4-4
diag controller bridge switch dhcp ................................................................................ 4-6
diag controller openvpn ................................................................................................ 4-7
diag controller serial modem ........................................................................................ 4-9
diag ip address show ................................................................................................. 4-10
diag ip link show ......................................................................................................... 4-15
diag ip neighbor show ................................................................................................ 4-19
diag ip route get ......................................................................................................... 4-21
diag ip route show ...................................................................................................... 4-24
diag line-monitor ......................................................................................................... 4-30
diag line-status ........................................................................................................... 4-32
diag mediation snmpne poll ....................................................................................... 4-33
diag mmdisplay .......................................................................................................... 4-34
diag output ................................................................................................................. 4-36
diag peripheral reload ................................................................................................ 4-37
diag ps ........................................................................................................................ 4-39
diag snapshot ............................................................................................................. 4-42
diag tcpdump .............................................................................................................. 4-43
diag test alarm-entry .................................................................................................. 4-48
diag test mode ............................................................................................................ 4-49
TOC-5
Table of Contents
diag top ...................................................................................................................... 4-50
diag who ..................................................................................................................... 4-53
diag whoami ............................................................................................................... 4-54
Chapter5:UtilityCommands ................................................................. 5-1
Utility Commands Overview ......................................................................................... 5-2
List of Utility Commands .............................................................................................. 5-3
copy .............................................................................................................................. 5-4
debug ethernet ............................................................................................................. 5-6
debug level ................................................................................................................... 5-8
debug mediation ........................................................................................................... 5-9
debug openvpn .......................................................................................................... 5-12
debug ppp .................................................................................................................. 5-14
debug serial ................................................................................................................ 5-16
debug snmp ............................................................................................................... 5-18
erase .......................................................................................................................... 5-19
exec-job run ............................................................................................................... 5-20
exec-job stop .............................................................................................................. 5-24
exec-kill connection .................................................................................................... 5-26
exit .............................................................................................................................. 5-27
help ............................................................................................................................ 5-28
logout ......................................................................................................................... 5-29
password .................................................................................................................... 5-30
ping ............................................................................................................................ 5-31
reload ......................................................................................................................... 5-33
running-config ............................................................................................................ 5-34
telnet .......................................................................................................................... 5-36
trace-route .................................................................................................................. 5-37
AppendixA:CommandIdentifications .................................................. A-1
AppendixB:IPTablesManPage .......................................................... B-1
Iptables Overview .........................................................................................................B-2
Name ................................................................................................................B-2
Synopsis ...........................................................................................................B-2
Description .......................................................................................................B-2
Targets .............................................................................................................B-2
Tables ..........................................................................................................................B-3
Options .........................................................................................................................B-4
Parameters .......................................................................................................B-6
Other Options ...................................................................................................B-8
TOC-6
Table of Contents
Match Extensions .............................................................................................B-9
Target Extensions ..........................................................................................B-15
Authors .......................................................................................................................B-21
1-1
1
CLIOverview
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
CLI Overview: Accessing the Command Line Interface
1-2
AccessingtheCommandLineInterface
After 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.
ViewingGlobalCommands
To 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 ?
( Kent r ox) >
Gl obal Commands
conf i g( +) Conf i gur es par amet er s.
copy Cr eat es a copy of a conf i gur at i on or
pat ch conf i gur at i on f i l e.
debug( +) Enabl es or di sabl es sessi on l og out put .
di ag( +) Di spl ays syst emdi agnost i cs.
er ase Er ases ( r emoves) a conf i gur at i on or pat ch
conf i gur at i on f i l e.
exec- j ob( +) Cont r ol s t he execut i on of j obs.
exec- ki l l ( +) Ter mi nat es a speci f i ed medi at i on
connect i on.
exi t Exi t s up one l evel i n t he command
hi er ar chy.
hel p Descr i bes how t o access hel p.
l ogout Logs out and t er mi nat es t he sessi on.
passwor d Changes t he passwor d f or t he cur r ent
user .
pi ng Test s net wor k connect i vi t y t o a r emot e
host .
r el oad Reset s t he syst em.
r unni ngconf i g Di spl ays t he cur r ent oper at i ng
conf i gur at i on.
show( +) Di spl ays par amet er s.
t el net Est abl i shes a Tel net sessi on.
t r ace- r out e Tr aces net wor k r out i ng t o a r emot e host .
( Kent r ox) >
CLI Overview: Command Types
1-3
CommandTypes
There are four primary groups of Remote RMM-1400 commands:
Configuration Commands
Show Commands
Diagnostic Commands
Utility Commands
ConfigurationCommands
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.
ShowCommands
Show 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.
DiagnosticCommands
Diagnostic 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.
UtilityCommands
Utility 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.
CLI Overview: CLI Navigation and Command Entry
1-4
CLINavigationandCommandEntry
Specific keys can be used to navigate in the CLI, edit command line entries, or
execute command entry shortcuts.
NavigationKeys
Navigation 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.
1-5
TAB Key
The 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.
ParameterValueswithSpaces
Use 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.
( Kent r ox) conf i g cont r ol l er et her net 2>
assi gn descr i pt i on har dwar e- addr ess speed
br i dge di sabl e no unassi gn
def aul t enabl e pr oxy- ar p
Gl obal Commands
conf i g exec- j ob passwor d t el net
copy exec- ki l l pi ng t r ace- r out e
debug exi t r el oad
di ag hel p r unni ngconf i g
er ase l ogout show
1-6
AbbreviatedCommandEntry
The 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.
( Kent r ox) >sh us
St r ong Passwor d Suppor t : enabl ed
Logi n Name Pr of i l e
1. bob r est r i ct ed
2. ebh r est r i ct ed
3. j ef f st at us
4. j ohndoe st at us
5. t echcomm management
6. t est super vi sor
( Kent r ox) >
( Kent r ox) >con cont et h 2
CLI Overview: Command Help
1-7
CommandHelp
Command help is available for navigating the CLI command hierarchy and for
assistance with specific commands. Enter help or ? for command help.
UsingtheHelpCommand
Enter help to see the basic Remote RMM-1400 help information. The following
example displays the help screen.
Usingthe?
The ? displays information for individual commands and command inputs.
Displaying Command Usage Statements
Use the ? directly following a command name to display that commands usage
statement.
For example, enter config interface? at the main prompt to display the following
usage statement.
( Kent r ox) >hel p
You can r equest hel p f or a command at any t i me by ent er i ng
a quest i on mar k ( ' ?' ) . The ' ?' di spl ays t he f ol l owi ng t ypes
of i nf or mat i on f or commands and/ or command i nput s:
- Usage st at ement s
- Avai l abl e subcommands
- Mat chi ng commands f or par t i al i nput s
- Avai l abl e l ocal and gl obal commands
The t ype of i nf or mat i on di spl ayed depends on wher e you ent er t he ' ?' .
For mor e i nf or mat i on on usi ng hel p, r ef er t o t he command r ef er ence
gui de.
( Kent r ox) >
1-8
DisplayingAvailableSubcommands
Use 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 i p.
( Kent r ox) >conf i g i nt er f ace
Usage: i nt er f ace <t ype> <i nst ance>
no i nt er f ace <t ype> { <i nst ance> | * }
no i nt er f ace *
<t ype> The t ype of i nt er f ace. Val i d t ypes ar e br i dge,
et her net , openvpn, and ser i al .
<i nst ance> Conf i gur es an i nst ance of a speci f i c i nt er f ace.
Val i d val ues ar e based on t he t ype of i nt er f ace.
Val i d br i dge val ues: swi t ch
swi t ch Br i dge gr oup i nt er f ace consi st i ng of a set of
swi t ch Et her net cont r ol l er s or WAN por t s
Val i d et her net val ues: <por t number >
<por t number > Por t number i dent i f yi ng t he l ocat i on
of t he i nt er f ace. Por t number
l abel s ar e on t he f r ont panel .
Val i d openvpn val ues: <name>
<name> OpenVPN i nt er f ace name.
Range: Up t o 10 al phanumer i c char act er s.
Val i d ser i al val ues: <por t number > or
<uni t number >/ <por t number >
<por t number > Por t number i dent i f yi ng t he l ocat i on
of t he i nt er f ace. Por t number
l abel s ar e on t he f r ont panel .
<uni t number > The per i pher al uni t number .
Val i d val ues: 1 t o 12
no Del et es one or mor e i nt er f aces. Val i d t ypes ar e
br i dge, et her net , openvpn, and ser i al .
* Speci f i es al l i nt er f aces or al l i nt er f aces of a
speci f i ed t ype.
( Kent r ox) >conf i g i nt er f ace
( Kent r ox) >show i p
Commands
ar p Di spl ays t he ARP cache.
domai n- name Di spl ays t he domai n name.
f or war d Di spl ays t he st at e of I P f or war di ng.
name- ser ver Di spl ays DNS ser ver s.
r out e Di spl ays r out es.
( Kent r ox) >show i p
1-9
DisplayingMatchingCommandsforPartialInputs
Use 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 conf i g to display all commands
that begin with i and can be entered at the prompt.
DisplayingAvailableLocalandGlobalCommands
Enter 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.
( Kent r ox) >conf i g i
Commands
i nt er f ace( +) Conf i gur es an i nt er f ace.
i p( +) Conf i gur es I P set t i ngs.
i pt abl es Conf i gur es I P t abl es.
( Kent r ox) >conf i g i
( Kent r ox) conf i g i nt er f ace br i dge swi t ch i p
- >
Commands
addr ess Conf i gur es t he I P addr ess of t he devi ce.
no Del et es I P addr ess i nf or mat i on.
Ent er ? t o see avai l abl e gl obal commands.
( Kent r ox) conf i g i nt er f ace br i dge swi t ch i p
- >
CLI Overview: CLI Command Descriptions
1-10
CLICommandDescriptions
The remaining chapters in this document describe all of the CLI commands grouped
by Command Types. Each command will have the following information.
Description
This section includes a detailed description of the command.
Formats
This 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.
Parameters
This section lists and describes possible parameters for the command. Valid values
for each parameter are also provided, if applicable.
CommandDefaults
This section provides the default values of the command, if applicable.
RequiredUserProfiles
This section lists the user profiles needed to execute the command.
Examples
This section provides screen captures depicting actual command executions. An
explanation of each example is provided.
SeeAlso
This 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.
2-1
2
ConfigurationCommands
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.
The config Command Overview
List of Config Commands
Configuration Commands: The config Command Overview
2-2
TheconfigCommandOverview
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. See The 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.
Configuration Commands: List of Config Commands
2-3
ListofConfigCommands
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 ?
( Dub) >conf i g [ ? does not di spl ay i n CLI ]
Commands
act i on( +) Conf i gur es an act i on.
al ar m- ent r y( +) Conf i gur es an al ar ment r y.
appl y- pat ch Modi f i es a conf i gur at i on by appl yi ng
commands f r oma pat ch conf i gur at i on f i l e.
banner Conf i gur es t he banner .
cl ock( +) Conf i gur es cl ock t i me and dat e set t i ngs.
cont r ol l er ( +) Conf i gur es a cont r ol l er .
cor r el at i on( +) Conf i gur es an event cor r el at i on.
def aul t Reset s conf i gur at i on par amet er s t o t he
def aul t val ues.
dhcp- r el ay( +) Conf i gur es boot p/ DHCP r el ay.
dhcp- ser ver ( +) Conf i gur es DHCP Ser ver set t i ngs.
di scr et e( +) Conf i gur es di scr et e i nput and out put
poi nt s.
event ( +) Conf i gur es an event .
host name Conf i gur es a host name.
i nt er f ace( +) Conf i gur es an i nt er f ace.
i p( +) Conf i gur es I P set t i ngs.
i pt abl es Conf i gur es i pt abl es.
j obs( +) Conf i gur es j obs.
meas- t abl e( +) Conf i gur es t he measur ement t abl e.
medi at i on( +) Conf i gur es medi at i on set t i ngs.
no Negat es a conf i gur at i on command.
nt p( +) Conf i gur es NTP set t i ngs.
per i pher al ( +) Conf i gur es per i pher al set t i ngs.
pkgs( +) Conf i gur es packages.
pr of i l e( +) Conf i gur es a user def i ned pr of i l e
r emot e- access( +) Conf i gur es r emot e access set t i ngs.
r esponse( +) Conf i gur es a r esponse.
si t ebus( +) Conf i gur es si t ebus.
snmp( +) Conf i gur es SNMP.
t i meout Conf i gur es t he sessi on t i meout val ue.
use- wi zar d Runs a conf i gur at i on wi zar d.
user s( +) Conf i gur es user s.
( Dub) >conf i g
Configuration Commands: config action
2-4
configaction
Description
This 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.
Formats
config action action_name
description text
event event_name
response response_name
no description
For deleting actions:
config no action { action_name | * }
Parameters
Required User Profiles
management, 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:
textDefines 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_nameSpecifies 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_nameSpecifies an existing response.
no Deletes a specified parameter.
* Specifies all actions.
Configuration Commands: config action
2-5
Examples
The following settings are configured for action door OpenAl m:
Description Door open al ar mact i on
Event door Open
Response door OpenTl 1Al m.
See Also
running-config
show actions
( Dub) >conf i g
( Dub) conf i g>act i on door OpenAl m
( Dub) conf i g act i on door OpenAl m>descr i pt i on Door open al ar mact i on
( Dub) conf i g act i on door OpenAl m>event door Open r esponse door OpenTl 1Al m
( Dub) conf i g act i on door OpenAl m>
Configuration Commands: config alarm-entry
2-6
configalarm-entry
Description
This command configures an alarm entry and its associated settings.
Formats
For configuring an alarm:
config alarm-entry alarm
category category_name
description text
ne-name ne_name
no { cat egor y | descr i pt i on | ne- name }
raw { di sabl e | enabl e }
trap { di sabl e | enabl e | pr i or i t y priority_level }
For configuring an alarm filter:
config alarm-entry alarm_filter
raw { di sabl e | enabl e }
trap { di sabl e | enabl e }
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.

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_nameDefines a category name. Maximum length
is 128 characters.
2-7
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:
di sabl eDisables the output of raw response information.
enabl eEnables the output of raw response information.
trap Configures SNMP trap support for an alarm entry or alarm entry
filter. Trap support is enabled by default. The following
parameters are accepted:
di sabl eDisables SNMP trap support.
enabl eEnables SNMP trap support.
pr i or i t ySpecifies the priority level for traps associated
with this alarm entry. In order to add new traps when the trap
queue is full, Remote drops the oldest, lowest-priority traps
from the queue. Valid values for priority_level are
hi ghest , hi gh, nor mal , l ow, and l owest .
description Configures an alarm entry description. There is no maximum
description length or default description. The following parameter
is accepted:
textDefines a description for the alarm entry.
ne-name Configures text that identifies the network element that the
Remote RMM-1400 alarm entry represents. The following
parameter is accepted:
ne_nameDefines the network element name.
no Deletes an alarm entry, a group of alarm entries, or all alarm
entries.
* Specifies all alarm entries.
2-8
Examples
The following settings are configured for alarm entry ALM_4:
Description ALM NE 4
Category Envi r onment al _Al ar ms
Network element name MDR4000t oDubl i n
Raw response information enabl ed
SNMP trap support enabl ed
SNMP trap priority level hi gh
( Dub) >conf i g
( Dub) conf i g>al ar m- ent r y ALM_4
( Dub) conf i g al ar m- ent r y ALM_4>descr i pt i on ALM NE 4
( Dub) conf i g al ar m- ent r y ALM_4>cat egor y Envi r onment al _Al ar ms
( Dub) conf i g al ar m- ent r y ALM_4>ne- name MDR4000t oDubl i n
( Dub) conf i g al ar m- ent r y ALM_4>r aw enabl e
( Dub) conf i g al ar m- ent r y ALM_4>t r ap enabl e
( Dub) conf i g al ar m- ent r y ALM_4>t r ap pr i or i t y hi gh
( Dub) conf i g al ar m- ent r y ALM_4>
2-9
configalarm-entryevent
Description
This command configures a trigger event that will activate an alarm entry with the
specified severity.
Formats
config alarm-entry alarm event event_originator event_type
event_severity { cr i t i cal | event | i nf or mat i onal | mi nor | maj or
| nor mal | war ni ng } alarm_message
For deleting a trigger event:
config alarm-entry alarm no event event_originator event_type
Parameters
alarm Defines the name of the alarm entry being configured. Valid
values are alphanumeric characters and underscores (_).
Note: This parameter must start with an alphabetic

character.
alarm_message Defines the text string associated with the alarm.
cr i t i cal Updates the state of the alarm entry to cr i t i cal .
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-74.
event_type Defines the type of generated event. For more information
on event types, refer to Table 3 on page 2-80.
i nf or mat i onal Updates the state of the alarm to i nf or mat i onal .
mi nor Updates the state of the alarm entry to mi nor .
maj or Updates the state of the alarm entry to maj or .
no Deletes a configured alarm text string.
nor mal Updates the state of the alarm entry to nor mal .
war ni ng Updates the state of the alarm entry to war ni ng.
2-10
Command Defaults
No alarm event configured
Examples
This example displays the configuration of an event for alarm entry ALM_2_2_5 with
the following settings:
Event originator i nput 1/ 16
Event type open
Severity level mi nor
Alarm message Power Low.
configalarm-entrynagging
Description
This 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.
Formats
config alarm-entry alarm nagging interval [ cr i t i cal |
i nf or mat i onal | maj or | mi nor | nor mal | war ni ng ]
For deleting the alarm nagging setting:
config alarm-entry alarm no nagging
Parameters
( Dub) >conf i g
( Dub) conf i g>al ar m- ent r y ALM_2_2_5
( Dub) conf i g al ar m- ent r y ALM_2_2_5>event i nput 1/ 16 open mi nor Power Low
( Dub) conf i g al ar m- ent r y ALM_2_2_5>
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.

cr i t i cal Activates alarm nagging for alarm entries with a critical severity
level.
2-11
Command Defaults
minor
Examples
This example displays the configuration of a 25 seconds interval when the ALM_2_2_5
alarm entry is in the maj or state.
See Also
config correlation
config event content
running-config
show alarm-entries
show correlations
show events
i nf or mat i onal Activates alarm nagging for alarm entries with an
i nf or mat i onal severity level or higher.
interval Defines the number of seconds between instances of the alarm
sending its state to all enabled protocols.
maj or Activates alarm nagging for alarm entries with a maj or severity
level or higher.
mi nor Activates alarm nagging for alarm entries with a mi nor severity
level or higher.
no Disables alarm nagging.
nor mal Activates alarm nagging for alarm entries with a nor mal severity
level or higher.
war ni ng Activates alarm nagging for alarm entries with a war ni ng
severity level or higher.
( Dub) >conf i g
( Dub) conf i g>al ar m- ent r y ALM_2_2_5
( Dub) conf i g al ar m- ent r y ALM_2_2_5>naggi ng 25 maj or
( Dub) conf i g al ar m- ent r y ALM_2_2_5>
Configuration Commands: config apply-patch
2-12
configapply-patch
Description
This 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
(/ conf i g/ pat ches) 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.
Formats
config apply-patch patch_file config_file
Parameters
Examples
The following example displays the modification of configuration file r unni ng-
st ar t up with patch file Conf i gUpdat e5- 10.
patch_file Specifies an existing patch file.
Note: All patch files in the / conf i g/ pat ches directory have a
. pat extension. However, you should not include the
extension when entering the patch file name in the CLI. For
example, conf i g1. pat would be entered as conf i g1.
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.
( Dub) >conf i g
( Dub) conf i g>appl y- pat ch Conf i gUpdat e5- 10 r unni ng- st ar t up
( Dub) conf i g>
Configuration Commands: config apply-patch
2-13
See Also
copy
erase
running-config
show config-file
Configuration Commands: config banner
2-14
configbanner
Description
This command configures the banner for Remote RMM-1400. The banner appears
when connecting to Remote RMM-1400.
Formats
config banner delimiting_character
For resetting the banner:
config default banner
Parameters
This command accepts escape codes that are used to include variable text within the
banner. For more information on the escape codes, refer to Table 1.
delimiting_character Defines the beginning and ending of the banner. Most
characters, such as @, (, ), #, ~, %, and *, can be
applied as the delimiting character.
Important: Do not use the following characters for the
delimiting character:
d, s, l, m, n, o, r, t, u, U, V, , , and \
default Resets the banner to the default banner.
Table 1 Escape Codes
Codes Descriptions
\ d Includes the current date in the banner.
\ s Includes the name of the operating system in the banner.
\ l Includes the name of the logical terminal from which the user is operating.
\ m Includes the architecture of the system (for example, i686), in the banner.
\ n Includes the host name of the system (for example, localhost) in the
banner.
\ o Includes the domain name of the system in the banner.
\ r Includes the release number of the Linux kernel in the banner.
\ t Includes the current time in the banner.
Configuration Commands: config banner
2-15
Command Default
Kentrox banner
Examples
This example displays the configuration of the delimiting character as #, the banner
text as Thi s i s my banner . , the current date (\ d), and the time (\ t ).
See Also
show 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
l ogi n:
( Dub) >conf i g
( Dub) conf i g>banner #
Ent er t he banner t ext . End t he banner wi t h a # char act er .
Thi s i s my banner .
\ d
\ t
#
( Dub) conf i g>
Table 1 Escape Codes (Continued)
Codes Descriptions (Continued)
Configuration Commands: config clock
2-16
configclock
Description
This command configures clock and timestamp settings for Remote RMM-1400.
Formats
config clock
default timestamp
local-time { hh: mm: ss | MM/DD/YYYY | hh: mm: ss MM/DD/YYYY }
timestamp { GMT | l ocal - t i me }
timezone { [ cust om] timezone_string hh_offset: mm_offset |
f r om- f i l e indicator }
Parameters
default Resets the timestamp to its default value (l ocal - t i me).
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 ntp on page 2-
138.
The following parameters are accepted:
hhDefines the hour value of the local time. This parameter
accepts values 0 to 23.
mmDefines the minute value of the local time. This parameter
ssDefines the second value of the local time. This parameter
MMDefines the month value of the date. This parameter
DDDefines the day value of the date. This parameter accepts
values from 1 to the total number of days in the month specified
in MM.
YYYYDefines the year value of the date. Valid values are 1970
to 2037.
2-17
timestamp Configures the logging timestamp option. The following parameters
are accepted:
GMTDisplays logging timestamps in Greenwich Mean Time.
l ocal - t i meDisplays 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:
cust omPuts 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-18.
timezone_stringDefines text to represent the desired
timezone, which accepts alphabetic strings of 1 to 10 characters
in length.
hh_offsetDefines 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_offsetDefines 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.
f r om- f i l eLoads and applies timezone information from file
t i mezones. 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 f r om- f i l e 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.
indicatorSpecifies a timezone indicator (1 to 10
alphanumeric characters) in file t i mezones. def .
2-18
Examples
The following clock settings are configured:
Local time 16: 45: 30 and date 12/ 14/ 2008
Timestamp option gmt
Timezone cust omEST - 5: 00.
configclockdaylightsavings
Description
This command configures daylight savings time settings.
Notes: When the timezone on Remote RMM-1400 is set to cust om, 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
t i mezones. 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 month
end-time hh: mm:ss
indicator indicator
save-amount hh:mm:ss
start-day { day | occurrence day_of_week }
start-month month
start-time hh:mm:ss
config clock no daylight-savings
( Dub) >conf i g
( Dub) conf i g>cl ock
( Dub) conf i g cl ock>l ocal - t i me 16: 45: 30 12/ 14/ 2009
( Dub) conf i g cl ock>t i mest amp gmt
( Dub) conf i g cl ock>t i mezone cust omEST - 5: 00
( Dub) conf i g cl ock>
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
dayDefines the day of the month when daylight savings time
ends. Valid values are 1 to 31.
occurrenceDefines the occurrence of a day in a month when
daylight savings time ends. Valid values are f i r st , second,
t hi r d, f our t h, and l ast .
day_of_weekDefines the day of the week when daylight
savings time ends. Valid values are Sunday, Monday, Tuesday,
Wednesday, Thur sday, Fr i day, and Sat ur day.
end-month Configures the month when daylight savings time ends. The
following parameter is accepted:
monthDefines the month that daylight savings time ends.
end-time Configures the time when daylight savings time ends:
hhDefines the hour when daylight savings time ends. This
parameter accepts values 0 to 23.
mmDefines the minute when daylight savings time ends. This
ssDefines the second when daylight savings time ends. This
indicator Configures the name (up to 10 alphanumeric characters) to be
displayed when daylight savings time is in effect. The following
indicatorDefines 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.
hhDefines the number of hours to save. This parameter
mmDefines the number of minutes to save. This parameter
ssDefines the number of seconds to save. This parameter
2-20
Examples
In the following standard example, the daylight savings indicator is set to DST:
start-day Configures the day when daylight savings time starts. The following
dayDefines the day of the month when daylight savings time
starts. Valid values are 1 to 31.
occurrenceDefines the occurrence of a day in a month when
daylight savings time starts. Valid values are f i r st , second,
t hi r d, f our t h, and l ast .
day_of_weekDefines the day of the week when daylight
savings time starts. Valid values are Sunday, Monday, Tuesday,
Wednesday, Thur sday, Fr i day, and Sat ur day.
start-
month
Configures the month when daylight savings time starts. The
monthDefines the month that daylight savings time starts.
start-time Configures the time when daylight savings time starts:
hhDefines the hour when daylight savings time starts. This
mmDefines the minute when daylight savings time starts. This
ssDefines the second when daylight savings time starts. This
no Disables daylight savings and the display of the daylight savings
time indicator.
( Dub) >conf i g
( Dub) conf i g cl ock>dayl i ght - savi ngs DST
( Dub) conf i g cl ock>
2-21
In the following custom example, daylight savings time settings are configured:
Indicator EDT
Start month mar ch
Start day 14
Start time 1: 00: 00 (AM)
End month november
End day l ast Sunday
End time 02: 00: 00 (AM)
Time to save 01: 45: 00.
See Also
show clock
( Dub) >conf i g
( Dub) conf i g cl ock>dayl i ght - savi ngs
( Dub) conf i g cl ock dayl i ght - savi ngs
- >i ndi cat or EDT
- >st ar t - mont h mar ch
- >st ar t - day 14
- >st ar t - t i me 01: 00: 00
- >end- mont h november
- >end- t i me 02: 00: 00
- >save- amount 01: 45: 00
- >
Configuration Commands: config controller bridge switch
2-22
configcontrollerbridgeswitch
Description
This command configures bridge group swi t ch or restores the settings associated
with bridge group swi t ch 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 swi t ch 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.
Formats
config controller bridge switch
description text
no description
For resetting the bridge group:
config default controller bridge switch
Parameters
Command Defaults
Bridge group swi t ch is configured by default
description Configures a description for bridge group swi t ch. The following
textDefines the description for bridge group swi t ch.
Maximum length is 60 characters.
no Deletes the description for bridge group swi t ch.
default Restores the settings associated with bridge group swi t ch to their
default values.
Configuration Commands: config controller bridge switch
2-23
Examples
This example displays the configuration of bridge group swi t ch with description
Swi t ch cont r ol l er .
See Also
show controllers
( Dub) >conf i g
( Dub) conf i g>cont r ol l er br i dge swi t ch
( Dub) conf i g cont r ol l er br i dge swi t ch>descr i pt i on Swi t ch cont r ol l er
( Dub) conf i g cont r ol l er br i dge swi t ch>
Configuration Commands: config controller ethernet
2-24
configcontrollerethernet
Description
This 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.
Formats
config controller ethernet port
assign
default { hardware-address | speed }
description text
disable
enable
hardware-address mac_address
proxy-arp { enabl e | di sabl e }
speed { aut o | 10h | 10f | 10hx | 10f x | 100h | 100f | 100hx |
100f x }
unassign
For resetting Ethernet controllers:
config default controller { ethernet port | ethernet * | * }
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:
textDefines 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 ports ability to pass data.
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_addressDefines 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
di sabl eDisables proxy ARP on an Ethernet controller.
Proxy ARP is disabled by default.
enabl eEnables proxy ARP on an Ethernet controller.
2-26
Examples
The following Ethernet controller settings are configured for controller et her net 2:
Enabled controller et her net 2
00: E0: 52: CC: 0B: 00 for the MAC address
10h for the speed
Enabled proxy ARP
Resource tracking assigned
Et her net 2 for the description.
speed This command configures the following settings for an
Ethernet controller:
Speed (in megabits per second)
Duplex operationRefers 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 capabilitiesRefers 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 aut o, which automatically
negotiates for the fastest controller speed possible between
the controller and the remote device.
unassign Specifies that the Ethernet controller should no longer be
tracked as a resource.
( Dub) >conf i g
( Dub) conf i g>cont r ol l er et her net 2
( Dub) conf i g cont r ol l er et her net 2>enabl e
( Dub) conf i g cont r ol l er et her net 2>har dwar e- addr ess 00: E0: 52: CC: 0B: 00
( Dub) conf i g cont r ol l er et her net 2>speed 10h
( Dub) conf i g cont r ol l er et her net 2>descr i pt i on Et her net 2
( Dub) conf i g cont r ol l er et her net 2>
2-27
See Also
show controllers ethernet
Configuration Commands: config controller ethernet bridge switch
2-28
configcontrollerethernetbridgeswitch
Description
This command associates an Ethernet controller with bridge group swi t ch.
Format
config controller ethernet port bridge switch
For removing the Ethernet controller from the bridge group:
config controller ethernet port no bridge group
Parameters
See Also
config controller ethernet
show controllers ethernet
no Removes the Ethernet controller from bridge group swi t ch.
port Defines the physical connector associated with the controller on
Remote RMM-1400. Valid Ethernet port values are 1 to 4.
Configuration Commands: config controller openvpn
2-29
configcontrolleropenvpn
Description
This command configures an OpenVPN controller and its associated settings. An
OpenVPN controller describes the system software that manages an OpenVPN client
or server.
Formats
config controller openvpn name
cipher { bl owf i sh- 128 | aes- 128 | aes- 256 }
default { cipher | hardware-address | keep-alive | port }
description text
disable
enable
mode { cl i ent | ser ver }
no { description | server }
server ip_address [ server_port ]
For resetting the OpenVPN controller:
config default controller openvpn name
For deleting OpenVPN controllers:
config no controller openvpn { name | * }
Parameters
* Specifies all OpenVPN controllers.
cipher Configures the algorithm used to encrypt the data on the
VPN. The following parameters are accepted:
aes- 128Specifies the 128-bit AES algorithm.
aes- 256Specifies the 256-bit AES algorithm.
bl owf i sh- 128Specifies the 128-bit Blowfish algorithm.
This is the default cipher option.
default Resets a parameter to its default setting.
description Configures a description for the OpenVPN controller. The
textDefines a description for the controller. The
maximum length for a controller description is 60
characters.
disable Disables the OpenVPN controller.
2-30
Examples
The following settings are configured for OpenVPN controller cmhcl i ent 1:
Enabled OpenVPN controller
Description VPN cl i ent cont r ol l er 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
enable Enables the OpenVPN controller.
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_addressDefines 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).
mode Configures the OpenVPN controller in client or server mode.
cl i ent Specifies client mode. This is the default value.
ser ver Specifies server mode. Typically, Remote RMM-
1400 will not be configured to run in server mode.
server Configures the address of the peer OpenVPN server. The
following parameters are accepted:
ip_addressConfigures the IP address used to
communicate with the server.
server_portConfigures the port used to communicate
with the server. Valid values are 1024 to 65535. The
default value is OpenVPN standard port 1194.
( Dub) >conf i g
( Dub) conf i g>cont r ol l er openvpn cmhcl i ent 1
( Dub) conf i g cont r ol l er openvpn cmhcl i ent 1>enabl e
( Dub) conf i g cont r ol l er openvpn cmhcl i ent 1>descr i pt i on VPN cl i ent cont r ol l er
CMH1
( Dub) conf i g cont r ol l er openvpn cmhcl i ent 1>har dwar e- addr ess 00: FF: 17: 8A: D4: 1B
( Dub) conf i g cont r ol l er openvpn cmhcl i ent 1>ser ver 172. 16. 220. 1 2294
( Dub) conf i g cont r ol l er openvpn cmhcl i ent 1>ci pher aes- 256
( Dub) conf i g cont r ol l er openvpn cmhcl i ent 1>
2-31
See Also
config interface openvpn
show controllers openvpn
Configuration Commands: config controller serial
2-32
configcontrollerserial
Description
These commands configure a serial controller. A serial controller describes the
hardware and software that communicate on a serial link.
Format
config controller serial { port | modem }
application { dest i nat i on | sour ce | dest i nat i on sour ce }
assign
baud { 300 | 600 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 |
57600 | 115200 }
databits { 6 | 7 | 8 }
default dial-timer
description text
dial-timer interval
disable
enable
flow { none | xonxof f | har dwar e }
linemode { r s232 | r s422 | r s485h }
no description
no prl-update
parity { none | even | odd }
prl-update network interval [ hour:minute ]
stopbits { 1 | 2 }
unassign
For resetting serial controllers:
config default controller serial { * | port | modem }
Parameters
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.
dest i nat i onSets the serial controller as the destination for
internal connections.
sour ceSets the serial controller as the initiator of internal
connections when the port associated with the controller
responds to a system event.
By default, dest i nat i on and sour ce are both enabled. At least
dest i nat i on or sour ce must be configured at all times.
2-33
assign Specifies that the serial controller should be tracked as a resource.
This lets the user determine serial port availability.
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.
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.
description Configures a description for the serial controller. The following
textDefines a description for the controller. The maximum
length for a controller description is 60 characters.
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.
intervalDefines 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.
2-34
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
noneSpecifies no flow control.
xonxof f 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.
har dwar eSpecifies 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:
r s- 232
r s- 422
r s- 485h (half duplex)
Note: Serial ports 1 and 2 operate only in r s- 232 linemode. Serial

ports 3 and 4 operate in r s- 422 or r s- 485h linemode.
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:
evenSets 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.
oddSets 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.
noneSets 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.
2-35
Examples
The following settings are configured for controller ser i al 2:
Description Sampl e cont r ol l er descr i pt i on
Application type dest i nat i on
Baud rate 57600
7 databits per byte
Dial timer of 15 seconds
xonxof f flow control
even bit parity
Stop bit 2.
prl-update Configures updates to the Preferred Roaming List (PRL) for
CDMA/EvDO modems. The following parameters are accepted:
net wor kIdentifies the network to which Remote RMM-1400
is connected. Valid values are alphanumeric characters.
i nt er val Specifies the number of days between updates.
Valid values are 7 to 90.
hour : mi nut eSpecifies 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.
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:
1Sets the stop bit to one.
2Sets the stop bit to two.
By default, the stop bit is set to 1.
unassign Specifies that the serial controller should no longer be tracked as a
resource.
2-36
configcontrollerserialconnect
Description
This command configures the connection settings for an asynchronous serial
controller or modem.
Format
config controller serial { port | modem } connect
dtr { on | of f }
mode { dcd | act i vi t y | dcd act i vi t y }
no { mode | string }
rts { on | of f | f ol l owdsr }
string { connect_string | @chat_file }
Parameters
( Dub) >conf i g
( Dub) conf i g>cont r ol l er ser i al 2
( Dub) conf i g cont r ol l er ser i al 2>descr i pt i on Sampl e cont r ol l er descr i pt i on
( Dub) conf i g cont r ol l er ser i al 2>appl i cat i on dest i nat i on
( Dub) conf i g cont r ol l er ser i al 2>baud 57600
( Dub) conf i g cont r ol l er ser i al 2>dat abi t s 7
( Dub) conf i g cont r ol l er ser i al 2>di al - t i mer 15
( Dub) conf i g cont r ol l er ser i al 2>f l ow xonxof f
( Dub) conf i g cont r ol l er ser i al 2>par i t y even
( Dub) conf i g cont r ol l er ser i al 2>st opbi t s 2
( Dub) conf i g cont r ol l er ser i al 2>
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:
onSets the DTR signal state to on when the serial controller
connects.
of f Sets the DTR signal state to off when the serial controller
connects.
By default, the DTR signal state is on.
2-37
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.
dcdSpecifies the DCD connect option. After the device connected
to the port asserts DCD, this option generates a controller up event
(unless the act i vi t y option is also enabled and is satisfied first).
act i vi t ySpecifies 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-32.
onSets the RTS signal state to on when the serial controller makes
a connection.
of f Sets the RTS signal state to off when the serial controller
makes a connection.
f ol l owdsr Sets the RTS signal state to follow the associated DSR
input signal.
The default RTS signal state is set to on.
2-38
Examples
The following serial controller connect settings are configured for controller ser i al 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_stringDefines 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_fileDefines 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) >conf i g
( Dub) conf i g cont r ol l er ser i al 3>connect
( Dub) conf i g cont r ol l er ser i al 3 connect
- >dt r on
- >mode dcd
- >r t s on
- >st r i ng ATDT1234567
- >
2-39
configcontrollerserialdisconnect
Description
This command configures the disconnect settings for an asynchronous serial
controller.
Format
config controller serial port disconnect
dtr { on | of f | pul se }
mode { dcd | br eak }
no mode
rts { on | of f | pul se }
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:
onSets the DTR signal state to on when the serial controller
disconnects.
of f Sets the DTR signal state to off when the serial controller
disconnects.
pul seCauses 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 of f .
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:
dcdSpecifies 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.
br eakSpecifies 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.
2-40
Examples
The following serial controller disconnect settings are configured for controller ser i al
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:
onSets the RTS signal state to on when the serial controller
disconnects.
of f Sets the RTS signal state to off when the serial controller
disconnects.
pul seCauses 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-32.
By default, the RTS signal state is set to of f .
( Dub) >conf i g
( Dub) conf i g cont r ol l er ser i al 3>di sconnect
( Dub) conf i g cont r ol l er ser i al 3 di sconnect
- >dt r on
- >mode dcd
- >r t s on
- >
2-41
configcontrollerserialencapsulation
Description
These 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.
Formats
For the wireless modem controller:
config controller serial modem encapsulation ppp
default { defaultroute | mru | mtu }
defaultroute
inactivity-timeout inactivity-time
lcp-requests [ di sabl e | enabl e ]
local identity identity secret
local method { chap | pap | none }
no { defaultroute | inactivity-timeout | mru | mtu }
mru units
mtu units
remote identity identity secret
remote 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 ports
subnet value.
Important: An interface must be configured that corresponds to
the specified controller for this command to operate
properly.
2-42
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
identityDefines 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.
secretDefines 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.
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.
Remote RMM-1400 will then restart the PPP connection. The
i dent i t yDefines the inactivity time in minutes. The valid
values are 0 - 30.
lcp-requests Configures Remote RMM-1400s ability to initiate or terminate a
PPP link based on the presence of LCP echo requests. The
di sabl eDisables LCP echo requests on the serial
controller.
enabl eEnables 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.
2-43
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:
chapSpecifies the CHAP authentication method. CHAP is
an access control protocol that uses encryption to avoid
revealing passwords.
papSpecifies the PAP authentication method. PAP
transmits unencrypted passwords. For this reason, it is less
secure than CHAP.
noneSpecifies 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
uni t sDefines 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
uni t sDefines 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.
2-44
Examples
The following PPP encapsulation settings are configured for controller ser i al modem:
Def aul t r out e functionality enabled
Identity user b and secret newpass
Local authentication method pap
5200 for the MRU
4500 for the MTU
Remote identity user 2 and secret r emuse
Remote authentication method chap.
See Also
show controllers
( Dub) >conf i g
( Dub) conf i g>cont r ol l er ser i al modem
( Dub) conf i g cont r ol l er ser i al modem>encapsul at i on ppp
( Dub) conf i g cont r ol l er ser i al modemencapsul at i on ppp
- >def aul t r out e
- >l ocal
( Dub) conf i g cont r ol l er ser i al modemencapsul at i on ppp l ocal
- >i dent i t y user b newpass
- >met hod pap
- >exi t
- >mr u 5200
- >mt u 4500
- >r emot e
( Dub) conf i g cont r ol l er ser i al modemencapsul at i on ppp r emot e
- >i dent i t y user 2 r emuse
- >met hod chap
- >
Configuration Commands: config correlation
2-45
configcorrelation
Description
This command manages mediation event correlations. A correlation is a type of event
originator that reports a correlated condition to a network management system.
Formats
config correlation name
default duration
description text
duration def aul t true_duration false_duration
expression term operator term
no { cor r el at i on_name | * }
For deleting a correlation:
config no correlation { name | * }
Parameters
* Deletes all configured events.
name Defines the name of the event correlation being configured.
default Resets the t r ue and f al se duration parameters to their default
values (0 and 0).
description Configures a description for a correlation. The following parameter
is accepted:
textDefines 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
expressions state. The following parameters are accepted:
true_durationDefines the number of seconds the
expression must remain true. Valid value range is 0-86400.
false_durationDefines the number of seconds the
expression must remain false. Valid value range is 0-86400.
def aul t Resets the true and false duration parameters to
their default values (0 0).
2-46
Command Defaults
No correlations configured
Examples
This example configures a correlation named Bot hCl osed with the following
parameters:
Description Cor r el at i on f or t wo di scr et e i nput s
Duration of 900 seconds (15 minutes) true and 0 seconds (immediate) false.
Expression i nput 0/ 1 cl ose and i nput 0/ 2 cl ose
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:
termA term collectively consists of the following parameters:
originator_typeOne of the Remote originator types
(anal og, i nput , out put , cor r el at i on, measur ement )
instanceA valid instance of the specified originator, for
example, 0/ 1, 2, or the name of a measurement.
stateA valid state for the originator, for example cl ose,
open, t r ue, f al se, as well as i n- band, hi gh, l ow, i nput -
sat ur at ed, and l oss- of - si gnal .
When a relational operator is used, a numeric value can
serve as a term; for example, bat t Vol t age < 10. 2.
operatorSpecifies a link between two terms, for example
and, al l , 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 (!=).
See the Remote RMM-1400 Configuration Guide for more
information about configuring event correlations.
no Initiates the deletion of a correlation or all correlations.
( Dub) >conf i g
( Dub) conf i g>cor r el at i on Bot hCl osed
( Dub) conf i g cor r el at i on Bot hCl osed>descr i pt i on Cor r el at i on f or t wo di scr et e
i nput s
( Dub) conf i g cor r el at i on Bot hCl osed>dur at i on 900 0
( Dub) conf i g cor r el at i on Bot hCl osed>expr essi on i nput 0/ 1 cl ose and i nput 0/ 2
cl ose
2-47
This example configures a correlation named LowVol t age with the following
parameters:
Description Cor r el at i on f or l ow bat t er y vol t age
Duration of 300 seconds (5 minutes) true and 0 seconds (immediate) false.
Expression measur ement bat t Vol t age < 10. 2
See Also
config action
config alarm-entry
config response
show correlations
( Dub) >conf i g
( Dub) conf i g>cor r el at i on LowVol t age
( Dub) conf i g cor r el at i on LowVol t age>descr i pt i on Cor r el at i on f or l ow bat t er
y vol t age
( Dub) conf i g cor r el at i on LowVol t age>dur at i on 300 0
( Dubl i n- TC) conf i g cor r el at i on LowVol t age>expr essi on measur ement bat t Vol t age <
10. 2
Configuration Commands: config dhcp-relay
2-48
configdhcp-relay
Description
This 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.
Formats
config 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.
Configuration Commands: config dhcp-relay
2-49
Examples
This example displays the enabling of BOOTP/DHCP relay and the configuration of a
BOOTP/DHCP server with IP address 12. 67. 34. 5.
See Also
show dhcp-relay
( Dub) >conf i g
( Dub) conf i g>dhcp- r el ay
( Dub) conf i g dhcp- r el ay>enabl e
( Dub) conf i g dhcp- r el ay>ser ver 12. 67. 34. 5
( Dub) conf i g dhcp- r el ay>
Configuration Commands: config dhcp-server
2-50
configdhcp-server
Description
This command configures the DHCP server and its associated settings.
Formats
config dhcp-server
authority
broadcast
config-file filename
disable
enable
no { 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.
2-51
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:
filenameDefines 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.
2-52
Examples
The following settings are configured for the DHCP server:
DHCP server enabled
DHCPNAK messages enabled
Broadcast packets enabled
DHCP server configuration file name dhcpconf i g1. conf .
configdhcp-serverhost
Description
This command configures hosts that will accept fixed (static) IP addresses from the
DHCP server.
Formats
config dhcp-server host hostname
ip address ip_address
no { hardware-address | ip address }
For deleting a host:
config dhcp-server no host hostname
Parameters
( Dub) >conf i g
( Dub) conf i g>dhcp- ser ver
( Dub) conf i g dhcp- ser ver >enabl e
( Dub) conf i g dhcp- ser ver >aut hor i t y
( Dub) conf i g dhcp- ser ver >br oadcast
( Dub) conf i g dhcp- ser ver >conf i g- f i l e dhcpconf i g1. conf
( Dub) conf i g dhcp- ser ver >
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.
2-53
Examples
The following settings are configured for DHCP server host pr i v- l an:
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.
mac_addressDefines 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-55.
ip_addressDefines the IP address for the host.
( Dub) >conf i g
( Dub) conf i g dhcp- ser ver >host pr i v- l an
( Dub) conf i g dhcp- ser ver host pr i v- l an
- >har dwar e- addr ess 00: 40: 72: 00: 99: 2a
- >i p addr ess 10. 39. 59. 33
- >
2-54
configdhcp-serverinterface
Description
This command configures DHCP server operation on an interface.
Formats
config dhcp-server interface
bridge swi t ch
ethernet ethernet_port
openvpn name
serial modem
For deleting DHCP server operation from interfaces:
config dhcp-server no interface
bridge swi t ch
ethernet ethernet_port
openvpn name
serial modem
Parameters
bridge Specifies the bridge interface for DHCP server operation. The following
swi t chSpecifies 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.
ethernet_portDefines 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
nameDefines the name of the OpenVPN interface.
serial Specifies a serial interface for DHCP server operation.
2-55
Examples
The following settings are configured for the DHCP server:
DHCP server operation on interface et her net 3
DHCP server operation on interface openvpn cmhcl i ent 1
DHCP server operation on interface br i dge swi t ch.
configdhcp-serversubnet
Description
This 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, you should disable HTTP before configuring the DHCP server.
For information on disabling HTTP, refer to command config remote-access on
page 2-156.
Formats
config dhcp-server subnet { ip_address subnet_mask |
ip_address/subnet_mask_length }
default { default-lease | max-lease }
default-lease seconds
domain-name-server ip_address
max-lease seconds
no { domain-name-server ip_address | range | router }
range minimum_ip_address maximum_ip_address
router router_ip_address ]
For deleting subnets:
config dhcp-server no subnet ip_address
( Dub) >conf i g
( Dub) conf i g dhcp- ser ver >i nt er f ace et her net 3
( Dub) conf i g dhcp- ser ver >i nt er f ace openvpn cmhcl i ent 1
( Dub) conf i g dhcp- ser ver >i nt er f ace br i dge swi t ch
( Dub) conf i g dhcp- ser ver >
2-56
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:
secondsDefines 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_addressDefines 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
secondsDefines the maximum lease time for the
subnetwork. Valid values are 1 to 31,536,000.
2-57
Command Defaults
No subnetworks configured
Examples
The 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_addressDefines the lowest IP address
that the DHCP server can assign to a device.
maximum_ip_addressDefines 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_addressDefines the IP address of the router.
2-58
See Also
config dhcp-server
config dhcp-server host
show dhcp-server
( Dub) >conf i g
( Dub) conf i g dhcp- ser ver >subnet 10. 39. 59. 0/ 24
( Dub) conf i g dhcp- ser ver subnet 10. 39. 59. 0/ 24
- >def aul t - l ease 1800
- >domai n- name- ser ver 10. 39. 59. 1
- >max- l ease 36000
- >r ange 10. 39. 59. 0 10. 39. 59. 31
- >r out er 10. 39. 59. 1
- >
Configuration Commands: config discrete analog
2-59
configdiscreteanalog
Description
This command configures the settings for a discrete analog input.
Formats
config discrete analog { unit/point | unit/point_range |
unit/power | unit/powerB | unit/powerMon | unit/temperature |
unit/humidity | unit/* | * }
assign
averaging [ hi gh | medi um| l ow | none ]
band low_band high_band
celsius
description [ text ]
disable
enable
fahrenheit
hysteresis sensor_value
interval duration
maximum current_loop sensor_reading
minimum current_loop sensor_reading
unassign
units 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.
2-60
averaging Specifies the level by which Remote will average, or smooth,
measurement values in order to compensate for rapid fluctuations.
Valid values include the following:
medi um- The typical value used when the unscaled value
fluctuates by +/- .01 V or mA.
hi gh - Provides the most averaging, but provides slower
response to value fluctuation.
l ow - Provides faster response to value fluctuation while still
providing a minimal level of averaging.
none - No averaging is used.
Note: Averaging is not available for the unit/temperature or

unit/humidity input.
band Configures the high and low values for analog input event
generation. Whenever the sensor input falls below the low level, a
low event is generated. Whenever the sensor input goes above the
high level, a high event is generated. When the input falls below
the high level or rises above the low level, an in-band event is
generated. The following parameters are accepted:
low_bandDefines the low input value in sensor units. Valid
values are numeric characters. The default value is 0.
high_bandDefines the high input value in sensor units. Valid
values are numeric characters. The default value is 0.
Note: To disable the generation of level events (all analog events

besides interval), set low_band to a higher value than
high_band.
celsius Sets the unit/temperature input to report values in degrees
Celsius.
description Configures an analog input description. The following parameter is
accepted:
textDefines 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.
2-61
hysteresis Configures hysteresis, which works as a guard between the high
and low band thresholds. For example, if a high band value is set
to 10 and the hysteresis is set to 1, a high event will be generated
when the input goes above 10 and an in-band event will be
generated when the input goes below 9. The following parameter
is accepted:
sensor_valueDefines the size of the hysteresis in sensor
units. Valid values are numeric characters. The default
hysteresis value is 0.
interval Configures the interval rate at which events are generated for an
analog input. The following parameter is accepted:
durationDefines 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-161 also

configures the interval rate at which events are generated
for an analog input. The most recently executed of these
two commands takes precedence.
2-62
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_loopDefines the maximum valid sensor output
current (in milliamps). This is the current that will be sensed by
the product. The default maximum current is 20 milliamps.
Notes: The maximum and sensor output current can be

configured as any value. However, Remote 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_readingDefines 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.
2-63
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
current_loopDefines the minimum valid sensor output
current (in milliamps). This is the current that will be sensed by
the product. The default minimum current is 4 milliamps.
Notes: The minimum sensor output current can be configured

as any value. However, Remote 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_readingDefines 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 units primary incoming power
supply voltage.
powerB Specifies the secondary power monitor, which is an analog input
that is dedicated to monitoring the unit's secondary incoming
power supply voltage.
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.
2-64
Examples
The following settings are configured for analog input 1/ 4:
Description Amp_met er
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 medi um
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_nameSpecifies 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.

2-65
See Also
config discrete input
config discrete output
show discrete
( Dub) >conf i g
( Dub) conf i g>di scr et e
( Dub) conf i g di scr et e>anal og 1/ 4
( Dub) conf i g di scr et e anal og 1/ 4
- >descr i pt i on Amp_met er
- >band 20 30. 5
- >hyst er esi s 2
- >i nt er val 10
- >maxi mum20 72
- >mi ni mum7 8
- >aver agi ng medi um
- >enabl e
- >assi gn
Configuration Commands: config discrete input
2-66
configdiscreteinput
Description
This command configures settings for digital inputs.
Formats
config discrete input { unit/point | unit/point_range | unit/* | *
}
alarm-default
assign
disable
enable
unassign
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 commands 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
textDefines a description for a digital input. The maximum
length is 256 characters.
2-67
disable This command disables event generation for a digital input.
Digital inputs are disabled by default.

disables event generation for digital inputs. The most
recently executed of these two commands takes
precedence.
enable This command enables event generation for a digital input.
Digital inputs are disabled by default.

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.
2-68
Examples
The following settings are configured for digital input 1/ 16:
Default alarm-table entry configured
Input enabled
Description Al ar m16
See Also
config discrete analog
show discrete
( Dub) >conf i g
( Dub) conf i g di scr et e>i nput 1/ 16
( Dub) conf i g di scr et e i nput 1/ 16
- >al ar m- def aul t
- >enabl e
- >descr i pt i on Al ar m16
- >assi gn
Configuration Commands: config discrete output
2-69
configdiscreteoutput
Description
This command configures a digital output.
Formats
config discrete output unit/point
assign
unassign
Parameters
Examples
The following settings are configured for discrete output 1/ 1:
Description Cr i t i cal al ar mout put
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
textDefines 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.
( Dub) >conf i g
( Dub) conf i g di scr et e>out put 1/ 1
( Dub) conf i g di scr et e out put 1/ 1
- >descr i pt i on Cr i t i cal al ar mout put
- >assi gn
- >
Configuration Commands: config discrete output
2-70
See Also
show discrete
Configuration Commands: config event
2-71
configevent
Description
This 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-73.
Formats
config event event_name
description text
no description
For deleting an event:
config no event { event_name | * }
Parameters
Command Defaults
No events configured
* Deletes all configured events.
description Configures a description for an event. The following parameter is
accepted:
textDefines 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.
Configuration Commands: config event
2-72
Examples
This example displays the configuration of description Door open event for event
door Open.
See Also
config action
config response
show actions
show events
show responses
( Dub) >conf i g
( Dub) conf i g>event door Open
( Dub) conf i g event door Open>descr i pt i on Door open event
( Dub) conf i g event door Open>
Configuration Commands: config event content
2-73
configeventcontent
Description
This command configures an event with an associated event originator and event
type.
Formats
config event event_name content event_originator event_type
Parameters
event_name Defines the name of the event being configured. Maximum
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-74.
event_type Defines the type of generated event. For more information on
event types, refer to Table 3 on page 2-80.
2-74
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 | power B | power Mon |
t emper at ur e | humi di t y }
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 units incoming
power B
Specifies the secondary power monitor, which is an
analog input that is dedicated to monitoring the unit's
secondary incoming power supply voltage.
power Mon
Specifies a third power monitor, which is an analog
input used to monitor voltage for an external, isolated
power supply.
t emper at ur e
Specifies the temperature sensor on an RMB
peripheral unit, which is an analog input that is
dedicated to monitoring the ambient temperature.
humi di t y
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
2-75
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.
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.
down
up
input instance Specifies a digital input as the event originator. Valid
values for instance are:
unit/point
unit
to 12.
point
Defines the digital input point number for the unit.
close
offline
open
Table 2 Valid Event Originators (Continued)
Event Originator Description (Continued)
2-76
measurement
instance
Specifies a measurement as the event originator. Valid
name
Identifies the measurement name. Valid values are
alphanumeric characters and underscores.
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.
down
up
output instance Specifies a digital output as the event originator. Valid
unit/point
unit
to 12.
point
Defines the digital output number within the unit.
close
offline
open
2-77
peripheral
instance
Specifies an expansion peripheral unit as the event
originator. Valid value for instance is:
unit
to 12.
offline
online
serial instance Specifies a serial controller as the event originator. Valid
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.
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.
snmpne instance Specifies the Remote RMM-1400 SNMP network element
as the event originator. Valid value for instance is:
name
Identifies the SNMP network element name. Valid
values are alphanumeric characters.
2-78
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
[ ip_address: ] port
Defines 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.
auth-success
conn-cancelled
conn-down
conn-failed
conn-inactivity
conn-timeout
conn-up
incoming-connection
system Specifies the system as a whole (not one particular
subsystem) as the event originator.
init
2-79
tcp instance Specifies a TCP connection as the event originator. Valid
the TCP connection. Valid values for port are 1000 to
65535. If present, ip_address should be an IP
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
the Telnet connection. Valid values for port are 1000
to 65535. If present, ip_address should be an IP
conn-cancelled
conn-down
conn-failed
conn-inactivity
conn-timeout
conn-up
incoming-connection
timer instance Specifies a system timer as the event originator. Valid
timer_name
Defines the unique name of the timer.
The following event type is valid for this originator:
timer-expire
2-80
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.
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.
2-81
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
ai Medi at i onEvent 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.
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 events 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.
Table 3 Valid Event Types (Continued)
Event Type Description (Continued)
2-82
Examples
This example displays the configuration of interval event anal ogI nt er val for anal og
1/ 4.
See Also
config correlation
config event
show correlations
show events
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) >conf i g
( Dub) conf i g>event anal ogI nt er val
( Dub) conf i g event anal ogI nt er val >cont ent
( Dub) conf i g event anal ogI nt er val cont ent
- >anal og 1/ 4
( Dub) conf i g event anal ogI nt er val cont ent anal og 1/ 4
- >i nt er val
( Dub) conf i g event anal ogI nt er val cont ent anal og 1/ 4
- >
Table 3 Valid Event Types (Continued)
Event Type Description (Continued)
Configuration Commands: config hostname
2-83
confighostname
Description
This command configures a hostname for Remote RMM-1400.
Formats
config hostname hostname
Parameters
Command Defaults
Kentrox
Examples
This example displays the configuration of hostname Dubl i nCo for Remote RMM-
1400. Notice that the command prompt changes from Dub to Dubl i nCo.
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) >conf i g
( Dub) conf i g>host name Dubl i nCo
( Dubl i nCo) conf i g>
Configuration Commands: config interface bridge switch
2-84
configinterfacebridgeswitch
Description
This command configures the interface to bridge group swi t ch.
Note: Before a bridge interface can be configured, bridge group swi t ch must be
configured with command config controller bridge switch on page 2-22. The
bridge interface is deleted automatically when bridge swi t ch is deleted.
Formats
config interface bridge switch
ip address { ip_address subnet_mask |
ip_address/subnet_mask_length } [ secondar y ]
ip no address [ ip_address | * ]
no description
Parameters
* Specifies all IP addresses.
description Configures the description for bridge interface swi t ch. The
textDefines the description for bridge interface swi t ch.
ip address Configures an IP address for the bridge switch interface. The
ip_addressDefines the IP address for the interface.
subnet_maskDefines the subnet mask for the interface in
dotted decimal format.
subnet_mask_lengthDefines the length of the subnet
mask. Valid values are 1 to 32.
secondar yDesignates an IP address as a backup to the
primary IP address.
2-85
Examples
The following settings are configured for bridge interface swi t ch:
Description Br i dge swi t ch i nt er f ace
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.
configinterfacebridgeswitchipdhcp
Description
This command configures DHCP client support for the interface to bridge group
swi t ch.
Note: DHCP client support cannot be enabled on the bridge group swi t ch if a static
IP address has already been configured. You must remove the static IP
address before enabling DHCP client support.
Formats
config interface bridge switch ip dhcp
disable
enable
retry-timeout timeout
default retry-timeout
For removing DHCP client support and deleting the retry-timeout value:
config interface bridge switch ip no dhcp
Parameters
( Dub) >conf i g
( Dub) conf i g>i nt er f ace br i dge swi t ch
( Dub) conf i g i nt er f ace br i dge swi t ch>descr i pt i on Br i dge swi t ch i nt er f ace
( Dub) conf i g i nt er f ace br i dge swi t ch>i p
( Dub) conf i g i nt er f ace br i dge swi t ch i p
- >addr ess 12. 85. 32. 4 255. 255. 0. 0
- >addr ess 12. 85. 32. 5 255. 255. 0. 0 secondar y
- >
disable Disables DHCP client support for bridge interface swi t ch. The
retry-timeout value is retained, should you decide to re-enable
DHCP client support.
enable Enables DHCP client support for bridge interface swi t ch.
2-86
Examples
The following settings are configured for bridge interface swi t ch:
DHCP client support enabled
Retry-timoute value 15 minutes
See Also
config interface ethernet
config interface serial
diag controller bridge switch dhcp
show interfaces
retry-
timeout
Configures the time to wait between attempts to contact a DHCP
server. The following parameter is accepted:
timeoutDefines 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 swi t ch and
deletes the retry-timeout value.
( Dub) >conf i g
( Dub) conf i g>i nt er f ace br i dge swi t ch
( Dub) conf i g i nt er f ace br i dge swi t ch>i p
( Dub) conf i g i nt er f ace br i dge swi t ch i p>dhcp
( Dub) conf i g i nt er f ace br i dge swi t ch i p dhcp
- >
- >enabl e
- >r et r y- t i meout 15
- >
Configuration Commands: config interface ethernet
2-87
configinterfaceethernet
Description
These commands configure settings for an Ethernet interface. An interface is a
source and sink for IP packets that is associated with a controller.
Formats
config interface ethernet port
description text
disable
enable
ip no address [ ip_address | * ]
no description
For deleting Ethernet interfaces:
config no interface { ethernet port | ethernet * | * }
Parameters
* Specifies all Ethernet interfaces or all interfaces from the Remote
RMM-1400 configuration.
description Configures a description for an Ethernet interface. The following
textDefines the description for the Ethernet interface.
disable Disables an Ethernet interface.
enable Enables an Ethernet interface.
ip address Configures an IP address for an Ethernet interface. The following
subnet_mask_lengthDefines the length of the subnet mask.
primary IP address.
Configuration Commands: config interface ethernet
2-88
Examples
The following settings are configured for interface et her net 2:
Enabled interface et her net 2
Description Et her net 2
IP address 12. 35. 92. 4 and subnet mask length 16.
See Also
show interfaces ethernet
port Defines the physical connector associated with an Ethernet
interface on Remote RMM-1400. Valid Ethernet port values are 1 to
4.
( Dub) >conf i g
( Dub) conf i g>i nt er f ace et her net 2
( Dub) conf i g i nt er f ace et her net 2>enabl e
( Dub) conf i g i nt er f ace et her net 2>descr i pt i on Et her net 2
( Dub) conf i g i nt er f ace et her net 2>i p
( Dub) conf i g i nt er f ace et her net 2 i p
- >addr ess 12. 35. 92. 4/ 16
( Dub) conf i g i nt er f ace et her net 2 i p
- >
Configuration Commands: config interface openvpn
2-89
configinterfaceopenvpn
Description
This 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.
Formats
config interface openvpn name
description text
disable
enable
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
textDefines 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:
subnet_mask_lengthDefines the length of the subnet mask.
primary IP address.
Configuration Commands: config interface openvpn
2-90
Examples
The following settings are configured for OpenVPN interface cmhcl i ent 1:
Enabled OpenVPN interface cmhcl i ent 1
Description VPN cl i ent i nt er f ace CMH1
IP address 12. 35. 64. 34 and subnet mask length 16
See Also
config controller openvpn
show interfaces openvpn
name Defines the name of the OpenVPN interface.
( Dub) >conf i g
( Dub) conf i g>i nt er f ace openvpn cmhcl i ent 1
( Dub) conf i g i nt er f ace openvpn cmhcl i ent 1>enabl e
( Dub) conf i g i nt er f ace openvpn cmhcl i ent 1>descr i pt i on VPN cl i ent i nt er f ace CMH1
( Dub) conf i g i nt er f ace openvpn cmhcl i ent 1>i p addr ess 12. 35. 64. 34/ 16
( Dub) conf i g i nt er f ace openvpn cmhcl i ent 1>
Configuration Commands: config interface serial
2-91
configinterfaceserial
Description
This 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.
Formats
config interface serial modem
description text
disable
enable
ip address ip_address poi nt opoi nt peer_ip_address
no { description | ip address ip_address }
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
textDefines a description for the serial interface. The
maximum length for an interface description is 60 characters.
disable Disables a serial interface.
enable Enables a serial interface.
ip address Configures an IP address for the serial interface. The following
poi nt opoi nt Initiates the definition of the remote device IP
address.
peer_ip_addressDefines the remote device IP address
for the interface.
Configuration Commands: config interface serial
2-92
Examples
The following settings are configured for interface ser i al modem:
Description Thi s i s t he ser i al i nt er f ace f or t he wi r el ess modem
IP address 10. 37. 45. 2 and peer IP address 10. 37. 45. 5
Enabled interface ser i al modem.
See Also
show interfaces
( Dub) >conf i g
( Dub) conf i g>i nt er f ace ser i al modem
( Dub) conf i g i nt er f ace ser i al modem>descr i pt i on Thi s i s t he ser i al i nt er f ace f or
t he wi r el ess modem
( Dub) conf i g i nt er f ace ser i al modem>i p addr ess 10. 37. 45. 2 poi nt opoi nt 10. 37. 45. 5
( Dub) conf i g i nt er f ace ser i al modem>enabl e
( Dub) conf i g i nt er f ace ser i al modem>
Configuration Commands: config ip
2-93
configip
Description
This command configures various IP settings for Remote RMM-1400.
Formats
config ip
arp ip_address mac_address
default gateway_address
domain-name domain_name
forward
name-server ip_address
no { 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 ]
For deleting a route:
config ip no route { destination_address subnet_mask |
destination_address/subnet_mask_length | default | * }
{ gateway_address | i nt er f ace type instance }
For restoring the default route (which routes to the bridge swi t ch interface):
config ip default route default
Parameters
* Specifies all IP addresses or routes.
arp Configures an Remote RMM-1400 ARP cache entry. The following
ip_addressDefines an IP address.
mac_addressDefines 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.
2-94
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. domai nname. com).
domain_nameDefines 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_addressDefines the IP address of the DNS server.
route Configures or deletes a static route. The following parameters are
accepted:
destination_addressDefines an IP address for a network.
subnet_maskDefines 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_lengthDefines the subnet mask length. Valid
values are 1 to 32.
gateway_addressDefines the IP address of the next node
location in a route.
interfaceDefines 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
preferenceDefines 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.
2-95
Examples
The 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. f i r ewal l domai n. com
Enabled IP forwarding
DNS server 12. 55. 68. 4
Default route 10. 40. 0. 1.
See Also
show ip
( Dub) >conf i g
( Dub) conf i g>i p
( Dub) conf i g i p>ar p 10. 40. 5. 11 00: 01: 03: 1C: A2: E4
( Dub) conf i g i p>domai n- name www. f i r ewal l domai n. com
( Dub) conf i g i p>name- ser ver 12. 55. 68. 4
( Dub) conf i g i p>r out e def aul t 10. 40. 0. 1
( Dub) conf i g i p>
Configuration Commands: config iptables
2-96
configiptables
Description
This 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 version 1.2.7a, refer to the man page for
IPTables Man Page on page B-1.
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 Also
show iptables
Configuration Commands: config jobs
2-97
configjobs
Description
These commands configure job history and statistics settings.
Formats
config jobs
default history-runs
history-runs count
no history
reset-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:
countDefines 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-81 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 command show jobs on
page 3-81.
Configuration Commands: config jobs
2-98
Command Defaults
25 runs
Examples
The 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 Also
config jobs name
show jobs
show jobs name
( Dub) >conf i g
( Dub) conf i g>j obs
( Dub) conf i g j obs>hi st or y- r uns 13
( Dub) conf i g j obs>r eset - st at s
( Dub) conf i g j obs>
( Dub) >conf i g
( Dub) conf i g j obs>def aul t hi st or y- r uns
( Dub) conf i g j obs>
Configuration Commands: config jobs name
2-99
configjobsname
Description
This command configures a job and its associated settings.
Important: You must stop running jobs before deleting them with this command.
Formats
config jobs name job_name
capture
cron-start
default { memory | start-attempts }
history run_id
memory mem_limit [ stack_size ]
no { capture | cron-start | history { run_id | * } | property
property | start-at start_index | start-boot | title }
property property prop_value
script package script [ min_version ]
start-at month day hour minute weekday
start-attempts count
start-boot
title 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.
J ob 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.
2-100
history Specifies the history of all Remote RMM-1400 jobs. The
run_idDefines the specific execution of a job for which
history will be purged.
job_name Defines the name of the job being added or deleted. J ob 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.
mem_limitDefines 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_sizeDefines 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
propertyDefines the property that will be configured for a
job. Acceptable values for the job property are based on
parameters defined in the script.
prop_valueDefines 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.
2-101
script Associates a script with a job and allows the user to select a
package version level for that job. J obs are likely to vary from
one card installation to another due to the uniqueness of device
IP addresses. The following parameters are accepted:
packageDefines the package containing the script.
scriptDefines the script to be run by the job.
min_versionDefines 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-
i nst al l 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.
dayDefines the day that the job will start. Valid values are
1 to 31.
hourDefines the hour that the job will start. Valid values
are 0 to 23.
minuteDefines the minute that the job will start. Valid
values are 0 to 59.
monthDefines the month that the job will start. Valid
values are 1 to 12.
start_indexDefines the index number associated with a
start time specification for a job.
weekdayDefines the day of the week that the job will start.
Valid values are 0, which represents Sunday, to 7, which
represents the following Sunday.
2-102
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
countDefines 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 whenever 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:
titleDefines the title of the job. The title can be up to 80
characters long and it can contain spaces.
2-103
Examples
The following settings are configured for job sampl ej ob:
Enabled capture capabilities
Enabled automatic start capabilities
Enabled start at boot up
J ob memory limit of 24368 kilobytes and stack size of 4000 kilobytes
J ob property dur at i on, which sets the runtime for a job in seconds, with a
property value of 10 seconds
Script package j obt est ut i l s, script nor mal , and minimum required version
level 2. 0. 0
10 start attempts
J ob title New Sampl e J ob.
( Dub) >conf i g
( Dub) conf i g j obs>name sampl ej ob
( Dub) conf i g j obs name sampl ej ob
- >capt ur e
- >cr on- st ar t
- >st ar t - boot
- >memor y 24368 4000
- >pr oper t y dur at i on 10
- >scr i pt j obt est ut i l s nor mal 2. 0. 0
- >st ar t - at t empt s 10
- >t i t l e New Sampl e J ob
- >
2-104
This example displays the configuration of the following start times for job sampl ej ob:
Month 4
Days 15- 24
Hours 3, 5, 7
Minute 30
No weekday
The configured start times for sampl ej ob are April 15th to 24th at 3:30 AM, 5:30 AM,
and 7:30 AM. The start-at index number is 2.
This example displays the removal of the history associated with run ID 14 for job
myj ob.
See Also
config jobs
config jobs name task
show jobs
show jobs name
( Dub) >conf i g
- >st ar t - at 4 15- 24 3, 5, 7 30 *
St ar t - at i ndex: 2
- >
( Dub) >conf i g
( Dub) conf i g j obs>name myj ob
( Dub) conf i g j obs name myj ob
- >no hi st or y 14
( Dub) conf i g j obs name myj ob
- >
Configuration Commands: config jobs name task
2-105
configjobsnametask
Description
These 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.
Formats
config jobs name job_name task task
no property property
position position
property property value
type 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
positionMoves a task to a specific location in the task list.
Valid values are 1 to the new total number of tasks. Command
show jobs name on page 3-84 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:
propertyDefines a user-configurable property for a task. Each
task type has its own set of properties. Refer to Table 4 on page 2-
106 and Table 6 on page 2-107 for more information about user-
configurable property sets.
valueDefines a value for a property.
Tip: In order to have spaces in the value, the value must be in
quotes.
2-106
datadir
Task 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
type Assigns a type to a job task. The following parameter is accepted:
task_typeDefines 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
cr eat e Specifies that the data directory should be created if it
doesnt already exist. The task fails if the data directory
does not exist and this property is not present. Valid values
are t r ue and f al se.
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
2-107
ifconfig
Task 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.
processmonitor
Task 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.
resource
Task type resource has been deprecated.
serversocket
Task 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
pat h Specifies the absolute path to the directory created by the script
engine.
Table 6 Properties for Task Type serversocket
addr ess Specifies the configuration of an IP address
or hostname.
Yes (if i f conf i g or
i nt er f ace are not
specified)
def er 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.
i f conf i g Specifies a previously configured address
value from an ifconfig task.
Yes (if i nt er f ace
or addr ess are not
specified)
2-108
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 tasks specified time frame. This task type has no associated properties.
i nt er f ace Specifies a previously configured interface
value.
Tip: For valid i nt er f ace values, refer to the
syst em- name values listed in command
show interfaces on page 3-61.
Yes (if i f conf i g or
addr ess are not
specified)
l i st en Specifies the number of connections allowed
in the sockets listen queue. This propertys
value is valid only if st r eamis configured.
No
por t 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
t ype Specifies the type of socket Remote RMM-
1400 configures. Valid values are st r eamand
dgr am. If not specified, the default is st r eam.
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:
f d = i nt ( pr oper t i es[ t askname. socket ] )
socket . f r omf d( f d, socket . AF_I NET, socket . SOCK_STREAM)
por t 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)
2-109
Examples
This example displays the configuration of task wat chdog for job sampl ej ob.
This example displays the deletion of task wat chdog from job sampl ej ob.
See Also
show jobs
show jobs name
( Dub) >conf i g
- >t ask wat chdog
( Dub) conf i g j obs name sampl ej ob t ask wat chdog
- >
( Dub) >conf i g
- >no t ask wat chdog
- >
Configuration Commands: config meas-table
2-110
configmeas-table
Description
This command configures the measurement table, which stores analog measurement
values.
Formats
config meas-table
default
interval interval
Parameters
Examples
This 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 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:
intervalDefines the time interval in minutes. Valid values
are whole numbers between 1 and 1440.
( Dub) >conf i g
( Dub) conf i g>meas- t abl e
( Dub) conf i g meas- t abl e>i nt er val 30
( Dub) conf i g meas- t abl e>
( Dub) >
2-111
This example configures the default value (15 minutes) for the interval parameter:
configmeas-tableentry
Description
This command configures entries in the measurement table.
Formats
config meas-table entry { name | filter | * }
band low high
category category_name
default
description text
disable
enable
hysteresis hysteresis_value
maximum maximum_value
minimum minimum_value
ne-name ne_name
no
originator originator
report-interval report_interval
units units
For deleting measurement table entries:
config meas-table no entry { name | filter | * }
Parameters
( Dub) >conf i g
( Dub) conf i g>meas- t abl e
( Dub) conf i g meas- t abl e>def aul t i nt er val
( Dub) conf i g meas- t abl e>
( Dub) >
* Specifies all event templates.
2-112
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
lowDefines the low measurement table value in sensor
units. Valid values are numeric characters. The default value is
0.
highDefines the high measurement table value in sensor
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_nameDefines 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
textDefines 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
hysteresis_valueDefines the hysteresis value in sensor
0.
2-113
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_valueDefines 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_valueDefines 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_nameDefines 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.
originatorDefines the source of the measured data:
For an analog input, originator identifies the input; for
example, anal og 1/ 3.
For a sitebus terminal, originator identifies the SiteBus
device and logical point; for example, si t ebus
t emp1/ t emper at ur eC.
For a script, originator takes the format scr i pt jobname
measurementname.
For SNMP proxy, originator takes the format snmpne
NEname_measurementname. An SNMP NE table also can serve
as the originator for a measurement table entry. In this case,
originator takes the format snmpne NEname_
measurementname_rowID, where rowID is the rows unique
identifier obtained from the row ID column.
2-114
Examples
The following settings are configured for the measurement table entry Vol t age1:
In-band range from 13 to 15
Maximum value 18
Minimum value 12
Network element name Gener at or 1
Measurement units VDC
See Also
config mediation snmp measurement-template
config mediation snmpne
diag mediation snmpne poll
show meas-table
show mediation
report-
interval
Configures the interval for reporting updated measurement values
by sending a trap or some other external message. The following
report-intervalDefines 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.
unitsDefines a unit of measure; for example, V or deg C.
Valid values are alphanumeric characters.
( Dub) >conf i g
( Dub) conf i g>meas- t abl e ent r y Vol t age1
( Dub) conf i g meas- t abl e ent r y Vol t age1
- >band 50 52
- >maxi mum54
- >mi ni mum48
- >ne- name Gener at or 1
- >uni t s VDC
- >
( Dub) >
Configuration Commands: config mediation snmp event-template
2-115
configmediationsnmpevent-template
Description
This command configures the event template for a proxied SNMP network element.
Formats
config mediation snmp event-template name
description description
message message
no
trap-oid trap_oid
varbind-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:
descriptionConfigures the name of the event template.
message Configures the event templates 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:
messageDefines the templates alarm message.
name Configures the name of the event template. Valid values are
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
trap_oidConfigures 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.
2-116
Examples
The following mediation SNMP event-template settings are configured:
Event-template name col dst ar t
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 $( i f I ndex)
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
varbind_oidConfigures the OID which is matched against
one of the varbind OIDs of an incoming trap. The OID may
contain parameters.
varbind_valueConfigures 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) >conf i g
( Dub) conf i g medi at i on snmp event - t empl at e col dst ar t
>descr i pt i on Reboot event
( Dub) conf i g medi at i on snmp event - t empl at e col dst ar t
>message $( event ) event on $( snmpne)
( Dub) conf i g medi at i on snmp event - t empl at e col dSt ar t
>t r ap- oi d . 1. 3. 6. 1. 6. 3. 1. 1. 5. 1
( Dub) conf i g medi at i on snmp event - t empl at e col dSt ar t
>var bi nd- mat ch . 1. 3. 6. 1. 2. 1. 2. 2. 1. 1 $( i f I ndex)
( Dub) >
2-117
See Also
config mediation snmp manager
config mediation snmp ne-template
config mediation snmp point-template
debug mediation
show mediation
Configuration Commands: config mediation snmp manager
2-118
configmediationsnmpmanager
Description
This command configures the mediation SNMP manager.
Formats
port port
Parameters
Example
The 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:
portConfigures the port number for the SNMP manager. The
default port is 162.
( Dub) conf i g medi at i on snmp manager
( Dub) conf i g medi at i on snmp manager >por t 2162
( Dub) conf i g medi at i on snmp manager >
( Dub) >
Configuration Commands: config mediation snmp measurement-template
2-119
configmediationsnmpmeasurement-template
Description
This 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.
Formats
config mediation snmp measurement-template name
default
no
poll-oid oid
poll-table poll_table_oid id_column value_column
trap trap_name
def aul t
no
t r ap- oi d oid
val ue- mat ch index
var bi nd- i d oid
var bi nd- mat ch oid value
var bi nd- val ue oid
value-conversion
def aul t
mul t i pl y 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
descriptionConfigures a description for the measurement
template. Valid values are string characters.
2-120
name Configures the name of the measurement template. Valid values
poll-oid Configures the OID used to poll the proxied NE for the
measurements current value. By default, the OID is empty which
indicates no poll is performed. The following parameter is
accepted:
oidConfigures 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
poll_table_oidConfigures the OID used to poll the table.
id_columnConfigures the column to check for a matching ID
value when polling the table. Valid values are integers.
value_columnConfigures the column number to check for a
matching measurement value. Valid values are numeric
characters.
2-121
trap Describes trap parameters that the measurement template will
compare with incoming traps in order to determine a match. The
nameConfigures the name of the trap. Valid values are
def aul t Configures the default value (1) for the val ue-
mat ch parameter.
t r ap- oi dConfigures 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:
oidConfigures 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.
val ue- mat chConfigures which numeric value in a string is
the desired value. The following parameter is accepted:
indexConfigures which numeric value in a string is desired.
Valid values are whole numbers.
var bi nd- i dUsed 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:
oidThe 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.
var bi nd- mat chConfigures a matching varbind OID and
value to match against the varbind OID and value of an
incoming trap. The following parameters are accepted:
oidThe 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.
valueThe value which must match the varbind value in an
incoming trap for the configured varbind OID. The value may
contain parameters.
var bi nd- val ueConfigures the OID to match against one of
the varbind OIDs of an incoming trap. The following parameter
is accepted:
oidThe OID value used to find the measurement value.
Valid values are dotted number OID strings, for example,
. 1. 2. 3. 4.
2-122
Examples
The following example configures a measurement template for a single
measurement. The following settings are configured:
Measurement-template name al Def
Poll OID . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 5. $( al I ndex)
Value match 2
Trap name cr i t i cal
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 $al I ndex
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:
multiplierThe 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:
indexConfigures which numeric value in a string is desired.
Valid values are whole numbers. For example, if the string
response is The vol t age i s 32. 6, t he cur r ent i s 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.
2-123
The following example configures a measurement template for a group of
measurements in a poll table. The following settings are configured:
Measurement-template name al Tabl eDef
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 cr i t i cal
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 $al I ndex
Varbind value from OID . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 5
( Dub) >conf i g
( Dub) >conf i g
( Dub) conf i g>medi at i on snmp measur ement - t empl at e al Def
( Dub) conf i g medi at i on snmp measur ement - t empl at e al Def
- >pol l - oi d . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 5. $( al I ndex)
- >val ue- mat ch 2
- >t r ap cr i t i cal
( Dub) conf i g medi at i on snmp measur ement - t empl at e al Def t r ap cr i t i cal
- >t r ap- oi d . 1. 3. 6. 1. 4. 1. 539. 42. 2. 0. 5
- >var bi nd- mat ch . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 1 $al I ndex
- >var bi nd- val ue . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 5
- >val ue- mat ch 2
( Dub) >
( Dub) >conf i g
( Dub) conf i g>medi at i on snmp measur ement - t empl at e al Tabl eDef
( Dub) conf i g medi at i on snmp measur ement - t empl at e al Tabl eDef
- >pol l - t abl e . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2 7 5
- >val ue- mat ch 2
- >t r ap cr i t i cal
( Dub) conf i g medi at i on snmp measur ement - t empl at e al Tabl eDef t r ap cr i t i cal
- >t r ap- oi d . 1. 3. 6. 1. 4. 1. 539. 42. 2. 0. 5
- >var bi nd- i d . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 7
- >var bi nd- val ue . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 5
- >val ue- mat ch 2
( Dub) >
2-124
See Also
config meas-table
debug mediation
show mediation
Configuration Commands: config mediation snmp ne-template
2-125
configmediationsnmpne-template
Description
This 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.
Formats
config mediation snmp ne-template name
event event_name template [ { param param_value } ... ]
measurement measurement_name template [ { param param_value }
... ]
ne-template reference_name template [ { param param_value } ...
]
no [ descr i pt i on | event | ne- t empl at e | poi nt ]
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.
descriptionConfigures 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_nameConfigures the name of the event. Valid values
are alphanumeric characters. Event names can also contain
replaceable parameters in the format $( par am) . These
parameters will be substituted when the template is applied to
an NE.
templateSpecifies the name of an existing event template.
paramSpecifies a parameter in the event template. The
value for this parameter is then specified by param_value.
2-126
measurement Configures a measurement for this NE template by referring to an
existing measurement template. The following parameters are
accepted:
measurement_nameConfigures the name of the
measurement. Valid values are alphanumeric characters.
templateSpecifies the name of an existing measurement
template.
paramSpecifies 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
ne-template This command specifies values for this NE template by referring to
a different NE template. The following parameters are accepted:
reference_nameConfigures the name of the event. Valid
values are alphanumeric characters. NE template reference
names can also contain replaceable parameters in the format
$( par am) . These parameters will be substituted when the
template is applied to an NE.
templateSpecifies the name of an existing NE template.
paramSpecifies 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_nameConfigures the name of the point. Valid values
are alphanumeric characters. Point names can also contain
replaceable parameters in the format $( par am) . These
parameters will be substituted when the template is applied to
an NE.
templateSpecifies the name of an existing point template.
paramSpecifies a parameter in the point template. The value
for this parameter is then specified by param_value.
2-127
Examples
The following mediation SNMP NE template settings are configured:
Event template name Templ at e1
Description Sampl e t empl at e
Point modem, which refers to the existing point template i f Ent r yDef and
specifies the value ser i al _modemfor the parameter i f Descr
Event r unni ngConf i gChange, which refers to the existing event template
conf i gChangeDef and specifies the value r unni ngconf i g for the
parameter f i l e
NE template al ar m1, which refers to the existing NE template al ar ms and
specifies the value 1 for the parameter num
See Also
show mediation
( Dub) >conf i g
( Dub) conf i g medi at i on snmp ne- t empl at e Templ at e1
>descr i pt i on Sampl e t empl at e
>poi nt modemi f Ent r yDef i f Descr ser i al _modem
>event r unni ngConf i gChange conf i gChangeDef f i l e r unni ngconf i g
>ne- t empl at e al ar m1 al ar ms num1
( Dub) >
Configuration Commands: config mediation snmp point-template
2-128
configmediationsnmppoint-template
Description
This command configures the point template for a proxied SNMP network element.
Formats
config mediation snmp point-template name
default [ of f l i ne- message | of f l i ne- sever i t y ]
no [ descr i pt i on | of f l i ne message | pol l - oi d | pol l - t abl e |
st at e ]
offline-message message
offline-severity severity
poll-default-state state
poll-oid oid
poll-table poll_table_oid match_column match_value state_column
state name
message message
pol l - val ue value
sever i t y [ cr i t i cal | maj or | mi nor | nor mal | war ni ng |
i nf or mat i onal ]
t r ap- oi d oid
var bi nd- mat ch 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.
descriptionConfigures the name of the point template.
name Configures the name of the point template. Valid values are
2-129
offline-
message
Configures the alarm message for the offline state of a mediation
SNMP point. The default message is $( poi nt ) i s of f l i ne. The
messageConfigures the offline alarm message. Valid values
offline-
severity
Configures the alarm severity for the offline state of a mediation
SNMP point. The following parameter is accepted:
severityThe offline alarm severity. The valid severity values
are cr i t i cal , i nf or mat i onal , maj or , mi nor , nor mal , and
war ni ng. The default value is maj or .
poll-
default-
state
Configures the default polling state for points in this template.
Possible values are of f l i ne and any states created by the state
parameter. The default value is of f l i ne.
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:
oidConfigures the name of the OID which is used to poll the
proxied NE.
Note: You can configure the point template for polling by OID
(using poll-oid) or for polling by table (using poll-table).
If poll-oid has been configured, executing poll-table
will override the existing command. Conversely, executing
poll-oid will override an existing poll-table command.
poll-table Configures a poll table for this point template. The following
match_columnConfigures the column number to check for a
matching value when polling the table. Valid values are
integers.
match_valueConfigures the value to match within the
specified column. Valid values are alphanumeric characters
and may contain parameters.
poll_table_OIDConfigures the name of the OID which is
used to poll the table.
state_columnConfigures the table column whose state will
be reported if a match is found. Valid values are integers.
2-130
state This command begins the configuration of a state for a point in a
template. The following parameters are accepted:
nameConfigures the name of the point's state. Valid values
messageConfigures 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.
pol l - val ueConfigures 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.
sever i t yConfigures the severity for a point template state.
This value is used to set the alarm table entry's severity for the
state.
t r ap- oi dConfigures the OID to match against a trap for a
mediation SNMP template state.
var bi nd- mat chConfigures 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_oidThe OID which is matched against one of the
varbind OIDs of an incoming trap. The OID may contain
parameters.
varbind_valueThe value which must match the value in an
incoming trap for the configured varbind OID. The value may
contain parameters.
2-131
Examples
The following mediation SNMP point-template settings are configured:
Point-template name i f Ent r yDef
Description Ent r y i n i f Tabl e
State up and then the following associated parameters:
poll value 1
message $( poi nt ) i s 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 $( i f I ndex)
severity nor mal
State down and then the following associated parameters:
poll value 2
message $( poi nt ) i s 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 $( i f I ndex)
severity maj or
( Dub) >conf i g medi at i on snmp
( Dub) conf i g medi at i on snmp>poi nt - t empl at e i f Ent r yDef
( Dub) conf i g medi at i on snmp poi nt - t empl at e i f Ent r yDef
>descr i pt i on Ent r y i n i f Tabl e
>pol l - oi d . 1. 3. 6. 1. 2. 1. 2. 2. 1. 8. $( i f I ndex)
>st at e up
( Dub) conf i g medi at i on snmp poi nt - t empl at e i f Ent r yDef st at e up
>pol l val ue 1
>t r ap- oi d . 1. 3. 6. 1. 6. 3. 1. 1. 5. 4
>sever i t y nor mal
>message $( poi nt ) i s up
>st at e down
>pol l val ue 2
( Dub) conf i g medi at i on snmp poi nt - t empl at e i f Ent r yDef st at e down
>t r ap- oi d . 1. 3. 6. 1. 6. 3. 1. 1. 5. 4
>sever i t y maj or
>message $( poi nt ) i s down
( Dub) >
2-132
This example defines the message I nt er f ace i s of f l i ne and the cr i t i cal
severity for the offline state on a point template:
See Also
debug mediation
show mediation
( Dub) >conf i g medi at i on snmp poi nt - t empl at e i f Ent r y
( Dub) conf i g medi at i on snmp poi nt - t empl at e i f Ent r y>of f l i ne- message I nt er f ace i s
of f l i ne
( Dub) conf i g medi at i on snmp poi nt - t empl at e i f Ent r y>
( Dub) conf i g medi at i on snmp poi nt - t empl at e i f Ent r y>of f l i ne- st at e cr i t i cal
( Dub) conf i g medi at i on snmp poi nt - t empl at e i f Ent r y>
Configuration Commands: config mediation snmpne
2-133
configmediationsnmpne
Description
This 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.
Formats
config mediation snmpne name
category category
connectivity-oid oid
default [ connect i vi t y- oi d | host ]
event event_name template [ { param param_value } ... ]
host ip_addr [ port [ community [ { v1 | v2 } ] ] ]
measurement measurement_name template [ { param param_value }
... ]
measurement-poll-interval measurement_interval
ne-name ne-name
point point_name template [ { param param_value } ... ]
point-poll-interval point_interval
template 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
categorySpecifies a category name for the SNMP NE.
description This command configures a textual description for an SNMP NE.
descr i pt i onSpecifies a description for the SNMP NE.
2-134
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:
oidThe 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 sysObj ect I D 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
event_nameThe name of the event on the mediation
SNMP NE. Valid values are alphanumeric characters.
templateThe name of a configured event template which
defines the event.
paramThe name of a replaceable parameter in the point
template. Valid values are alphanumeric characters.
param_valueThe 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
ip_addrThe 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.
communityThe 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.
2-135
measurement Configures a measurement for a mediation SNMP NE. The
measurement_nameThe name of the measurement on the
mediation SNMP NE. Valid values are alphanumeric
characters.
templateThe name of a configured measurement
template which defines the measurement.
paramThe name of a replaceable parameter in the
measurement template. Valid values are alphanumeric
characters.
param_valueThe 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_intervalThe measurement polling interval
(in seconds). Valid values are 10 to 86400. The default value
is 60.
name Configures the name of the mediation SNMP NE. Valid values
ne-name Configures the network element name for a mediation SNMP
NE. The following parameter is accepted:
ne_nameThe network element name of the mediation
SNMP NE.
point Configures a status point on a mediation SNMP NE. The
point_nameThe name of the point on the mediation
SNMP NE. Valid values are alphanumeric characters.
templateThe name of a configured point template which
defines the point.
param The name of a replaceable parameter in the point
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_intervalThe point polling interval (in seconds).
Valid values are 60 to 86400. The default value is 3600.
2-136
Examples
The following mediation SNMP NE settings are configured:
SNMP NE name MyNE
Description My pr oxi ed NE
Category r eboot event
NE name MyNE
Host with IP address 10. 40. 65. 90, port 16, community admi ni st r at or , and
version v1
Event name r eboot and template col dSt ar t
Point et her net 1, template i f Ent r y, parameter i f I ndex, and parameter
value 1.
template Configures an SNMP NE by referring to an existing NE template.
reference_nameA unique name that identifies this
particular reference to the NE template. Valid values are
templateThe name of a configured template which
defines parameters for this type of network element.
param The name of a replaceable parameter in the NE
parameter in the NE template.
( Dub) >conf i g
( Dub) conf i g medi at i on snmpne MyNE
>descr i pt i on My pr oxi ed NE
>cat egor y r eboot event
>ne- name MyNE
>host 10. 40. 65. 90 161 admi ni st r at or v1
>event r eboot col dst ar t
>poi nt et her net 1 i f Ent r y i f I ndex 1
>( Dub) >
2-137
The following mediation SNMP NE settings are configured:
SNMP NE name Your NE
Category Sampl eCat egor y
Host with IP address 10. 44. 57. 30, port 161, community admi ni st r at or ,
and version v1
Measurement name newMeasur ement , template myMeasTmpl , parameter
i f I ndex with a value of 10
Measurment polling interval of 120 seconds.
See Also
debug mediation
show mediation
( Dub) >conf i g
( Dub) conf i g>medi at i on snmpne Your NE
( Dub) conf i g medi at i on snmpne Your NE
- >host 10. 44. 57. 30 161 admi ni st r at or v1
- >measur ement newMeasur ement myMeasTmpl i f I ndex 10
- >cat egor y Sampl eCat egor y
- >measur ement - pol l - i nt er val 120
( Dub) >
Configuration Commands: config ntp
2-138
configntp
Description
These commands configure NTP settings for Remote RMM-1400. NTP maintains a
common clock time among hosts within a network.
Formats
config ntp
default poll-interval
disable
enable
poll-interval min_poll max_poll
server ip_address [ pr ef er ]
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_pollDefines the minimum time frame limit that a host
on a network has to receive and transmit data. Enter x where
x is 2
x
. 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_pollDefines the maximum time frame limit that a host
on a network has to receive and transmit data. Enter x where
x is 2
x
. 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.
Configuration Commands: config ntp
2-139
Examples
The 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
pr ef er .
ip_addressDefines the IP address for an NTP server.
pr ef er Sets the specified IP address as the preferred
server.
( Dub) >conf i g
( Dub) conf i g>nt p
( Dub) conf i g nt p>pol l - i nt er val 4 9
( Dub) conf i g nt p>ser ver 12. 99. 23. 4
( Dub) conf i g nt p>enabl e
( Dub) conf i g nt p>
Configuration Commands: config peripheral
2-140
configperipheral
Description
This 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.
Formats
config peripheral unit
description text
manage name
no { 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
textDefines the description for the peripheral unit. The
maximum length is 128 characters.
2-141
Command Defaults
No 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:
nameSelects 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 units 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 units
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.
typeDefines a supported peripheral type. Supported types
include the following:
RMB- 1 for RMB-1 and RMB-2 units
di scr et e- expansi on for Expand D units
RME- B64 for RME-B64 units
RME- E8 for RME-E8 units
RME- S8 for RME-S8 units.
2-142
Examples
The following settings are configured for peripheral unit 1:
Type RMB- 1
Description RMB- 1 smar t bl ock
Managed RMB-1 RMB1- 0E68FD
See Also
diag peripheral reload
show peripherals
( Dub) >conf i g
( Dub) conf i g>per i pher al 1
( Dub) conf i g per i pher al 1>t ype RMB- 1
( Dub) conf i g per i pher al 1>descr i pt i on RMB- 1 smar t bl ock
( Dub) conf i g per i pher al 1>manage RMB1- 0E68FD
( Dub) conf i g per i pher al 1>
Configuration Commands: config pkgs install
2-143
configpkgsinstall
Description
These 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.
Formats
config pkgs install
all [ f r omser ver ]
name package [ min_version ] [ f r omser ver ]
referenced [ f r omser ver ]
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 / pkgst age staging area or from the central
FTP package server, whichever one is specified.
Tip: The staging area is the / pkgst age 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.
f r omser ver Specifies the configured server as the location
from which the package or packages will be installed. Specify
f r omser ver only if Remote RMM-1400 is configured with an
FTP server.
Tip: If f r omser ver is specified, Remote RMM-1400 will only
check the FTP server for available packages. Likewise, if
f r omser ver is not specified, Remote RMM-1400 will
check only the staging area for available packages.
2-144
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.
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
packageDefines the name of the package that will be
installed.
min_versionDefines the minimum acceptable version level
for an installed package.
FTP server.
2-145
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.
Packages can be downgraded to a lower version after they have
FTP server.
2-146
Examples
This example displays the installation of all available packages from the configured
central package FTP server.
This example displays the installation of script package t est i from the configured
FTP server. The minimum acceptable version level for the package is 1. 1. 2.
This example displays the installation of all packages referenced by configured jobs.
( Dub) >conf i g
( Dub) conf i g>pkgs
( Dub) conf i g pkgs>i nst al l
( Dub) conf i g pkgs i nst al l
- >al l f r omser ver
Package pkgt est ut i l s, ver si on 1. 0. 0 i nst al l ed
Package t est a, ver si on 1. 3. 0 i nst al l ed
Package t est b, ver si on 2. 2. 0 i nst al l ed
Package t est i mpa, ver si on 1. 0. 0 i nst al l ed
Package t est i mpb, ver si on 2. 1. 0 i nst al l ed
Package t est i mpc, ver si on 1. 2. 0 i nst al l ed
Package t est i mpd, ver si on 2. 1. 1 i nst al l ed
Package t est i mpe, ver si on 2. 0. 0 i nst al l ed
Package t est p, ver si on 1. 0. 0 i nst al l ed
Package t est q, ver si on 1. 0. 0 i nst al l ed
Package t est r , ver si on 1. 0. 0 i nst al l ed
- >
( Dub) >conf i g
- >name t est i 1. 1. 2 f r omser ver
Package t est i , ver si on 2. 0. 1 i nst al l ed.
- >
( Dub) >conf i g
- >r ef er enced f r omser ver
Package t est i , ver si on 2. 0. 1 i nst al l ed
Package t est g, ver si on 1. 0. 0 i nst al l ed
Package t est j , ver si on 2. 0. 1 i nst al l ed
- >
2-147
See Also
config pkgs on-demand-install
config pkgs server
config pkgs uninstall
show pkgs
Configuration Commands: config pkgs on-demand-install
2-148
configpkgson-demand-install
Description
This 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.
Formats
config pkgs no on-demand-install
Parameters
Command Defaults
Disabled
no Disables on demand install.
Configuration Commands: config pkgs on-demand-install
2-149
Examples
This 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) >conf i g
( Dub) conf i g pkgs>on- demand- i nst al l
( Dub) conf i g pkgs>
( Dub) >conf i g
( Dub) conf i g pkgs>no on- demand- i nst al l
Configuration Commands: config pkgs server
2-150
configpkgsserver
Description
This 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.
Formats
config pkgs server
address ip_address [ port ]
default { directory | user }
directory directory
disable
enable
user 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_addressDefines the IP address of the central package
FTP server.
portDefines the port number of the central package FTP
server. Valid values are 1 to 65535. The default port number is
21.
default Resets the specified parameter to its default value.
directory Configures Remote 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:
directoryDefines the directory on the central package FTP
server that contains the script packages.
disable Disables remote FTP access.
enable Enables remote FTP access.
Configuration Commands: config pkgs server
2-151
Examples
The following settings are configured for the central package FTP server:
IP address 10. 50. 13. 12
Port number 50
Directory / r emot e/ packages
Username t est
Password t est
Central package FTP server enabled.
See Also
config 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
usernameDefines the user name configured on the central
FTP package server. The default user name is anonymous.
passwordDefines the password configured on the central FTP
package server. The default password is scr i pt @ai .
no Deletes Remote RMM-1400s IP configuration for the central FTP
package server and resets the user name, password, and directory
to the default values.
( Dub) >conf i g
( Dub) conf i g pkgs>ser ver
( Dub) conf i g pkgs ser ver
- >addr ess 10. 50. 13. 12 50
- >di r ect or y / r emot e/ packages
- >user t est t est
- >enabl e
- >
Configuration Commands: config pkgs uninstall
2-152
configpkgsuninstall
Description
This 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.
Formats
all
name package
Parameters
Examples
This example displays the uninstallation of package t est g.
This example displays the uninstallation of all configured packages.
all Uninstalls all packages.
name Uninstalls a specified package. The following parameter is accepted:
packageDefines the name of the package being uninstalled.
( Dub) >conf i g
( Dub) conf i g pkgs>uni nst al l
( Dub) conf i g pkgs uni nst al l
- >name t est g
Package t est g uni nst al l ed
( Dub) conf i g pkgs uni nst al l
- >
( Dub) >conf i g
( Dub) conf i g pkgs>uni nst al l al l
Package j obt est ut i l s uni nst al l ed.
Package t est g uni nst al l ed.
Package t est h uni nst al l ed.
Package t est j uni nst al l ed.
Configuration Commands: config pkgs uninstall
2-153
See Also
config pkgs install
show pkgs
Configuration Commands: config profile
2-154
configprofile
Description
This command configures a user-defined command profile and adds or excludes
commands for that profile.
Formats
config profile profile_name
copy { management | r est r i ct ed | st at us | super vi sor |
user_defined }
exclude command_id
include command_id
no { 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.
r est r i ct edCopies the restricted-level profile.
st at usCopies the status-level profile.
super vi sor Copies the supervisor-level profile.
user_definedCopies a user-defined profile.
exclude Excludes a command from a user-defined profile. The following
command_idDefines 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 A: Command
Identifications.
include Includes a command in a user-defined profile. The following
command_idDefines 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 A: Command
Identifications.
Configuration Commands: config profile
2-155
supervisor
Examples
The following settings are configured for profile Super St at us:
Included command sets / conf i g/ cont r ol l er / et h and
/ conf i g/ i nt er f ace/ et h
Copied profile st at us
Privilege level 3.
See Also
show 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
levelDefines the privilege level. Valid values are 2 to 14 for
user-defined privilege levels. System privilege levels are:
0 is for st at us
1 is for management
15 is for super vi sor .
profile_name Defines the new profile name.
( Dub) >conf i g
( Dub) conf i g>pr of i l e Super St at us
( Dub) conf i g pr of i l e Super St at us>i ncl ude / conf i g/ cont r ol l er / et h
( Dub) conf i g pr of i l e Super St at us>i ncl ude / conf i g/ i nt er f ace/ et h
( Dub) conf i g pr of i l e Super St at us>copy st at us
( Dub) conf i g pr of i l e Super St at us>pr i v- l vl 3
( Dub) conf i g pr of i l e Super St at us>
Configuration Commands: config remote-access
2-156
configremote-access
Description
This 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.
Formats
config remote-access
http { def aul t por t | di sabl e | enabl e | por t port }
https { def aul t por t | di sabl e | enabl e | por t port }
ssh-sftp { di sabl e | enabl e }
telnet-ftp { def aul t por t | di sabl e | enabl e | por t 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:
def aul t Resets the port number to its default value.
di sabl eDisables the remote access protocol. This protocol is
enabled by default.
enabl eEnables the remote access protocol.
por t Configures the HTTP port number. This value defines the
TCP port number at which web browsers access the web server.
portDefines 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:
def aul t Resets the port number to its default value (443).
di sabl eDisables the remote access protocol.
enabl eEnables the remote access protocol. This protocol is
por t Configures the HTTPS port number. This value defines
the TCP port number at which web browsers access the web
server.
portDefines the port number for the HTTPS server. Valid
range is 443 or 1024 to 65535. The default port number is 443.
2-157
Examples
The 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:
Note: The disable fails if there is no other enabled remote

access protocol.
telnet-
ftp
Specifies Telnet and FTP remote access protocols. These protocols
are enabled by default. The following parameters are accepted:
def aul t Resets the port number to its default value.
Note: The disable fails if there is no other enabled remote

access protocol.
por t Configures the Telnet and FTP port numbers.
telnet_portDefines the port number for the Telnet server.
Valid values are 23 or 1024 to 65535.
ftp_portDefines the port number for the FTP server. Valid
values are 21 or 1024 to 65535.
( Dub) >conf i g
( Dub) conf i g>r emot e- access
( Dub) conf i g r emot e- access>ssh- sf t p enabl e
( Dub) conf i g r emot e- access>t el net - f t p enabl e
( Dub) conf i g r emot e- access>t el net - f t p por t 3001 5001
( Dub) conf i g r emot e- access>ht t p por t 12450
( Dub) conf i g r emot e- access>
2-158
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 Also
show remote-access
( Dub) >conf i g
( Dub) >conf i g r emot e- access
( Dub) conf i g r emot e- access> ht t ps enabl e
( Dub) conf i g r emot e- access ht t ps def aul t por t
( Dub) conf i g r emot e- access>
( Dub) >conf i g
( Dub) conf i g>r emot e- access
( Dub) conf i g r emot e- access>ssh- sf t p
( Dub) conf i g r emot e- access ssh- sf t p
- >di sabl e
[ REMM0002] At l east one r emot e access pr ot ocol must be enabl ed at al l t i mes.
( Dub) conf i g r emot e- access ssh- sf t p
- >
Configuration Commands: config response
2-159
configresponse
Description
These 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.
Formats
config response response_name
description text
no description
For deleting a response:
config no response { response_name | * }
Parameters
Examples
This example displays the configuration of response door OpenTl 1Al mwith
description Door open TL1 al ar m.
response_name Defines the name of the response being configured.
description Configures a description for a response. The following
textDefines a description for a response.
* Deletes all configured responses.
( Dub) >conf i g
( Dub) conf i g>r esponse door OpenTl 1Al m
( Dub) conf i g r esponse door OpenTl 1Al m>descr i pt i on Door open TL1 al ar m
( Dub) conf i g r esponse door OpenTl 1Al m>
Configuration Commands: config response
2-160
See Also
config response content
show responses
Configuration Commands: config response content
2-161
configresponsecontent
Description
These commands configure response content settings.
Formats
config response response_name content responder
close [ dur at i on period ]
critical [ message message_text ]
disable
enable
informational [ message message_text ]
interval [ dur at i on period ]
major [ message message_text ]
minor [ message message_text ]
normal [ message message_text ]
open [ dur at i on period ]
restart-timer
stop-timer
warning [ 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:
dur at i onSpecifies that the relay output will close for a set
length of time.
periodDefines 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:
messageConfigures an alarm entry response and the
associated alarm message text.
message_textDefines the text that describes why the
alarm was activated. Maximum length is 128 characters.
2-162
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:
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
minor Updates the state of the alarm entry to minor. Valid responder is
2-163
normal Updates the state of the alarm entry to normal. Valid responder
is alarm-entry. The following parameters are accepted:
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 8 on page 2-164.
response_name Defines the name of the response being configured. Maximum
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 . l og. 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:
2-164
Table 8 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 | temperature }
unit
Defines the peripheral unit number. Valid values are 0 to
12.
point
Defines the analog input point number within the unit.
power
Specifies the power monitor, which is an analog input that
is dedicated to monitoring the units 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.
ethernet
instance
Specifies an Ethernet controller as the responder. Valid values
for instance are Ethernet port values 1 to 4.
2-165
input instance Specifies a digital input as the responder. Valid value for
instance is:
unit/point
unit
12.
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
unit/point
unit
12.
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 8 Valid Responders (Continued)
Responder Description (Continued)
2-166
Examples
This example displays the configuration of close response l at chAl mfor out put 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:
Defines the SSH port number and optional IP address for
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
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 8 Valid Responders (Continued)
Responder Description (Continued)
2-167
This example displays the configuration of response t i meSt ar t for timer
cal l At t empt . The timer runs once and then disappears.
configresponsecontentconnect
Description
These commands configure responses that create mediation connections between
responders and destinations.
Formats
config response response_name content responder connect
break
dest destination
dest-data dest_text
inactivity interval
no { dest | dest-data | inactivity | source-data |
suppress-inactivity-disc }
source-data source_data_text
suppress-inactivity-disc
Parameters
( Dub) >conf i g
( Dub) conf i g>r esponse l at chAl m
( Dub) conf i g r esponse l at chAl m>cont ent
( Dub) conf i g r esponse l at chAl mcont ent
- >out put 1/ 4
( Dub) conf i g r esponse l at chAl mcont ent out put 1/ 4
- >cl ose
( Dub) conf i g r esponse l at chAl mcont ent out put 1/ 4
- >
( Dub) >conf i g
( Dub) conf i g>r esponse t i meSt ar t
( Dub) conf i g r esponse t i meSt ar t >cont ent
( Dub) conf i g r esponse t i meSt ar t cont ent
- >t i mer cal l At t empt
( Dub) conf i g r esponse t i meSt ar t cont ent t i mer cal l At t empt
- >st ar t - t i mer
( Dub) conf i g r esponse t i meSt ar t cont ent t i mer cal l At t empt st ar t - t i mer
- >t i mer - l i f e one- shot
( Dub) conf i g r esponse t i meSt ar t cont ent t i mer cal l At t empt st ar t - t i mer
- >
response_name Defines the name of the response being configured.
2-168
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 8 on page 2-164.
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
destinationDefines the destination that is
the receiving end-point for the connection. For
more information on available destinations, refer
to Table 10 on page 2-170.
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
destination_textDefines 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.
2-169
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
intervalDefines 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 strings
primary use is to provide a per-call modem dial
string. The following parameter is accepted:
source_data_textDefines 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.
2-170
Table 9 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
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
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 10 Valid Destinations
Destination Description
script
instance
Specifies a script as the receiving end-point for the connection.
The script instance has the following format:
job_name listener
job_name defines the name of an existing job in which the
script resides.
listener defines the listener for incoming connections.
This name is defined by the job's script.
serial
instance
Specifies an asynchronous serial controller as the receiving
end-point for the connection. Valid values for instance are
asynchronous ports 1 to 4 and modem.
2-171
Examples
The following settings are configured for response t el net Connect i on:
Responder t el net 50001
Enabled br eak propagation
Binary transmission mode
No disconnect when the inactivity timer expires.
See Also
config response
config response content connect
show responses
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) >conf i g
( Dub) conf i g>r esponse t el net Connect i on
( Dub) conf i g r esponse t el net Connect i on>cont ent
( Dub) conf i g r esponse t el net Connect i on cont ent
- >t el net 50001
( Dub) conf i g r esponse t el net Connect i on cont ent t el net 50001
- >connect
( Dub) conf i g r esponse t el net Connect i on cont ent t el net 50001 connect
- >br eak
- >opt i ons - b
- >suppr ess- i nact i vi t y- di sc
- >
Table 10 Valid Destinations (Continued)
Destination Description (Continued)
Configuration Commands: config sitebus
2-172
configsitebus
Description
These commands configure devices connected to the SiteBus terminals on an RMB
peripheral unit.
Formats
config sitebus name
description text
id hex_id
type 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
textDefines a text description for a SiteBus device.
id Configures the hexidecimal ID for a SiteBus device. The following
hex_idDefines 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.
Configuration Commands: config sitebus
2-173
Examples
The following SiteBus device settings are configured:
Device name t emp1
Device ID 280000561000F1
Device type sbTemp
Device description Heat i ng cor e t emp pr obe
See Also
show sitebus
type Configures the device type for a SiteBus device. The following
device_typeDefines 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 2.0x is sbTemp. Points created for the sbTemp
device type include t emper at ur eF and t emper at ur eC.
( Dub) >conf i g
( Dub) conf i g>si t ebus t emp1
( Dub) conf i g si t ebus t emp1>
( Dub) conf i g si t ebus t emp1>i d 280000561000F1
( Dub) conf i g si t ebus t emp1>t ype sbTemp
( Dub) conf i g si t ebus t emp1>descr i pt i on Heat i ng cor e t emp pr obe
( Dub) conf i g si t ebus t emp1>
Configuration Commands: config snmp
2-174
configsnmp
Description
These commands configure SNMP settings for Remote RMM-1400.
Formats
config snmp
auth-trap { di sabl e | enabl e }
community community { v1 | v2 } { r eadonl y | r eadwr i t e }
host ip_address [ port [ community [ v1 | v2 | v2- i nf or m] ] ]
trap-queue { di sabl e | enabl e | pr i or i t y oid priority_level }
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 | * }
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:
di sabl eDisables the transmission of authentication failure
traps.
enabl eEnables the transmission of authentication failure
traps.
community Configures community strings accepted by the SNMP agent. SNMP
community strings provide embedded password access to MIB
contents. The following parameters are accepted:
communityDefines the community string.
v1Sets the SNMP community type as version 1.
r eadonl yPermits read only access to all objects in the MIB.
r eadwr i t ePermits read and write access to all objects in the
MIB.
2-175
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_addressDefines the management station IP address.
portDefines the management station port number. The default
port number is 162.
communityDefines the community string. The default
Community string publ i c.
v2Sets the SNMP community type as version 2. This is the
default SNMP community type.
v2- i nf or mSpecifies that an SNMP version 2 inform request is
sent to this management station.
no Negates an SNMP configuration command.
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:
di sabl eDisables the SNMP trap queue. The queue is
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.
enabl eSaves SNMP traps in a queue if the connection to the
host is down.
oidSpecifies 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_levelSpecifies the priority for this trap OID. In
order to add new traps when the trap queue is full, Remote drops
the oldest, lowest-priority traps from the queue. Valid values are
hi ghest , hi gh, nor mal , l ow, and l owest .
Note: A priority level on an alarm table entry will override any

priority on the OIDs used for alarm table traps.
2-176
Examples
The following SNMP settings are configured:
Community string mycomm
SNMP community type v1
Read and write access to MIB objects (r eadwr i t e)
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 i nf or m
r equest host:
The following example configures traps from OID . 1. 3. 6. 1. 6. 4. 1. 1. 3. 1 to have
hi gh priority:
See Also
show snmp
( Dub) >conf i g
( Dub) conf i g>snmp
( Dub) conf i g snmp>communi t y mycommv1 r eadwr i t e
( Dub) conf i g snmp>host 10. 40. 56. 3 21 mycomm
( Dub) conf i g snmp>aut h- t r ap enabl e
( Dub) conf i g snmp>t r ap- queue enabl e
( Dub) conf i g snmp>
( Dub) >conf i g
( Dub) conf i g snmp>host 10. 40. 56. 3 21 mycommv2- i nf or m
( Dub) >conf i g
( Dub) conf i g snmp>t r ap- queue
( Dub) conf i g snmp t r ap- queue>pr i or i t y . 1. 3. 6. 1. 6. 4. 1. 1. 3. 1 hi gh
( Dub) conf i g snmp t r ap- queue>
Configuration Commands: config timeout
2-177
configtimeout
Description
This 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.
Formats
config timeout minutes
config default timeout
config no timeout
Parameters
Command Defaults
10 minutes
Examples
This 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) >conf i g
( Dub) conf i g>t i meout 20
( Dub) conf i g>
Configuration Commands: config timeout
2-178
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 Also
show timeout
( Dub) >conf i g
( Dub) conf i g>def aul t t i meout
( Dub) conf i g>
( Dub) >conf i g
( Dub) conf i g>no t i meout
( Dub) conf i g>
Configuration Commands: config use-wizard
2-179
configuse-wizard
Description
The 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.
Formats
config 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
debugDisplays 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 devices IP
address, subnet mask, and default gateway
Configuring the devices SNMP settings
Configuring login accounts
Configuring a wireless WAN connection.
execution.
Configuration Commands: config use-wizard
2-180
Examples
The following example displays the i ni t set up 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:
execution.
debug Displays debugging information during wizard execution.
( Dub) >conf i g
( Dub) conf i g>use- wi zar d i ni t set up
- - - - - - - - - - - - - - - - - - - - -
- - - - - i ni t set up - - - - -
- - - - - - - - - - - - - - - - - - - - -
Thi s wi zar d conf i gur es i ni t i al connect i vi t y set t i ngs.
An ast er i sk ( *) i n a sel ect i on l i st denot es t he def aul t val ue.
Ct r l - c abor t s t he wi zar d.
NOTE:
Thi s wi zar d pr ovi des onl y basi c conf i gur at i on. For addi t i onal
conf i gur at i on opt i ons, consul t t he command r ef er ence gui de.
Host name of t hi s devi ce:
Configuration Commands: config users
2-181
configusers
Description
These commands:
Add new users
Delete existing users
Reset existing users
Change passwords for existing users
Optionally enable a strong password
Note: Remote RMM-1400 allows for the configuration of up to 20 users.

Formats
config users
add username profile password confirm_password
delete username
password username
strong-password { enabl e | di sabl e }
For resetting users:
config default users
Parameters
add Adds a new user to the Remote RMM-1400 configuration. The
usernameDefines the name of the new user. The length for a
user name is 2 to 20 alphanumeric characters. This value is case-
sensitive.
profileDefines a profile to assign to the new user. A profile
gives the user designated permissions in Remote RMM-1400. User
profiles can be st at us, management , super vi sor , or r est r i ct ed.
passwordDefines 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_passwordRequires the user to re-enter the assigned
password.
2-182
Table 11 lists available user profiles and permission levels for Remote RMM-1400.
Command Defaults
Username admi n
Password passwor d
delete Deletes a user from the Remote RMM-1400 configuration. The
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:
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.
enabl eEnables the strong password feature.
di sabl eDisables the strong password feature. This feature is
default Resets the primary user to default user ai and deletes all other users
from Remote RMM-1400.
Table 11 User Profiles and Permission Levels
User Profile Permission
st at us 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.
super vi sor Provides permission to all show commands, config commands,
utility commands, and most diag commands.
r est r i ct ed Allows access to the terminal server, but restricts CLI activity to
logging out only. No files are available for retrieval using FTP.
2-183
supervisor
Examples
This example displays enabling the strong password feature.
This example displays the addition of a user with the name j ef f and profile st at us.
Note that the initial password entered did not meet the criteria for the strong password
feature.
This example displays the deletion of the user j ohndoe from Remote RMM-1400.
This example displays the configuration of a new password for user br b22.
This example displays the resetting of the default username and password.
( Dub) >conf i g
( Dub) conf i g>user s
( Dub) conf i g user s>st r ong- passwor d enabl ed
( Dub) conf i g user s>
( Dub) conf i g user s>add j ef f st at us
Pl ease ent er t he new passwor d. *********
Pl ease conf i r mt he new passwor d. *********
[ ATHM0029] Passwor d must cont ai n at l east one char act er f r omt hr ee of t he
f ol l owi ng t ypes: upper - case, l ower - case, numer i cal , and speci al
punct uat i on.
( Dub) conf i g user s>add j ef f st at us
Pl ease ent er t he new passwor d. *********
Pl ease conf i r mt he new passwor d. *********
( Dub) >conf i g
( Dub) conf i g user s>del et e j ohndoe
( Dub) >conf i g
( Dub) conf i g user s>passwor d br b22
Pl ease ent er t he new passwor d. ******
Pl ease conf i r mt he new passwor d. ******
( Dub) >conf i g
( Dub) conf i g>def aul t user s
( Dub) conf i g>
2-184
See Also
password
show users
3-1
3
ShowCommands
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.
The show Command Overview
List of Show Commands
Show Commands: The show Command Overview
3-2
TheshowCommandOverview
Show 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.
Show Commands: List of Show Commands
3-3
ListofShowCommands
The 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 di spl ay i n CLI ]
Commands
act i ons Di spl ays a summar y f or al l conf i gur ed
act i ons or a det ai l ed summar y f or a
speci f i c act i on.
al ar m- ent r i es Di spl ays al ar ment r i es.
audi t ( +) Di spl ays r epor t s of act i ons, event s, and
r esponses t hat ar e mi ssi ng associ at i ons.
banner Di spl ays t he conf i gur ed banner .
cl ock Di spl ays t he cl ock t i me and dat e
set t i ngs.
compact - f l ash Di spl ays compact f l ash si ze.
conf i g- f i l e Di spl ays a conf i gur at i on or pat ch
connect i ons Di spl ays summar y i nf or mat i on f or al l
medi at i on connect i ons or a det ai l ed
summar y f or a speci f i c medi at i on
connect i on.
cont r ol l er s Di spl ays i nf or mat i on f or conf i gur ed
cont r ol l er s.
cor r el at i ons Di spl ays a summar y of al l conf i gur ed
event cor r el at i ons or a det ai l ed summar y
f or a speci f i c event cor r el at i on.
debuggi ng( +) Di spl ays i nf or mat i on r el at i ng t o t he
st at us of debuggi ng on t he devi ce.
dhcp- r el ay Di spl ays t he boot p/ DHCP r el ay
conf i gur at i on.
dhcp- ser ver Di spl ays t he DHCP ser ver conf i gur at i on.
di scr et e( +) Di spl ays conf i gur ed di scr et e poi nt s.
event s Di spl ays a summar y of al l conf i gur ed
event s or a det ai l ed summar y f or a
speci f i c event .
expansi on- i mages Di spl ays t he per i pher al expansi on i mage
header s.
i nt er f aces Di spl ays i nf or mat i on f or conf i gur ed
i nt er f aces.
i nvent or y Di spl ays har dwar e i nvent or y.
- - Mor e- - [ pr ess space bar t o cont i nue l i st ]
Show Commands: List of Show Commands (continued)
3-4
ListofShowCommands(continued)
i p( +) Di spl ays I P set t i ngs.
i pt abl es( +) Di spl ays i pt abl es conf i gur at i on
i nf or mat i on.
j obs( +) Di spl ays j ob i nf or mat i on.
l i st ener s Di spl ays t he dest i nat i ons t hat ar e
l i st eni ng f or medi at i on connect i ons i n
t he syst em.
l og- f i l e Di spl ays t he cur r ent debug l og f i l e.
meas- t abl e Di spl ays t he at t r i but es of t he
measur ement t abl e.
medi at i on( +) Di spl ays medi at i on conf i gur at i on.
nt p Di spl ays t he NTP conf i gur at i on.
per i pher al s Di spl ays t he per i pher al s t hat have been
di scover ed or conf i gur ed
pkgs( +) Di spl ays package i nf or mat i on.
pr oduct Di spl ays pr oduct i nf or mat i on.
pr of i l es Di spl ays al l pr of i l es.
pydoc( +) Di spl ays Pyt hon l i br ar y document at i on.
r emot e- access Di spl ays t he r emot e access conf i gur at i on.
r esour ce- t r acki ng Di spl ays i t ems t hat have been mar ked f or
r esour ce usage t r acki ng.
r esponses Di spl ays a summar y of al l conf i gur ed
r esponses or a det ai l ed summar y f or a
speci f i c r esponse.
conf i gur at i on.
si t ebus Di spl ays t he si t ebus devi ces t hat have
been di scover ed or conf i gur ed.
snmp( +) Di spl ays SNMP conf i gur at i on i nf or mat i on.
t est Di spl ays t est set t i ngs.
t i meout Di spl ays t he sessi on t i meout .
t i mer s Di spl ay t i mer s.
user s Di spl ays al l user s.
ver si on Di spl ays t he cur r ent l y i nst al l ed sof t war e
ver si on.
( Dub) show
Show Commands: show actions
3-5
showactions
Description
This command displays a basic summary of all actions or a detailed summary for a
specific action.
Formats
show actions [ action_name ]
Parameters
status, management, supervisor
Examples
This 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>act i ons
Name Event Name Response Name Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
door OpenAl m door Open door Open332Al m Door open al ar ma. . .
wat er Lvl Al m wat er Lvl Hi gh wat er Lvl 332Al m Wat er l evel al ar m
( Dub) show>
Column Description
Descr i pt i on 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.
3-6
This example displays a detailed summary of action door OpenAl m.
( Dub) >show
( Dub) show>act i ons door OpenAl m
Act i on Name : door OpenAl m
Act i on Descr i pt i on : Door open al ar mact i on
Event Name : door Open
Event Descr i pt i on : Door open i ndi cat or
Event Or i gi nat or : i nput 1/ 1
Event Type : open
Response Name : door Open332Al m
Response Descr i pt i on : Door open al ar mr esponse
Response Responder : snmpne 2
Response Type : snmpal ar m
Response Par amet er s :
al mcde=CR
msg=REPT ALM ENV
t ext bl k=poi nt 1: CR, DOOR
( Dub) show>
Column Description
Act i on
Descr i pt i on
Displays the description for a specified action.
Act i on Name Displays the name of a specified action.
Event
Descr i pt i on
Displays a description for the displayed event.
Event Name Displays the name of an event associated with the specified
action.
Event Or i gi nat or Displays an event originator, which generates an event.
Event Type Displays the event type for the displayed event.
Response
Descr i pt i on
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
Par amet er s
Displays the configured response parameters for various
types of alarm responses. For more information about
response parameters, refer to the response configuration
commands.
Response
Responder
Displays a response responder, which processes a
response.
3-7
See Also
config action
config event
config response
Response Type Displays a response type.
Column Description (Continued)
Show Commands: show alarm-entries
3-8
showalarm-entries
Description
This command displays all central alarm table entries, an individual alarm table entry,
or all alarm table entries with a specified severity level.
Formats
show alarm-entries
[ name alarm | severity severity_level ]
[ nopage ]
Parameters
name Initiates the selection of an alarm name from the central alarm table.
alarmDefines 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
severity_levelDefines the alarm severity level for which
associated alarm entries will be displayed.
3-9
Examples
This example displays the first page of central alarm table entries.
( Dub) >show
( Dub) show>al ar m- ent r i es
Name St at e Tr ap Raw Cur r ent al ar mmessage
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1_1 i nf or mat i o + - of f l i ne
1_humi di t y i nf or mat i o + - humi di t y of f l i ne
1_t emp i nf or mat i o + - t emp of f l i ne
i nput 1_1 nor mal + - - - -
i nput 1_2 nor mal + - - - -
i nput 1_3 nor mal + - - - -
i nput 1_4 nor mal + - - - -
i nput 1_5 nor mal + - - - -
i nput 1_6 nor mal + - - - -
i nput 1_7 nor mal + - - - -
i nput 1_8 nor mal + - - - -
i nput 1_9 nor mal + - - - -
i nput 1_10 nor mal + - - - -
i nput 1_11 nor mal + - - - -
i nput 1_12 nor mal + - - - -
i nput 1_13 nor mal + - - - -
i nput 1_14 nor mal + - - - -
i nput 1_15 nor mal + - - - -
i nput 1_16 nor mal + - - - -
i nput 1_17 nor mal + - - - -
i nput 1_18 nor mal + - - - -
- - Mor e- -
3-10
This example displays specific information for alarm table entry i nput 0_1.
( Dub) >show
( Dub) show>al ar m- ent r i es name i nput 1_2
Name - i nput 1_2
St at e - nor mal
Cur r ent Message -
Descr i pt i on -
Naggi ng I nt er val - 0
Naggi ng Level - maj or
Tr ap - enabl ed
Tr ap Pr i or i t y - di sabl ed
Raw - di sabl ed
Cat egor y -
NE Name -
Or i gi nat or - i nput 1/ 2
Al ar mAct i ons:
Sever i t y Tr i gger Message
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
nor mal open i nput 1/ 2 open
cr i t i cal cl ose i nput 1/ 2 cl ose
( Dub) show>
Display Item Description
Cat egor y Displays a category for an alarm entry. The category associates
the alarm table entry with a specific application or business task.
Cur r ent
Message
Displays the text message associated with the current state of
the alarm.
Descr i pt i on Displays the text description for the alarm entry.
Message Displays the text string associated with the alarm.
Naggi ng
I nt er val
Displays the time between occurrences of sending the alarm to
all enabled protocols.
Naggi ng Level Displays the severity level at which the alarm gets sent
repeatedly. Possible values are:
nor mal
war ni ng
mi nor
maj or
cr i t i cal
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.
Or i gi nat or Displays the system component that generates the alarm.
3-11
See Also
config alarm-entry
Raw Displays the raw output status for an alarm entry as enabl ed or
di sabl ed. Raw output contains all of the data from the central
alarm table.
Sever i t y Displays the severity levels for associated alarm actions.
St at e Displays the alarm state. Possible states are:
nor mal
war ni ng
mi nor
maj or
cr i t i cal
Tr ap Displays the status of SNMP trap output for the specified alarm
entry as enabl ed or di sabl ed.
Tr ap Pr i or i t y Displays the priority level for traps from the specified alarm entry
as di sabl ed, hi ghest , hi gh, nor mal , l ow, or l owest .
Tr i gger Displays the type of event that will set off the alarm.
Display Item Description (Continued)
Show Commands: show audit
3-12
showaudit
Description
These commands display all actions, events, and responses that are missing data
required for proper operation.
Formats
show audit
actions
events
responses
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 events 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 responses content.
3-13
Examples
This example displays all audited actions:
( Dub) >show
( Dub) show>audi t
( Dub) show audi t >act i ons
Act i on : l at chOpen
I ssue : No r esponse conf i gur ed
Act i on : wat er Lvl
I ssue : No event conf i gur ed
Act i on : ai r Pr essur e
I ssue : Event e2 mi ssi ng
I ssue : Response r 2 mi ssi ng
Act i on : a1
I ssue : Dupl i cat e event / r esponse pai r s: ( a1, a2)
Act i on : a2
I ssue : Dupl i cat e event / r esponse pai r s: ( a1, a2)
( Dub) show audi t >
Act i on Displays an audited action.
I ssue Displays one of the following issues associated with a flagged
action:
No event conf i gur ed
No r esponse conf i gur ed
Event event name mi ssi ng
Response response name mi ssi ng
Dupl i cat e event / r esponse pai r s
3-14
This example displays all audited events.
This example displays all audited responses.
( Dub) >show
( Dub) show>audi t
( Dub) show audi t >event s
Event : e1
I ssue : Dupl i cat e cont ent : ( e1, e2)
Event : anal ogI nt er val
I ssue : Not used i n any act i ons
Event : t empHi gh
I ssue : Not f ul l y conf i gur ed
Event : e2
I ssue : Dupl i cat e cont ent : ( e1, e2)
Event Displays an audited event.
event:
Not used i n any act i ons
Not f ul l y conf i gur ed
Dupl i cat e cont ent .
( Dub) >show
( Dub) show>audi t
( Dub) show audi t >r esponses
Response : wat er Lvl Al m
I ssue : Not f ul l y conf i gur ed
Response : et her net Di sabl e
Response : door Open
I ssue : Dupl i cat e cont ent : ( door Open, connDest Dat a)
Response : connDest Dat a
I ssue : Dupl i cat e cont ent : ( door Open, connDest Dat a)
3-15
See Also
config action
response:
Not used i n any act i ons
Not f ul l y conf i gur ed
Dupl i cat e cont ent
Response Displays an audited response.
Show Commands: show banner
3-16
showbanner
Description
This command displays the Remote RMM-1400 banner.
Formats
show banner
Examples
This example displays the banner configuration for Remote RMM-1400 with the time
and date displaying with the text, Thi s i s my banner .
See Also
config banner
( Dub) >show
( Dub) show>banner
Thi s i s my banner .
\ d
\ t
( Dub) show>
Show Commands: show clock
3-17
showclock
Description
This command displays the configured date and time for Remote RMM-1400.
Formats
show clock
Examples
This 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>cl ock
Thu J an 14 16: 04: 50 EST 2010
Upt i me 2 days, 4: 48
The t i mezone i s named EST and has an of f set of - 05: 00 GMT.
Dayl i ght savi ngs t i me i s named EDT and usi ng def aul t U. S. r ul es.
Log t i mest amps ar e usi ng l ocal - t i me.
( Dub) show>
Show Commands: show compact-flash
3-18
showcompact-flash
Description
This command displays the flash memory size.
Formats
show compact-flash
Examples
This example displays the size of the compact flash memory.
( Dub) >show
( Dub) show>compact - f l ash
Compact Fl ash Si ze: 262144 kbyt es
( Dub) show>
Show Commands: show config-file
3-19
showconfig-file
Description
This 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.
Formats
show 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
r unni ngconf i g This configuration file contains the configuration that controls
current operation of Remote RMM-1400. For more
information, refer to running-config on page 5-34.
st ar t up- conf i g This configuration file contains the configuration at start-up
time for Remote RMM-1400.
3-20
Examples
This example displays all the available configuration files.
f act or y- conf i g This configuration file contains the factory defaults for
Remote RMM-1400.
Note: If f act or y- conf i g 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>conf i g- f i l e
f act or y- conf i g
r unni ngconf i g
st ar t up- conf i g
( Dub) show>
Table 1 Special Values for File Names (Continued)
Special File Name Description
3-21
This example displays configuration file st ar t up- conf i g.
See Also
copy
erase
running-config
( Dub) > show conf i g- f i l e st ar t up- conf i g
# Pr oduct : Remot e RMM- 1400
# Ver si on: 2. 00
# Cr eat ed: 2010- 11- 22, 15: 40: 55. 0, +0000
# User : j anedoe
# Boot l oader Ver si on: 1. 00
conf i g cl ock t i mezone EST - 05: 00
conf i g cl ock dayl i ght - savi ngs EDT
conf i g i p r out e def aul t 192. 168. 105. 1
conf i g i p r out e 10. 25. 2. 5/ 32 10. 39. 0. 1
conf i g i p r out e 10. 34. 0. 0/ 16 10. 39. 0. 1
conf i g i p r out e 10. 44. 0. 0/ 16 10. 39. 0. 1
conf i g i p r out e 64. 0. 0. 0/ 8 i nt er f ace ser i al modem
conf i g i p r out e 192. 168. 105. 0/ 25 192. 168. 105. 1
conf i g i p r out e 192. 168. 105. 128/ 25 192. 168. 105. 1
conf i g i p r out e 192. 228. 36. 48/ 32 i nt er f ace ser i al modem
conf i g i pt abl es - t f i l t er - N bad_st at e
conf i g i pt abl es - t f i l t er - N wan_i nput
conf i g i pt abl es - t f i l t er - N wan_i nput _SCD
conf i g i pt abl es - t f i l t er - N wan_out put
conf i g i pt abl es - t f i l t er - N wan_out put _SCD
conf i g i pt abl es - t f i l t er - N vpn_i nput
conf i g i pt abl es - t f i l t er - N vpn_i nput _SCD
conf i g i pt abl es - t f i l t er - N vpn_out put
conf i g i pt abl es - t f i l t er - N vpn_out put _SCD
- - Mor e- -
Show Commands: show connections
3-22
showconnections
Description
This 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.
Formats
show connections [ connection_point ]
Parameters
Examples
This example displays summary information for all mediation connections.
connection_point Defines a mediation connection end point or filter that is part
of a connection for which detailed information will be
displayed.
( Dub) >show
( Dub) show>connect i ons
scr i pt sdat a_gc sdat a_gcConnect or - > ser i al 2
t cp 10. 39. 63. 111: 60003: 4 - > ser i al 3
t cp 10. 39. 63. 111: 60004: 3 - > ser i al 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 t cp
IP address 10. 39. 63. 111
Port number 60003
Internal reference number 4
Accepting endpoint ser i al 3.
Show Commands: show connections
3-23
See Also
Show Commands: show controllers
3-24
showcontrollers
Description
This command displays configuration information for all Remote RMM-1400
controllers.
Formats
show controllers [ * ]
Parameters
Examples
This example displays the first screen of detailed information for all configured
Remote RMM-1400 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-37 and show controllers openvpn on page 3-32.
* Displays configuration information for all controllers.
( Dub) >show
( Dub) show>cont r ol l er s *
br i dge swi t ch syst em- name=br _swi t ch st at us=enabl ed oper - st at e=up
descr i pt i on=10/ 100 et her net swi t ch
et her net 1 syst em- name=mi i 0
st at us=enabl ed l i nk- st at e=up
admi n- speed=aut o oper - speed=10H
har dwar e- addr ess=00: 40: 72: 0F: A8: CA
def aul t - addr ess=00: 40: 72: 0F: A8: CA
pr oxy- ar p=di sabl ed
r esour ce- st at e=unassi gned
desc=Swi t ch por t
st at us=enabl ed l i nk- st at e=down
har dwar e- addr ess=00: 40: 72: 0F: A8: CB
def aul t - addr ess=00: 40: 72: 0F: A8: CB
desc=Swi t ch por t
- - Mor e- -
Show Commands: show controllers
3-25
See Also
config controller serial
show controllers serial
Show Commands: show controllers bridge
3-26
showcontrollersbridge
Description
This command displays configuration information for all Remote RMM-1400 bridge
controllers or for a specified Remote RMM-1400 bridge controller.
Formats
show controllers bridge
*
switch [ mac ]
Parameters
Examples
This example displays information for Remote RMM-1400 controller br i dge swi t ch.
* Displays configuration information for all controllers or for all
controllers of a specified type.
switch Displays bridge swi t ch configuration information along with cost
and priority information for the associated Ethernet and serial
controllers. The following parameter is accepted:
macDisplays all MAC addresses with their associated ports
for the specified bridge group.
( Dub) >show
( Dub) show>cont r ol l er s br i dge swi t ch
br i dge swi t ch syst em- name=br _swi t ch st at us=enabl ed oper - st at e=up
descr i pt i on=10/ 100 et her net swi t ch
( Dub) show>
3-27
This example displays MAC addresses with their associated ports on bridge swi t ch.
( Dub) >show
( Dub) show>cont r ol l er s br i dge swi t ch mac
Cont r ol l er MAC Addr ess I s Local ? Age( sec)
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
et her net 3 00: 01: 02: CC: 3E: 8F no 19
et her net 3 00: 04: 76: 9C: 39: 01 no 247
et her net 3 00: 04: 76: 9C: 3F: 07 no 19
et her net 3 00: 0B: DB: 69: 9F: 19 no 57
et her net 3 00: 0B: DB: 69: 9F: 4A no 19
et her net 3 00: 0B: DB: 7A: BA: 25 no 38
et her net 3 00: 0B: DB: 83: 76: 85 no 19
et her net 3 00: 0C: 29: B8: A6: FF no 57
et her net 3 00: 0F: 20: DB: 39: F5 no 38
et her net 3 00: 11: 43: 9C: B3: A7 no 19
et her net 3 00: 13: 72: 96: 2F: 65 no 171
et her net 3 00: 14: 22: 46: 2C: A6 no 133
et her net 3 00: 1A: A0: A1: 59: 37 no 0
et her net 3 00: 1A: A0: A1: 65: A9 no 247
et her net 3 00: 1C: 23: 01: E8: 1A no 133
et her net 3 00: 1C: 23: 21: 35: D9 no 209
et her net 3 00: 21: F7: 6D: 08: 00 no 0
et her net 3 00: 40: 72: 00: CD: 29 no 19
et her net 3 00: 40: 72: 00: E9: 01 no 38
et her net 3 00: 40: 72: 04: 7C: 34 no 133
et her net 3 00: 40: 72: 04: 7C: 67 no 38
et her net 3 00: 40: 72: 04: A0: DB no 0
et her net 3 00: 40: 72: 08: 3B: 62 no 19
et her net 3 00: 40: 72: 0B: E7: 32 no 0
et her net 3 00: 40: 72: 0D: 1C: 72 no 0
et her net 3 00: 40: 72: 0D: 1C: 8D no 0
et her net 3 00: 40: 72: 0E: 66: 34 no 0
et her net 3 00: 40: 72: 0E: 67: 10 no 171
et her net 3 00: 40: 72: 0E: 68: F4 no 0
et her net 1 00: 40: 72: 0E: 68: FD no 0
et her net 3 00: 40: 72: 0F: A8: A1 no 209
et her net 3 00: 40: 72: 0F: A8: FB no 209
et her net 3 00: 40: 72: 0F: A9: 19 no 171
et her net 3 00: 80: F0: 5F: 87: 7C no 19
( Dub) show>
3-28
Example Descriptions
The following table defines the display items that appear in the previous examples.
Display items are listed in alphabetical order.
See Also
show controllers
Age( sec) Displays the MAC address age in seconds.
Cont r ol l er Displays the controller associated with the MAC address.
descr i pt i on Displays the configured bridge controller description.
I s Local ? Displays if the MAC address and associated controller are local or
remote.
MAC Addr ess Displays a list of MAC addresses on the bridge controller.
oper - st at e Displays the operational state of the controller (the state the
controller is actually in) as up or down.
st at us Displays the controller state as enabl ed or di sabl ed.
syst em- name Displays the controllers system name (for example, br _swi t ch).
Show Commands: show controllers ethernet
3-29
showcontrollersethernet
Description
This command displays configuration information for all Remote RMM-1400 Ethernet
controllers or for a specified Remote RMM-1400 Ethernet controller.
Formats
show controllers ethernet [ * | port ]
Parameters
Examples
This example displays detailed information for controller et her net 2.
* Displays configuration information for all Ethernet controllers.
port Selects an Ethernet port number.
( Dub) >show
( Dub) show>cont r ol l er s et her net 2
har dwar e- addr ess=00: 40: 72: 0F: A8: CB
def aul t - addr ess=00: 40: 72: 0F: A8: CB
desc=Swi t ch por t
( Dub) show>
3-30
The following table defines the display items that appear in the previous example.
admi n- speed Displays the configured speed for the port. admi n-
speed=aut o means that the fastest port speed possible
is automatically negotiated between the controller and
the remote device.
def aul t - addr ess Displays the default hardware address, which represents
the controllers 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.
har dwar e- addr ess Displays the port hardware address, which represents
the controller's current MAC address.
l i nk- st at e Displays the state of the controllers link as up or down.
Note: When a port is di sabl ed (or enabl ed), its link

state may be listed as up or down. The l i nk-
st at e represents the presence of a cable
connection on the port, whereas the port st at us
represents the ports ability to pass data.
oper - speed Displays the speed that the port is currently using. This
value will always be the same as the admi n- speed value
(unless admi n- speed is aut o).
pr oxy- ar p Displays the status of proxy ARP on a Ethernet controller
as enabl ed or di sabl ed. Proxy ARP is the technique by
which a host answers ARP requests intended for
another machine.
r esour ce- st at e Displays if the Ethernet controller is assigned to be
tracked as a resource or not.
st at us Displays the controller state as enabl ed or di sabl ed.
3-31
See Also
show controllers
syst em- name Displays the controllers system name (for example,
hdl c0 or et h0_1).
Show Commands: show controllers openvpn
3-32
showcontrollersopenvpn
Description
This command displays configuration information for:
All OpenVPN controllers
A specified OpenVPN controller
Clients that are connected to an OpenVPN server.
Formats
show controllers openvpn [ name [ clients ] | * ]
Parameters
Examples
This example displays detailed information for OpenVPN controller cl i ent :
name Specifies the name of the OpenVPN controller.
clients Displays the clients that are connected to an OpenVPN server. This
parameter is only available for OpenVPN controllers in server mode. A
client name may be shown as ( unknown) if it has connected to the
server, but has not yet finished authentication. Typically, Remote RMM-
1400 will not be configured to run in server mode.
* Displays configuration information for all controllers or for all controllers
of a specified type.
( Dub) >show cont r ol l er s openvpn cl i ent
openvpn cl i ent syst em- name=ovpn_cl i ent
har dwar e- addr ess=00: FF: FC: CA: C0: DC
def aul t - addr ess=00: FF: FC: CA: C0: DC
mode=cl i ent ser ver =192. 228. 36. 48: 1194 ci pher =aes- 256
vpn- st at e=connect ed, Tue J an 12 15: 15: 52 EST 2010
cer t - subj ect =/ O=AI / CN=UMTS RMM- 1400
cer t - val i di t y- st ar t =Thu J an 7 00: 00: 00 EST 2010
cer t - val i di t y- end=Wed J an 7 00: 00: 00 EST 2015
vpn- r x- byt es=1035991 vpn- t x- byt es=1282010
( Dub) >
3-33
addr Displays the address and port number for a client
connected to the OpenVPN server.
cer t - subj ect Displays the common name (CN) of this network element.
cer t - val i di t y- end Displays the date and time at which this certificate token
will become invalid.
cer t - val i di t y-
st ar t
Displays the date and time at which this certificate token
became valid.
ci pher Displays the cryptographic cipher for encrypting packets on
an OpenVPN controller. One of the following options may
appear:
128- bi t Bl owf i sh, which is the fastest option. This
algorithm is the default.
256- bi t AES, which is the most secure, but slowest
option.
128- bi t AES, which is similar in strength to 128-bit
Blowfish algorithm, but slower.
connect ed Displays the time and date that a client was connected to
the OpenVPN server.
def aul t - addr ess Displays the default hardware address, which represents
the controllers 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.
har dwar e- addr ess Displays the port hardware address, which represents the
controller's current MAC address.
keep- al i ve-
i nact i ve
Displays the number of seconds that a session must be
inactive before a ping packet is transmitted.
3-34
keep- al i ve-
di sconnect
Displays the number of seconds that a peer can go without
receiving packets before it is considered disconnected.
l i nk- st at e Displays the state of the controllers link as up or down.
mode Displays if the OpenVPN controller is in cl i ent or ser ver
mode.
r x- byt es Displays the number of received bytes by a client
ser ver Displays the address and port number for an OpenVPN
server.
st at us Displays the controller or channel group state as enabl ed
or di sabl ed.
syst em- name Displays the controllers system name.
t x- byt es Displays the number of transmitted bytes by a client
vpn- r x- byt es Displays how many bytes have been received on the VPN.
3-35
vpn- st at e Displays the VPN state and connection date. One of the
following VPN states may appear:
i ni t i al The VPN daemon is running.
connect i ngThe VPN daemon is connecting to the
server (if running in client mode) or its local socket (if
running in server mode).
assi gni ng- I PThe VPN daemon is assigning an IP
address to the local network interface.
addi ng- r out esThe VPN daemon is adding routes to
the local device.
connect edThe VPN daemon is fully authenticated
and connected to the server (client mode) or able to
accept client connections (server mode).
r econnect i ngThe VPN daemon is attempting to
reconnect to the server (client mode).
exi t i ngThe VPN daemon is exiting.
wai t i ng- r esponseThe VPN daemon is waiting for a
response from the server (client mode).
aut hent i cat i ngThe VPN daemon is authenticating
with the server (client mode).
r et r i evi ngconf i gThe VPN daemon is retrieving
configuration from the server (client mode).
di sabl edThe VPN daemon controller is disabled
and the daemon is fully stopped.
wai t i ngconf i gThe VPN manager is waiting for
configuration information to be supplied.
wai t i ng- t okenThe VPN manager is waiting for a
valid certificate token to be installed.
wai t i ng- cr l The VPN manager is waiting for a valid
certificate revocation list (CRL) to be installed.
wai t i ng- daemonThe VPN manager is waiting for the
VPN daemon to be started.
wai t i ng- daemon- st opThe VPN manager is waiting
for the VPN daemon to be stopped.
daemon- st oppedThe VPN daemon has been
stopped.
vpn- r x- byt es Displays how many bytes have been transmitted on the
VPN.
3-36
See Also
show controllers
Show Commands: show controllers serial
3-37
showcontrollersserial
Description
This 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.
Formats
*
port
modem [ nai | namval ]
Parameters
Examples
This example displays the configuration information for asynchronous serial controller
ser i al 2.
* Displays configuration information for all serial controllers.
port Selects an asynchronous serial port number. Valid values for
Remote RMM-1400 are 1 to 4.
modem Displays serial controller information about the wireless 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 this command. For more information, see the config
controller serial command.
3-38
This example displays the configuration information for controller ser i al modem:
( Dub) >show
( Dub) show>cont r ol l er s ser i al 2
ser i al 2 st at us=enabl ed l i nk- st at e=up encapsul at i on= baud=9600 dat abi t s=8
st opbi t s=1 par i t y=none r esour ce- st at e=unassi gned
f l ow- cont r ol =none
l i nemode=r s232
di al - t i mer =1
i ni t - st r i ng=
connect - mode=
r t s- connect - mode=on
dt r - connect - mode=on
di sconnect - mode=
r t s- di sconnect - mode=of f
dt r - di sconnect - mode=of f
par i t y- er r or s=0
descr i pt i on=Asynchr onous por t
appl i cat i on=sour ce dest i nat i on
( Dub) show>
( Dub) >show
( Dub) show>cont r ol l er s ser i al modem
ser i al modemst at us=enabl ed l i nk- st at e=up encapsul at i on=ppp
i ni t - st r i ng=AT+CGDCONT=1, " I P" , " i sp. ci ngul ar " AT ATD*99***1#
r esour ce- st at e=assi gned
si gnal - st r engt h=f ai r ( - 88 dBm)
descr i pt i on=Wi r el ess Modem
ppp def aul t r out e=f al se
l ocal - met hod=none l ocal - i dent i t y=
r emot e- met hod=chap r emot e- i dent i t y=i sp@ci ngul ar gpr s. com
mr u=1520 mt u=1520
l cp- r equest s=di sabl ed
i nact i vi t y- t i meout =3
( Dub) show>
appl i cat i on 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.
3-39
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, act i vi t y, and no value.
dat abi t s Displays the number of databits in a data byte
transmitted or received by the controller.
def aul t r out e Displays the status of the default route option
as t r ue or f al se. When this option is t r ue,
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.
di al - t i mer 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.
di sconnect - 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, br eak,
and no value.
dt r - 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.
dt r - di sconnect - 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.
encapsul at i on Displays the encapsulation protocol for the
serial controller as PPP.
3-40
f l ow- cont r ol 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 har dwar e, xon/ xof f ,
and none. Hardware flow control uses
electrical signals to control the flow of data and
works for either binary or ASCII data.
xon/ xof f flow control uses the transmission of
special characters to control the flow of data
and works only for ASCII data (not for binary
data).
i nact i vi t y- t i meout 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.
i ni t - st r i ng Displays the connection initialization string for
the controller. Depending on the connection
settings, this string may or may not get sent to
the UART.
l cp- r equest s Displays the status of Remote RMM-1400s
ability to initiate or terminate a PPP link based
on the presence of LCP echo requests.
l i nemode Displays the linemode for the controller. The
linemode sets the electrical encoding for data
and the definition for control leads on a serial
link.
l i nk- st at e Displays the state of the controllers link as up
or down.
l ocal - i dent i t y 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.
3-41
l ocal - met hod 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).
mr u Displays the maximum number of data bytes
that can be received in a single PPP frame on
a serial port.
mt u Displays the maximum number of data bytes
that can be transmitted in a single PPP frame
on a WAN port.
par i t y 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.
par i t y- er r or s 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.
r emot e- i dent i t y 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.
r emot e- met hod 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).
r esour ce- st at e Displays if the serial controller is assigned to
be tracked as a resource or not.
r t s- 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.
3-42
See Also
show controllers
r t s- di sconnect - 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.
si gnal - st r engt h Displays the signal strength (in dBm) for the
modem along with an associated rating of
ver y poor , poor , f ai r , good, or excel l ent .
st at us Displays the controller state as enabl ed or
di sabl ed.
st opbi t s 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.
Show Commands: show correlations
3-43
showcorrelations
Description
This command displays the configured event correlations, including the current
expressions and associated values.
Formats
show correlations [ name | name_filter ]
Parameters
Examples
This 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
I nput , enter show correlations Input*.
( Dub) >show cor r el at i ons
Name Val ue Expr essi on Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Bot hCl osed f al se i nput 0/ 1 cl ose and i nput 0/ 2 Cor r el at i on f or t wo di scr et e
i nput s
Door Al ar ms f al se i nput 0/ 1 open and i nput 0/ 2 Cor r el at i on f or open door
al ar ms
( Dub) show>
Show Commands: show correlations
3-44
This example displays detailed information for correlation event Bot hCl osed.
See Also
config event
config correlation
( Dub) >show cor r el at i on Bot hCl osed
Name: Bot hCl osed
Expr essi on: i nput 0/ 1 cl ose and i nput 0/ 2 cl ose
Tr ue Dur at i on: 900
Fal se Dur at i on: 0
Eval uat i on: t r ue and t r ue = t r ue
Val ue: t r ue
Descr i pt i on: Cor r el at i on f or t wo di scr et e i nput s
( Dub) >
Descr i pt i on Displays the configured description for the event correlation.
Expr essi on Displays the configured expression for the event correlation.
Eval uat i on Displays the results of the expression evaluation.
Fal se
Dur at i on
Displays the number of seconds the expression must remain
false.
Tr ue Dur at i on Displays the number of seconds the expression must remain
true.
Val ue Displays the correlated value (response) that is reported to the
alarm table.
Show Commands: show debugging
3-45
showdebugging
Description
These commands display the status of event debugging on Remote RMM-1400.
Formats
show debugging
ethernet
level
mediation
openvpn
ppp
snmp
Parameters
Examples
This example displays the status of debug information logging for Ethernet controllers
and interfaces.
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.
( Dub) >show
( Dub) show>debuggi ng
( Dub) show debuggi ng>et her net
Debug cont r ol l er : enabl ed
Debug i nt er f ace: di sabl ed
( Dub) show debuggi ng>
Show Commands: show debugging
3-46
See Also
debug ethernet
debug level
debug mediation
debug openvpn
debug ppp
debug serial
debug snmp
Show Commands: show dhcp-relay
3-47
showdhcp-relay
Description
This command displays BOOTP/DHCP relay configuration information for Remote
RMM-1400.
Formats
show dhcp-relay
Examples
This example displays BOOTP/DHCP relay configuration information for Remote
RMM-1400.
See Also
config dhcp-relay
( Dub) >show
( Dub) show>dhcp- r el ay
boot p/ DHCP r el ay i s enabl ed
boot p/ DHCP r el ay ser ver s:
10. 40. 57. 50
10. 40. 2. 2
10. 40. 57. 60
( Dub) show>
boot p/ DHCP r el ay i s Displays one of the following:
enabl ed if BOOTP/DHCP relay is enabled on
Remote RMM-1400
di sabl ed if BOOTP/DHCP relay is disabled on
Remote RMM-1400
boot p/ DHCP r el ay
ser ver s
Displays the IP address of each BOOTP/DHCP server.
Show Commands: show dhcp-server
3-48
showdhcp-server
Description
This command displays DHCP server configuration information for Remote RMM-
1400.
Formats
show dhcp-server
Examples
This example displays DHCP server configuration information for Remote RMM-
1400.
( Dub) >show
( Dub) show>dhcp- ser ver
Admi n St at e: enabl ed
Br oadcast : enabl ed
Aut hor i t y: enabl ed
Conf i g f i l e:
Not e: User speci f i ed conf i gur at i on f i l es wi l l over i de conf i gur ed
set t i ngs.
I nt er f aces:
br i dge swi t ch
Subnet s:
192. 168. 10. 0/ 24 r ange=192. 168. 10. 2/ 192. 168. 10. 50 r out er =192. 168. 10. 1
def aul t - l ease=3600 max- l ease=28800
DNS:
Host s:
pr i v- l an MAC=00: 40: 72: 00: 99: 2A I P=0. 0. 0. 0
t ech- l apt op1 MAC=00: 60: 08: AD: 86: FF I P=198. 168. 10. 51
( Dub) show>
Admi n
St at e
Displays the status of the DHCP server on Remote RMM-1400.
Aut hor i t y One of the following appears:
enabl edThe DHCP server will respond to misconfigured
DHCP clients with DHCPNAK messages.
di sabl edThe DHCP server will not respond to misconfigured
DHCP clients with DHCPNAK messages.
3-49
Br oadcast One of the following appears:
enabl edThe DHCP server will send DHCP request
responses as broadcast packets.
di sabl edThe DHCP server will send DHCP request
responses as unicast packets.
Conf i g
f i l e
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).
Host s Displays the following for each host being served by the DHCP
server:
Hostname
Hardware address (MAC)
IP address (I P)
Notes: 0. 0. 0. 0 for MAC specifies that a hardware address has not

been configured.
0. 0. 0. 0 for I P specifies that an IP address has not been
configured.
I nt er f aces Displays the name of each Remote RMM-1400 interface on which
the DHCP server is operating.
Subnet s 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
(r ange)
Router IP address (r out er )
Default lease time (def aul t - l ease)
Maximum lease time (max- l ease)
IP addresses of all DNS servers (DNS)
Notes: 0. 0. 0. 0 for r ange specifies that an IP address range has

not been configured.
0. 0. 0. 0 for r out er specifies that a router IP address has
not been configured.
3-50
See Also
config dhcp-server
config dhcp-server host
config dhcp-server subnet
Show Commands: show discrete
3-51
showdiscrete
Description
These commands display information for all discrete points or for a specified discrete
point.
Formats
show 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.
*Displays information for all analog inputs for a specified
peripheral unit or all analog inputs.
analog_pointDefines the point number for the analog input
being displayed.
powerDisplays information for the power monitor, which is an
analog input that is dedicated to monitoring the units incoming
powerBDisplays information for the secondary power monitor,
which is an analog input that is dedicated to monitoring the unit's
secondary incoming power supply voltage.
powerMonDisplays information for the third power monitor, which
is an analog input used to monitor voltage for an external, isolated
power supply.
temperatureDisplays information for the temperature sensor on
an RMB peripheral unit, which is an analog input that is dedicated to
monitoring the ambient temperature.
humidityDisplays information for the humidity sensor on an RMB
peripheral unit, which is an analog input that is dedicated to
monitoring the ambient humidity.
unitDefines the peripheral unit number. Valid values are 0 to 12.

3-52
Examples
This 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_pointDefines the digital input number within the unit.

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_pointDefines the digital output number within the unit.

( Dub) >show
( Dub) show>di scr et e
( Dub) show di scr et e>anal ogs
I D St at e Resour ce St at e Val ue Mode I nt er val Descr i pt i on
0/ power di sabl e unassi gned 0. 1 V vol t age 0
0/ power B di sabl e unassi gned 41. 0 V vol t age 0
0/ power Mon di sabl e unassi gned 0. 4 V vol t age 0
1/ 1 di sabl e unassi gned 0. 00 V vol t age 0
1/ 5 di sabl e unassi gned 0. 006 mA cur r ent 0
1/ humi di t y di sabl e unassi gned 19 %RH 0
1/ t emper at ur e di sabl e unassi gned 27 C cel si us 0
( Dub) show di scr et e>
Column Description
Descr i pt i on Displays the configured descriptions for associated analog inputs.
I D Displays the unit numbers and point numbers for all analog inputs.
3-53
This example displays information for input anal og 1/ 5.
I nt er val Displays the configured analog input intervals. These values
represent the rate at which interval events are generated.
Mode Displays the input analog mode as cur r ent or vol t age input.
Resour ce
St at e
Displays whether an analog input has been assigned for resource
tracking (assi gned or unassi gned).
St at e Displays the status of all analog inputs as enabl e or di sabl e.
Val ue Displays the values and units of measurement for all analog
inputs. of f l i ne specifies that an analog input is associated with
an offline peripheral.
( Dub) >show
( Dub) show di scr et e>anal ogs 1/ 5
I D - 1/ 5
Descr i pt i on - Gas Sensor
St at e - enabl e
Resour ce St at e - unassi gned
Low Band - 8
Hi gh Band - 14
Hyst er esi s - 2
I nt er val - 17
Max Loop Val ue - 13
Mi n Loop Val ue - 5
Max Sensor Readi ng - 15
Mi n Sensor Readi ng - 7
Uni t s - mA
Mode - cur r ent
Val ue - 2. 00 mA
Descr i pt i on Displays the description for the analog input.
Hi gh Band Displays the high band level in sensor units for an analog
input.
Hyst er esi s Displays the hysteresis for an analog input. Hysteresis works
as a guard between the high and low band thresholds.
I D Displays the unit number and point number for the analog
input.
3-54
This example displays information for all digital outputs.
I nt er val 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 Val ue Displays the maximum voltage allowed (in milliamps) if the
specified analog input is operating in vol t age mode.
Max Sensor
Readi ng
Displays the sensor value associated with the maximum
current allowed on the analog input.
Mi n Loop Val ue Displays the minimum voltage allowed (in milliamps) if the
specified analog input is operating in vol t age mode.
Mi n Sensor
Readi ng
Displays the sensor value associated with the minimum
current allowed on the analog input.
Mode Displays the input analog mode as cur r ent or vol t age input.
Resour ce St at e Displays whether this input has been assigned for resource
tracking.
St at e Displays the status of the analog input as enabl e or di sabl e.
Uni t s Displays the configured unit of measurement.
Val ue Displays the value and unit of measurement for the analog
input. of f l i ne specifies that the analog input is associated
with an offline peripheral.
( Dub) >show
( Dub) show di scr et e>out put s
I D Resour ce St at e Val ue Descr i pt i on
1/ 1 unassi gned open Connect i on up
1/ 2 unassi gned cl osed
1/ 3 unassi gned cl osed
1/ 4 unassi gned open
3-55
This example displays information for di scr et e out put 1/ 4.
See Also
( Dub) >show
( Dub) show di scr et e>out put s 1/ 4
I D - 1/ 4
Descr i pt i on - Thi s i s t he out put poi nt f or a pr essur e gauge
Val ue - open
Column Description
Descr i pt i on Displays configured descriptions for all digital outputs or a specific
digital output.
I D Displays the unit numbers and digital output numbers for all digital
outputs or for a specific digital output.
Resour ce
St at e
Displays whether this input has been assigned for resource
tracking.
Val ue Displays values for all digital outputs or a specific digital output as
open, which indicates that an output has a current flow, cl osed,
which indicates that an output has no current flow, or of f l i ne,
which indicates that a digital output is associated with an offline
peripheral.
Show Commands: show events
3-56
showevents
Description
This command displays summarized information for all events or detailed information
for a specific event.
Formats
show events [ event_name ]
Parameters
Examples
This example displays summarized information for all events.
This example displays detailed information for event door Open.
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>event s
Name Or i gi nat or Type Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
door Open i nput 1/ 3 open Thi s event si gnal . . .
40010 t cp 40010 i ncomi ng- connect i o
t cp_ser i al _0001 t cp 60001 i ncomi ng- connect i o I P t o ser i al por t . . .
wat er Lvl i nput 1/ 4 cl ose Thi s event si gnal . . .
( Dub) show>
( Dub) >show
( Dub) show>event s door Open
Event Name : door Open
Event Descr i pt i on : Thi s event si gnal s when a door i s opened.
Event Or i gi nat or : i nput 1/ 3
Event Type : open
( Dub) show>
Show Commands: show events
3-57
See Also
config event
Descr i pt i on Displays all configured event descriptions.
Event
Descr i pt i on
Displays a description for a configured event.
Event Name Displays the name of a configured event.
Event
Or i gi nat or
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.
Or i gi nat or 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.
Show Commands: show expansion-images
3-58
showexpansion-images
Description
This command displays the expansion peripheral executable images and expansion
peripheral stage 2 bootloader images that are installed on Remote RMM-1400.
Formats
show expansion-images
3-59
Examples
This 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>expansi on- i mages
di scr et e- expansi on/ boot . i mg
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pr oduct : AI Expansi on- Shel f
Ver si on: 1. 60
Bui l d dat e: 2010- 07- 29, 16: 46: 54. 0, - 04: 00
Bui l d I D: 006
I mage t ype: AI ModExpan- Pr oduct i on
Pr oduct i on r el ease.
di scr et e- expansi on/ st age2boot . i mg
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Ver si on: 3. 10
Bui l d dat e: Thu J ul 6 13: 52: 11 EDT 2006
I mage t ype: AI 160- St age2Boot
ser i al 8- expansi on/ boot . i mg
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Ver si on: 1. 60
Bui l d dat e: 2010- 07- 29, 16: 46: 54. 0, - 04: 00
Bui l d I D: 006
ser i al 8- expansi on/ st age2boot . i mg
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Ver si on: 3. 11
bi st at e48- expansi on/ boot . i mg
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Ver si on: 1. 60
Bui l d dat e: 2010- 07- 29, 16: 46: 54. 0, - 04: 00
Bui l d I D: 006
bi st at e48- expansi on/ st age2boot . i mg
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Ver si on: 3. 11
f b64- expansi on/ boot . i mg
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Mor e- -
3-60
See Also
config peripheral
Display Items Description
Bui l d dat e Displays the build date.
Bui l d I D Displays the build ID number.
I mage t ype Displays the image type.
Pr oduct Displays the product associated with the software image.
Ver si on Displays the software image version number.
Show Commands: show interfaces
3-61
showinterfaces
Description
This command displays information and/or statistics for interfaces on Remote RMM-
1400.
Formats
show interfaces [ * ]
Parameters
Examples
This 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.
( Dub) >show
( Dub) show>i nt er f aces *
br i dge swi t ch syst em- name=br _swi t ch st at us=enabl ed l i nk- st at e=up
addr ess=10. 39. 90. 80/ 16
et her net 1 syst em- name=mi i 0 st at us=enabl ed l i nk- st at e=down
addr ess=1. 2. 3. 4/ 16
openvpn cl i ent syst em- name=ovpn_cl i ent st at us=enabl ed l i nk- st at e=up
addr ess=192. 168. 105. 110/ 24
ser i al modemname=ser i al modemsyst em- name=ppp_modemst at us=enabl ed
l i nk- st at e=up
addr ess=32. 178. 157. 24 poi nt opoi nt =10. 64. 64. 64
( Dub) >show
Show Commands: show interfaces
3-62
See Also
show interfaces bridge
show interfaces ethernet
show interfaces openvpn
show interfaces serial modem
Show Commands: show interfaces bridge
3-63
showinterfacesbridge
Description
This command displays information and/or statistics for the bridge interface on
Remote RMM-1400.
Formats
show interfaces bridge [ switch | * ]
Parameters
Examples
This example displays information and statistics for interface br i dge swi t ch and
statistics for all the ports included in br i dge swi t ch.
* Displays configuration information and statistics for the bridge
interface.
swi t ch Displays configuration information and statistics for the bridge
swi t ch interface.
( Dub) >show
( Dub) show>i nt er f aces br i dge swi t ch
br i dge swi t ch syst em- name=br _swi t ch
addr ess=10. 39. 90. 2/ 16
St at s: Byt es Packet s Er r or s Dr opped Over r un Fr ami ng
Rx 88466612 810824 0 0 0 0
Tx 5321340 44361 0 0 0 0
et her net 2
Rx 0 13835 0 0 0 0
Tx 0 27251 0 0 0 0
et her net 3
Rx 0 0 0 0 0 0
Tx 0 0 0 0 0 0
et her net 4
Rx 0 31076 0 0 0 0
Tx 0 48370 0 0 0 0
( Dub) >
3-64
Note: Statistics not collected by Remote RMM-1400 will display as zeroes.

addr ess Displays the IP address for the bridge interface.
l i nk- st at e Displays the state of the link (up or down) that connects the
interface to another device.
st at us Displays the status of the interface (enabl ed or di sabl ed).
syst em-
name
Displays the system name for the interface (for example,
br _swi t ch for interface bridge switch).
desc Displays a description for the interface.
Rx Byt es Displays the number of bytes received in error-free packets by the
interface.
RX Dr opped Displays the number of packets received by the interface that were
dropped.
Rx Er r or s Displays the number of errors that have occurred while receiving
data on the interface.
Rx Fr ami ng Displays the number of framing errors that have occurred while
receiving data on the interface.
Rx Over r un Displays the number of packets not received by the interface
because of a receiver overrun.
Rx Packet s Displays the number of error-free packets received by the
interface.
Tx Byt es Displays the number of bytes transmitted in error-free packets from
the interface.
Tx Dr opped Displays the number of packets that were dropped before they
could be transmitted by the interface.
Tx Er r or s Displays the number of errors that have occurred while transmitting
data from the interface.
Tx Fr ami ng Displays the number of framing errors that have occurred while
transmitting data from the interface.
Tx Over r un Displays the number of packets not transmitted from the interface
because of a transmitter overrun.
3-65
See Also
show interfaces
Tx Packet s Displays the number of error-free packets transmitted from the
interface.
Show Commands: show interfaces ethernet
3-66
showinterfacesethernet
Description
This command displays information and/or statistics for Ethernet interfaces on
Remote RMM-1400.
Formats
show interfaces ethernet [ * | port ]
Parameters
Examples
This 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>i nt er f aces et her net *
desc=Et her net i nt er f ace 2
addr ess=23. 67. 0. 4/ 16
Rx 0 0 0 0 0 0
Tx 0 0 0 0 0 0
addr ess=23. 68. 0. 3/ 16
secondar y- addr ess=23. 69. 0. 3/ 16
Rx 0 0 0 0 0 0
Tx 0 0 0 0 0 0
( Dub) show>
addr ess Displays the IP address for the interface.
desc Displays a description for the interface.
3-67
Rx Byt es Displays the number of bytes received in error-free packets by
the interface.
RX Dr opped Displays the number of packets received by the interface that
were dropped.
Rx Er r or s Displays the number of errors that have occurred while
interface.
secondar y-
addr ess
Displays each secondary IP address for the interface.
syst em- name Displays the system name for the interface (for example,
br _swi t ch for interface br i dge swi t ch).
Tx Byt es Displays the number of bytes transmitted in error-free packets
from the interface.
Tx Er r or s Displays the number of errors that have occurred while
Tx Over r un Displays the number of packets not transmitted from the
interface because of a transmitter overrun.
interface.
3-68
See Also
show interfaces
Show Commands: show interfaces openvpn
3-69
showinterfacesopenvpn
Description
This command displays information and/or statistics for OpenVPN interfaces on
Remote RMM-1400.
Formats
show interfaces openvpn [ name | * ]
Parameters
Examples
This 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>i nt er f aces openvpn *
openvpn cl i ent syst em- name=ovpn_cl i ent st at us=enabl ed l i nk- st at e=down
addr ess=12. 35. 64. 34/ 16
Rx 0 0 0 0 0 0
Tx 0 0 0 0 0 0
( Dub) show>
Rx Byt es Displays the number of bytes received in error-free packets by
the interface.
RX Dr opped Displays the number of packets received by the interface that
were dropped.
Show Commands: show interfaces openvpn
3-70
See Also
show interfaces
Rx Er r or s Displays the number of errors that have occurred while
interface.
from the interface.
Tx Over r un Displays the number of packets not transmitted from the
interface because of a transmitter overrun.
interface.
Show Commands: show interfaces serial modem
3-71
showinterfacesserialmodem
Description
This command displays information and/or statistics for serial interfaces on Remote
RMM-1400.
Formats
show interfaces serial modem
Examples
This example displays information and statistics for interface ser i al modem.

( Dub) >show
( Dub) show>i nt er f ace ser i al modem
ser i al modemname=ser i al modemsyst em- name=ppp_modem
addr ess=32. 178. 157. 24 poi nt opoi nt =10. 64. 64. 64
Rx 2000533 17288 0 0 0 0
Tx 2885841 20472 0 0 0 0
( Dub) show>
poi nt opoi nt Displays the remote device IP address for the interface.
Rx Byt es Displays the number of bytes received in error-free packets by the
interface.
RX Dr opped Displays the number of packets received by the interface that were
dropped.
Rx Er r or s Displays the number of errors that have occurred while receiving
data on the interface.
Show Commands: show interfaces serial modem
3-72
See Also
interface.
from the interface.
Tx Over r un Displays the number of packets not transmitted from the interface
because of a transmitter overrun.
interface.
Show Commands: show inventory
3-73
showinventory
Description
This command displays information for each existing Remote RMM-1400 hardware
component.
Formats
show inventory
Examples
This example displays information for each existing Remote RMM-1400 hardware
component.
( Dub) >show
( Dub) show>i nvent or y
Name Sl ot Manuf act ur er Par t no. Ser i al Manf . dat e Ver si on
KTX544 Kent r ox B544- 0. 0: 0 09460064 12/ 01/ 09 1. 00b001
( Dub) show>
Column Description
Manf . Dat e Displays the date the hardware component was manufactured.
Manuf act ur er Displays the name of the manufacturer of the hardware
component.
Name Displays hardware component KTX544, which is the Remote
RMM-1400 motherboard.
Par t no. Displays the part number for the hardware component.
Ser i al Displays the serial number for the hardware component.
Sl ot Not used.
Ver si on Displays the version of the stage 1 bootloader.
Show Commands: show ip
3-74
showip
Description
This command displays the configured IP settings for Remote RMM-1400.
Formats
show ip
arp [ conf i gur ed ]
domain-name
forward
name-server
route [ conf i gur ed ]
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:
conf i gur edDisplays 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. domai nname. 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.
conf i gur edDisplays static routes that were explicitly
configured by the user.
3-75
Examples
This 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. kent r ox. com.
This example displays the IP forwarding status as di sabl ed.
This example displays the configured primary and secondary DNS servers.
( Dub) >show
( Dub) show>i p
( Dub) show i p>ar p
I P Addr ess MAC Addr ess
10. 39. 0. 1 00: 21: F7: 6D: 08: 00
192. 168. 105. 1 00: FF: 5C: D6: EB: 9A
10. 39. 3. 102 00: 01: 02: CC: 3E: 8F
( Dub) show i p>
( Dub) >show
( Dub) show>i p
( Dub) show i p>domai n- name
Domai n Name: www. kent r ox. com
( Dub) show i p>
( Dub) >show
( Dub) show>i p
( Dub) show i p>f or war d
I P f or war di ng: di sabl ed
( Dub) show i p>
( Dub) >show
( Dub) show>i p
( Dub) show i p>name- ser ver
Pr i mar y DNS Ser ver : 10. 45. 73. 2
Secondar y DNS Ser ver : 12. 74. 56. 26
( Dub) show i p>
3-76
This example displays the contents of the IP routing table for Remote RMM-1400.
( Dub) >show
( Dub) show>i p
( Dub) show i p>r out e
Dest i nat i on Gat eway I nt er f ace Fl ags
0. 0. 0. 0/ 0 192. 168. 105. 1 openvpn cl i ent Up
10. 34. 0. 0/ 16 10. 39. 0. 1 br i dge swi t ch Up
10. 64. 64. 64/ 32 0. 0. 0. 0 ser i al modem Up Host
127. 0. 0. 0/ 8 0. 0. 0. 0 * Up Rej ect
127. 0. 0. 1/ 32 0. 0. 0. 0 l o Up Host
169. 254. 0. 0/ 16 0. 0. 0. 0 br i dge swi t ch Up
192. 168. 105. 0/ 24 0. 0. 0. 0 openvpn cl i ent Up
( Dub) show i p>
Column Description
Dest i nat i on Displays the destination network or destination host address. The
default destination is 0. 0. 0. 0 (or def aul t ).
Fl ags Displays flags that specify the status of routes. The following list
displays all possible flags:
Dynami c specifies that the route has been dynamically
installed by a daemon or a redirect.
Host specifies that the routes target is a host.
Modi f i ed specifies that a route has been modified by the
routing daemon or a redirect.
Rei nst at e specifies a reinstate route for dynamic routing.
Rej ect specifies a blocking route. This forces a route lookup
to fail.
St at i c specifies a static route.
Up specifies that the interface through which the route will send
packets is up.
Gat eway Displays the next-hop gateway address.
Note: In this sense, gateway is synonymous with router.

I nt er f ace Displays the interface to which packets to this destination are sent.
3-77
This example displays routes that have been manually configured by users for
Remote RMM-1400.
See Also
config ip
( Dub) >show
( Dub) show>i p
( Dub) show i p>r out e conf i gur ed
Dest i nat i on Gat eway/ I nt er f ace Pr ef er ence
def aul t openvpn cl i ent
10. 40. 65. 76/ 32 et her net 1 60
192. 168. 100. 0/ 25 192. 168. 100. 1 100
192. 168. 100. 128/ 25 192. 168. 100. 1 90
192. 167. 20. 0/ 24 10. 45. 0. 2 50
192. 167. 20. 0/ 24 ser i al modem 70
( Dub) show i p>
Show Commands: show iptables
3-78
showiptables
Description
This command displays either the current iptables configuration or detailed
information for each iptables rule.
Format
show iptables [ conf i gur at i on | det ai l s ]
Parameters
conf i gur at i on Displays the current iptables configuration.
det ai l s Displays detailed information for each IP table rule.
3-79
Examples
This example displays the current iptables configuration. All existing chains and rules
are listed for the f i l t er , mangl e, and nat iptables.
( Dub) >show
( Dub) show>i pt abl es
( Dub) show i pt abl es>conf i gur at i on
Tabl e nat
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chai n PREROUTI NG ( pol i cy ACCEPT)
Chai n POSTROUTI NG ( pol i cy ACCEPT)
Chai n OUTPUT ( pol i cy ACCEPT)
Tabl e f i l t er
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chai n I NPUT ( pol i cy ACCEPT)
- i l o - j ACCEPT
Chai n FORWARD ( pol i cy ACCEPT)
- d 127. 0. 0. 0/ 8 - j ACCEPT
Tabl e mangl e
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chai n PREROUTI NG ( pol i cy ACCEPT)
- i l o - j ACCEPT
Chai n I NPUT ( pol i cy ACCEPT)
- i l o - j ACCEPT
Chai n FORWARD ( pol i cy ACCEPT)
- d 127. 0. 0. 0/ 8 - j ACCEPT
Chai n POSTROUTI NG ( pol i cy ACCEPT)
- d 127. 0. 0. 0/ 8 - j ACCEPT
( Dub) show i pt abl es>
3-80
This example displays detailed information for all existing rules in the f i l t er , mangl e,
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
Appendix B: IPTables Man Page.
See Also
config iptables
( Dub) >show
( Dub) show>i pt abl es
( Dub) show i pt abl es>det ai l s
Tabl e nat
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chai n PREROUTI NG ( pol i cy ACCEPT 58101 packet s, 5095K byt es)
pkt s byt es t ar get pr ot opt i n out sour ce dest i nat i on
Chai n POSTROUTI NG ( pol i cy ACCEPT 3420 packet s, 205K byt es)
Chai n OUTPUT ( pol i cy ACCEPT 3420 packet s, 205K byt es)
Tabl e f i l t er
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chai n I NPUT ( pol i cy ACCEPT 19407 packet s, 2897K byt es)
475K 26M ACCEPT al l - - l o * 0. 0. 0. 0/ 0 0. 0. 0. 0/ 0
Chai n FORWARD ( pol i cy ACCEPT 0 packet s, 0 byt es)
Show Commands: show jobs
3-81
showjobs
Description
This command displays information related to jobs and job runs.
Formats
show jobs
history
history-runs
statistics
summary
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.
3-82
Examples
This 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>j obs
( Dub) show j obs>hi st or y
J ob Run I D St ar t t i me End t i me Exi t st at e
j ob1 1 2010/ 01/ 14 14: 15: 39 2010/ 01/ 14 14: 17: 21 ki l l ed
j ob2 2 2010/ 01/ 14 14: 15: 54 2010/ 01/ 14 14: 16: 05 abnor mal
j ob3 1 2010/ 01/ 14 14: 16: 14 2010/ 01/ 14 14: 16: 09 abnor mal
j ob4 1 2010/ 01/ 14 14: 16: 40 2010/ 01/ 14 14: 16: 55 abnor mal
j ob5 1 2010/ 01/ 14 14: 19: 11 2010/ 01/ 14 14: 19: 22 nor mal
( Dub) show j obs>
Column Description
End t i me Displays the date and time that the job ended.
Exi t
st at e
Displays the state of the job upon exit. The following states are
possible:
nor mal specifies that the job exited under normal conditions.
abnor mal specifies that the job ended under abnormal conditions,
such as a system error.
ki l l ed specifies that the job exited due to a manual stop.
J ob Displays the job names.
Run I D Displays the job run ID number.
St ar t
t i me
Displays the date and time that the job started.
( Dub) >show
( Dub) show>j obs
( Dub) show j obs>hi st or y- r uns
Maxi mumhi st or y r uns: 25
( Dub) show j obs>
3-83
This example displays Remote RMM-1400 job statistics. Display items Nor mal ,
Ki l l ed, and Abnor mal 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 Also
config jobs
( Dub) >show
( Dub) show>j obs
( Dub) show j obs>st at i st i cs
J obs conf i gur ed: 7
J obs r unni ng: 1
J obs compl et ed: 14
Nor mal : 4
Ki l l ed: 5
Abnor mal : 5
( Dub) show j obs>
Show Commands: show jobs name
3-84
showjobsname
Description
These commands display information about a specified job.
Formats
show jobs name job_name
data { cat | head | more | tail } filename
history [ run_id ]
properties
starts { start_index | * }
status
task { 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 j obdat a
directory. The following parameters are accepted:
catDisplays the entire contents of the file.
headDisplays the first ten lines of the file.
moreDisplays the entire contents of the file in a page-by-page
format.
tailDisplays the last ten lines of the file.
filenameSpecifies the file whose contents will be displayed,
such as act i ve. l og or st der r . l og.
history Displays the known history of a job for Remote RMM-1400. The
run_idDefines 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
*Specifies that all starts times will be displayed for a job.
start_indexDefines 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.
3-85
Examples
This example displays the known history of job myj ob.
This example displays the history for run ID 3 of job myj ob.
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.
taskDefines the task that will be displayed.
( Dub) >show
( Dub) show>j obs
( Dub) show j obs>name myj ob
( Dub) show j obs name myj ob
- >hi st or y
Run I D St ar t t i me End t i me Exi t st at e
1 2010/ 01/ 15 21: 24: 54 2010/ 01/ 15 21: 25: 12 ki l l ed
2 2010/ 01/ 15 21: 25: 25 2010/ 01/ 15 21: 25: 29 nor mal
3 2010/ 01/ 15 21: 25: 32 2010/ 01/ 15 21: 26: 09 ki l l ed
4 2010/ 01/ 15 21: 26: 19 2010/ 01/ 15 21: 26: 30 nor mal
5 2010/ 01/ 15 21: 26: 34 2010/ 01/ 15 21: 26: 39 abnor mal
- >
( Dub) >show
( Dub) show>j obs
( Dub) show j obs>name myj ob
- >hi st or y 3
Run I D: 3
St ar t : 2010/ 01/ 15 21: 25: 32
End: 2010/ 01/ 15 21: 26: 09
Exi t st at e: ki l l ed
- >
Column Description
End t i me Displays the date and time that the job ended.
Exi t
st at e
Displays the state of the job upon exit. The following states are
possible:
nor mal specifies that the job exited under normal conditions.
abnor mal specifies that the job ended under abnormal conditions,
such as a system error.
ki l l ed specifies that the job exited due to a manual stop.
3-86
This example displays the property names and values for job anot her j ob.
This example displays the start specifications for job Anot her J ob.
Run I D Displays the job run ID number.
St ar t
t i me
Displays the date and time that the job started.
( Dub) >show
( Dub) show>j obs
( Dub) show j obs>name anot her j ob
( Dub) show j obs name anot her j ob
- >pr oper t i es
Name Val ue
dur at i on 1000
exi t code 245
st opdel ay 10
- >
Column Description
Name Displays the configurable job properties.
Note: Values displayed in this column depend on the script that the job
is executing.
Val ue Displays values for the corresponding job properties.
( Dub) >show
( Dub) show>j obs
- >st ar t s *
Cr on st ar t : di sabl ed
St ar t at boot up: di sabl ed
St ar t - at i ndex: 1
Mont h: 8
Day: 4
Hour : 12
Mi nut e: 35
Weekday: 4
No schedul ed st ar t t i me
- >
3-87
This example displays the status of job sampl ej ob.
Cr on st ar t Specifies that a job will start automatically after a specific event
has occurred, such as arrival at a specified time/date. Possible
values are Enabl ed and Di sabl ed.
Day Displays the day that the job is configured to start.
Hour Displays the hour that the job is configured to start.
Mi nut e Displays the minute that the job is configured to start.
Mont h Displays the month that the job is configured to start.
St ar t at
boot up
Specifies that a job will start at Remote RMM-1400 bootup.
Possible values are Enabl ed and Di sabl ed.
St ar t - at
i ndex
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>j obs
( Dub) show j obs>name sampl ej ob
( Dub) show j obs name sampl ej ob
- >st at us
J ob: sampl ej ob
Package: j obt est ut i l s
Mi n ver si on: any
Scr i pt : nor mal
Ti t l e: Sampl eJ ob
Cr on st ar t : di sabl ed
St ar t at boot : di sabl ed
Memor y l i mi t ( Kb) : 2560
St ack si ze ( Kb) : 1024
Out put capt ur e: di sabl ed
Max st ar t at t empt s: 1
Run st at e: r unni ng
Run I D: 4
St ar t at t empt : 1
St ar t t i me: 2010/ 01/ 08 18: 41: 29
Debuggi ng: di sabl ed
Checki ng: di sabl ed
Memor y usage ( Kb) : 2026
( Dub) show j obs name sampl ej ob
- >
3-88
Note: The following display items appear only if the status display is for a running
job.
Cr on st ar t Displays the cron start status.
J ob Displays the job name.
Max st ar t
at t empt s
Displays the number of times that Remote RMM-1400 will
attempt to start the job.
Memor y l i mi t Displays the amount of memory that can be used for the job.
Mi n ver si on Displays the minimum acceptable version for the specified
package.
Out put capt ur e 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 st at e Displays the job run state as Runni ng or I dl e.
Scr i pt Displays the script to which the job will send runtime and
parameter use instructions.
St ack si ze Displays the maximum stack size for the job.
St ar t at boot Displays if the job will start when the system boots up.
Ti t l e Displays the title of the job, if a title has been configured.
Checki ng Displays the checking status as di sabl ed or enabl ed.
Debuggi ng Displays the debugging status as di sabl ed or enabl ed.
Memor y usage
( Kb)
Displays the amount of memory being used by the job in
kilobytes.
Run I D Displays the ID for job run.
3-89
This example displays the configured tasks and task properties configured for job
Anot her J ob.
See Also
config jobs
config jobs name
config jobs name task
St ar t at t empt Displays the number of times that Remote RMM-1400 has
attempted to start the job.
St ar t t i me Displays the date and time that the job started.
( Dub) >show
( Dub) show>j obs
- >t ask *
Task: xml r pc
Posi t i on: 1
Type: ser ver socket
Pr oper t i es:
Name Val ue
def er t r ue
i nt er f ace br _swi t ch
- >
Posi t i on Displays the task position.
Pr oper t i es 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 i f conf i g or
ser ver socket .
Show Commands: show listeners
3-90
showlisteners
Description
This command displays the destinations that are listening for mediation connections
in the system. This serves as a diagnostic tool that allows the user to determine the
destinations that are actively listening.
Formats
show listeners
Examples
This example displays destinations that are listening for mediation connections in the
system.
( Dub) >show
( Dub) show>l i st ener s
Li st ener s:
ser i al 1
ser i al 2
ser i al 3
ser i al 4
t cp 0. 0. 0. 0: 40010
( Dub) show>
ser i al 1 to
ser i al 4
Displays the serial ports that are listening for mediation
connections.
t cp
0. 0. 0. 0: 40010
Displays the TCP destinations that are listening for mediation
connections.
Show Commands: show log-file
3-91
showlog-file
Description
This 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.
Formats
show log-file [ aut h ] [ t er se | ver bose ] [ line_count ]
Parameters
Command Defaults
Terse
20 lines
aut h 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.
t er se 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.
ver bose Displays a more-detailed version of the Remote RMM-1400 log file.
Show Commands: show log-file
3-92
Examples
This example displays the last (most recent) 10 lines of a less-detailed (t er se)
version of the Remote RMM-1400 log file.
See Also
debug level
( Dub) >show
( Dub) show>l og- f i l e 10
20090204: 030113: - 0500:
- ai - per i ph- et her : Mgmt CommUp: Management communi cat i on est abl i shed t o per i pher
al " RMB1- 0E68FA" .
20090204: 030113: - 0500:
- ai - per i ph- et her : Per i phOnl i ne: Per i pher al " RMB1- 0E68FA" Onl i ne.
20090204: 030113: - 0500:
- ai - per i ph- et her : Per i phManaged: Per i pher al " RMB1- 0E68FA" Managed.
20090204: 030114: - 0500:
- :
20090204: 034747: - 0500:
- ai - f nd- cor e: I nt er nal Logi cEr r or : I nt er nal l ogi c er r or : Cl osi ng dat a manager w
i t h open t r ansact i on
( Dub) show>
Show Commands: show meas-table
3-93
showmeas-table
Description
This command displays configuration information for the measurement table, a
summary of all configured measurement table entries, or details about an individual
measurement table entry.
Formats
show meas-table
entries [ name | filter | nopage ]
Parameters
Examples
This 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:
nameSpecifies the name of an individual measurement table
entry. Detailed information about this entry will display upon
execution of the command.
filterConfigures 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.
nopageDisplays 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
( Dub) show>meas- t abl e
Number of measur ement s - 4
Lengt h of Hi st or y - 24
Ti me I nt er val - 15
( Dub) >
3-94
This example displays a list of measurement table entries.
( Dub) >show
( Dub) show>meas- t abl e ent r i es
Name St at e Val ue Uni t s
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
phoeni xBat t Cel l Temp1 i nput - sat ur at ed 18 C
phoeni xBat t Cel l Temp2 i nput - sat ur at ed 18 C
phoeni xBat t St r i ng i nput - sat ur at ed 54. 5 Vol t s
( Dub) >
Name Displays the name of the measurement table entry.
St at e Displays the current status of the measurement table entry.
Possible values include:
l oss- of - si gnal The current value is below the configured
minimum value
l owThe current value is below the in-band range, but above the
minimum value
i n- bandThe current value lies within the in-band range
hi ghThe current value is above the in-band range, but below
the maximum value
i nput - sat ur at edThe current value is above the configured
maximum value
of f l i neRemote is not receiving a value from the originator.
Val ue Displays the current value of the measurement.
Uni t s Displays the unit of measure.
3-95
This example displays detailed information for measurement table entry j l t est .
( Dub) >show
( Dub) show>meas- t abl e ent r i es j l t est
Name - j l t est ( st at i c)
St at us - hi gh
Or i gi nat or - anal og 1/ 1
Descr i pt i on -
NE Name - neNameOf J l t est
Cat egor y - cat egor yOf J l t est
Repor t I nt er val - 5
Low- Band - 20. 0
Hi gh- Band - 80. 0
Hyst er esi s - 0. 0
Max- Li mi t - 90. 0
Mi n- Li mi t - 10. 0
Uni t s - gal l ons
Cur r ent Val ue - 89. 3
I nt er val Val ue - 89. 3
I nt er val Mi ni mum- 89. 3
I nt er val Maxi mum- 89. 3
I nt er val Aver age - 89. 3
( Dub) >
Name Displays the name of the measurement table entry.
St at us Displays the current status of the measurement table entry.
Possible values include:
l oss- of - si gnal The current value is below the configured
minimum value
l owThe current value is below the in-band range, but above
the minimum value
i n- bandThe current value lies within the in-band range
hi ghThe current value is above the in-band range, but
below the maximum value
i nput - sat ur at edThe current value is above the configured
maximum value
of f l i neRemote is not receiving a value from the originator.
Or i gi nat or Displays the origin of the measured data; for example, an
analog input, a script, or SNMP proxy.
Descr i pt i on Displays a description of the measurement table entry.
NE Name Displays the name of the network element whose data is being
measured.
3-96
See Also
config meas-table
show mediation
Cat egor y Displays a category for the measurement table entry. The
category associates the measurement table entry with a
specific application or task.
Repor t
I nt er val
Displays the interval (in minutes) for storing updated
measurement values.
Low- Band Displays the lowest measured value that will be considered an
i n- band, or normal, condition.
Hi gh- Band Displays the highest measured value that will be considered
an i n- band, or normal, condition.
Hyst er esi s Displays hysteresis, which works as a guard between hi gh-
band and l ow- band thresholds.
Max- Li mi t Displays the highest measured value that will be considered a
hi gh condition. Values higher than this will result in an input-
saturated condition.
Mi n- Li mi t Displays the lowest measured value that will be considered a
l ow condition. Values lower than this will result in a loss-of-
signal condition.
Uni t s Displays the unit of measure.
Cur r ent Val ue Displays the current value of the measurement.
I nt er val Val ue Displays the last measurement value stored during the most
recent measurement interval.
I nt er val
Mi ni mum
Displays the lowest value measured during the last report
interval.
I nt er val
Maxi mum
Displays the highest value measured during the last report
interval.
I nt er val
Aver age
Displays the average value measured during the last report
interval.
Show Commands: show mediation
3-97
showmediation
Description
This command displays summaries of all configured SNMP options and SNMP
network elements.
Formats
show mediation
snmp { event - t empl at es [ name ] | manager
| measur ement - t empl at es [ name ] | ne- t empl at es [ name ] |
poi nt - t empl at es [ name ] }
snmpnes [ name ]
Parameters
snmp Displays a summary of the SNMP options. The following
event - t empl at esDisplays all event templates or a detailed
view of an instance of an event template. The following
nameSpecifies the name of an event template for which
information will be displayed.
measur ement - t empl at esDisplays all measurement
templates or a detailed view of an instance of a measurement
nameSpecifies the name of a measurement template for
which information will be displayed.
ne- t empl at esDisplays all NE templates or a detailed view
of an instance of an NE template. The following parameter is
accepted:
nameSpecifies the name of an NE template for which
manager Displays the settings for the mediation SNMP
manager.
poi nt - t empl at esDisplays all point templates or a detailed
view of an instance of a point template. The following
nameSpecifies the name of a point template for which
3-98
Examples
This example displays a summary of all configured SNMP event templates.
This example displays the details of the col dSt ar t Def 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:
nameSpecifies the name of a network element for which
( Dub) show medi at i on snmp
( Dub) show medi at i onsnmp>event - t empl at es
Name Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
col dSt ar t Def
conf i gChangeDef
i f DownDef
i f UpDef
pei phDef per i pher al onl i ne/ of f l i ne event - t empl at e descr i pt i on
( Dub) show medi at i on snmp>
( Dub) show medi at i on snmp>event - t empl at es col dSt ar t Def
Name: col dSt ar t Def
Descr i pt i on:
Message: $( event ) event on NE $( snmpne)
Tr ap OI D: . 1. 3. 6. 1. 6. 3. 1. 1. 5. 1
Descr i pt i on Displays the description for the mediation SNMP event
template.
Message Displays the event templates 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.
Tr ap OI D Displays the trap OID (Object Identifier) for an event template.
This value will be matched against the OID for a trap.
3-99
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 i f Ent r yDef SNMP point template.
Var bi nd- mat ch Displays the mediation SNMP event template varbind to match
against a trap.
( Dub) show medi at i onsnmp>manager
Manager Por t : 162
Manager Por t Displays the port number for the SNMP manager.
( Dub) show medi at i on snmp>poi nt - t empl at es
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
al ar mTabl eDef
i f Ent r yDef Ent r y i n i f Tabl e
( Dub) >show medi at i on snmp
( Dub) show medi at i on snmp>poi nt - t empl at es i f Ent r y
Name: i f Ent r y
Descr i pt i on: Ent r y i n i f Tabl e
Pol l OI D: . 1. 3. 6. 1. 2. 1. 2. 2. 1. 8. $( i f I ndex)
Of f l i ne Sever i t y: cr i t i cal
Of f l i ne Message: I nt er f ace $( poi nt ) i s of f l i ne
St at e: up
Message: $( poi nt ) i s up
Pol l Val ue: 1
Sever i t y: nor mal
Tr ap OI D: . 1. 3. 6. 1. 6. 3. 1. 1. 5. 4
Var bi nd Mat ch: . 1. 3. 6. 1. 2. 1. 2. 2. 1. 1 = $( i f I ndex)
St at e: down
Message: $( poi nt ) i s down
Pol l Val ue: 2
Sever i t y: cr i t i cal
Tr ap OI D: . 1. 3. 6. 1. 6. 3. 1. 1. 5. 3
Var bi nd Mat ch: . 1. 3. 6. 1. 2. 1. 2. 2. 1. 1 = $( i f I ndex)
3-100
This example displays a summary of all configured SNMP measurement templates.
Descr i pt i on Displays a textual description for a point template.
Name Displays the name of the point template.
Pol l OI D Displays the OID used for polling the point.
Of f l i ne
Sever i t y
Displays the severity for the offline state of the point.
Of f l i ne
Message
Displays the alarm message for the offline state of the point.
St at e Displays the name of the point's state and the following
information:
MessageDisplays 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.
Pol l Val ueDisplays 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.
Sever i t yDisplays the severity for a point template
state. This value is used to set the alarm table entry's
severity for the state.
Tr ap- OI DDisplays the OID to match against a trap for a
mediation SNMP point template state.
Var bi nd- Mat chDisplays a matching varbind OID and
value for a mediation SNMP point template state.
- >measur ement - t empl at es
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
al Def Si ngl e measur ement
al Tabl eDef Measur ement gr oup
3-101
This example displays the details of the al Def SNMP measurement template.
This example displays a summary of all configured SNMP NE templates.
- >measur ement - t empl at es al Def
Name: al Def
Descr i pt i on: Si ngl e measur ement
Pol l OI D: . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 5. $( al I ndex)
Val ue Mat ch I ndex: 2
Val ue Conver si on Mul t i pl i er : 1
Tr ap: cr i t i cal
Tr ap OI D: . 1. 3. 6. 1. 4. 1. 539. 42. 2. 0. 5
Var bi nd Val ue: . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 5
Val ue Mat ch I ndex: 2
Var bi nd Mat ch: . 1. 3. 6. 1. 4. 1. 539. 42. 2. 2. 1. 1 = $( al I ndex)
Descr i pt i on Displays a textual description for a measurement template.
Pol l OI D Displays the OID (Object Identifier) used to poll the proxied NE
for the measurements current value.
Val ue Mat ch
I ndex
Displays which numeric value in a string response should be
considered as the desired measured value.
Val ue
Conver si on
Mul t i pl i er
Displays the amount by which the measured value will be
multiplied before it is reported or stored.
Tr ap Displays the name of the trap.
Tr ap OI D Displays the trap OID to match against incoming traps.
Var bi nd Val ue Displays a varbind OID used to find the collected
measurement.
Var bi nd Mat ch Displays a varbind OID and value to match against incoming
traps.
( Dub) show medi at i on snmp>ne- t empl at es
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Templ at e1 Sampl e t empl at e
Templ at e2 Devi ceB Templ at e
3-102
This example displays the details of the Templ at e1 SNMP NE template.
This example displays a summary of all configured SNMP network elements.
( Dub) show medi at i on snmp>ne- t empl at es Templ at e1
Name: Templ at e1
Descr i pt i on: Sampl e t empl at e
Event : r unni ngConf i gChange
Templ at e: conf i gChangeDef
Par amet er : f i l e = r unni ngconf i g
Measur ement : Meas1
Templ at e: al Def
Par amet er : cur r ent = 1
Poi nt : modem
Templ at e: i f Ent r yDef
Par amet er : i f Descr = ser i al _modem
Templ at e Ref er ence: al ar m1
Templ at e: al ar ms
Par amet er : num= 1
Descr i pt i on Displays a textual description for an NE template.
Event Displays the name of an event that has been configured for
this NE template.
Measur ement Displays the name of a measurement that has been
configured for this NE template.
Par amet er Displays a parameter that is specified for this NE template,
and the value that is specified for this parameter.
Poi nt Displays the name of a point that has been configured for this
NE template.
Templ at e Displays the name of an existing event, point, or NE template
that is referenced by this NE template.
Templ at e
Ref er ence
Displays a name that uniquely identifies a reference to an
existing NE template.
( Dub) show medi at i on
( Dub) show medi at i on snmpnes>
Name Host Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
r emot esl ow 10. 34. 68. 60
r emot esl owv1 10. 34. 68. 60
MyNE 10. 40. 65. 90 My pr oxi ed NE
3-103
This example displays the details of the MyNE mediation SNMP NE.
( Dub) show medi at i on
( Dub) show medi at i on>snmpnes MyNE
Name: MyNE
Descr i pt i on: My pr oxi ed NE
Host : 10. 40. 65. 90: 161
SNMP Communi t y: admi ni st r at or
SNMP Ver si on: v1
NE Name: MyNE
Cat egor y: some- cat egor y
Connect i vi t y OI D: . 1. 3. 6. 1. 2. 1. 1. 2. 0
Connect i vi t y St at e: Onl i ne
Last Connect i vi t y Pol l Repl y: Mon J un 25 17: 49: 24 GMT 2008
Event : r eboot
Templ at e: col dSt ar t
Last Tr ap: Mon J un 25 17: 49: 24 GMT 2008
Measur ement : newMeasur ement
Templ at e: myMeasTmpl
Last Pol l Repl y: unknown
Par amet er : i f I ndex = 10
Poi nt : et her net 1
Templ at e: i f Ent r y
Cur r ent St at e: up
Last Tr ap: Mon J un 25 17: 49: 24 GMT 2008
Last Pol l Repl y: Mon J un 25 17: 49: 24 GMT 2008
Poi nt : et her net 2
Templ at e: i f Ent r y
Cur r ent St at e: Poi nt Of f l i ne
Last Tr ap: unknown
Last Pol l Repl y: unknown
( Dub) show medi at i on>
Cat egor y Displays the category for a mediation SNMP NE.
Descr i pt i on Displays a textual description for an SNMP NE.
Connect i vi t y
OI D
Displays the OID used to poll for connectivity to the SNMP NE.
Connect i vi t y
St at e
Displays the connectivity state of the SNMP NE: Onl i ne or
Of f l i ne.
3-104
Event Displays the event name for a mediation SNMP NE and the
following associated information:
Templ at eThe name of a configured event template
which defines the event.
Par amet er The name of a replaceable parameter in the
point template and the associated value.
Last Tr apThe 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:
i p_addr The IP address of the proxied network element.
The default value is 0. 0. 0. 0.
por t The port on the proxied network element which is
used for polling.
communi t yThe SNMP community string which is used
for polling.
Measur ement Displays the name of a measurement on a mediation SNMP
NE and includes the following information:
Templ at eThe name of a configured measurement
template which defines the measurement.
Last Pol l Repl yThe time that a poll reply last matched
the measurement. The default value is unknown, for when
no poll reply has yet been received.
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.
3-105
See Also
Poi nt Displays the name of a status point on a mediation SNMP NE
and includes the following information:
Templ at eThe name of a configured point template
which defines the point.
point template and its associated value.
Last Tr apThe time that a trap last matched the point.
The default value is unknown, for when no trap has yet
been received.
Last Pol l Repl yThe time that a poll reply last matched
the point. The default value is unknown, for when no poll
reply has yet been received.
Show Commands: show ntp
3-106
showntp
Description
This command displays the current NTP configuration for Remote RMM-1400.
Formats
show ntp
Examples
This example displays NTP in an enabled state, the configuration of the preferred
server with the IP address of 10. 50. 18. 33, the configuration of the secondary server
with the IP address of 10. 50. 18. 32, and the default configuration of the minimum
and maximum polling intervals.
This example displays NTP in a disabled state.
See Also
config ntp
( Dub) >show
( Dub) show>nt p
NTP i s enabl ed.
Pr ef er r ed NTP ser ver : 10. 50. 18. 33
Secondar y NTP ser ver : 10. 50. 18. 32
Pol l i nt er val i s 2^6 ( 64) - 2^10 ( 1024) seconds
( Dub) show>
( Dub) >show
( Dub) show>nt p
NTP i s di sabl ed.
Pr ef er r ed NTP ser ver : 10. 50. 18. 33
Secondar y NTP ser ver : 10. 50. 18. 32
Pol l i nt er val i s 2^6 ( 64) - 2^10 ( 1024) seconds
( Dub) show>
Show Commands: show peripherals
3-107
showperipherals
Description
These 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.
Formats
show peripherals
name name
unit unit
Parameters
name Specifies the name of a peripheral device for display. The following
nameSelects 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
peripherals MAC address. Names are formatted as follows, where each
X represents a hexadecimal digit:
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 per i pher al s
command, as shown in the example below.
unit Specifies a peripheral unit number for display. The following parameter is
accepted:
3-108
Examples
This 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>per i pher al s
Name St at e I P Manager I P Manager Name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BI S48- 0D1C8D Unmanaged 169. 254. 115. 212 0. 0. 0. 0
DEP- 083B62 Ot her Managed 169. 254. 44. 105 10. 39. 64. 81 AI
FB64- 0D1C72 Unmanaged 169. 254. 88. 111 0. 0. 0. 0
RMB1- 0E68FD Onl i ne 0. 0. 0. 0 10. 39. 90. 2 RMM1400
SER8- 04A0DB Unmanaged 169. 254. 171. 198 0. 0. 0. 0
Uni t Name I P Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1 RMB1- 0E68FD 0. 0. 0. 0
2
3
4
5
6
7
8
9
10
11
12
( Dub) show>
( Dub) >show
( Dub) show>per i pher al s uni t 1
Uni t number : 1
Descr i pt i on:
Type: r mb- 1
Admi n st at e: Managed
Name: RMB1- 0E68FD
I P addr ess: 0. 0. 0. 0
Oper st at e: Onl i ne
Manager name: RMM1400
Manager I P addr ess: 10. 39. 90. 2
Type: RMB- 1
Model : B684- 00. A: 0
Fi r mwar e ver si on: 1. 00
Fi r mwar e bui l d dat e: J an 11 2010 15: 21: 20
Fi r mwar e bui l d I D: 003
Ser i al number : 0000000001
Manuf act ur e dat e: 12/ 18/ 09
St age2 boot l oader ver si on: 1. 00
St age2 boot l oader bui l d dat e: 11/ 05/ 09
MAC addr ess: 00: 40: 72: 0E: 68: FD
( Dub) show>
3-109
Admi n st at e Displays the current administrative state of the
peripheral.
Descr i pt i on Displays the user-configured description for the
peripheral.
Fi r mwar e bui l d dat e Displays the build date of the firmware executing on
the peripheral.
Fi r mwar e bui l d I D Displays the build ID of the firmware executing on
the peripheral.
Fi r mwar e ver si on Displays the version number of the firmware
executing on the peripheral.
I P addr ess Displays the IP address of the peripheral.
MAC addr ess Displays the hardware address of the peripheral.
Manager I P addr ess 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.
Manuf act ur e dat e 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 st at e Displays the current management state of the
peripheral.
Ser i al number Displays the serial number of the peripheral.
St age 2 boot l oader
bui l d dat e
Displays the build date of the second stage
bootloader executing on the peripheral.
St age 2 boot l oader
ver si on
Displays the version number of the second stage
bootloader executing on the peripheral.
3-110
See Also
config peripheral
Type Displays the type of the peripheral as follows:
di scr et e- expansi on for Expand D units
RMB- 1 for RMB-1 and RMB-2 units
ser i al 8- expansi on for RME-S8 units
f b64- expansi on for RME-B64 units
FE8- expansi on for RME-E8 units
Uni t number Displays the unit number of the peripheral.
Show Commands: show pkgs
3-111
showpkgs
Description
This 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.
Formats
show pkgs
name package
on-demand-install
server
summary
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:
packageDefines 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.
3-112
Examples
This example displays package exampl escr i pt along with its associated
characteristics and settings.
( Dub) >show
( Dub) show>pkgs
( Dub) show pkgs>name exampl escr i pt
Package: exampl escr i pt
Ver si on: 1. 0. 0
Runni ng j ob count : 0
I mpor t s:
Package Mi n ver si on Pr esence
t est i mpb 2. 1. 0 mi ssi ng
Scr i pt : capt ur e_exampl e
Aut hor : Appl i ed I nnovat i on I nc.
Descr i pt i on: Thi s pr i nt s a pr oper t y t o st dout and st der r .
Language: Pyt hon
Modul e: exampl eScr i pt . scr i pt
Cl ass: Capt ur eExampl e
Pr oper t i es:
Name Requi r ed?
capt ur e_t ext r equi r ed
Scr i pt : echo_exampl e
Aut hor : Appl i ed I nnovat i on I nc.
Descr i pt i on: Thi s i s an echo ser ver exampl e scr i pt .
Language: Pyt hon
Modul e: exampl eScr i pt . scr i pt
Cl ass: EchoExampl e
Tasks:
Name Type Requi r ed?
new_i p i f conf i g opt i onal
ser ver _sock ser ver socket r equi r ed
Pr oper t i es:
Name Requi r ed?
st r i p_spaces opt i onal
upper _case opt i onal
( Dub) show pkgs>
I mpor t s 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.
Requi r ed ver si on displays the minimum version of the
imported script package that is compatible with the main
package.
I nst al l ed ver si on displays the currently installed script
package import.
3-113
This example displays the status of the on-demand-install option as disabled.
Package Displays the package name along with the following
characteristics:
Ver si on displays the version number.
Runni ng j ob count displays the number of running jobs that
are currently using the package.
Pr oper t i es Displays the job properties expected by the script. The following
job property characteristics are listed:
Name displays the job property names.
Requi r ed? displays if the job properties are required or not.
Scr i pt Displays a script within the package. The following script
characteristics are listed:
Aut hor displays the author of the script.
Descr i pt i on displays a description of the script.
Language displays the language used to create the script. It
includes the sub-headings Modul e, which indicates the
package for which the script was created, and Cl ass, 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).
Requi r ed? displays if the tasks are required or not.
( Dub) >show
( Dub) show>pkgs
( Dub) show pkgs>on- demand- i nst al l
On demand i nst al l : di sabl ed
( Dub) show pkgs>
3-114
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.
See Also
config pkgs install
config pkgs server
( Dub) >show
( Dub) show>pkgs
( Dub) show pkgs>ser ver
FTP ser ver : enabl ed
Addr ess: 10. 50. 37. 9
Por t : 21
User : new
Passwor d: ser ver
Di r ect or y: / t mpdi r / t est / f t p8/ packages/ ser ver
( Dub) show pkgs>
Addr ess Displays the IP address of the server.
Di r ect or y Displays the directory in which the packages reside.
FTP ser ver Displays the status of the remote FTP server as enabl ed or
di sabl ed.
Passwor d Displays the password for the server.
Por t Displays the port number for the server.
( Dub) >show
( Dub) show>pkgs
( Dub) show pkgs>summar y
Package Ver si on
goodpkg 1. 0. 0
j obt est ut i l s 1. 0. 0
t est i 2. 0. 1
t est j 2. 0. 1
( Dub) show pkgs>
Show Commands: show product
3-115
showproduct
Description
This command displays product information for Remote RMM-1400.
Formats
show product
Examples
This example displays the product information for Remote RMM-1400.
( Dub) >show
( Dub) show>pr oduct
Pr oduct code: RMM1400
Par t number : B544- 0. 0: 0
Remot e RMM- 1400
( Dub) show>
Hardware components Displays the hardware components that are associated
with Remote RMM-1400. The example displays
component Remot e RMM- 1400.
Par t number Displays a part number for Remote RMM-1400. The
example displays part number B544- 0. 0: 0.
Pr oduct 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.
Show Commands: show profiles
3-116
showprofiles
Description
This command displays all profiles, or detailed information for a specified profile.
Formats
show profiles [ profile_name ]
Parameters
supervisor
Examples
This example displays information for all user-defined profiles:
This example displays detailed information for user-defined profile t ech:
profile_name Specifies the profile to display.
( Dub) >show
( Dub) show>pr of i l es
Pr of i l e Name Base Type pr i v- l vl
new1 super vi sor 3
Super St at us st at us 6
new3 management 10
t ech st at us 5
( Dub) show>
( Dub) >show
( Dub) show>pr of i l es t ech
Name: t ech
Base Type: st at us
Pr i vi l ege Level : 5
Command I D Act i on
/ conf i g/ cont r ol l er / et h i ncl ude
/ conf i g/ i nt er f ace/ et h i ncl ude
/ show/ r esour ce- t r acki ng excl ude
( Dub) show>
Column Description
Act i on Displays if the command IDs are included or excluded for the
user-defined profile.
Show Commands: show profiles
3-117
See Also
config profile
Base Type Displays the system profile on which the user-defined profile is
based.
Command I D 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 A: Command Identifications.
Name Displays the name of the user-defined profile.
pr i v- l vl Displays the privilege level for a profile.
Pr i vi l ege
Level
Displays the privilege level for a profile.
Pr of i l e Name Displays the name of the user-defined profile.
Show Commands: show pydoc
3-118
showpydoc
Description
This command displays Python module information.
Formats
show pydoc
keyword keyword [ package ]
name name [ package ]
summary package
Parameters
keyword Searches Python module names and descriptions for a specified
keyword. A package name can be specified to narrow down the list of
Python modules in which Remote RMM-1400 will search. The following
keywordDefines the keyword for which Remote RMM-1400 will
search.
packageDefines the package in which Remote RMM-1400 will
search for the Python module.
name Displays the Python documentation for a module. A package name can
be specified to define where the module must reside. The following
nameDefines the name of the module for which documentation
will be displayed. This value is case-sensitive.
summary Displays a list of all Python modules in a package. The following
3-119
Examples
This example displays all Python module names and descriptions in which keyword
scr i pt appears.
This example displays the Python documentation for module Test E. Test E in
package t est e.
( Dub) >show
( Dub) show>pydoc
( Dub) show pydoc>keywor d scr i pt
cgi - Suppor t modul e f or CGI ( Common Gat eway I nt er f ace) scr i pt s.
cgi t b - Handl e except i ons i n CGI scr i pt s by f or mat t i ng t r acebacks i nt o ni ce HTML
.
compi l eal l - Modul e/ scr i pt t o " compi l e" al l . py f i l es t o . pyc ( or . pyo) f i l e.
sel ect - Thi s modul e suppor t s asynchr onous I / O on mul t i pl e f i l e descr i pt or s.
ai scr i pt ( package) - Thi s package cont ai ns cl asses t hat ar e used f or cr eat i ng sc
r i pt s f or execut i on.
ai scr i pt . scr i pt
( Dub) show pydoc>
( Dub) >show
( Dub) show>pydoc
( Dub) show pydoc>name Test E. Test E t est e
Pyt hon Li br ar y Document at i on: modul e Test E. Test E i n Test E
NAME
Test E. Test E
FI LE
/ var / ai - muse/ j ai l / pkgdb/ t est e/ Test E/ Test E. py
DESCRI PTI ON
: Aut hor : Test E_Aut hor
: Descr i pt i on: Thi s i s Test E
CLASSES
Scr i pt E0
Scr i pt E1
cl ass Scr i pt E0
| Met hods def i ned her e:
|
| r un( sel f , pr oper t i es)
|
| st op( sel f )
- - Mor e- -
3-120
This example displays the modules in package pkgt est ut i l s.
( Dub) >show
( Dub) show>pydoc
( Dub) show pydoc>summar y pkgt est ut i l s
Modul es
Abnor mal
Cl asses
Nor mal
PkgTest Ut i l s
PkgTest Ut i l s. PkgTest Ut i l s
( Dub) show pydoc>
Show Commands: show remote-access
3-121
showremote-access
Description
This command displays the remote access protocol configuration.
Formats
show remote-access
Examples
This example displays the remote access protocol configuration.
See Also
config remote-access
( Dub) >show r emot e- access
SSH and SFTP: Enabl ed
Tel net and FTP: Enabl ed
Tel net por t : 23
FTP por t : 21
HTTP: Di sabl ed
HTTP por t : 80
HTTPS: Enabl ed
HTTPS por t : 443
( Dub) >
Show Commands: show resource-tracking
3-122
showresource-tracking
Description
This command displays the items that have been marked for resource usage tracking.
Formats
show resource-tracking
Examples
This example displays the items that have been marked for resource tracking.
See Also
( Dub) >show
( Dub) show>r esour ce- t r acki ng
I D Resour ce St at e
ser i al 1 assi gned
ser i al modem assi gned
( Dub) show>
Show Commands: show responses
3-123
showresponses
Description
This command displays summary information for all responses or displays for a
specified response.
Formats
show responses [ response_name ]
Parameters
Examples
This 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>r esponses
Name Type Responder Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
connect _0001 connect t cp 60001 I P t o ser i al por t . . .
door Open421Al ar m i nt er val anal og 1/ 1 Act i vat es an al ar . . .
pr essur eGauge connect ser i al 2 Act i vat es an al ar . . .
( Dub) show>
Column Description
Descr i pt i on Displays the configured response descriptions.
Name Displays the names of all configured responses.
Show Commands: show responses
3-124
This example displays detailed information for response connect _0001.
See Also
config response
Responder Displays the responders associated with the configured
responses. Responders are system components that process
responses. For descriptions of all available responders, see the
response configuration commands.
Type Displays the response types associated with the configured
responses. For descriptions of all available response types, refer
to the response configuration commands.
( Dub) >show
( Dub) show>r esponses connect _0001
Response Name : connect _0001
Response Descr i pt i on : I P t o ser i al por t 1 - out goi ng ser i al connect i on
Response Responder : t cp 60001
Response Type : connect
Response Par amet er s :
dest =ser i al 1
dest - dat a=ATDT101
( Dub) show>
Response
Descr i pt i on
Displays the configured response description.
Response Name Displays the name of the configured response.
Response
Par amet er s
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.
Show Commands: show running-config
3-125
showrunning-config
Description
This 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.
information pertaining to users and other sensitive data.
Tip: This command performs the same function as command running-config on
page 5-34.
Formats
show running-config [ nopage ]
Parameters
nopage Displays the entire running configuration upon execution of the
outputs the running configuration one page at a time.
Show Commands: show running-config
3-126
Examples
This 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 t echcommis added to the system.
See Also
copy
running-config
( Dub) >show r unni ngconf i g
# Ver si on: 2. 00
# Cr eat ed: 2010- 11- 22, 15: 43: 51. 0, +0000
# User : j anedoe
conf i g dhcp- r el ay ser ver 10. 39. 70. 40
conf i g per i pher al 1 t ype r mb- 1
conf i g per i pher al 1 manage RMB1- 0E68FD
conf i g r emot e- access ht t p di sabl e
conf i g r emot e- access ht t ps enabl e
conf i g snmp host 10. 34. 3. 84 162 publ i c v1
conf i g snmp host 10. 34. 3. 83 162 publ i c v2- i nf or m
conf i g t i meout 0
conf i g user s add t echcommsuper vi sor - e$1$Qzv94sky$J / XFok7l Vj o8E/ l mbH9f h. -
e$1$Qzv94
conf i g i nt er f ace br i dge swi t ch i p addr ess 10. 39. 90. 2/ 16
- - Mor e- -
Show Commands: show sitebus
3-127
showsitebus
Description
This command displays a summary of all devices connected to the SiteBus terminals
on an RMB peripheral unit, or details about a specific SiteBus device.
Formats
show sitebus
id hex_id
name name
Parameters
Examples
This 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 t emp2,
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_idIdentifies 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:
nameIdentifies the name for a SiteBus device.
3-128
( Dub) >show
( Dub) show>si t ebus
I D Per i ph: Bus St at e Managed Name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
28004564AE05A5 1: 2 Unmanaged
280000561000F1 1: 1 Managed t emp1
Name I D St at e Type Descr i pt i on
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
t emp1 280000561000F1 Onl i ne sbTemp Heat i ng cor e t emp pr
t emp2 2800006F5AA522 Of f l i ne sbTemp Ext er i or t emp pr obe
( Dub) show>
Column Description
Descr i pt i on Displays the text description for a SiteBus device.
I D Displays the unique 14-digit hexidecimal ID value for each
SiteBus device. Every device is hard-coded with a unique
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.
Per i ph: 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 perhiperhal unit.
St at e The following St at e 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.
Onl i ne indicates that a configured device has a valid device
type and has been discovered by RMB.
Of f l i ne indicates that a configured device has an invalid
device type and/or has not been discovered by RMB.
3-129
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.

version 2.0x is sbTemp.
( Dub) >show
( Dub) show>si t ebus i d 28004564AE05A5
Di scover ed I D: 28004564AE05A5
Suppor t ed Types: sbTemp
Per i pher al : 1
Bus: 2
Admi n St at e: Unmanaged
Last Updat ed Ti me: Mon Feb 1 16: 42: 46 EDT 2010
( Dub) show>
( Dub) >show
( Dub) show>si t ebus i d 280000561000F1
Name: t emp1
Descr i pt i on: Heat i ng cor e t emp pr obe
I D: 280000561000F1
Type: sbTemp
Per i pher al : 1
Bus: 1
Admi n St at e: Managed
Oper St at e: Onl i ne
Last Updat ed Ti me: Mon Feb 1 16: 42: 46 EDT 2010
( Dub) show>
Column Description
Admi n St at e The following Admi n St at e 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
3-130
See Also
config sitebus
Di scover ed
I D/ I D
Displays the unique 14-digit hexidecimal ID value for each
SiteBus device. Every device is hard-coded with a unique
Remote RMM-1400.
Last Updat ed
Ti me
Displays the date and time when device status was last updated.
Oper St at e The following Oper St at e values are listed:
Onl i ne indicates that a configured device has a valid device
type and has been discovered by RMB.
Of f l i ne indicates that a configured device has an invalid
device type and/or has not been discovered by RMB.
Per i pher al Displays the RMB peripheral to which this device is connected.
Suppor t ed
Types
Displays the device types a discovered (but unconfigured)
device can support.

Type Displays the device type, which determines how data from the
device will be interpreted and what points will be created for the
device.

Show Commands: show snmp
3-131
showsnmp
Description
This command displays currently configured SNMP settings. SNMP community
strings provide embedded password access to MIB contents.
Formats
show snmp
communities
hosts
summary
Parameters
Examples
This 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.
( Dub) >show
( Dub) show>snmp
( Dub) show snmp>communi t i es
Name Type Mode
admi ni st r at or v2 r eadwr i t e
comm2 v1 r eadwr i t e
mycomm v2 r eadwr i t e
publ i c v2 r eadonl y
( Dub) show snmp>
3-132
This example displays the current management stations in the trap table.
This example displays a summary of the SNMP agent configuration.
Column Description
Mode Displays the community string modes. Possible modes are:
r eadonl y, which permits read only access to all objects in the MIB
r eadwr i t e, 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) and v2 (which specifies SNMP version 2c).
( Dub) >show
( Dub) show>snmp
( Dub) show snmp>host s
I P Addr ess Por t Type Communi t y Tr ap Queue
10. 40. 56. 3 21 v2 mycomm sendi ng
10. 50. 80. 90 162 v2 admi ni st r at or queui ng
10. 39. 3. 80 162 v2- i nf or m admi ni st r at or sendi ng
( Dub) show snmp>
( Dub) >show
( Dub) show>snmp
( Dub) show snmp>summar y
Aut hent i cat i on t r aps: enabl ed
Tr ap queue: enabl ed
Communi t i es:
Name Type Mode
admi ni st r at or v1 r eadwr i t e
newadmi ni st r at or v1 r eadonl y
publ i c v1 r eadonl y
Host s:
I P Addr ess Por t Type Communi t y Tr ap Queue
10. 50. 80. 90 162 v2 newadmi ni st r at or queui ng
10. 40. 56. 3 21 v2 mycomm sendi ng
10. 39. 3. 80 162 v2- i nf or m admi ni st r at or sendi ng
Pr i or i t y:
Tr ap OI D Pr i or i t y
. 1. 3. 6. 1. 6. 4. 1. 1. 3. 1 hi gh
. 1. 3. 6. 1. 6. 4. 1. 2. 4. 1 l ow
( Dub) show snmp>
Column Description
Communi t y Displays the community string that represents the management
station.
3-133
See Also
config snmp
I P
Addr ess
Displays the IP address for the management station.
Por t Displays the port number for the management station.
Pr i or i t y Displays the priority level that is assigned to traps that match the
specified Tr ap OI D value.
Tr ap OI D Displays the OID (Object Identifier) value that is matched against the
OID of an incoming trap.
Tr ap
Queue
Displays the status of trap queuing for the management station.
Possible values are:
sendi ng, which indicates that all traps are immediately sent to
the host
queui ng, 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-i nf or m, which specifies that an SNMP version 2 inform
request is sent to a management station.
Show Commands: show test alarm-entries
3-134
showtestalarm-entries
Description
This 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.
Formats
show test alarm-entries [ nopage ]
Parameters
Examples
This example displays five alarm entries currently being simulated in test mode.
See Also
diag test alarm-entry
diag test mode
nopage Displays the entire list of alarm entries upon execution of the
outputs the list of alarm entries one page at a time.
( Dub) >show
( Dub) show>t est
( Dub) show t est > al ar m- ent r i es
Name St at e Cur r ent al ar mmessage
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Expl osi ve_Gas nor mal Expl osi ve Gas Not Det ect ed
GPS_Fai l ur e nor mal GPS Nor mal
Gener at or _Oi l Pr essur nor mal - - -
NewTest nor mal - - -
Toxi c_Gas nor mal - - -
( Dub) show t est
Show Commands: show test mode
3-135
showtestmode
Description
This 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.
Formats
show test mode
Examples
This example displays the current test mode as Di sabl ed.
This example displays the current test mode as Enabl ed, and that test mode will
remain enabled for 290 seconds before reverting to Di sabl ed.
See Also
diag test mode
( Dub) >show t est mode
Test Mode: Di sabl ed
( Dub) >
( Dub) >show t est mode
Test Mode: Enabl ed
Test Dur at i on: 290 second( s)
( Dub) >
Show Commands: show timeout
3-136
showtimeout
Description
This command displays the amount of time that can elapse before a Remote RMM-
1400 session expires due to inactivity.
Formats
show timeout
Examples
This example displays the current timeout configuration, which is set to 60 mi nut es.
This example displays the current timeout configuration, which is set to never time
out.
See Also
config timeout
( Dub) >show
( Dub) show>t i meout
The sessi on t i meout i s set t o 60 mi nut es.
( Dub) show>
( Dub) >show
( Dub) show>t i meout
The sessi on t i meout i s set t o never t i me out .
( Dub) show>
Show Commands: show timers
3-137
showtimers
Description
This command displays information for all currently running Remote RMM-1400
mediation timers.
Formats
show timers
Examples
This example displays the name, duration, and life-cycle for all running mediation
timers.
See Also
debug mediation
( Dub) >show
( Dub) show>t i mer s
Ti mer Name: cont Up
Dur at i on: 500
Li f e cycl e: one- shot
Ti mer Name: downTi me
Dur at i on: 300
Li f e cycl e: one- shot
( Dub) show>
Show Commands: show users
3-138
showusers
Description
This command displays the locally configured Remote RMM-1400 users with their
corresponding profiles.
Formats
show users
Examples
This 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-
181.
( Dub) >show user s
St r ong Passwor d Suppor t : enabl ed
Logi n Name Pr of i l e
1. t echcomm management
2. t est super vi sor
3. j ef f st at us
4. ebh r est r i ct ed
( Dub) >
Show Commands: show version
3-139
showversion
Description
This command displays the software version and the build information for Remote
RMM-1400.
Formats
show version
Examples
This example displays the Remote RMM-1400 version level.
( Dub) >show ver si on
Pr oduct : Remot e RMM- 1400
Ver si on: 2. 00
Bui l d dat e: 2010- 11- 22, 16: 46: 13. 0, +0000
Bui l d I D: 015
I mage t ype: KTX544- Pr oduct i on
Boot l oader Ver si on: 1. 00
( Dub) >
Show Commands: show version
3-140
4-1
4
DiagnosticCommands
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.
The diag Command Overview
List of diag Commands
Diagnostic Commands: The diag Command Overview
4-2
ThediagCommandOverview
Diagnostic 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.
ListofdiagCommands
The 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) >di ag [ ? does not di spl ay i n CLI ]
Commands
br eak Ter mi nat es a shel l connect i on.
cl ear ( +) Cl ear s st at i st i cal count er s.
cont r ol l er ( +) Di spl ays di agnost i c i nf or mat i on f or a
cont r ol l er .
i p( +) Di spl ays di agnost i c I P i nf or mat i on.
l i ne- moni t or Pr ovi des l ow- l evel moni t or i ng of
asynchr onous ser i al por t s.
l i ne- st at us Pr ovi des cont r ol si gnal st at us of
asynchr onous ser i al por t s.
medi at i on( +) Pr ovi des di agnost i c medi at i on commands.
mmdi spl ay Di spl ays medi at i on messages.
out put Cont r ol s a r el ay out put .
per i pher al ( +) Pr ovi des di agnost i c commands f or
per i pher al s.
ps Di spl ays pr ocess st at us.
snapshot Capt ur es cur r ent syst emdi agnost i cs f or
anal ysi s.
t cpdump Di spl ays t he header s of packet s r ecei ved
on an i nt er f ace.
t est ( +) Pr ovi des access t o di agnost i c t est i ng
commands.
t op Di spl ays t op CPU pr ocesses ( t he most CPU
i nt ensi ve t asks) .
who Di spl ays user s cur r ent l y l ogged i n.
whoami Di spl ays l ogi n name of cur r ent user .
( Dub) >di ag
Diagnostic Commands: diag break
4-3
diagbreak
Description
This command terminates a Remote RMM-1400 shell connection. Remote RMM-
1400 shell connections are terminated using the terminal name for a connection.
Formats
diag break tty
Parameters
supervisor
Examples
This example displays the termination of a shell connection with terminal name
t t yp1.
See Also
diag who
tty Defines the terminal name for the shell connection being terminated.
Terminal names appear in the second column of the output for command
diag who.
( Dub) >di ag
( Dub) di ag>br eak t t yp1
( Dub) di ag>
Diagnostic Commands: diag clear
4-4
diagclear
Description
These commands reset alarm settings to their default values and clear IP table rule
and interface counters.
Formats
diag clear
alarm-entry { alarm | * }
counters
Parameters
Examples
This 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:
alarmDefines the name of an alarm entry for configuration in
the central alarm table. Valid values are alphanumeric
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-61 and
show iptables on page 3-78.
( Dub) >di ag
( Dub) di ag>cl ear
( Dub) di ag cl ear >al ar m- ent r y t _6_1_36
( Dub) di ag cl ear >count er s
( Dub) di ag cl ear >
Diagnostic Commands: diag clear
4-5
See Also
config alarm-entry
show alarm-entries
show interfaces
Diagnostic Commands: diag controller bridge switch dhcp
4-6
diagcontrollerbridgeswitchdhcp
Description
This command manually releases or renews the current DHCP lease.
Formats
diag controller bridge switch dhcp
release
renew
Parameters
Examples
This example displays releasing the current DHCP lease.
See Also
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.
( Dubl i n- TC) >di ag
( Dubl i n- TC) di ag>cont r ol l er br i dge swi t ch
( Dubl i n- TC) di ag cont r ol l er br i dge swi t ch>dhcp
( Dubl i n- TC) di ag cont r ol l er br i dge swi t ch dhcp
- >r el ease
( Dubl i n- TC) di ag cont r ol l er br i dge swi t ch dhcp
- >
Diagnostic Commands: diag controller openvpn
4-7
diagcontrolleropenvpn
Description
This 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.
Formats
diag 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.
Diagnostic Commands: diag controller openvpn
4-8
Examples
This example displays a diagnostic connection made to OpenVPN controller cmh1.
See Also
config controller openvpn
show controllers openvpn
( Dub) >di ag cont r ol l er openvpn cmh1 management
>I NFO: OpenVPN Management I nt er f ace Ver si on 1 - - t ype ' hel p' f or mor e i nf o
hel p
Management I nt er f ace f or OpenVPN 2. 0. 6 i 686- pc- l i nux [ SSL] [ LZO] [ EPOLL] bui l t
on Sep 26 2006
Commands:
aut h- r et r y t : Aut h f ai l ur e r et r y mode ( none, i nt er act , noi nt er act ) .
echo [ on| of f ] [ N| al l ] : Li ke l og, but onl y show messages i n echo buf f er .
exi t | qui t : Cl ose management sessi on.
hel p : Pr i nt t hi s message.
hol d [ on| of f | r el ease] : Set / show hol d f l ag t o on/ of f st at e, or
r el ease cur r ent hol d and st ar t t unnel .
ki l l cn : Ki l l t he cl i ent i nst ance( s) havi ng common name cn.
ki l l I P: por t : Ki l l t he cl i ent i nst ance connect i ng f r omI P: por t .
l og [ on| of f ] [ N| al l ] : Tur n on/ of f r eal t i me l og di spl ay
+ show l ast N l i nes or ' al l ' f or ent i r e hi st or y.
mut e [ n] : Set l og mut e l evel t o n, or show l evel i f n i s absent .
net : ( Wi ndows onl y) Show net wor k i nf o and r out i ng t abl e.
passwor d t ype p : Ent er passwor d p f or a quer i ed OpenVPN passwor d.
si gnal s : Send si gnal s t o daemon,
s = SI GHUP| SI GTERM| SI GUSR1| SI GUSR2.
st at e [ on| of f ] [ N| al l ] : Li ke l og, but show st at e hi st or y.
st at us [ n] : Show cur r ent daemon st at us i nf o usi ng f or mat #n.
t est n : Pr oduce n l i nes of out put f or t est i ng/ debuggi ng.
user name t ype u : Ent er user name u f or a quer i ed OpenVPN user name.
ver b [ n] : Set l og ver bosi t y l evel t o n, or show i f n i s absent .
ver si on : Show cur r ent ver si on number .
END
qui t
( Dub) >
Diagnostic Commands: diag controller serial modem
4-9
diagcontrollerserialmodem
Description
Provisions the wireless phone module/modem.
Formats
diag controller serial modem
activate network
namval dir min sid nid
Note: Make sure that the serial controller is disabled before running this command.
For more information, see the config controller serial command.
Parameters
Examples
This example provisions the modem phone numbers, system ID, and network ID.
See Also
activate Valid for EVDO phone modules only. Performs over-the-air activation
of a modem using the following parameter:
net wor kAn alphanumeric abbreviation that identifies a network.
If the modem is already activated, this parameter will update a PRL.
namval Valid for EVDO phone modules only. Provisions the modem using the
following parameters:
di r Directory Number. Must be a 10 digit number.
mi nMobile ID Number. Must be a 10 digit number.
si dSystem ID. Number range is from 0 - 32767.
ni dNetwork lD. Number range is from 0 - 65535.
( Dub) >di ag
( Dub) di ag>cont r ol l er ser i al modem
( Dub) di ag cont r ol l er ser i al modemnamval 6145557890 6145557891 0 12345
Diagnostic Commands: diag ip address show
4-10
diagipaddressshow
Description
These 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 commands optional parameters. If no optional parameters are
entered, Remote RMM-1400 displays information for all known IP addresses.
Formats
diag ip address show
[ deprecated ]
[ dev interface_name ]
[ dynamic ]
[ label pattern ]
[ permanent ]
[ primary ]
[ scope { gl obal | host | l i nk } ]
[ 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_nameDefines 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:
patternDefines the pattern of IP addresses being displayed.
permanent Displays permanent IP addresses.
primary Displays primary IP addresses.
4-11
scope Initiates the display of IP addresses that have a specified scope.
gl obal IP address is valid globally.
host IP address is valid only on the local host.
l i nkIP 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:
prefixDefines 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).
4-12
Examples
This example displays diagnostic information for all known Remote RMM-1400 IP
addresses.
( Dub) >di ag
( Dub) di ag>i p
( Dub) di ag i p>addr ess
( Dub) di ag i p addr ess
- >show
1: l o: <LOOPBACK, UP> mt u 16436 qdi sc noqueue
l i nk/ l oopback 00: 00: 00: 00: 00: 00 br d 00: 00: 00: 00: 00: 00
i net 127. 0. 0. 1/ 8 scope host l o
2: et h0: <BROADCAST, MULTI CAST, PROMI SC, SLAVE, UP> mt u 1514 qdi sc pf i f o_f ast ql en 1
00
l i nk/ et her 00: 40: 72: 0f : a8: c9 br d f f : f f : f f : f f : f f : f f
3: et h1: <BROADCAST, MULTI CAST> mt u 1500 qdi sc noop ql en 100
l i nk/ et her 00: 40: 72: 0f : a8: ca br d f f : f f : f f : f f : f f : f f
4: mi i 0: <BROADCAST, MULTI CAST, UP> mt u 1500 qdi sc noqueue
5: mi i 1: <BROADCAST, MULTI CAST> mt u 1500 qdi sc noqueue
l i nk/ et her 00: 40: 72: 0f : a8: cb br d f f : f f : f f : f f : f f : f f
l i nk/ et her 00: 40: 72: 0f : a8: cc br d f f : f f : f f : f f : f f : f f
7: mi i 3: <BROADCAST, MULTI CAST> mt u 1500 qdi sc noop
l i nk/ et her 00: 40: 72: 0f : a8: cd br d f f : f f : f f : f f : f f : f f
l i nk/ et her 00: 00: 00: 00: 00: 00 br d f f : f f : f f : f f : f f : f f
9: mi i 5: <BROADCAST, MULTI CAST, PROMI SC, MASTER, UP> mt u 1500 qdi sc noqueue
10: br _swi t ch: <BROADCAST, MULTI CAST, UP> mt u 1500 qdi sc noqueue
i net 10. 39. 90. 80/ 16 br d 10. 39. 255. 255 scope gl obal br _swi t ch
11: ovpn_cl i ent : <BROADCAST, MULTI CAST, UP> mt u 1500 qdi sc pf i f o_f ast ql en 100
l i nk/ et her 00: f f : f c: ca: c0: dc br d f f : f f : f f : f f : f f : f f
i net 192. 168. 105. 110/ 24 br d 192. 168. 105. 255 scope gl obal ovpn_cl i ent
28: ppp_modem: <POI NTOPOI NT, MULTI CAST, NOARP, UP> mt u 1500 qdi sc pf i f o_f ast ql en 1
00
l i nk/ ppp
i net 166. 217. 154. 167 peer 10. 64. 64. 64/ 32 scope gl obal ppp_modem
- >
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.
4-13
Flags <> Displays information for the interface associated with each IP
address. One or more of the following can appear:
UPThe 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.
LOOPBACKThe interface does not communicate with
other hosts. All packets are sent to the loopback IP
address for Remote RMM-1400.
BROADCASTThe interface has the ability to send packets
to all other hosts that share the same physical link.
POI NTOPOI NTThe 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.
MULTI CASTThe interface can multicast.
PROMI SCThe interface listens and feeds all the traffic on
the link to the kernel.
ALLMULTI The interface receives all mulitcast packets.
NOARPThe interface does not need any address
resolution. Packets can be delivered without any help
from the protocol stacks.
DYNAMI CThe interface was dynamically created.
SLAVEThe interface is bonded to other interfaces in
order to share link capacities.
mt u 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.
qdi sc Displays the queuing algorithm for the interface associated
with each IP address. One of the following appears:
noopThe interface is in black hole mode. All packets
sent to the interface are discarded.
noqueueThe interface queues nothing.
pf i f o_f ast The interface queues packets using any of
the three available bands based on the packets TOS bits
or assigned priority.
ql en Displays the default transmit queue length (measured in
packets) for the interface associated with each IP address.
Interfaces that do not queue packets (qdi sc set to noop or
noqueue) do not have a default transmit queue length.
4-14
This example displays diagnostic information for pr i mar y IP addresses associated
with interface bridge switch (br _swi t ch).
See Also
diag ip link show
diag ip neighbor show
diag ip route get
diag ip route show
l i nk/ 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.
i net 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 mi i 0, mi i 1, and so

forth) do not have IP addresses.
( Dub) >di ag
( Dub) di ag>i p
( Dub) di ag i p>addr ess
- >show dev br _swi t ch pr i mar y
i net 10. 39. 90. 80/ 16 br d 10. 39. 255. 255 scope gl obal br _swi t ch
- >
Diagnostic Commands: diag ip link show
4-15
diagiplinkshow
Description
These commands display diagnostic link information for Remote RMM-1400. Remote
RMM-1400 displays information for all links that match the criteria specified in this
commands optional parameters. If no optional parameters are entered, Remote
RMM-1400 displays information for all links.
Formats
diag ip link show
[ up ]
Parameters
dev Initiates the display of links for a specified Remote RMM-1400 interface. The
interface_nameDefines the system name for the interface being
displayed..
up Displays information for links that are enabled and functioning.
4-16
Examples
This example displays diagnostic information for all Remote RMM-1400 links.
( Dub) >di ag
( Dub) di ag>i p
( Dub) di ag i p>l i nk
( Dub) di ag i p l i nk
- >show
1: l o: <LOOPBACK, UP> mt u 16436 qdi sc noqueue
l i nk/ l oopback 00: 00: 00: 00: 00: 00 br d 00: 00: 00: 00: 00: 00
2: et h0: <BROADCAST, MULTI CAST, PROMI SC, SLAVE, UP> mt u 1514 qdi sc pf i f o_f ast ql en 1
00
3: et h1: <BROADCAST, MULTI CAST> mt u 1500 qdi sc noop ql en 100
5: mi i 1: <BROADCAST, MULTI CAST> mt u 1500 qdi sc noqueue
l i nk/ et her 00: 40: 72: 0f : a8: cb br d f f : f f : f f : f f : f f : f f
l i nk/ et her 00: 40: 72: 0f : a8: cc br d f f : f f : f f : f f : f f : f f
l i nk/ et her 00: 40: 72: 0f : a8: cd br d f f : f f : f f : f f : f f : f f
l i nk/ et her 00: 00: 00: 00: 00: 00 br d f f : f f : f f : f f : f f : f f
9: mi i 5: <BROADCAST, MULTI CAST, PROMI SC, MASTER, UP> mt u 1500 qdi sc noqueue
11: ovpn_cl i ent : <BROADCAST, MULTI CAST, UP> mt u 1500 qdi sc pf i f o_f ast ql en 100
l i nk/ et her 00: f f : f c: ca: c0: dc br d f f : f f : f f : f f : f f : f f
28: ppp_modem: <POI NTOPOI NT, MULTI CAST, NOARP, UP> mt u 1500 qdi sc pf i f o_f ast ql en 1
00
l i nk/ ppp
- >
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.
4-17
Flags <> Displays information for the interface associated with each
link. One or more of the following can appear:
UPThe 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.
LOOPBACKThe interface does not communicate with
other hosts. All packets are sent to the loopback IP
address for Remote RMM-1400.
BROADCASTThe interface has the ability to send packets
to all other hosts that share the same physical link.
POI NTOPOI NTThe 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.
MULTI CASTThe interface can multicast.
PROMI SCThe interface listens and feeds all the traffic on
the link to the kernel.
ALLMULTI The interface receives all mulitcast packets.
NOARPThe interface does not need any address
resolution. Packets can be delivered without any help
from the protocol stacks.
DYNAMI CThe interface was dynamically created.
SLAVEThe interface is bonded to other interfaces in
order to share link capacities.
mt u 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.
qdi sc Displays the queuing algorithm for the interface associated
with each link. One of the following appears:
noopThe interface is in black hole mode. All packets
sent to the interface are discarded.
noqueueThe interface queues nothing.
pf i f o_f ast The interface queues packets using any of
the three available bands based on the packets TOS bits
or assigned priority.
ql en Displays the default transmit queue length (measured in
packets) for the interface associated with each link. Interfaces
that do not queue packets (qdi sc set to noop or noqueue) do
not have a default transmit queue length.
4-18
This example displays diagnostic information for enabled and functioning links
associated with interface bridge switch (br _swi t ch).
See Also
diag ip route get
diag ip route show
l i nk/ 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) >di ag
( Dub) di ag>i p
( Dub) di ag i p>l i nk
- >show dev br _swi t ch up
- >
Diagnostic Commands: diag ip neighbor show
4-19
diagipneighborshow
Description
These commands display diagnostic neighbor information for Remote RMM-1400.
Remote RMM-1400 displays information for all neighbors that match the criteria
specified in this commands optional parameters. If no optional parameters are
entered, Remote RMM-1400 displays information for all neighbors.
Formats
[ to prefix ]
[ unused ]
[ nud { del ay | f ai l ed | i ncompl et e | noar p | none | per manent
| pr obe | r eachabl e | st al e } ]
Parameters
to Initiates the display of neighbors with a specified destination IP address
prefix. The following parameter is accepted:
prefixDefines 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-
interface_nameDefines the system name for the interface being
displayed.
unused Displays information for neighbors that are not currently in use.
nud Initiates the display of neighbors in a specified NUD state. The following
del ayPacket has been sent to stale neighbor.
f ai l edResolution has failed.
i ncompl et eNeighbor is in process of resolution.
noar pNeighbor is valid.
noneState of neighbor is void.
per manent Neighbor is valid and can be removed only
administratively.
pr obeDelay timer expired, but no confirmation was received.
r eachabl eNeighbor is valid and reachable.
st al eNeighbor is valid, but probably already unreachable.
Diagnostic Commands: diag ip neighbor show
4-20
Examples
This 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 r eachabl e.
See Also
diag ip link show
diag ip route get
diag ip route show
( Dub) >di ag
( Dub) di ag>i p
( Dub) di ag i p>nei ghbor
( Dub) di ag i p nei ghbor
- >show
10. 39. 0. 1 dev br _swi t ch l l addr 00: 21: f 7: 6d: 08: 00 nud del ay
192. 168. 105. 1 dev ovpn_cl i ent l l addr 00: f f : 5c: d6: eb: 9a nud st al e
10. 39. 3. 102 dev br _swi t ch l l addr 00: 01: 02: cc: 3e: 8f nud st al e
- >
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.
l l addr Displays the link layer address of each neighbor.
nud Displays the NUD state of each neighbor.
( Dub) >di ag
( Dub) di ag>i p
( Dub) di ag i p>nei ghbor
- >show t o 10. 39/ 16 nud r eachabl e
10. 39. 0. 1 dev br _swi t ch l l addr 00: 21: f 7: 6d: 08: 00 nud r eachabl e
- >
Diagnostic Commands: diag ip route get
4-21
diagiprouteget
Description
These commands find a route to a specified destination and then display diagnostic
information for the route.
Formats
diag 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 routes 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.
interface_nameDefines the system name for
the interface being displayed.
tos Finds and displays a route with a specified type of
service value. The following parameter is accepted:
tosDefines the type of service value for the
route being found and displayed.
4-22
Examples
This 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) >di ag
( Dub) di ag>i p
( Dub) di ag i p>r out e
( Dub) di ag i p r out e
- >get 128. 5. 99. 2
128. 55. 99. 2 vi a 192. 168. 105. 1 dev ovpn_cl i ent sr c 192. 168. 105. 110
cache mt u 1500 advmss 1460
- >
Destination IP address Displays the destination IP address for the route.
f r om Displays the source IP address for the route.
vi a Displays the gateway through which the route is
reachable.
interface through which the route goes.
sr c Displays the source IP address for the route.
cache Displays route characteristics (for example, MTU).
mt u 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.
4-23
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 _swi t ch).
See Also
diag ip link show
diag ip route show
( Dub) >di ag
( Dub) di ag>i p
- >get 128. 25. 45. 2 oi f br _swi t ch
128. 25. 45. 2 dev br _swi t ch sr c 10. 39. 90. 80
cache mt u 1500 advmss 1460
- >
Diagnostic Commands: diag ip route show
4-24
diagiprouteshow
Description
These 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 commands optional parameters. If no optional
parameters are entered, Remote RMM-1400 displays information for all routes in the
IP routing table.
Formats
diag ip route show
[ exact ip_address ]
[ from { prefix | r oot prefix | mat ch prefix | exact ip_address
} ]
[ match prefix ]
[ protocol { boot | gat ed | ker nel | r a | r edi r ect } ]
[ root prefix ]
[ scope { gl obal | host | l i nk } ]
[ src prefix ]
[ table { al l | cache | l ocal | mai n | table_id } ]
[ to { prefix | r oot prefix | mat ch prefix | exact ip_address }
]
[ tos tos ]
[ type { bl ackhol e | br oadcast | l ocal | mul t i cast | nat |
pr ohi bi t | t hr ow | uni cast | unr eachabl e } ]
[ via prefix ]
Parameters
dev Initiates the display of routes going through a specified Remote RMM-
interface_nameDefines the system name for the interface
being displayed.
exact Displays a route with a specified IP address. The following parameter
is accepted:
ip_addressDefines the IP address of routes being displayed.
4-25
from Displays routes with specified source IP address parameters. The
exact Displays routes with specified source IP addresses.
ip_addressDefines the IP address of routes to be displayed.
mat chDisplays routes with source IP address prefixes equal to
or shorter than a specified source IP address prefix.
prefixDefines 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, 10. 39/ 16).
r oot 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:
protocol Displays routes associated with a specified routing protocol. The
boot Route was received during the boot up sequence.
gat edRoute was entered using the CLI.
ker nel Route was received as part of the route configuration
that occurs when Remote RMM-1400 is booted.
r aRoute was received by the Router Discovery Protocol. The
default is boot .
r edi r ect Route was received as the result of a redirect.
root Displays routes with IP address prefixes equal to or longer than a
scope Displays routes that have a specified scope. The following parameters
are accepted:
gl obal Route is valid globally.
host Route is valid only on the local host.
l i nkRoute is valid only on Remote RMM-1400.
src Initiates the display of routes with a preferred source IP address prefix.
4-26
table Displays routes in a specified IP routing table. The following
al l Specifies all IP routing tables
cacheSpecifies the IP routing cache
l ocal Specifies the local IP routing table
mai nSpecifies the main IP routing table (IP routing table ID 254).
This is the default value.
table_idDefines 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_addressDefines the IP address of routes to be displayed.
mat chDisplays routes with destination IP address prefixes equal
to or shorter than a specified destination IP address prefix.
r oot 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
tosDefines the type of service value associated with routes
being displayed.
4-27
type Displays routes of a specified type. The following parameters are
accepted:
bl ackhol eThe route destination is unreachable. Packets going
to route destination are silently dropped.
br oadcast The route destination is a broadcast address.
l ocal The route destination is assigned to Remote RMM-1400.
Packets are looped back and delivered locally.
mul t i cast The route is a mulitcast route.
nat The route is a special NAT route. Route destination must be
translated before forwarding can occur.
pr ohi bi t The route destination is unreachable. Sender will
receive a message specifying that the route destination is
unreachable.
t hr owThe route causes a route lookup in a routing table to fail,
returning the routing selection process to the routing policy
database.
uni cast The route is a real path to another host.
unr eachabl eThe 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
4-28
Examples
This example displays diagnostic information for all routes in the main IP routing
table.
Note: Not all display items appear for each route.

( Dub) >di ag
( Dub) di ag>i p
- >show
10. 34. 0. 0/ 16 vi a 10. 39. 0. 1 dev br _swi t ch pr ot o gat ed
10. 39. 0. 0/ 16 dev br _swi t ch pr ot o ker nel scope l i nk sr c 10. 39. 90. 80
169. 254. 0. 0/ 16 dev br _swi t ch scope l i nk
10. 44. 0. 0/ 16 vi a 10. 39. 0. 1 dev br _swi t ch pr ot o gat ed
64. 0. 0. 0/ 8 dev ppp_modem pr ot o gat ed scope l i nk
unr eachabl e 127. 0. 0. 0/ 8 pr ot o gat ed scope nowher e
def aul t vi a 192. 168. 105. 1 dev ovpn_cl i ent pr ot o gat ed
- >
Destination IP address/
subnet mask
Displays the destination IP address and/or subnet mask
of each route. unr eachabl e specifies that the destination
is unreachable. def aul t specifies that the route is a
default route.
vi a Displays the gateway through which the route is
reachable.
interface through which each route goes.
pr ot o Displays the routing protocol for each route.
scope Displays the scope of each route. Scope specifies the
area where the route is valid. Valid values are:
gl obal Route is valid globally.
host Route is valid only on the local host.
l i nkRoute is valid only on Remote RMM-1400.
sr c Displays the source IP address for each route.
4-29
This example displays diagnostic information for routes going through interface bridge
switch (br _swi t ch).
See Also
diag ip link show
( Dub) >di ag
( Dub) di ag>i p
- >show dev br _swi t ch
10. 34. 0. 0/ 16 vi a 10. 39. 0. 1 pr ot o gat ed
10. 39. 0. 0/ 16 pr ot o ker nel scope l i nk sr c 10. 39. 90. 80
169. 254. 0. 0/ 16 scope l i nk
10. 44. 0. 0/ 16 vi a 10. 39. 0. 1 pr ot o gat ed
- >
Diagnostic Commands: diag line-monitor
4-30
diagline-monitor
Description
This 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.
Formats
diag line-monitor port [ port ... ]
Parameters
port Defines the physical connector associated with the controller on Remote
RMM-1400. Valid values are ser i al - 1 to ser i al - 4 and consol e.
Note: A supervisor user profile is required to monitor a console.

Diagnostic Commands: diag line-monitor
4-31
Examples
This example displays line monitoring for asynchronous serial port ser i al - 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 Also
diag line-status
( Dub) >di ag
( Dub) di ag>l i ne- moni t or ser i al - 1
[ ser i a- 1] T> 07 .
[ ser i a- 1] T> 00 .
[ ser i a- 1] T> 00 .
[ ser i a- 1] T> 01 . h
***St ar t i ng Hex- Onl y Di spl ay Mode***
[ ser i al - 1] T> 01 02 02 03m
***St ar t i ng Mi xed Di spl ay Mode***
[ ser i al - 1] T> <03> <04> <04> <05>c
***St ar t i ng 2 Col umn Di spl ay Mode***
[ ser i a- 1] T> 05 .
[ ser i a- 1] T> 06 .
[ ser i a- 1] T> 06 .
[ ser i a- 1] T> 07 .
Diagnostic Commands: diag line-status
4-32
diagline-status
Description
This command displays the asynchronous control signals and administrative states
for an asynchronous port or group of ports.
Formats
diag line-status port [ port ... ]
Parameters
Examples
This example displays the asynchronous control signals and administrative states for
serial ports consol e, ser i al - 2, and ser i al - 3.
See Also
diag line-monitor
port Defines the physical connector associated with the controller on Remote
RMM-1400. Valid values are ser i al - 1 to ser i al - 4 and consol e.
( Dub) >di ag
( Dub) di ag>l i ne- st at us consol e ser i al - 2 ser i al - 3
Por t Admi n Li nk DSR DCD CTS DTR RTS
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ser i al - 2 enabl ed up - - - + +
ser i al - 3 enabl ed up - - - + +
consol e enabl ed up + + - + +
( Dub) di ag>
Diagnostic Commands: diag mediation snmpne poll
4-33
diagmediationsnmpnepoll
Description
This command forces a poll for current point states on a mediation SNMP network
element.
Formats
diag mediation snmpne name poll
Parameters
Examples
In this example, mediation SNMP NE MyNE is set to be polled:
See Also
debug mediation
show mediation
name The name of the mediation SNMP NE. Valid values are
( Dub) di ag medi at i on snmpne MyNE
( Dub) di ag medi at i on snmpne MyNE>pol l
( Dub) di ag medi at i on snmpne MyNE>
Diagnostic Commands: diag mmdisplay
4-34
diagmmdisplay
Description
This 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.
Formats
diag mmdisplay
event
eventresponse
regex regex
response
verbose
Parameters
event Displays event mediation messages.
eventresponse Displays event and response mediation messages.
regex Displays messages that match a regular expression. The
regexDefines 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.
Diagnostic Commands: diag mmdisplay
4-35
Examples
This example displays all Remote RMM-1400 mediation messages.
This example displays Remote RMM-1400 event mediation messages only.
( Dub) >di ag
( Dub) di ag>mmdi spl ay
Pr ess Ct r l - C t o r et ur n t o t he CLI
< r out er | command=r egi st er | dest i nat i on=Pr i nt Log7566 | r egex=. * | si ze=10000 >
< event | or i gi nat or =anal og 1/ 1 | t r i gger Event =i nt er val | val ue=0. 00 mA >
( Dub) di ag>
( Dub) >di ag
( Dub) di ag>mmdi spl ay event
Pr ess Ct r l - C t o r et ur n t o t he CLI
( Dub) di ag>
Diagnostic Commands: diag output
4-36
diagoutput
Description
These commands open or close a digital output. The output can optionally be opened
or closed for a specified number of seconds.
Formats
diag output unit/point
close [ momentary ]
open [ momentary ]
Parameters
Examples
This example displays a digital output being opened for 12 seconds.
See Also
show discrete
close Closes the digital output. The following parameter is accepted:
momentaryDefines 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:
momentaryDefines 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) di ag>di ag
( Dub) di ag>out put 1/ 2 open 12
( Dub) di ag>
Diagnostic Commands: diag peripheral reload
4-37
diagperipheralreload
Description
This 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.
Formats
diag peripheral { uni t unit | name name | * } reload
[ force-download ]
Parameters
name Specifies the name of the managed peripheral unit. The following
nameThis name consists of a series of letters followed by six
hexadecimal digits representing the unique portion of the
peripheral units MAC address. Names are formatted as follows,
where each X represents a hexadecimal digit:
SER8- XXXXXX for RME-S8 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.
uni t Specifies the peripheral unit number. The following parameter is
accepted:
unitDefines the peripheral unit number. Valid values are 1 to
12.
* Specifies all peripheral units.
Diagnostic Commands: diag peripheral reload
4-38
Example
This example displays the rebooting of RMB unit RMB1- 0E68FD.
See Also
config peripheral
show peripherals
( Dub) >di ag
( Dub) di ag>per i pher al name RMB1- 0E68FD
( Dub) di ag>per i pher al name RMB1- 0E68FD r el oad
Ar e you sur e you wi sh t o r eset t he per i pher al ( s) ? ( y/ N) y
( Dub) di ag per i pher al name DEP- 083B62>
Diagnostic Commands: diag ps
4-39
diagps
Description
This command displays all running Remote RMM-1400 processes.
Formats
diag ps
4-40
Examples
This 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) >di ag
( Dub) di ag>ps
USER PI D %CPU %MEM VSZ RSS TTY STAT START TI ME COMMAND
r oot 1 0. 0 0. 2 1776 520 ? S 03: 51 0: 04 i ni t
r oot 2 0. 0 0. 0 0 0 ? SW 03: 51 0: 00 [ kevent d]
r oot 3 0. 0 0. 0 0 0 ? RWN 03: 51 0: 00 [ ksof t i r qd_CPU0]
r oot 4 0. 0 0. 0 0 0 ? SW 03: 51 0: 00 [ kswapd]
r oot 5 0. 0 0. 0 0 0 ? SW 03: 51 0: 00 [ bdf l ush]
r oot 6 0. 0 0. 0 0 0 ? SW 03: 51 0: 00 [ kupdat ed]
r oot 7 0. 0 0. 0 0 0 ? SW 03: 51 0: 00 [ mt dbl ockd]
r oot 8 0. 0 0. 0 0 0 ? SW 03: 51 0: 00 [ khubd]
r oot 56 0. 0 0. 0 0 0 ? SWN 03: 51 0: 00 [ j f f s2_gcd_mt d6]
r oot 105 0. 0 0. 8 5376 2228 ? S 03: 51 0: 00 / usr / sbi n/ daemonr
r oot 106 0. 0 2. 2 11268 5852 ? S 03: 51 0: 01 l ogd
r oot 107 0. 0 2. 2 11268 5852 ? S 03: 51 0: 00 l ogd
r oot 108 0. 0 2. 2 11268 5852 ? S 03: 51 0: 00 l ogd
r oot 115 0. 0 0. 9 11700 2464 ? S 03: 51 0: 00 evt d
r oot 116 0. 0 0. 9 11700 2464 ? S 03: 51 0: 00 evt d
r oot 117 0. 0 0. 9 11700 2464 ? S 03: 51 0: 00 evt d
r oot 118 0. 0 0. 9 11700 2464 ? S 03: 51 0: 00 evt d
r oot 119 0. 0 0. 9 11700 2464 ? S 03: 51 0: 00 evt d
r oot 123 0. 0 2. 8 27680 7360 ? S 03: 51 0: 06 umi d
r oot 124 0. 0 2. 8 27680 7360 ? S 03: 51 0: 00 umi d
r oot 127 0. 0 2. 8 27680 7360 ? S 03: 51 0: 00 umi d
r oot 128 0. 0 2. 8 27680 7360 ? S 03: 51 0: 00 umi d
r oot 129 0. 0 2. 8 27680 7360 ? S 03: 51 0: 03 umi d
r oot 130 0. 0 2. 8 27680 7360 ? S 03: 51 0: 02 umi d
r oot 131 0. 0 2. 8 27680 7360 ? S 03: 51 0: 04 umi d
r oot 132 0. 0 2. 8 27680 7360 ? S 03: 51 0: 03 umi d
r oot 154 0. 0 0. 7 4796 1972 ? S 03: 51 0: 00 / usr / sbi n/ gat ed
Column Description
USER Displays the names of users who own the corresponding processes.
4-41
See Also
diag who
diag whoami
PI D 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.
TI ME Displays the time the process was started.
COMMAND Displays the name of the command being executed.
Diagnostic Commands: diag snapshot
4-42
diagsnapshot
Description
This command creates a file named snapshot . t ar . 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.

Formats
diag snapshot
supervisor
Examples
This example displays the execution of command diag snapshot.
See Also
diag ps
diag top
diag who
diag whoami
( Dub) >di ag
( Dub) di ag>snapshot
( Dub) di ag>
Diagnostic Commands: diag tcpdump
4-43
diagtcpdump
Description
This 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 commands optional parameters. If no optional parameters are
entered, Remote RMM-1400 displays the headers of all packets received.
Note: For more detailed information about this command, refer to the man page for
command tcpdump.
Formats
diag 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
countDefines 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.
- E Initiates the decrypting of IPsec ESP packets based on a specified
algorithm and secret. The following parameters are accepted:
algoDefines the algorithm used to decrypt IPsec ESP
packets. Valid values are des- cbc, 3des- cbc, bl owf i sh- cbc,
r c3- cbc, cast 128- cbc, and none.
secretDefines the ASCII text for the ESP secret key.
- f Displays foreign IP addresses numerically rather than
symbolically.
4-44
- 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.
interfaceDefines 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:
snaplenDefines the number of bytes of data to grab from
each packet.
- S Displays absolute, rather than relative, TCP sequence numbers.
- t Specifies that Remote RMM-1400 will not display a timestamp for
each displayed packet header.
4-45
Examples
This example displays the headers of all packets received on the default interface
(br _swi t ch or br i dge swi t ch). Remote RMM-1400 displays packet headers in a
line-buffered format.
- T Initiates the interpretation of packets of a specific type. The
cnf pCisco NetFlow Protocol packets
r pcRemote Procedure Call packets
r t cpReal-Time Applications Control Protocol packets
r t pReal-Time Applications Protocol packets
snmpSimple Network Management Protocol packets
vat Visual Audio Tool packets
wbDistributed 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.
4-46
Note: Press CTRL+c to terminate the display of packet headers.

( Dub) >di ag
( Dub) di ag>t cpdump - l
t cpdump: l i st eni ng on br _swi t ch
16: 37: 01. 696704 10. 44. 7. 6. 2384 > 10. 39. 90. 80. t el net : . ack 2484415291 wi n 63642
( DF)
16: 37: 01. 696888 10. 39. 90. 80. t el net > 10. 44. 7. 6. 2384: P 1: 34( 33) ack 0 wi n 5840 (
DF)
16: 37: 01. 869630 ar p who- has 10. 39. 68. 20 ( 3a: 73: e7: 30: 18: 6) t el l 10. 39. 0. 1
16: 37: 01. 915458 10. 44. 7. 6. 2384 > 10. 39. 90. 80. t el net : . ack 34 wi n 63609 ( DF)
16: 37: 01. 915643 10. 39. 90. 80. t el net > 10. 44. 7. 6. 2384: P 34: 580( 546) ack 0 wi n 584
0 ( DF)
16: 37: 02. 134204 10. 44. 7. 6. 2384 > 10. 39. 90. 80. t el net : . ack 580 wi n 63063 ( DF)
16: 37: 02. 134392 10. 39. 90. 80. t el net > 10. 44. 7. 6. 2384: P 580: 746( 166) ack 0 wi n 58
40 ( DF)
16: 37: 02. 347449 0: 40: 72: e: 68: f 6 > 1: 40: 72: 1: 1: 1 snap ui / C l en=241
16: 37: 02. 352957 10. 44. 7. 6. 2384 > 10. 39. 90. 80. t el net : . ack 746 wi n 64512 ( DF)
16: 37: 02. 353141 10. 39. 90. 80. t el net > 10. 44. 7. 6. 2384: P 746: 981( 235) ack 0 wi n 58
40 ( DF)
16: 37: 02. 571710 10. 44. 7. 6. 2384 > 10. 39. 90. 80. t el net : . ack 981 wi n 64277 ( DF)
16: 37: 02. 571932 10. 39. 90. 80. t el net > 10. 44. 7. 6. 2384: P 981: 1149( 168) ack 0 wi n 5
840 ( DF)
16: 37: 02. 790470 10. 44. 7. 6. 2384 > 10. 39. 90. 80. t el net : . ack 1149 wi n 64109 ( DF)
16: 37: 02. 790654 10. 39. 90. 80. t el net > 10. 44. 7. 6. 2384: P 1149: 1318( 169) ack 0 wi n
5840 ( DF)
23 packet s r ecei ved by f i l t er
0 packet s dr opped by ker nel
( Dub) di ag>
t cpdump Displays the system name for the interface for which
packets are being displayed.
Packet headers Displays all packet headers that match the specified
criteria.
packet s r ecei ved by
f i l t er
Displays the number of packets received on the
interface while the command was executing.
packet s dr opped by
ker nel
Displays the number of packets dropped by the kernel.
4-47
This example displays the headers of all packets received on interface ser i al modem.
Remote RMM-1400 displays absolute, rather than relative, TCP sequence numbers
and does not display a timestamp for each packet header.
( Dub) >di ag
( Dub) di ag>t cpdump - i ser i al modem- S - t
t cpdump: l i st eni ng on ppp_modem
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)
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 packet s r ecei ved by f i l t er
0 packet s dr opped by ker nel
( Dub) di ag>
Diagnostic Commands: diag test alarm-entry
4-48
diagtestalarm-entry
Description
This command specifies alarms in the alarm table to be tested. Test notifications will
be sent for all alarm states for each alarm entry specified.
Formats
diag test alarm-entry { alarm_name | alarm_name_filter }
Parameters
Examples
In this example, test notifications will be sent for alarm entry Bat t er y_A:
In this example, test notifications will be sent for all alarm entries in the alarm table:
See Also
diag test mode
show test alarm-entries
show 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.
( Dub) >di ag
( Dub) di ag>t est
( Dub) di ag t est >al ar m- ent r y Bat t er y_A
( Dub) di ag t est >
( Dub) >di ag
( Dub) di ag>t est
( Dub) di ag t est >al ar m- ent r y *
Diagnostic Commands: diag test mode
4-49
diagtestmode
Description
This 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.
Formats
diag test mode { di sabl e | enabl e [ timeout ] }
Parameters
Examples
In 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
show test alarm-entries
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) >di ag
( Dub) di ag>t est
( Dub) di ag t est >mode enabl e 15
( Dub) >di ag
( Dub) di ag>t est
( Dub) di ag t est >mode di sabl e
Diagnostic Commands: diag top
4-50
diagtop
Description
This 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
(bat ch).
Formats
diag top [ bat ch [ iterations ] ]
Parameters
Command Defaults
One 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:
iterationsDefines the number of times the top CPU processes
will be displayed.
4-51
Examples
This 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 (bat ch).
Type q to exit the display of top CPU processes.
( Dub) >di ag
( Dub) di ag>t op
16: 46: 03 up 6 days, 5: 29, 4 user s, l oad aver age: 1. 00, 1. 00, 0. 91
197 pr ocesses: 195 sl eepi ng, 2 r unni ng, 0 zombi e, 0 st opped
CPU st at es: 0. 4%user , 0. 5%syst em, 0. 0%ni ce, 99. 2%i dl e
Mem: 257152K t ot al , 137132K used, 120020K f r ee, 1296K buf f er s
Swap: 0K t ot al , 0K used, 0K f r ee, 80640K cached
PI D USER PRI NI SI ZE RSS SHARE STAT %CPU %MEM TI ME COMMAND
14253 t est 16 0 1264 1264 920 R 19. 8 0. 4 0: 00 t op
1 r oot 8 0 520 520 440 S 0. 0 0. 2 0: 04 i ni t
2 r oot 9 0 0 0 0 SW 0. 0 0. 0 0: 00 kevent d
3 r oot 19 19 0 0 0 SWN 0. 0 0. 0 0: 09 ksof t i r qd_CPU0
4 r oot 9 0 0 0 0 SW 0. 0 0. 0 0: 00 kswapd
5 r oot 9 0 0 0 0 SW 0. 0 0. 0 0: 00 bdf l ush
6 r oot 9 0 0 0 0 SW 0. 0 0. 0 0: 00 kupdat ed
7 r oot 9 0 0 0 0 SW 0. 0 0. 0 0: 00 mt dbl ockd
8 r oot 9 0 0 0 0 SW 0. 0 0. 0 0: 00 khubd
56 r oot 15 10 0 0 0 SWN 0. 0 0. 0 0: 00 j f f s2_gcd_mt d6
105 r oot 9 0 2228 2228 1968 S 0. 0 0. 8 0: 00 daemonr unner
106 r oot 9 0 6100 6100 2212 S 0. 0 2. 3 0: 04 l ogd
107 r oot 9 0 6100 6100 2212 S 0. 0 2. 3 0: 00 l ogd
108 r oot 9 0 6100 6100 2212 S 0. 0 2. 3 0: 02 l ogd
114 r oot 9 0 2200 2200 1944 S 0. 0 0. 8 0: 00 daemonr unner
115 r oot 9 0 2472 2472 2132 S 0. 0 0. 9 0: 01 evt d
Column Description
PI D Displays the process ID for each task.
USER Displays the user name of the task's owner.
PRI Displays the priority for each task.
4-52
See Also
diag ps
diag who
diag whoami
NI Displays the nice value of the task. Negative nice values are higher
priority.
SI ZE 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.
TI ME 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.
Diagnostic Commands: diag who
4-53
diagwho
Description
This command displays all users logged into Remote RMM-1400.
Formats
diag who
Examples
This example displays the terminal names, login dates/times, and workstation IP
addresses for all users logged into Remote RMM-1400.
See Also
diag break
diag whoami
show users
( Dub) >di ag
( Dub) di ag>who
ai t t yp0 Sep 14 14: 36 ( 10. 40. 5. 11)
br b22 t t yp1 Sep 14 14: 43 ( 10. 40. 5. 20)
( Dub) di ag>
Diagnostic Commands: diag whoami
4-54
diagwhoami
Description
This command displays the terminal name for a user logged into Remote RMM-1400.
Formats
diag whoami
Examples
This example displays the terminal name (br b22) for the user logged into
Remote RMM-1400.
See Also
diag who
show users
( Dub) >di ag
( Dub) di ag>whoami
br b22
( Dub) di ag>
5-1
5
UtilityCommands
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
Utility Commands: Utility Commands Overview
5-2
UtilityCommandsOverview
The 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.
Utility Commands: List of Utility Commands
5-3
ListofUtilityCommands
The following is a partial list of the global commands from the CLI, displaying only
those in the utility category. This is followed by the listing of the debug subcommands.
Remember that a command with a ( +) indicates subcommands.
( Dub) > [ ? does not di spl ay i n CLI ]
Gl obal Commands [ di spl ayi ng onl y ut i l i t y commands]
copy Cr eat es a copy of a conf i gur at i on or
pat ch conf i gur at i on f i l e.
debug( +) Enabl es or di sabl es sessi on l og out put .
er ase Er ases ( r emoves) a conf i gur at i on or pat ch
exec- j ob( +) Cont r ol s t he execut i on of j obs.
exec- ki l l ( +) Ter mi nat es a speci f i ed medi at i on
connect i on.
exi t Exi t s up one l evel i n t he command
hi er ar chy.
hel p Descr i bes how t o access hel p.
l ogout Logs out and t er mi nat es t he sessi on.
passwor d Changes t he passwor d f or t he cur r ent
user .
pi ng Test s net wor k connect i vi t y t o a r emot e
host .
r el oad Reset s t he syst em.
conf i gur at i on.
t el net Est abl i shes a Tel net sessi on.
t r ace- r out e Tr aces net wor k r out i ng t o a r emot e host .
( Dub) >debug
Commands
et her net ( +) Enabl es or di sabl es debug i nf or mat i on
l oggi ng f or Et her net cont r ol l er and
i nt er f ace event s.
l evel ( +) Conf i gur es t he l evel of debug messages
di spl ayed on t he CLI .
medi at i on( +) Conf i gur es medi at i on debuggi ng.
openvpn( +) Enabl es or di sabl es debug i nf or mat i on
l oggi ng f or OpenVPN event s.
ppp( +) Enabl es or di sabl es debug i nf or mat i on
l oggi ng f or PPP.
ser i al ( +) Enabl es or di sabl es debug i nf or mat i on
l oggi ng f or ser i al cont r ol l er and
i nt er f ace event s.
snmp( +) Conf i gur es SNMP debuggi ng.
( Dub) >debug
Utility Commands: copy
5-4
copy
Description
This command copies a configuration file to the specified file name in the / conf i g
directory on the Remote RMM-1400 FTP server.
Formats
copy 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
f act or y-
conf i g
This configuration file contains the factory defaults for Remote
RMM-1400. For example, if you copy the f act or y- conf i g to the
r unni ngconf i g, Remote RMM-1400 is reset to its default
configuration.
Important: New information cannot be copied to the
f act or y- conf i g file. Additionally, if you copy
f act or y- conf i g to r unni ngconf i g, you will have
to reconfigure all previously configured settings.
r unni ng-
conf i g
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
r unni ngconf i g file can be used as the source or destination file
name.
Utility Commands: copy
5-5
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.
Examples
This example displays the copying of the current running configuration file
(r unni ngconf i g), which contains all the current configuration settings and
customization, to the startup configuration file (st ar t up- conf i g).
This example displays the copying of the configuration file (r unni ngconf i g) to a
destination file named myconf i g.
See Also
erase
running-config
show config-file
r unni ng-
st ar t up
This file copies a configuration to both the r unni ngconf i g and
st ar t up- conf i g files at the same time. The following rules apply
to r unni ng- st ar t up:
It is write-only.
It is valid only as a destination file name. Users cannot copy
r unni ng- st ar t up to another file.
Users cannot copy r unni ngconf i g or st ar t up- conf i g to
r unni ng- st ar t up.
st ar t up-
conf i g
This configuration file contains the configuration at start-up time
for Remote RMM-1400. If r unni ngconf i g is copied to
st ar t up- conf i g, the settings in the r unni ngconf i g file
become the settings applied at start-up time. When executing the
copy command, the st ar t up- conf i g file can be used as the
source or destination file name.
( Dub) >copy r unni ngconf i g st ar t up- conf i g
( Dub) >
( Dub) >copy r unni ngconf i g myconf i g
( Dub) >
Special File Description (Continued)
Utility Commands: debug ethernet
5-6
debugethernet
Description
This 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.
Formats
debug ethernet
all { di sabl e | enabl e }
controller { di sabl e | enabl e }
interface { di sabl e | enabl e }
Parameters
Command Defaults
Disabled
all Specifies that debug information logging is disabled or enabled for
controllers and interfaces. The following parameters are accepted:
di sabl eDisables debug information logging.
enabl eEnables debug information logging.
controller Specifies that debug information logging is disabled or enabled for
controllers only. The following parameters are accepted:
interface Specifies that debug information logging is disabled or enabled for
interfaces only. The following parameters are accepted:
Utility Commands: debug ethernet
5-7
Examples
This example displays the enabling of debug information logging for Ethernet
controller events.
This example displays the disabling of debug information logging for Ethernet
controller events.
See Also
running-config
show debugging
show log-file
( Dub) >debug
( Dub) debug>et her net
( Dub) debug et her net >cont r ol l er enabl e
( Dub) debug et her net >
( Dub) >debug
( Dub) debug>et her net
( Dub) debug et her net >cont r ol l er di sabl e
( Dub) debug et her net >
Utility Commands: debug level
5-8
debuglevel
Description
This command enables or disables the display of debug messages. When enabled,
debug messages are displayed on the CLI.
Formats
debug level
all
authentication
critical
none
Parameters
Command Defaults
critical
Examples
This 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.
See Also
show debugging
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>l evel
( Dub) debug l evel >al l
( Dub) debug l evel >
Utility Commands: debug mediation
5-9
debugmediation
Description
This 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.
Formats
debug mediation
actions { di sabl e | enabl e }
alarm { di sabl e | enabl e }
connections { di sabl e | enabl e }
log { di sabl e | enabl e }
netif { di sabl e | enabl e }
peripheral { di sabl e | enabl e }
python { di sabl e | enabl e }
snmp { di sabl e | enabl e }
snmp-trap { di sabl e | enabl e }
tcp { di sabl e | enabl e }
telnet { di sabl e | enabl e }
timer { di sabl e | enabl e }
uart { di sabl e | enabl e }
Parameters
actions Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles action mediation. The
di sabl e
enabl e.
alarm Specifies verbose debug information logging for central alarm
table entries. The following parameters are accepted:
di sabl e
enabl e.
5-10
connections Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles connection mediation. The
di sabl e
enabl e.
log Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles logging mediation. The
di sabl e
enabl e.
netif Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles interface mediation. The
di sabl e
enabl e.
peripheral Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles peripheral mediation. The
di sabl e
enabl e.
python Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles Python mediation. The
di sabl e
enabl e.
snmp Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles SNMP mediation. The
di sabl e
enabl e.
snmp-trap Specifies verbose debug information logging of the SNMP traps
received by the mediation SNMP manager. The following
di sabl e
enabl e.
tcp Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles TCP mediation. The
di sabl e
enabl e.
5-11
Examples
This example displays the enabling of debug information logging for action mediation
and peripheral mediation.
See Also
show debugging
show log-file
telnet Specifies verbose debug information logging for the telnet filter.
di sabl e
enabl e.
timer Specifies debug information logging for timer mediation. The
di sabl e
enabl e.
uart Specifies verbose debug information logging for the Remote RMM-
1400 software subsystem that handles UART mediation. The
di sabl e
enabl e.
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
di sabl e
enabl e.
enable Enables all debug information logging for the Remote RMM-1400
software subsystem that handles action mediation. The following
di sabl e
enabl e.
( Dub) >debug
( Dub) debug>medi at i on
( Dub) debug medi at i on>act i ons enabl e
( Dub) debug medi at i on>per i pher al enabl e
( Dub) debug medi at i on>
Utility Commands: debug openvpn
5-12
debugopenvpn
Description
This 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.
Formats
debug openvpn
all { di sabl e | enabl e }
controller { di sabl e | enabl e }
Parameters
Command Defaults
Disabled
Examples
This 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:
controller Specifies that debug information logging is disabled or enabled for
controllers only. The following parameters are accepted:
( Dub) >debug
( Dub) debug>openvpn
( Dub) debug openvpn>cont r ol l er enabl e
( Dub) debug openvpn>
Utility Commands: debug openvpn
5-13
This example displays the disabling of debug information logging for OpenVPN
controller events.
See Also
running-config
show debugging
show log-file
( Dub) >debug
( Dub) debug>openvpn
( Dub) debug openvpn>cont r ol l er di sabl e
( Dub) debug openvpn>
Utility Commands: debug ppp
5-14
debugppp
Description
This 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.
Formats
debug ppp
all { enabl e | di sabl e }
error { enabl e | di sabl e }
negotiation { enabl e | di sabl e }
packet { enabl e | di sabl e }
Parameters
Command Defaults
Disabled
all Specifies debug information logging for all controllers configured
with PPP encapsulation. The following parameters are accepted:
di sabl e
enabl e.
error Specifies debug information logging for PPP error events and
statistics. The following parameters are accepted:
di sabl e
enabl e.
negotiation Specifies debug information logging for the negotiation of LCP
(link) and NCP (network) settings. The following parameters are
accepted:
di sabl e
enabl e.
packet Specifies packet-level debug information logging for PPP. The
di sabl e
enabl e.
Utility Commands: debug ppp
5-15
Examples
This 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.
See Also
running-config
show debugging
show log-file
( Dub) >debug
( Dub) debug>ppp
( Dub) debug ppp>al l enabl e
( Dub) debug ppp>
( Dub) >debug
( Dub) debug>ppp
( Dub) debug ppp>al l di sabl e
( Dub) debug ppp>
Utility Commands: debug serial
5-16
debugserial
Description
This command enables or disables debug information logging for serial controller and
interface events. When enabled, debug information is written to the Remote RMM-
1400 log file.
Tip: To enable the display of debug information for serial controller and interface
events on the CLI, use command debug level.
Formats
debug serial
controller { enabl e | di sabl e }
interface { enabl e | di sabl e }
Parameters
Command Defaults
Disabled
all Specifies debug information logging for serial controller and
interface events. The following parameters are accepted:
di sabl e
enabl e.
controller Specifies debug information logging for serial controller events only.
di sabl e
enabl e.
interface Specifies debug information logging for serial interface events only.
di sabl e
enabl e.
Utility Commands: debug serial
5-17
Examples
This example displays the enabling of debug information logging for serial controller
events.
See Also
running-config
show debugging
show log-file
( Dub) >debug
( Dub) debug>ser i al
( Dub) debug ser i al >cont r ol l er enabl e
( Dub) debug ser i al >
Utility Commands: debug snmp
5-18
debugsnmp
Description
This command enables or disables debug information logging for SNMP events.
When enabled, debug information is written to the Remote RMM-1400 log file.
Formats
debug snmp
traplog { enabl e | di sabl e }
Parameters
Command Defaults
Disabled
Examples
This example displays the enabling of debug information logging for outgoing SNMP
traps.
See Also
running-config
show debugging
show log-file
all Specifies debug information logging for all SNMP events. The
di sabl e
enabl e.
traplog Specifies debug information logging for outgoing SNMP traps only.
di sabl e
enabl e.
( Dub) >debug
( Dub) debug>snmp
( Dub) debug snmp>t r apl og enabl e
( Dub) debug snmp>
Utility Commands: erase
5-19
erase
Description
This command deletes a configuration file from Remote RMM-1400.
Formats
erase filename
Parameters
Examples
This example displays the deletion of the configuration file myconf i g from
Remote RMM-1400.
See Also
copy
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
st ar t up- conf i g. File names are case-sensitive.
( Dub) >er ase myconf i g
Ar e you sur e you wi sh t o er ase ' myconf i g' ? ( y/ N) y
( Dub) >
Utility Commands: exec-job run
5-20
exec-jobrun
Description
This command starts a job for Remote RMM-1400. If the job is started successfully, a
run ID number is displayed. J obs can also start in debug mode or check mode.
Important: Packages cannot be removed while a running job is using them. J obs
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 jobs allocated memory with command config jobs
name.
Formats
exec-job job_name run
debug [ tag=value... ]
check [ tag=value... ]
5-21
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.)
tagDefines 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.
valueDefines the value of parameter tag.
5-22
Examples
This example displays the running of job myj ob, which is assigned a run ID of 9.
This example displays the running of job myj ob in debug mode.
This example displays the running of job myj ob in check mode.
debug Specifies that the job will run in debug mode. When in debug mode,
prompt ( Pdb) will appear. Several commands and key combinations
are available for identifying debugging tools and options:
? (or help)Lists all debug mode commands and topics or lists
information pertaining to a specific command (when entered
directly preceding a command).
q (or CTRL+d)Terminates the debug mode session.
Tip: Refer to www.python.org for how to use the debugger.
tagDefines 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.
valueDefines the value of parameter tag.
job_name Defines the job being started.
( Dub) >exec- j ob myj ob
( Dub) exec- j ob myj ob>r un
Run I D: 9
( Dub) exec- j ob myj ob>
( Dub) exec- j ob myj ob>r un debug
Run I D: 10
Connect i ng t o debugger sessi on. . .
> / var / ai - muse/ j ai l / pkgdb/ j obt est ut i l s/ J obTest Ut i l s/ J obTest Ut i l s. py( 35) r un( )
- > def r un ( sel f , pr oper t i es) :
( Pdb)
( Dub) exec- j ob myj ob>r un check
Run I D: 11
5-23
This example displays the running of job myj ob with tag pol l i ng_i nt er val set to 60.
See Also
config jobs name
show jobs
show jobs name
( Dub) exec- j ob myj ob>r un pol l i ng_i nt er val =60
Column Description
Run I D Displays the job run ID.
Utility Commands: exec-job stop
5-24
exec-jobstop
Description
This command stops a job (or a group of jobs). When a job stops, a summary of its
runtime statistics appears.
Formats
exec-job job_name stop
exec-job * stop [ usi ng package ]
Parameters
Examples
This example displays the stopping of job myj ob.
* Stops all jobs.
job_name Defines the job being started.
package Defines the package being used by jobs that will be stopped.
usi ng Cancels all jobs using a specified package.
( Dub) exec- j ob myj ob>st op
Run I D: 5
St ar t : 2009/ 09/ 14 14: 49: 57
End: 2009/ 09/ 14 14: 50: 06
Exi t st at e: ki l l ed
Column Description
Run i d Displays the job run ID.
St ar t Displays the time the job started.
End Displays the time the job ended.
Exi t
st at e
Displays the state of the job upon exit. Possible values are nor mal ,
ki l l ed, and abnor mal .
Utility Commands: exec-job stop
5-25
This example displays the stopping of all jobs that use package j obt est ut i l s.
See Also
config jobs name
show jobs
show jobs name
( Dub) >exec- j ob *
( Dub) exec- j ob *>st op usi ng j obt est ut i l s
J ob Run I D St ar t t i me End t i me Exi t st at e
newj ob2 4 2009/ 09/ 15 11: 34: 45 2009/ 09/ 15 11: 35: 40 ki l l ed
myj ob 8 2009/ 09/ 15 11: 34: 22 2009/ 09/ 15 11: 35: 41 ki l l ed
( Dub) exec- j ob *>
J ob Displays all jobs that were stopped.
Run I D Displays the run IDs for jobs that were stopped.
St ar t t i me Displays the times that running jobs started.
End t i me Displays the times that running jobs ended.
Exi t st at e Displays the states of jobs upon exit. Possible values are nor mal ,
ki l l ed, and abnor mal .
Utility Commands: exec-kill connection
5-26
exec-killconnection
Description
This command terminates a specified mediation connection. A mediation connection
is a point-to-point connection that goes through Remote RMM-1400.
Formats
exec- ki l l connect i on or i gi nat or
Parameters
Examples
This example displays the termination of a mediation connection originated by t cp
10. 40. 57. 5: 40001: 4.
See Also
config action
show connections
or i gi nat or
Defines the event mediation connection originator, such as
tcp 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- ki l l command to avoid
excessive typing.
( Dub) >exec- ki l l
( Dub) exec- ki l l >connect i on t cp 10. 40. 57. 5: 40001: 4
( Dub) exec- ki l l >
Utility Commands: exit
5-27
exit
Description
This 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.
Formats
exit
Examples
This example displays the exiting from the conf i g i p command hierarchy and the
returning of the user to the main prompt.
See Also
logout
( Dub) >conf i g
( Dub) conf i g>i p
( Dub) conf i g i p>exi t
( Dub) conf i g>exi t
( Dub) >
Utility Commands: help
5-28
help
Description
This command displays an explanation of how to use the ? command for
Remote RMM-1400.
Formats
help
Examples
This example displays an explanation of how to use the ? command.
( Dub) >hel p
You can r equest hel p f or a command at any t i me by ent er i ng
a quest i on mar k ( ' ?' ) . The ' ?' di spl ays t he f ol l owi ng t ypes
of i nf or mat i on f or commands and/ or command i nput s:
- Usage st at ement s
- Avai l abl e subcommands
- Mat chi ng commands f or par t i al i nput s
- Avai l abl e l ocal and gl obal commands
The t ype of i nf or mat i on di spl ayed depends on wher e you ent er t he ' ?' .
For mor e i nf or mat i on on usi ng hel p, r ef er t o t he command r ef er ence
gui de.
( Dub) >
Utility Commands: logout
5-29
logout
Description
This 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.
Formats
logout
Examples
This example displays the ending of a Remote RMM-1400 session.
See Also
exit
( Dub) >l ogout
Utility Commands: password
5-30
password
Description
This command changes the password for the current user.
Formats
password
Examples
This example displays the changing of the current user's password from t est to
t est 10.
See Also
config users
( Dub) >passwor d
Pl ease ent er t he ol d passwor d. ****
Pl ease ent er t he new passwor d. ******
Pl ease conf i r mt he new passwor d. ******
( Dub) >
Utility Commands: ping
5-31
ping
Description
This 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.
Formats
ping { hostname | ip_address }
[ size packet_size ]
[ source source_address ]
Parameters
Command Defaults
56 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_sizeDefines 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_addressDefines the source IP address. This IP
address must be configured on a local interface.
Utility Commands: ping
5-32
Examples
This 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 Also
telnet
( Dub) >pi ng 10. 44. 57. 5
PI NG 10. 44. 57. 5 ( 10. 44. 57. 5) : 56 dat a byt es
64 byt es f r om10. 44. 57. 5: seq=0 t t l =63 t i me=3. 508 ms
- - - 10. 44. 57. 5 pi ng st at i st i cs - - -
4 packet s t r ansmi t t ed, 4 packet s r ecei ved, 0%packet l oss
r ound- t r i p mi n/ avg/ max = 1. 970/ 2. 379/ 3. 508 ms
( Dub) >
Column Description
i cmp_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.
t t l 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.
t i me Displays the time in which each packet response was received.
( Dub) >pi ng 10. 25. 2. 5 si ze 70
PI NG 10. 25. 2. 5 ( 10. 25. 2. 5) : 70 dat a byt es
- - - 10. 25. 2. 5 pi ng st at i st i cs - - -
6 packet s t r ansmi t t ed, 6 packet s r ecei ved, 0%packet l oss
r ound- t r i p mi n/ avg/ max = 0. 971/ 1. 073/ 1. 254 ms
( Dub) >
Utility Commands: reload
5-33
reload
Description
This command resets Remote RMM-1400. Before a reset is issued, Remote RMM-
1400 prompts to save the running configuration.
Formats
reload [ reason ]
Parameters
Examples
This example displays the saving of the running configuration and the resetting of
Remote RMM-1400.
See Also
running-config
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) >r el oad
Do you wi sh t o save your r unni ng conf i gur at i on? ( y/ N) n
Ar e you sur e you wi sh t o r eset ? ( y/ N) y
Syst emgoi ng down I MMEDI ATELY!
Utility Commands: running-config
5-34
running-config
Description
This 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.
information pertaining to users and other sensitive data.
Tip: This command performs exactly the same function as command show running-
config.
Formats
running-config [ nopage ]
Parameters
Examples
This 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 t echcommis added to the system.
nopage Displays the entire running configuration upon execution of the
outputs the running configuration one page at a time.
Utility Commands: running-config
5-35
See Also
copy
show running-config
( Dub) >r unni ngconf i g
# Ver si on: 2. 00
# Cr eat ed: 2010- 11- 22, 16: 46: 13. 0, +0000
# User : j anedoe
conf i g dhcp- r el ay ser ver 10. 39. 70. 40
conf i g per i pher al 1 t ype r mb- 1
conf i g per i pher al 1 manage RMB1- 0E68FD
conf i g r emot e- access ht t p di sabl e
conf i g r emot e- access ht t ps enabl e
conf i g snmp host 10. 34. 3. 83 162 publ i c v2- i nf or m
conf i g t i meout 0
conf i g user s add t echcommsuper vi sor - e$1$Qzv94sky$J / XFok7l Vj o8E/ l mbH9f h. -
e$1$Qzv94
conf i g i nt er f ace br i dge swi t ch i p addr ess 10. 39. 90. 2/ 16
- - Mor e- -
Utility Commands: telnet
5-36
telnet
Description
This command establishes a Telnet connection to a specified host or IP address.
Formats
telnet { hostname | ip_address } [ port ]
Parameters
Command Defaults
Port number 23
Examples
This example displays Remote RMM-1400 connecting to IP address 10. 44. 57. 5
(another Kentrox Remote RMM-1400 device).
See Also
ping
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) >t el net 10. 44. 57. 5
Tr yi ng 10. 44. 57. 5. . .
Connect ed t o 10. 44. 57. 5.
Escape char act er i s ' ^] ' .
_ __ _____ _ _ _______ _____ ____ __ __
| | / / | ___| | \ | | | ___ ___| | _ \ / \ \ \ / /
| | / / | | ___ | \ \ | | | | | ( _) | | - - | \ \ / /
| ( | ___| | | \ \ | | | | _ / | ( ) | ) (
| | \ \ | | ___ | | \ | | | | | \ \ | - - | / / \ \
| _| \ _\ | _____| | _| \ _| | _| | _| \ _\ \ ____/ / _/ \ _\
RMM- 1400
l ogi n:
Utility Commands: trace-route
5-37
trace-route
Description
This command traces the route to a specified IP address or host and displays all hop
numbers, locations, and times associated with the route.
Formats
trace-route { hostname | ip_address } [ sour ce source_address ]
Parameters
Examples
This 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.
sour ce Initiates the configuration of the source address from which probe
packets originate. The following parameter is accepted:
source_addressDefines the source IP address. This IP
address must be configured on a local interface.
( Dub) >t r ace- r out e 10. 44. 57. 5
t r acer out e t o 10. 44. 57. 5 ( 10. 44. 57. 5) , 30 hops max, 38 byt e packet s
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 byt e
packet s
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.
Utility Commands: trace-route
5-38
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) >t r ace- r out e 10. 25. 2. 20 sour ce 10. 40. 57. 5
t r acer out e t o 10. 25. 2. 20 ( 10. 25. 2. 20) f r om10. 40. 57. 5, 30 hops max, 40 byt e pack
et s
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) >
A-1
A
CommandIdentifications
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-154.
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
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 /config/controller/eth/
config controller ethernet disable /config/controller/eth/disable
config controller ethernet enable /config/controller/eth/enable
hardware-address
/config/controller/eth/hwaddr
config controller ethernet proxy-arp /config/controller/eth/proxy-arp
A-2
Command Identifications:
config controller ethernet speed /config/controller/eth/speed
config controller ethernet unassign /config/controller/eth/unassign
config controller openvpn /config/controller/openvpn/
config correlation /config/correlation
config dhcp-relay /config/dhcp-relay
config dhcp-server /config/dhcp-server
config discrete /config/discrete
config event /config/event
config hostname /config/hostname
config interface /config/interface
config interface bridge /config/interface/bridge
config interface ethernet /config/interface/eth
config interface ethernet /config/interface/eth/
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 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 iptables /config/iptables
config jobs /config/jobs
config mediation /config/mediation
config ntp /config/ntp
Commands Identifications (Continued)
A-3
config ntp disable /config/ntp/disable
config ntp enable /config/ntp/enable
config ntp poll-interval /config/ntp/poll-interval
config ntp server /config/ntp/server
config peripheral /config/peripheral
config pkgs /config/pkgs
config profile /config/profile
config profile copy /config/profile/copy
config profile exclude /config/profile/exclude
config profile include /config/profile/include
config profile priv-lvl /config/profile/priv-lvl
config remote-access /config/remote-access
config response /config/response
config snmp /config/snmp
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
config users /config/users
config users add /config/users/add
config users delete /config/users/delete
config users password /config/users/password
copy /copy
debug /debug
debug ethernet /debug/ethernet
A-4
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/
diag /diag
diag break /diag/break
diag clear /diag/clear
diag controller /diag/controller
diag ip /diag/ip
diag line-monitor /diag/line-monitor
diag line-status /diag/line-status
diag mediation /diag/mediation
diag mmdisplay /diag/mmdisplay
diag output /diag/output
diag peripheral /diag/peripheral
diag ps /diag/ps
diag snapshot /diag/snapshot
diag tcpdump /diag/tcpdump
diag test /diag/test
diag top /diag/top
diag who /diag/who
diag whoami /diag/whoami
erase /erase
exec-job /exec-job
A-5
exit /exit
halt /halt
help /help
password /password
ping /ping
reload /reload
running-config /running-config
show /show
show actions /show/actions
show alarm-entries /show/alarm-entries
show audit /show/audit
show banner /show/banner
show bootp /show/bootp
show clock /show/clock
show compact-flash /show/compact-flash
show config-file /show/config-file
show connections /show/connections
show controllers /show/controllers
show 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
A-6
show inventory /show/inventory
show ip /show/ip
show iptables /show/iptables
show jobs /show/jobs
show listeners /show/listeners
show log-file /show/log-file
show mediation /show/mediation
show ntp /show/ntp
show peripherals /show/peripherals
show pkgs /show/pkgs
show product /show/product
show profiles /show/profiles
show pydoc /show/pydoc
show remote-access /show/remote-access
show resource-tracking /show/resource-tracking
show responses /show/responses
show running-config /show/running-config
show snmp /show/snmp
show test /show/test
show timeout /show/timeout
show users /show/users
show version /show/version
telnet /telnet
trace-route /trace-route
B-1
B
IPTablesManPage
This appendix provides information on the iptables administration tool including descriptions,
tables, command formats and options.
Guide to this Appendix
Iptables Overview
Tables
Options
Authors
B-2
IPTables Man Page: Iptables Overview
IptablesOverview
Name
iptables - administration tool for IPv4 packet filtering and NAT
Synopsis
iptables [ -t table ] [ -A | -D | -C ] chain rule-specification
[ options ]
iptables [ -t table ] -I chain [ rulenum ] rule-specification
[ options ]
iptables [ -t table ] -R chain r ul enumrule-specification [
options ]
iptables [ -t table ] -D chain r ul enum[ options ]
iptables [ -t table ] [ -L | -F | -Z ] [ chain ] [ options ]
iptables [ -t table ] -N chain
iptables [ -t table ] -X [ chain ]
iptables [ -t table ] -P chain target [ options ]
iptables [ -t table ] -E old-chain-name new-chain-name
Description
Iptables is used to set up, maintain, and inspect the tables of IP packet filter rules in
the Linux kernel. Several different tables may be defined. Each table contains a
number of built-in chains and may also contain user-defined chains.
Each chain is a list of rules which can match a set of packets. Each rule specifies
what to do with a packet that matches. This is called a target, which may be a jump
to a user-defined chain in the same table.
Targets
A firewall rule specifies criteria for a packet and a target. If the packet does not match,
the next rule in the chain is examined; if it does match, then the next rule is specified
by the value of the target, which can be the name of a user-defined chain or one of
the following special values:
ACCEPT means to let the packet through
DROP means to drop the packet on the floor
QUEUE means to pass the packet to userspace (if supported by the kernel).
RETURN means stop traversing this chain and resume at the next rule in the
previous (calling) chain. If the end of a built-in chain is reached or a rule in a built-
in chain with target RETURN is matched, the target specified by the chain policy
determines the fate of the packet.
B-3
IPTables Man Page: Tables
Tables
There are currently three independent tables. Which tables are present at any time
depends on the kernel configuration options and which modules are present.
The tables are as follows:
-t, --table
table
This option specifies the packet matching table which the
command should use. If the kernel is configured with
automatic module loading, an attempt will be made to load the
appropriate module for that table if it is not already there.
filter This is the default table (if no -t option is passed). It contains the built-in
chains INPUT (for packets coming into the box itself), FORWARD (for
packets being routed through the box), and OUTPUT (for locally-
generated packets).
nat This table is consulted when a packet that creates a new connection is
encountered. It consists of three built-ins: PREROUTING (for altering
packets as soon as they come in), OUTPUT (for altering locally-
generated packets before routing), and POSTROUTING (for altering
packets as they are about to go out).
mangle This table is used for specialized packet alteration. Until kernel 2.4.17 it
had two built-in chains: PREROUTING (for altering incoming packets
before routing) and OUTPUT (for altering locally-generated packets
before routing). Since kernel 2.4.18, three other built-in chains are also
supported: INPUT (for packets coming into the box itself), FORWARD
(for altering packets being routed through the box), and POSTROUTING
(for altering packets as they are about to go out).
B-4
IPTables Man Page: Options
Options
The options that are recognized by iptables can be divided into several different
groups.
These options specify the specific action to perform. Only one of them can be
specified on the command line unless otherwise specified below. For all the long
versions of the command and option names, you need to use only enough letters to
ensure that iptables can differentiate it from all other options.
-A, --append chain rule-
specification
Append one or more rules to the end
of the selected chain. When the
source and/or destination names
resolve to more than one address, a
rule will be added for each possible
address combination.
-D, --delete chain rule-
specification
-D, --delete chain rulenum
Delete one or more rules from the
selected chain. There are two versions
of this command: the rule can be
specified as a number in the chain
(starting at 1 for the first rule) or a rule
to match.
-I, --insert chain [ rulenum ]
rule-specification
Insert one or more rules in the
selected chain as the given rule
number. So, if the rule number is 1,
the rule or rules are inserted at the
head of the chain. This is also the
default if no rule number is specified.
-R, --replace chain rulenum
rule-specification
Replace a rule in the selected chain. If
the source and/or destination names
resolve to multiple addresses, the
command will fail. Rules are
numbered starting at 1.
B-5
-L, --list [ chain ] List all rules in the selected chain. If no
chain is selected, all chains are listed.
As every other iptables command, it
applies to the specified table (FILTER
is the default), so NAT rules get listed
by
iptables -t nat -n -L
Please note that it is often used with
the -n option, in order to avoid long
reverse DNS lookups. It is legal to
specify the -Z (zero) option as well, in
which case the chain(s) will be
atomically listed and zeroed. The
exact output is affected by the other
arguments given. The exact rules are
suppressed until you use
iptables -L -v -F
--flush [ chain ] Flush the selected chain (all the
chains in the table if none is given).
This is equivalent to deleting all the
rules one by one.
-Z, --zero [ chain ] Zero the packet and byte counters in
all chains. It is legal to specify the -L,
--list (list) option as well, to see the
counters immediately before they are
cleared. (See above.)
-N, --new-chain chain Create a new user-defined chain by
the given name. There must be no
target of that name already.
-X, --delete-chain [ chain ] Delete the optional user-defined chain
specified. There must be no
references to the chain. If there are,
you must delete or replace the
referring rules before the chain can be
deleted. If no argument is given, it will
attempt to delete every non-built-in
chain in the table.
B-6
Parameters
The following parameters make up a rule specification (as used in the add, delete,
insert, replace and append commands).
-P, --policy chain target Set the policy for the chain to the
given target. See the section
TARGETS for the legal targets. Only
built-in (non-user-defined) chains can
have policies, and neither built-in nor
user-defined chains can be policy
targets.
-E, --rename-chain old-chain
new-chain
Rename the user specified chain to
the user supplied name. This is
cosmetic, and has no effect on the
structure of the table.
-h Help. Give a (currently very brief)
description of the command syntax.
-p, --protocol [ ! ] protocol The protocol of the rule or of the packet to
check. The specified protocol can be one of
tcp, udp, icmp, or all, or it can be a
numeric value, representing one of these
protocols or a different one. A protocol
name from /etc/protocols is also allowed. A
"!" argument before the protocol inverts the
test. The number zero is equivalent to all.
Protocol all will match with all protocols
and is taken as default when this option is
omitted.
-s, --source [ ! ] address[ /mask
]
Source specification. Address can be either
a network name, a hostname (please note
that specifying any name to be resolved
with a remote query such as DNS is a really
bad idea), a network IP address (with
/mask), or a plain IP address. The mask
can be either a network mask or a plain
number, specifying the number of 1's at the
left side of the network mask. Thus, a mask
of 24 is equivalent to 255.255.255.0. A "!"
argument before the address specification
inverts the sense of the address. The flag
--src is an alias for this option.
B-7
-d, --destination [ ! ]
address[ /mask ]
Destination specification. See the
description of the -s (source) flag for a
detailed description of the syntax. The flag
--dst is an alias for this option.
-j, --jump target This specifies the target of the rule; i.e.,
what to do if the packet matches it. The
target can be a user-defined chain (other
than the one this rule is in), one of the
special built-in targets which decide the
fate of the packet immediately, or an
extension (see EXTENSIONS below). If
this option is omitted in a rule, then
matching the rule will have no effect on the
packet's fate, but the counters on the rule
will be incremented.
-i, --in-interface [ ! ] name Name of an interface via which a packet is
going to be received (only for packets
entering the INPUT, FORWARD and
PREROUTING chains). When the "!"
argument is used before the interface
name, the sense is inverted. If the interface
name ends in a "+", then any interface
which begins with this name will match. If
this option is omitted, any interface name
will match.
-o, --out-interface [ ! ] name Name of an interface via which a packet is
going to be sent (for packets entering the
FORWARD, OUTPUT and
POSTROUTING chains). When the "!"
argument is used before the interface
name, the sense is inverted. If the interface
name ends in a "+", then any interface
which begins with this name will match. If
this option is omitted, any interface name
will match.
B-8
OtherOptions
The following additional options can be specified:
[ ! ] -f, --fragment This means that the rule only refers to
second and further fragments of
fragmented packets. Since there is no way
to tell the source or destination ports of
such a packet (or ICMP type), such a
packet will not match any rules which
specify them. When the "!" argument
precedes the "-f" flag, the rule will only
match head fragments, or unfragmented
packets.
-c, --set-counters PKTS BYTES This enables the administrator to initialize
the packet and byte counters of a rule
(during INSERT, APPEND, REPLACE
operations).
-v, --verbose Verbose output. This option makes the list command show
the interface name, the rule options (if any), and the TOS
masks. The packet and byte counters are also listed, with
the suffix 'K', 'M' or 'G' for 1000, 1,000,000 and
1,000,000,000 multipliers respectively (but see the -x flag
to change this). For appending, insertion, deletion and
replacement, this causes detailed information on the rule
or rules to be printed.
-n, --numeric Numeric output. IP addresses and port numbers will be
printed in numeric format. By default, the program will try to
display them as host names, network names, or services
(whenever applicable).
-x, --exact Expand numbers. Display the exact value of the packet
and byte counters, instead of only the rounded number in
K's (multiples of 1000) M's (multiples of 1000K) or G's
(multiples of 1000M). This option is only relevant for the -L
command.
--line-numbers When listing rules, add line numbers to the beginning of
each rule, corresponding to that rule's position in the chain.
--
modprobe=command
When adding or inserting rules into a chain, use command
to load any necessary modules (targets, match extensions,
etc).
B-9
MatchExtensions
iptables can use extended packet matching modules. These are loaded in two ways:
implicitly, when -p or --protocol is specified, or with the -m or --match options,
followed by the matching module name; after these, various extra command line
options become available, depending on the specific module. You can specify
multiple extended match modules in one line, and you can use the -h or --help
options after the module has been specified to receive help specific to that module.
The following extensions are included in the base package, and most of these can be
preceded by a ! to invert the sense of the match.
tcp
These extensions are loaded if --protocol tcp is specified. It provides the
following options:
--source-port [ ! ] port[ :port ] Source port or port range specification.
This can either be a service name or a
port number. An inclusive range can
also be specified, using the format
port:port. If the first port is omitted,
"0" is assumed; if the last is omitted,
"65535" is assumed. If the second port
greater then the first they will be
swapped. The flag --sport is a
convenient alias for this option.
--destination-port [ ! ] port[ :port
]
Destination port or port range
specification. The flag --dport is a
convenient alias for this option.
--tcp-flags [ ! ] mask comp Match when the TCP flags are as
specified. The first argument is the flags
which we should examine, written as a
comma-separated list, and the second
argument is a comma-separated list of
flags which must be set. Flags are: SYN
ACK FIN RST URG PSH ALL NONE. Hence
the command iptables -A FORWARD
-p tcp --tcp-flags
SYN,ACK,FIN,RST SYN will only match
packets with the SYN flag set, and the
ACK, FIN and RST flags unset.
B-10
udp
These extensions are loaded if --protocol udp is specified. It provides the
following options:
icmp
This extension is loaded if --protocol icmp is specified. It provides the following
option:
[ ! ] --syn Only match TCP packets with the SYN
bit set and the ACK and FIN bits
cleared. Such packets are used to
request TCP connection initiation; for
example, blocking such packets coming
in an interface will prevent incoming
TCP connections, but outgoing TCP
connections will be unaffected. It is
equivalent to --tcp- flags
SYN,RST,ACK SYN. If the "!" flag
precedes the "--syn", the sense of the
option is inverted.
--tcp-option [ ! ] number Match if TCP option set.
--mss value[ :value ] Match TCP SYN or SYN/ACK packets
with the specified MSS value (or
range), which control the maximum
packet size for that connection.
--source-port [ ! ] port[ :port ] Source port or port range specification.
See the description of the --source-
port option of the TCP extension for
details.
--destination-port [ ! ] port[ :port
]
Destination port or port range
specification. See the description of
the --destination-port option of the
TCP extension for details.
--icmp-type [ ! ]
typename
This allows specification of the ICMP type, which
can be a numeric ICMP type, or one of the ICMP
type names shown by the command iptables -p
icmp -h.
B-11
mac
limit
This module matches at a limited rate using a token bucket filter. A rule using this
extension will match until this limit is reached (unless the ! flag is used). It can be
used in combination with the LOG target to give limited logging, for example.
multiport
This module matches a set of source or destination ports. Up to 15 ports can be
specified. It can only be used in conjunction with -p tcp or -p udp.
--mac-source [ ! ]
address
Match source MAC address. It must be of the form
XX:XX:XX:XX:XX:XX. Note that this only makes
sense for packets coming from an Ethernet device
and entering the PREROUTING, FORWARD or
INPUT chains.
--limit rate Maximum average matching rate: specified as a number,
with an optional /second, /minute, /hour, or /day
suffix; the default is 3/hour.
--limit-burst
number
Maximum initial number of packets to match: this number
gets recharged by one every time the limit specified
above is not reached, up to this number; the default is 5.
--source-ports port[ ,port[ ,port . . . ] ] Match if the source port is
one of the given ports. The
flag --sports is a
convenient alias for this
option.
--destination-ports port[ ,port[ ,port . . . ]
]
Match if the destination port
is one of the given ports.
The flag --dports is a
convenient alias for this
option.
--ports port[ ,port[ ,port . . . ] ] Match if the both the source
and destination ports are
equal to each other and to
one of the given ports.
B-12
mark
This module matches the netfilter mark field associated with a packet (which can be
set using the MARK target below).
owner
This module attempts to match various characteristics of the packet creator, for
locally-generated packets. It is only valid in the OUTPUT chain; some packets (such
as ICMP ping responses) may have no owner, and hence never match.
state
This module, when combined with connection tracking, allows access to the
connection tracking state for this packet.
--mark value[ /mask
]
Matches packets with the given unsigned mark value (if a
mask is specified, this is logically ANDed with the mask
before the comparison).
--uid-owner userid Matches if the packet was created by a process with the
given effective user id.
--gid-owner groupid Matches if the packet was created by a process with the
given effective group id.
--pid-owner
processid
Matches if the packet was created by a process with the
given process id.
--sid-owner
sessionid
Matches if the packet was created by a process in the
given session group.
--cmd-owner name Matches if the packet was created by a process with the
given command name. (This option is present only if
iptables was compiled under a kernel supporting this
feature.)
--state
state
Where state is a comma separated list of the connection states to
match. Possible states are INVALID meaning that the packet is
associated with no known connection, ESTABLISHED meaning that
the packet is associated with a connection which has seen
packets in both directions, NEW meaning that the packet has
started a new connection, or otherwise associated with a
connection which has not seen packets in both directions, and
RELATED meaning that the packet is starting a new connection,
but is associated with an existing connection, such as an FTP
data transfer, or an ICMP error.
B-13
conntrack
This module, when combined with connection tracking, allows access to more
connection tracking information than the "state" match. (This module is present only
if iptables was compiled under a kernel supporting this feature.)
--ctstate state Where state is a comma separated list of
the connection states to match. Possible
states are INVALID meaning that the
packet is associated with no known
connection, ESTABLISHED meaning that
the packet is associated with a connection
which has seen packets in both directions,
NEW meaning that the packet has started a
new connection, or otherwise associated
with a connection which has not seen
packets in both directions, and RELATED
meaning that the packet is starting a new
connection, but is associated with an
existing connection, such as an FTP data
transfer, or an ICMP error. SNAT A virtual
state, matching if the original source
address differs from the reply destination.
DNAT A virtual state, matching if the
original destination differs from the reply
source.
--ctproto proto Protocol to match (by number or name)
--ctorigsrc [ ! ] address[ /mask
]
Match against original source address
--ctorigdst [ ! ] address[ /mask
]
Match against original destination address
--ctreplsrc [ ! ] ] address[ /mask
]
Match against reply source address
--ctrepldst [ ! ] address[ /mask
]
Match against reply destination address
--ctstatus [ NONE | EXPECTED |
SEEN_REPLY | ASSURED ] [ , . . . ]
Match against internal conntrack states
--ctexpire time[ :time ] Match remaining lifetime in seconds
against given value or range of values
(inclusive)
B-14
dscp
This module matches the 6 bit DSCP field within the TOS field in the IP header. DSCP
has superseded TOS within the IETF.
pkttype
This module matches the link-layer packet type.
tos
This module matches the 8 bits of Type of Service field in the IP header (i.e. including
the precedence bits).
ah
This module matches the SPIs in AH header of IPSec packets.
esp
This module matches the SPIs in ESP header of IPSec packets.
length
This module matches the length of a packet against a specific value or range of
values.
--dscp value Match against a numeric (decimal or hex) value
[0-32].
--dscp-class
DiffServ_Class
Match the DiffServ class. This value may be any
of the BE, EF, AFxx or CSx classes. It will then be
converted into it's according numeric value.
--pkt-type [ unicast | broadcast | multicast
]
--tos
tos
The argument is either a standard name, (use iptables -m tos -h to
see the list), or a numeric value to match.
--ahspi [ ! ] spi[ :spi
]
--espspi [ ! ] spi[ :spi
]
--length length[ :length
]
B-15
ttl
This module matches the time to live field in the IP header.
unclean
This module takes no options, but attempts to match packets which seem malformed
or unusual. This is regarded as experimental.
TargetExtensions
iptables can use extended target modules. The following are included in the standard
distribution.
Log
Turn on kernel logging of matching packets. When this option is set for a rule, the
Linux kernel will print some information on all matching packets (like most IP header
fields) via the kernel log (where it can be read with dmesg or syslogd(8)). This is a
"non-terminating target," i.e., rule traversal continues at the next rule. So if you want
to LOG the packets you refuse, use two separate rules with the same matching
criteria, first using target LOG then DROP (or REJECT).
Mark
This is used to set the netfilter mark value associated with the packet. It is only valid in
the mangle table. It can for example be used in conjunction with iproute2.
--ttl
ttl
Matches the given TTL value.
--log-level level Level of logging (numeric or see syslog.conf(5)).
--log-prefix
prefix
Prefix log messages with the specified prefix; up to 29
letters long, and useful for distinguishing messages in the
logs.
--log-tcp-
sequence
Log TCP sequence numbers. This is a security risk if the
log is readable by users.
--log-tcp-options Log options from the TCP packet header.
--log-ip-options Log options from the IP packet header.
--set-mark
mark
B-16
Reject
This is used to send back an error packet in response to the matched packet;
otherwise, it is equivalent to DROP so it is a terminating TARGET, ending rule traversal.
This target is only valid in the INPUT, FORWARD and OUTPUT chains, and user-defined
chains which are only called from those chains. The following option controls the
nature of the error packet returned:
Tos
This is used to set the 8-bit Type of Service field in the IP header. It is only valid in the
mangle table.
Mirror
This is an experimental demonstration target which inverts the source and destination
fields in the IP header and retransmits the packet. It is only valid in the INPUT,
FORWARD and PREROUTING chains, and user-defined chains which are only
called from those chains. Note that the outgoing packets are NOT seen by any packet
filtering chains, connection tracking or NAT, to avoid loops and other problems.
--reject-with
type
The type given can be icmp-net-unreachable, icmp-
host-unreachable, icmp-port-unreachable, icmp-
proto-unreachable, icmp-net-prohibited or icmp-
host-prohibited, which return the appropriate ICMP error
message (port-unreachable is the default). The option tcp-
reset can be used on rules which only match the TCP
protocol: this causes a TCP RST packet to be sent back.
This is mainly useful for blocking ident (113/tcp) probes
which frequently occur when sending mail to broken mail
hosts (which won't accept your mail otherwise).
--set-tos
tos
You can use a numeric TOS values, or use iptables -j TOS -h
to see the list of valid TOS names.
B-17
Snat
This target is only valid in the nat table, in the POSTROUTING chain. It specifies that
the source address of the packet should be modified (and all future packets in this
connection will also be mangled), and rules should cease being examined. It takes
one type of option:
You can add several --to-source options. If you specify more than one source
address, either via an address range or multiple --to-source options, a simple
round-robin (one after another in cycle) takes place between these addresses.
Dnat
This target is only valid in the nat table, in the PREROUTING and OUTPUT chains,
and user-defined chains which are only called from those chains. It specifies that the
destination address of the packet should be modified (and all future packets in this
connection will also be mangled), and rules should cease being examined. It takes
one type of option:
You can add several --to-destination options. If you specify more than one
destination address, either via an address range or multiple --to-destination
options, a simple round-robin (one after another in cycle) load balancing takes place
between these addresses.
--to-source ipaddr[ -ipaddr
]
[ :port-port ]
which can specify a single new source IP
address, an inclusive range of IP addresses,
and optionally, a port range (which is only valid
if the rule also specifies -p tcp or -p udp). If
no port range is specified, then source ports
below 512 will be mapped to other ports below
512: those between 512 and 1023 inclusive will
be mapped to ports below 1024, and other
ports will be mapped to 1024 or above. Where
possible, no port alteration will occur.
--to-destination ipaddr[ -ipaddr
]
[ :port-port ]
which can specify a single new
destination IP address, an inclusive range
of IP addresses, and optionally, a port
range (which is only valid if the rule also
specifies -p tcp or -p udp). If no port
range is specified, then the destination
port will never be modified.
B-18
Masquerade
This target is only valid in the nat table, in the POSTROUTING chain. It should only be
used with dynamically assigned IP (dialup) connections; if you have a static IP
address, you should use the SNAT target. Masquerading is equivalent to specifying a
mapping to the IP address of the interface the packet is going out, but also has the
effect that connections are forgotten when the interface goes down. This is the correct
behavior when the next dialup is unlikely to have the same interface address (and
hence any established connections are lost anyway). It takes one option:
e
Redirect
This target is only valid in the nat table, in the PREROUTING and OUTPUT chains,
and user-defined chains which are only called from those chains. It alters the
destination IP address to send the packet to the machine itself (locally-generated
packets are mapped to the 127.0.0.1 address). It takes one option:
Ulog
This target provides userspace logging of matching packets. When this target is set
for a rule, the Linux kernel will multicast this packet through a netlink socket. One or
more userspace processes may then subscribe to various multicast groups and
receive the packets. Like LOG, this is a "non-terminating target," i.e., rule traversal
continues at the next rule.
--to-ports port[ -port
]
This specifies a range of source ports to use,
overriding the default SNAT source port-selection
heuristics (see above). This is only valid if the rule
also specifies -p tcp or -p udp.
--to-ports port[ -port
]
This specifies a destination port or range of ports to
use: without this, the destination port is never
altered. This is only valid if the rule also specifies
-p tcp or -p udp.
--ulog-nlgroup
nlgroup
This specifies the netlink group (1-32) to which the
packet is sent. Default value is 1.
--ulog-prefix prefix Prefix log messages with the specified prefix; up to 32
characters long, and useful for distinguishing
messages in the logs.
--ulog-cprange size Number of bytes to be copied to userspace. A value of
0 always copies the entire packet, regardless of its
size. Default is 0.
B-19
Tcpmss
This target allows you to alter the MSS value of TCP SYN packets, to control the
maximum size for that connection (usually limiting it to your outgoing interface's MTU
minus 40). It can only be used in conjunction with -p tcp.
This target is used to overcome criminally braindead ISPs or servers which block
ICMP Fragmentation Needed packets. The symptoms of this problem are that
everything works fine from your Linux firewall/router, but machines behind it can never
exchange large packets:
1. Web browsers connect, then hang with no data received.
2. Small mail works fine, but large emails hang.
3. ssh works fine, but scp hangs after initial handshaking.
Work around: activate this option and add a rule to your firewall configuration, for
example:
iptables -A FORWARD -p tcp --tcp-flags SYN,RST SYN \ -j TCPMSS
--clamp-mss-to-pmtu
These options are mutually exclusive.
Dscp
This target allows you to alter the value of the DSCP bits within the TOS header of the
IPv4 packet. As this manipulates a packet, it can only be used in the mangle table.
--ulog-qthreshold
size
Number of packet to queue inside kernel. Setting this
value to, e.g. 10 accumulates ten packets inside the
kernel and transmits them as one netlink multipart
message to userspace. Default is 1 (for backwards
compatibility).
--set-mss value Explicitly set MSS option to specified value.
--clamp-mss-to-
pmtu
Automatically clamp MSS value to (path_MTU - 40).
--set-dscp value Set the DSCP field to a numerical value (can be
decimal or hex)
--set-dscp-class
class
Set the DSCP field to a DiffServ class.
B-20
Ecn
This target allows you to selectively work around known ECN blackholes. It can only
be used in the mangle table.
Diagnostics
Various error messages are printed to standard error. The exit code is 0 for correct
functioning. Errors which appear to be caused by invalid or abused command line
parameters cause an exit code of 2, and other errors cause an exit code of 1.
Bugs
The counters are not reliable on sparc64.
Compatibility with ipchains
The iptables is very similar to ipchains by Rusty Russell. The main difference is that
the chains INPUT and OUTPUT are only traversed for packets coming into the local
host and originating from the local host respectively. Hence every packet only passes
through one of the three chains; previously a forwarded packet would pass through all
three.
The other main difference is that -i refers to the input interface; -o refers to the
output interface, and both are available for packets entering the FORWARD chain.
iptables is a pure packet filter when using the default filter table, with optional
extension modules. This should simplify much of the previous confusion over the
combination of IP masquerading and packet filtering seen previously. So the following
options are handled differently:
-j MASQ
-M -S
-M -L
There are several other changes in iptables.
See Also
iptables-save(8), iptables-restore(8), ip6tables(8), ip6tables-save(8), ip6tables-
restore(8).
The packet-filtering-HOWTO details iptables usage for packet filtering, the NAT-
HOWTO details NAT, the netfilter-extensions-HOWTO details the extensions that are
not in the standard distribution, and the netfilter-hacking-HOWTO details the netfilter
internals.
See http://www.netfilter.org/.
--ecn-tcp-
remove
Remove all ECN bits from the TCP header. Of course, it can
only be used in conjunction with -p tcp.
B-21
IPTables Man Page: Authors
Authors
Rusty Russell wrote iptables, in consultation with Michael Neuling.
Marc Boucher wrote the mangle table, the owner match, and the mark material.
J ames Morris wrote the TOS target and tos match.
J ozsef Kadlecsik wrote the REJ ECT target.
Harald Welte wrote the ULOG target, TTL, DSCP, ECN matches and targets.
The Netfilter Core Team is: Marc Boucher, J ozsef Kadlecsik, J ames Morris, Harald
Welte and Rusty Russell.
Man page written by Herve Eychenne <rv@wallfire.org>.
Mar 09, 2002
B-22
IPTables Man Page: Authors
Index-1
Index
Symbols
? (command) 28
A
action
display 5
alarm entry display 8
alarm states, resetting 4
alarm-entry configuration commands
alarm nagging settings 10
events that activate an alarm-entry 9
analog event originator 74
application mode configuration for an
asynchronous serial controller 32
ARP cache
configuration 93
display 74
asynchronous serial port monitoring 30
audited action display 12
authority for a DHCP server 50
B
band configuration for a discrete analog
input 60
banner
configuration of 14
display of 16
baud rate configuration 33
BOOTP/DHCP
relay 47
relay agent 48
server 48, 47
break propagation 168
bridge controller configuration 22
bridge controller display 26
bridge interface configuration 84
bridge interface display 63
broadcast configuration for a DHCP
server 50
broadcast packets 50
build time and date display for software
139
C
capture of job output 99
categories for alarm entries 6
CHAP and PAP authentication
identity 42
local identity and secret configuration
42
method 43
remote identity and secret
configuration 43
check mode for a running job 21
CLI, using the
abbreviated command entry 6
command help 7
command types 4, 5, 3, 4
navigation and command entry 4, 6
clock configuration 16
command entry
abbreviated 6
parameters with spaces 5
command help, overview 7
command usage statements, displaying
7
compact flash card 18
config 128
apply-patch 12
banner 14
clock 16
dhcp-relay 48
hostname 83
ip 93
iptables 96
meas-table 110
peripheral 140
remote-access 156
sitebus 172
snmp 115, 118, 128, 133, 154
timeout 177
users 181
use-wizard 179
config alarm-entry 6
event 9
nagging 10
config clock 16
daylight-savings 18
config controller bridge switch 22
config controller ethernet 24
bridge switch 28
config controller serial 32
connect 36
disconnect 39
encapsulation 41
config dhcp-relay 48
config dhcp-server 50
interface 54
subnet 55
config discrete
analog 59
input 66
config event 45, 71
content 73
config inteface
bridge switch
ip dhcp 85
config interface
bridge switch 84
ethernet 87
openvpn 89
serial 91
config jobs 97
name 99
config jobs name task 105
config mediation snmp
event-template 115
manager 118
measurement-template 119
ne-template 125
point-template 128
config mediation snmpne 133
config ntp 138
config pkgs
install 143
on-demand-install 148
server 150
uninstall 152
config response 159
content 161
connect 167
configuration files
copy of 4
display of 19
for a DHCP server 51
configuration wizards 179
connect response
configuration 167
responders 170
connect string for a serial connection 38
connection event types 80
controller display 24, 32
controllers
display of 24
copy 4
counters
for interfaces 61, 69
cron start
display 87
cron-start for a job 99
D
data received event type 80
data-link layer address 25, 53
daylight savings time
configuration 18
Index
Index-2
display of 17
debug
Ethernet 6
level 8
mediation 9
OpenVPN 12
ppp 14
serial 16
snmp 18
debug information logging
for mediation 9
for OpenVPN 12
for PPP encapsulation 14
for serial controllers and interfaces 16
debug mode for a running job 22
debug status display 45
default alarm-table entries for digital
inputs 66
destination data string, for a connect
response 168
destination for a mediation connection
168
dgram 108
DHCP packets 48
DHCP server
configuration 50
DHCPNAK messages 50
display of information 48
hardware address for a host 53
IP address for a host 53
DHCP server subnet
default lease 56
domain name server 56
maximum lease 56
range 57
router 57
dhcp-relay 48
diag
break 5, 3, 4
clear 4
line-monitor 30
line-status 32
mmdisplay 34
ps 39
snapshot 42
tcpdump 43
top 50
who 53
whoami 54
diag controller serial
bert 7
loopback 9
diag ip
address show 10
link show 15
neighbor show 19
diag ip route
get 21
show 24
diag mediation snmpne poll 33, 49
diag peripheral
reload 37
diagnostic commands 354
for creating file snapshot.tar.gz 42
for displaying IP address information
10
for displaying IP packet headers 43
for displaying link information 15
for displaying logged in users 53
for displaying neighbor information 19
for displaying route information 21, 24
for displaying running processes 39
for displaying the terminal name 54
for displaying top CPU processes 50
for finding a route 21
for resetting a peripheral 37
for terminating a shell connection 5, 3,
4
digital input configuration 66
digital output
opening and closing 36
resource tracking 69
digital output configuration 69
disconnect mode 39
discrete analog input
band configuration 60
disable of 60
enable of 60
lowest valid current 63
maximum current configuration 62
resource tracking 59
discrete expansion peripheral
configuration 140
discrete point display 51
DNS server
configuration 94
display 74
domain name
configuration 94
display 74
down event type 80
DTR 36, 39
Duplex operation 26
E
encapsulation formats for
communications 41
erase 19
Ethernet controller
configuration 24
debugging 6
description 24
display 29
hardware address 25
speed 26
Ethernet event originator 75
Ethernet interface
configuration 87
debugging 6
description 87
display 66
IP address 87
event 115
configuration 45, 71
display 43, 56
types 8082
event correlation 45
event correlations 43
event template 115
event-templates 97
exec-job
run 20
stop 24
exec-kill connection 26
exit 27
exit states for a job 82, 85
F
filter table 96
forward
status display 74
FTP server
server configuration 150
G
GMT timestamp configuration 16
H
hardware
address 25
components, display 73
information display 115
help 28
high event 60, 61
hostname configuration 83
HTTP remote access protocol 156
hysteresis configuration 61
I
ICMP echo request packet 31
identity for CHAP and PAP
authentication 42
in-band event 60, 61
in-band event type 80
incoming connection event type 80
initialization event type 80
input event originator 75
input saturated event type 81
input_saturated event 62
interface configuration for a DHCP server
54
interface display 61, 69
interface, adding to a bridge group 84
interval event type 81
IP address display 10
IP configuration 93
IP forwarding 94
IP packet headers, display 43
IP table rule and interface counters,
clearing 4
iptables
display 78
match extensions 9
options 4
overview 2
parameters 6
tables 3
Index-3
Index
iptables configuration 96
J
jobs
attribute display 81
configuration 99
exit states 82, 83, 85, 24
history display 81
history runs display 81
identical start times 101
manually stopping 102
package version level selection 101
property configuration 100
restart configuration 102
run count 81
runs, resetting 97
runtime
statistics display 24
start
ID number assignment 101
start time specification 101
statistics display 81
summary display 81
tasks
configuration 105
L
LCP and NCP negotiation 14
LCP echo requests 42
linemode
asynchronous serial controller
configuration 34
settings 34
local and global commands, displaying
available 9
local CHAP and PAP authentication
settings 42
local time
display 17
local time configuration 16
log file 91
logged in user display 53
logging out of a console or remote
session 29
login banner
configuration 14
display 16
logout 29
loss-of-signal event type 81
low band threshold 81
low event 60
low event type 81
M
management information base 174
management station
configuration 175
managing a peripheral 141
mangle table 96
maximum current configuration for
discrete analog inputs 62
MDI-X 26
mediation connection destination 168
mediation connection listeners
displaying 90
mediation connections
display 22
termination 26
mediation debugging 9
mediation display 97
mediation messages
display 34
display settings 34
mediation SNMP network elements 133
mediation timer
display 137
memory configuration for jobs 100
memory limits for a job 100
MRU 43
MTU 43
N
nagging 10
nat table 96
navigating the command hierarchy 27
navigation keys 4
NE template 125
network element and alarm entries 7
NTP
poll interval 138
preferred server 139
server 139
NTP configuration 138
display 106
O
offline event type 81
on demand install of packages 148
online event type 81
open event type 81
OpenVPN debugging 12
openVPN interface configuration 89
originator 26
output capture display 88
P
package display 111
package installation 143
package server
address configuration 150
directory configuration 150
user configuration 151
packages
minimum required version level 148
missing packages 148
on-demand-install 148
server configuration 150
uninstallation of 152
version levels for 101
packet-level debugging 14
parity, asynchronous serial controller
configuration of 34
part number 115
partial command inputs, displaying 9
patch files 12
per-call modem dial string 168, 169
peripheral
display of information 107
event originator 77
management 141
type configuration 141
ping 31
point display 51
point template 128
point-template 128
point-templates 97
poll oid 129
PPP 43, 14
product
components, display of 73
prompt display configuration 83
proxy ARP 25
PyChecker utility 21
Python module display 118
R
raw response information for an alarm-
entries 7
records of job runs 97
reload 33
remote access configuration 156
remote CHAP and PAP authentication
settings 43
remote identity and secret
configuration for CHAP and PAP
authentication 43
remote-access status display 121
reset for the system 33
resource tracking
display 122
for a digital output 69
for digital inputs 66
for Ethernet controllers 24
of a discrete analog input 59
responders 164
response configuration commands
connect response configuration 167
initial configuration 159
response content settings 161
response display 123
responses
closing a relay output 161
disabling a component 162
enabling a component 162
interval response 162
opening an output 163
restarting a timer 163
stopping a timer 163
timer life configuration 163
user.log configuration 163
Index
Index-4
RMB peripheral unit
configuring 140
humidity sensor 60
rebooting 37
sitebus 172
temperature sensor 63
routing table display 74
RTS 37, 40
run count history 81
running a job 20
running process display 39
running-config 125, 34
runtime statistics display for a job 24
S
script configuration for a job 101
sensor
input 60, 62, 63
output current 62, 63
serial controller configuration
application mode 32
disconnect mode 39
encapsulation protocol 41
linemode configuration 34
parity configuration 34
stop bit 35
serial controller connection settings
connect mode 37
connect string 38
DTR 36
RTS 37
serial controller description 33
serial controller disconnect settings
disconnect mode 39
DTR 39
RTS 40
serial controller display 37
serial event originator 77
serial interface
configuration 91
display 69, 71
IP address 91
severity levels 9
shell connection termination 5, 3, 4
show
actions 5, 4
alarm-entries 8
audit 12
banner 16
clock 17
compact-flash 18
config-file 19
connections 22
controllers 24, 32
debugging 45
dhcp-relay 47
dhcp-server 48
discrete 51
events 43, 56
expansion-images 58
interfaces 61, 69
inventory 73
ip 74
iptables 78
jobs 81
listeners 90
log-file 91
meas-table 93
mediation 97
ntp 106
peripherals 107
pkgs 111
product 115
pydoc 118
remote-access 121
resource-tracking 122
responses 123
running-config 125
sitebus 127
snmp 131
timeout 136
timers 137
users 138
version 139
show controllers
bridge 26
ethernet 29
serial 37
show correlations 43
show interfaces
bridge 63
ethernet 66
serial 71
signal good event type 81
sitebus configuration 172
SNMP 133
authentication failure traps 174
community strings 174
community types 174, 175
event template 115
management stations 175
manager 118
NE template 125
network elements 133
point template 128
setting display 131
trap support for alarm entries 7
snmp
manager 118
point template 128
SNMP display
community strings 131
management stations 131
summary 131
SNMP event templates 98
SNMP manager 97
SNMP network elements 98
source data string for a connect response
169
SSH and SFTP remote access protocols
157
stage 2 bootloader 58
standard error/output 99
start at boot up for a job 102
start attempt configuration for a job 102
start time configuration for a job 101
static route configuration 94
stderr 99
stdout 99
stop bits
asynchronous serial controller
configuration of 35
stopping a job 24
stream 108
strong password 181
subcommands, displaying 8
summary display
of job runtime statistics 24
system
configuration compilation 125, 34
configuration display 125, 34
log-file display 91
timeout interval display 136
system event originator 78
T
TAB key functionality in the CLI 5
task display for a job 85
TCP
event originator 79
tcpdump 43
telnet 36
Telnet and FTP remote access protocols
157
telnet event originator 79
terminal name, for a connection 3
time and date display 17
time configuration commands 1618
time, ping display 32
timeout interval for the system 177
timer
display 137
timestamp configuration 16
timezone
display of 17
timezone configuration 16
timing out the system 177
title configuration for a job 102
top CPU process display 50
trace-route 37
trap table 175
ttl 32
U
units for analog inputs 64
up event type 82
usage statements 7
user configuration commands
password 30
users
adding 181
deleting 181
display of 138
display of all 53
password change 181
resetting 181
utility commands
copy 4
erase 19
exit 27
Index-5
Index
help 28
logout 29
overview 3
ping 31
reload 33
running-config 34
telnet 36
trace-route 37
V
varbind 130
version level display 139
W
wizards 179
Index
Index-6
Copyrights-1
CopyrightsandLicense
Statements
Copyright 1983-2010 by Kentrox, Inc.
The material discussed in this publication is the
proprietary property of Kentrox, Inc. Kentrox 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 by sending an email request to
engineer@kentrox.com.
TRADEMARKS:
Kentrox, the Kentrox logo, Applied Innovation, Applied
Innovation Inc., the AI logo, and other names are
intellectual property of Kentrox 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.
THIRD PARTIES:
OpenVPN (TM) -- An Open Source VPN daemon
Copyright (C) 2002-2010 OpenVPN Solutions LLC
<info@openvpn.net>This distribution contains multiple
components, some of which fall under different licenses.
By using OpenVPN or any of the bundled components
enumerated below, you agree to be bound by the
conditions of the license for each respective component.
Copyright 2000-2002 by the netfilter coreteam
(coreteam@netfilter.org): Paul Rusty Russell
(rusty@rustcopr.com.au), Marc Boucher
(marc+nf@mbsi.ca), J ames Morris
(jmorris@intercode.com.au), Harald Welte
(laforge@gnumonks.org), J ozsef Kadlecsik
(kadlec@blackhole.kfki.hu).
This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General
Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your
Option) any later version.
This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General
Public License along with this program; if not, write to
the Free Software Foundation, Inc., 675 Mass Ave,
Cambridge, MA 02139, USA.
Copyrights-2
Copyrights and License Statements

Remote RMM 1400 Version 2 0x Command Reference Guide Revision 2

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Remote RMM 1400 Version 2 0x Command Reference Guide Revision 2

Uploaded by

Copyright:

Available Formats

2010 by Kentrox, Inc. All rights reserved.

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

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

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

Note: This parameter must start with an alphabetic

Note: This parameter must start with an alphabetic character.

Note: When a user invokes the f r om- f i l e keyword, command

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

Note: Serial ports 1 and 2 operate only in r s- 232 linemode. Serial

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

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

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

Notes: Before configuring the DHCP server configuration file

Note: A hostname can consist of alphanumeric characters

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

Note: When entering this command, ethernet port can be

Note: DHCP does not accept network or broadcast

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

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

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

Notes: The maximum and sensor output current can be

Note: Setting the maximum sensor input lower than the

Notes: The minimum sensor output current can be configured

Note: Setting the maximum sensor input lower than the

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

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

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

Note: The OID for the aiMediationEvent MIB object is

Note: Memory is not unlimited. Concurrently running jobs

Note: If not defined by the user, the data directory name

Note: If you are using Remote with the Optima Management

Note: Parameters are of the form $(name) where the name is a

Note: You can configure the measurement template for polling by

Note: The first server configured becomes the preferred server

Note: To remove the peripheral type configuration, reset the

Note: The disable fails if there is no other enabled remote

Note: The disable fails if there is no other enabled remote

Note: You can enter binary character values by

Note: You can enter binary character values by

Note: The only device type supported for Remote RMM-1400

Note: Any queued traps are sent immediately when command

Note: A priority level on an alarm table entry will override any

Note: An indefinite login occurs when minutes is set to 0. This means

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

Note: If f act or y- conf i g is entered for filename, no

Note: The hardware address and default hardware

Note: When a port is di sabl ed (or enabl ed), its link

Note: The hardware address and default hardware

Note: Make sure that the serial controller is disabled before

Notes: 0. 0. 0. 0 for MAC specifies that a hardware address has not

Notes: 0. 0. 0. 0 for r ange specifies that an IP address range has

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

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

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

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

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

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

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

Note: Domain names can be comprised of alphanumeric

Note: In this sense, gateway is synonymous with router.

Note: Multiple scripts can be contained in a package.

Note: The only device type supported for Remote RMM-1400

Note: The only device type supported for Remote RMM-1400

Note: The only device type supported for Remote RMM-1400