User guide

ManualsBrandsSiemens ManualsComputer equipmentRUGGEDCOM RSG2200

RUGGEDCOM ROS

v4.1

User Guide

For RMC30

12/2014

Preface

Introduction

Using ROS

Device Management

System Administration

Setup and Configuration

Troubleshooting

RC1105-EN-02

Summary of content (170 pages)

PAGE 1
Preface RUGGEDCOM ROS v4.
PAGE 2
RUGGEDCOM ROS User Guide Copyright © 2014 Siemens Canada Ltd. 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.
PAGE 3
RUGGEDCOM ROS User Guide Table of Contents Table of Contents Preface ................................................................................................................ ix Conventions ....................................................................................................................................... ix Alerts ......................................................................................................................................... ix CLI Command Syntax ....
PAGE 4
Table of Contents RUGGEDCOM ROS User Guide 1.6.3.8 TruthValues .......................................................................................................... 22 1.7 Certificate and Key Requirements ............................................................................................... 22 Chapter 2 Using ROS ......................................................................................................... 25 2.1 Connecting to ROS ..............................................
PAGE 5
RUGGEDCOM ROS User Guide Table of Contents 3.6.1 Viewing Local Logs ......................................................................................................... 51 3.6.2 Clearing Local Logs ......................................................................................................... 52 3.6.3 Configuring the Local System Log .................................................................................... 52 3.6.4 Managing Remote Logging ........................................
PAGE 6
Table of Contents RUGGEDCOM ROS User Guide 4.4.4 Authentication Related Security Alarms ............................................................................. 86 4.4.4.1 Security Alarms for Login Authentication ................................................................ 86 4.4.4.2 Security Messages for Port Authentication .............................................................. 88 4.5 Managing the Configuration File .......................................................................
PAGE 7
RUGGEDCOM ROS User Guide Table of Contents 5.4.2 Modbus Concepts .......................................................................................................... 118 5.4.2.1 Modbus Server Client Applications ....................................................................... 118 5.4.2.2 Modbus TCP Performance Determinants .............................................................. 119 5.4.2.3 Turnaround Delay ...............................................................................
PAGE 8
Table of Contents viii RUGGEDCOM ROS User Guide
PAGE 9
RUGGEDCOM ROS User Guide Preface Preface This guide describes v4.1 of ROS (Rugged Operating System) running on the RUGGEDCOM RMC30. 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 us by network and system planners, system programmers, and line technicians.
PAGE 10
RUGGEDCOM ROS User Guide Preface CLI Command Syntax The syntax of commands used in a Command Line Interface (CLI) is described according to the following conventions: Example Description command Commands are in bold. command parameter Parameters are in plain text. command parameter1 parameter2 Parameters are listed in the order they must be entered. command parameter1 parameter2 Parameters in italics must be replaced with a user-defined value.
PAGE 11
RUGGEDCOM ROS User Guide Preface Accessing Documentation The latest Hardware Installation Guides and Software User Guides for most RUGGEDCOM products are available online at www.siemens.com/ruggedcom. For any questions about the documentation or for assistance finding a specific document, contact a Siemens sales representative.
PAGE 12
RUGGEDCOM ROS User Guide Customer Support Preface xii
PAGE 13
RUGGEDCOM ROS Chapter 1 User Guide Introduction Introduction This chapter provides a basic overview of the ROS software. It describes the following topics: • Section 1.1, “Overview” • Section 1.2, “Security Recommendations and Considerations” • Section 1.3, “Available Services by Port” • Section 1.4, “SNMP Management Interface Base (MIB) Support” • Section 1.5, “SNMP Traps” • Section 1.6, “ModBus Management Support” • Section 1.7, “Certificate and Key Requirements” Section 1.
PAGE 14
Chapter 1 RUGGEDCOM ROS Introduction User Guide Section 1.2 Security Recommendations and Considerations The following describes important security-related recommendations and suggestions that should be considered before implementing the RMC30 on any network: • Section 1.2.1, “Security Recommendations” • Section 1.2.2, “Key Files” Section 1.2.
PAGE 15
RUGGEDCOM ROS Chapter 1 User Guide Introduction • Configuration files are provided in the CSV (comma separated values) 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. • Management of the configuration file, certificates and keys is the responsibility of the device owner.
PAGE 16
Chapter 1 RUGGEDCOM ROS Introduction User Guide Section 1.2.2.1 SSL Certificates ROS supports SSL certificates that conform to the following specifications: • X.509 v3 digital certificate format • PEM format • RSA key pair, 512 to 2048 bits The RSA key pair used in the default certificate and in those generated by ROS uses a public key of 1024 bits in length. NOTE RSA keys smaller than 1024 bits in length are not recommended. Support is only included here for compatibility with legacy equipment.
PAGE 17
RUGGEDCOM ROS User Guide Chapter 1 Introduction For information on creating SSL certificates for use with ROS in a Microsoft Windows environment, refer to the following Siemens application note: Creating/Uploading SSH Keys and SSL Certificates to ROS Using Windows.
PAGE 18
Chapter 1 RUGGEDCOM ROS Introduction User Guide NOTE DSA keys smaller than 1024 bits in length are not recommended, and support is only included here for compatibility with legacy equipment. The following (bash) shell script fragment uses the ssh-keygen command line utility to generate a 1024 bit DSA key suitable for use in ROS . The resulting ssh.keys file, which may then be uploaded to ROS: # DSA key size: BITS=1024 # Make an SSH key pair: ssh-keygen -t dsa -b 1024 -N '' -f ssh.
PAGE 19
RUGGEDCOM ROS Chapter 1 User Guide Introduction 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. NOTE In certain cases, the service might be disabled, but the port can still be open (e.g. TFTP). • Port Default The default state of the port (i.e. open or closed).
PAGE 20
Chapter 1 RUGGEDCOM ROS Introduction User Guide Services Port Number Port Open Port Default Access Authorized TACACS+ TCP/49 (configurable) Open (configurable) Closed Yes RADIUS UDP/1812 to send (configurable), opens random port to listen to Open (configurable) Closed Yes Only available through two management interfaces. Remote Syslog UDP/514 (configurable) Open (configurable) Closed No Only available through two management interfaces.
PAGE 21
RUGGEDCOM ROS Chapter 1 User Guide Introduction Services Port Number Port Open Port Default Access Authorized Open (configurable) Closed Yes Note dropped if service not configured RCDP — Section 1.4 SNMP Management Interface Base (MIB) Support ROS supports a variety of standard MIBs, proprietary RUGGEDCOM MIBs and Agent Capabilities MIBs, all for SNMP (Simple Network Management Protocol). • Section 1.4.1, “Supported Standard MIBs” • Section 1.4.
PAGE 22
Chapter 1 RUGGEDCOM ROS Introduction User Guide Standard MIB Name Title RFC 3414 SNMP-USER-BASED-SM-MIB User-based Security Model (USM) for Version 3 of the Simple Network Management Protocol (SNMPv3) RFC 3415 SNMP-VIEW-BASED-ACM-MIB View-bsed Access Control Model (VACM) for the Simple Management Protocol (SNMP) IEEE 802.3ad IEEE8023-LAG-MIB Management Information Base Module for Link Aggregation IEEE 802.
PAGE 23
RUGGEDCOM ROS Chapter 1 User Guide Introduction File Name MIB Name Supported MIB rcSnmpUserBasedSmMibAC.mib RC-SNMP-USER-BASED-SM-MIB-AC SNMP-USER-BASED-SM-MIB-AC rcSnmpViewBasedAcmMibAC.mib RC-SNMP-VIEW-BASED-ACM-MIB-AC SNMP-VIEW-BASED-ACM-MIB-AC rcifmibAC.mib RC-IF-MIB-AC IF-MIB rcbridgemibAC.mib RC-BRIDGE-MIB-AC BRIDGE-MIB rcrmonmibAC.mib RC-RMON-MIB-AC RMON-MIB rcqbridgemibAC.mib RC-Q-BRIDGE-MIB-AC Q-BRIDGE-MIB rcipmibAC.mib RC-IP-MIB-AC IP-MIB rclldpmibAC.
PAGE 24
Chapter 1 RUGGEDCOM ROS Introduction User Guide Table: Proprietary Traps Trap MIB genericTrap RUGGEDCOM-TRAPS-MIB powerSupplyTrap swUpgradeTrap cfgChangeTrap weakPasswordTrap defaultKeysTrap Generic traps carry information about events in their severity and description objects. They are sent at the same time an alarm is generated for the device. The following are examples of RUGGEDCOM generic traps: NOTE Information about generic traps can be retrieved using the CLI command alarms.
PAGE 25
RUGGEDCOM ROS Chapter 1 User Guide Introduction Function Code Data The following sections describe the support for ModBus management: • Section 1.6.1, “ModBus Function Codes” • Section 1.6.2, “ModBus Memory Map” • Section 1.6.3, “ModBus Memory Formats” Section 1.6.1 ModBus Function Codes RUGGEDCOM devices support the following ModBus function codes for device management through ModBus: NOTE While RUGGEDCOM devices have a variable number of ports, not all registers and bits apply to all products.
PAGE 26
Chapter 1 RUGGEDCOM ROS Introduction User Guide Starting Address 2 Bytes 0x0000 to 0xFFFF Number of Registers 2 Bytes 1 to 121 (0x79) Section 1.6.2 ModBus Memory Map The following details how ModBus process variable data is mapped.
PAGE 27
RUGGEDCOM ROS Chapter 1 User Guide Introduction Address #Registers 0240 64 0280 02C0 Description (Reference Table in UI) R/W Format Alarm 6 R Alarm 64 Alarm 7 R Alarm 64 Alarm 8 R Alarm R/W Format R PortCmd R/W Format Ethernet Port Status The following data is mapped to the ethPortStats table: Address #Registers 03FE 2 Description (Reference Table in UI) Port Link Status Ethernet Statistics The following data is mapped to the rmonStats table: Address #Registers 0400 2
PAGE 28
Chapter 1 RUGGEDCOM ROS Introduction 16 User Guide Address #Registers 0430 2 0432 Description (Reference Table in UI) R/W Format Port s7/p1 Statistics - Ethernet In Packets R Uinst32 2 Port s7/p2 Statistics - Ethernet In Packets R Uinst32 0434 2 Port s8/p1 Statistics - Ethernet In Packets R Uinst32 0436 2 Port s8/p2 Statistics - Ethernet In Packets R Uinst32 0440 2 Port s1/p1 Statistics - Ethernet Out Packets R Uinst32 0442 2 Port s1/p2 Statistics - Ethernet Out Packets
PAGE 29
RUGGEDCOM ROS Chapter 1 User Guide Introduction Address #Registers 0484 2 0486 R/W Format Port s1/p3 Statistics - Ethernet In Packets R Uinst32 2 Port s1/p4 Statistics - Ethernet In Packets R Uinst32 0488 2 Port s2/p1 Statistics - Ethernet In Packets R Uinst32 048A 2 Port s2/p2 Statistics - Ethernet In Packets R Uinst32 048C 2 Port s2/p3 Statistics - Ethernet In Packets R Uinst32 048E 2 Port s2/p4 Statistics - Ethernet In Packets R Uinst32 0490 2 Port s3/p1 Statistics
PAGE 30
Chapter 1 RUGGEDCOM ROS Introduction User Guide Address #Registers 04D0 2 04D2 Description (Reference Table in UI) R/W Format Port s3/p1 Statistics - Ethernet Out Packets R Uinst32 2 Port s3/p2 Statistics - Ethernet Out Packets R Uinst32 04D4 2 Port s3/p3 Statistics - Ethernet Out Packets R Uinst32 04D6 2 Port s3/p4 Statistics - Ethernet Out Packets R Uinst32 04D8 2 Port s4/p1 Statistics - Ethernet Out Packets R Uinst32 04DA 2 Port s4/p2 Statistics - Ethernet Out Packets
PAGE 31
RUGGEDCOM ROS Chapter 1 User Guide Introduction Address #Registers 0686 2 06C0 Description (Reference Table in UI) R/W Format Port 4 Statistics – Serial In Packets R Uint32 2 Port 1 Statistics – Serial Out Packets R Uint32 06C2 2 Port 2 Statistics – Serial Out Packets R Uint32 06C4 2 Port 3 Statistics – Serial Out Packets R Uint32 06C6 2 Port 4 Statistics – Serial Out Packets R Uint32 Section 1.6.
PAGE 32
Chapter 1 RUGGEDCOM ROS Introduction User Guide • FF 00 hex requests output to be True • 00 00 hex requests output to be False • Any value other than the suggested values does not affect the requested operation For example, consider a Write Multiple Registers request to clear alarms in the device. 0x10 0x00 0x80 0x00 0x01 2 0xFF 0x00 • FF 00 for register 00 80 clears the system alarms • 00 00 does not clear any alarms The response may look like: 0x10 0x00 0x80 0x00 0x01 Section 1.6.3.
PAGE 33
RUGGEDCOM ROS Chapter 1 User Guide Introduction In this example, bytes 3 and 4 refer to register 1 at location 0x03FE, and represent the status of ports 1 – 16. Bytes 5 and 6 refer to register 2 at location 0x03FF, and represent the status of ports 17 – 32. The device only has 20 ports, so byte 6 contains the status for ports 17 – 20 starting from right to left. The rest of the bites in register 2 corresponding to the non-existing ports 21 – 31 are zero (0).
PAGE 34
Chapter 1 RUGGEDCOM ROS Introduction User Guide 0x04 0x00 0x43 0x00 0x01 The response may look like: 0x04 0x02 0x00 0x0A The lower byte of the register displays the power supply's status. In this example, both power supplies in the unit are functional. Section 1.6.3.
PAGE 35
RUGGEDCOM ROS Chapter 1 User Guide Introduction Each ROS device is shipped with an SSL certificate and RSA key pair, and a DSA key pair for SSH that are unique to software version. If a valid SSL certificate or SSL/SSH keys are not available on the device, the default certificate and keys are used immediately so that SSH and SSL (https) sessions can be served.
PAGE 36
Chapter 1 Introduction RUGGEDCOM ROS User Guide For SSH, ROS requires a DSA key pair in PEM format. The DSA key must be between 512 and 2048 bits in length for Controlled versions. The key file is uploaded to the ssh.keys flash file on the device.
PAGE 37
RUGGEDCOM ROS Chapter 2 User Guide Using ROS Using ROS This chapter describes how to use the ROS interface. It describes the following tasks: • Section 2.1, “Connecting to ROS” • Section 2.2, “Logging In” • Section 2.3, “Logging Out” • Section 2.4, “Using the Web Interface” • Section 2.5, “Using the Console Interface” • Section 2.6, “Using the Command Line Interface” • Section 2.7, “Selecting Ports in ROS” • Section 2.8, “Managing the Flash File System” • Section 2.9, “Accessing BIST Mode” Section 2.
PAGE 38
Chapter 2 RUGGEDCOM ROS Using ROS User Guide • Flow Control: Off • Terminal ID: VT100 • Stop Bit: 1 3. Connect to the device. Once the connection is established, the login form appears. For more information about logging in to the device, refer to Section 2.2, “Logging In”. Section 2.1.2 Connecting via the Network ROS can be accessed over the network either through a Web browser, terminal or a workstation running terminal emulation software.
PAGE 39
RUGGEDCOM ROS Chapter 2 User Guide Using ROS 1. Select the service (i.e. Telnet, RSH or SSH). 2. Enter the IP address for the port that is connected to the network. 3. Connect to the device. Once the connection is established, the login form appears. For more information about logging in to the device, refer to Section 2.2, “Logging In”. Section 2.2 Logging In To log in to the device, do the following: 1. Connect to the device either directly or through a Web browser.
PAGE 40
Chapter 2 RUGGEDCOM ROS Using ROS User Guide CAUTION! To prevent unauthorized access to the device, make sure to change the default guest, operator, and admin passwords before commissioning the device. For more information about changing passwords, refer to Section 4.3, “Configuring Passwords”. 2. In the User Name field, type the username for an account setup on the device. 3. In the Password field, typ the password for the account. 4. Click Enter or click Submit (Web interface only). Section 2.
PAGE 41
RUGGEDCOM ROS Chapter 2 User Guide Using ROS 1 2 3 Figure 4: Web Interface Layout (Example) 1. Top Frame 2. Side Frame 3. Main Frame Frame Description Top The top frame displays the system name for the device. Side The side frame contains a logout option and a collapsible list of links that open various screens in the main frame. For information about logging out of ROS, refer to Section 2.3, “Logging Out”.
PAGE 42
Chapter 2 RUGGEDCOM ROS Using ROS User Guide 3 1 2 4 Figure 5: Elements of a Typical Screen (Example) 1. Title 2. Parameters and/or Data 3. Access Level or Alarm Notification 4. Controls Section 2.5 Using the Console Interface The Console interface is a Graphical User Interface (GUI) organized as a series of menus. It is primarily accessible through a serial console connection, but can also be accessed through IP services, such as a Telnet, RSH (Remote Shell), or SSH (Secure Shell) session.
PAGE 43
RUGGEDCOM ROS Chapter 2 User Guide Using ROS 4 5 1 2 3 Figure 6: Console Interface (Example) 1. System Identification 2. Menus 3. Command Bar 4. Menu Name 5. Alarms Indicator NOTE They system identifier is user configurable. For more information about setting the system name, refer to Section 4.1, “Configuring the System Information”.
PAGE 44
Chapter 2 RUGGEDCOM ROS Using ROS User Guide NOTE Before exiting a screen, ROS will automatically prompt the user to save any changes that have not been committed. Ctrl + I Inserts a new record. Ctrl + L Deletes a record. Ctrl + S Opens the CLI interface. Ctrl + X Terminates the current session. This command is only available from the main menu. Ctrl + Z Displays important information about the current screen or selected parameter. Section 2.
PAGE 45
RUGGEDCOM ROS Chapter 2 User Guide Command Using ROS Description • port is a comma separated list of port numbers (e.g. 1,3-5,7) clrstpstats Clears all spanning tree statistics. cls Clears the screen. dir Prints the directory listing. exit Terminates the session. factory Enables factory mode, which includes several factory-level commands used for testing and troubleshooting. Only available to admin users.
PAGE 46
Chapter 2 RUGGEDCOM ROS Using ROS Command User Guide Description pinged is not on the same network as the device pinging the other device, the default gateway must be programmed. purgemac Purges the MAC Addrtess table. reset Perform a hard reset of the switch. resetport {all | ports} Resets one or more Ethernet ports, which may be useful for forcing re-negotiation of speed and duplex, or in situations where the link partner has latched into an inappropriate state.
PAGE 47
RUGGEDCOM ROS Chapter 2 User Guide Using ROS Command Description Optional and/or required parameters include: • • • • dest is the remote TFTP server's IP address cmd is either put (upload) or get (download) fsource is the source filename fdest is the destination filename trace Starts event tracing. Run trace ? for more help. type filename Displays the contents of a text file.
PAGE 48
Chapter 2 RUGGEDCOM ROS Using ROS User Guide • option is the option to use during the trace Example: >trace transport allon TRANSPORT: Logging is enabled 4. Start the trace by typing: trace Section 2.6.3 Executing Commands Remotely via RSH The Remote Shell (RSH) facility can be used from a workstation to cause the product to act upon commands as if they were entered at the CLI prompt.
PAGE 49
RUGGEDCOM ROS Chapter 2 User Guide Using ROS The following sections describe in more detail how to use SQL commands: • Section 2.6.4.1, “Finding the Correct Table” • Section 2.6.4.2, “Retrieving Information” • Section 2.6.4.3, “Changing Values in a Table” • Section 2.6.4.4, “Resetting a Table” • Section 2.6.4.5, “Using RSH and SQL” Section 2.6.4.1 Finding the Correct Table Many SQL commands operate upon specific tables in the database, and require the table name to be specified.
PAGE 50
Chapter 2 RUGGEDCOM ROS Using ROS User Guide Retrieving Information About a Parameter from a Table Use the following command to retrieve information about a specific parameter from a table: NOTE The parameter name must be the same as it is displayed in the menu system, unless the name contains spaces (e.g. ip address). Spaces must be replaced with underscores (e.g. ip_address) or the parameter name must be wrapped in double quotes (e.g. "ip address").
PAGE 51
RUGGEDCOM ROS Chapter 2 User Guide Port Name 1 Port 1 2 Port 2 3 Port 3 4 Port 4 Using ROS 1 2 3 4 ifName Media 1000T 1000T 1000T 1000T State Enabled On Enabled On Enabled On Enabled On AutoN Speed Dupx FlowCtrl LFI Alarm Auto Auto Off Off on Auto Auto Off Off On Auto Auto Off Off On Auto Auto Off Off On 4 records selected Section 2.6.4.
PAGE 52
Chapter 2 RUGGEDCOM ROS Using ROS User Guide 10.0.1.1 10.0.1.2 C:\> for /F %i in (devices) do rsh %i -l admin,admin sql select from ipAddrtable C:\>rsh 10.0.1.1 -l admin,admin sql select from ipAddrtable IP Address 192.168.0.31 Subnet 255.255.255.0 IfIndex 1001 IfStats 274409096 IfTime 2218 IfName vlan1 1 records selected C:\>rsh 10.0.1.2 -l admin,admin sql select from ipAddrtable 0 records selected C:\ Section 2.
PAGE 53
RUGGEDCOM ROS Chapter 2 User Guide Using ROS 1. Log in to the device as an admin user and access the CLI shell. For more information about accessing the CLI shell, refer to Section 2.6, “Using the Command Line Interface”. 2. Type flashfiles. A list of files currently in Flash memory is displayed, along with their locations and the amount of memory they consume.
PAGE 54
Chapter 2 RUGGEDCOM ROS Using ROS User Guide Section 2.8.3 Defragmenting the Flash File System The flash memory is defragmented automatically whenever there is not enough memory available for a binary upgrade. However, fragmentation can occur whenever a new file is uploaded to the unit. Fragmentation causes sectors of available memory to become separated by ones allocated to files.
PAGE 55
RUGGEDCOM ROS Chapter 3 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, “Viewing Product Information” • Section 3.2, “Viewing CPU Diagnostics” • Section 3.3, “Restoring Factory Defaults” • Section 3.
PAGE 56
Chapter 3 RUGGEDCOM ROS Device Management User Guide 1 2 3 4 5 6 7 8 9 Figure 7: Product Information Form (Example) 1. MAC Address Box 2. Order Code Box 3. Classification Box 7. Required Boot Box 8. Hardware ID Box 9. Reload Button 4. Serial Number Box 5. Boot Version Box 6. Main Version Box This screen displays the following information: Parameter Description MAC Address Synopsis: ##-##-##-##-##-## where ## ranges 0 to FF Shows the unique MAC address of the device.
PAGE 57
RUGGEDCOM ROS Chapter 3 User Guide Device Management Parameter Description Shows the type, part number, and revision level of the hardware. Section 3.2 Viewing CPU Diagnostics To view CPU diagnostic information useful for troubleshooting hardware and software performance, navigate to Diagnostics » View CPU Diagnostics. The CPU Diagnostics form appears. 1 2 3 4 5 6 7 8 9 11 Figure 8: CPU Diagnostics Form 1. Running Time Box 2. Total Powered Time Box 3. CPU Usage Box 4. RAM Total Box Box 7.
PAGE 58
Chapter 3 RUGGEDCOM ROS Device Management User Guide Parameter Description The size of RAM that have never been used during the system runtime. Synopsis: -32768 to 32767 C Temperature The temperature on CPU board. Synopsis: 0 to 4294967295 Free Rx Bufs Free Rx Buffers. Synopsis: 0 to 4294967295 Free Tx Bufs Free Tx Buffers. Section 3.3 Restoring Factory Defaults The device can be completely or partially restored to its original factory default settings.
PAGE 59
RUGGEDCOM ROS Chapter 3 User Guide Device Management Parameter Description Defaults Choice Synopsis: { None, Selected, All } Setting some records like IP Interfaces management interface, default gateway, SNMP settings to default value would cause switch not to be accessible with management applications.
PAGE 60
Chapter 3 RUGGEDCOM ROS Device Management User Guide NOTE The contents of the internal file system are fixed. New files and directories cannot be created, and existing files cannot be deleted. Only the files that can be uploaded to the device can be overwritten. Files that may need to be uploaded or downloaded include: • main.bin – the main ROS application firmware image • boot.bin – the boot loader firmware image • fpga.xsvf – the FPGA firmware binary image • config.
PAGE 61
RUGGEDCOM ROS Chapter 3 User Guide Device Management NOTE If available in the terminal emulation or Telnet software, select the XModem 1K protocol for transmission over the standard XModem option. 4. When the device responds with Press Ctrl-X to cancel , launch the XMODEM transfer from the host computer. The device will indicate when the transfer is complete. The following is an example from the CLI shell of a successful XMODEM file transfer: >xmodem receive main.
PAGE 62
Chapter 3 RUGGEDCOM ROS Device Management User Guide TFTP CMD: main.bin loading succesful. Section 3.5.3 Uploading/Downloading Files Using a TFTP Server To updload or download a file using a TFTP server, do the following: IMPORTANT! TFTP does not define an authentication scheme. Any use of the TFTP client or server is considered highly insecure. NOTE This method requires a host computer that has TFTP server software installed.
PAGE 63
RUGGEDCOM ROS User Guide Chapter 3 Device Management user@host$ sftp admin@ros_ip Connecting to ros_ip... admin@ros_ip's password: sftp> put ROS-CF52_Main_v3-7-0.bin main.bin Uploading ROS-CF52_Main_v3-7-0.bin to /main.bin ROS-CF52_Main_v3-7-0.bin 100% 2139KB 48.6KB/s 00:44 sftp> Section 3.6 Managing Logs The crash (crashlog.txt) and system (syslog.txt) log files contain historical information about events that have occurred during the operation of the device.
PAGE 64
Chapter 3 RUGGEDCOM ROS Device Management User Guide Section 3.6.2 Clearing Local Logs To clear both the local crash and system logs, log in to the CLI shell and type: clearlogs To clear only the local system log, log in to the Web interface and do the following: 1. Navigate to Diagnostics » Clear System Log. The Clear System Log form appears. 1 Figure 12: Clear System Log Form 1. Confirm Button 2. Click Confirm. Section 3.6.
PAGE 65
RUGGEDCOM ROS Chapter 3 User Guide Device Management Parameter Description Local Syslog Level Synopsis: { EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUGGING } Default: INFORMATIONAL The severity of the message that has been generated. Note that the severity level selected is considered the minimum severity level for the system. For example, if ERROR is selected, the system sends any syslog messages generated by Error, Critical, Alert and Emergency. 3. Click Apply.
PAGE 66
Chapter 3 RUGGEDCOM ROS Device Management 2. User Guide Configure the following parameter(s) as required: Parameter Description UDP Port Synopsis: 1025 to 65535 or { 514 } Default: 514 The local UDP port through which the client sends information to the server(s). 3. Click Apply. Section 3.6.4.2 Viewing a List of Remote Syslog Servers To view a list of known remote syslog servers, navigate to Administration » Configure Syslog » Configure Remote Syslog Server.
PAGE 67
RUGGEDCOM ROS Chapter 3 User Guide Device Management 1 Figure 16: Remote Syslog Server Table 1. InsertRecord 2. Click InsertRecord. The Remote Syslog Server form appears. 1 2 3 4 5 7 6 Figure 17: Remote Syslog Server Form 1. IP Address Box 3. 2. UDP Port Box 3. Facility Box 4. Severity Box 5. Apply Button 6. Delete Button 7. Reload Button Configure the following parameter(s) as required: Parameter Description IP Address Synopsis: ###.###.###.
PAGE 68
Chapter 3 RUGGEDCOM ROS Device Management User Guide Parameter Description Severity Synopsis: { EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUGGING } Default: DEBUGGING The severity level is the severity of the message that has been generated. Please note that the severity level user select is accepted as the minimum severity level for the system.
PAGE 69
RUGGEDCOM ROS Chapter 3 User Guide Device Management Section 3.7 Managing IP Gateways ROS allows up to ten IP gateways to be configured. When both the Destination and Subnet parameters are blank, the gateway is considered to be a default gateway. NOTE The default gateway configuration will not be changed when resetting all configuration parameters to their factory defaults. The following sections describe how to set up and manage IP gateways: • Section 3.7.
PAGE 70
Chapter 3 RUGGEDCOM ROS Device Management User Guide 1 Figure 21: IP Gateways Table 1. InsertRecord 2. Click InsertRecord. The IP Gateways form appears. 1 2 3 4 6 5 Figure 22: IP Gateways 1. Destination Box 3. 2. Subnet Box 3. Gateway Box 4. Apply Button 5. Delete Button 6. Reload Button Configure the following parameter(s) as required: Parameter Description Destination Synopsis: ###.###.###.### where ### ranges from 0 to 255 Specifies the IP address of destination network or host.
PAGE 71
RUGGEDCOM ROS Chapter 3 User Guide Device Management Section 3.7.3 Deleting an IP Gateway To delete an IP gateway configured on the device, do the following: 1. Navigate to Administration » Configure IP Gateways. The IP Gateways table appears. Figure 23: IP Gateways Table 2. Select the IP gateway from the table. The IP Gateways form appears. 1 2 3 4 6 5 Figure 24: IP Gateways Form 1. Destination Box 3. 2. Subnet Box 3. Gateway Box 4. Apply Button 5. Delete Button 6.
PAGE 72
Chapter 3 RUGGEDCOM ROS Device Management User Guide 1 2 3 4 5 6 7 8 9 Figure 25: IP Services Form 1. Inactivity Timeout Box 2. Telnet Sessions Allowed Box 3. Web Server Users Allowed Box 4. TFTP Server Box Address Box 6. SSH Sessions Allowed Box 7. RSH Server Box 8. Apply Button 9. Reload Button 2. 5.
PAGE 73
RUGGEDCOM ROS Chapter 3 User Guide Parameter Device Management Description Disables/enables Remote Shell access. 3. Click Apply. Section 3.9 Managing Remote Monitoring Remote Monitoring (RMON) is used to collect and view historical statistics related to the performance and operation of Ethernet ports. It can also record a log entry and/or generate an SNMP trap when the rate of occurrence of a specified event is exceeded.
PAGE 74
Chapter 3 RUGGEDCOM ROS Device Management User Guide If history controls have not been configured, add controls as needed. For more information, refer to Section 3.9.1.2, “Adding an RMON History Control”. Section 3.9.1.2 Adding an RMON History Control To add an RMON history control, do the following: 1. Navigate to Ethernet Stats » Configure RMON History Controls. The RMON History Controls table appears. 1 Figure 27: RMON History Controls Table 1. InsertRecord 2. Click InsertRecord.
PAGE 75
RUGGEDCOM ROS Chapter 3 User Guide Parameter Device Management Description The index of this RMON History Contol record. Port Synopsis: 1 to maximum port number Default: 1 The port number as seen on the front plate silkscreen of the switch. Requested Buckets Synopsis: 1 to 4000 Default: 50 The maximum number of buckets requested for this RMON collection history group of statistics. The range is 1 to 4000. The default is 50.
PAGE 76
Chapter 3 RUGGEDCOM ROS Device Management User Guide 1 2 3 4 5 6 7 10 8 9 Figure 30: RMON History Controls Form 1. Index Box 2. Port Box 3. Requested Buckets Box Button 8. Delete Button 9. Reload Button 3. 4. Granted Buckets Box 5. Interval Box 6. Owner Box 7. Apply Click Delete. Section 3.9.2 Managing RMON Alarms When Remote Monitoring (RMON) alarms are configured, ROS examines the state of a specific statistical variable.
PAGE 77
RUGGEDCOM ROS User Guide Chapter 3 Device Management Figure 31: The Alarm Process There are two methods to evaluate a statistic in order to determine when to generate an event: delta and absolute. For most statistics, such as line errors, it is appropriate to generate an alarm when a rate is exceeded. The alarm defaults to the delta measurement method, which examines changes in a statistic at the end of each measurement period.
PAGE 78
Chapter 3 RUGGEDCOM ROS Device Management User Guide Section 3.9.2.2 Adding an RMON Alarm To add an RMON alarm, do the following: 1. Navigate to Ethernet Stats » Configure RMON Alarms. The RMON Alarms table appears. 1 Figure 33: RMON Alarms Table 1. InsertRecord 2. Click InsertRecord. The RMON Alarms form appears. 1 2 3 4 5 6 7 8 9 10 11 12 14 13 Figure 34: RMON Alarms Form 1. Index Box 2. Variable Box 3. Rising Thr Box 4. Falling Thr Box 5. Value Box 6. Type Options 7. Interval Box 8.
PAGE 79
RUGGEDCOM ROS Chapter 3 User Guide Device Management Parameter Description Index Synopsis: 1 to 65535 Default: 1 The index of this RMON Alarm record. Variable Synopsis: SNMP Object Identifier - up to 39 characters The SNMP object identifier (OID) of the particular variable to be sampled. Only variables that resolve to an ASN.1 primitive type INTEGER (INTEGER, Integer32,Counter32, Counter64, Gauge, or TimeTicks) may be sampled. A list of objects can be printed using shell command 'rmon'.
PAGE 80
Chapter 3 RUGGEDCOM ROS Device Management Parameter User Guide Description The index of the event that is used when a rising threshold is crossed. If there is no corresponding entryl in the Event Table, then no association exists. In particular, if this value is zero, no associated event will be generated. Owner Synopsis: Any 127 characters Default: Monitor The owner of this record. It is suggested to start this string withword 'monitor'. 4. Click Apply. Section 3.9.2.
PAGE 81
RUGGEDCOM ROS Chapter 3 User Guide Device Management 1 2 3 4 5 6 7 8 9 10 11 12 14 13 Figure 36: RMON Alarms Form 1. Index Box 2. Variable Box 3. Rising Thr Box 4. Falling Thr Box 5. Value Box 6. Type Options 7. Interval Box 8. Startup Alarm List 9. Rising Event Box 10. Falling Event Box 11. Owner Box 12. Apply Button 13. Delete Button 14. Reload Button 3. Click Delete. Section 3.9.3 Managing RMON Events Remote Monitoring (RMON) events define behavior profiles used in event logging.
PAGE 82
Chapter 3 RUGGEDCOM ROS Device Management User Guide Section 3.9.3.1 Viewing a List of RMON Events To view a list of RMON events, navigate to Ethernet Stats » Configure RMON Events. The RMON Events table appears. Figure 37: RMON Events Table If events have not been configured, add events as needed. For more information, refer to Section 3.9.3.2, “Adding an RMON Event”. Section 3.9.3.2 Adding an RMON Event To add an RMON alarm, do the following: 1.
PAGE 83
RUGGEDCOM ROS Chapter 3 User Guide Device Management 1 2 3 4 5 6 7 9 8 Figure 39: RMON Events Form 1. Index Box 2. Type List 3. Community Box 4. Last Time Sent Box 8. Delete Button 9. View Button 10. Reload Button 3. 5. Description Box 6. Owner Box 7. Apply Button Configure the following parameter(s) as required: Parameter Description Index Synopsis: 1 to 65535 Default: 3 The index of this RMON Event record.
PAGE 84
Chapter 3 RUGGEDCOM ROS Device Management User Guide Section 3.9.3.3 Deleting an RMON Event To delete an RMON event, do the following: 1. Navigate to Ethernet Stats » Configure RMON Events. The RMON Events table appears. Figure 40: RMON Events Table 2. Select the event from the table. The RMON Events form appears. 1 2 3 4 5 6 7 9 8 Figure 41: RMON Events Form 1. Index Box 2. Type List 3. Community Box 4. Last Time Sent Box 8. Delete Button 9. View Button 10. Reload Button 3. 5.
PAGE 85
RUGGEDCOM ROS Chapter 3 User Guide Device Management Section 3.10.1 Upgrading Firmware Upgrading ROS firmware, including the main, bootloader and FPGA firmware, may be necessary to take advantage of new features or bug fixes. Binary firmware images are available from Siemens . Visit www.siemens.com/ruggedcom to determine which versions/updates are available or contact Siemens Customer Support.
PAGE 86
Chapter 3 RUGGEDCOM ROS Device Management User Guide IMPORTANT! Never downgrade the ROS software version beyond ROS v4.1 when encryption is enabled. Make sure the device has been restored to factory defaults before downgrading. 4. Restore the device to its factory defaults. For more information, refer to Section 3.3, “Restoring Factory Defaults”. 5. Upload and apply the older firmware version and its associated FPGA files using the same methods used to install newer firmware versions.
PAGE 87
RUGGEDCOM ROS User Guide Chapter 3 Device Management Section 3.12 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. Disconnect all network cables from the device. 2. Connect to the device via the RS232 serial console port. For more information, refer to Section 2.1.
PAGE 88
RUGGEDCOM ROS User Guide Decommissioning the Device Chapter 3 Device Management 76
PAGE 89
RUGGEDCOM ROS Chapter 4 User Guide System Administration System Administration This chapter describes how to perform various administrative tasks related to device identification, user permissions, alarm configuration, certificates and keys, and more. It describes the following tasks: • Section 4.1, “Configuring the System Information” • Section 4.2, “Customizing the Login Screen” • Section 4.3, “Configuring Passwords” • Section 4.4, “Managing Alarms” • Section 4.
PAGE 90
Chapter 4 RUGGEDCOM ROS System Administration User Guide Parameter Description Contact Synopsis: Any 49 characters The contact can be used to help identify the person responsible for managing the switch. You can enter name, phone number, email, etc. It is displayed in the login screen so that this person may be contacted should help be required. 3. Click Apply. Section 4.
PAGE 91
RUGGEDCOM ROS Chapter 4 User Guide System Administration NOTE Users can also be verified through a RADIUS or TACACS+ server. When enabled for authentication and authorization, the RADIUS or TACACS+ server will be used in the absence of any local settings. For more information about configuring a RADIUS or TACACS+ server, refer to Section 4.6, “Managing an Authentication Server”.
PAGE 92
Chapter 4 RUGGEDCOM ROS System Administration User Guide An alarm will generate if a weak password is configured. The weak password alarm can be disabled by the user. For more information about disabling alarms, refer to Section 4.4, “Managing Alarms”. 2.
PAGE 93
RUGGEDCOM ROS Chapter 4 User Guide System Administration Parameter Description Related username is in field Admin Username; full read/write access to all settings and commands. Confirm Admin Password Synopsis: 15 character ASCII string Related username is in field Admin Username; full read/write access to all settings and commands. 3. Click Apply. Section 4.4 Managing Alarms Alarms indicate the occurrence of events of either importance or interest that are logged by the device.
PAGE 94
Chapter 4 System Administration RUGGEDCOM ROS User Guide Figure 45: Alarms Table NOTE This list of alarms (configurable and non-configurable) is accessible through the Command Line Interface (CLI) using the alarms. For more information, refer to Section 2.6.1, “Available CLI Commands”. For information about modifying a pre-configured alarm, refer toSection 4.4.3, “Configuring an Alarm”. Section 4.4.
PAGE 95
RUGGEDCOM ROS Chapter 4 User Guide System Administration Figure 46: Latched Alarms Table To clear the passive alarms from the list, do the following: 1. Navigate to Diagnostics » Clear Latched Alarms. The Clear Latched Alarms form appears. 1 Figure 47: Clear Latched Alarms Form 1. Confirm Button 2. Click Confirm. Section 4.4.3 Configuring an Alarm While all alarms are pre-configured on the device, some alarms can be modified to suit the application.
PAGE 96
Chapter 4 System Administration RUGGEDCOM ROS User Guide Figure 48: Alarms Table 2. 84 Select an alarm. The Alarms form appears.
PAGE 97
RUGGEDCOM ROS Chapter 4 User Guide System Administration 1 2 3 4 5 6 7 8 10 9 Figure 49: Alarms Form 1. Name Box 2. Level Box 3. Latch Box 4. Trap Box Button 9. Delete Button 10. Reload Button 3. 5. Log Box 6. LED & Relay Box 7. Refresh Time Box 8. Apply Configure the following parameter(s) as required: Parameter Description Name Synopsis: Any 34 characters Default: sys_alarm The alarm name, as obtained through the alarms CLI command.
PAGE 98
Chapter 4 RUGGEDCOM ROS System Administration User Guide Parameter Description LED & Relay Synopsis: { On, Off } Default: Off Enables LED and fail-safe relay control for this alarm. If latching is not enabled, this field will remain disabled. Refresh Time Synopsis: 0 s to 60 s Default: 60 s Refreshing time for this alarm. 4. Click Apply. Section 4.4.
PAGE 99
RUGGEDCOM ROS Chapter 4 User Guide System Administration Message Name Weak Password Configured Alarm SNMP Trap Syslog Yes Yes Yes Default Keys In Use ROS generates this alarm and logs a message in the syslog when default keys are in use. For more information about default keys, refer to Section 1.7, “Certificate and Key Requirements”. NOTE For Non-Controlled (NC) versions of ROS, this alarm is only generated when default SSL keys are in use.
PAGE 100
Chapter 4 RUGGEDCOM ROS System Administration User Guide TACACS+ Response Invalid ROS generate this alarm and logs a message in the syslog when the response from the TACACS+ server is received with an invalid CRC. Message Name TACACS Response Invalid Alarm SNMP Trap Syslog Yes Yes Yes SNMP Authentication Failure ROS generates this alarm, sends an authentication failure trap, and logs a message in the syslog when an SNMP manager with incorrect credentials communicates with the SNMP agent in ROS.
PAGE 101
RUGGEDCOM ROS Chapter 4 User Guide System Administration Message Name Alarm SNMP Trap Syslog 802.1X Port X Authentication Failure Yes Yes Yes 802.1X Port X Authorized Addr. XXX No No Yes Section 4.5 Managing the Configuration File The device configuration file for ROS is a single CSV (Comma-Separate Value) formatted ASCII text file, named config.csv. It can be downloaded from the device to view, compare against other configuration files, or store for backup purposes.
PAGE 102
Chapter 4 RUGGEDCOM ROS System Administration 1. User Guide Navigate to Administration » Configure Data Storage. The Data Storage form appears. 1 2 3 4 5 Figure 50: Data Storage Form 1. Encryption Options 2. 2. Passphrase Box 3. Confirm Passphrase Box 4. Apply Button 5. Reload Button Configure the following parameter(s) as required: Parameter Description Encryption Synopsis: { On, Off } Enable/disable encryption of data in configuration file.
PAGE 103
RUGGEDCOM ROS Chapter 4 User Guide System Administration ROS also has the ability to accept partial configuration updates. For example, to update only the parameters for Ethernet port 1 and leave all other parameters unchanged, transfer a file containing only the following lines to the device: # Port Parameters ethPortCfg Port,Name,Media,State,AutoN,Speed,Dupx,FlowCtrl,LFI,Alarm, 1,Port 1,100TX,Enabled,On,Auto,Auto,Off,Off,On, Section 4.
PAGE 104
Chapter 4 RUGGEDCOM ROS System Administration User Guide Attribute Value Vendor-Specific Vendor-ID: 15004 Type: 1 Length: 11 String: RuggedCom A RADIUS server may also be used to authenticate access on ports with 802.1X security support.
PAGE 105
RUGGEDCOM ROS Chapter 4 User Guide System Administration NOTE The RADIUS client uses the Password Authentication Protocol (PAP) to verify access. To configure access to either the primary or backup RADIUS servers, do the following: 1. Navigate to Administration » Configure Security Server » Configure RADIUS Server. The RADIUS Server table appears. Figure 51: RADIUS Server Table 2. Select either Primary or Backup from the table. The RADIUS Server form appears.
PAGE 106
Chapter 4 RUGGEDCOM ROS System Administration User Guide Parameter Description Confirm Auth Key Synopsis: 31 character ASCII string The authentication key to be shared with server. 4. Click Apply. Section 4.6.
PAGE 107
RUGGEDCOM ROS Chapter 4 User Guide System Administration 1 2 3 4 5 7 6 Figure 54: TACACS Plus Server Form 1. Server Box Button 3. 2. IP Address Box 3. Auth TCP Port Box 4. Auth Key Box 5. Confirm Key Box 6. Apply Button 7. Reload Configure the following parameter(s) as required: Parameter Description Server Synopsis: Any 8 characters Default: Primary This field tells whether this configuration is for a Primary or a Backup Server. IP Address Synopsis: ###.###.###.
PAGE 108
Chapter 4 RUGGEDCOM ROS System Administration User Guide • 1 represents the guest access level To configure the privilege levels for each user type, do the following: 1. Navigate to Administration » Configure Security Server » Configure TacPlus Server » Configure TACPLUS Serv Privilege Config. The TACPLUS Serv Privilege Config form appears. 1 2 3 4 5 Figure 55: TACPLUS Serv Privilege Config Form 1. Server Box 2. 2. IP Address Box 3. Auth TCP Port Box 4. Apply Button 5.
PAGE 109
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Setup and Configuration This chapter describes how to setup and configure the device for use on a network using the various features available in ROS. It describes the following tasks: • Section 5.1, “Managing Time Services” • Section 5.2, “Managing SNMP” • Section 5.3, “Managing Network Discovery” • Section 5.4, “Managing Serial Protocols” Section 5.
PAGE 110
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Parameter Description Time Zone Synopsis: { UTC-12:00 (Eniwetok, Kwajalein), UTC-11:00 (Midway Island, Samoa), UTC-10:00 (Hawaii), UTC-9:00 (Alaska), UTC-8:00 (Los Angeles, Vancouver), UTC-7:00 (Calgary, Denver), UTC-6:00 (Chicago, Mexico City), UTC-5:00 (New York, Toronto), UTC-4:30 (Caracas), UTC-4:00 (Santiago), UTC-3:30 (Newfoundland), UTC-3:00 (Brasilia, Buenos Aires), UTC-2:00 (Mid Atlantic), UTC-1:00 (Azores), UTC-0:00 (Lisbon, London)
PAGE 111
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Figure 57: NTP Server Table 2. Select either Primary or Backup. The NTP Server form appears. 1 2 3 4 5 Figure 58: NTP Server Form 1. Server Box 3. 2. IP Address Box 3. Update Period Box 4. Apply Button 5. Reload Button Configure the following parameter(s) as required: Parameter Description Server Synopsis: Any 8 characters Default: Primary This field tells whether this configuration is for a Primary or a Backup Server.
PAGE 112
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Section 5.2 Managing SNMP ROS supports versions 1, 2 and 3 of the Simple Network Management Protocol (SNMP), otherwise referred to as SNMPv1, SNMPv2c and SNMPv3 respectively. SNMPv3 provides secure access to the devices through a combination of authentication and packet encryption over the network.
PAGE 113
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Section 5.2.1.1 Viewing a List of SNMP Users To view a list of SNMP users configured on the device, navigate to Administration » Configure SNMP » Configure SNMP Users. The SNMP Users table appears. Figure 59: SNMP Users Table If users have not been configured, add users as needed. For more information, refer to Section 5.2.1.2, “Adding an SNMP User”. Section 5.2.1.
PAGE 114
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 Figure 60: SNMP Users Table 1. InsertRecord 2. Click InsertRecord. The SNMP Users form appears. 1 2 3 4 5 6 7 8 9 10 12 11 Figure 61: SNMP Users Form 1. Name Box 2. IP Address Box 3. v1/v2c Community Box 4. Auth Protocol Box 5. Priv Protocol Box 6. Auth Key Box 7. Confirm Auth Key Box 8. Priv Key Box 9. Confirm Priv Key Box 10. Apply Button 11. Delete Button 12.
PAGE 115
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration • Must have at least one alphabetic character and one number. Special characters are permitted. • Must not have more than 3 continuously incrementing or decrementing numbers. For example, Sub123 and Sub19826 are permitted, but Sub12345 is not. An alarm will generate if a weak password is configured. The weak password alarm can be disabled by the user. For more information about disabling alarms, refer to Section 4.4, “Managing Alarms”. 3.
PAGE 116
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Section 5.2.1.3 Deleting an SNMP User To delete an SNMP user, do the following: 1. Navigate to Administration » Configure SNMP » Configure SNMP Users. The SNMP Users table appears. Figure 62: SNMP Users Table 2. Select the user from the table. The SNMP Users form appears. 1 2 3 4 5 6 7 8 9 10 12 11 Figure 63: SNMP Users Form 1. Name Box 2. IP Address Box 3. v1/v2c Community Box 4. Auth Protocol Box 5. Priv Protocol Box 6.
PAGE 117
RUGGEDCOM ROS User Guide Chapter 5 Setup and Configuration Section 5.2.2 Managing Security-to-Group Mapping The following sections describe how to configure and manage security-to-group maps, refer to the following: • Section 5.2.2.1, “Viewing a List of Security-to-Group Maps” • Section 5.2.2.2, “Adding a Security-to-Group Map” • Section 5.2.2.3, “Deleting a Security-to-Group Map” Section 5.2.2.
PAGE 118
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 Figure 65: SNMP Security to Group Maps Table 1. InsertRecord 2. Click InsertRecord. The SNMP Security to Group Maps form appears. 1 2 3 4 6 5 Figure 66: SNMP Security to Group Maps Form 1. Security Model Box 3. 2. Name Box 3. Group Box 4. Apply Button 5. Delete Button 6.
PAGE 119
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Section 5.2.2.3 Deleting a Security-to-Group Map To delete a security-to-group map, do the following: 1. Navigate to Administration » Configure SNMP » Configure SNMP Security to Group Maps. The SNMP Security to Group Maps table appears. Figure 67: SNMP Security to Group Maps Table 2. Select the map from the table. The SNMP Security to Group Maps form appears. 1 2 3 4 6 5 Figure 68: SNMP Security to Group Maps Form 1.
PAGE 120
Chapter 5 Setup and Configuration RUGGEDCOM ROS User Guide Section 5.2.3.1 Viewing a List of SNMP Groups To view a list of SNMP groups configured on the device, navigate to Administration » Configure SNMP » Configure SNMP Access. The SNMP Access table appears. Figure 69: SNMP Access Table If SNMP groups have not been configured, add groups as needed. For more information, refer to Section 5.2.3.2, “Adding an SNMP Group”. Section 5.2.3.
PAGE 121
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration 1 2 3 4 5 6 7 9 8 Figure 71: SNMP Access Form 1. Group Box 2. Security Model Box 3. Security Level Box 4. ReadViewName Box 6. NotifyViewName Box 7. Apply Button 8. Delete Button 9. Reload Button 3. 5. WriteViewName Box Configure the following parameter(s) as required: Parameter Description Group Synopsis: Any 32 characters The group name to which the security model and name belong.
PAGE 122
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Section 5.2.3.3 Deleting an SNMP Group To delete an SNMP group, do the following: 1. Navigate to Administration » Configure SNMP » Configure SNMP Access. The SNMP Access table appears. Figure 72: SNMP Access Table 2. Select the group from the table. The SNMP Access form appears. 1 2 3 4 5 6 7 9 8 Figure 73: SNMP Access Form 1. Group Box 2. Security Model Box 3. Security Level Box 4. ReadViewName Box 6. NotifyViewName Box 7.
PAGE 123
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration configuration tools to configure them. The behavior of IP-based mechanisms such as the web interface, SSH, telnet, or SNMP will all be undefined. Since RCDP operates at Layer 2, it can be used to reliably and unambiguously address multiple devices even though they may share the same IP configuration. Siemens 's RUGGEDCOM Explorer is a lightweight, standalone Windows application that supports RCDP.
PAGE 124
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Serial interface bit rates can be configured in the range of 100 to 230400 bps. A turnaround time is supported to enforce minimum times between successive messages transmitted via a serial port. CAUTION! Configuration hazard – risk of communication disruption. Changing the ID for the management VLAN will break any active Raw Socket TCP connections. If this occurs, reset all serial ports.
PAGE 125
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Protocol Features WIN • Packetization per the protocol specification • CRC checking in message headers received from the serial port TIN • Support for two TIN protocol modes • Packetization per the protocol specification • CRC checking in message headers received from the serial port • Remote source address learning, specific for the two different modes Telnet Com Port • Raw Socket protocol with additional support for the serial break sig
PAGE 126
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide • Section 5.4.1.1, “Raw Socket Character Encapsulation” • Section 5.4.1.2, “RTU Polling” • Section 5.4.1.3, “Broadcast RTU Polling” • Section 5.4.1.4, “Preemptive Raw Socket” • Section 5.4.1.5, “Port Redirectors” • Section 5.4.1.6, “Message Packetization” Section 5.4.1.1 Raw Socket Character Encapsulation Character encapsulation is used any time a stream of characters must be reliably transported across a network.
PAGE 127
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration 1 3 2 14 3 5 4 3 5 Figure 76: RTU Polling 1. Host 2. Host with Port Redirection Software 3. RMC30 4. Ethernet 5. RTU If a server is used at the host end, it will wait for a request from the host, encapsulate it in an IP Datagram and send it to the remote side. There, the remote server will forward the original request to the RTU. When the RTU replies, the server will forward the encapsulated reply back to the host end.
PAGE 128
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 2 4 1 2 2 41 2 3 4 Figure 77: Broadcast RTU Polling 1. Host 2. RMC30 3. Ethernet 4. RTU Initially, the remote servers establish connections with the host server. The host server is configured to accept a maximum of three incoming connections. The host sequentially polls each RTU. Each poll received by the host server is forwarded (i.e. broadcast) to all of the remote servers.
PAGE 129
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration 5 1 3 3 5 3 5 3 5 4 2 Figure 78: Permanent and Dynamic Master Connection Support 1. Permanent Master (Polling RTUs) 2. Dynamic Master 3. RMC30 4. Ethernet 5. RTU The permanent master is connected to the Raw Socket port of the RMC30. Raw Socket is configured to be connected to all Preemptive Raw Socket ports where polled RTUs are connected (multiple incoming connection).
PAGE 130
Chapter 5 Setup and Configuration RUGGEDCOM ROS User Guide Section 5.4.1.6 Message Packetization The serial server buffers received characters into packets to improve network efficiency and demarcate messages.
PAGE 131
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration The Modbus Server application accepts TCP encapsulated Modbus TCP messages from Client Gateways and native masters. After removing the TCP headers, the messages are issued to the RTU. Responses are TCP encapsulated and returned to the originator. The following illustrates a complex network of Client Gateways, Server Gateways and native TCPModbus devices. 4 5 6 1 8 1 7 9 2 10 3 7 11 Figure 79: Modbus Client and Server 1.
PAGE 132
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 3 4 1a 2 1b 4 5 3a 3b 6 7 9a 8 9c 9b 9d Figure 80: Sources of Delay and Error in an End-to-End Exchange 1. Master 2. Client Gateway 3. Server Gateway 4. Remote Terminal Unit (RTU) In step 1a, the master issues a request to the Client Gateway. If the Client Gateway validates the message, it will forward it to the network as step 2. The Client Gateway can respond immediately in certain circumstances, as shown in step 1b.
PAGE 133
RUGGEDCOM ROS User Guide Chapter 5 Setup and Configuration Section 5.4.2.3 Turnaround Delay The Modbus protocol uses the concept of a turnaround delay in conjunction with broadcast messages. When the host sends a broadcast message (that does not invoke an RTU response), it waits for a turnaround delay time. This delay makes sure the RTU has enough time to process the broadcast message before it receives the next poll.
PAGE 134
Chapter 5 RUGGEDCOM ROS Setup and Configuration 1 User Guide 3 2 4 1 4 1 1 1 2 4 Figure 81: Source/Destination Two-Way Communication 1. Device 1 2. RMC30 Client Gateway 3. Ethernet 4. RMC30 Server Gateway Even if the protocol can distinguish between the server and client sides, ROS does not. Both sides need to know where on the network a given destination device is. If a message is received from the network, the destination address must point to the serial port on the receiving server.
PAGE 135
RUGGEDCOM ROS User Guide Chapter 5 Setup and Configuration Address Learning for TIN Mode 1 When a message with an unknown source address is received from the IP network, it is learned on the IP address and IP port. If a message with the same source address is received from another IP address and/or IP port, the address will be relearned. The aging time will be reset whenever a unicast TIN message is received from a particular source address.
PAGE 136
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Section 5.4.3.5 Broadcast Messages DNP Broadcast Messages Addresses 65521 through 65535 are DNP 3.0 broadcast addresses. ROS supports broadcasts sending messages with those destination addresses received from serial ports to all IP Addresses found in the Device Address Table (either learned or statically configured).
PAGE 137
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration The Device Address Table contains addresses and locations of devices configured (or learned) for specific protocols. If a protocol is configured to use TCP to transport data, the server will start listening to the IP Port configured for the protocol. At the same time, TCP connections will be placed to all IP addresses where devices for that protocol are attached. ROS will keep only one connection open to one IP Address on one IP Port.
PAGE 138
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 2 3 5 6 4 7 8 1 Figure 82: Optical Loop Topology 1. RS485 Slave with Repeat On 2. RMC20 On 6. RUGGEDCOM Server 7. Ethernet 3. Multiple RMC20s 8. RS485 Master 4. RMC20 in Force Half-Duplex Mode 5. RS232/422 with Repeat The repeat function will optically retransmit any data received on the optical receiver, in addition to any connected serial devices.
PAGE 139
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration 1 2 3 4 5 6 7 8 9 10 11 12 13 15 14 16 Figure 84: Serial Ports Form 1. Port Box 2. Name Box 3. Protocol List 4. Type List 5. ForceHD Options 6. Baud Box 7. Data Bits Options 8. Stop List 9. Parity List 10. Turnaround Box 11. PostTx Delay Box 12. Hold Time Box 13. DSCP Box 14. RxtoTx Delay Box 15. Apply Button 16. Reload Button 3.
PAGE 140
Chapter 5 RUGGEDCOM ROS Setup and Configuration Parameter User Guide Description Enables forcing half-duplex mode of operation. While sending data out of the serial port, all received data are ignored. This mode of operation is available only on ports that operate in full-duplex mode. Baud Synopsis: 100 to 230400 Default: 9600 The baud rate at which to operate the port. Data Bits Synopsis: { 7, 8 } Default: 8 The number of data bits to operate the port with. Stop Synopsis: { 1, 1.
PAGE 141
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Section 5.4.6 Configuring the Raw Socket Protocol To configure the Raw Socket protocol for a serial port, do the following: 1. Make sure the serial port is configured to use the Raw Socket protocol. For more information, refer to Section 5.4.5, “Configuring a Serial Port”. 2. Navigate to Serial Protocols » Configure Protocols » Configure Raw Socket » Configure Protocol. The Protocol table appears. Figure 85: Protocol Table 3.
PAGE 142
Chapter 5 RUGGEDCOM ROS Setup and Configuration Parameter User Guide Description Default: 1 The port number as seen on the front plate silkscreen of the switch. Pack Char Synopsis: 0 to 255 or { Off } Default: Off The character that can be used to force forwarding of accumulated data to the network. If a packetization character is not configured, accumulated data will be forwarded based upon the packetization timeout (Pack Timer) parameter.
PAGE 143
RUGGEDCOM ROS Chapter 5 User Guide Parameter Setup and Configuration Description Enables link statistics collection for the protocol. 5. Click Apply. 6. Add one or more remote hosts. For more information, refer to Section 5.4.16.2, “Adding a Remote Host”. Section 5.4.7 Configuring the Preemptive Raw Socket Protocol To configure the Preemptive Raw Socket protocol for a serial port, do the following: 1. Make sure the serial port is configured to use the Preemptive Raw Socket protocol.
PAGE 144
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 3 4 5 6 7 8 9 10 11 13 12 14 Figure 88: Preemptive Raw Socket Form 1. Port Box 2. Pack Char Box 3. Pack Timer Box 4. Pack Size Box 5. Flow Control Options 6. Loc Port Box 7. Rem Port Box 8. IP Address Box 9. Link Stats Options 10. Dyn Pack Char Box 11. Dyn Pack Timer Box 12. Timeout Box 13. Apply Button 14. Reload Button 4.
PAGE 145
RUGGEDCOM ROS Chapter 5 User Guide Parameter Setup and Configuration Description The character that can be used to force forwarding of accumulated data to the network.If a packetization character is not configured, accumulated data will be forwarded based upon the packetization timeout parameter. Pack Timer Synopsis: 1 to 1000 ms Default: 10 ms The delay from the last received character until when data is forwarded.
PAGE 146
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 3 4 5 7 8 Figure 90: Modbus Server Form 1. Port Box 2. Response Timer Box Button 7. Reload Button 4. 3. Auxiliary TCP Port Box 4. Send Exceptions Options 5. Link Stats Options 6. Apply Configure the following parameter(s) as required: Parameter Description Port Synopsis: 1 to maximum port number Default: 1 The port number as seen on the front plate silkscreen of the switch.
PAGE 147
RUGGEDCOM ROS Chapter 5 User Guide 2. Setup and Configuration Navigate to Serial Protocols » Configure Protocols » Configure Modbus Client. The Modbus Client form appears. 1 2 3 4 5 6 Figure 91: Modbus Client Form 1. IP Port Box 3. 2. Forward Exceptions Options 3. Link Stats Options 4. DSCP Box 5. Apply Button 6.
PAGE 148
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 3 4 5 6 7 8 9 10 11 13 12 14 Figure 92: WIN and TIN Form 1. TIN Mode Box 2. TIN Transport Options 3. WIN Transport Options 4. TIN IP Box 5. WIN IP Box 6. Messaging Aging Timer Box 7. Address Aging Timer Box 8. Broadcast Addresses List 9. Unicast Addresses List 10. Link Stats Options 11. WIN DSCP Box 12. TIN DSCP Box 13. Apply Button 14. Reload Button 3.
PAGE 149
RUGGEDCOM ROS Chapter 5 User Guide Parameter Setup and Configuration Description The Aging Time for TIN mode2 messages. It specifies how long a message should be stored in the internal table. When the feature is enabled, any TIN mode2 message received will be stored in an internal table which can be examined by using command 'SQL SELECT FROM ItcsTin2Dup'. If the same message is received within the time window specified by this parameter, the new message is considered duplicate, and thus discarded.
PAGE 150
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 3 4 5 6 Figure 93: MicroLok Form 1. Transport Options 3. 2. IP Port Box 3. Link Stats Options 4. DSCP Box 5. Apply Button 6. Reload Button Configure the following parameter(s) as required: Parameter Description Transport Synopsis: { TCP, UDP, Disabled } Default: UDP The network transport used to transport protocol data over an IP network.
PAGE 151
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration 1 2 3 4 5 6 7 8 9 Figure 94: DNP Form 1. Transport Options 2. IP Port Box 3. Remote UDP Port Options Options 7. DSCP Box 8. Apply Button 9. Reload Button 3. 4. Learning Box 5. Aging Timer Box 6. Link Stats Configure the following parameter(s) as required: Parameter Description Transport Synopsis: { TCP, UDP, Disabled } Default: TCP The network transport used to transport protocol data over an IP network.
PAGE 152
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Section 5.4.13 Configuring the DNP Over Raw Socket Protocol To configure the DNP Over Raw Socket protocol for a serial port, do the following: 1. Make sure the serial port is configured to use the DNP Over Raw Socket protocol. For more information, refer to Section 5.4.5, “Configuring a Serial Port”. 2. Navigate to Serial Protocols » Configure Protocols » Configure DNP Protocol » Configure DNP over RawSocket.
PAGE 153
RUGGEDCOM ROS Chapter 5 User Guide Parameter Setup and Configuration Description Default: In The Call direction for TCP Tranport. • In: accepts an incoming connection. • Out: places an outgoing connection • Both: places an outgoing connection and waits for as incoming connection (both directions). Max Conns Synopsis: 1 to 64 Default: 1 The maximum number of allowed incoming TCP connections.
PAGE 154
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Figure 97: Mirrored Bits Table 3. Select a serial port. The Mirrored Bits form appears. 1 2 3 4 5 6 7 8 Figure 98: Mirrored Bits Form 1. Port Box 2. Transport Box 8. Reload Button 4. 3. Loc Port Box 4. Rem Port Box 5. IP Address Box 6. Link Stats Options 7.
PAGE 155
RUGGEDCOM ROS Chapter 5 User Guide Parameter Setup and Configuration Description For an incoming TCP connection (server), the local interface IP address on which to listen for connection requests. An empty string implies the default: the IP address of the management interface. When both outgoing and incoming connections are enabled (client or server), this is the remote IP address to which to place an outgoing TCP connection request or from which to accept an incoming request.
PAGE 156
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 3 4 5 6 7 8 9 11 10 12 Figure 100: Telnet Com Port Form 1. Port Box 2. Pack Char Box 3. Pack Timer Box 4. Pack Size Box 5. Flow Control Options 6. Call Dir List Box 8. Rem Port Box 9. IP Address Box 10. Link Stats Options 11. Apply Button 12. Reload Button 4. 7.
PAGE 157
RUGGEDCOM ROS Chapter 5 User Guide Parameter Setup and Configuration Description • to place an outgoing connection or • to place outgoing connection and wait for incoming (both directions). Loc Port Synopsis: 1024 to 65535 Default: 50000 The local IP port to use when listening for an incoming connection. Rem Port Synopsis: 1 to 65535 Default: 50000 The remote TCP port to use when placing an outgoing connection. This parameter is applicable only to TCP transport. IP Address Synopsis: ###.###.###.
PAGE 158
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Figure 101: Remote Table If remote hosts have not been configured, add hosts as needed. For more information, refer to Section 5.4.16.2, “Adding a Remote Host”. Section 5.4.16.2 Adding a Remote Host To add a remote host for the Raw socket protocol, do the following: 1. Navigate to Serial Protocols » Configure Protocols » Configure Raw Socket » Configure Remote Hosts. The Remote Hosts table appears. Figure 102: Remote Table 2.
PAGE 159
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Parameter Description IP Address Synopsis: ###.###.###.### where ### ranges from 0 to 255 Default: The IP address of the remote host. IP Port Synopsis: 1 to 65535 or { Unknown } Default: 50000 The IP port that remote host listens to. If this is zero (Unknown), the unit only receives from the remote host but does not transmit to it.
PAGE 160
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide 1 2 3 4 6 5 Figure 105: Remote Form 1. IP Address Box 3. 2. IP Port Box 3. Port(s) Box 4. Apply Button 5. Delete Button 6. Reload Button Click Delete. Section 5.4.17 Managing Device Addresses The following sections describe how to configure and manage device addresses: • Section 5.4.17.1, “Viewing a List of Device Addresses” • Section 5.4.17.2, “Adding a Device Address” • Section 5.4.17.3, “Deleting a Device Address” Section 5.4.17.
PAGE 161
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration If device addresses have not been configured, add addresses as needed. For more information, refer to Section 5.4.17.2, “Adding a Device Address”. Section 5.4.17.2 Adding a Device Address To add a device address, do the following: 1. Navigate to Serial Protocols » Configure Device Addresses. The Device Address Table table appears. 1 Figure 107: Device Address Table Table 1. InsertRecord 2. Click InsertRecord.
PAGE 162
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Parameter Description Protocol Synopsis: { ModbusServer, ModbusClient, DNP, WIN, TIN, MicroLok } Default: ModbusServer The serial protocol supported on this serial port. Address Synopsis: Any 31 characters Default: The complete address of a device, which might be either local to the RUGGEDCOM device or remote. A local address is one associated with a device connected to a serial port on this device.
PAGE 163
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Figure 109: Device Address Table Table 2. Select the device address from the table. The Device Address Table form appears. 1 2 3 4 5 6 8 7 Figure 110: Device Address Table Form 1. Protocol List 2. Address Box 8. Reload Button 3. 3. Remote IP Address Box 4. Port Box 5. Name Box 6. Apply Button 7. Delete Button Click Delete. Section 5.4.
PAGE 164
Chapter 5 RUGGEDCOM ROS Setup and Configuration User Guide Figure 111: TIN Dynamic Address Table This table displays the following information: Parameter Description Address Synopsis: Any 31 characters The remote device address. Location Synopsis: ###.###.###.### where ### ranges from 0 to 255 The IP Address of the remote host.
PAGE 165
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Parameter Description Protocol Synopsis: { None, RawSocket, ModbusServer, ModbusClient, DNP, DNPRS, WIN, TIN, MicroLok, MirroredBits, PreemptRawSocket, TelnetComPort } The serial protocol supported by devices that create this link. Local Address Synopsis: Any 27 characters The address of the device connected to the serial port on this device.
PAGE 166
Chapter 5 RUGGEDCOM ROS Setup and Configuration Parameter User Guide Description The number of packets transmitted on the connection. Section 5.4.21 Viewing Serial Port Statistics To view statistics for serial ports, navigate to Serial Protocols » View Serial Port Statistics. The Serial Port Statistics table appears.
PAGE 167
RUGGEDCOM ROS Chapter 5 User Guide Setup and Configuration Parameter Description The number of Overrun Errors. Section 5.4.22 Clearing Statistics for Specific Serial Ports To clear the statistics collected for one or more serial ports, do the following: 1. Navigate to Serial Protocols » Clear Serial Port Statistics. The Clear Serial Port Statistics form appears. 1 2 Figure 115: Clear Serial Port Statistics Form 1. Port Check Boxes 2. Confirm Button 2. Select one or more serial ports. 3.
PAGE 168
RUGGEDCOM ROS User Guide Resetting Serial Ports Chapter 5 Setup and Configuration 156
PAGE 169
RUGGEDCOM ROS Chapter 6 User Guide Troubleshooting Troubleshooting This chapter describes troubleshooting steps for common issues that may be encountered when using ROS or designing a network. It describes the following tasks: IMPORTANT! For further assistance, contact a Customer Service representative. • Section 6.1, “General” Section 6.1 General The following describes common problems.
PAGE 170
RUGGEDCOM ROS User Guide General Chapter 6 Troubleshooting 158