All rights reserved. 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 Siemens Canada Ltd..
Disclaimer Of Liability
Siemens has verified the contents of this document against the hardware and/or software described. However, deviations between the
product and the documentation may exist.
Siemens 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
RUGGEDCOM™ and ROS™ are trademarks of Siemens Canada Ltd..
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
The registered trademark Linux® is used pursuant to a sublicense from LMI, the exclusive licensee of Linus Torvalds, owner of the mark on a
world-wide basis.
Other designations in this manual might be trademarks whose use by third parties for their own purposes would infringe the rights of the
owner.
Open Source
RUGGEDCOM ROX II is based on Linux®. Linux® is made available under the terms of the GNU General Public License Version 2.0 [http://
www.gnu.org/licenses/gpl-2.0.html].
RUGGEDCOM ROX II contains additional Open Source Software. For license conditions, refer to the associated License Conditions
document.
Security Information
Siemens provides products and solutions with industrial security functions that support the secure operation of plants, machines, equipment
and/or networks. They are important components in a holistic industrial security concept. With this in mind, Siemens' products and solutions
undergo continuous development. Siemens recommends strongly that you regularly check for product updates.
For the secure operation of Siemens products and solutions, it is necessary to take suitable preventive action (e.g. cell protection concept)
and integrate each component into a holistic, state-of-the-art industrial security concept. Third-party products that may be in use should also
be considered. For more information about industrial security, visit http://www.siemens.com/industrialsecurity.
To stay informed about product updates as they occur, sign up for a product-specific newsletter. For more information, visit http://
support.automation.siemens.com.
Warranty
Refer to the License Agreement for the applicable warranty terms and conditions, if any.
For warranty details, visit www.siemens.com/ruggedcom or contact a Siemens customer service representative.
Training ........................................................................................................................................ xxxvii
Customer Support ......................................................................................................................... xxxvii
This guide describes the CLI user interface for RUGGEDCOM ROX II v2.9 running on the RUGGEDCOM
RX1500/RX1501/RX1510/RX1511/RX1512. It contains instructions and guidelines on how to use the software, as
well as some general theory.
It is intended for use by network technical support personnel who are familiar with the operation of networks. It is
also recommended for use by network and system planners, system programmers, and line technicians.
Conventions
This CLI User Guide uses the following conventions to present information clearly and effectively.
Alerts
Preface
The following types of alerts are used when necessary to highlight important information.
DANGER!
DANGER alerts describe imminently hazardous situations that, if not avoided, will result in death or
serious injury.
WARNING!
WARNING alerts describe hazardous situations that, if not avoided, may result in serious injury and/or
equipment damage.
CAUTION!
CAUTION alerts describe hazardous situations that, if not avoided, may result in equipment damage.
IMPORTANT!
IMPORTANT alerts provide important information that should be known before performing a procedure
or step, or using a feature.
NOTE
NOTE alerts provide additional information, such as facts, tips and details.
CLI Command Syntax
The syntax of commands used in a Command Line Interface (CLI) is described according to the following
conventions:
Conventionsxxxv
Page 36
Preface
ExampleDescription
RUGGEDCOM ROX II
CLI User Guide
command
command parameter
command parameter1 parameter2
command parameter1 parameter2
command [ parameter1 | parameter2 ]
command { parameter3 | parameter4 }
command parameter1 parameter2 { parameter3 |
parameter4 }
Related Documents
Other documents that may be of interest include:
• RUGGEDCOM RX1500 Installation Guide
• RUGGEDCOM RX1500 Data Sheet
Commands are in bold.
Parameters are in plain text.
Parameters are listed in the order they must be entered.
Parameters in italics must be replaced with a user-defined value.
Alternative parameters are separated by a vertical bar (|).
Square brackets indicate a required choice between two or more
parameters.
Curly brackets indicate an optional parameter(s).
All commands and parameters are presented in the order they must
be entered.
System Requirements
Each workstation used to connect to the RUGGEDCOM ROX II Rugged CLI interface must meet the following
system requirements:
• Must have a working Ethernet interface compatible with at least one of the port types on the RUGGEDCOM
RX1500
• The ability to configure an IP address and netmask on the computer’s Ethernet interface
• A suitable Ethernet cable
• An SSH client application installed on a computer
Accessing Documentation
The latest user documentation for RUGGEDCOM ROX II v2.9 is available online at
www.siemens.com/ruggedcom. To request or inquire about a user document, contact Siemens Customer
Support.
xxxviRelated Documents
Page 37
RUGGEDCOM ROX II
CLI User Guide
License Conditions
RUGGEDCOM ROX II contains open source software. Read the license conditions for open source software
carefully before using this product.
License conditions are detailed in a separate document accessible via RUGGEDCOM ROX II. To access the
license conditions, log in to the RUGGEDCOM ROX II CLI and type the following command:
file show-license LicenseSummary.txt
Training
Siemens offers a wide range of educational services ranging from in-house training of standard courses on
networking, Ethernet switches and routers, to on-site customized courses tailored to the customer's needs,
experience and application.
Siemens' Educational Services team thrives on providing our customers with the essential practical skills to make
sure users have the right knowledge and expertise to understand the various technologies associated with critical
communications network infrastructure technologies.
Siemens' unique mix of IT/Telecommunications expertise combined with domain knowledge in the utility,
transportation and industrial markets, allows Siemens to provide training specific to the customer's application.
For more information about training services and course availability, visit www.siemens.com/ruggedcom or
contact a Siemens sales representative.
Preface
Customer Support
Customer support is available 24 hours, 7 days a week for all Siemens customers. For technical support or
general information, contact Siemens Customer Support through any of the following methods:
Online
Visit http://www.siemens.com/automation/support-request to submit a Support Request (SR) or check
on the status of an existing SR.
Telephone
Call a local hotline center to submit a Support Request (SR). To locate a local hotline center, visit
Install the Industry Online Support app by Siemens AG on any Android, Apple iOS or Windows mobile
device and be able to:
• Access Siemens' extensive library of support documentation, including FAQs and manuals
• Submit SRs or check on the status of an existing SR
• Contact a local Siemens representative from Sales, Technical Support, Training, etc.
• Ask questions or share knowledge with fellow Siemens customers and the support community
License Conditionsxxxvii
Page 38
RUGGEDCOM ROX II
CLI User Guide
Preface
Customer Supportxxxviii
Page 39
RUGGEDCOM ROX II
CLI User Guide
Introduction
Welcome to the RUGGEDCOM ROX II (Rugged Operating System on Linux®) v2.9 CLI User Guide for the
RUGGEDCOM RX1500/RX1501/RX1510/RX1511/RX1512. This document details how to configure the RX1500
via the RUGGEDCOM ROX II Command Line Interface (CLI). RUGGEDCOM ROX II also features a Web
interface, which is described in a separate CLI User Guide.
IMPORTANT!
This CLI User Guide describes all features of RUGGEDCOM ROX II, but some features can only
be configured through the Web interface. This is indicated throughout the CLI User Guide where
applicable.
The following sections provide more detail about RUGGEDCOM ROX II:
• Section 1.1, “Features and Benefits”
• Section 1.2, “Feature Keys”
• Section 1.3, “Security Recommendations”
Chapter 1
Introduction
• Section 1.4, “Available Services by Port”
• Section 1.5, “User Permissions”
Section 1.1
Features and Benefits
Feature support in RUGGEDCOM ROX II is driven by feature keys that unlock feature levels. For more
information about feature keys, refer to Section 1.2, “Feature Keys”.
The following describes the many features available in RUGGEDCOM ROX II and their benefits:
• Cyber Security
Cyber security is an urgent issue in many industries where advanced automation and communications
networks play a crucial role in mission critical applications and where high reliability is of paramount
importance. Key RUGGEDCOM ROX II features that address security issues at the local area network level
include:
PasswordsMulti-level user passwords secures against unauthorized configuration
SSH/SSLExtends capability of password protection to add encryption of passwords and data as
Enable/Disable PortsCapability to disable ports so that traffic cannot pass
802.1Q VLANProvides the ability to logically segregate traffic between predefined ports on switches
they cross the network
SNMPv3Encrypted authentication and access security
HTTPSFor secure access to the Web interface
FirewallIntegrated stateful firewall provides protected network zones
VPN/IPSECAllows creation of secure encrypted and authenticated tunnels
Features and Benefits1
Page 40
Chapter 1
Introduction
• Enhanced Rapid Spanning Tree Protocol (eRSTP)™
Siemens's eRSTP allows the creation of fault-tolerant ring and mesh Ethernet networks that incorporate
redundant links that are pruned to prevent loops. eRSTP implements both STP and RSTP to promote
interoperability with commercial switches, unlike other proprietary ring solutions. The fast root failover feature of
eRSTP provides quick network convergence in case of an RSTP root bridge failure in a mesh topology.
• Quality of Service (IEEE 802.1p)
Some networking applications such as real-time control or VoIP (Voice over IP) require predictable arrival
times for Ethernet frames. Switches can introduce latency in times of heavy network traffic due to the internal
queues that buffer frames and then transmit on a first come first serve basis. RUGGEDCOM ROX II supports
Class of Service, which allows time critical traffic to jump to the front of the queue, thus minimizing latency and
reducing jitter to allow such demanding applications to operate correctly. RUGGEDCOM ROX II allows priority
classification by port, tags, MAC address, and IP Type of Service (ToS). A configurable weighted fair queuing
algorithm controls how frames are emptied from the queues.
• VLAN (IEEE 802.1Q)
Virtual Local Area Networks (VLAN) allow the segregation of a physical network into separate logical networks
with independent broadcast domains. A measure of security is provided since hosts can only access other
hosts on the same VLAN and traffic storms are isolated. RUGGEDCOM ROX II supports 802.1Q tagged
Ethernet frames and VLAN trunks. Port based classification allows legacy devices to be assigned to the correct
VLAN. GVRP support is also provided to simplify the configuration of the switches on the VLAN.
• Simple Network Management Protocol (SNMP)
SNMP provides a standardized method, for network management stations, to interrogate devices from different
vendors. SNMP versions supported by RUGGEDCOM ROX II are v1, v2c and v3. SNMPv3 in particular
provides security features (such as authentication, privacy, and access control) not present in earlier SNMP
versions. RUGGEDCOM ROX II also supports numerous standard MIBs (Management Information Base)
allowing for easy integration with any Network Management System (NMS). A feature of SNMP supported by
RUGGEDCOM ROX II is the ability to generate traps upon system events. RUGGEDCOM NMS, the Siemens
management solution, can record traps from multiple devices providing a powerful network troubleshooting
tool. It also provides a graphical visualization of the network and is fully integrated with all Siemens products.
• Remote Monitoring and Configuration with RUGGEDCOM NMS
RUGGEDCOM NMS (RNMS) is Siemens's Network Management System software for the discovery,
monitoring and management of RUGGEDCOM products and other IP enabled devices on a network. This
highly configurable, full-featured product records and reports on the availability and performance of network
components and services. Device, network and service failures are quickly detected and reported to reduce
downtime.
RNMS is especially suited for remotely monitoring and configuring RUGGEDCOM routers, switches,
serial servers and WiMAX wireless network equipment. For more information, contact a Siemens Sales
representative.
• NETCONF Configuration Interface
The NETCONF configuration interface allows administrators to set device parameters and receive device
updates through the use of XML-based commands. This standard, supported by multiple vendors, makes it
possible to greatly simplify the task of network management.
For more information about how to use NETCONF to configure RUGGEDCOM ROX II,
refer to the RUGGEDCOM RUGGEDCOM ROX II NETCONF Reference Guide available on
www.siemens.com/ruggedcom.
• NTP (Network Time Protocol)
NTP automatically synchronizes the internal clock of all RUGGEDCOM ROX II devices on the network. This
allows for correlation of time stamped events for troubleshooting.
RUGGEDCOM ROX II
CLI User Guide
2Features and Benefits
Page 41
RUGGEDCOM ROX II
CLI User Guide
• Port Rate Limiting
RUGGEDCOM ROX II supports configurable rate limiting per port to limit unicast and multicast traffic. This can
be essential to managing precious network bandwidth for service providers. It also provides edge security for
Denial of Service (DoS) attacks.
• Broadcast Storm Filtering
Broadcast storms wreak havoc on a network and can cause attached devices to malfunction. This could be
disastrous on a network with mission critical equipment. RUGGEDCOM ROX II limits this by filtering broadcast
frames with a user-defined threshold.
• Port Mirroring
RUGGEDCOM ROX II can be configured to duplicate all traffic on one port to a designated mirror port. When
combined with a network analyzer, this can be a powerful troubleshooting tool.
• Port Configuration and Status
RUGGEDCOM ROX II allows individual ports to be hard configured for speed, duplex, auto-negotiation, flow
control and more. This allows proper connection with devices that do not negotiate or have unusual settings.
Detailed status of ports with alarm and SNMP trap on link problems aid greatly in system troubleshooting.
• Port Statistics and RMON (Remote Monitoring)
RUGGEDCOM ROX II provides continuously updating statistics per port that provide both ingress and egress
packet and byte counters, as well as detailed error figures.
Also provided is full support for RMON statistics. RMON allows for very sophisticated data collection, analysis
and detection of traffic patterns.
• Event Logging and Alarms
RUGGEDCOM ROX II records all significant events to a non-volatile system log allowing forensic
troubleshooting. Events include link failure and recovery, unauthorized access, broadcast storm detection,
and self-test diagnostics among others. Alarms provide a snapshot of recent events that have yet to be
acknowledged by the network administrator. An external hardware relay is de-energized during the presence of
critical alarms, allowing an external controller to react if desired.
• HTML Web Browser User Interface
RUGGEDCOM ROX II provides a simple, intuitive user interface for configuration and monitoring via a
standard graphical Web browser or via a standard telecom user interface. All system parameters include
detailed online help to make setup a breeze. RUGGEDCOM ROX II presents a common look and feel and
standardized configuration process, allowing easy migration to other RUGGEDCOM managed products.
• Command Line Interface (CLI)
A command line interface used in conjunction with remote shell to automate data retrieval, configuration
updates, and firmware upgrades. A powerful Telecom Standard style Command Line Interface (CLI) allows
expert users the ability to selectively retrieve or manipulate any parameters the device has to offer.
• Link Backup
Link backup provides an easily configured means of raising a backup link upon the failure of a designated
main link. The main and backup links can be Ethernet, Cellular, T1/E1, DDS or T3. The feature can back up to
multiple remote locations, managing multiple main: backup link relationships. The feature can also back up a
permanent high speed WAN link to a permanent low speed WAN link and can be used to migrate the default
route from the main to the backup link.
• OSPF (Open Shortest Path First)
OSPF is a routing protocol that determines the best path for routing IP traffic over a TCP/IP network based on
link states between nodes and several quality parameters. OSPF is an Interior Gateway Protocol (IGP), which
is designed to work within an autonomous system. It is also a link state protocol, meaning the best route is
determined by the type and speed of the inter-router links, not by how many router hops they are away from
each other (as in distance-vector routing protocols such as RIP).
Chapter 1
Introduction
Features and Benefits3
Page 42
Chapter 1
Introduction
• BGP (Border Gateway Protocol)
BGPv4 is a path-vector routing protocol where routing decisions are made based on the policies or rules laid
out by the network administrator. It is typically used where networks are multi-homed between multiple Internet
Service Providers, or in very large internal networks where internal gateway protocols do not scale sufficiently.
• RIP (Routing Information Protocol)
RIP version 1 and version 2 are distance-vector routing protocols that limit the number of router hops to 15
when determining the best routing path. This protocol is typically used on small, self-contained networks, as
any router beyond 15 hops is considered unreachable.
• IS-IS (Intermediate System - Intermediate System)
IS-IS is one of a suite of routing protocols tasked with sharing routing information between routers. The job of
the router is to enable the efficient movement of data over sometimes complex networks. Routing protocols are
designed to share routing information across these networks and use sophisticated algorithms to decide the
shortest route for the information to travel from point A to point B. One of the first link-state routing protocols
was IS-IS developed in 1985 and adopted by the ISO in 1998 (ISO/IEC 10589:2002). It was later republished
as an IETF standard (RFC 1142 [http://tools.ietf.org/html/rfc1142]).
• Brute Force Attack Prevention
Protection against Brute Force Attacks (BFAs) is standard in RUGGEDCOM ROX II. If an external host fails
to log in to the CLI, NETCONF or Web interfaces after a fixed number of attempts, the host's IP address will
be blocked for a period of time. That period of time will increase if the host continues to fail on subsequent
attempts.
• USB Mass Storage
Use a removable USB Mass Storage drive to manage important files and configure RUGGEDCOM ROX II.
▪ Upgrade/Downgrade Firmware – Use the USB Mass Storage drive as a portable repository for new or legacy
versions of the RUGGEDCOM ROX II firmware.
▪ Backup Files – Configure RUGGEDCOM ROX II to backup important information to the USB Mass Storage
drive, such as rollbacks, log files, feature keys and configuration files.
▪ Share Files – Quickly configure or upgrade other RUGGEDCOM RX1500 devices by copying files using the
same microSD/microSDHC Flash drive.
RUGGEDCOM ROX II
CLI User Guide
IMPORTANT!
Do not remove the USB Mass Storage drive during a file transfer.
NOTE
Only one partition is supported on the USB Mass Storage drive.
NOTE
Only USB Mass Storage drives with one partition are supported.
• Hot Swapping Modules
Power Modules (PM) and Line Modules (LM) can be safely replaced with modules of exactly the same type
while the device is running, with minimal disruption to the network. The device only needs to be restarted after
swapping a module with a different type, such as an Ethernet module with a serial module.
Following a hot swap, the new module will be automatically configured to operate in the same operational state
as the previous module.
4Features and Benefits
Page 43
RUGGEDCOM ROX II
CLI User Guide
NOTE
A reboot is required if a module is installed in a slot that was empty when the device was started.
Section 1.2
Feature Keys
Feature keys add features to an existing installation of RUGGEDCOM ROX II. They can be purchased and
installed at any time.
Three feature keys are currently available: L2STD, L3STD and L3SEC. By default, each new RX1500/RX1501/
RX1510/RX1511/RX1512 is ordered with a base feature key, which is permanently installed on the device.
Additional feature keys can be installed on the compact flash card or placed on a USB Mass Storage device,
which allows them to be moved to other devices when needed.
NOTE
Each feature key is signed with the serial number of the device it is intended to be used in. Feature
keys can be used in other RUGGEDCOM ROX II devices, but a low-level alarm will be generated
indicating a hardware mismatch.
Chapter 1
Introduction
Feature keys include the following features:
Feature
VLANs (802.1Q)
QoS (802.1p)
MSTP (802.1Q-2005)
RSTP
eRSTP™
SNTP
L2TPv2 and L2TPv3
Port Rate Limiting
Broadcast Storm Filtering
Port Mirroring
SNMP v1/v2/v3
RMON
CLI
a
Feature Key
Layer 2 Standard
Edition (L2STD)
üüü
üüü
üüü
üüü
üüü
üüü
üüü
üüü
üüü
üüü
üüü
üüü
üüü
Layer 3 Standard
Edition (L3STD)
Layer 3 Security
Edition (L3SEC)
HTML User Interface
MPLS
DHCP
üüü
ûüü
ûüü
Feature Keys5
Page 44
Chapter 1
Introduction
Feature
Layer 2 Standard
Edition (L2STD)
Feature Key
Layer 3 Standard
Edition (L3STD)
RUGGEDCOM ROX II
CLI User Guide
Layer 3 Security
Edition (L3SEC)
VRRPv2 and VRRPv3
PIM-SM
Firewall
OSPF
BGP
RIP v1/v2
IS-IS
Traffic Prioritization
VPN
IPSec
Virtualization
a
Formerly 802.1s
ûüü
ûüü
ûüü
ûüü
ûüü
ûüü
ûüü
ûüü
ûûü
ûûü
üüü
For information about installing and viewing the contents of feature keys, refer to Section 3.13, “Managing
Feature Keys”.
Section 1.3
Security Recommendations
To prevent unauthorized access to the device, note the following security recommendations:
Authentication
CAUTION!
Accessibility hazard – risk of data loss. Do not misplace the passwords for the device. If both the
maintenance and boot passwords are misplaced, the device must be returned to Siemens Canada Ltd.
for repair. This service is not covered under warranty. Depending on the action that must be taken to
regain access to the device, data may be lost.
• Replace the default passwords for all user accounts, access modes (e.g. maintenance mode) and processes
(where applicable) before the device is deployed.
• Use strong passwords. Avoid weak passwords such as password1, 123456789, abcdefgh, etc. For more
information about creating strong passwords, refer to the password requirements in Section 4.10, “Managing
Passwords and Passphrases”.
• Make sure passwords are protected and not shared with unauthorized personnel.
• Do not re-use passwords across different user names and systems, or after they expire.
• Record passwords in a safe, secure, off-line location for future retrieval should they be misplaced.
• When RADIUS authentication is done remotely, make sure all communications are within the security perimeter
or on a secure channel.
6Security Recommendations
Page 45
RUGGEDCOM ROX II
CLI User Guide
• PAP (Password Authentication Protocol) is not considered a secure protocol and should only be enabled when
required. Consider using CHAP (Challenge-Handshake Authentication Protocol) whenever possible.
Physical/Remote Access
• It is highly recommended to enable Brute Force Attack (BFA) protection to prevent a third-party from obtaining
unauthorized access to the device. For more information, refer to Section 5.6, “Enabling/Disabling Brute Force
Attack Protection”.
• SSH and SSL keys are accessible to users who connect to the device via the serial console. Make sure to take
appropriate precautions when shipping the device beyond the boundaries of the trusted environment:
▪ Replace the SSH and SSL keys with throwaway keys prior to shipping.
▪ Take the existing SSH and SSL keys out of service. When the device returns, create and program new keys
for the device.
• The default and auto-generated SSL certificates are self-signed. It is recommended to use an SSL certificate
that is either signed by a trusted third-party Certificate Authority (CA) or by an organization's own CA. For more
information, refer to Generating SSH Keys and SSL Certificates for ROS and ROX Using Windows [http://
w3.siemens.com/mcms/industrial-communication/Documents/AN22_Application-Note_EN.pdf].
• Restrict physical access to the device to only trusted personnel. A person with malicious intent in possession
of the flash card could extract critical information, such as certificates, keys, etc. (user passwords are protected
by hash codes), or reprogram the card.
Chapter 1
Introduction
• Passwords/passphrases for service mode and maintenance mode should only be given to a limited number of
trusted users. These modes provide access to private keys and certificates.
• Control access to the serial console to the same degree as any physical access to the device. Access to
the serial console allows for potential access to BIST mode, which includes tools that may be used to gain
complete access to the device.
• When using SNMP (Simple Network Management Protocol):
▪ Limit the number of IP addresses that can connect to the device and change the community names. Also
configure SNMP to raise a trap upon authentication failures. For more information, refer to Section 5.11,
“Managing SNMP”.
▪ Make sure the default community strings are changed to unique values.
• When using RUGGEDCOM ROX II as a client to securely connect to a server (such as, in the case of a
secure upgrade or a secure syslog transfer), make sure the server side is configured with strong ciphers and
protocols.
• Limit the number of simultaneous Web Server, CLI, SFTP and NETCONF sessions allowed.
• If a firewall is required, configure and start the firewall before connecting the device to a public network. Make
sure the firewall is configured to accept connections from a specific domain. For more information, refer to
Section 5.17, “Managing Firewalls”.
• Modbus is deactivated by default in RUGGEDCOM ROX II. If Modbus is required, make sure to follow the
security recommendations outlined in this CLI User Guide and configure the environment according to defensein-depth best practices.
• Configure secure remote system logging to forward all logs to a central location. For more information, refer to
Section 3.9, “Managing Logs”.
• Configuration files are provided in either NETCONF or CLI format for ease of use. Make sure configuration files
are properly protected when they exist outside of the device. For instance, encrypt the files, store them in a
secure place, and do not transfer them via insecure communication channels.
• It is highly recommended that critical applications be limited to private networks, or at least be accessible only
through secure services, such as IPsec. Connecting a RUGGEDCOM ROX II device to the Internet is possible.
Security Recommendations7
Page 46
Chapter 1
Introduction
RUGGEDCOM ROX II
CLI User Guide
However, the utmost care should be taken to protect the device and the network behind it using secure means
such as firewall and IPsec. For more information about configuring firewalls and IPsec, refer to Section 5.17,
“Managing Firewalls” and Section 5.29, “Managing IPsec Tunnels”.
• Management of the certificates and keys is the responsibility of the device owner. Consider using RSA key
sizes of 2048 bits in length for increased cryptographic strength. Before returning the device to Siemens
Canada Ltd. for repair, replace the current certificates and keys with temporary throwaway certificates and keys
that can be destroyed upon the device's return.
• Be aware of any non-secure protocols enabled on the device. While some protocols, such as HTTPS, SSH
and 802.1x, are secure, others, such as Telnet and RSTP, were not designed for this purpose. Appropriate
safeguards against non-secure protocols should be taken to prevent unauthorized access to the device/
network.
• Prevent access to external, untrusted Web pages while accessing the device via a Web browser. This can
assist in preventing potential security threats, such as session hijacking.
• Make sure the device is fully decommissioned before taking the device out of service. For more information,
refer to Section 3.7, “Decommissioning the Device”.
• Configure port security features on access ports to prevent a third-party from launching various attacks that can
harm the network or device. For more information, refer to Section 3.17.3, “Configuring Port Security”.
Hardware/Software
CAUTION!
Configuration hazard – risk of data corruption. Maintenance mode is provided for troubleshooting
purposes and should only be used by Siemens Canada Ltd. technicians. As such, this mode is not fully
documented. Misuse of this maintenance mode commands can corrupt the operational state of the
device and render it inaccessible.
• Make sure the latest firmware version is installed, including all security-related patches. For the latest
information on security patches for Siemens products, visit the Industrial Security website [http://
www.industry.siemens.com/topics/global/en/industrial-security/news-alerts/Pages/alerts.aspx] or the
cert/cert-security-advisories.htm]. Updates to Siemens Product Security Advisories can be obtained by
subscribing to the RSS feed on the Siemens ProductCERT Security Advisories website, or by following
@ProductCert on Twitter.
• Only enable the services that will be used on the device, including physical ports. Unused physical ports could
potentially be used to gain access to the network behind the device.
• Use the latest Web browser version compatible with RUGGEDCOM ROX II to make sure the most secure
Transport Layer Security (TLS) versions and ciphers available are employed. Additionally, 1/n-1 record splitting
is enabled in the latest Web browser versions of Mozilla Firefox, Google Chrome and Internet Explorer, and
mitigates against attacks such as SSL/TLS Protocol Initialization Vector Implementation Information Disclosure
Vulnerability (e.g. BEAST).
• For optimal security, use SNMPv3 whenever possible. Use strong passwords with this feature. For more
information about creating strong passwords, refer to the password requirements in Section 4.10, “Managing
Passwords and Passphrases”.
Policy
• Periodically audit the device to make sure it complies with these recommendations and/or any internal security
policies.
• Review the user documentation for other Siemens products used in coordination with the device for further
security recommendations.
8Security Recommendations
Page 47
RUGGEDCOM ROX II
CLI User Guide
Section 1.4
Available Services by Port
The following table lists the services available by the device, including the following information:
• Services
The service supported by the device
• Port Number
The port number associated with the service
• Port Open
The port state, whether it is always open and cannot be closed, or open only, but can be configured
• Port Default
The default state of the port (i.e. open or closed)
• Access Authorized
Denotes whether the ports/services are authenticated during access
Chapter 1
Introduction
ServicesPort NumberPort Open
SSHTCP/22Open (if configured with login)OpenYes
SSH (Service Mode)TCP/222Open (if configured with login)ClosedYes
NETCONFTCP/830Open (if configured with login)OpenYes
SFTPTCP/2222Open (if configured with login)ClosedYes
HTTPTCP/80Open (if configured with login)OpenN/A
NTPUDP/123Open (if configured)ClosedNo
SNMPUDP/161Open (if configured with login)ClosedYes
HTTPSTCP/443Open (if configured with login)OpenYes
/admin/alarms (status)RRNoAdministrator and operator can see status
/admin/alarms-config/R/UR/UNoAdministrator and operator cannot create
/admin/usersC/R/UNoNo
/admin/users/useridR/UR/UNoOperator can only change own password
/admin/cliR/UR/UNo
/admin/snmpC/R/UNoNo
AdministratorOperatorGuest
R/URNo
Access
Notes
of active-alarms, acknowledge and clear
alarms
or delete alarm-lists
and cannot create users.
/admin/netconfR/UNoNo
/admin/dnsC/R/UNoNo
/admin/webuiR/UR/UNo
/admin/schedulerC/R/UNoNo
/admin/contactR/UR/UNo
/admin/hostnameR/UR/UNo
/admin/locationR/UR/UNo
/admin/session-limitsR/UR/UNo
/admin/session-securityR/UR/UNo
10User Permissions
Page 49
RUGGEDCOM ROX II
CLI User Guide
Chapter 1
Introduction
Commands/Paths Permitted
Access
AdministratorOperatorGuest
/admin/sftpR/UR/UNo
/admin/time (status)RRNo
/admin/switch-config (status)R/URNo
/admin/systemR/UR/UNo
/admin/sytem-nameR/UR/UNo
/admin/timezoneR/UC/R/UNo
/admin/clear-all-alarms (action)EC/R/UNo
/admin/backup-files (action)E/R/UNoNo
/admin/delete-all-ssh-known-hosts (action)EENo
/admin/delete-logs (action)ENoNo
/admin/delete-ssh-known-host (action)EENo
/admin/full-configuration-load (action)E/UNoNo
/admin/full-configuration-save (action)E/UNoNo
/admin/install-files (action)E/UNoNo
/admin/reboot (action)EENo
Notes
/admin/restore-factory-defaults (action)E/UNoNo
/admin/set-system-clock (action)E/UENo
/admin/shutdown (action)EENo
/appsC/R/UC/R/UR
/chassis/part-listR/URR
/chassis/fixed-modulesC/R/UR/UR
/chassis/line-module-listR/URR
/chassis/line-modules/line-moduleR/UR/UR
/interfacesRC/R/UR
/interfaceC/R/UR/UR
/routingC/R/UC/R/UR
/routing/dynamic/ospf/interfaceC/R/UR/UR
/routing/dynamic/rip/interfaceC/R/UR/UR
/routing/multicast/dynamic/pim-sm/
C/R/UR/UR
interface
/routing/dynamic/isis/interfaceC/R/UR/UR
/security/firewallC/R/UC/R/UR
/security/cryptoC/R/URR
/security/crypto/private-keyC/R/UNoNo
User Permissions11
Page 50
Chapter 1
Introduction
RUGGEDCOM ROX II
CLI User Guide
Commands/Paths Permitted
Access
AdministratorOperatorGuest
/servicesC/R/UC/R/UR
/services/time/ntp/key/C/R/UNoNo
/tunnelC/R/UC/R/UR
/tunnel/ipsecC/R/UNoNo
/ipC/R/UC/R/UR
/mplsC/R/UC/R/UR
/mpls/interface-mplsR/UR/UR
/mpls/ldp/interface-ldpR/UR/UR
/switchC/R/UC/R/UR
/switch/vlans/all-vlansC/R/UC/R/UR
/switch/port-securityR/UNoNo
/qosC/R/UC/R/UR
/globalC/R/UNoNo
hintsEEE
monitorEENo
Notes
mpls-pingEENo
mpls-tracerouteEENo
pingEENo
ping6EENo
reportstatsEENo
sshENoNo
tcpdumpEENo
telnetEENo
tracerouteEENo
traceroute6EENo
traceserialEENo
wizardENoNo
Section 1.6
Removable Memory
The RUGGEDCOM RX1500 features a user-accessible memory slot that supports a USB Mass Storage device.
The drive can be used to manage configuration, firmware and other files on the device or a fleet of devices.
12Removable Memory
Page 51
RUGGEDCOM ROX II
CLI User Guide
• Upgrade/Downgrade Firmware – Use the USB Mass Storage device as a portable repository for new or legacy
versions of the RUGGEDCOM ROX II firmware.
• Backup Files – Configure RUGGEDCOM ROX II to backup important information to the USB Mass Storage
device, such as rollbacks, log files, feature keys and configuration files.
• Share Files – Quickly configure or upgrade other RUGGEDCOM RX1500/RX1501/RX1510/RX1511/RX1512
devices by copying files using the same USB Mass Storage device.
IMPORTANT!
Do not remove the USB Mass Storage device during a file transfer.
NOTE
Only one partition is supported on the USB Mass Storage device.
For information about how to insert or remove the USB Mass Storage device, refer to the Installation Guide for
the RUGGEDCOM RX1500/RX1501/RX1510/RX1511/RX1512.
Chapter 1
Introduction
Removable Memory13
Page 52
RUGGEDCOM ROX II
CLI User Guide
Chapter 1
Introduction
Removable Memory14
Page 53
RUGGEDCOM ROX II
CLI User Guide
Using RUGGEDCOM ROX II
Using RUGGEDCOM ROX II
This chapter describes how to use the RUGGEDCOM ROX II interface. It describes the following tasks:
• Section 2.1, “Connecting to RUGGEDCOM ROX II”
• Section 2.2, “Default User Names and Passwords”
• Section 2.3, “Logging In”
• Section 2.4, “Logging Out”
• Section 2.5, “Using Network Utilities”
• Section 2.6, “Using the Command Line Interface”
• Section 2.7, “Configuring the CLI Interface”
• Section 2.8, “Accessing Different Modes”
Chapter 2
Section 2.1
Connecting to RUGGEDCOM ROX II
The following describes the various methods for connecting the device:
• Section 2.1.1, “Connecting Directly”
• Section 2.1.2, “Connecting Through the Network”
Section 2.1.1
Connecting Directly
RUGGEDCOM ROX II can be accessed through a direct serial or Ethernet connection.
Using the RS-232 Serial Console Port
To establish a serial connection to the device, do the following:
1.Connect a serial terminal or a computer running terminal emulation software to the RS-232 console port on
the device.
Connecting to RUGGEDCOM ROX II15
Page 54
Chapter 2
Using RUGGEDCOM ROX II
Figure 1: RS-232 Console Port (RUGGEDCOM RX1500 Model Shown)
2.Configure the terminal as follows:
• 57600 bps
• No parity
• 8 bits
• Set the terminal type to VT100
• Disable hardware and software flow control
3.Establish a connection to the device and press any key. The login prompt appears.
4.Log in to RUGGEDCOM ROX II. For more information about logging in to RUGGEDCOM ROX II, refer to
Section 2.3, “Logging In”.
RUGGEDCOM ROX II
CLI User Guide
Using an Ethernet Port
To establish a direct Ethernet connection to the device, do the following:
1.Connect a serial terminal or a computer running terminal emulation software to either the MGMT
(Management) port or any other RJ-45 Ethernet port on the device.
Figure 2: MGMT Port (RUGGEDCOM RX1500 Model Shown)
16Connecting Directly
Page 55
RUGGEDCOM ROX II
CLI User Guide
Using RUGGEDCOM ROX II
2.Configure the IP address range and subnet for the serial terminal or computer's Ethernet port. The range is
typically the IP address for the device's IP interface plus one, ending at *.*.*.254.
By default, the RUGGEDCOM RX1500 has a different IP address and subnet configured for two types of IP
interfaces, both of which are mapped to one or more physical ports:
PortIP Address/Mask
MGMT192.168.1.2/24
All other Ethernet ports192.168.0.2/24
For example, if the serial terminal or computer is connected to the device's MGMT port, configure the serial
terminal or computer's Ethernet port with an IP address in the range of 192.168.1.3 to 192.168.1.254.
Connect to the device using the IP address 192.168.1.2, the address of the MGMT interface.
3.Launch the SSH client on the computer and connect to admin@{ipaddress}, where {ipaddress} is the IP
address for the MGMT port. The login prompt appears:
Using username "admin".
admin@192.168.0.2's password:
4.Log in to RUGGEDCOM ROX II. For more information about logging in to RUGGEDCOM ROX II, refer to
Section 2.3, “Logging In”.
Chapter 2
Section 2.1.2
Connecting Through the Network
To connect to RUGGEDCOM ROX II through the network, do the following:
1.On the workstation being used to connect to the device, configure the Ethernet port to use an IP address
falling within the subnet of the device.
By default, the RUGGEDCOM RX1500 has a different IP address and subnet configured for two types of IP
interfaces, both of which are mapped to one or more physical ports:
PortIP Address/Mask
MGMT192.168.1.2/24
All other Ethernet ports192.168.0.2/24
For example, if the device is connected via the MGMT port, configure the computer's Ethernet port with
an IP address in the range of 192.168.1.3 to 192.168.1.254. Connect to the device using the IP address
192.168.1.2, the address of the MGMT interface.
2.Launch the SSH client on the computer and connect to admin@{ipaddress}, where {ipaddress} is the IP
address for the port that is connected to the network.
3.Log in to RUGGEDCOM ROX II. For more information, refer to Section 2.3, “Logging In”.
Section 2.2
Default User Names and Passwords
The following default passwords are pre-configured on the device for each access mode:
Connecting Through the Network17
Page 56
Chapter 2
Using RUGGEDCOM ROX II
CAUTION!
Security hazard – risk of unauthorized access and/or exploitation. To prevent unauthorized access to
the device, change the default passwords before commissioning the device. For more information,
refer to Section 4.10, “Managing Passwords and Passphrases”.
ModeUsernamePassword
Servicerootadmin
Maintenancerootadmin
Administratoradminadmin
Operatoroperoper
Guestguestguest
Section 2.3
Logging In
RUGGEDCOM ROX II
CLI User Guide
To log in to RUGGEDCOM ROX II, do the following:
1.Connect to the device. For more information about the various methods of connecting to the device, refer
Section 2.1, “Connecting to RUGGEDCOM ROX II”.
2.Once a connection is established with the device, press Enter. The login prompt appears.
NOTE
RUGGEDCOM ROX II features three default user accounts: admin, operator and guest. Additional
user accounts can be added. For information about adding user accounts, refer to Section 4.9.2,
“Adding a User”.
3.Type the user name and press Enter. The password prompt appears.
NOTE
If a unique password/passphrase has not been configured, use the factory default password. For
more information, refer to Section 2.2, “Default User Names and Passwords”.
IMPORTANT!
RUGGEDCOM ROX II features a Brute Force Attack (BFA) protection system to detect potentially
malicious attempts to access the device. When enabled, the protection system will block an IP
address after 15 failed login attempts over a 10 minute period. The IP address will be blocked
for 720 seconds or 12 minutes the first time. If the same IP address fails again 15 times in a 10
minute period, it will be blocked again, but the waiting period will be 1.5 times longer than the
previous wait period.
Siemens strongly recommends that BFA protection be enabled. For more information about
enabling BFA protection, refer to Section 5.6, “Enabling/Disabling Brute Force Attack Protection”.
BFA protection is enabled by default for new installations of RUGGEDCOM ROX II.
4.Type the password associated with the username and press Enter.
login as: admin
admin@127.0.0.1's password:
Welcome to Rugged CLI
18Logging In
Page 57
RUGGEDCOM ROX II
CLI User Guide
admin connected from 127.0.0.1 using console on ruggedcom
ruggedcom#
Section 2.4
Logging Out
To log out of the device, type exit at the root level.
ruggedcom# exit
Section 2.5
Using Network Utilities
The following sections describe how to use the built-in RUGGEDCOM ROX II network utilities:
• Section 2.5.1, “Pinging a Host”
• Section 2.5.2, “Dumping Raw Data to a Terminal or File”
• Section 2.5.3, “Tracing the Route to a Remote Host”
• Section 2.5.4, “Pinging an IPv4 Address Using MPLS Protocols”
• Section 2.5.5, “Tracing the Route of an IPv4 Address Using MPLS Protocols”
• Section 2.5.6, “Tracing Activities on a Serial Port”
• hex displays the content of serial data in a hex
• protocol traces the serial protocol on the serial port
• tcp-udp traces TCP-UDP events on the serial port
Section 2.6
Using the Command Line Interface
The following sections describe how use the Command Line Interface (CLI):
• Section 2.6.1, “Accessing Different CLI Modes”
• Section 2.6.2, “Using Command Line Completion”
• Section 2.6.3, “Displaying Available Commands”
• Section 2.6.4, “Editing Commands”
• Section 2.6.5, “Using Output Redirects”
• Section 2.6.6, “Using Regular Expressions”
• Section 2.6.7, “Using CLI Utilities”
• Section 2.6.8, “Specifying a Range”
• Section 2.6.9, “Common Commands”
Section 2.6.1
Accessing Different CLI Modes
RUGGEDCOM ROX II provides commands for monitoring and configuring software, hardware and network
connectivity. The Command Line Interface (CLI) supports the following modes:
Tracing the Route of an IPv4 Address Using MPLS
Protocols21
Page 60
Chapter 2
Using RUGGEDCOM ROX II
ModeDescription
RUGGEDCOM ROX II
CLI User Guide
Operational ModeOperational mode is the default mode after a user logs in to the device. It allows users to perform general
Configuration ModeConfiguration mode is launched from the Operational Mode. It allows users to change the actual configuration
device management actions and provides troubleshooting and maintenance utilities. It is used for viewing
the system status, controlling the CLI environment, monitoring and troubleshooting network connectivity, and
launching the Configuration mode.
of the device.
All changes to the configuration are made on a copy of the active configuration, called the candidate
configuration. Changes do not take effect until they are committed.
In both modes, the CLI prompt indicates the current mode. In Operational mode, the prompt is:
ruggedcom#
In Configuration mode, the prompt is:
ruggedcom(config)#
As a user navigates through the configuration data hierarchy, the prompt indicates the user's location in the
configuration. For example, after navigating to interface » eth » lm3 » 1, the CLI prompt will be:
ruggedcom(config-eth-lm3/1)#
Section 2.6.2
Using Command Line Completion
Commands and parameters do not need to be entered completely for the CLI to recognize them. By typing the
first few letters of a command and pressing Tab, the CLI will display the possible completions. If the first few
letters are unique to a specific command, the full command is automatically displayed. If the first few letters
match more than one possible command, a lit of possible completions appears.
NOTE
Automatic completion is disabled inside quotation marks. If the name of a command or parameter
contains a space, such as a filename, escape the space with a \ or enclose the string in quotation
marks. For example:
who file foo\ bar
or
who file "foo bar"
NOTE
Auto-completion also applies to filenames and directories, but cannot be initiated using a space. Autocompletion using a space is disabled when typing a filename or directory name.
Section 2.6.3
Displaying Available Commands
To display a list of available commands at any point in the CLI, type ?.
For example, in Operational mode, typing ? at the command prompt displays a list of all Operational mode
commands:
22Using Command Line Completion
Page 61
RUGGEDCOM ROX II
CLI User Guide
ruggedcom# ?
Possible completions:
admin Configures the general device characteristics
autowizard Automatically query for mandatory elements
clear Clear parameter
commit Confirm a pending commit
compare Compare running configuration to another configuration or a file
.
.
.
traceserial Trace serial ports activities
who Display currently logged on users
write Write configuration
ruggedcom#
Using RUGGEDCOM ROX II
Section 2.6.4
Editing Commands
The following commands can be used to edit command lines and move around the command history.
Chapter 2
Moving the Cursor
CommandDescription
Ctrl+b or Left ArrowMoves the cursor back one character
Ctrl+f or Right ArrowMoves the cursor forward one character
Esc+b or Alt+bMoves the cursor back one word
Esc+f or Alt+fMoves the cursor forward one word
Ctrl+a or HomeMoves the cursor to the beginning of the command line
Ctrl+e or EndMoves the cursor to the end of the command line
Deleting Characters
CommandDescription
Ctrl+h, Delete or
Backspace
Ctrl+dDelete the character after the cursor
Ctrl+kDelete all characters from the cursor to the end of the line
Ctrl+u or Ctrl+xDelete the whole line
Delete the character before the cursor
Ctrl+w, Esc+Backspace
or Alt+Backspace
Esc+d or Alt+dDelete the whole after the cursor
Delete the whole before the cursor
Editing Commands23
Page 62
Chapter 2
Using RUGGEDCOM ROX II
Inserting Recently Deleted Text
CommandDescription
Ctrl+yInserts the most recently deleted text at the cursor's location
Displaying Previously Entered Commands
CommandDescription
Ctrl+p or Up ArrowShows the previous command in the command history
Ctrl+n or Down ArrowShows the next command in the command history
Ctrl+rReverses the order of commands in the command history
RUGGEDCOM ROX II
CLI User Guide
show history
shows a list of previous commands
Capitalization
CommandDescription
Esc+cCapitalizes the first letter of the word at the cursor's location and sets all other characters to lowercase
Esc+lChanges the entire word at the cursor's location to lowercase
Esc+uChanges the entire word at the cursor's location to uppercase
Special Actions
CommandDescription
Ctrl+cAborts a command or clears the command line
Ctrl+v or Esc+qTreats the next character(s) as character data, not a command
Ctrl+lRedraws the screen
Ctrl+tTransposes characters
Esc+mEnters multi-line mode
Ctrl+dExits multi-line mode
Ctrl+zExits configuration mode
Inserting Hard Returns
CommandDescription
Esc+MInserts a hard return
24Editing Commands
Page 63
RUGGEDCOM ROX II
CLI User Guide
Using RUGGEDCOM ROX II
Section 2.6.5
Using Output Redirects
Information returned from a CLI term can be processed in various ways using an output redirect term. To specify
an output redirect, type | after the CLI term and then type the redirect term. To display the available redirects,
type | ? after a CLI term. For example:
ruggedcom# show admin | ?
Possible completions:
append Append output text to a file
begin Begin with the line that matches
count Count the number of lines in the output display
exclude Exclude lines that match
include Include lines that match
linnum Enumerate lines in the output
more Paginate output
nomore Suppress pagination
notab Suppress table output
repeat Repeat show term with a given interval
save Save output text to a file
select Select additional columns
tab Enforce table output
until End with the line that matches
Chapter 2
ParameterDescription
appendAppends the output text to a specified ASCII text file.
For example, running these two terms appends the admin and
chassis information to the specified file:
ruggedcom# show admin | append foo.txt
ruggedcom# show interface | append foo.txt
The resulting file contains the results of show interface appended to
the results of show admin (lines truncated with ... are shortened for
illustrative purposes only):
ruggedcom# file show-config foo.txt
admin
time
gmtime "Wed Oct 22 20:05:50 2014"
localtime "Wed Oct 22 16:05:50 2014"
rox-imaging
roxflash-progress
phase Inactive
status message ""
image flashing 0
netconf
statistics
in bad hellos 0
in sessions 0
dropped sessions 0
in rpcs 0
in bad rpcs 0
out rpc errors 0
out notifications 0
alarms
active-alarms chassis 11 1
severity notice
description "Line Module with serial number
L15R-1710-PR002 in slot lm4 is i
nserted or up"
Using Output Redirects25
Page 64
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
beginBegins the output with the line containing the specified text. Regular
expressions can be used with this redirect. For more information
about regular expressions, refer to Section 2.6.6, “Using Regular
Expressions”.
For example, show admin | begin netconf returns all of the
admin information following the netconf line:
ruggedcom# show admin | begin netconf
netconf
statistics
in sessions 0 in xml parse errs 0 in bad
hellos 0 in rpcs 0 in bad rpcs 0 in not...
countDisplays the number of lines returned by the term.
For example, show admin | count shows the number of lines in the
admin information.
ruggedcom# show admin | count
Count: 9 lines
excludeExcludes lines containing the specified text. Information that is a
child of the excluded line is also excluded. Regular expressions
can be used with this redirect. For more information about regular
expressions, refer to Section 2.6.6, “Using Regular Expressions”.
For example, show admin | exclude netconf shows the admin
information, excluding the netconf lines.
ruggedcom# show admin | exclude netconf
admin
time
gmtime "Tue Feb 15 08:25:27 2011\n" localtime
"Tue Feb 15 03:25:27 2011\n"
software-upgrade
upgrade-progress
software partition "Partition #1" current
version "ROX 2.1.0 (2010-12-03 17:38) ...
statistics
in sessions 0 in xml parse errs 0 in bad
hellos 0 in rpcs 0 in bad rpcs 0 in not...
supported rpcs 0 out rpc replies 0 out rpc
errors 0 out notifications 0
includeIncludes lines containing the specified text. Information that is a
child of the included line is usually included, but may not be in some
cases. Regular expressions can be used with this redirect. For more
information about regular expressions, refer to Section 2.6.6, “Using
Regular Expressions”.
For example, show admin | include time shows the time lines from
the admin information.
ruggedcom# show admin | include time
time
gmtime "Tue Feb 15 08:34:55 2011\n" localtime
"Tue Feb 15 03:34:55 2011\n"
ruggedcom#
linnumNumbers the lines in the output. For example:
ruggedcom# show admin | linnum
1: admin
2: time
26Using Output Redirects
Page 65
RUGGEDCOM ROX II
CLI User Guide
ParameterDescription
Using RUGGEDCOM ROX II
Chapter 2
3: gmtime "Tue Feb 15 08:37:42 2011\n"
localtime "Tue Feb 15 03:37:42 2011\n"
4: software-upgrade
.
.
.
morePaginates the output. When the output reaches the screen-length
setting, the CLI prompts you to press a key for more. Press Enter to
advance line-by-line; press space to advance page-by-page.
nomoreSuppresses pagination.
notabSuppresses table output.
For example, show chassis | begin line-modules shows the following
table:
ruggedcom# show chassis | begin line-modules
line-modules
line-module
BYPASS
OVERCURRENT
SLOT DETECTED MODULE STATUS
STATUS
power-controller
PM MOV PM PM PM
SLOT PROTECTION TEMPERATURE CURRENT VOLTAGE
-----------------------------------------------pm1 na 43 2907 3381
For example, show chassis | begin line-modules | notab suppresses
the table formatting:
ruggedcom# show chassis | begin line-modules |
notab
line-modules
line-module lm1
detected module "1000TX w/ 2x RJ45"
line-module lm2
detected module none
line-module lm3
detected module "6x RS232/RS422/RS485 via
RJ45"
line-module lm4
detected module "E1 w/ 2x BNC"
line-module lm5
detected module none
line-module lm6
detected module none
power-controller
PM MOV PM PM PM
SLOT PROTECTION TEMPERATURE CURRENT VOLTAGE
-----------------------------------------------pm1 na 43 2892 3381
repeatRepeats the term at the specified interval. Specify an interval in
seconds. The term repeats until you cancel it with Ctrl-C.
Using Output Redirects27
Page 66
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
For example, show admin | repeat 10s repeats the show admin term
every 10 seconds.
saveSaves the output to the specified ASCII text file.
For example, show chassis | save foo.txt saves the chassis
information to the file foo.txt
RUGGEDCOM ROX II
CLI User Guide
select
tabEnforces table layout for columnar data.
untilIncludes output until a line containing the specified text appears.
This redirect is not yet implemented.
Regular expressions can be used with this redirect. For more
information about regular expressions, refer to Section 2.6.6, “Using
Regular Expressions”.
For example, show chassis | begin cpu | until status returns the
chassis information beginning with cpu and ending with status:
ruggedcom# show chassis | begin cpu | until
status
cpu
slot-cpu main
detected module "RX1501 8 Gigabit Layer 3 w/ 6
LM slots and 1 PM slots"
cpu load 22
ram avail 53
ram avail low 20
status
Section 2.6.6
Using Regular Expressions
RUGGEDCOM ROX II command line regular expressions are a subset of the regular expressions found in egrep
and in the AWK programming language. Regular expressions can be used along with several of the output
redirects. For more information about using output redirects, refer to Section 2.6.5, “Using Output Redirects”.
CharacterDescriptionExample
.Matches any single character (e.g. .100, 100., .100.).100
100.
.100.
*Matches zero (0) or more occurrences of a pattern100*
+Matches 1 or more occurrences of a pattern100+
?Match 0 or 1 occurrences of a pattern100?
^Matches the beginning of the line^100
$Matches the end of the line100$
()Matches only the characters specified(38a)
[]Matches any character other than those specified[^abc]
_ (underscore)The underscore character has special meanings in an autonomous system
path. It matches to:
• Each space ( ) and comma (,)
_100,100_, _100_
28Using Regular Expressions
Page 67
RUGGEDCOM ROX II
CLI User Guide
CharacterDescriptionExample
• Each AS set delimiter (e.g. { and })
• Each AS confederation delimiter (e.g. ( and ))
• The beginning and end of the line
Therefore, the underscore can be used to match AS values.
For example, to show all the IP interfaces that are in the up state:
ruggedcom# show interfaces ip | include up
admin state up
state up
admin state up
state up
admin state up
state up
admin state up
admin state up
admin state up
admin state up
admin state up
Section 2.6.7
Using RUGGEDCOM ROX II
Chapter 2
Using CLI Utilities
The Operational mode provides a set of standard utility applications, similar to those on a typical Linux-based
operating system.
ParameterDescription
ssh [ host | address/name ] { bind-address |
address } { cipher-spec | cipher } { login | name
} { port | number } { sub-system }
telnet { host | address/name }
Further information about these well-known applications is publicly available on the Internet.
Opens a secure shell on another host. Parameters include:
• host is the name or IP address of the host. It is mandatory.
• bind-address is the source address of the connection. Only
useful on systems with more than one address.
• cipher-spec is the cipher specification for encrypting the
session. Supported cipher options include aes128-cbc, 3descbc, blowfish-cbc, cast128-cbc, arcfour128, arcfour256, arcfour,
aes192-cbc, aes256-cbc, aes128-ctr, aes192-ctr and aes256-ctr.
• login is the users login name on the host.
• port is the TCP port number to open an SSH session to.
• sub-system invokes a subsystem on the remote system, such
as NETCONF.
Opens a telnet session to another host. Parameters include:
• host is the name or IP address of the host
Section 2.6.8
Specifying a Range
Some CLI commands accept a range of values, such as LM1-3 or 3-6, to specify multiple targets. In the following
example, a command is applied to port 1 on LM1, LM2 and LM3:
ruggedcom(config)# interface switch lm1-3 1
Using CLI Utilities29
Page 68
Chapter 2
Using RUGGEDCOM ROX II
In this example, a command is issued to ports 1, 2 and 4 on LM1, LM2 and LM4:
ruggedcom(config)# interface switch lm1-2,4 1-2,4
When available, the range parameter can be included before the value range:
ruggedcom(config)# interface switch range lm1-3 1-6
Section 2.6.9
Common Commands
The following sections describe common commands that can be used in the CLI:
• Section 2.6.9.1, “Basic CLI Commands”
• Section 2.6.9.2, “File Commands”
• Section 2.6.9.3, “Interface and Services Commands”
• Section 2.6.9.4, “Administration Commands”
• Section 2.6.9.5, “Configuration Mode General Commands”
RUGGEDCOM ROX II
CLI User Guide
Section 2.6.9.1
Basic CLI Commands
Use the following commands to perform basic CLI functions.
ParameterDescription
exit [ level | configuration-mode | no-confirm ]
help command
id
logout [ logout | sessionid ]
quit
Default: level
Exits from the current mode.
• level exits from the current mode. If performed at the top level,
this command exits from the configuration mode.
• configuration-mode exits from configuration mode regardless
of mode.
• no-confirm exits from configuration mode without prompting the
user to commit any pending changes.
Displays help text for the specified command.
Displays the current user's information. For example:
ruggedcom# id
user = admin(0), gid=0, groups=admin, gids=
Terminates the specified session. A session can by specified based
on its user ID or session ID.
Logs out of and ends the CLI session.
send [ all | admin ] message
Sends a message to all users of the specified type. The message
appears in both the CLI and web interface. For example:
ruggedcom# send all "Rebooting at
midnight!"Message from admin@ruggedcom at
2011-02-15 08:42:49...
Rebooting at midnight!
Shows selected configuration information. Use auto completion to
display the list of options available at each configuration level. For
example:
ruggedcom# show chassis hardware slot-hardware
ORDER
SLOT FIELD DETECTED MODULE
SERIAL NUMBER
------------------------------------------------------------ pm1 48 48VDC (36-59VDC) Power Supply
lm1 XX none none
lm2 M1_ Old V90 Modem
lm3 TX01 2x 10/100Tx RJ45
lm4 TX01 2x 10/100Tx RJ45
lm5 DS3 1x T3/E3
lm6 TC2 2x Chan T1/E1
pm2 XX none none
main CM01 RX1000 Main Board
RX1K-12-11-0015
show [ cli | history | jobs | log | logfile ]
show parser dump command
show running-config option
Shows selected system information.
• cli shows the CLI environment settings. For example:
ruggedcom# show cli
autowizard true
complete-on-space true
display-level 99999999
history 100
ignore-leading-space true
output-file terminal
paginate true
screen-length 65
screen-width 237
service prompt config true
show-defaults false
terminal xterm
• history displays the CLI command history.
• jobs displays currently running background jobs. For example:
ruggedcom# show jobs
JOB COMMAND
2 monitor start /tmp/saved
• log and logfile display the selected log file. Use auto
completion to view a list of available log files.
Displays all possible commands starting with the specified
command.
Displays the current configuration. If an option parameter is not
specified, the entire configuration will be displayed by default . Use
Basic CLI Commands31
Page 70
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
auto completion to see a list of configuration options. Use | and one
or more output redirects to restrict the information to be shown.
Section 2.6.9.2
File Commands
Operational mode provides commands for managing log, configuration and feature key files on the device.
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
compare file
file
Compares the running configuration to a file. A > character indicates
text that is present in the selected file but not in the running
configuration. A < character indicates text that is present in the
running configuration, but not in the selected file. In the following
example, the user information is present in the configuration, but not
in the selected file:
Compares the contents of two files. A < character indicates text
that is present in the first selected file but not in the second file. A >
character indicates text that is present in the second selected file but
not in the first file. In the following example, the user information is
present in the second file, but not in the first:
Copies a configuration file. After typing the command, press Tab to
view a list of available files. For example, the following command
copies the deleted_users file to the archive001 file:
Deletes a configuration file. After typing the command, press Tab
to view a list of available files. For example, the following command
deletes the deleted_users file:
ruggedcom# file delete-config deleted_users
Deletes a feature key file. After typing the command, press Tab to
view a list of available files. For example, the following command
deletes the feature key 1_cmRX1K-12-11-0217.key file:
Securely copies a configuration file from a remote computer to the
device. The remote computer must have an SCP or SSH (secure
shell) service or client installed and running.
To use this command, the user credentials for the remote computer,
the IP address or host name of the remote computer, the directory
path to the configuration file on the remote computer, and the
configuration file filename must all be known.
• user is a user name with access rights to the remote computer.
• host is the host name or IP address of the remote computer.
• path path is the path to the configuration file on the remote
computer.
File Commands33
Page 72
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
• current-filename is the current filename of the configuration
file.
• new-filename is the new filename for the configuration file. To
use the current filename, specify the current filename or exclude
this parameter from the command.
When prompted, type the password to connect to the remote
computer. For example:
Securely copies a configuration file from the device to a remote
computer. The remote computer must have an SCP or SSH (secure
shell) service or client installed and running.
To use this command, the user credentials for the remote computer,
the IP address or host name of the remote computer, the directory
path to the configuration file on the remote computer, and the
configuration file filename must all be known.
• current-filename is the current filename of the configuration
file.
• user is a user name with access rights to the remote computer.
• host is the host name or IP address of the remote computer.
• path path specifies where to save the configuration file on the
remote computer.
• new-filename is the new filename for the configuration file. To
use the current filename, specify the current filename or exclude
this parameter from the command.
When prompted, type the password to connect to the remote
computer. For example:
Securely copies a feature key file from a remote computer to the
device. The remote computer must have an SCP or SSH (secure
shell) service or client installed and running.
To use this command, the user credentials for the remote computer,
the IP address or host name of the remote computer, the directory
path to the feature key file on the remote computer, and the feature
key file filename must all be known.
• user is a user name with access rights to the remote computer.
34File Commands
Page 73
RUGGEDCOM ROX II
CLI User Guide
ParameterDescription
Using RUGGEDCOM ROX II
Chapter 2
• host is the host name or IP address of the remote computer.
• path path is the path to the feature key file on the remote
computer.
• current-filename is the current filename of the feature key
file.
• new-filename is the new filename for the feature key file. To
use the current filename, specify the current filename or exclude
this parameter from the command.
When prompted, type the password to connect to the remote
computer. For example:
Securely copies a feature key file to a remote computer from the
device. The remote computer must have an SCP or SSH (secure
shell) service or client installed and running.
To use this command, the user credentials for the remote computer,
the IP address or host name of the remote computer, the directory
path to the feature key file on the remote computer, and the feature
key file filename must all be known.
• current-filename is the current filename of the feature key
file.
• user is a user name with access rights to the remote computer.
• host is the host name or IP address of the remote computer.
• path path specifies where to save the feature key file on the
remote computer.
• new-filename is the new filename for the feature key file. To
use the current filename, specify the current filename or exclude
this parameter from the command.
When prompted, type the password to connect to the remote
computer. For example:
Securely copies a log file to a remote computer from the device. The
remote computer must have an SCP or SSH (secure shell) service
or client installed and running.
To use this command, the user credentials for the remote computer,
the IP address or host name of the remote computer, the directory
path to the log file on the remote computer, and the log file filename
must all be known.
Where:
• current-filename is the current filename of the log file.
File Commands35
Page 74
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
• user is a user name with access rights to the remote computer.
• host is the host name or IP address of the remote computer.
• path path specifies where to save the log file on the remote
computer.
• new-filename is the new filename for the log file. To use the
current filename, specify the current filename or exclude this
parameter from the command.
When prompted, type the password to connect to the remote
computer. For example:
Operational mode provides commands for restarting and displaying information for various interfaces and
services.
ParameterDescription
interfaces modem modem [ at | reset ]
interfaces serial restart-serserver
36Interface and Services Commands
Sends an AT or reset command to the specified modem. Use auto
completion to display a list of available modems.
• at: Sends an AT command to the selected modem. To send
multiple AT commands, separate each command with a : colon.
• reset: Resets the modem.
Restarts the serial communication service.
Page 75
RUGGEDCOM ROX II
CLI User Guide
ParameterDescription
Using RUGGEDCOM ROX II
Chapter 2
interfaces clearstatistics [ ddsName | t1e1Name |
t3e3Name ] name
services dhcpserver show-active-leases
Clears statistics for the specified WAN interface. Use tab completion
to display a list of available WAN interfaces.
Displays active DHCP leases.
Section 2.6.9.4
Administration Commands
Operational mode provides commands for performing device administration tasks.
ParameterDescription
admin acknowledge-all-alarms
admin clear-all-alarms
admin delete-all-ssh-known-hosts
admin delete-ssh-known-hosts
admin restore-factory-defaults
Acknowledges all system alarms.
Clears all system alarms.
Deletes the list of known hosts.
Deletes the host entry from the list of known hosts.
Restores the factory default configuration and settings, but does not
erase any files you have saved on the device.
admin reboot
admin restore-factory-defaults
admin set-system-clock time YYYY-MM-DDHH:MM:SS
admin shutdown
admin software-upgrade decline-upgrade
admin software-upgrade launch-upgrade
admin software-upgrade rollback-reboot
maint-login
Reboots the device.
Restores the factory default configuration and settings, but does not
erase any files you have saved on the device.
Sets the date and time on the device. To specify just the date, type
the date in the format YYYY-MM-DD. To specify just the time, type
the time in the format HH:MM:SS. To specify both date and time,
enclose the string in quotation marks and type the date and time in
the format "YYYY-MM-DD HH:MM:SS".
NOTE
When setting the time, specifying seconds seconds
(SS) is optional.
Shuts down the device.
For more information on shutting down the device, refer to
Section 3.4, “Shutting Down the Device”
Cancels (or declines) a recent software upgrade that is waiting for a
reboot to the upgraded partition.
Launches an upgrade in the alternate partition.
Boots to a previous software release on the alternate partition.
CAUTION!
Configuration hazard – risk of data loss/corruption.
Maintenance mode is provided for troubleshooting
purposes and should only be used by Siemens Canada
Ltd. technicians. Maintenance mode is provided for
Administration Commands37
Page 76
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
troubleshooting purposes and all possible commands
are not documented. Misuse of maintenance mode
commands can corrupt the operational state of the
device and render the device inaccessible.
Logs in to the underlying operating system as the root user. The
user must be an administrator and be able to provide the maint-login
password.
monitor start filename
monitor stop filename
reportstats
config private
config exclusive
Starts displaying the specified system log or tracing the specified
file. If necessary, the output can be redirected to a file. For
information on how to redirect output, refer to Section 2.6.5, “Using
Output Redirects”. Use auto completion to view a list of available
logs and files.
Stops displaying the specified system log or tracing the specified
file. Use auto completion to view a list of available logs and files.
Displays an extensive collection of device-specific statistics. If
necessary, the output can be redirected to a file. For information
on how to redirect output, refer to Section 2.6.5, “Using Output
Redirects”.
Enters a configuration mode where users can make changes to the
system. This is the primary mode for most users who want to make
changes to the device/network configuration. It can be accessed by
multiple Operator and Admin users.
All changes made during a private configuration session are hidden
from other users until they are committed. Each change must be
committed before it is applied to the active system.
If a user opens an exclusive configuration session during another
user's private configuration session, the user in the private
configuration session cannot commit their changes until the other
user ends their session.
Enters a configuration mode where users can make changes to
the system. This mode is similar to the private configuration mode,
except all other users are blocked from committing their changes
until the user using the exclusive configuration mode exits. Only one
Operator or Admin user can use the exclusive configuration mode at
a time per device.
When committing changes in exclusive configuration mode, use the
confirmed option to set a timeout period. Changes will be applied
for the set period of time, after which the configuration will be reset
to its previous settings. This allows users to test their configuration
changes before fully applying them to the active system.
For more information about the confirmed option, refer to
Section 2.6.9.5, “Configuration Mode General Commands”.
IMPORTANT!
Always log out of the exclusive configuration mode
or exit the transaction. If the session is terminated
before a user exits properly, other users logged in to
the device will continue to be blocked from making
changes until the session timeout period expires.
38Administration Commands
Page 77
RUGGEDCOM ROX II
CLI User Guide
Using RUGGEDCOM ROX II
Section 2.6.9.5
Configuration Mode General Commands
Configuration mode provides a set of general commands that allow users to work with configuration data.
ParameterDescription
Chapter 2
abort
clear
commit no-confirm
commit abort
commit and-quit
commit check
commit confirmed timeout
Exits the configuration session without saving changes.
NOTE
In an edit exclusive session, any pending unconfirmed
commits will not be canceled until their timeout periods
expire. A new edit exclusive session cannot be opened
until the timeout period ends.
Deletes all configuration changes.
Immediately commits the current set of configuration changes. This
command will prompt the user to confirm the action. Use the no-confirm parameter to revert the configuration without requiring
confirmation.
In an edit exclusive session, this command aborts/cancels all
confirmed commits.
Commits all confirmed and unconfirmed changes and exits the
configuration mode.
Validates the current configuration.
Temporarily commits changes for a period of time, allowing users
to test the configuration before fully committing the changes. The
changes must be committed using a standard commit command
before the timeout period ends. If changes are not committed before
the timeout period ends, they are automatically discarded and the
previous settings are restored.
A timeout period can be specified at the end of the command. The
default timeout period is 10 minutes. The minimum timeout period is
1 minute. For example:
ruggedcom(config-admin)# commit confirmed 2
To cancel a commit before the time elapses and discard the
changes, type:
commit abort
To permanently commit the changes before the time elapses, type:
commit
commit comment text
commit label text
commit persist-id text
commit save-running file
Immediately commits the current set of configuration changes
along with a custom comment. The comment will appear next to the
commit in a list of pending of commits.
Immediately commits the current set of configuration changes
along with a custom label. In a list of pending commits, the label will
appear instead of the auto-generated commit ID.
Immediately commits the current set of configuration changes and
assigns a user-specified ID or flag.
Immediately commits the current set of configuration changes and
saves them to the specified file. It does not save the complete
running configuration.
Configuration Mode General Commands39
Page 78
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
copy
details
do
end
Copies a configured element to a new element. For example, the
following command copies the userid admin to the new userid
wsmith:
ruggedcom(config)# copy admin users userid admin
smith
The new item has all of the attributes of the item from which it is
copied. In this example, userid wsmith will have the same password
and role attributes as the userid admin.
When used in combination with the save command, the details
command includes default values in the saved configuration file. For
example:
ruggedcom(config)# save {filename} | details
The details command can also be used to show default
configuration values. For example:
ruggedcom(config)# show running-config admin
session-limits | details
Performs an Operational mode command. For example, the
following command performs the Operational mode ping command
in the Configuration mode session:
ruggedcom(config)# do ping 172.30.134.12
Terminates the configuration session. The system prompts the user
to commit uncommitted changes.
exit
help command
load [ merge | override ] filename
Exits from the current mode. Unlike the end command, the system
does not prompt the user to commit uncommitted changes.
Displays help information for the specified command.
Loads a configuration from an ASCII CLI configuration file.
Two parameters are available for the CLI load command: override
and merge.
• Override: this parameter is for users who have a full configuration
file saved and want to load it back on to the device. The full
configuration file can be previously created with the CLI save
command executed from the top level in the configuration tree
or with the adminfull-configuration-save command.
With the override parameter, the entire running configuration is
overwritten by the contents of the configuration file.
The override option has the following restrictions:
▪ The configuration file must be a complete configuration for the
device. A complete configuration is the entire configuration tree.
▪ The load command must be invoked at the base of the
configuration tree.
• Merge: this parameter is for users who want to build a template
configuration and load it to many devices. The template
configuration file can be obtained by using the CLI save
command. With the merge parameter, the contents of the
configuration file will be merged with the running configuration.
The remaining configurations, which are not included in the
configuration file, will remain unchanged.
After loading the configuration, use the commit command to commit
the changes.
40Configuration Mode General Commands
Page 79
RUGGEDCOM ROX II
CLI User Guide
ParameterDescription
Using RUGGEDCOM ROX II
Chapter 2
move [ after | before | first | last | ipv4 ]
no
Moves an existing IPv4 address to a new position in the list
of addresses. The address can be moved to the first or last
(default) position in the list, or before or after another address. For
example, the following command moves 172.30.137.37/9 before
172.30.137.31/19:
ruggedcom(config)# move ip fe-3-1 ipv4 address
172.30.137.37/19 before 172.30.137.31/19
Negates a command or sets it to its default setting. For example, the
following command deletes the IP address 172.30.137.37/19:
ruggedcom(config)# no ip fe-3-1 ipv4 address
172.30.137.37/19
NOTE
The no command affects only the parameter or setting
of the node explicitly specified in the command. When
using no to negate a parameter or setting that has
dependencies, clearing the specific parameter does not
clear the related dependencies.
For example, the following command adds an IPv4
route with a gateway:
ruggedcom(config)# routing ipv4 route
192.168.33.0/24 via 192.168.11.2
The following command deletes the gateway, but it
does not delete the route:
ruggedcom(config)# no routing ipv4 route
192.168.33.0/24 via 192.168.11.2
pwd
rename
resolved
revert no-confirm
rollback configuration number
The no deletes only the explicitly specified parameter
or object.
Displays the path to the current node. For example, after navigating
to an IPv4 address, the following command displays the path
through the command hierarchy to the current node:
ruggedcom(config-address-172.30.137.31/19)# pwd
Current submode path:
ip fe-3-1 \ ipv4 \ address 172.30.137.31/19
Changes the value of a parameter. For example, the following
command changes the IPv4 address 172.30.137.36/19 to
172.30.137.40/19:
ruggedcom(config)# rename ip fe-3-1 ipv4 address
172.30.137.36/19 172.30.137.40/19
Issue this command when conflicts have been resolved. Conflicts
are normally discovered when the commit operation is performed.
Conflicts typically arise when multiple users edit the same parts of a
configuration.
Copies the running configuration into the current configuration. This
discards all changes to the current configuration. This command
will prompt the user to confirm the action. Use the no-confirm
parameter to revert the configuration without requiring confirmation.
Returns the configuration to a previously committed configuration.
The system stores a limited number of old configurations. After
Configuration Mode General Commands41
Page 80
Chapter 2
Using RUGGEDCOM ROX II
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
reaching the maximum number of old configurations, storing a new
configuration deletes the oldest configuration in the list. The most
recently committed configuration (the running configuration) appears
as item 0 in the list. Select a number from the list and press Enter.
ruggedcom(config)# rollback configuration
Possible completions:
0 2012-01-08 13:51:46 by admin via cli
1 2012-01-08 13:50:58 by admin via cli
2 2012-01-08 12:05:46 by admin via cli
3 2012-01-08 10:47:42 by admin via cli
4 2012-01-08 07:49:38 by admin via cli
5 2012-01-08 07:46:14 by admin via cli
ruggedcom(config)# rollback configuration
After rolling back the configuration, use the commit command to
commit the changes.
save filename
show
Saves the current configuration, without default values, to an ASCII
file. Specify a filename for the file.
Current configuration means the configuration of the user's current
level in the configuration data hierarchy. For example, if the user
is at the top level, the save command will save the complete/full
configuration of the device.
ruggedcom(config)# save {full-configurationfilename}
If the user is at a level other than the top level, such as the firewall
level, the save command will save a partial configuration of the
current level.
ruggedcom(config)#security firewall
ruggedcom(config-firewall)# save {firewallconfiguration-filename}
Use this command along with the details command to include
default values in the saved configuration file. For example:
ruggedcom(config)# save {filename} | details
Shows configuration, history or command line interface parser
information. Type show and press Tab to navigate through the items
available to display.
This command can also be combined with the details command
to display the default configuration values. For example:
ruggedcom# show running-config admin sessionlimits | details
top command
validate
wizard [ rox_flash | rox_upgrade ]
Exits to the top level of the command hierarchy and, optionally, runs
a command.
Validates the current configuration.
Runs the rox_flash or rox_upgrade wizards. For more information,
refer to Section 3.11.5.2, “Downgrading Using ROXflash” and
Section 3.11.3, “Upgrading the RUGGEDCOM ROX II Software”.
42Configuration Mode General Commands
Page 81
RUGGEDCOM ROX II
CLI User Guide
Using RUGGEDCOM ROX II
Section 2.7
Configuring the CLI Interface
The following commands can be used to configure certain characteristics and customize the CLI interface.
ParameterDescription
Chapter 2
autowizard { true | false }
clear history
display-level
history integer
output-file { filename | terminal }
paginate { true | false }
screen-length integer
screen-width integer
show-defaults { true | false }
When enabled, the CLI prompts for required settings when a new
identifier is created.
Clears the CLI history.
Determines the depth of hierarchical information to display in
command results.
Determines the number of items to record in the CLI history.
Directs CLI output to the specified ASCII text file, or to the terminal.
Output is directed to the specified destination until another
destination is set with a subsequent output-file command.
Lengthy output is paginated by default. When the output reaches the
screen-length setting, the CLI prompts the user to press a key for
more output. Press Enter to advance line-by-line or press Space to
advance page-by-page. When disabled, output is not paginated.
Determines the number of lines in a terminal page.
Determines the length of terminal lines.
Determines if default values are shown when displaying the
configuration. When enabled, default values appear as comments
after the configured value. In the following example, the default
value for the contact value is shown as a comment following the
configured contact string of wsmith@example.com:
Default values only appear for parameters that have default values.
If a parameter does not have a default value, no default appears
when show-defaults is set to true.
terminal { dumb | vt100 | xterm | linux | ansi }
Determines the terminal type and controls how line editing is
performed. Supported terminals are: dumb, vt100, xterm, linux, and
ansi. Other terminals may also work but have no explicit support.
Section 2.8
Accessing Different Modes
Aside from normal mode, there are three additional modes within RUGGEDCOM ROX II that offer various
controls over the operating system.
The following sections describe how to access the different modes within RUGGEDCOM ROX II:
• Section 2.8.1, “Accessing BIST Mode”
Configuring the CLI Interface43
Page 82
Chapter 2
Using RUGGEDCOM ROX II
RUGGEDCOM ROX II
CLI User Guide
• Section 2.8.2, “Accessing Service Mode”
• Section 2.8.3, “Accessing Maintenance Mode”
Section 2.8.1
Accessing BIST Mode
BIST (Built-In-Self-Test) mode is used by RUGGEDCOM ROX II to test and configure internal functions of the
device. The method for accessing BIST is different if a new software image has been flashed onto the flash card.
CAUTION!
Security hazard – risk of unauthorized access and/or exploitation. Access to BIST mode should be
restricted to admin users only.
CAUTION!
Configuration hazard – risk of data corruption. BIST mode is provided for troubleshooting and
advanced configuration purposes and should only be used by Siemens Canada Ltd. technicians. As
such, this mode is not fully documented. Misuse of the commands available in this mode can corrupt
the operational state of the device and render it inaccessible.
NOTE
BIST mode opens port 222.
To access BIST mode normally, do the following:
IMPORTANT!
Do not connect the device to the network when it is in BIST mode. The device will generate excess
multicast traffic in this mode.
1.Disconnect the device from the network.
2.Connect to the RUGGEDCOM RX1500 through the RS-232 console connection and a terminal application.
For more information, refer to Section 2.1.1, “Connecting Directly”.
3.Reboot the device. For more information, refer to Section 3.5, “Rebooting the Device”.
4.If prompted, provide the boot password/passphrase for the device.
5.As soon as the device starts to boot up, press ESC. A list of possible boot modes for each partition appears.
Auto booting [4-0], Hit [ESC] key to stop: 0
Welcome to the boot menu. Please select from the following options:
Enter [BootPartition-BootTarget] (e.g. '4.0') to boot.
'h' Show this help menu
44Accessing BIST Mode
Page 83
RUGGEDCOM ROX II
CLI User Guide
'l' List the available boot targets
'c' Exit to the boot loader command line
Will reboot after 60 seconds of inactivity
:
Using RUGGEDCOM ROX II
NOTE
In the example above, the text Auto booting [4-0] indicates the active partition is Boot
Partition 4.
6.Enter boot mode on the active partition by typing the associated target number. For example, if the active
partition is Boot Partition 6, type 6-1 and press Enter. The self-test cycle begins.
7.Press Ctrl+c to stop the self-test cycle and halt the excess multicast traffic. A BIST prompt appears.
BIST:~#
To access BIST mode after flashing a new software image on to the flash card, do the following:
1.Connect to the RUGGEDCOM RX1500 through the RS-232 console connection and a terminal application.
For more information, refer to Section 2.1.1, “Connecting Directly”.
2.Cycle power to the device.
3.If prompted, provide the boot password/passphrase for the device.
Chapter 2
4.Press Ctrl+c to stop the self-test cycle and halt the excess multicast traffic. A BIST prompt appears.
BIST:~#
Once all configuration changes or tests are complete, it is important to change the boot mode by doing the
following:
1.Set the next boot to normal by typing:
nextboot normal
2.Reboot the device by typing:
reboot
CAUTION!
Security hazard – risk of unauthorized access and/or exploitation. Upon accessing BIST mode
on a device that is connected to a network, make sure SSH is disabled. Failure to disable SSH
once in BIST mode would allow anyone with remote access to the device and the root password to
access the Linux shell.
NOTE
SSH is enabled automatically once the device is rebooted in normal mode. It can also be enabled
manually by typing:
/etc/init.d/ssh start
3.Once the device is rebooted, disable SSH immediately by typing:
/etc/init.d/ssh stop
4.Connect the device to the network.
Accessing BIST Mode45
Page 84
Chapter 2
Using RUGGEDCOM ROX II
Section 2.8.2
Accessing Service Mode
Service mode grants access to the Linux shell.
To access service mode, do the following:
CAUTION!
Configuration hazard – risk of data corruption. Service mode is provided for troubleshooting and
advanced configuration purposes and should only be used by Siemens technicians. As such, this
mode is not fully documented. Misuse of the commands available in this mode can corrupt the
operational state of the device and render it inaccessible.
CAUTION!
Security hazard – risk of unauthorized access and/or exploitation. SSH is automatically enabled on
port 222 when the device is put in service mode. If the device is connected to the network, a user with
remote access to the device and the root password could access the Linux shell. If required, protect
the device by either:
• Disconnecting the device from the network
• Disabling SSH via maintenance mode before accessing service mode
RUGGEDCOM ROX II
CLI User Guide
IMPORTANT!
Changes made to the configuration in this mode will override the current configuration settings (e.g. IP
addresses, VLAN settings, etc.), but are discarded following a system reboot.
1.Connect to RUGGEDCOM ROX II through the RS-232 console connection and a terminal application. For
more information, refer to Section 2.1.1, “Connecting Directly”.
2.Reboot the device. For more information, refer to Section 3.5, “Rebooting the Device”.
3.As soon as the device starts to boot up, press ESC. A list of possible boot modes for each partition appears.
Auto booting [4-0], Hit [ESC] key to stop: 0
Welcome to the boot menu. Please select from the following options:
Enter [BootPartition-BootTarget] (e.g. '4.0') to boot.
'h' Show this help menu
'l' List the available boot targets
'c' Exit to the boot loader command line
Will reboot after 60 seconds of inactivity
:
NOTE
In the example above, the text
46Accessing Service Mode
Page 85
RUGGEDCOM ROX II
CLI User Guide
Auto booting [4-0]
Using RUGGEDCOM ROX II
indicates the active partition is Boot Partition 4.
4.Enter service mode on the active partition by typing the associated target number. For example, if the active
partition is Boot Partition 6, type 6-3. A login prompt for service mode appears.
5.Type root and press Enter. A password prompt appears.
NOTE
If a unique password/passphrase has not been configured, use the factory default password. For
more information, refer to Section 2.2, “Default User Names and Passwords”.
NOTE
The current service mode password/passphrase is the same as the password/passphrase for
accessing maintenance mode.
6.Type the current service mode password/passphrase and press Enter.
ruggedcom login: root
Password:
Last login: Tue Oct 13 13:37:38 EDT 2020 on ttyS0
Linux ruggedcom 3.0.0-2-8360e #1 Thu Jan 24 21:20:30 UTC 2013 ppc
The programs included with the Debian GNU/Linux system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.
Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law.
8t-eterminal size
now 80x20
Welcome to ruggedcom Partition1 (Rev ROX 2.4.0 (2013-01-24 18:20)) RX1510 SN
12110102-0012-0030060017 13:42:07 up 7 min
Temperature +38.5 C (+101.3 F) Disk 24% Memory 41%
root@ruggedcom:~#
Chapter 2
CAUTION!
Security hazard – risk of unauthorized access and/or exploitation. Upon accessing service mode
on a device that is connected to a network, make sure SSH is disabled. Failure to disable SSH
once in service mode would allow anyone with remote access to the device and the root password
to access the Linux shell.
Section 2.8.3
Accessing Maintenance Mode
Maintenance mode grants access to the Linux shell.
To access maintenance mode, do the following:
CAUTION!
Configuration hazard – risk of data corruption. Maintenance mode is provided for troubleshooting
purposes and should only be used by Siemens Canada Ltd. technicians. As such, this mode is not fully
Accessing Maintenance Mode47
Page 86
Chapter 2
Using RUGGEDCOM ROX II
documented. Misuse of the commands available in this mode can corrupt the operational state of the
device and render it inaccessible.
IMPORTANT!
Changes made to the configuration in this mode will override the current configuration settings (e.g. IP
addresses, VLAN settings, etc.), but are discarded following a system reboot.
1.In normal mode, type maint-login and press Enter. A password prompt appears.
NOTE
The current maintenance mode password/passphrase is the same as the password/passphrase
for accessing service mode.
2.Type the current maintenance mode password/passphrase and press Enter.
Example:
ruggedcom# maint-login
Password:
Welcome to ruggedcom Partition2 (Rev ROX 2.4.0 (2013-01-24 18:20)) RX1511 SN R15R-3410-PR061
22:29:20 up 1 day, 8:42
Temperature +41.0 C (+105.8 F) Disk 25% Memory 43%
root@ruggedcom:~#
RUGGEDCOM ROX II
CLI User Guide
48Accessing Maintenance Mode
Page 87
RUGGEDCOM ROX II
CLI User Guide
Device Management
Device Management
This chapter describes how to configure and manage the device and its components, such as module interfaces,
logs and files. It describes the following tasks:
NOTE
For information about how to configure the device to work with a network, refer to Chapter 5, Setup and
Configuration.
• Section 3.1, “Determining the Product Version”
• Section 3.2, “Viewing Chassis Information and Status”
• Section 3.3, “Viewing the Parts List”
• Section 3.4, “Shutting Down the Device”
• Section 3.5, “Rebooting the Device”
• Section 3.6, “Restoring Factory Defaults”
Chapter 3
• Section 3.7, “Decommissioning the Device”
• Section 3.8, “Managing Files”
• Section 3.9, “Managing Logs”
• Section 3.10, “Managing the Software Configuration”
• Section 3.11, “Upgrading/Downgrading the RUGGEDCOM ROX II Software”
• Section 3.12, “Managing RUGGEDCOM ROX II Applications”
• Section 3.25, “Managing a Domain Name System (DNS)”
49
Page 88
Chapter 3
Device Management
Section 3.1
Determining the Product Version
During troubleshooting or when ordering new devices, Siemens Canada Ltd. personnel may request specific
information about the device, such as the model, order code or serial number.
To display general information about the product, type:
show chassis chassis-status
A table or list similar to the following example appears:
ruggedcom# show chassis chassis-status
chassis-status
model RX1501
software license "Layer 3 Standard Edition"
order code RX1501-L3-MNT-HI-L3SE-CG01-XX-S01-E02-XX-XX
rox release "ROX 2.6.0-QA3.14 (2014-08-11 18:00)"
system serial number RX1501R-0812-00664
This table or list provides the following information:
ParameterDescription
RUGGEDCOM ROX II
CLI User Guide
modelSynopsis: A string
The RuggedCom device model name.
software-licenseSynopsis: A string
The current software capability.
mlfbSynopsis: A string 1 to 256 characters long
rox-releaseSynopsis: A string
system-serial-numberSynopsis: A string 1 to 32 characters long
Security hazard – risk of unauthorized access and/or exploitation. Always shutdown the device before
disconnecting power. Failure to shutdown the device first could result in data corruption.
NOTE
The device never enters a permanent shutdown state. When instructed to shutdown, the devices shuts
down and provides a time-out period during which power can be disconnected from the device. The
default time-out period is 300 seconds (five minutes). At the end of the time-out period, the device
reboots and restarts.
NOTE
If wiring hinders the process of disconnecting power from the device, the power module(s) can be
removed instead.
admin shutdown
56Viewing the Parts List
Page 95
RUGGEDCOM ROX II
CLI User Guide
Section 3.5
Device Management
Rebooting the Device
To reboot the device, type:
admin reboot
Section 3.6
Restoring Factory Defaults
To restore the factory defaults for the device, navigate to admin » restore-factory-defaults and configure the
following parameter(s):
admin restore-factory-defaults
If necessary, include the following options in the command:
ParameterDescription
Chapter 3
delete-logsSynopsis: true or false
default-both-partitionsSynopsis: true or false
delete-saved-configurationsSynopsis: true or false
shutdownSynopsis: true or false
Section 3.7
Default: false
Delete system logs as well as restoring default settings.
Default: false
Perform the operation on both partitions.
Default: false
Delete saved configuration files (works with default-both-partitions option).
Default: false
Shutdown rather than reboot after restoring factory defaults.
Decommissioning the Device
Before taking the device out of service, either permanently or for maintenance by a third-party, make sure the
device has been fully decommissioned. This includes removing any sensitive, proprietary information.
To decommission the device, do the following:
1.Obtain a copy of the RUGGEDCOM ROX II firmware currently installed on the device. For more information,
contact Siemens Customer Support.
2.Log in to maintenance mode. For more information, refer to Section 2.8.3, “Accessing Maintenance Mode”.
3.Delete the current boot password/passphrase by typing:
rox-delete-bootpwd --force
4.Type exit and press Enter.
Rebooting the Device57
Page 96
Chapter 3
Device Management
RUGGEDCOM ROX II
CLI User Guide
5.Log in to RUGGEDCOM ROX II. For more information, refer to Section 2.3, “Logging In”.
6.Flash the RUGGEDCOM ROX II firmware obtained in Step 1 to the inactive partition and reboot the device.
For more information, refer to Section 3.11.5.2, “Downgrading Using ROXflash”.
7.Repeat Step 5 and Step 6 to flash the RUGGEDCOM ROX II firmware obtained in Step 1 to the other
partition and reboot the device.
8.Shut down the device. For more information, refer to Section 3.4, “Shutting Down the Device”.
Section 3.8
Managing Files
The following sections describe how to manage important files on the device:
NOTE
Only feature keys and configuration files can be installed or backed up.
• Section 3.8.1, “Installing Files”
• Section 3.8.2, “Backing Up Files”
Section 3.8.1
Installing Files
To install a file on the device, such as a configuration file or feature key, do the following:
1.If the source of the file is a USB Mass Storage drive, insert the drive in the USB port on the device. For more
information, refer to the RUGGEDCOM RX1500/RX1501/RX1510/RX1511/RX1512 Installation Guide.
2.Navigate to admin » install-files and configure the following parameter(s) as required:
url { url }Synopsis: A string 1 to 1024 characters long
The URL of the ROX II file to copy. Supported URIs are HTTP,
SCP, SFTP, FTPS and FTP. To install from a USB flash drive
or microSD/microSDHC drive (if applicable), the URL format is
"usb://<usb-device-name>/path-to-file-on-system" or "sd://sd-1//
path-to-file-on-system". Run "show chassis" to determine the
name of the USB device. Note that only one single partition is
supported for either data medium. For all other protocols, the
format is "protocol://user:password@host:port/path-to-file". If
"port" is not specified, the default port for the protocol is used.
Section 3.8.2
Backing Up Files
To backup files stored on the device, do the following:
58Managing Files
Page 97
RUGGEDCOM ROX II
CLI User Guide
Device Management
1.If the file's destination is a USB Mass Storage drive, insert the drive in the USB port on the device. For more
information, refer to the RUGGEDCOM RX1500/RX1501/RX1510/RX1511/RX1512 Installation Guide.
2.Make sure the CLI is in Configuration mode.
3.Navigate to admin » backup-files and configure the following parameter(s) as required:
file { file }Synopsis: A string 1 to 255 characters long
The file names to copy.
Chapter 3
timestampSynopsis: true or false
url { url }Synopsis: A string 1 to 1024 characters long
Default: false
If enabled, a time stamp will be appended to the file name. This
option is not applicable to file names that contain '*'.
The URL of the ROX II file to copy. Supported URIs are HTTP,
SCP, SFTP, FTPS and FTP. To save to a USB flash drive or
microSD/microSDHC drive (if applicable), the URL format is
"usb://<usb-device-name>/path-to-file-on-system" or "sd://sd-1//
path-to-file-on-system". Run "show chassis" to determine the
name of the USB device. Note that only one single partition is
supported for either data medium. For all other protocols, the
format is "protocol://user:password@host:port/path-to-file". If
using a path only, close it with '/'. If "port" is not specified, the
default port for the protocol is used.
Section 3.9
Managing Logs
RUGGEDCOM ROX II maintains various logs to record information about important events. Each log falls into
one of the following log types:
Security Event LogsInformation related to the following security events are logged by RUGGEDCOM ROX II:
NOTE
Passwords can be retried up to 3 times before the login attempt is considered a security event.
• Successful and unsuccessful login attempts
• Local and remote (RADIUS) authentication
• Security-sensitive commands (whether successful or unsuccessful)
• An optionally configurable SNMP Authentication Failure Trap (disabled by default) in accordance with
SNMPv2-MIB
All security event logs are recorded in var/log/auth.log and can be viewed in the Authlog Viewer. For
more information about viewing logs, refer to Section 3.9.1, “Viewing Logs”.
SyslogsSyslog allows users to configure local and remote syslog connections to record important, non-security event
Managing Logs59
information. The remote Syslog protocol, defined in RFC 3164 [http://tools.ietf.org/html/rfc3164], 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 designed to simply transport these event
messages from the generating device to the collector.
Page 98
Chapter 3
Device Management
All log files are organized in the log directory (/var/log) according to the facility and priority at which they
have been logged. Remote Syslog sends the requested logs to the remote server(s) at whichever facility and
priority they were initially logged, after filtering the logs based on the selectors configured for the server.
The following log files are setup with the following default selectors:
• syslog catches all logs except daemon.debug, auth or authpriv logs
• daemon.log catches all err level (and above) logs written to the daemon facility
• messages catches all info, notice and warn level logs for all facilities except auth, authpriv, cron, daemon,
mail and news
A selector setup using the following facilities at level info and up is recommended:
• daemon
• user
• kern
• syslog
Diagnostic LogsDiagnostic logs record system information for the purposes of troubleshooting.
The following sections describe how to view, configure and manage logs:
• Section 3.9.1, “Viewing Logs”
• Section 3.9.2, “Deleting Logs”
• Section 3.9.3, “Configuring a Source IP Address for Remote Syslog Messages”
• Section 3.9.7, “Managing Remote Server Selectors”
RUGGEDCOM ROX II
CLI User Guide
Section 3.9.1
Viewing Logs
Select logs can be viewed directly within the CLI. Otherwise, these and other logs can be downloaded from the
device and viewed in a text editor/viewer.
NOTE
For information about downloading log files from the device, refer to Section 3.8.2, “Backing Up Files”.
To view a log in the CLI, do the following:
show log file
Where:
• file is the log file to view
For example, to view the auth.log, type:
show log auth.log
A result similar to the following is displayed:
ruggedcom# show log auth.log
Jan 29 09:25:00 ruggedcom confd[2068]: audit user: admin/0 failed to login using externalauth: Local
authentication
Jan 29 09:25:00 ruggedcom confd[2068]: audit user: admin/0 logged in through Web UI from 192.168.0.200
Jan 29 09:25:00 ruggedcom confd[2068]: audit user: admin/32 assigned to groups: admin
Jan 29 09:25:01 ruggedcom CRON[4599]: pam_unix(cron:session): session opened for user root by (uid=0)
60Viewing Logs
Page 99
RUGGEDCOM ROX II
CLI User Guide
.
.
.
Section 3.9.2
Device Management
Deleting Logs
To delete all logs stored on the device, type:
admin delete-logs
Section 3.9.3
Configuring a Source IP Address for Remote Syslog
Messages
IP packets for remote syslog messages include a destination IP address and a source IP address. The source
IP address is the interface from which the message is sent (e.g. switch.0001). However, that address may not
be meaningful within the system log, or the address may conflict with a firewall rule or policy. In such cases, an
alternative source IP address can be configured for all remote syslog messages.
To configure a specific source IP address for all remote syslog messages, do the following:
1.Make sure the CLI is in Configuration mode.
2.Make sure an IP address is first defined for the desired interface. For more information, refer to either
Section 5.40.3.2, “Adding an IPv4 Address” or Section 5.40.6.2, “Adding an IPv6 Address”.
3.Configure the source IP address by typing:
Chapter 3
admin logging source-ip address
Where:
• address is the alternative source IP address
4.Type commit and press Enter to save the changes, or type revert and press Enter to abort.
Section 3.9.4
Managing Diagnostic Logs
Diagnostic logs are available for troubleshooting the device. Various device behavior is recorded in the following
logs:
LogFilename
Developer's Log/var/log/confd-dev.log
SNMP Log/var/log/snmp-trace.log
NETCONF Summary Log/var/log/netconf.log
NETCONF Trace Log/var/log/netconf-trace.log
XPATH Trace Log/var/log/xpath-trace.log
Deleting Logs61
Page 100
Chapter 3
Device Management
LogFilename
WebUI Trace Log/var/log/webui-trace.log
CAUTION!
Configuration hazard – risk of reduced performance. Enabling diagnostic logging will significantly affect
the performance of RUGGEDCOM ROX II. Only enable diagnostic logging when directed by Siemens.
The following sections describe how to configure and manage diagnostic logs:
• Section 3.9.4.1, “Enabling/Disabling the Developer's Log”
• Section 3.9.4.2, “Enabling/Disabling the SNMP Log”
• Section 3.9.4.3, “Enabling/Disabling the NETCONF Summary Log”
• Section 3.9.4.4, “Enabling/Disabling the NETCONF Trace Log”
• Section 3.9.4.5, “Enabling/Disabling the XPATH Trace Log”
• Section 3.9.4.6, “Enabling/Disabling the WebUI Trace Log”
Section 3.9.4.1
Enabling/Disabling the Developer's Log
RUGGEDCOM ROX II
CLI User Guide
The Developer's log records internal system transactions from the operational view.
CAUTION!
Configuration hazard – risk of reduced performance. Enabling diagnostic logging will significantly affect
the performance of RUGGEDCOM ROX II. Only enable diagnostic logging when directed by Siemens.
To enable or disable the Developer's log, do the following:
1.Make sure the CLI is in Configuration mode.
2.Enable or disable the Developer's log by typing the following commands:
Enable
admin logging diagnostics developer-log enabled
Disable
no admin logging diagnostics developer-log enabled
3.Configure the level of information provided by the Developer's log by typing: