Dissemination or reproduction of this document, or evaluation and communication of its contents, is not authorized except where
expressly permitted. Violations are liable for damages. All rights reserved, particularly for the purposes of patent application or
trademark registration.
This document contains proprietary information, which is protected by copyright. All rights are reserved. No part of this document may
be photocopied, reproduced or translated to another language without the prior written consent of RuggedCom Inc.
Disclaimer Of Liability
We have checked the contents of this manual against the hardware and software described. However, deviations from the description
cannot be completely ruled out.
RuggedCom shall not be liable for any errors or omissions contained herein or for consequential damages in connection with the
furnishing, performance, or use of this material.
The information given in this document is reviewed regularly and any necessary corrections will be included in subsequent editions.
We appreciate any suggested improvements. We reserve the right to make technical improvements without notice.
Registered Trademarks
RuggedServer™, RuggedWireless™, RuggedCom Discovery Protocol™ (RCDP™), RuggedExplorer™, Enhanced Rapid Spanning
Tree Protocol™ (eRSTP™), ROX™, Rugged Operating System On Linux™, RuggedBackbone™ are trademarks of RuggedCom Inc.
Rugged Operating System® (ROS®) and RuggedSwitch® are registered trademarks of RuggedCom Inc. Other designations in this
manual might be trademarks whose use by third parties for their own purposes would infringe the rights of the owner.
Warranty
Five (5) years from date of purchase, return to factory. For warranty details, visit www.ruggedcom.com or contact your customer
service representative.
Contacting RuggedCom
Corporate HeadquartersUS HeadquartersEurope Headquarters
RuggedCom Inc.
A.7. Software-Upgrade Menu .................................................................................................. 493
A.8. Upgrade Monitoring Form in Reboot-pending Stage .......................................................... 494
A.9. Upgrade Monitoring Form Showing Successful Upgrade .................................................... 495
ROX™ v2.2 User Guide24RuggedBackbone™ RX1500
Page 25
Preface
Preface
This guide describes the web-based user interface for the ROX™ version 2.2 Operating System running
on the RuggedBackbone™ RX1500 family of products.
Supported Platforms
ROX™2.2 is designed to work on RuggedCom's RuggedBackbone™ and RuggedRouter® hardware
platforms. This ensures a consistent user experience when migrating from one product model in the
family to another.
ROX™ currently supports the following RuggedCom networking platforms:
• RuggedBackbone™ RX5000 family of rugged, modular, Layer 3 switching multi-service hardware
platforms.
• RuggedBackbone™ RX1500 family of rugged, modular, hot-swappable Layer 3 switching and routing
platforms.
• RuggedRouter® RX1000 family of rugged Cyber-Security Appliances.
Who Should Use This User Guide
This guide is recommended for use by network technical support personnel who are familiar with the
operation of networks. Others who might find the book useful are network and system planners, system
programmers, and line technicians.
How This Guide Is Organized
Part I: Administration
Part I covers the graphical user interface and overall management of the hardware chassis
and operating system, including access control, logging, networking configuration, and time
synchronization.
Part II: Network Interfaces and Ethernet Bridging
Part II covers the configuration and monitoring of the Ethernet bridging functions of the system,
including Ethernet port setup, the Spanning Tree Protocol, and Virtual LANs.
Part III: Routing and Security
Part III covers the configuration and monitoring of layer 3 routing and security functions, including
OSPF, RIP, BGP, Multicast, and the Firewall.
Each part of this guide is organized into chapters that are typically devoted to one particular feature
of the system.
Each chapter discuss mechanisms, protocols, or techniques specific to a particular feature. Many
chapters include a general overview of the feature or protocol to be configured, providing some
background into the feature and how it is used on the device. All chapters present the forms and fields
in the web interface through which you configure the feature.All chapters present the CLI commands
you use to configure the feature.
While every effort is made to ensure the accuracy and completeness of this guide, some
web interface illustrations may not be exactly as shown.
Applicable Operating System Software Revision
This guide is applicable to ROX™ version 2.2.
ROX™ v2.2 User Guide25RuggedBackbone™ RX1500
Page 26
Part I. Administration
Part I. Administration
Part I describes the administration of a ROX™-based networking device:
The ROX Web InterfaceChapter 1, The ROX™ Web Interface
System AdministrationChapter 2, System Administration
Time SynchronizationChapter 3, Time Synchronization
Basic Networking ConfigurationChapter 4, Basic Network Configuration
Advanced Networking
ROX™ features two primary user interfaces: a web-based interface and a command line interface (CLI).
This user guide documents the usage and structure of the web-based user interface. For details of the
CLI, please refer to the ROX™ Command Line Interface User Guide (in progress).
1.1. Getting Started
1.1.1. Requirements
Accessing the ROX™ web interface for the first time, prior to any system configuration, requires:
• A computer with an installed web browser capable of running JavaScript. ROX™ supports the
following web browsers:
• Microsoft® Internet Exporer 8.0 and higher
• Mozilla Firefox
• GNU Iceweasel
• Google Chrome
• The computer must have a working Ethernet interface, which must be compatible with at least one
of the port types on the RuggedBackbone™ as ordered.
• The ability to configure an IP address and netmask on the computer’s Ethernet interface.
1.1.2. Connecting To The Web Interface
By default, the RuggedBackbone™ RX1500 has a different IP address and subnet configured for each
of two distinct IP interfaces, each of which is mapped to one or more physical ports:
Interface NameLocationIP Address/Mask
fe-cm-1Front panel interface192.168.1.2/24
All other Ethernet portsLM and SM cards192.168.0.2/24
Table 1.1. Default IP Address Configuration
In order to connect to the RX1500 using a web browser, configure the IP address of the web browser’s
system to fall within the subnet of the corresponding RX1500 interface. For example, if the web browser
system is connected to the Ethernet interface on the RX1500 front panel:
• The web browser system’s Ethernet interface must be configured with an IP address in the range:
192.168.1.3 to 192.168.1.254.
• The RX1500 is accessible to the web browser at the IP address: 192.168.1.2, the address of the fecm-1 network interface.
1.1.3. The Web Browser Connection
The ROX™ web server uses SSL (Secure Socket Layer) to encrypt data traffic exchanged with its clients
(connections made via "https://"). This guarantees the privacy of communications between browser and
server.
It can happen that upon connecting to the ROX™ web server, some new web browsers
may report that they cannot verify the authenticity of the server’s certificate against any of
their known certificate authorities. This is expected, and it is safe to instruct the browser
to accept the certificate offered by the ROX™ system. Once the browser is instructed to
accept the certificate, all communications with the web server will be secure.
ROX™ v2.2 User Guide27RuggedBackbone™ RX1500
Page 28
1. The ROX™ Web Interface
Start a web browser session and open a connection to the switch by entering a URL that specifies its
IP address (https://192.168.1.2, to continue with the example above). Once the web browser makes
contact with the switch, The resulting page should be the login prompt displayed below:
Figure 1.1. The ROX™ Login Form
Enter the default user name, "admin" and the configured password for the admin user. Click on the
Login button. The switch is shipped with a default administrator password, "admin". If authentication
is successful, the main menu is presented.
1.2. The Structure Of The Web Interface
The system configuration interface (the Configure Running tab) is organized as a hierarchical set of
linked menu entries, which may be traversed using the four-panel navigation window, as illustrated
below.
Figure 1.2. The ROX™ Web Interface
Menu items listed in a panel of the navigation window at a given point in the menu hierarchy may be:
•
Submenus, which are marked using the icon, or
•
Actions, which are marked using the icon.
Note that green submenu icons represent operational data.
ROX™ v2.2 User Guide28RuggedBackbone™ RX1500
Page 29
1. The ROX™ Web Interface
Tables and forms relevant to the selected menu item appear below the navigation window.
The icons in the upper left corner of the forms and tables are used to signify the type of content
represented in each form or table.
•
The green arrow icon signifies operational data.
•
The key icon signifies the key in key settings.
•
The blue globe icon signifies the global group (a high-level grouping of items).
•
The pencils and protractor icon signifies configuration data.
•
The paper and pencil icon signifies results. This icon is usually found on a form where there are
parameters to enter.
Every web page in the ROX™ user interface has a header, illustrated above, containing:
•
The ROX™ and RuggedCom logos and a Logout button, which terminates the current web
session.
• The tabs: Configure Running and Tools.
The Configure Running tab selects the configuration interface described above. A menu bar below the
page header displays the following editing mode controls:
• View: View configuration settings only.
• Edit Private: Enter a configuration editing mode where you can make changes to the system. Your
changes are applied to the active system only when you commit them. Edit sessions are self
contained: the changes made in your edit session are not visible to other users in other edit sessions.
• Edit Exclusive: Enter a configuration editing mode where, after committing your changes, you can
specify a timeout period to test the changes. At the end of the timeout period, your changes to revert
back to the original settings. Use this mode when you want to test changes before committing them
permanently. When you click Commit, a dialog prompts you to set a commit timeout. Type a value
and select a unit of time. ROX temporarily applies your changes to the active system for the specified
time. To cancel the commit and discard the changes, click Abort Commit before the time elapses.
To permanently commit your changes, click Commit before the time elapses.
In many cases, the tables appear on a screen closer to the top level and clicking on one of the submenus
brings up the form(s) associated with the table. For example, clicking on the Chassis menu and then
the Hardware submenu will display the Slot Hardware table. Further clicking on the pm1 submenu will
display the Slot Hardware form.
The Tools tab displays a menu of tools in the menu bar, with the following structure:
• Device Info: displays text from various system logs. You can specify the number of lines to view and
a text filter.
• Messages Viewer: displays all events from /var/log/messages.
• Syslog Viewer: displays syslog events from /var/log/syslog.
• Authlog Viewer: displays authentication events from /var/log/auth.log.
• Layer2log Viewer: displays Layer 2 events from /var/log/layer2.
• Kernlog Viewer: displays kernel events from /var/log/messages.
• Accessories
• Ping: an ICMP echo tool for IPv4 addresses
• Ping6: an ICMP echo tool for IPv6 addresses
ROX™ v2.2 User Guide29RuggedBackbone™ RX1500
Page 30
1. The ROX™ Web Interface
• Tcpdump: a packet analyzer for TCP/IP and other packets
• Traceroute: a tool for displaying route or path information and packet transit delays between IPv4
addresses
• Traceroute6: a tool for displaying route or path information and packet transit delays between IPv6
addresses
• CLI: a command line interface window
• Users: displays a list of currently connected users, provides controls to kick users off of the system,
and provides a message board to send messages to users.
• Upload: uploads configuration files, feature keys, elan certificates, ipsec certificates, ca certificates,
and crl certificates to the system from your workstation. From the Choose file type list, select the type
of file to upload. Click Choose File and navigate to and select a file on your workstation. To upload
the selected file, click Send.
• Download: downloads configuration files, feature keys, elan certificates, ipsec certificates, ca
certificates, crl certificates, log files, and rollback files from the system to your workstation. From the
Choose file type list, select the type of file to download. Click List files; a list of available files appears.
To download a file, right-click on a file name and select Save Link As (the name of the menu option
will vary, depending on your browser). To open a file in a new window or tab, click on a file name.
1.2.1. Top-level Menu Categories
Figure 1.3. Top-level Menu
Below is a description of the categories in the top-level menu that is shown above.
admin
The admin menu is used for configuring functions related to the administration of the router.
Functions include DNS, alarms, logging, authentication, users, software upgrade, notifications and
SNMP.
chassis
The chassis menu is used for configuring the chassis.
global
The global menu is used for configuring global functions including profiles for PPP and cellular
modems.
interface
The interface menu is used for configuring the interface, including (where applicable) sections for
WAN, serial, modem and trunks.
ROX™ v2.2 User Guide30RuggedBackbone™ RX1500
Page 31
1. The ROX™ Web Interface
interfaces
The interfaces menu displays the status of functions configured via the interface menu. For example,
eth functions can be configured using the eth submenu that is accessible from the interface menu.
The eth status can be viewed by clicking on the eth submenu of the interfaces menu.
switch
The switch menu is used for configuring Layer 2 packet switching functions. Functions included are
port security, DHCP relay agent, port mirroring, multicast filtering, CoS, mac tables, spanning tree,
VLANs, layer 3 switching and net discovery. You can also reset switched ports and clear switched
port statistics and cable diagnostic test results.
tunnel
The tunnel menu is used for configuring IP tunnels using IPsec, Layer 2 tunnelling functions and
Generic Routing Encapsulation (GRE).
ip
The ip menu is used for configuring the ROX™ system’s IP network interfaces.
qos
The qos menu is used for configuring traffic control.
routing
The routing menu is used for configuring the routing features. Included are sections on dynamic,
static, status and multicast routing.
security
The security menu is used for configuring security, including the firewall.
services
The services menu is used for configuring various services. These services include timekeeping,
VRRP, DHCP server and linkfailover.
1.3. Making Configuration Changes
In order to make configuration changes, select the desired Edit Private mode from the configuration
view. The same navigation window, tables and forms are redisplayed, but with additional controls, as
illustrated below.
ROX™ v2.2 User Guide31RuggedBackbone™ RX1500
Page 32
1. The ROX™ Web Interface
Figure 1.4. Example of Edit Private Mode
The example above depicts the process of adding a VLAN ID to an interface. The interface/eth/cm1
menu can be seen to contain:
• A configuration entry, followed by a "delete" icon, , which removes the corresponding entry.
Clicking on <add vlan> displays the Add ID form below the navigation window, which prompts for a VLAN
ID. Entering a VLAN ID and clicking Add adds the selected VLAN to the currently selected interface.
Note the help button, , on the Add ID form which, when clicked, displays context-sensitive information
about the corresponding data field.
A red asterisk appears beside fields that are mandatory for configuration, when in Edit Private mode.
Note the red asterisk next to the field name (VLAN ID) in the Key settings form.
Several controls below the header and menu bar are used to affect the behaviour of the changes made
during the current configuration editing session:
Changes
Present a summary of all pending changes.
Validate
Automatically check the validity of pending changes.
Revert All
Abort all pending changes.
Commit
Commit all pending changes - save changes persistent configuration storage and to the running
system.
Rollback
Present a list of change sets made to date, with an option to revert a selected set of changes.
ROX™ v2.2 User Guide32RuggedBackbone™ RX1500
Page 33
1. The ROX™ Web Interface
Exit Transaction
Exit from configuration editing mode. If there are pending changes, a prompt will be presented to
verify the discarding of all pending changes.
1.3.1. Configuring Tables Using Key Settings Forms
Much of the information in ROX™ is organized into tables. Each table is indexed or sorted by a key,
which is a piece of information such as a name, address, or other variable. For example, a Chassis
Hardware table is indexed by slot name (with the slot name being the key) and a DNS Server table is
indexed by IP address (with the IP address being the key). Key information can be added using the key
settings forms. To add server information to a DNS server table, for example, add the server address
to the key settings form and this information will appear in the DNS server table.
Figure 1.5. Adding Key Information
To add key information to a table, go into the Edit Private mode and enter the information into the
key settings form. Click the Commit button. When you have finished making all changes, click the ExitTransaction button to return to the View mode.
ROX™ v2.2 User Guide33RuggedBackbone™ RX1500
Page 34
1. The ROX™ Web Interface
Figure 1.6. Key Information in a Table
The information entered in the key settings form will now appear in the table. Note that the table appears
on the server screen, while the key settings form appears on the address screen, which is a submenu
linked to the server screen (see below).
Figure 1.7. Example of Key Settings 1
ROX™ v2.2 User Guide34RuggedBackbone™ RX1500
Page 35
1. The ROX™ Web Interface
Figure 1.8. Example of Key Settings 2
The submenus that display the key settings forms appear in the far right column of the screen.
Sometimes, it will be necessary to traverse several menu screens to get to a key settings form.
1.3.2. Viewing More Information in Tables
Occasionally, a table may have more entries that are not visible in the initial view. If you encounter a
table that has a line of linked text at the top with the word "Next", and a number in parentheses ( ), you
can click on the "Next" link and access additional entries. The two figures below illustrate this situation.
In this case, there are 18 entries in the table. The first table contains 16 entries and 2 entries follow
in the next table.
ROX™ v2.2 User Guide35RuggedBackbone™ RX1500
Page 36
1. The ROX™ Web Interface
Figure 1.9. First Table of Information
Figure 1.10. Second Table of Information
The second table of information shows the balance of the entries and contains a link back to the previous
entries.
ROX™ v2.2 User Guide36RuggedBackbone™ RX1500
Page 37
2. System Administration
2. System Administration
This chapter describes administration-related functions and the Administration menu. Information on
the Administration submenus is found throughout Part 1 of this guide.
2.1. Administration menu
Figure 2.1. Administration menu
The Administration (Admin) menu is accessible from the main menu. Use this menu to link to submenus
related to alarms, DNS, logging, SNMP, authentication, user IDs and passwords, software versions
(upgraded) and netconf.
As well, you can link directly from the Admin menu to commands called "actions" (see below) that
will clear or acknowledge all alarms, shut down or reboot the system, set the system clock or restore
factory defaults.
2.2. System Commands
This section describes where to find basic system commands using the Administration menu and its
menu actions. The following forms are accessible from the Administration menu.
Figure 2.2. Clear All Alarms Menu Action form
To clear all alarms, click on the clear-all-alarms menu action and then click the Perform button on the
Clear All Alarms form.
Figure 2.3. Acknowledge All Alarms Menu Action form
ROX™ v2.2 User Guide37RuggedBackbone™ RX1500
Page 38
2. System Administration
To acknowledge all alarms, click on the acknowledge-all-alarms menu action and then click the Perform
button on the Acknowledge All Alarms form.
Figure 2.4. Shutdown the Device Menu Action form
To shut down the device, click on the shutdown menu action and then click the Perform button on the
Shutdown the Device form.
Figure 2.5. Reboot the Device Menu Action form
To reboot the device, click on the reboot menu action and then click the Perform button on the Reboot
the Device form.
Figure 2.6. Set New Time and Date form
The Set New Time and Date form configures the current time and date settings.
Figure 2.7. Set Clock on Target Device form
To set the clock on the target device, click on the setSystemClock menu action, then enter the relevant
time/date information into the Set New Time and Date form. The information must be in the following
format: YYYY-MM-DD HH:MM:SS. After entering this information, click the Perform button on the Set
clock on target device form.
For more detailed information on time synchronization, refer to Chapter 3, Time Synchronization.
ROX™ v2.2 User Guide38RuggedBackbone™ RX1500
Page 39
2. System Administration
Figure 2.8. Restore-factory-defaults Trigger Action form
To restore factory defaults to the system, click on the restore-factory-defaults menu action and then
click the Perform button on the Restore-factory-defaults Trigger Action form.
The Administration, Hostname, Timezone and Current System Time forms are accessible from the
Admin menu.
Figure 2.9. Administration form
System Name
Synopsis: A string
Default: System Name
An administratively-assigned name for this managed node. By convention, this is the node's fullyqualified domain name. If the name is unknown, the value is the zero-length string.
Location
Synopsis: A string
Default: Location
The physical location of this node (e.g., 'telephone closet, 3rd floor'). If the location is unknown, the
value is the zero-length string.
contact
Synopsis: A string
Default: Contact
The textual identification of the contact person for this managed node, together with information on
how to contact this person. If no contact information is known, the value is the zero-length string.
Figure 2.10. Hostname form
ROX™ v2.2 User Guide39RuggedBackbone™ RX1500
Page 40
2. System Administration
The hostname is the name of the product. (This can be changed, though.)
name
Synopsis: A string conforming to: "[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])*"
Default: ruggedcom
The hostname is the name of this device.
domain
Synopsis: Domain name (RFC 1034)
Default: localdomain
The domain for this hostname.
Figure 2.11. Timezone form
Timezone Category
Synopsis: string
Selects the timezone. Note that the Etc/GMT timezones conform to the POSIX style and have their
signs reversed from common usage. In POSIX style, zones west of GMT have a positive sign; zones
east of GMT have a negative sign.
Timezone
Synopsis: string
Selects the timezone.
Figure 2.12. Setting the Timezone Form - in Edit Private Mode
To set the time zone, enter Edit Private mode and click on the Timezone Category field. Use the
drop-down menu which appears to select the appropriate time zone. Daylight saving time will adjust
automatically, if applicable to your zone.
Figure 2.13. Current System Time form
The Current System Time form displays the current time.
UTC Time
Synopsis: string
The current GM Time
Local Time
Synopsis: string
ROX™ v2.2 User Guide40RuggedBackbone™ RX1500
Page 41
2. System Administration
The current local time
2.3. Administrative Access Control
The following access control forms are accessible from the Administration menu - by clicking on the
main menu under admin.
Figure 2.14. CLI Sessions form
enabled
Synopsis: boolean
Default: true
Provides the ability to configure CLI features on the device.
Listen IP
Synopsis: IPv4 address in dotted-decimal notation
Synopsis: IPv6 address in colon-separated hexadecimal notation
Default: 0.0.0.0
The IP Address the CLI will listen on for CLI requests (default 0.0.0.0).
Listen Port
Synopsis: unsigned short integer
Default: 22
The port on which the CLI listens for CLI requests. The default is port 22.
Extra IP:Ports
Synopsis: A string
Synopsis: "extra-ip-ports" occurs in an array.
The CLI will also listen on these IP Addresses:Port values. Add ':#' to set non-default port value #.
(ie. xxx.xxx.xxx.xxx:19343 [::] [::]:16000)
Maximum idle time before terminating a NETCONF session. If the session is waiting for notifications,
or has a pending confirmed commit, the idle timeout is not used. The default value is 0, which
means no timeout.
greeting
Synopsis: string
Default: Welcome to Rugged CLI
Sets the greeting presented when the user logs in to the CLI.
Figure 2.15. Idle-timeout field
Clicking on the Idle-timeout field on the CLI Sessions form allows you to choose a value for this field.
The default value is PT30M, which stands for "Precision Time 30 Minutes". This refers to the time when
an inactive session expires or times out. Only integer values corresponding to the following fields can
be entered: Year, Month, Day, Hour, Min, Sec, or Ms. The example above shows the default value of
PT30M, which corresponds to the Min field.
Figure 2.16. Session Limits form
The Session Limits form is used for setting the maximum number of users sessions on a northbound
channel.
Maximum idle time before terminating a WebUI session. If the session is waiting for notifications, or
has a pending confirmed commit, the idle timeout is not used. The default value is 0, which means
no timeout.
Figure 2.19. Idle-timeout field
Clicking on the Idle-timeout field on the WWW Interface Sessions form allows you to choose a value for
this field. The default value is PT30M, which stands for "Precision Time 30 Minutes". This refers to the
time when an inactive session expires or times out. Only integer values corresponding to the following
fields can be entered: Year, Month, Day, Hour, Min, Sec, or Ms. The example above shows the default
value of PT30M, which corresponds to the Min field.
2.4. User Accounts
Figure 2.20. Users menu
The Users menu is accessible from the main menu under admin. This menu is used to access
commands needed for creating and managing passwords for administrators, operators and guests.
Both private and public passwords can be created. The Admin Users ID Table (below) can be found
on the same screen as the Users menu. Clicking on admin, guest, oper, private or public will lead you
to the Users ID forms for each of these options.
Figure 2.21. Users table
ROX™ v2.2 User Guide45RuggedBackbone™ RX1500
Page 46
2. System Administration
Figure 2.22. Users form
name
Synopsis: string
User Name
password
Synopsis: A string
User Password
role
Synopsis: string - one of the following keywords { guest, operator, administrator }
Default: guest
User Role
Figure 2.23. Users Screen in Edit Private View
Passwords can be managed, added and deleted while in the Edit Private view.
ROX™ v2.2 User Guide46RuggedBackbone™ RX1500
Page 47
2. System Administration
2.5. Software Upgrade
ROX™ supports two system partitions. One is always active and the other is inactive. ROX™ always
applies software upgrades to the inactive partition, providing the following advantages:
1.The current system is unaffected and can operate normally while the upgrade is in progress
2.The current partition remains intact, allowing you to roll back to the original system if needed
After a successful upgrade, the next reboot boots the upgraded partition.
The following applies to software upgrades:
• All system configurations and all user files (featurekeys, configuration files etc.) are carried over to
the upgraded partition.
• All configurations are locked during an upgrade and until the upgraded partition is booted. This
prevents post-upgrade configuration changes that are not carried over to the upgraded partition.
• Completed upgrades can be declined before the next reboot.
• If major system failures are detected upon booting the upgraded partition, the system will
automatically roll back to the previous partition.
Figure 2.24. Software-Upgrade menu
The Software-Upgrade menu is accessible from the main menu under admin. The path to this menu
is admin/software-upgrade. This menu links to functions that will enable the user to upgrade software,
launch the upgraded software, decline new upgrades, and rollback and reboot. The Upgrade Monitoring
form and Upgrade Settings form appear on the same screen as the Software-Upgrade menu.
Figure 2.25. Upgrade Settings
In edit mode, define an upgrade server on the Upgrade Settings form by setting the Server URL and
Target ROX Version parameters. The Upgrade Server URL is the location of the ROX™ software
repository. Target ROX Version is the version of ROX to which you are upgrading. For information on
setting up an upgrade server, see Appendix C, Setting Up An Upgrade Server.
Upgrade Server URL
Synopsis: string
repository-url
Target ROX Version
Synopsis: string
ROX™ v2.2 User Guide47RuggedBackbone™ RX1500
Page 48
2. System Administration
target-version
Figure 2.26. Upgrade Monitoring
The Upgrade Monitoring form displays the status of the current upgrade operation.
software-partition
Synopsis: A string
The current active partition number. The unit has two software partitions: #1 and #2. Upgrades are
always peformed to the other partition.
Current Version
Synopsis: A string
The current operating software version.
Upgrade Phase
Synopsis: string - one of the following keywords { Failed, Completed successfully, Unknown
The current phase or state of the upgrade. It is one of 'Estimating upgrade size', 'Copying filesystem',
'Downloading packages', 'Installing packages', Unknown state', 'Completed successfully', or
'Failed'. These phrases will not vary, any may be used programmitcally for ascertaining state.
status-message
Synopsis: string
Additional details on the status of the upgrade
Phase 1: Filesystem Sync (% complete)
Synopsis: integer
Phase 1 of the upgrade involves synchronizing the filesystem with the partition to which we are
upgrading.
This reflects the estimated percent complete.
Phase 2: Package Download (% complete)
Synopsis: integer
Phase 2 of the upgrade downloads all packages that require an update. This reflects the estimated
percent complete.
ROX™ v2.2 User Guide48RuggedBackbone™ RX1500
Page 49
2. System Administration
Phase 3: Package Installation (% complete)
Synopsis: integer
Phase 3 of the upgrade installs all packages that require an update. This reflects the estimated
percent complete.
Last Attempt
Synopsis: A string
The date and time of completion of the last upgrade attempt.
Last Result
Synopsis: string - one of the following keywords { Interrupted, Declined, Not Applicable, Reboot
Indicates whether or not the last upgrade completed successfully
Figure 2.27. Launch Upgrade
To launch an upgrade, click on the launch-upgrade menu action and then click the Perform button on
the Launch Upgrade form. Note that the server URL and version name information must be entered
in the Upgrade Settings form prior to launching the upgrade. For detailed step-by-step instructions on
how to perform a software upgrade, refer to Appendix A, Upgrading Software.
Figure 2.28. Decline Upgrade
To decline an upgrade, click on the decline-upgrade menu action and then click the Perform button on
the Decline Upgrade form.
Figure 2.29. Rollback and Reboot
To roll back an upgrade, click on the rollback-reboot menu action and then click the Perform button on
the Rollback and Reboot form.
Rollback and Reboot “rolls back” the system to the previously active software installation, which is
stored on the alternate of two filesystem partitions in flash memory. Performing this action will result in
rebooting the system using the old software installation along with its configuration.
ROX™ v2.2 User Guide49RuggedBackbone™ RX1500
Page 50
2. System Administration
Any configuration changes made since the last software upgrade will not be reflected after
rebooting to the "rolled-back" software installation.
ROX™ supports two system partitions. One is always active and the other is inactive. ROXflash allows
you to flash any ROX™ software version to the inactive partition.
To obtain a flash image, contact your RuggedCom sales representative. Place the flash image in a
location on your network accessible to the ROX™. On the ROXflash form, enter the URL for the flash
image and flash it to the inactive partition. The flash image will be active after the next reboot.
2.6.1. Uses
Use ROXflash for downgrading to an earlier version of the ROX software. For example, your
organization has certified a specific version of the ROX software, and all ROX™ units must run the
certified version. Due to an equipment issue, you need to install a new ROX™ unit that comes with a
later version of the software. In this example, use ROXflash to install the earlier version of the software
on the new unit.
Use ROXflash only to install earlier versions of the ROX software. Software upgrades to later versions
should be performed using the Software Upgrade function.
Table 2.1, “Differences Between ROXflash and Software Upgrade Functions” outlines some of the
key differences between the ROXflash and Software Upgrade functions. For more information on the
Software Upgrade function, see Section 2.5, “Software Upgrade”.
ROXflashSoftware Upgrade
Used primarily for downgrades.
Uses a flash image ordered from a
RuggedCom Sales Representative.
Downgrades to any software version supplied in an image.
Does not transfer system configurations and
files to the next software version. ROXflash
returns the unit to its factory default settings.
Configurations must be reloaded after rebooting.
Table 2.1. Differences Between ROXflash and Software Upgrade Functions
Used only for upgrades; does not support
downgrades (except for rollbacks).
Uses an archive of ROX™ software packages
hosted on an upgrade server. The archive is
available on RuggedCom.com for download.
Rolls back only to the last version
stored on the alternate partition.
Transfers configurations and files to the
upgraded software version; reverts to the
previous configurations in a rolled back version.
2.6.2. ROXflash Configuration
Figure 2.30. ROX-Imaging menu
ROX™ v2.2 User Guide50RuggedBackbone™ RX1500
Page 51
2. System Administration
The ROX-Imaging menu is accessible from the main menu under admin. The ROXflash Monitoring form
appears on the same screen as this menu.
Figure 2.31. ROXflash Monitoring form
This form shows the progress and state of the roxflash operation (during an upgrade or downgrade).
ROXflash Phase
Synopsis: string - one of the following keywords { Failed, Completed successfully, Unknown
The current phase or state of the ROXflash operation. It is always one of: 'Inactive', 'Downloading
image', 'Imaging partition', 'Unknown state', Completed successfully, or 'Failed'. These phrases do
not vary, and may be used programatically for ascertaining state.
ROXflash Status
Synopsis: A string
Detailed messages about ROXflash progress.
Phase 1: Image Download (% complete)
Synopsis: integer
Phase 1 of ROXflash downloads the image from a URL. This reflects percent complete.
Phase 2: Image Flashing (% complete)
Synopsis: integer
Phase 2 of ROXflash flashes the image to the alternate partition. This reflects percent complete.
Figure 2.32. ROXFlash menu
ROX™ v2.2 User Guide51RuggedBackbone™ RX1500
Page 52
2. System Administration
Figure 2.33. ROXFlash forms
To perform a ROXFlash operation, enter the URL into the ROXflash form and then click the Perform
button. Next, monitor the progress by returning to the ROXflash Monitoring form.
2.7. Scheduling Jobs
Use job scheduling to execute CLI (command line interface) commands at a specified time and date or
in response to configuration changes. The path to the scheduler menu is admin/scheduler.
Figure 2.34. Scheduler menu
There are two types of scheduled jobs:
• periodic jobs launch at a defined interval. Set the interval in the Minute, Hour, Day of Month, and
Month parameters. Use the Day of Week parameter to launch the job on a specific day of the week,
such as every Friday. For information on how periodic scheduled jobs behave when you omit date
and time parameters, see Figure 2.36, “Scheduled Jobs Form” and the field descriptions.
• configchange jobs launch only when the configuration changes.
The job scheduler Command parameter accepts most ROX CLI commands. Do not use commands
that require a manual response or confirmation.
The /admin/scheduler/scheduled-jobs table lists the scheduled jobs and their settings:
ROX™ v2.2 User Guide52RuggedBackbone™ RX1500
Page 53
2. System Administration
Figure 2.35. Scheduled-jobs table
To add a scheduled job:
• Enter edit mode, navigate to admin/scheduler, and click <Add scheduled-jobs>.
• On the Key settings form, enter a name for the job and click Add.
• On the Scheduled Jobs form, set the job parameters.
Figure 2.36. Scheduled Jobs form
Job Type
Synopsis: string - one of the following keywords { periodic, configchange }
Default: periodic
Determines when to launch the scheduled job:
• periodic: the job launches at a set date and time.
• configchange: the job launches when the configuration changes.
Minute
Synopsis: A string
Default:
For periodic jobs, sets the minutes portion of the job launch time. Valid values are in the range of
0 to 59. If no value is set, the scheduler uses the default value of 0 and launches the job every
hour on the the hour.
• To specify a single value, enter the value in the field. For example, to launch the job 10 minutes
past the hour, enter 10
• To specify a list of values, enter the values as a comma-separated list. For example, to launch
the job at 14, 30, and 45 minutes past the hour, enter 15,30,45
ROX™ v2.2 User Guide53RuggedBackbone™ RX1500
Page 54
2. System Administration
• To specify a range of values, enter the range as comma-separated values. For example, to launch
the job every minute between 30 and 45 minutes past the hour, enter 30-45
Hour
Synopsis: A string
For periodic jobs, sets the hour portion of the job launch time, in the 24-hour clock format. Valid
values are in the range of 0 to 23. If no value is set, the job launches every hour at the time set
in the Minute field.
• To specify a single value, enter the value in the field. For example, to launch the job at 5:00 pm,
enter 17
• To specify a list of values, enter the values as a comma-separated list. For example, to launch
the job at 9:00 am, 12:00 pm, and 5:00 pm, enter 9,12,17
• To specify a range of values, enter the range as comma-separated values. For example, to launch
the job every hour between 9:00 am and 5:00 pm, enter 9-17
Day of Month
Synopsis: A string
For periodic jobs, sets the day of the month on which to run the scheduled job. Valid values are in
the range of 1 to 31. If no value is set, the job launches every day.
• To specify a single value, enter the value in the field. For example, to launch the job on the tenth
day of the month, enter 10
• To specify a list of values, enter the values as a comma-separated list. For example, to launch
the job on the first, fifteenth, and thirtieth days of the month, enter 10,15,30
• To specify a range of values, enter the range as comma-separated values. For example, to launch
the job on days one through fifteen, enter 1-15
Month
Synopsis: A string
For periodic jobs, sets the month in which to run the scheduled job. Valid values are in the rage of
1 to 12. If no value is set, the job launches every day.
• To specify a single value, enter the value in the field. For example, to set the month to February,
enter 2
• To specify a list of values, enter the values as a comma-separated list. For example, to set the
months to January, June, and December, enter 1,6,12
• To specify a range of values, enter the range as comma-separated values. For example, to set
the months to January through June, enter 1-6
Day of Week
Synopsis: A string
For periodic jobs, sets the day of the week on which to run the scheduled job. Valid entries are in
the range of 0 to 6, where 0 represents Sunday, 1 represents Monday, and so on. If no value is
set, the job launches every day.
• To specify a single value, enter the value in the field. For example, to set the day to Monday,
enter 1
• To specify a list of values, enter the values as a comma-separated list. For example, to set the
days to Friday, Saturday, and Sunday, enter 5,6,0
• To specify a range of values, enter the range as comma-separated values. For example, to set
the days to Monday through Friday, enter enter 1-5
Command
Synopsis: A string
ROX™ v2.2 User Guide54RuggedBackbone™ RX1500
Page 55
2. System Administration
The CLI commands to execute at the scheduled time. The command or list of commands can be
up to 1024 characters in length. For example, this command saves the running configuration to a
file named 'myconfig': show running-config | save myconfig
Do not use interactive commands or commands that require a manual response or confirmation.
2.8. The Featurekey
2.8.1. Overview
Some ROX™ software features are only available by purchasing an appropriate feature level. Consult
the product datasheet for available feature levels and the specific capabilities they enable.
When specifying a feature level at the time of ordering, the featurekey is entered into the electronic
signature on the device . The featurekey is independent of the compact flash card and is retained by
the device should the card be replaced.
2.8.2. Upgrading Feature Levels in the field
Feature levels can be purchased and upgraded in the field with a file-based featurekey. To update your
featurekey, contact your RuggedCom sales representative. For RX15xx products, you need to provide
the serial number for the unit you are upgrading. The upgraded featurekey is licensed for the serial
number you provide. For instructions on how to view your serial numbers, see Section 2.8.4, “Viewing
RuggedCom Serial Numbers”.
To install the featurekey file, use the Install Files form found under that admin menu. You can also use
the file scp-featurekey-from-url command from the ROX™ Command Line Interface. For instructions
on how to upload the featurekey file, see Section 2.8.5, “Uploading a Featurekey”.
The upgraded featurekey resides on the device’s compact flash card. ROX™ evaluates both the device
featurekey and the file-based featurekey, and then enables the most capable feature level described
by the keys.
When using file-based featurekeys, the feature level follows the compact flash card. Moving the compact
flash card to another device moves the feature level to the new device. If you want the upgraded feature
level to be tied to a specific device, contact your RuggedCom sales representative to arrange for an
RMA (Return to Manufacturer Authorization) to have the featurekey programmed into the device.
2.8.3. When a File-based featurekey does not Match the Hardware
In rare circumstances, you may need to remove the compact flash card from one device and transfer
it to another device. For example: you may have a backup device to replace a malfunctioning unit, and
you choose to use the upgrade featurekey on the malfunctioning unit’s compact flash card to retain your
configuration in the backup unit.
The file-based featurekey on the compact flash card is licensed for a particular unit, but can be
transferred to another unit to ensure continuity of service. When you transfer the file-based featurekey
from its licensed unit to another unit for which it is not licensed, the device behaves in the following
manner:
1.The device enables the higher feature level found on the compact flash card.
2.The device raises a non-clearable alarm, indicating a hardware mismatch with the featurekey.
3.The alarm trips the fail-safe relay and turns on the main alarm LED.
To acknowledge the alarm and resolve the issue, follow these steps:
1.Acknowledge the alarm. (For instructions on acknowledging alarms , see Chapter 6, Alarms.)
2.Contact a Ruggedcom sales representative and order a featurekey matching the serial numbers
of the hardware you are using.
ROX™ v2.2 User Guide55RuggedBackbone™ RX1500
Page 56
2. System Administration
2.8.4. Viewing RuggedCom Serial Numbers
When you order a new featurekey, you need to provide RuggedCom with the chassis serial number.
This section describes how to view your device’s serial numbers through the CLI screen in the ROX™
web interface.
Follow these steps to display the serial numbers for your device:
Procedure 2.1. Viewing RuggedCom Serial Numbers
1.Launch a web browser and navigate to your device’s IP address. Log in to ROX™. The ROX web
interface appears.
2.Click the Tools tab and click the CLI link. The CLI screen appears.
Figure 2.37. CLI in the ROX™ Web Interface
3.At the Operational mode command line prompt, type show chassis and press Enter. Chassis
information appears:
ruggedcom# show chassis
chassis
chassis-status
model RX1501 software license "Layer 2 Standard Edition" order code ...
hardware
slot-hardware
ORDER
SLOT FIELD DETECTED MODULE SERIAL NUMBER
------------------------------------------------------------------------------------ pm1 XX none none
lm1 XX none none
lm2 TC4 T1/E1 w/ 4x RJ48 L15R-3333-PR301
lm3 D02 DDS w/ 1x RJ48 7
lm4 XX none none
lm5 CG01 1000TX w/ 2x RJ45 L15R-3109-PR001
lm6 XX none none
main CM04A RX1501 8 Gigabit Layer 2 w/ 6 LM slots and 1 PM slots R15R-1310-PR032
In the slot-hardware table, make note of the main slot serial number (highlighted in bold
text in the example above).
4.When ordering a new featurekey, provide the main slot serial number to RuggedCom.
ROX™ v2.2 User Guide56RuggedBackbone™ RX1500
Page 57
2. System Administration
2.8.5. Uploading a Featurekey
After receiving your featurekey file from RuggedCom, save the file to a computer that is accessible to
your device through your network.
2.8.5.1. Uploading a Featurekey Using the Web User Interface
Install Featurekey files using the Install Files forms found under the admin menu.
To install a featurekey file, navigate to admin/install-files. The Install Files form appears. In the in the File
type field, select featurekey. In the URL field, enter the URL to the file. On the Install Files to Devices
form, click the Perform button.
Figure 2.38. Install Files forms
For more information on installing files, see Section 2.9.1, “Installing Files”.
2.8.5.2. Uploading a Featurekey Using the Command Line Interface
To upload the file to your device, you will need to know the following information:
• the featurekey filename.
• a user name and password to log in to the computer where you saved the featurekey file.
• the hostname or IP address of the computer where you saved the featurekey file.
Follow these steps to upload a featurekey file to your device:
Procedure 2.2. Uploading a Featurekey File
1.Launch a web browser and navigate to your device’s IP address. Log in to ROX™. The ROX™
web interface appears.
2.Click the Tools tab and click the CLI link. The CLI screen appears.
3.In Operational mode, at the command line prompt, type the following command:
4.Type the command with your parameters and press Enter. When prompted, type the user’s
password and press Enter. The system uploads the featurekey file:
On the CLI screen, click Stop to close the CLI session.
2.8.6. Backing Up a Featurekey Using the Web User Interface
Featurekey files can be backed up using the following forms. These forms are accessible from the
admin menu.
To back up a featurekey file, navigate to admin/backup-files. The Backup Files form appears. In the
File type field, select featurekey. Enter additional parameters on the form. On the Backup Files From
Devices form, click the Perform button.
ROX™ v2.2 User Guide58RuggedBackbone™ RX1500
Page 59
2. System Administration
Figure 2.39. Backup Files forms
For more information on backing up files, see Section 2.9.2, “Backing Up Files”.
2.9. Installing and Backing Up Files
You can install and back up files using the following forms found under the admin menu.
Figure 2.40. Administration menu
2.9.1. Installing Files
To install a file, click install-files. The Install Files forms appear.
ROX™ v2.2 User Guide59RuggedBackbone™ RX1500
Page 60
2. System Administration
Figure 2.41. Install Files forms
On the Install Files form, select the file type and enter a URL. On the Install Files To Devices form,
click the Perform button.
2.9.2. Backing Up Files
To back up a file, click on backup-files. The Backup Files forms appear.
Figure 2.42. Backup Files forms
On the Backup Files form, select the file type and enter the required parameters. On the Backup Files
From Devices form, click the Perform button.
ROX™ v2.2 User Guide60RuggedBackbone™ RX1500
Page 61
2. System Administration
2.10. Deleting Log Files
Figure 2.43. Delete-logs menu
To delete log files, click the Perform button on the Delete Log Files form. This form is accessible at
admin/delete-logs.
Figure 2.44. Delete Log Files form
2.11. Saving Full Configurations
Save full configurations to a file using the forms below. These forms are accessible at admin/save-fullconfiguration.
Figure 2.45. Save-full-configuration menu
ROX™ v2.2 User Guide61RuggedBackbone™ RX1500
Page 62
2. System Administration
Figure 2.46. Save Full Configuration forms
To save full configurations to a file, select the format and enter the parameters in the Save Full
Configuration form, then click the Perform button in the Saving Full Configuration form.
2.12. Loading Full Configurations
Load full configurations to a file using the forms below. These forms are accessible at admin/load-fullconfiguration.
Figure 2.47. Load-full-configuration menu
Figure 2.48. Load Full Configuration forms
To load full configurations to a file, select the format and enter the parameters in the Load Full
Configuration form, then click the Perform button in the Trigger Action form.
ROX™ v2.2 User Guide62RuggedBackbone™ RX1500
Page 63
3. Time Synchronization
3. Time Synchronization
ROX™ offers the following timekeeping and time synchronization features:
• Local hardware timekeeping and time zone management
• NTP time synchronization
3.1. NTP Fundamentals
NTP (Network Time Protocol) is an Internet protocol used to synchronize the clocks of computers
to some time reference. Variants of NTP such as SNTP (Simple NTP, a reduced functionality NTP)
and XNTP (Experimental NTP) exist. NTP itself is available in versions 3 and 4 (RuggedBackbone™
includes version 4).
NTP is a fault-tolerant protocol that allows an NTP daemon program to automatically select the best
of several available time sources, or reference clocks, to synchronize to. Multiple candidates can be
combined to minimize the accumulated error. Temporarily or permanently wrong time sources are
detected and avoided.
The NTP daemon achieves synchronization by making small and frequent changes to the router
hardware clock.
The NTP daemon operates in a client-server mode, both synchronizing from servers and providing
synchronization to peers.
If NTP has a number of servers to choose from, it will synchronize with the lowest stratum server. The
stratum is a measure of the number of servers to the (most highly accurate) reference clock. A reference
clock itself appears at stratum 0. A server synchronized to a stratum n server will be running at stratum
n + 1.
You will generally configure lower stratum NTP hosts as servers and other NTP hosts at the same
stratum as peers. If all your configured servers fail, a configured peer will help in providing the NTP
time. It is generally a good idea to configure one at least one server and peer.
The NTP daemon will know about the NTP servers and peers to use in three ways.
• It can be configured manually with a list of servers to poll,
• It can be configured manually with a list of peers to send to,
• It can look at advertisements issued by other servers on multicast or broadcast addresses.
Note that if multicasting or broadcasting is used, it is strongly recommended to enable authentication
unless you trust all hosts on the network.
NTP uses UDP/IP packets for data transfer because of the fast connection setup and response times
UDP offers. The NTP protocol uses port UDP port 123. Note that if your router employs a firewall and
acts as a client it must open UDP port 123. Additionally, if the router acts as a server the firewall must
allow connection requests on port 123 as well.
3.1.1. The NTP Sanity Limit
The NTP daemon corrects the system time through two means, “stepping” and “slewing”. If the
difference between the local clock and the reference clock chosen by NTP (the “offset”) is more than
128ms for a period of more than 900 seconds, NTP will “step” or instantaneously correct the time. If the
time difference is less than 128ms, NTP will “slew” the time by no more than 500 microseconds every
second towards the correct time, in such a way that to an application on the system, the time never
appears to be flowing backwards.
ROX™ v2.2 User Guide63RuggedBackbone™ RX1500
Page 64
3. Time Synchronization
After booting, NTP uses slewing to achieve synchronization by making small and frequent changes to
the router hardware clock. If the reference server’s clock differs from the local clock by more than 1000
seconds, the NTP daemon decides that a major problem has occurred and terminates.
3.2. Configuring Time Synchronization
To configure time synchronization, configure the following items:
• set the system time and date. See Section 3.2.1, “Configuring the System Time and Date”.
• set the system timezone. See Section 3.2.2, “Configuring the System Time Zone”.
• set the local time settings. See Section 3.2.3, “Configuring the Local Time Settings”.
• add remote NTP servers. You can add remote NTP servers with or without authentication. See
Section 3.2.4, “Configuring NTP Servers”.
• set the NTP server restrictions. See Section 3.2.6, “Configuring NTP Server Restrictions”.
• configure an NTP server using Multicast or Broadcast. See Section 3.2.7, “Configuring an NTP Server
using Multicast or Broadcast”.
• configure an NTP client using Multicast. See Section 3.2.8, “Configuring an NTP Client using
Multicast”.
• configure an NTP client using Broadcast. See Section 3.2.9, “Configuring an NTP Client using
Broadcast”.
After configuring NTP, you can check the status of the NTP service. See Section 3.2.10, “Checking
NTP Status”.
3.2.1. Configuring the System Time and Date
To set the system time and date:
• Navigate to admin/set-system-clock.
• On the Set New Time and Date form, enter the date in the format YYYY-MM-DD HH:MM:SS.
Figure 3.1. Set new Time and Date form
• On the Set clock on target device form, click Perform.
3.2.2. Configuring the System Time Zone
To set the system time zone:
• In edit mode, navigate to admin.
• On the Timezone form, select a timezone from the list.
The Etc/GMT timezones conform to the POSIX style and have their signs reversed from common
usage. In POSIX style, zones west of GMT have a positive sign; zones east of GMT have a negative
sign.
ROX™ v2.2 User Guide64RuggedBackbone™ RX1500
Page 65
3. Time Synchronization
Figure 3.2. Timezone form
• Commit the changes.
3.2.3. Configuring the Local Time Settings
On the Local Time Settings form, you enable the local clock and set the NTP stratum level.
The path to the Local Time Settings form is /services/time/ntp.
To set the local time settings:
• In edit mode, navigate to /services/time/ntp.
• On the Local Time Settings form, set the local time parameters.
• Commit the changes.
Figure 3.3. Local Time Settings form
Enable
Enables the local clock
Stratum
Synopsis: unsigned byte integer
Default: 10
The stratum number of the local clock
3.2.4. Configuring NTP Servers
ROX™ can periodically refer to an NTP server to correct any accumulated drift in the onboard clock.
ROX™ can also serve time via SNTP to hosts that request it.
You can add NTP servers with or without authentication keys. To associate an authentication key with
an NTP server, you must first define the server key. For instructions on how to create server keys, see
Section 3.2.5, “Adding Server Keys”.
To view the list of configured NTP servers, navigate to /services/time/ntp/server.
Figure 3.4. Network Time Protocol (NTP) Servers
To add an NTP server:
ROX™ v2.2 User Guide65RuggedBackbone™ RX1500
Page 66
3. Time Synchronization
• In edit mode, navigate to /services/time/ntp/server and click <Add server>.
• On the Key settings form, enter the IP address or hostname for the server and click Add.
• On the Network Time Protocol (NTP) Servers form, set the server parameters.
• Commit the changes.
Figure 3.5. Network Time Protocol (NTP) Servers form
Enable
Turns on the NTP interface to this server.
Peer
Allows you to enter and edit peers. Peers are NTP servers of the same stratum as the router, and
are useful when contact is lost with the hosts in the NTP servers menu.
Minpoll
Synopsis: unsigned byte integer
Default: 6
Minimum poll interval for NTP messages, in seconds as a power of two.
Maxpoll
Synopsis: unsigned byte integer
Default: 10
Maximum poll interval for NTP messages, in seconds as a power of two.
Iburst
When the server is unreachable and at each poll interval, send a burst of eight packets instead
of the usual one.
NTP Version
Synopsis: integer
The version of the NTP protocol used to communicate with this host. Change this only if it is known
that the host requires a version other than 4.
ROX™ v2.2 User Guide66RuggedBackbone™ RX1500
Page 67
3. Time Synchronization
Prefer
Marks this server as preferred.
Key
Synopsis: unsigned short integer
An authentication key associated with this host.
3.2.5. Adding Server Keys
Use server keys to use authentication for NTP communications. NTP authentication authenticates the
time source to help prevent tampering with NTP timestamps. When using authentication, both the local
and remote servers must share the same key and key identifier. Packets sent to and received from the
server/peer include authentication fields encrypted using the key.
Keys defined here are associated with NTP servers on the Network Time Protocol (NTP) Servers and
NTP Broadcast/Multicast Servers forms.
To add a server key:
• In edit mode, navigate to /services/time/ntp/key and click <Add key>.
• On the Key settings form, enter an identifier for the key and click Add.
• On the Server Keys form, set the key parameters.
• Commit the changes.
Figure 3.6. Server Keys form
Key
Synopsis: "AES CFB128"-encrypted string
Key.
Trusted
Mark this key is trusted for the purposes of authenticating peers with symmetric key cryptography.
The authentication procedures require that both the local and remote servers share the same key
and key identifier.
3.2.6. Configuring NTP Server Restrictions
Use server restrictions to control and restrict access to the NTP server.
To set NTP server restrictions:
• In edit mode, navigate to /services/time/ntp/restrict and click <Add restrict>.
• On the Key settings form, set the following parameters and click Add.
ROX™ v2.2 User Guide67RuggedBackbone™ RX1500
Page 68
3. Time Synchronization
Figure 3.7. Server Restrictions Key settings form
Address
Synopsis: IPv4 address in dotted-decimal notation
Synopsis: IPv6 address in colon-separated hexadecimal notation
Synopsis: Domain name (RFC 1034)
Synopsis: string - the keyword { default }
Address to match. The address can be host or network IP address or a valid host DNS name.
Mask
Synopsis: IPv4 address in dotted-decimal notation
Synopsis: string - the keyword { default }
Mask used to address match. Mask 255.255.255.255 means address is treated as the address
of an individual host.
• On the Server Restrictions form, set the restriction parameters.
• Commit the changes.
Figure 3.8. Server Restrictions form
Flags
Synopsis: string - one of the following keywords { version, ntpport, notrust, notrap, noserve,
noquery, nopeer, nomodify, lowpriotrap, limited, kod, ignore }
Synopsis: "flags" occurs in an array.
Flags restrict access to NTP services. An entry with no flags allows free access to the NTP server.
• version: denies packets that do not match the current NTP version.
• ntpport: matches only if the source port in the packet is the standard NTP UDP port (123).
• notrust: denies service unless the packet is cryptographically authenticated.
• notrap: declines to to provide mode 6 control message trap service to matching hosts.
• noserve: denies all packets except ntpq(8) and ntpdc(8) queries.
• noquery: denies ntpq(8) and ntpdc(8) queries.
ROX™ v2.2 User Guide68RuggedBackbone™ RX1500
Page 69
3. Time Synchronization
• nopeer: denies packets which result in mobilizing a new association.
• nomodify: denies ntpq(8) and ntpdc(8) queries attempting to modify the state of the server;
queries returning information are permitted.
• lowpriotrap: declares traps set by matching hosts to be low priority.
• limited: denies service if the packet spacing violates the lower limits specified in the NTP discard
setting.
• kod: sends a kiss-o-death (KoD) packet when an access violation occurs.
• ignore: denies all packets.
3.2.7. Configuring an NTP Server using Multicast or Broadcast
The NTP broadcast/multicast address must be the same as the client address. It is recommended
that NTP authentication be used and that a server key be set with the broadcast/multicast setting. For
instructions on how to create server keys, see Section 3.2.5, “Adding Server Keys”.
To set a multicast/broadcast address for an NTP server:
• In edit mode, navigate to /services/time/ntp/broadcast and click <Add broadcast>.
• On the Key settings form, enter the broadcast/multicast IP address and click Add.
• On the NTP Broadcast/Multicast Servers form, set the broadcast/multicast parameters.
• Commit the changes.
Figure 3.9. NTP Broadcast/Multicast Servers form
Enable
Enables sending broadcast or multicast NTP messages to this address.
Key
Synopsis: unsigned short integer
Authentication key.
NTP Version
Synopsis: integer
The version of the NTP protocol used to communicate with this host. Change this only if it is known
that the host requires a version other than 4.
Time To Live
Synopsis: unsigned byte integer
Default: 1
Time to live.
ROX™ v2.2 User Guide69RuggedBackbone™ RX1500
Page 70
3. Time Synchronization
3.2.8. Configuring an NTP Client using Multicast
Configuring a multicast address for an NTP client enables the client to listen for and receive NTP
messages on the multicast address. It is recommended that NTP authentication be used and that
a server key be set with the multicast setting. For instructions on how to create server keys, see
Section 3.2.5, “Adding Server Keys”.
To set a multicast address for an NTP client:
• In edit mode, navigate to /services/time/ntp.
• On the NTP Multicast Clients form, set the multicast parameters.
• Commit the changes.
Figure 3.10. NTP Multicast Clients form
Enable Multicast Client
Enables the multicast message mode
Address
Synopsis: IPv4 address in dotted-decimal notation
Synopsis: IPv6 address in colon-separated hexadecimal notation
Synopsis: Domain name (RFC 1034)
Default: 224.0.1.1
The multicast address on which the NTP client listens for NTP messages.
3.2.9. Configuring an NTP Client using Broadcast
Configuring a broadcast address for an NTP client enables the client to listen for and receive NTP
messages on the broadcast address, and enables the NTP server to send NTP messages on the
broadcast/multicast address. It is recommended that NTP authentication be used and that a server key
be set with the broadcast setting. For instructions on how to create server keys, see Section 3.2.5,
“Adding Server Keys”.
To set a broadcast address for an NTP client:
• In edit mode, navigate to /services/time/ntp.
• On the Network Time Protocol (NTP) form, set the broadcast parameters.
• Commit the changes.
Figure 3.11. Network Time Protocol (NTP) form
ROX™ v2.2 User Guide70RuggedBackbone™ RX1500
Page 71
3. Time Synchronization
Enable Broadcast Client
The broadcast address on which the NTP client listens for NTP messages.
3.2.10. Checking NTP Status
To view the NTP service status:
• In normal or edit mode, navigate to /services/time/ntp/ntp-status and click <ntp-status>.
• On the Trigger Action form, click Perform.
• Review the NTP service status in the NTP Service Status form.
Figure 3.12. NTP Service Status form
For more information on viewing NTP status information, refer to http://support.ntp.org/bin/view/Support/
TroubleshootingNTP
ROX™ v2.2 User Guide71RuggedBackbone™ RX1500
Page 72
4. Basic Network Configuration
4. Basic Network Configuration
This chapter discusses the following:
• IP Interfaces
• Configuring IPv4 and IPv6 Addresses
• Simple Network Setups with IPv4 and IPv6 Addresses
4.1. IP Interfaces
Figure 4.1. IP menu
The IP menu is accessible from the main menu under ip.
4.1.1. Configuring an IP Address
The RX1500 has the following internet interfaces configured by default: dummy0, fe-cm-1, and
switch.0001. The default IP addresses for fe-cm-1 and switch.0001 are configured under the ipv4
submenu. switch.0001 is the VLAN interface and is only seen if you have one or more ethernet line
modules. It is created implicitly as all switched ports have a default PVID of 1. The following table lists
the default IP addresses.
InterfaceIP Address
switch.0001192.168.0.2/24
fe-cm-1192.168.1.2/24
Table 4.1. Default IP Addresses
To configure a different IP address on an interface, see Procedure 4.1, “Configuring an IP Address”.
ROX™ v2.2 User Guide72RuggedBackbone™ RX1500
Page 73
4. Basic Network Configuration
Figure 4.2. Configuring an IP Address
Procedure 4.1. Configuring an IP Address
1.Enter Edit Private mode.
2.Navigate to ip/interface/ipv4.
3.To delete an existing IP address, click the delete icon.
4.Click Add address. The Key settings form appears.
5.In the IPaddress field, type the new IP address.
6.Click Commit.
7.Click Exit Transaction.
To create additional interfaces, see Section 5.3, “Adding Interfaces to Switched Ports”.
4.1.2. Simple Network Setup with the Default IPv4 Addresses
This section describes how to set up a simple network using the factory default IPv4 address.
ROX™ v2.2 User Guide73RuggedBackbone™ RX1500
Page 74
4. Basic Network Configuration
Figure 4.3. Basic Network Setup Using the Default IPv4 Addresses
Procedure 4.2. Basic Network Setup Using the Default IPv4 Addresses
1.Connect a user PC to the Fast Ethernet port (fe-cm-1) of the RX1500 and configure the PC to be
on the same subnet as the port.
2.Configure the PC to use the IP address of the Fast Ethernet port as the default gateway
3.Connect one of the switched ports from any available LMs to a switch typically connecting a LAN
4.The PCs connected to the switch should be on the same subnet as the switch.
5.Configure the switch and the PCs behind the switch to use Switch.0001’s IP address (192.168.0.2)
as the default gateway
6.From the user PC, ping the IP addresses of the PCs behind the switch. Verify the ping is successful.
To configure a WAN port and assign an IP address, see Chapter 23, WAN.
To configure Dynamic Routing on the unit, see Chapter 34, Dynamic Routing.
To configure Static Routes and Default Gateways, see Chapter 35, Static Routing.
For information related to the Firewall and IP NAT that might be necessary before connecting the unit
to the INTERNET, see Chapter 38, Firewall.
For information on adding VLAN interfaces to Switched Ports (Ethernet Ports on LMs and SM) and
assigning IP addresses to configured VLANs to make them routable, see Section 5.3, “Adding Interfaces
to Switched Ports”.
For information on Dynamic IP address assignment and ProxyARP on switched and non-switched
ports, see Section 5.3.1.1, “Configuring IP Address Source and ProxyARP for VLAN Interfaces” and
Section 5.4.1, “Configuring IP Address Source and ProxyARP for Non-switched Interfaces”.
4.1.3. Configuring an IPv6 Address
IPv6 link local addresses starting with the prefix FE80 are assigned to all routable Ethernet interfaces
in the RX1500. The Link Local addresses are hidden in the Web UI but they are visible from the CLI
(Command Line Interface) using the show interfaces ip command.
To advertise IPv6 link layer addresses to their neighbors on the same link, IPv6 Router Advertisement
in IPv6 Neighbor Discovery must be enabled. For more information on IPv6 fundamentals and Neighbor
Discovery, see Section 5.1, “IPv6 Fundamentals” and Section 5.2, “IPv6 Neighbor Discovery”.
Procedure 4.3. Configuring an IPv6 Address
1.Enter Edit Private mode.
ROX™ v2.2 User Guide74RuggedBackbone™ RX1500
Page 75
4. Basic Network Configuration
2.From the WEB UI Navigate to ip/interface/ipv6.
3.Click Add address. The Key settings form appears.
4.In the IPaddress field, type an IPv6 address with a network prefix
5.Click Commit.
6.Click Exit Transaction.
7.To delete an existing IPv6 address, click the delete icon under ip/interface/ipv6.
8.Refer to steps 3 to 7 to configure a new IPv6 address
4.1.4. Simple Network Setup with IPv6 Addresses
This section describes how to configure a simple network using the factory default IPv6 address.
Figure 4.4. Simple IPv6 Network Setup
Procedure 4.4. Simple IPv6 Network Setup
1.Connect a user PC to Fast Ethernet port (fe-cm-1) of the RX1500 and configure the PC to be on
the same subnet as the port.
2.Configure the S.PC with IPv6 address FDD1:9AEF:3DE4::1/24 and Default Gateway as
FDD1:9AEF:3DE4::2.
3.Configure the fe-cm-1 and switch.0001 interfaces of the RX1500 with the IPv6 addresses shown
in Figure 4.4, “Simple IPv6 Network Setup”.
4.Connect one of the switched ports from any available LMs to an IPv6 capable network.
5.Configure the D.PCs on the IPv6 network to be on the same IP subnet as switch.0001 and configure
the Default Gateway address as FDD2:8AEF:4DE4::2/48.
6.Enable IPv6 Neighbor Discovery under ip/{interface}/ipv6/nd. For more information on IPv6
neighbor discovery, see Section 5.2, “IPv6 Neighbor Discovery”.
7.Confirm that you can reach the D.PCs from the S.PC.
ROX™ v2.2 User Guide75RuggedBackbone™ RX1500
Page 76
4. Basic Network Configuration
4.1.5. Routable Interfaces
Figure 4.5. Routable Interfaces table
The Routable Interfaces table is accessible from the ip menu.
Figure 4.6. Routable Interfaces form
The path to the Routable Interfaces form is ip/{interface}.
Interface Name
Synopsis: A string
The name for this routable logical interface
Auto-Cost Bandwidth (kbps)
Synopsis: unsigned long integer
This value is used in auto-cost calculations for this routable logical interface in kbps
Figure 4.7. Addresses table
The path to the Addresses table is ip/{interface}/ipv4. The Addresses table provides a summary of which
IP addresses are configured.
Figure 4.8. Addresses form
The path to the Addresses form is ip/{interface}/ipv4/{address}.
ipaddress
Synopsis: IPv4 address and prefix in CIDR notation
The IPv4/Prefix (xxx.xxx.xxx.xxx/xx).
peer
Synopsis: IPv4 address in dotted-decimal notation
The peer IPv4 Address (xxx.xxx.xxx.xxx, PPP link only).
ROX™ v2.2 User Guide76RuggedBackbone™ RX1500
Page 77
5. IP Network Interfaces
5. IP Network Interfaces
This chapter familiarizes the user with:
• IPv6 Fundamentals and IPv6 Neighbor Discovery
• Adding VLAN Interfaces to Switched Ports
• Configuring IP Address Source and ProxyARP for Switched and Non-switched Interfaces
5.1. IPv6 Fundamentals
Version 6 of the Internet Protocol (IPv6, RFC 2460) has been designated to replace IPv4 throughout the
Internet. Some important changes that IPv6 introduces relative to IPv4 fall into the following categories:
5.1.1. Addressing
IPv6 addresses are four times the length of IPv4 addresses, at 128 bits, to be used as 64 bits of network
and 64 bits of host address. The larger address space allows much greater flexibility in hierarchical
network definition and routing.
The IPv6 packet header has been simplified relative to IPv4 in order to simplify and therefore speed the
processing of packets by routing nodes. It also features more efficiently encoded options and greater
flexibility in creating extensions.
5.1.2. Security
Security has been designed into IPv6, rather than being treated as a component that must be added
to existing IPv4 network stacks.
5.1.3. IPv6 Address Scopes
There are three scopes of IPv6 addresses named Link Local, Unique Local and Global. A Link Local
address is automatically assigned to any IPv6 capable interface. This address is mandatory for the
devices on the same link to communicate with each other.
The link local address begins with “FE80” in the first 10 bits of an IPv6 address and the
address is not routable. The scope for Unique Local address is within enterprise networks. It
identifies the boundary of private networks within an organization. Example of a link local address:
FE80:0000:0000:0000:020A:DCFF:FE01:0CCD
Unique Local addresses are similar to private IPv4 addresses and they are not routable on the Internet. A
Unique Local address consists of the first 7 bits as the site address starts with “FD”, the next 1 bit set to 1
meaning locally assigned, next 40 bits as the Global ID to identify a company, next 16 bits as the Subnet
ID to identify the subnets within a site and it is usually defined based on hierarchical plan, and finally
the last 64 bits for the Interface ID. Example of a unique local address: FD00:ABAB:CDCD:EFEF:
020A:DCFF:FE01:0CCD
The Global IPv6 addresses are routable and they are interned to be used on the Internet. In order to
allow address aggregation the global addresses are structured in hierarchical order. A global address
is identified by the first 48 bits specified by the service provider as the global routing prefix in which the
first 3 bits of the address start with 001 (2000::/3), the next 16 bits after the global routing prefix are used
to define subnets and the last 64 bits are used for Interface ID to define a host. Example of a unique
local address: 2001:0CCD:3456:789A:8A9C:BCAB:023A:1234
5.1.4. IPv6 Multicast Addresses
In IPv6 multicast addresses are widely used. The use of broadcast address is removed in IPv6, instead
IPV6 multicast addresses are used for neighbor discovery and route advertisement. An IPv6 multicast
address starts with first 8 bits all set to 1 (FF), next 4 bits to define the Lifetime (0 - Permanent, 1 -
ROX™ v2.2 User Guide77RuggedBackbone™ RX1500
Page 78
5. IP Network Interfaces
Temporary), then the following 4 bits to define the scope (1 - Node, 2 - Link, 5 - Site, 8 – Organization and
E – Global) and the last 112 bits identify a multicast Group ID. Some well-known multicast addresses
are mentioned below:
IPv6 M.Cast AddressScopeDescription
FF02::1Link-LocalAll Nodes on a Link
FF02::2Link-LocalAll Routers on a Link
FF01::1Node-LocalSame Node
FF01::2Node-LocalSame Router
FF05::2Site-LocalAll Routers on a Site
FF02::1:FFxx:xxxxLink-LocalSolicited Node Address
Table 5.1. Multicast Addresses
5.2. IPv6 Neighbor Discovery
In IPv6 the Neighbor Discovery (ND) protocol is seen as a replacement for IPv4 ARP message. It uses
ICMPv6 messages with various purposes include finding a link-layer address of a neighbor, discover
neighbor routers, determine any change in the link-layer address, determine when a neighbor is down,
send network information from router to hosts, which includes hop limit, MTU size, determining the
network prefix used on a link, address auto configuration, and the default route information.
There many types of ICMPv6 messages among which five types of messages are used by the ND
protocol. The five types of ICMPv6 messages are briefly described in the following section:
• Router Solicitation (ICMPv6 type 133): This message is sent by hosts to routers as a request to router
advertisement message. It uses a destination multicast address: FF02::2
• Router Advertisement Messages (ICMPv6 type 134): This message is used by routers to announce
its presence in a network. The message includes network information related to IPv6 prefixes, default
route, MTU size, hop limit and auto configuration flag. It uses a destination multicast address: FF02::1
• Neighbor Solicitation Messages (ICMPv6 type 135): This message is sent by hosts to determine the
existence of another host on the same. The goal is to find the link-layer of neighbor nodes on the
same link.
• Neighbor Advertisement Messages (ICMPv6 type 136): This message is sent by hosts to indicate the
existence of the host and it provides information about its own link-layer address.
• Redirect Messages (ICMPv6 type 137): This message is sent by a router to inform a host about a
better router to reach a particular destination address.
In RX1500, Neighbor Discovery should be configured on all Ethernet interfaces enabled for IPv6. The
following figure displays the available configuration options for IPv6 Neighbor Discovery.
ROX™ v2.2 User Guide78RuggedBackbone™ RX1500
Page 79
5. IP Network Interfaces
Figure 5.1. Neighbor Discovery form
The path to the Neighbor Discovery form is ip/{interface}/ipv6/nd.
Enable Route Advertisement
Enable to send router advertisement messages.
Set Advertisement Interval Option
Includes an Advertisement Interval option which indicates to hosts the maximum time in
milliseconds, between successive unsolicited router advertisements.
Set Home Agent Configuration Flag
Sets/unsets the flag in IPv6 router advertisements which indicates to hosts that the router acts as
a home agent and includes a home agent option.
Home Agent Lifetime
Synopsis: unsigned integer
Default: 1800
The value to be placed in the home agent option, when the home agent config flag is set, which
indicated the home agent lifetime to hosts. A value of 0 means to place a router lifetime value.
Home Agent Preference
Synopsis: unsigned integer
Default:
The value to be placed in the home agent option, when the home agent config flag is set, which
indicates the home agent preference to hosts.
Set Managed Address Configuration Flag
The flag in IPv6 router advertisements, which indicates to hosts that they should use the managed
(stateful) protocol for addresses autoconfiguraiton in addition to any addresses autoconfigured
using stateless address autoconfiguration.
ROX™ v2.2 User Guide79RuggedBackbone™ RX1500
Page 80
5. IP Network Interfaces
Set Other Statefull Configuration Flag
The flag in IPv6 router advertisements, which indicates to hosts that they should use the
administered (stateful) protocol to obtain autoconfiguration information other than addresses.
Router Lifetime
Synopsis: unsigned integer
Default: 1800
The value (in seconds) to be placed in the Router Lifetime field of router advertisements sent from
the interface. Indicates the usefulness of the router as a default router on this interface. Setting the
value to zero indicates that the router should not be considered a default router on this interface.
It must be either zero or between the value specified with the IPv6 nd ra-interval (or default) and
9000 seconds. The default is 1800 seconds.
Reachable Time (Millseconds)
Synopsis: unsigned integer
Default:
The value (in milliseconds) to be placed in the Reachable Time field in the router advertisement
messages sent by the router. The configured time enables the router to detect unavailable
neightbors. The value zero means unspecified (by this router). The default is 0.
Figure 5.2. Neighbor Discovery IPv6 Prefix
An IPv6-capable interface can use Neighbor Discovery to advertise IPv6 network prefixes to its neighbor
on the same link.
Figure 5.3. Neighbor Discovery IPv6 Prefix forms
IPv6 Prefix
Synopsis: IPv6 address and prefix in CIDR notation
The length of time in seconds during which addresses generated from the prefix remain preferred.
The default value is 604800.
Off Link
Indicates that advertisement makes no statement about on-link or off-link properties of the prefix.
No Autoconfig
Indicates to hosts on the local link that the specified prefix cannot be used for IPv6 autoconfiguration.
Set Router Address Flag
Indicates to hosts on the local link that the specified prefix contains a complete IP address by setting
the R flag.
This screen is accessible after adding an IPv6 Prefix under the Neighbor Discovery. To display the
forms, navigate to ip/{interface}/ipv6/nd/prefix.
5.3. Adding Interfaces to Switched Ports
For switched ports, you create routable interfaces by configuring VLANs. VLANs are created either
implicitly or explicitly. There are four locations in the web user interface where VLAN interfaces are
created implicitly, and one location where they are created explicitly:
Explicit/ImplicitLocation in the Web User Interface
The procedure below is an example of how to create explicit VLAN interfaces.
ROX™ v2.2 User Guide81RuggedBackbone™ RX1500
Page 82
5. IP Network Interfaces
Figure 5.4. Explicitly Adding a VLAN Interface to a Switched Port
Procedure 5.1. Explicitly Adding a VLAN Interface at switch/vlans/static-vlan
1.Go into Edit Private mode.
2.Navigate to switch/vlans/static-vlan.
3.Click on Add static-vlan. The Key settings form appears.
4.In the VLAN ID field, enter a number from 1 to 4094 (for example, 2).
5.Click Add.
6.Click Commit.
7.Click Exit Transaction.
The procedures below are examples of how to create implicit VLAN interfaces.
Procedure 5.2. Implicitly Adding a VLAN Interface at interface/switch/{port}
1.Go into Edit Private mode.
2.Navigate to interface/switch/{port}. The switch forms are displayed.
3.On the VLAN form, type the PVID number into the PVID field.
4.Click Commit.
5.Click Exit Transaction.
Procedure 5.3. Implicitly Adding a VLAN Interface at interface/trunks
1.Go into Edit Private mode.
2.Navigate to interface/trunks.
3.Click on Add trunks. The Key settings form appears.
ROX™ v2.2 User Guide82RuggedBackbone™ RX1500
Page 83
5. IP Network Interfaces
4.In the Trunk ID field, type a number between 1 and 15.
5.Click Add. The Trunks forms appear.
6.On the VLAN form, type a PVID number into the PVID field.
7.Click Commit.
8.Click Exit Transaction.
Procedure 5.4. Implicitly Adding a VLAN Interface at switch/mac-tables/static-mac-table
1.Go into Edit Private mode.
2.Navigate to switch/mac-tables/static-mac-table.
3.Click on Add static-mac. The Key settings form appears.
4.In the MAC Address field, type a string of 17 characters (for example, 11:22:33:44:55:66).
5.In the VLAN ID field, enter a number between 1 and 4094.
6.Click Add. The Static MAC Address Parameters form appears.
7.Click Enabled in the Learned field or select a port in the Slot field.
8.Click Commit.
9.Click Exit Transaction.
When configuring the static-mac-table, you must click Enabled in the Learned field or
select a port in the Slot field, otherwise the configuration will fail when you try to commit it.
Procedure 5.5. Implicitly Adding a VLAN Interface at switch/mcast-filtering/static-mcasttable
1.Enter edit mode, navigate to switch/mcast-filtering/static-mcast-table, and click <Add static-mcasttable>. The Key settings form appears.
2.In the VLAN ID field, enter a number between 1 and 4094.
3.In the MAC Address field, type a string of 17 characters beginning with 01 (for example,
01:22:33:44:55:66).
4.Click Add. The Static Multicast Summary form appears. Select an option from the CoS field or
leave normal as the default.
5.Click Commit.
6.Commit the changes.
ROX™ will create a new routable interface for each VLAN created (either implicitly or explicitly) on the
switch. These interfaces have names such as "switch.xxxx" where "x" is the VLAN ID that has been
created. It will not have a default IP address so you will need to create one using the procedure in
Section 4.1, “IP Interfaces” or use DHCP. For more information on setting DHCP, see Section 5.4.1,
“Configuring IP Address Source and ProxyARP for Non-switched Interfaces”.
5.3.1. All-VLANs
After VLAN interfaces have been added, they will be displayed in the All VLANs table, below. The path
to this table is switch/vlans/all-vlans.
ROX™ v2.2 User Guide83RuggedBackbone™ RX1500
Page 84
5. IP Network Interfaces
Figure 5.5. All VLANs table
5.3.1.1. Configuring IP Address Source and ProxyARP for VLAN Interfaces
The All VLANs Properties form can be used to configure ProxyARP and dynamic address source by
following the procedures below.
Figure 5.6. All VLANs Properties form
Procedure 5.6. Configuring IP Address Source and ProxyARP for VLAN Interfaces
1.Go into Edit Private mode.
2.Navigate to switch/vlans/all-vlans/{vlan}. The All VLANs Properties form is displayed.
3.In the IP Address Source field, select dynamic if you want the interface to get an IP address from
a DHCP server. For information on configuring RX1500 as a DHCP server, see Chapter 15, DHCP
Server. The default value for the IP Address Source field is static. To assign a static IP address
to an interface, see Chapter 4, Basic Network Configuration.
4.Click Commit.
5.Click Exit Transaction.
Procedure 5.7. Configuring ProxyARP Using the All VLANs Properties form
1.Go into Edit Private mode.
2.Navigate to switch/vlans/all-vlans/{vlan}. The All VLANs Properties form is displayed.
3.In the ProxyARP field, click Enabled.
4.Click Commit.
5.Click Exit Transaction.
ROX™ v2.2 User Guide84RuggedBackbone™ RX1500
Page 85
5. IP Network Interfaces
5.4. Non-switched Interface Menu
Figure 5.7. Non-switched Interface menu
The Non-switched (or Route-only) Interface menu is accessible from the main menu.
Figure 5.8. Routable Ethernet Ports table
The path to the Routable Ethernet Ports table is interface/eth.
Figure 5.9. Routable Ethernet Ports form
The path to the Routable Ethernet Ports form is interface/eth/{port}.
Slot
Synopsis: string - one of the following keywords { em, cm }
ROX™ v2.2 User Guide85RuggedBackbone™ RX1500
Page 86
5. IP Network Interfaces
Synopsis: string - one of the following keywords { lm6, lm5, lm4, lm3, lm2, lm1, sm }
The name of the module location provided on the silkscreen across the top of the device.
Port
Synopsis: integer
The port number as seen on the front plate silkscreen of the switch (or a list of ports, if aggregated
in a port trunk).
Enabled
Synopsis: boolean
Default: true
Enables/Disables the network communications on this port
AutoN
Enables or disables IEEE 802.3 auto-negotiation. Enabling auto-negotiation results in speed and
duplex being negotiated upon link detection; both end devices must be auto-negotiation compliant
for the best possible results
Speed
Synopsis: string - one of the following keywords { 1000, 100, 10 }
Speed (in Megabit-per-second or Gigabit-per-second). If auto-negotiation is enabled, this is the
speed capability advertised by the auto-negotiation process. If auto-negotiation is disabled, the port
is explicitly forced to this speed mode. AUTO means advertise all supported speed modes.
Duplex
Synopsis: string - one of the following keywords { full, half }
If auto-negotiation is enabled, this is the duplex capability advertised by the auto-negotiation
process. If auto-negotiation is disabled, the port is explicitly forced to this duplex mode. AUTO
means advertise all supported duplex modes.
link-alarms
Synopsis: boolean
Default: true
Disabling link-alarms will prevent alarms and LinkUp and LinkDown SNMP traps from being sent
for that interface. Link alarms may also be controlled for the whole system under admin / alarm-cfg.
IP Address Source
Synopsis: string - one of the following keywords { dynamic, static }
Default: static
Whether the IP address is static or dynamically assigned via DHCP or BOOTP. Option DYNAMIC
is a common case of dynamically assigned IP address. It switches between BOOTP and DHCP
until it gets the response from the relevant server. Must be static for non-management interfaces
ProxyARP
Enables/Disables whether the port will respond to ARP requests for hosts other than itself
on-demand
This interface is up or down on demand of link fail over.
alias
Synopsis: A string
The SNMP alias name of the interface
ROX™ v2.2 User Guide86RuggedBackbone™ RX1500
Page 87
5. IP Network Interfaces
5.4.1. Configuring IP Address Source and ProxyARP for Non-switched
Interfaces
IP addresses on routable ports are static by default. To change the IP address of the port to dynamic,
follow the procedure below. ProxyARP can also be enabled using this form.
Figure 5.10. Configuring Dynamic Address Source and ProxyARP
Procedure 5.8. Configuring IP Address Source and ProxyARP for Non-switched Interfaces
1.Go into Edit Private mode.
2.Go to interface/eth/(port}. The Routable Ethernet Ports form appears.
3.In the IP Address Source field, select dynamic if you want the interface to get an IP address from
a DHCP server. For information on configuring RX1500 as a DHCP server, see Chapter 15, DHCP
Server. To assign a static IP address to an interface, see Chapter 4, Basic Network Configuration.
ROX™ v2.2 User Guide87RuggedBackbone™ RX1500
Page 88
5. IP Network Interfaces
4.Click Commit.
5.Click Exit Transaction.
To set ProxyARP for a static or dynamic interface, follow the procedure below.
Procedure 5.9. Setting ProxyARP
1.Go into Edit Private mode.
2.Go to interface/eth/(port}. The Routable Ethernet Ports form appears.
3.In the ProxyARP field, click Enabled.
4.Click Commit.
5.Click Exit Transaction.
ROX™ v2.2 User Guide88RuggedBackbone™ RX1500
Page 89
6. Alarms
6. Alarms
6.1. Introduction
The ROXII alarm system is a highly configurable notification system of events of interest. Asserted
alarms in the system may be viewed in a table in the CLI, web user interface, as well as queried by
NETCONF. Alarms are categorized by subsystem.
The alarm system allows the user to:
• enable/disable alarms with the exception of mandatory alarms
• configure whether or not an alarm triggers the fail-relay and paints the alarm LED red
• configure the severity of an alarm to one of the following: emergency, alert, critical, error, warning,
notice, info, debug (in descending order of severity). A small minority of alarms have fixed severity.
6.1.1. Alarm Subsystems
As of the current release, there are three subsystems that support alarms; they are Admin, Chassis,
and Switch.
Note that some of the following examples describing the nature of each alarm subsystem may not be
available in this release. A list of the available alarms can be viewed in the configuration file at /admin/
alarm-cfg.
Admin Subsystem: these alarms are for administrative aspects of the device, including feature-key
problems, upgrades, and configuration changes.
Chassis Subsystem: these alarms are for physical or electrical problems, or events of interest. This
includes irregular voltages at the power supply or the insertion or removal of a module.
Switch Subsystem: these alarms pertain to layer-2 events of interests such as RSTP topology changes
and link up/down events.
6.1.2. Fail-Relay Behavior
The fail-relay shall be activated when an active alarm in the system is also configured to trigger it. Once
an alarm has been acknowledged or cleared it ceases to assert the fail-relay. The fail-relay will only be
de-activated when all active alarms that are configured to assert it have been acknowledged or cleared.
6.1.3. Alarm LED Behavior
The alarm LED on the control module shall be red when unacknowledged alarm(s) are asserted and
the LED is enabled for any of the active alarms. Once an alarm has been acknowledged or cleared,
the LED is switched off.
6.1.4. Clearing and Acknowledging Alarms
There are two broad types of alarms:
1. Non-Clearable alarms - Users cannot clear these alarms, only acknowledge them; the difference
between these actions is outlined later in this section. These alarms have a condition associated
with them that the system assesses. The system asserts the alarm when the condition is true and
clears the alarm when the condition has been resolved. An example of this is 'Bad input supply on
power module'. If a redundant power module loses its supply an alarm is asserted. If the problem
is resolved and power is returned to the module, the system de-asserts the alarm. De-asserted
alarms remain as active alarms until acknowledged by the user.
ROX™ v2.2 User Guide89RuggedBackbone™ RX1500
Page 90
6. Alarms
2. Clearable alarms - these alarms simply report an event of interest that has no resolution per se. An
example of this would be a 'configuration changed' alarm. These alarms are clearable by the user
and are never cleared by the system.
Alarms may be cleared and acknowledged both on an individual basis and globally (i.e. clear/
acknowledge all active-alarms). When an alarm is cleared by the user it is removed from the active
alarms table and no longer asserts the fail-relay and LED. When an alarm is acknowledged by the user
it de-asserts the fail-relay and LED, but it remains in the active alarms table, unless the alarm is nonclearable and de-asserted by the system. In the latter case it is removed from the table, because the
condition was resolved.
6.2. Alarm Configuration
Figure 6.1. Alarms menu
The Alarms menu is accessible from the main menu under admin.
View active alarms in the Active Alarms table.
Figure 6.2. Active Alarms table
If data is configured, the Active Alarms table will appear on the same screen as the Alarms menu.
Figure 6.3. Active Alarms Key Settings form
If data is configured, the path to the Key Settings form and Active Alarms form is admin/alarms/
{interface}.
ROX™ v2.2 User Guide90RuggedBackbone™ RX1500
Page 91
6. Alarms
Figure 6.4. Active Alarms form
subsystem
Synopsis: string - one of the following keywords { wan, switch, chassis, admin }
Alarms are categorized by the subsystem to which they belong e.g.: Admin, Chassis, Ethernet,
WAN.
Alarm ID
Synopsis: integer
Alarm Type Identifier. A value that uniquely defines a type of alarm.
Event ID
Synopsis: integer
Alarm Event Identifier. A value that uniquely defines a specific alarm event of the indicated alarm
type.
severity
Synopsis: string - one of the following keywords { debug, info, notice, warning, error, critical,
alert, emergency }
The class of severity: Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug
description
Synopsis: string
When applicable, provides further details on the alarmable event
Date/Time
Synopsis: string
The date and time the event was detected
User Actions
Synopsis: string - one of the following keywords { must-resolve, clear-or-ack, resolve-or-ack }
There are three categories of alarms:
1. clear or ack : the user can clear (remove from 'active-alarm' list) and/or acknowledge (turn off
actuator(s) but keep as active-alarm).
2. ack or resolve : the user can acknowledge only, the system will clear the alarm once it is
acknowledged and the condition is resovled.
3. must-resolve : for a minority of alarms, the condition must be resolved to turn off actuators and
clear the alarm.
actuators
Synopsis: string - one of the following keywords { acked, none, led-relay, led, relay }
ROX™ v2.2 User Guide91RuggedBackbone™ RX1500
Page 92
6. Alarms
Indicates which actuator(s) this alarm currently asserts. 'ACKED' indicates the alarm was
acknowledged so actuators are de-asserted.
Individual alarms can be cleared or acknowledged on the Clear Alarm Menu Action form or the
Acknowledge Alarm Menu Action form. To clear or acknowledge an alarm, select admin/alarms/{alarmssubmenu} and then select the Clear action or the Acknowledge action.
Figure 6.5. Clear Alarm Menu Action form
Figure 6.6. Acknowledge Alarm Menu Action form
To clear or acknowledge ALL alarms, instead of only individual alarms, access the Clear All Alarms and
Acknowledge All Alarms menu action forms. These forms are accessible from the admin menu. The
path to the Clear All Alarms Menu Action and the Acknowledge All Alarm Menu Action is admin, then
clicking on the clear-all-alarms action or the acknowledge-all-alarms action.
Figure 6.7. Clear All Alarms Menu Action form
Figure 6.8. Acknowledge All Alarms Menu Action form
ROX™ v2.2 User Guide92RuggedBackbone™ RX1500
Page 93
6. Alarms
6.2.1. Administrative Alarm Configuration
Figure 6.9. Admin Alarm Configuration table
The path to the Admin Alarm Configuration table is admin/alarm-config/admin.
Figure 6.10. Admin Alarm Configuration form
The path to the Admin Alarm Configuration form is admin/alarm-config/admin/{alarm id}.
id
Synopsis: integer
This is the ID number of the alarm assigned by the system.
description
Synopsis: A string
The name of the alarm.
severity
Synopsis: string - one of the following keywords { debug, info, notice, warning, error, critical,
alert, emergency }
The severity level can be one of emergency, alert, critical, error, warning, notice, info, and debug.
This cannot be changed for some alarms
admin-enable
If disabled, the alarm is not reported in the active list and does not actuate led/failrelay.
failrelay-enable
If enabled, this alarm will assert the failrelay.
led-enable
If enabled, the main 'Alarm' LED light will be red when this alarm is asserted. If disabled, the main
'Alarm' LED light is not affected by this alarm.
ROX™ v2.2 User Guide93RuggedBackbone™ RX1500
Page 94
6. Alarms
6.2.2. Chassis Alarm Configuration
Figure 6.11. Chassis Alarm Configuration table
The path to the Chassis Alarm Configuration form is admin/alarm-config/chassis.
Figure 6.12. Chassis Alarm Configuration form
The path to the Chassis Alarm Configuration form is admin/alarm-config/chassis/{alarm id).
id
Synopsis: integer
This is the ID number of the alarm assigned by the system.
description
Synopsis: A string
The name of the alarm.
severity
Synopsis: string - one of the following keywords { debug, info, notice, warning, error, critical,
alert, emergency }
The severity level can be one of emergency, alert, critical, error, warning, notice, info, and debug.
This cannot be changed for some alarms
admin-enable
If disabled, the alarm is not reported in the active list and does not actuate led/failrelay.
failrelay-enable
If enabled, this alarm will assert the failrelay.
led-enable
If enabled, the main 'Alarm' LED light will be red when this alarm is asserted. If disabled, the main
'Alarm' LED light is not affected by this alarm.
ROX™ v2.2 User Guide94RuggedBackbone™ RX1500
Page 95
6. Alarms
6.2.3. Switch Alarm Configuration
Figure 6.13. Switch Alarm Configuration table
The path to the Switch Alarm Configuration form is admin/alarm-config/switch.
Figure 6.14. Switch Alarm Configuration form
The path to the Switch Alarm Configuration form is admin/alarm-config/switch/{alarm id).
id
Synopsis: integer
This is the ID number of the alarm assigned by the system.
description
Synopsis: A string
The name of the alarm.
severity
Synopsis: string - one of the following keywords { debug, info, notice, warning, error, critical,
alert, emergency }
The severity level can be one of emergency, alert, critical, error, warning, notice, info, and debug.
This cannot be changed for some alarms
admin-enable
If disabled, the alarm is not reported in the active list and does not actuate led/failrelay.
failrelay-enable
If enabled, this alarm will assert the failrelay.
led-enable
If enabled, the main 'Alarm' LED light will be red when this alarm is asserted. If disabled, the main
'Alarm' LED light is not affected by this alarm.
ROX™ v2.2 User Guide95RuggedBackbone™ RX1500
Page 96
7. Domain Name Search
7. Domain Name Search
7.1. Domain Name Lookup
The DNS (Domain Name Service) menu is accessible from the main menu under admin. The path to
this menu is admin/dns.
Figure 7.1. DNS menu
Figure 7.2. Domain Name Searches form
The path to the Domain Name Searches form is admin/dns/search.
domain
Synopsis: Domain name (RFC 1034)
Figure 7.3. Domain Name Servers
The path to the Domain Name Servers table is admin/dns/server.
address
Synopsis: IPv4 address in dotted-decimal notation
Synopsis: IPv6 address in colon-separated hexadecimal notation
ROX™ v2.2 User Guide96RuggedBackbone™ RX1500
Page 97
8. Logging
8. Logging
The syslog provides users with the ability to configure local and remote syslog connections. The remote
syslog protocol, defined in RFC 3164, is a UDP/IP-based transport that enables a device to send event
notification messages across IP networks to event message collectors, also known as syslog servers.
The protocol is simply designed to transport these event messages from the generating device to the
collector.
ROX™ supports up to 5 collectors (syslog servers). Remote Syslog provides the ability to configure:
• IP address(es) of collector(s).
• Source UDP port.
• Destination UDP port per collector.
• Syslog source facility ID per collector (same value for all ROX™ modules).
• Filtering severity level per collector (in case different collectors are interested in syslog reports with
different severity levels).
8.1. Configuring Local Syslog
The local syslog configuration enables users to control what level of syslog information will be logged.
Only messages of a severity level equal to or greater than the configured severity level are written to
the syslog.txt file in the unit.
8.2. Configuring the Remote Syslog Server
Figure 8.1. Logging menu
The Logging menu is accessible from the main menu under admin. The path to this menu is admin/
logging.
Figure 8.2. Remote Server table
The Remote Server table appears on the same screen as the Logging menu.
The Remote Server table can be used to identify a remote logging server.
ROX™ v2.2 User Guide97RuggedBackbone™ RX1500
Page 98
8. Logging
Figure 8.3. Remote Server form
If data is configured, there will be a list of logging servers under admin/logging/server. Clicking on each
server will allow you to access the settings and Remote Server forms.
Server IP Address
Synopsis: IPv4 address in dotted-decimal notation
Synopsis: IPv6 address in colon-separated hexadecimal notation
Synopsis: Domain name (RFC 1034)
The IPv4 or IPv6 address of a logging server. Up to 8 logging servers can be added.
enabled
Enables/disables the feed to the remote logging server
Figure 8.4. Remote Server Selector table
If data is configured, the path to the Remote Server Selector table will be admin/logging/server.
Figure 8.5. Selector menu
If data is configured, the path to the Remote Server Selector Forms (below) will be admin/logging/server.
Then click on the next linked submenu, then on "selector" and then "1" or any linked submenus that
may be in this list.
ROX™ v2.2 User Guide98RuggedBackbone™ RX1500
Page 99
8. Logging
Figure 8.6. Remote Server Selector form
name
Synopsis: integer
The log selector identifier. Enter an integer greater than 0; up to 8 selectors can be added. The log
selector determines which subsystem messages are included in the log.
negate
Excludes messages defined in the Remote Server Selector fields from the log. Selecting this option
acts as a logical NOT for the selector definition.
For example: Selecting same, debug, and mail in the Comparison, Level, and Facility-list fields
includes debug messages from the mail subsystem in the log. Selecting Negateexcludes debug
messages from the mail subsystem from the log.
comparison
Synopsis: string - one of the following keywords { same, same_or_higher }
Default: same_or_higher
The message severity levels to include in the log:
• same: includes only messages of the severity level selected in the Level field.
• same_or_higher: includes messages of the severity level selected in the Level field, and all
messages of higher severity.
For example:
• Selecting debug in the Level field and same in the Comparison field includes only debug
messages in the log.
• Selecting debug in the Level field and same_or_higher in the Comparison field includes debug
and all higher severity messages in the log.
level
Synopsis: string - one of the following keywords { all, none, debug, info, notice, warning, err, crit,
alert, emerg }
Default: all
The base message severity level to include in the log. all includes all messages. none excludes all
messages. Other levels are listed in order of increasing severity.
ROX™ v2.2 User Guide99RuggedBackbone™ RX1500
Page 100
8. Logging
facility-list
Synopsis: string - one of the following keywords { all, local7, local6, local5, local4, local3, local2,
Synopsis: "facility-list" occurs in an array of at most 8 elements.
The subsystems generating log messages. Messages from the selected subusystems are included
in the log. At least one subsystem must be selected; up to 8 subsystems can be selected.
8.3. Deleting Logs
For information on how to delete log files, see Section 2.10, “Deleting Log Files”.
ROX™ v2.2 User Guide100RuggedBackbone™ RX1500
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.