Remote RMC-700 and Remote RMM-800. Version 6.4x. Configuration Guide CONFIGURATION GUIDE WESTELL.COM. Westell Technologies Part # Rev A

Transcription

1 Remote RMC-700 and Remote RMM-800 Version 6.4x Configuration Guide CONFIGURATION GUIDE Westell Technologies Part # Rev A

2 Copyright 2016 by Westell, Inc. All Rights Reserved. Westell, Kentrox, Optima Management System, and Optima Prime are registered trademarks of Westell. All other names are trademarks of their respective owners. Information is correct at time of publication and is subject to change without notice. Contact Westell in Aurora,IL, to verify current product information. Westell, Inc. is an Equal Opportunity/Affirmative Action employer. Westell, Inc. 750 North Commons Drive Aurora, IL USA Toll Free: (800) International: +1 (630) Fax: +1 (630) Page 1-2

3 Table of Contents Preface Preface-i About this Document... Preface-i Document Conventions... Preface-ii Cautions and Warnings... Preface-iv Customer Assistance... Preface-v Chapter 1: Product Overview Remote Product Overview Summary of Remote Functions Remote Features Remote RMC-700 Hardware Configuration Remote RMM-800 Hardware Configuration Remote Products Specification Summary Chapter 2: Getting Started Accessing the CLI Using a Local Connection Setting Up the Initial Remote RMM-800 or Remote RMC-700 Configuration Accessing the CLI Using a Remote Connection Accessing the Web Interface TABLE OF CONTENTS Chapter 3: Configuring Users in the CLI Adding a New User Enabling the Strong Password Feature Changing a User Password Configuring Concurrent Login Limits Page TOC-1

4 Table of Contents Deleting a User Creating a Custom Profile Chapter 4: Saving and Applying Configurations Saving the Running Configuration Applying Configuration Fragments to an Existing Configuration File Restoring Factory Defaults Restoring Basic Network Settings Chapter 5: Configuring Network Setup Parameters Configuring the Domain Name, DNS Servers and IP Forwarding Configuring an IPv6 Address Configuring NAT Configuring NTP Configuring System Clock Settings Configuring Default Settings Configuring Custom System Clock Settings Configuring a Timezone Definition File Configuring RAS Settings Configuring SNMP Chapter 6: Understanding Controllers and Interfaces Controller Descriptions Bridge Controllers Ethernet Controllers OpenVPN Controllers Serial Controllers Interface Descriptions Bridge Interfaces Ethernet Interfaces OpenVPN Interfaces Serial Interfaces Chapter 7: Configuring a Site VPN Connection Getting Started Configuration Requirements Optima Redirect Configuration Example Configuring the Site LAN Configuring the Site VPN Verifying the VPN Connection from the Client Page TOC-2

5 Remote RMX-3200 Version 6.4x Configuration Guide Table of Contents: Chapter 8: Configuring Static Routes Adding an IPv4 Static Route to the IP Routing Table Adding a Default IPv4 Static Route to the IP Routing Table Adding an IPv6 Static Route to the IP Routing Table Adding a Default IPv6 Static Route to the IP Routing Table Chapter 9: Configuring a Wireless Network Getting Started Wireless Network Overview Initial Setup Configuring the Wireless Modem Configuring an LTE Modem Configuring an HSPA or EvDO Modem Configuring the VPN Chapter 10: Configuring Actions, Events and Responses Overview Event Components Response Components Action Components Configuring an Event, Response and Action Chapter 11: Configuring Technician Laptop Access Configuration Overview Assigning IP Addresses to Technician Laptops Configuring IPTables for Network Address Translation Chapter 12: Configuring Event Correlations Overview Event Correlation Components Correlation Expression Components Originator Types and States Operators Expression Evaluation Configuring a Time Period (Optional) Configuring an Event Correlation Chapter 13: Configuring Alarm Entries in the Central Alarm Table Overview Alarm Protocol Formats Raw Page TOC-3

6 Table of Contents SNMP TL Configuring an Alarm Entry for a Temperature Sensor Configuring Analog Input Values Configuring an Alarm Entry for a Discrete Input Configuring an Alarm Entry for a Serial Connection Failure Configuring an Alarm Entry for a Power Supply Failure Configuring an Alarm Entry for a TCP Connection that Goes Down Configuring an Alarm Entry for a Telnet Connection that Comes Up Testing Alarm Table Configurations Chapter 14: Configuring Measurements and the Measurement Table 14-1 Overview Use for Measuring State Transitions and Durations Use with Alarm Table Entries Use with Event Correlations Use with Proxied SNMP NEs Configuring a Measurement Table Entries for Temperature and Humidity Sensors 14-5 Sample Configuration for Discrete Analog Temperature Sensor Sample Configuration for SiteBus Temperature Sensor Sample Configuration for SiteBus Combined Temperature and Humidity Sensor 14-8 Configuring an Alarm Entry for a Measurement Configuring a Measurement Table Entry for State Transitions and Durations Configuring an Event Correlation for a Measurement Chapter 15: Configuring Mediation Connections Overview Secure Terminal Server Access Terminal Server User Access TACACS+ Configuration Configuring a TCP to Asynchronous Serial Connection Configuring a Telnet to Asynchronous Serial Connection Configuring a SSH to Asynchronous Serial Connection Configuring an Asynchronous Serial to Asynchronous Serial Connection Configuring an Asynchronous Serial to TCP Connection Chapter 16: Configuring and Connecting TL1 Infrastructure Overview Configuring a TL1 Multiplexer Configuring a Virtual TL1 NE Configuring the TCP Port for a TL1 Multiplexer Configuring a Telnet Connection to a TL1 Multiplexer Page TOC-4

7 Remote RMX-3200 Version 6.4x Configuration Guide Table of Contents: Configuring a Telnet Connection to a Virtual TL1 NE Chapter 17: Configuring DHCP DHCP Server Overview DHCP Client Support Configuring a DHCP Server Configuring a DHCP Server Subnet Configuring a Host on a DHCP Server Configuring BOOTP/DHCP Relay Configuring DHCP Client Support Chapter 18: Configuring Relay Outputs Overview Configuring the Mediation TL1 Command Configuring TL1 Commands to Control a Relay Output Configuring SNMP to Operate a Relay Output Directly Controlling a Relay Output Chapter 19: Configuring the SNMP Proxy SNMP Proxy Feature Overview SNMP Proxy Configuration Information SNMP Templates SNMP NE SNMP Manager Configuring a Mediation SNMP Event Template Configuring a Mediation SNMP Point Template Configuring a Mediation SNMP NE Template Configuring a Mediation SNMP Measurement Template Configuring a Mediation SNMP Network Element Configuration Results Chapter 20: Configuring Jobs Job Configuration Overview Script Package Components Installing a Script Package Configuring a Job with a Script Package and Script Configuring a Job with a Job Property Configuring a Job with a Job Task Configuring Job Start Times Configuring Dynamic Memory for a Job Viewing Job Information on the Remote Web Interface Page TOC-5

8 Table of Contents Chapter 21: Configuring Modules Module Configuration Overview Configuring Modules Using Command Line Interface Installing Modules Enabling an Optional Application Realizing and Configuring Network Elements Configuring an NE Set Initiating a Control Action Configuring Modules Using Web Interface Installing Modules Realizing and Configuring Network Elements Configuring an NE Set Configuring Discrete Inputs with the Remote Web Interface Chapter 22: Configuring the Peripheral Management Subsystem Peripheral Management Subsystem Overview RMB-1 Peripheral Unit RMB-2 Peripheral Unit Expansion Peripheral Unit Discovery Expansion Peripheral States Configuring Remote RMM-800 or Remote RMC-700 to Manage an Expansion Peripheral 22-7 Configuring Discrete I/O Points on an Expansion Peripheral Configuring Alarms for an Expansion Peripheral Configuring SiteBus Devices for an Expansion Peripheral Disconnecting a Managed Expansion Peripheral Chapter 24: Configuring SiteBus Devices Configuring SiteBus Devices Chapter 25: Using Configuration Wizards Configuration Wizard Overview Using the initsetup Wizard Using the bistate-alarms Wizard Using the serial-port Wizard Chapter 26: TL1 Commands Overview Default TL1 VNE Commands ACT-USER ALW-MSG-ALL CANC-USER Page TOC-6

9 Remote RMX-3200 Version 6.4x Configuration Guide Table of Contents: RTRV-ALM-ALL RTRV-ALM-DS RTRV-ALM-EC RTRV-ALM-ENV RTRV-ALM-EQPT RTRV-ALM-OC RTRV-ALM-T RTRV-HDR Unsupported TL1 Commands Appendix A: Backing Up and Restoring the Remote Configuration. Appendix-1 Backing Up the Configuration... A-2 Restoring the Configuration... A-3 Appendix A: Command Identifications... A-1 Glossary... Glossary-1 Index... Index-1 Copyrights and License Statements... Copyrights-1 Page TOC-7

10 Table of Contents Page TOC-8

11 Preface About this Document This document explains how to configure and operate the Remote RMC-700 and Remote RMM-800 intelligent site management devices. Remote RMC-700 and Remote RMM-800 system administrators should have a working knowledge of their networks and the devices and protocols being used with Westell s Kentrox Remote devices. PREFACE Additional information on all CLI commands is presented in the Remote RMC-700 and Remote RMM-800 Command Reference Guide. Instructions on use of the Remote RMC-700 and Remote RMM-700 web interfaces are in the Kentrox Remote Web Interface User Guide. Page Preface-i

12 Preface: Document Conventions Table 1 describes the text conventions used in this document. Table 1 Document Conventions Convention Screen Text, Menu Items, System Prompts, Messages and Reports Static Command Text Variable Command Text Meaning This style indicates Kentrox configuration screen text, menu items, system prompts, messages, and reports. In a command statement, this style indicates text that should be entered exactly as shown at a command line. In a command statement, this style indicates user-specified text.... In a command statement, ellipses (...) signify that the preceding parameter can be repeated a number of times. [ ] [ ] In a command statement, square brackets indicate an optional parameter. Two or more parameters in square brackets with a vertical bar ( ) between them indicate a choice of optional parameters. { } In a command statement, two or more parameters in braces with a vertical bar ( ) between them indicate a choice of required parameters. Menus and Menu Commands Dialog Boxes, Tabs, Fields, Check Boxes, and Command Buttons Variable Field Text KEYS This style indicates menu and menu commands. A right arrow ( > ) separates the menus from the submenus or menu commands. The right arrow also indicates the order in which you should click the menus, submenus, and menu commands. This style indicates dialog boxes, tabs, fields, check boxes, and command buttons. This style indicates variable information you type in a dialog box field. Uppercase body text indicates keys on a keyboard, such as the TAB or ENTER keys. Keys used in combination are connected with a plus symbol (+). Page Preface-ii

13 Preface: Table 1 Document Conventions (Continued) Labels Note: Important: Tip: This style designates physical components on Kentrox products such as jumpers, switches, and cable connectors. Note messages emphasize or supplement important points of the main text. Important messages provide information that is essential to the completion of a task. Tip messages provide information that assists users in operating equipment more effectively. Page Preface-iii

14 Preface: Cautions and Warnings Electrostatic Discharge Caution CAUTION: Kentrox equipment and its peripherals contain electrostatic sensitive components. Proper handling, shipping, and storage precautions must be exercised: Ground Caution You must remove and install cards in a static-free environment. Wear an antistatic wrist strap that is plugged into the Kentrox equipment so you are grounded at the same point as the equipment. Do not remove cards from their antistatic plastic bags until you are ready to install them into the chassis. Immediately after you remove a card from the chassis, you must insert it into its antistatic bag. When the cards are not in use, keep them in their antistatic plastic bags. Do not ship or store cards near strong electrostatic, electromagnetic, or radioactive fields. CAUTION: For Kentrox equipment to operate safely and correctly, there must be a safety ground strap between the equipment ground bolts and the office ground. FCC Warning The Federal Communications Commission has set limits for emitted radio interference, and Remote RMC-700 is constructed with this electromagnetic interference (EMI) limitation in mind. Remote RMC-700 is classified under FCC regulations as a Class A device, that is, a device for use in commercial environments and not in residential areas. This device has been tested and shown to comply with the following FCC rule: Part 15 Subpart J. Operation of this equipment in a residential area may cause interference to radio and TV reception, requiring the user to take whatever steps are necessary to correct the interference. Information is available from the FCC describing possible corrective actions. To maintain low EMI levels, we suggest that you use only metal connectors and shielded cable grounded to the frame. Specifications are subject to change without notice. Page Preface-iv

15 Preface: Customer Assistance All customers, partners, and resellers who have a valid Westell Support and Services Agreement have complete access to the technical support resources. Pre-sales Support Westell offers pre-sales technical support from 9 a.m. to 5 p.m. Eastern time, Monday - Friday. Representatives are standing by to assist with customer account information and product ordering and answer questions regarding Westell products and solutions. Phone number: , option 1 Before you call or Before you contact Westell for assistance, please have the following information available: The versions of hardware and software you are currently running The error number and exact wording of any messages that appeared on your screen What happened and what you were doing when the problem occurred How you tried to solve the problem Technical Support support is available. You may send at any time during the day; however, responses will be provided only during normal business hours, in accordance with your Service and Support Agreement. To contact Technical Support, send to: support@westell.com Telephone Technical Support Available to qualified Westell customers or partners who have not been able to resolve their technical issue by using our online services. To qualify for support, you must have a valid Support and Services Agreement. Phone number: , option 2 Normal Business Hours: 8 a.m. to 6 p.m. Eastern time After-Hours Support: Available to qualified customers who are experiencing serviceaffecting outages that cannot wait until the next business day. To qualify for after- Page Preface-v

16 Preface: hours support, you must have a valid 24x7 Support and Services Agreement. Call the number above, option 2, and follow the prompts for after-hours service. Product Documentation You can also access and view the most current versions of Kentrox product documentation on our Web site at: Page Preface-vi

17 Product Overview This chapter provides a high level overview of the Remote product features and functionality. In addition, the hardware architecture and components of the Remote RMC-700 and Remote RMM-800, including expansion units and peripherals, are described. Guide to this Chapter Remote Product Overview Remote RMC-700 Hardware Configuration CHAPTER 1 Remote RMM-800 Hardware Configuration Page 1-1

18 Chapter 1: Product Overview: Remote Product Overview Remote Product Overview Westell s Kentrox Remote suite of products includes Remote RMX-3200, Remote RMM-1400, Remote RMM-800, and Remote RMC-700. These models provide various features. In general, the Remote products are monitoring and control devices that provide IP management connectivity to remote sites, including environmentally hardened locations. An integral part of Westell s Kentrox Optima Management System, the Remote products reside at the network s remote locations and connect to each element via a wide variety of interface options. The Remote products perform protocol mediation and interface conversion, collect alarms and monitoring data, and support bidirectional management control with the Optima Management Portal via Ethernet, T1/E1, or wireless communication options. Together, Remote and the Optima Management Portal provide detailed monitoring, remote control and management for virtually all remote site devices. Figure 1-1 depicts the Remote and Optima Management Portal functionality. Figure 1-1 Remote and Optima Integration for Remote Site Management Page 1-2

19 Chapter 1: Product Overview: Remote Product Overview Summary of Remote Functions The Remote product functions include: Compatibility with Optima Management Portal or any standard SNMP-based management system Intelligent connectivity to remote network elements Powerful event-response subsystem Custom application extension support Security and network access control Remote Features All Remote products include the following features:discrete and analog input alarm mediation and reporting Operations Support Systems (OSS) to relay output mediation Aggregation of performance data Mediation between OSS equipment and network elements Scripts designed for performing corrective actions on monitored equipment Page 1-3

20 Chapter 1: Product Overview: Remote RMC-700 Hardware Configuration Remote RMC-700 Hardware Configuration Figure 1-2 shows the Remote RMC-700 base unit, which consists of the following connectors and counts: 2 Ethernet ports provide for connections into a network. 2 serial ports provide connectivity to any asynchronous device.12 discrete ports, 1 analog input, and 1 control output. 1 SiteBus One-Wire Interface allowing up to 12 One-Wire sensors Diversity SMA Female Cellular/PCS Antenna Tx/Rx SMA Female Cellular/ PCS Antenna SiteBus Connection 2 Serial Ports 2 Ethernet Ports 12 Discrete Ports Relay Analog Input Battery Input DC Power Input Figure 1-2 Remote RMC-700 Base Unit Page 1-4

21 Chapter 1: Product Overview: Remote RMM-800 Hardware Configuration Remote RMM-800 Hardware Configuration Figure 1-3 shows the Remote RMM-800 base unit, which consists of the following connectors and counts: 4 Ethernet ports provide for connections into a network. 2 serial ports provide connectivity to any asynchronous device. 16 discrete ports, 1 analog input, and 1 control output. 1 SiteBus One-Wire Interface allowing up to 12 One-Wire sensors Unit Status LEDs 2 SFP Ports 10/100/ Ethernet Ports 10/100/1000 Console Port Tx/Rx SMA Female Cellular PCS Antenna Diversity SMA Female Cellular/PCS Antenna Chassis Ground Connections LINK + ACT LEDs 2 Asynch Serial Ports SiteBus Connection 16 Discrete Ports Relay Analog Input DC Power Inputs A & B Figure 1-3 Remote RMM-800 base unit Page 1-5

22 Chapter 1: Product Overview: Remote Products Specification Summary Remote Products Specification Summary Table 1-1 summarizes the number and types of ports, outputs and inputs for the Remote RMC-700 and Remote RMM-800. Table 1-1 Product Specifications Summary Product Async Ports Console Ports Ethernet Ports Discrete Outputs Control Outputs Analog Inputs Remote RMC Remote RMM Page 1-6

23 Getting Started This chapter provides information on getting started with Remote RMM-800 or Remote RMC-700. Step-by-step scenarios describe how to access the CLI, set up the initial configuration and access the web interface. Guide to this Chapter Accessing the CLI Using a Local Connection Setting Up the Initial Remote RMM-800 or Remote RMC-700 Configuration CHAPTER 2 Accessing the CLI Using a Remote Connection Accessing the Web Interface Page 2-1

24 Chapter 2: Getting Started: Accessing the CLI Using a Local Connection Accessing the CLI Using a Local Connection In this scenario, you will: Connect and log into Remote RMM-800 or Remote RMC-700 (optional) Access help information Note: When a new Remote RMM-800 or Remote RMC-700 is booted for the first time, it does not have a configured IP address. As a result, the initial configuration for Remote RMM-800 or Remote RMC-700 must be performed onsite using the console port. For information about configuring an IP address for remote logins, refer to Setting Up the Initial Remote RMM- 800 or Remote RMC-700 Configuration on page 2-4. To access the CLI using a local connection (using Kickstart): 1. If you haven t already done so, install Kentrox Redirect software on your laptop or PC. When the installation is complete, Kentrox Redirect and Kentrox Kickstart icons appear on your desktop. 2. Use a standard CAT5 Ethernet cable (such as Kentrox part number CAB182-10) to connect the PC or laptop to an Ethernet port on Remote RMM-800 or Remote RMC Launch Kentrox Kickstart. Kickstart discovers the Remote RMM-800 or Remote RMC-700 device, as shown below (RMM-1400 shown - Remote RMC-700 and Remote RMM-800 are similar). Note: If the Remote RMM-800 or Remote RMC-700 device is not discovered within one minute, select Help > About in Kentrox Kickstart, then click the Network Troubleshooting Guide link for instructions. 4. Click SSH Terminal (or select Tools > Connect > SSH Terminal). An SSH window opens, displaying the Remote RMM-800 or Remote RMC-700 login prompt. 5. At the login prompt, enter your user name: Page 2-2

25 Chapter 2: Getting Started: Accessing the CLI Using a Local Connection admin 6. At the password prompt, enter your password: password Notes: Passwords are case-sensitive. admin is the default user name and password is the default password. Remote RMC-700 and Remote RMM-800 allow you to log in only five times using the default password. On your sixth login, Remote RMM-800 or Remote RMC-700 will prompt you to change the default password to a new password. The main CLI prompt displays. loginas: admin / / \ _ \ / \ \ \ / / / / \ \ (_) -- \ \/ / ( \ \ _ / ( ) ) ( \ \ \ \ \ -- / /\ \ _ \_\ _ \_ _ _ \_\ \ / /_/ \_\ Remote RMC-700 Using keyboard-interactive authentication. Password: You have 4 grace logins remaining using the default user password. You can create initial network connectivity settings and user accounts by running this command: config use-wizard initsetup (Kentrox)> 7. (optional) Access help information: help or? Note: For more information on using the CLI, refer to section CLI Overview in the Remote RMC-700 and Remote RMM-800 Command Reference Guide. Page 2-3

26 Chapter 2: Getting Started: Setting Up the Initial Remote RMM-800 or Remote RMC-700 Configuration Setting Up the Initial Remote RMM-800 or Remote RMC- 700 Configuration In this scenario, you will: Configure a new user with a supervisor profile Configure the login banner Configure a CLI session timeout Configure a hostname Configure an IP address for remote logins Configure a default route (gateway) To set up the initial Remote RMM-800 or Remote RMC-700 configuration: 1. At the main prompt, add user janedoe and assign the supervisor profile: config users add janedoe supervisor 2. At the password prompt, enter the password mypassword. For security purposes, the characters that you enter do not display, but appear as asterisks as shown below: ********** 3. When prompted to confirm, re-enter the password. Again, the characters that you enter appear as asterisks: ********** 4. Configure a banner with # as the delimiting character: config banner # The following message displays: Enter the banner text. End the banner with a # character. 5. Configure the banner with display text This is my banner and the current date and time: This is my banner. \d \t # The prompt re-displays. Page 2-4

27 Chapter 2: Getting Started: Setting Up the Initial Remote RMM-800 or Remote RMC-700 Configuration 6. Configure the CLI session timeout as 20 minutes: config timeout Configure the host name as Dub: config hostname Dub 8. Configure the IP address. Note: The Remote RMC-700 and Remote RMM-800 support IPv4 and IPv6 and provide the ability to configure both IP protocols at the same time. Refer to Configuring Network Setup Parameters for more information on how to configure an IPv6 address. For this scenario, use IP address and subnet mask : config interface bridge switch ip address Note: The bridge switch interface forwards IP packets to the switched Ethernet ports. You must assign an IP address to allow remote access to Remote RMM-800 or Remote RMC-700. This IP address is the primary Remote RMM-800 or Remote RMC-700 IP address. 9. Add a default route with gateway address : config ip route default Note: Refer to the remote access configuration commands in the Remote RMC- 700 and Remote RMM-800 Command Reference Guide for more information. 10. (optional) Verify that the user environment has been set up properly: running-config The command response displays similar to the following: Page 2-5

28 Chapter 2: Getting Started: Setting Up the Initial Remote RMM-800 or Remote RMC-700 Configuration (Dub)>running-config # Product: Remote RMC # Version: 5.20# Created: ,12:25:00.0, 0000 # User: janedoe # Stage2 Version: 1.00 config banner # This is my banner. \d \t # config hostname Dub config ip route default config timeout 20 config users add janedoe supervisor - e$6$cezdpzpb25a7nbk8$9on8gqa9q7ev4yi6cs2vjcmn6 na31pba7wm/qksvatxpgvbz3v85cw3naklo7fq.xrp8zazmzzsgmrqdvcvet/ - e$6$cezdpzpb25a7n bk8$9on8gqa9q7ev4yi6cs2vjcmn6na31pba7wm/qksvatxpgvbz3v85cw3naklo7fq.xrp8zazmzzs G mrqdvcvet/ config interface bridge switch ip address /16 (Dub)> Notes: The preceding example was obtained using a supervisor profile, which displays the entire configuration; users with management and status profiles can view limited configuration data. The -e preceding the encrypted text indicates that the password and password confirmation have been encrypted. 11. Save the configuration. (Refer to Saving the Running Configuration on page 4-2.) Page 2-6

29 Chapter 2: Getting Started: Accessing the CLI Using a Remote Connection Accessing the CLI Using a Remote Connection In this scenario, you will connect and log into Remote RMM-800 or Remote RMC- 700 remotely using an SSH connection. To access the CLI using a remote connection: 1. Use a PC or laptop with terminal emulation software to connect to Remote RMM- 800 or Remote RMC-700. For information on operating your particular terminal emulation software, refer to the documentation provided with the program. 2. Set up your terminal emulation software to connect using an SSH connection. Note: Individual procedures for making this connection will vary based on the type of software you are using. 3. Enter the IP address of the Remote RMM-800 or Remote RMC-700 to which you want to connect. 4. At the login prompt, enter your user name: janedoe 5. At the password prompt, enter your password: mypassword Notes: Passwords are case-sensitive. admin is the default user name and password is the default password. Remote RMM-800 or Remote RMC-700 let you log in only five times using the default password. On your sixth login, Remote RMM-800 or Remote RMC-700 will prompt you to change the default password to a new password. Page 2-7

30 Chapter 2: Getting Started: Accessing the Web Interface Accessing the Web Interface From the Remote RMM-800 or Remote RMC-700 web interface, you can perform the following functions: Enable/disable alarm test mode Save or restore system configuration View system log Manage jobs, packages and scripts Display system information including version number Manage and configure Modules and Applications Before you can access the Remote RMM-800 or Remote RMC-700 web interface you must configure the IP address. For more information, refer to Setting Up the Initial Remote RMM-800 or Remote RMC-700 Configuration on page 2-4. Important: If using the HTTPS protocol and accessing the web interface for the first time, an error page will display indicating that there is a problem with the website's security certificate. Click Continue to this website to accept the security certificate and continue with the acceptance options as prompted. In this scenario, you will open a Web browser and access Remote RMM-800 or Remote RMC-700 using a specific IP address. To access the Remote RMM-800 or Remote RMC-700 web interface: 6. Open a Web browser. 7. In the URL address field, enter the Remote RMM-800 or Remote RMC-700 IP address: The login window displays. 8. Enter your user name: janedoe 9. Enter your password: mypassword The web interface opens to the Home page, refer to Figure To display the system information, click the System button on the left side of the screen or click the System Info link. Page 2-8

31 Chapter 2: Getting Started: Accessing the Web Interface Figure 2-1 Remote RMC-700 web interface Home Page Page 2-9

32 Chapter 2: Getting Started: Accessing the Web Interface Page 2-10

33 Configuring Users in the CLI This chapter provides step-by-step scenarios on how to configure users. Guide to this Chapter Adding a New User Enabling the Strong Password Feature Changing a User Password Configuring Concurrent Login Limits CHAPTER 3 Deleting a User Creating a Custom Profile Page 3-1

34 Chapter 3: Configuring Users in the CLI: Adding a New User Adding a New User In this scenario, you will add a new user. To add a new user: 1. At the main prompt, add a new user with user name johndoe and assign profile status: config users add johndoe status 2. At the password prompt, enter the new password. Note that the characters that you enter do not display, but display as asterisks: ********** 3. When prompted to confirm, enter the same password. Again, the characters that you enter display as asterisks: ********** Notes: User names and passwords are case-sensitive. The Remote user name must begin with an alphanumeric character, which can be followed by alphanumeric, underscore, and hyphen characters. Available profiles are status, management, supervisor, and restricted. For more information on these profiles, refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide. 4. (optional) Verify that the new user has been added properly: show users The command response displays similar to the following: (Dub)>show users Login Name Profile 1. janedoe supervisor 2. johndoe status 3. test supervisor (Dub)> 5. Save the configuration. Page 3-2

35 Chapter 3: Configuring Users in the CLI: Enabling the Strong Password Feature Enabling the Strong Password Feature The strong password is an optional security feature that enforces additional validations on new or changed user passwords. The password validations apply to passwords entered for local users only. RAS users will use rules enforced by the Radius or TACACS+ server. The strong password feature is disabled by default. In this scenario, you will: Enable the strong password feature. Change an existing user password. To enable the strong password feature: 1. At the main prompt, enable the strong password: config users strong-password enable 2. (optional) Verify that the strong-password feature is enabled: show users The command response displays similar to the following: (Dub)>show users Strong Password Support: enabled Login Name Profile 1. bob restricted 2. ebh restricted 3. jeff status 4. tech management 5. test supervisor (Dub)> 3. Change the existing password for user ebh. The following example shows the additional restrictions of the strong password feature. (Dub)>config users password ebh Please enter the new password. ******** Please confirm the new password. ******** [ATHM0029] Password must contain at least one character from three of the following types: upper-case, lower-case, numerical, and special punctuation. (Dub)>config users password ebh Please enter the new password. ********* Please confirm the new password. ********* (Dub)> Page 3-3

36 Chapter 3: Configuring Users in the CLI: Changing a User Password Changing a User Password In this scenario, you will change the password for an existing user. To change a user password: 1. At the main prompt, change the password for user johndoe to oldguy: config users password johndoe The following message displays: Please enter the new password. 2. Enter the new password: oldguy Note: Passwords are case-sensitive and display as asterisks (*) on the screen as you type them. The following message displays: Please confirm the new password. 3. Re-enter the new password. oldguy Note: Passwords always display in an encrypted format within the system. There is no way to verify that the user password has been changed. 4. Save the configuration. Page 3-4

37 Chapter 3: Configuring Users in the CLI: Configuring Concurrent Login Limits Configuring Concurrent Login Limits In this scenario you will limit a specified user s maximum number of concurrent logins, verify the limit, and remove the limit. System administrators can specify login limits for Remote users.users with this limit configured will have a maximum number (up to 10) of concurrent logins into the Remote, including access to the Remote s Console, Web UI, Telnet, SSH, FTP, and SFTP interfaces. The default user login limit will be set to no limit. To set the login limit at 10 for the user test: 1. Enter the command config users limit <username> login <login limit> as follows: config>users limit test login Verify users login limits: show users The login limit displays as shown below: (Dub) show>users Strong Password Support: disabled Login Name Profile 1. diag diagnostic 2. test supervisor Login Limits: User Name Login Limit 1. test 10 (Dub) show> 3. Remove that same user s login limit: config users no limit test Page 3-5

38 Chapter 3: Configuring Users in the CLI: Deleting a User Deleting a User In this scenario, you will delete a user. To delete a user: 1. At the main prompt, delete user johndoe: config users delete johndoe 2. (optional) Verify that the user has been deleted properly: show users The command response displays similar to the following: (Dub)>show users Login Name Profile 1. janedoe supervisor 2. test supervisor (Dub)> Note: If the user has been deleted, it will no longer display in the list of users. 3. Save the configuration. Page 3-6

39 Chapter 3: Configuring Users in the CLI: Creating a Custom Profile Creating a Custom Profile In this scenario, you will: Create a custom user profile to include and exclude specific command sets (IDs) for that profile. Add a user to the newly created custom profile. To configure a custom profile: 1. At the main prompt, configure a new profile with the name tech and privilege level 5 (status): config profile tech priv-lvl 5 2. Configure the base type for the new tech profile as status: config profile tech copy status 3. Include the command sets /config/controller/eth (config controller ethernet) and /config/interface/eth (config interface ethernet) in the tech profile: config profile tech include /config/controller/eth config profile tech include /config/interface/eth Note: For a list of valid command identifications, see Appendix : Command Identifications. 4. Exclude the command set /show/resource-tracking from the tech profile: config profile tech exclude /show/resource-tracking 5. Add user ebh to the newly created tech profile with password technician: config users add ebh tech technician technician 6. (optional) Verify that the custom profile has been configured properly: show profile tech The command response displays similar to the following: (Dub)>show profile tech Name: tech Base Type: status Privilege Level: 5 Command ID /config/controller/eth /config/interface/eth /show/resource-tracking (Dub)> Action include include exclude 7. (Optional) Save the configuration. Page 3-7

40 Chapter 3: Configuring Users in the CLI: Creating a Custom Profile Page 3-8

41 Saving and Applying Configurations This chapter provides information on saving and applying configurations. Guide to this Chapter Saving the Running Configuration Applying Configuration Fragments to an Existing Configuration File Restoring Factory Defaults Restoring Basic Network Settings CHAPTER 4 Page 4-1

42 Chapter 4: Saving and Applying Configurations: Saving the Running Configuration Saving the Running Configuration In this scenario, you will save the running configuration. Note: You should save the configuration each time you make a change that you want to keep. If you reset Remote RMM-800 or Remote RMC-700 without first saving the configuration, any unsaved changes will be lost. To save the configuration, copy the running configuration to the startup configuration: copy running-config startup-config You can also save the running configuration from the Remote web interface as follows: 1. Click the System button on the Display Control tab bar. Select Backup & Restore from the drop-down menu. 2. In the Save Configuration section of the screen, shown in Figure 4-1, either select one of the To: options from the drop-down menu or type a configuration name into the To: field provided. Click Apply. 3. The screen refreshes and confirms your selection. Figure 4-1 The Save Configuration drop-down menu See Accessing the Web Interface on page 2-8 for details. Page 4-2

43 Chapter 4: Saving and Applying Configurations: Applying Configuration Fragments to an Existing Configuration File Applying Configuration Fragments to an Existing Configuration File In this scenario, you will apply a configuration fragment (patch file) to an existing configuration file. This feature lets you apply a group of configuration commands without individually entering each one in the CLI. Patch files are transferred to their own directory on Remote RMM-800 or Remote RMC-700 (/config/patches) with an SFTP utility. Once a patch file is in this directory, the user can show, copy, or erase it using the existing CLI commands. Note: Patches are separated into supervisor and non-supervisor groups. A user with a supervisor profile can read, upload and apply supervisor patches only. Non-supervisor users have a separate set of patches to read, upload and apply. Remote checks user permissions to ensure appropriate safeguards for uploading and applying all patch files. Important: Before you begin this procedure, you must obtain or create a configuration patch file with a.pat extension. Files without this extension cannot be saved in the patch file directory. The patch file cannot have the same name as any configuration file already loaded on Remote RMM-800 or Remote RMC-700. To apply a configuration fragment to an existing configuration file: 1. Using an SFTP utility, transfer the patch file (patch1.pat) to Remote RMM-800 or Remote RMC-700 directory /config/patches. 2. At the CLI prompt, apply patch file patch1 to file running-config: config apply-patch patch1 running-config The individual command lines are displayed as the patch file is applied: (Dub)>config apply-patch patch1 running-config config users add manager1 manage test test config no timeout config ntp disable config clock daylight-savings DST (Dub)> Page 4-3

44 Chapter 4: Saving and Applying Configurations: Restoring Factory Defaults Restoring Factory Defaults In this scenario, you will restore Remote RMM-800 or Remote RMC-700 s factory default settings. Important: When you copy the factory configuration to the running configuration, all configured settings are removed. You need a console port connection to re-establish communications with Remote RMM-800 or Remote RMC It also will be necessary to undertake the steps in Chapter 2: Getting Started. To restore the factory default settings, copy the factory configuration to the running configuration: copy factory-config running-config Page 4-4

45 Chapter 4: Saving and Applying Configurations: Restoring Basic Network Settings Restoring Basic Network Settings In this scenario, you will restore Remote RMM-800 or Remote RMC-700 s basic network settings. These settings are entered in the initsetup wizard. The runningconfig file is now automatically saved to a network-recovery file when the you run the initsetup wizard and apply the output to the running-config file. If the running configuration is lost, users can save file network-recovery to file running-config to restore the initial system configuration. Note: For more information on the initsetup wizard, refer to Using the initsetup Wizard on page To restore the basic network settings, copy the network recovery file to the running configuration: copy network-recovery running-config You can also restore the network settings from the Remote web interface as follows: 1. Click the System button on the Display Control tab bar and select Backup & Restore from the drop-down menu. 2. In the Restore Configuration section of the screen, select network-recovery from the drop-down menu and click Apply. 3. The screen refreshes upon a successful restoration. See Accessing the Web Interface on page 2-8 for details. Page 4-5

46 Chapter 4: Saving and Applying Configurations: Restoring Basic Network Settings Page 4-6

47 Configuring Network Setup Parameters This chapter provides step-by-step scenarios on how to configure network setup parameters for Remote RMM-800 or Remote RMC-700. Guide to this Chapter Configuring the Domain Name, DNS Servers and IP Forwarding Configuring an IPv6 Address Configuring NAT64 CHAPTER 5 Configuring NTP Configuring System Clock Settings Configuring Custom System Clock Settings Configuring a Timezone Definition File Configuring RAS Settings Configuring SNMP Page 5-1

48 Chapter 5: Configuring Network Setup Parameters: Configuring the Domain Name, DNS Servers and IP Forwarding Configuring the Domain Name, DNS Servers and IP Forwarding In this scenario, you will: Configure a domain name Configure a primary and secondary DNS server Enable IP forwarding To configure the IP settings: 1. At the main prompt, configure domain name config ip domain-name 2. Configure the primary DNS server with IP address : config ip name-server Configure the secondary DNS server with IP address : config ip name-server Enable IP forwarding: config ip forward Page 5-2

49 Chapter 5: Configuring Network Setup Parameters: Configuring the Domain Name, DNS Servers and IP Forwarding 5. (optional) Verify that the IP settings have been configured properly: running-config The command response similar to the following displays: ss (Dub)>running-config # Product: Remote RMC # Version: 5.20 # Created: ,12:32:11.0,-0800 # User: test # Bootloader Version 1.00 config banner # This is my banner. \d \t # config hostname Dub config ip domain-name config ip forward config ip name-server config ip name-server config ip route default config timeout 20 config users add janedoe supervisor - e$6$cezdpzpb25a7nbk8$9on8gqa9q7ev4yi6cs2vjcmn6 na31pba7wm/qksvatxpgvbz3v85cw3naklo7fq.xrp8zazmzzsgmrqdvcvet/ - e$6$cezdpzpb25a7n bk8$9on8gqa9q7ev4yi6cs2vjcmn6na31pba7wm/qksvatxpgvbz3v85cw3naklo7fq.xrp8zazmzzs G mrqdvcvet/ config interface bridge switch ip address /16 (Dub)> Tip: You can also use the show ip domain-name, show ip forward and show ip name-server commands to verify the individual IP configurations. 6. Save the configuration. Page 5-3

50 Chapter 5: Configuring Network Setup Parameters: Configuring an IPv6 Address Configuring an IPv6 Address In this scenario, you will configure an IPv6 address. To configure an IPv6 address: 1. Configure interface bridge switch IPv6 address fd10::39:0:0:100/64 config interface bridge switch ipv6 address fd10::39:0:0:100/64 Note: If an IPv6 router is advertising itself on the network, and IPv6 is enabled on the interface, the Remote RMM-800 or Remote RMC-700 may acquire adynamic IPv6 address from the router in addition to the address configured. 2. (Optional) Verify that the interface bridge switch has been configured properly with the IPv6 address: show interfaces bridge Note: The command response will also contain the link-local IPv6 address. The command response similar to the following displays: (Dub)>show interfaces bridge bridge switch system-name=br_switch status=enabled link-state=up address= /16 link-local-address= /16 ipv6 admin-state=enabled oper-state=enabled mode=host address=fc10::39:240:72ff:fe0e:678d/64 valid= sec preferred=604793sec dynamic address=fd10::39:0:0:100/64 valid=forever preferred=forever address=fd::39:0:0:100/64 valid=forever preferred=forever address=fe80::240:72ff:fe0e:678d/64 valid=forever preferred=forever (Dub)> 3. Save the configuration. Page 5-4

51 Chapter 5: Configuring Network Setup Parameters: Configuring NAT64 Configuring NAT64 The Remote RMM-800 or Remote RMC-700 can be configured to allow IPv6 clients to communicate with IPv4 network elements at a site. In this example scenario, the Remote RMM-800 or Remote RMC-700 communicates to the network over IPv6 and is connected to the IPv6 network via Ethernet port 2. The bridge switch is configured with an IPv4 address and is connected to IPv4 network elements at the site. Note: This section addresses configuration within Remote RMM-800 or Remote RMC-700 to use the NAT64 feature. Additional routing configuration within the customer s network is necessary for the NAT64 feature to function correctly. In this scenario, the user will: Remove Ethernet port 2 from the bridge Configure an IPv6 address on the Ethernet 2 interface Enable NAT64 on the Ethernet 2 interface Enable IP forwarding Configure an IPv4 address on the bridge switch interface Enable NAT64 on the bridge switch interface Configure an IPv6 address on the NAT64 controller Configure an IPv4 pool address Configure the mapping between the IPv4 addresses of the Network Elements to the virtual IPv6 addresses Page 5-5 To configure the Remote RMM-800 or Remote RMC-700 for IPv6 by removing Ethernet 2 from the bridge and configuring an IPv6 address to the Ethernet 2 interface: 1. Remove Ethernet 2 from the bridge: config controller ethernet 2 no bridge 2. Configure the Ethernet 2 interface address: config interface ethernet 2 ipv6 address fc10::39:0:0:a27:3214/64 3. Enable NAT64 on the Ethernet 2 interface: config interface ethernet 2 nat64 enable 4. Configure IP forwarding: config ip forward To configure the bridge switch interface with an IPv4 address and enable NAT64: 5. Configure the IPv4 address: config interface bridge switch IP address /24 6. Enable NAT64 on the bridge switch interface:

52 Chapter 5: Configuring Network Setup Parameters: Configuring NAT64 config interface bridge switch nat64 enable To configure the NAT64 controller: 7. Configure the controller s IPv6 address: config controller nat64 ipv6-address fc10::39:0:0:a27:a01 8. Configure the NAT64 controller s IPv4 address pool: config controller nat64 ipv4-pool /24 9. Map the addresses of the IPv4 network elements: config controller nat64 map fc10::39:0:0:a27:321e config controller nat64 map fc10::39:0:0:a27:321f The command response similar to the following displays: (rmc27) show> (rmc27) show>controller nat64 nat64 system-name=nat64 status=enabled link-state=down ipv4-pool= /24 ipv6-address=fc10::39:0:0:a27:a01 Static Map: fc10::39:0:0:a27:321e fc10::39:0:0:a27:321f (rmc27) show> Page 5-6

53 Chapter 5: Configuring Network Setup Parameters: Configuring NTP Configuring NTP In this scenario, you will: Configure a primary and secondary NTP server Configure a minimum and maximum NTP polling interval Enable NTP Note: NTP on Remote RMC-700 and Remote RMM-800 supports both IPv4 and IPv6. To configure system clock parameters using the common clock time maintained by the Remote RMM-800 or Remote RMC-700 NTP server: 1. At the main prompt, configure the preferred NTP server with IP address : config ntp server Tip: The first server configured becomes the preferred server and the second server configured becomes the secondary server, unless indicated otherwise by entering prefer as in step Configure the second NTP server with IP address and set it as the preferred server: config ntp server prefer 3. Define the minimum NTP polling interval as 7 (128 seconds) and maximum NTP polling interval as 12 (4096 seconds): config ntp poll-interval 7 12 Tip: The value for the interval is 2 raised to the power of the value entered. 4. Enable NTP on Remote RMM-800 or Remote RMC-700: config ntp enable Page 5-7

54 Chapter 5: Configuring Network Setup Parameters: Configuring NTP 5. (optional) Verify that the clock parameters have been configured properly: running-config The command response similar to the following displays: (Dub)>running-config # Product: Remote RMC # Version: 5.20 # Created: ,12:32:11.0,-0800 # User: test # Bootloader Version 1.00 config banner # This is my banner. \d \t # config hostname Dub config ip domain-name config ip forward config ip name-server config ip name-server config ip route default config ntp enable config ntp poll-interval 7 12 config ntp server prefer config ntp server config timeout 20 config users add janedoe supervisor - e$6$cezdpzpb25a7nbk8$9on8gqa9q7ev4yi6cs2vjcmn6 na31pba7wm/qksvatxpgvbz3v85cw3naklo7fq.xrp8zazmzzsgmrqdvcvet/ - e$6$cezdpzpb25a7n bk8$9on8gqa9q7ev4yi6cs2vjcmn6na31pba7wm/qksvatxpgvbz3v85cw3naklo7fq.xrp8zazmzzs G mrqdvcvet/ config interface bridge switch ip address /16 (Dub)> Tip: You can also use the show ntp command to verify the NTP configuration. 6. Save the configuration. Page 5-8

55 Chapter 5: Configuring Network Setup Parameters: Configuring System Clock Settings Configuring System Clock Settings Remote RMC-700 and Remote RMM-800 let you configure timezones and daylight savings rules for any location. Three methods are available for configuring timezone and daylight savings settings: Configure a timezone and use the default daylight savings settings. See Configuring Default Settings for details. Configure a timezone and define custom daylight savings settings. See Configuring Custom System Clock Settings for details. Apply daylight savings rules from a timezone definition file. See Configuring a Timezone Definition File for details. Each method has a specific format for configuring a timezone. Depending upon the format used, the daylight savings command will have different usages. Configuring Default Settings In this scenario, you will: Configure the timezone in default mode Enable daylight savings default parameters Configure the local time and date Important: You must disable NTP before you can configure the Remote RMM-800 or Remote RMC-700 system clock locally. To configure default system clock settings: 1. At the config clock prompt, configure the timezone as EST with an offset of -5:00. This puts the daylight savings configuration into default mode: config clock timezone EST -5:00 2. Enable U.S. daylight savings rules and configure the name that displays when daylight savings time is in effect: config clock daylight-savings EDT 3. Configure the local time as 11:22:30 and the local date as 04/09/2010: config clock local-time 11:22:30 04/09/2010 Page 5-9

56 Chapter 5: Configuring Network Setup Parameters: Configuring System Clock Settings 4. (optional) Verify that the clock parameters have been configured properly: show clock The command response similar to the following displays: (Dub)>show clock Fri Apr 9 11:22:30 EDT 2010 Uptime 4 days, 0:17 The timezone is named EST and has an offset of -05:00 GMT. Daylight savings time is named EDT and using default U.S rules. Log timestamps are using GMT. (Dub)> Tip: In the command response for show clock, the name assigned to indicate that daylight savings is enabled will appear in the timestamp during daylight savings. After daylight savings, the name of the configured timezone will appear in the timestamp. 5. Save the configuration. Configuring Custom System Clock Settings If you configure the timezone in custom mode, you can use subcommands to customize the daylight savings parameters. In this scenario, you will: Configure the timezone in custom mode Enable daylight savings in custom mode Configure custom daylight savings time parameters Important: You must disable NTP before you can configure the Remote RMM-800 or Remote RMC-700 system clock locally. To configure custom system clock settings: 1. At the config clock prompt, configure the timezone as EST with an offset of -5:00 and set the daylight savings configuration in the custom mode: config clock timezone custom EST -5:00 Page 5-10

57 Chapter 5: Configuring Network Setup Parameters: Configuring System Clock Settings 2. Set the following custom daylight savings time parameters: (Dub)>config (Dub) config>clock (Dub) config clock>daylight-savings (Dub) config clock daylight-savings ->indicator EDT (Dub) config clock daylight-savings ->start-month march (Dub) config clock daylight-savings ->start-day 23 (Dub) config clock daylight-savings ->start-time 01:00:00 (Dub) config clock daylight-savings ->end-month november (Dub) config clock daylight-savings ->end-time 02:00:00 (Dub) config clock daylight-savings ->save-amount 01:45:00 (Dub) config clock daylight-savings -> 3. (optional) Verify that the clock parameters have been configured properly: show clock The command response similar to the following displays: (Dub)>show (Dub) show>clock Fri Apr 9 14:18:24 EST 2010 Uptime 9 days, 17:48 The timezone is named EST and has an offset of -05:00 GMT. Daylight savings time is named EDT and using custom rules: Starts on 23 of March at 01:00:00, saving 01:45:00. Ends on 23 of November at 02:00:00. Log timestamps are using GMT. (Dub) show> 4. Save the configuration. Page 5-11

58 Chapter 5: Configuring Network Setup Parameters: Configuring System Clock Settings Configuring a Timezone Definition File You can load and apply daylight savings rules to your system from a timezone definition file. A timezone definition file is derived from the public domain timezone database and consists of: Zone entries, which identify the available timezones with their GMT offsets and any applicable rules Rules, which define valid date and time ranges and the amount of time saved. In this scenario, you will: Install the timezone definition file Apply daylight savings rules from the timezone definition file To configure a time zone definition file: 1. Establish an SFTP connection into the system and upload the definition file from your local workstation. A new directory will be added under the config directory with a single file named timezones.def. 2. At the config clock prompt, apply the installed timezone definition file: config clock timezone from-file EST 3. (optional) Verify that the clock parameters have been configured properly: show clock The command response similar to the following displays: (Dub)>show (Dub) show>clock Fri Apr 9 14:18:24 EST 2010 Uptime 9 days, 17:48 The timezone is named EST and has an offset of -05:00 GMT. Daylight savings time is currently active and is saving 01:00. These settings were loaded from the timezone definition file. (Dub) show> 4. Save the configuration. Page 5-12

59 Chapter 5: Configuring Network Setup Parameters: Configuring RAS Settings Configuring RAS Settings In this scenario, you will: Configure the RAS server type Configure the RAS server address and settings Enable RAS accounting Configure the RAS authorization mode Configure the number of times Remote RMM-800 or Remote RMC-700 attempts to connect to the RAS server Configure the RAS timeout period for a remote authentication attempt To configure RAS settings: 1. At the main prompt, configure the RAS server type as tacacs+ with fallback enabled: config ras shell tacacs+ fallback Note: A message displays indicating that the shell type configuration will not take effect until the server is configured. 2. Configure the primary RAS server with the following settings: IP address Port 100 Secret tserver1 Phases accounting, authentication and authorization: config ras server port 100 config ras server secret tserver1 config ras server phase accounting authentication authorization Note: RADIUS and Tacacs+ clients on Remote RMC-700 and Remote RMM- 800 support both IPv4 and IPv6 servers. 3. Enable RAS accounting: config ras accounting enable 4. Configure privilege level RAS authorization: config ras authorization privilege Page 5-13

60 Chapter 5: Configuring Network Setup Parameters: Configuring RAS Settings Note: RAS accounting and authorization take effect only when TACACS+ is configured as the server type. 5. Configure Remote RMM-800 or Remote RMC-700 to make 5 connection attempts to the RAS server before failing: config ras retry 5 6. Configure how long Remote RMM-800 or Remote RMC-700 waits for a response from the RAS server before falling back on local authentication: config ras timeout (optional) Verify that the remote authentication settings have been configured properly: show ras The command response similar to the following displays: (Dub)>show ras Shell RAS option: TACACS+ with Local Fallback RAS Accounting: enabled RAS Authorization: privilege RAS Retry: 5 RAS Timeout: 30 RAS Servers IP Port Secret Phases tserver1 authen author account (Dub)> 8. Save the configuration. Page 5-14

61 Chapter 5: Configuring Network Setup Parameters: Configuring SNMP Configuring SNMP In this scenario, you will: Configure an SNMP version 1 community string Configure an IPv4 SNMP management station Configure an IPv6 SNMP management station for version 2 inform requests Enable authentication trap transfer Enable the SNMP trap queue Configure the priority level on a trap OID Notes: This scenario applies only when an SNMP management system, such as AppliedView, is used to manage Remote RMM-800 or Remote RMC-700. Note: The following management information bases (MIBs) are available for Remote RMC-700 and Remote RMM-800: aimediationv2.mib aiperiphdiscrete.mib aiperipheral.mib aisyscfg.mib aisyscfgconfig.mib aisystem.mib aisysteminv.mib airosetta.mib ktxmeasurement ktxmodule To access the available MIBs for Remote RMM-800 or Remote RMC-700, go to: The above MIBs are listed as MIB - (file name). To configure SNMP: 1. At the main prompt, configure an SNMP version 1 community string named newadministrator and assign read-only access to objects in the MIB: config snmp community public v1 readonly Page 5-15

62 Chapter 5: Configuring Network Setup Parameters: Configuring SNMP 2. Configure a management station with IPv4 address , port number 162 and community string public for sending SNMP traps: config snmp host public v1 3. Configure an IPv6 management station for version 2 inform requests: config snmp host fd10:39:0:0: public v2-inform 4. Enable the sending of authentication traps: config snmp auth-trap enable 5. Enable the SNMP trap queue: config snmp trap-queue enable Notes: The queuing state occurs on an SNMP host when a ping fails and traps are waiting to be sent. The sending state occurs on an SNMP host for all other conditions related to trap queuing. Trap queuing is always enabled for v2-inform type hosts, however ping is not used. Instead, the oldest request in the queue is retried until a response is received. 6. Assign a high priority for a linkdown trap with OID : config snmp trap-queue priority high 7. (optional) Verify that SNMP has been configured properly: show snmp summary The command response similar to the following displays: (Dub)>show snmp summary Authentication traps: enabled Trap queue: enabled Communities: Name User Type Auth Mode administrator v1 noauth readwrite public v1 noauth readonly V3 Users: Username Auth Priv Hosts: IP Address Port Type Auth Community/User Queue v1 noauth public sending fd10::39:0:0: v2-inform noauth public sending Priority: Trap OID Priority high (Dub)> 8. Save the configuration. Page 5-16

63 Chapter 5: Configuring Network Setup Parameters: Configuring SNMP In this scenario, you will: Configure an SNMP version 3 user Configure an SNMP v3 community Configure an SNMP v3 host 1. At the main prompt, configure a v3 user (eric) with md5 authentication (passphrase: ericauthphrase) and des encryption (passphrase: ericprivphrase): config snmp user eric md5 ericauthphrase des ericprivphrase 2. Configure a community (dublinusers)with a v3 user (eric) that has authentication and encryption (priv) with read and write access (readwrite): config snmp community dublinusers v3 user eric priv readwrite 3. Configure a host with the ip address of , port number 2, user name eric, community type v3, with authentication (auth) but no encryption: config snmp host eric v3 auth 4. (optional) Verify that SNMP has been configured properly: show snmp summary The command response similar to the following displays: (Dub)>show snmp summary Authentication traps: enabled Trap queue: disabled Communities: Name User Type Auth Mode administrator v1 noauth readwrite dublinusers eric v3 priv readwrite public v1 noauth readonly v3comm v3user v3 priv readwrite V3 Users: Username Auth Priv eric md5 des v3user md5 aes-128 Hosts: IP Address Port Type Auth Community/User Queue v1 noauth administrator sending v3 auth eric sending Priority: Trap OID Priority (Dub)> Page 5-17

64 Chapter 5: Configuring Network Setup Parameters: Configuring SNMP Page 5-18

65 Understanding Controllers and Interfaces This chapter provides information about controllers and interfaces and how they operate on Remote RMC-700 and Remote RMM-800. Guide to this Chapter Controller Descriptions Interface Descriptions CHAPTER 6 Page 6-1

66 Chapter 6: Understanding Controllers and Interfaces: Controller Descriptions Controller Descriptions A controller is a software object on Remote RMC-700 and Remote RMM-800 that serves as a destination for a data bit stream. It can be a physical device, such as a serial transceiver, or the controller can be a virtual entity. There are four types of controllers that can be configured in the Remote RMM-800 or Remote RMC-700 CLI: Bridge Controllers Ethernet Controllers OpenVPN Controllers Serial Controllers Bridge Controllers There is only one bridge controller on Remote RMC-700 and Remote RMM-800. The controller is named bridge switch because it is a bridge that (by default) includes both of the Ethernet switch ports. This and the next section imply that Ethernet controllers are always on the bridge. Ethernet Controllers There are two Ethernet controllers on every Remote RMC-700 and Remote RMM They represent the two local switched Ethernet ports.both are on the bridge by default, but can be configured to be excluded from the bridge controller. OpenVPN Controllers OpenVPN controllers use the OpenVPN software package to manage VPN connections. The Remote RMC-700 and Remote RMM-800 OpenVPN controllers can be configured for either client mode or site-server mode. An OpenVPN controller in the client mode is used to establish a VPN connection between a Remote RMM-800 or Remote RMC-700 client and the Connect SCS server. This VPN connection provides a secure link between remote sites and the protected customer management network. An OpenVPN controller in the site-server mode establishes a VPN connection between a technician's laptop running the Kentrox Redirect application and a Remote RMM-800 or Remote RMC-700. This VPN connection provides a secure link for accessing network elements at a remote site from the technician's laptop. Serial Controllers Remote RMC-700 and Remote RMM-800 have two asynchronous serial controllers.in addition, Remote RMC-700 and Remote RMM-800 contain a PCI mini card slot for a wireless modem with a USB interface to the processor. Remote RMC-700 and Page 6-2

67 Chapter 6: Understanding Controllers and Interfaces: Controller Descriptions Remote RMM-800 support LTE, EvDO and HSPA modems. The modem is available as serial modem. Page 6-3

68 Chapter 6: Understanding Controllers and Interfaces: Interface Descriptions Interface Descriptions An interface is an entity to which you can route IP packets. Interfaces must be associated with controllers, which may be underlying physical ports. There are four types of interfaces that can be configured in the Remote RMM-800 or Remote RMC- 700 CLI: Bridge Interfaces Ethernet Interfaces OpenVPN Interfaces Serial Interfaces Bridge Interfaces The bridge interface works in conjunction with the bridge controller switch. It is used to bridge Ethernet ports, and initially includes the two switched Ethernet ports. An IP address can be assigned to the bridge switch interface, providing a mechanism to route IP packets to the two switched Ethernet ports and any bridged port on Remote RMM-800 or Remote RMC-700. The IP address assigned to the bridge interface is Remote RMM-800 or Remote RMC-700 s primary IP address. Until this IP address is configured, Remote RMM-800 or Remote RMC-700 cannot be managed remotely via SSH or SNMP. For more information, refer to Setting Up the Initial Remote RMM-800 or Remote RMC-700 Configuration on page 2-4. Ethernet Interfaces Ethernet interfaces are individually configurable on Remote RMC-700 and Remote RMM-800, allowing you to set them up with static routes. By default, Ethernet interfaces are part of the bridge switch. To configure an Ethernet interface with its own IP address, you must first remove it from the bridge switch with the command: config controller ethernet port no bridge Refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide for details on using this command. OpenVPN Interfaces Like Ethernet interfaces, OpenVPN interfaces are individually configurable on Remote RMC-700 and Remote RMM-800. This capability lets users set them up with static routes. The OpenVPN interface can be associated with two types of OpenVPN controller modes, client and site-server. Page 6-4

69 Chapter 6: Understanding Controllers and Interfaces: Interface Descriptions Serial Interfaces Interfaces are not configurable for Remote RMC-700 and Remote RMM-800 s two asynchronous serial ports. However, an interface can be configured for the wireless phone module (serial modem). The modem interface works in conjunction with the serial controller connected to the wireless modem. By configuring an IP address for the modem interface, IP packets can be routed through the modem. Page 6-5

70 Chapter 6: Understanding Controllers and Interfaces: Interface Descriptions Page 6-6

71 Configuring a Site VPN Connection This chapter provides a detailed site VPN configuration example. Also included in this chapter are step-by-step scenarios on how to configure the site LAN, the site VPN and how to establish the VPN from the client using the Remote RMM-800 or Remote RMC-700. Guide to this Chapter Getting Started Configuration Example CHAPTER 7 Configuring the Site LAN Configuring the Site VPN Verifying the VPN Connection from the Client Page 7-1

72 Chapter 7: Configuring a Site VPN Connection: Getting Started Getting Started A major feature of the Remote RMC-700 and Remote RMM-800 is the ability to provide secure remote access to site network elements. A site VPN connection can be temporarily established between a client and the Remote RMM-800 or Remote RMC-700. The Remote RMM-800 or Remote RMC-700 uses the OpenVPN software package to establish the VPN connection. A VPN connection from the client to the site allows IP connectivity without the problems of using port based NAT. A firewall is implemented on the Remote RMM-800 or Remote RMC-700 to restrict the traffic to approved IP addresses and ports at the site. Configuration Requirements The Remote RMC-700 and Remote RMM-800 use an OpenVPN controller instance configured in the site-server mode to establish the site VPN connection from the client. An OpenVPN controller instance in the site-server mode can be used in addition to an OpenVPN controller instance in the client mode for secure wireless backhaul. Optima Optima is a web-based software application that provides complete visibility and control of network infrastructure sites, such as cell sites, substations and remote communication huts and all its systems including power, environmental, security and networking. Optima provides a Remote RMM-800 or Remote RMC-700 connectivity page that displays detailed information (protocol, port and cipher) about the site VPN. Redirect uses the site VPN information passed by Optima to establish the site VPN connection before launching applications to the site network elements. Redirect The Redirect software manages the site VPN connection to the Remote RMM-800 or Remote RMC-700 that enables access to the network elements on the site's private LAN. Redirect bundles OpenVPN client and supporting Kentrox data (e.g. server authentication certificates) to perform the site VPN connection. Redirect supports one VPN connection at a time. To establish a new VPN connection to a different site, Redirect automatically disconnects the previous connection and establishes the new connection. Page 7-2

73 Chapter 7: Configuring a Site VPN Connection: Configuration Example Configuration Example Figure 7-1 provides a detailed example of how the site VPN connection between Client 1 and Remote RMC-700 is configured. This example also applies to Remote RMM-700 and Remote RMM-800. In the following example, both Client 1 and Remote RMC-700 are connected to the Intranet. Redirect on Client 1 uses the IP address of the Remote RMC-700 on the Intranet to establish the site VPN connection to access Site NE 1 and Site NE 2. Figure 7-1 Site VPN Connection between Client 1 and the Remote RMC-700 The site LAN network in this example is /24. The IP address of Site NE 1 is /24. The IP address of Site NE 2 is /24. The IP address of the site VPN interface on the Remote RMC-700 is /24. Page 7-3

74 Chapter 7: Configuring a Site VPN Connection: Configuration Example After the site VPN connection is established between Client 1 and the Remote RMC- 700, the client is assigned a point-to-point (site VPN) IP address /30. The peer s IP address is /30 on the Remote RMC-700. The routes to the site LAN network are pushed to Client 1. These routes are listed in the Routes added box at the top of the diagram. The firewall rules are added based on the allowaccess configurations on the Remote RMC-700 defined by the user. The Remote RMM-800 or Remote RMC-700 must be configured with the IP address, protocol and port number that will be used when making connections from the clients to the site network elements. All other traffic will be blocked by the firewall on the Remote RMM-800 or Remote RMC-700. Page 7-4

75 Chapter 7: Configuring a Site VPN Connection: Configuring the Site LAN Configuring the Site LAN Note: The type of interface to be used for the site LAN must be decided upon before a site VPN connection can be configured. In the following scenario, ethernet port 1 interface is used. In this scenario, you will: Remove the ethernet controller from the bridge group Configure the IP address for the ethernet controller Enable IP forwarding Note: In order to configure the site LAN, first remove the ethernet controller from the bridge group. To configure the site LAN: 1. Remove controller ethernet 1 from the bridge group: config controller ethernet 1 no bridge 2. Configure IP address /24 for ethernet port 3: config interface ethernet 1 ip address /24 3. Enable IP forwarding: config ip forward Page 7-5

76 Chapter 7: Configuring a Site VPN Connection: Configuring the Site VPN Configuring the Site VPN In this scenario, you will: Configure the site VPN controller Configure the interface for client routes Configure the IP address and ports to access over the site VPN Verify the configuration Show the number of clients connected to the site VPN To configure the site VPN: 1. Configure the site VPN controller with instance name site with default cipher, keep-alive, port and protocol. config controller openvpn site mode site-server 2. Configure site interface with IP address /24 config interface openvpn site ip address /24 3. Configure the routes for the site VPN clients to reach the site LAN: config controller openvpn site client-route ethernet 2 Tip: Multiple routes can be added to reach different subnets at the same site by executing the command multiple times for each additional route. 4. Configure the IP addresses and ports of the site NEs to be accessed over the site VPN: config controller openvpn allow-access tcp tcp 443 udp 161 config controller openvpn allow-access tcp tcp 443 udp 161 Notes: By default, the Remote RMM-800 or Remote RMC-700 blocks all traffic to the site LAN. ICMP ping requests and replies are automatically allowed for each IP address specified. 5. Verify the configuration: show controllers openvpn site The command response similar to the following displays: Page 7-6

77 Chapter 7: Configuring a Site VPN Connection: Configuring the Site VPN (Dub)>show controllers openvpn site openvpn site system-name=ovpn_site status=enabled link-state=up mode=site-server protocol=udp port=1194 cipher=blowfish-128 keep-alive-inactive=30 keep-alive-disconnect=120 client-route=ethernet 2 vpn-state=connected, Thu Jan 10 14:00:45 EDT 2013 cert-subject=/c=us/st=oh/o=kentrox, Inc./CN=openvpn token cert-validity-start=wed Oct 10 14:42:32 ex 2012 cert-validity-end=wed Jan 31 17:13:31 EDT 2029 allow-access= tcp tcp 443 udp 161 allow-access= tcp tcp 443 udp 161 (Dub)> 6. Show the number of clients that are currently connected to the site VPN: show controllers openvpn site client-count The command response similar to the following displays: (Dub)>show controllers openvpn site client-count Number of known clients: 0 Number of authenticated clients: 0 (Dub)> Page 7-7

78 Chapter 7: Configuring a Site VPN Connection: Verifying the VPN Connection from the Client Verifying the VPN Connection from the Client The VPN connection between the client and the Remote RMM-800 or Remote RMC- 700 can be established in two ways. The connection can be made by launching an application from Optima or by manually opening a connection from Redirect running on the client computer. In either case, Optima or Redirect must be configured to use the site VPN. Note: Refer to the Optima and Redirect documentation for additional information on how to establish VPN connections. In this scenario, you will: Verify that a client is connected Verify the number of clients that are connected Note: A connection from the client to the Remote RMM-800 or Remote RMC-700 using Optima or Redirect must first be opened before performing the following procedure. To verify that a client is connected: show controllers openvpn site clients The command response similar to the following displays: (Dub)>show controllers openvpn site clients >test addr :1194 virtual-addr= connected=mon Dec 10 13:27:30 EST 2012 rx-bytes=24617 tx-bytes=32053 (Dub)> To verify the number of clients that are connected: show controllers openvpn site client-count The command response similar to the following displays: (Dub)>show controllers openvpn site client-count Number of known clients: 1 Number of authenticated clients: 1 (Dub)> Note: From the client, site NE 1 (IP address ) and site NE 2 ( ) can be accessed using ping, telnet, ssh, http, https or snmp. Page 7-8

79 Configuring Static Routes This chapter provides step-by-step scenarios on how to configure static routes in the IP routing table. Guide to this Chapter Adding an IPv4 Static Route to the IP Routing Table Adding a Default IPv4 Static Route to the IP Routing Table Adding an IPv6 Static Route to the IP Routing Table CHAPTER 8 Adding a Default IPv6 Static Route to the IP Routing Table Page 8-1

80 Chapter 8: Configuring Static Routes: Adding an IPv4 Static Route to the IP Routing Table Adding an IPv4 Static Route to the IP Routing Table In this scenario, you will add an IPv4 static route to the IP routing table. To add an IPv4 static route to the IP routing table: 1. At the main prompt, add an IPv4 static route with destination address , subnet mask length 16 and gateway address : config ip route / (optional) Verify that the IPv4 static route has been added properly: show ip route The command response similar to the following displays: (Dub)>show ip route Destination Gateway Interface Flags / bridge switch Up / * Reject Up / lo Host Up / bridge switch Up (Dub)> 3. Save the configuration. Page 8-2

81 Chapter 8: Configuring Static Routes: Adding a Default IPv4 Static Route to the IP Routing Table Adding a Default IPv4 Static Route to the IP Routing Table In this scenario, you will add a default IPv4 static route to the IP routing table. To add a default IPv4 static route to the IP routing table: 1. At the main prompt, add the default IPv4 static route with gateway address : config ip route default (optional) Verify the default static route has been added properly: show ip route The command response similar to the following displays: (Dub)>show ip route Destination Gateway Interface Flags / openvpn client Up / bridge switch Up / * Reject Up / lo Up Host / bridge switch Up (Dub)> 3. Save the configuration. Page 8-3

82 Chapter 8: Configuring Static Routes: Adding an IPv6 Static Route to the IP Routing Table Adding an IPv6 Static Route to the IP Routing Table In this scenario, you will add an IPv6 static route to the IP routing table. To add an IPv6 static route to the IP routing table: 1. At the main prompt, add an IPv6 static route with destination address fd11:0:0:40::, subnet mask length 64 and gateway address fd10::39:0:0:0:1: config ip route-v6 fd11:0:0:40::/64 fd10::39:0:0:1:1 2. (optional) Verify that the IPv6 static route has been added properly: show ip route The command response similar to the following displays: (Dub)>show ip route Destination Gateway Interface Flags / bridge switch Up / bridge switch Up / * Up Reject / lo Up Host / bridge switch Up fc10:0:0:39::/64 :: bridge switch Up fd10:0:0:39::/64 :: bridge switch Up fd11:0:0:40::/64 fd10::39:0:0:1:1 bridge switch Up fe80::/64 :: bridge switch Up ff00::/8 :: bridge switch Up ff02::fb/128 ff02::fb bridge switch Up ff02::1:ffcb:4e8b/128 ff02::1:ffcb:4e8b bridge switch Up (Dub)> 3. Save the configuration. Page 8-4

83 Chapter 8: Configuring Static Routes: Adding a Default IPv6 Static Route to the IP Routing Table Adding a Default IPv6 Static Route to the IP Routing Table In this scenario, you will add a default IPv6 static route to the IP routing table. To add a default IPv6 static route to the IP routing table: 1. At the main prompt, add the default static route with an IPv6 address fd10::39:0:0:1 config ip route-v6 default fd10::39:0:0:1 2. (optional) Verify the default IPv6 static route has been properly added: show ip route The command response similar to the following displays: (Dub)>show ip route Destination Gateway Interface Flags / bridge switch Up / bridge switch Up / * Up Reject / lo Up Host / bridge switch Up / openvpn site Up Host / openvpn site Up / lo Up Host default fe80::e611:5bff:fecb:4e8b bridge switch Up ::/0 fd10::39:0:0:1 bridge switch Up fc10:0:0:39::/64 :: bridge switch Up fd10::/64 :: bridge switch Up fe80::/64 :: bridge switch Up ff00::/8 :: bridge switch Up ff02::1/128 ff02::1 bridge switch Up (Dub)> Note: If an IPv6 router is advertising itself on the network and IPv6 is enabled on the interface, the Remote RMM-800 or Remote RMC-700 route table may include a route which uses the router s link-local IPV6 address as the default IPv6 static route. 3. Save the configuration. Page 8-5

84 Chapter 8: Configuring Static Routes: Adding a Default IPv6 Static Route to the IP Routing Table Page 8-6

85 Configuring a Wireless Network This chapter provides information about configuring a wireless network with Remote RMM-800 or Remote RMC-700. Guide to this Chapter Getting Started Configuring the Wireless Modem Configuring the VPN CHAPTER 9 Page 9-1

86 Chapter 9: Configuring a Wireless Network: Getting Started Getting Started This section discusses the following topics: Wireless Network Overview Initial Setup Wireless Network Overview Remote RMC-700 and Remote RMM-800 models can be equipped with EvDO, HSPA,or LTE modules.these modules allow users to locate Remote RMM-800s or Remote RMM-700s in areas that do not have traditional WAN connectivity. A wireless Remote RMM-800 or Remote RMC-700 should appear as a wired extension of the management network. The goal is to provide two-way, reliable connections with no restrictions on protocols over the network. The wireless Remote RMM-800 or Remote RMC-700 communicates with the service provider s management network by delivering alarms to it. The management network tries to establish connections to Remote RMM-800 or Remote RMC-700 or to network elements connected to Remote RMM-800 or Remote RMC-700. Initial Setup Users must set up the following configurations for Remote RMM-800 or Remote RMC-700 to operate in a wireless network. To set up the initial configurations: 1. Connect to Remote RMM-800 or Remote RMC-700, log into the CLI and run the initsetup wizard using command config use-wizard initsetup. 2. Configure the standard configuration parameters (such as users, SNMP, networking and time). 3. Verify that Remote RMM-800 or Remote RMC-700 is connected to the management network. Page 9-2

87 Chapter 9: Configuring a Wireless Network: Configuring the Wireless Modem Configuring the Wireless Modem Important: If you use the initsetup wizard to provision the wireless modem, then this procedure is unnecessary. Use of the initsetup wizard is often preferable. Refer to Initial Setup. Configuring an LTE Modem To configure an LTE modem: 1. Enable interface serial modem: config interface serial modem enable 2. Configure a default route that uses the same subnet as the corresponding interface: config controller serial modem defaultroute Note: This command overrides the default route assigned to the Remote RMM- 800 or Remote RMC-700 via command config ip route default. The modem configured with the default route option and command config ip route default are mutually exclusive. You should not have both configured. 3. (optional) Verify that the LTE modem serial interface has been configured properly: show interfaces serial modem The command response similar to the following displays: (RMC107)>show (RMC107) show>interfaces serial modem serial modem system-name=ppp_modem status=enabled link-state=up nat64=disable address= /29 Stats: Bytes Packets Errors Dropped Overrun Framing Rx Tx (RMC107) show> Page 9-3

88 Chapter 9: Configuring a Wireless Network: Configuring the Wireless Modem Configuring an HSPA or EvDO Modem. In this scenario, you will: Configure a description for the wireless modem Configure a connection string for the wireless modem Assign the wireless modem as a resource Activate an EvDO wireless modem Configure the PPP encapsulation settings Configure the wireless modem interface To configure the HSPA or EvDO wireless modem settings: 1. Configure description HSPA wireless modem for controller serial modem: config controller serial modem description HSPA wireless modem OR Configure description EVDO wireless modem for controller serial modem: config controller serial modem description EVDO wireless modem 2. For an HSPA modem, configure the serial controller s connection string asfollows: OR config controller serial modem connect string AT+CGDCCONT=1, IP, carrier_apn AT ATD*99***1# For an EvDO modem, configure the serial controller s connection string asfollows: config controller serial modem connect string AT AT$QCMIP=1 AT$QCMIPP=0 AT$QCMIPEP=1 AT$QCQNC=0 AT$QCMDR=3 ATDT# Assign controller serial modem as a resource: config controller serial modem assign Note: For an EvDO modem only, activate the network name: diag controller serial modem activate <network name> 4. Configure the following ppp encapsulation settings for the HSPA or EvDO modem: Remote method chap Remote username isp@providerx.com and password PROVIDER1 A default route that uses the same subnet as the corresponding interface Page 9-4

89 Chapter 9: Configuring a Wireless Network: Configuring the Wireless Modem Notes: This command overrides the default route assigned to the Remote RMM- 800 or Remote RMC-700 via command config ip route default. PPP configured with the default route option and command config ip route default are mutually exclusive. You should not have both configured. PPP username and password may vary by wireless carrier. Consult your network provider for the proper identification information. Disabled LCP requests config controller serial modem encapsulation ppp config controller serial modem encapsulation ppp remote method chap config controller serial modem encapsulation ppp remote identity isp@providerx.com PROVIDER1 config controller serial modem encapsulation ppp defaultroute config controller serial modem encapsulation ppp lcp-requests disable 5. (optional) Verify that the HSPA serial controller has been configured properly: show controllers serial modem The command response similar to the following displays: (Dub)>show controllers serial modem serial modem status=enabled link-state=up encapsulation=ppp init-string=at+cgdcont=1, IP, isp.cingular AT ATD*99***1# resource-state=assigned signal-strength=fair (-82 dbm) prl-version=51281 prl-size=5736 Next PRL update in: (unavailable) description=hspa wireless modem ppp defaultroute=true local-method=none local-identity= remote-method=chap remote-identity=isp@providerx.com mru=1520 mtu=1520 lcp-requests=disabled (Dub)> 6. Enable interface serial modem: config interface serial modem enable Note: The IP address of the serial modem interface is assigned automatically by PPP. 7. (optional) Verify that the HSPA serial interface has been configured properly: show interfaces serial modem Page 9-5

90 Chapter 9: Configuring a Wireless Network: Configuring the Wireless Modem The command response similar to the following displays: (Dub)>show interface serial modem serial modem name=serial wan/1 system-name=ppp_modem status=enabled link-state=up address= pointopoint= Stats: Bytes Packets Errors Dropped Overrun Framing Rx Tx (Dub)> Page 9-6

91 Chapter 9: Configuring a Wireless Network: Configuring the VPN Configuring the VPN In this scenario, you will: Configure an OpenVPN controller Configure an OpenVPN interface To configure the VPN: 1. Enable OpenVPN controller client: config controller openvpn client enable 2. Configure encryption option aes-256 for OpenVPN controller client: config controller openvpn client cipher aes-256 Note: The cipher configured for Remote RMM-800 or Remote RMC-700 must match what is configured on the VPN server. If there's a mismatch, the VPN will not be established. 3. Configure server IP address and port number 1194 for OpenVPN controller client: config controller openvpn client server (optional) Verify that the OpenVPN controller has been configured properly: show controllers openvpn The command response similar to the following displays: (Dub)>show controllers openvpn openvpn client system-name=ovpn_client status=enabled link-state=up hardware-address=00:ff:8c:a5:63:89 default-address=00:ff:8c:a5:63:89 mode=client server= :1194 cipher=aes-256 vpn-state=connected, Tue Feb 9 15:52:03 EST 2010 cert-subject=/o=ai/cn=vpn-client3 cert-validity-start=mon Sep 18 04:00:00 GMT 2006 cert-validity-end=sun Sep 18 04:00:00 GMT 2011 vpn-rx-bytes= vpn-tx-bytes= (Dub)> 5. Configure IP address and subnet mask length 24 for OpenVPN interface client: config interface openvpn client ip address /24 The command response similar to the following displays: Page 9-7

92 Chapter 9: Configuring a Wireless Network: Configuring the VPN (Dub)>show interfaces openvpn openvpn client system-name=ovpn_client status=enabled link-state=up address= /24 (Dub)> Page 9-8

93 Configuring Actions, Events and Responses This chapter provides information about actions, events and responses. Guide to this Chapter Overview Event Components Response Components Action Components CHAPTER 10 Configuring an Event, Response and Action Page 10-1

94 Chapter 10: Configuring Actions, Events and Responses: Overview Overview Actions are rules in Remote RMC-700 and Remote RMM-800 that provide a flexible mechanism for managing system mediation by letting users associate events and responses. Actions provide the ability to configure an extensive range of behavior in response to external or internal events. Actions consist of three components: Events System occurrences related to changes in Remote RMM-800 or Remote RMC-700 s equipment or the environment. Responses Behaviors that are executed in response to system events. Actions Rules that create associations between responses and events. During normal Remote RMM-800 or Remote RMC-700 operation, internal event messages are generated. A subsystem called the Action Manager keeps a list of actions and monitors all the event messages. When an event message matches an event configured in an action, the Action Manager generates the corresponding response message. Each responder in the system monitors the response messages and executes responses directed to it. Page 10-2

95 Chapter 10: Configuring Actions, Events and Responses: Overview Figure 10-1 illustrates the sequence of events that occurs when action MyActions s event (MyEvent) occurs. Figure 10-1 Sequence of Events Note: Several commands exist in the Remote RMC-700 and Remote RMM-800 CLI that display diagnostic information related to actions: show actions, show events, show responses, show audit actions, show audit events, show audit responses and diag mmdisplay. For more information about display and diagnostic commands, refer to the Remote RMC-700 and Remote RMM- 800 Command Reference Guide. Page 10-3

96 Chapter 10: Configuring Actions, Events and Responses: Event Components Event Components Figure 10-2 illustrates a sample event configuration: event name originator event type config event MyEvent content input 0/1 close Figure 10-2 Example of the Event Command Event declarations consist of the following elements: An event name, which is a user-defined name for the event. An event originator, which is a system component that generates the event. An event type, which is a system occurrence that signifies the event. Options for the event type vary based on the event originator. Note: For more information about event configuration commands and parameters, refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide. Page 10-4

97 Chapter 10: Configuring Actions, Events and Responses: Response Components Response Components Figure 10-3 illustrates a sample response configuration: response name responder response type config response MyResponse content output 0/1 close Figure 10-3 Example of the Response Command Response declarations consist of the following elements: A response name, which is a user-defined name for the response. A responder, which is a system component that processes the response. A response type, which defines what the response does when the associated event occurs. Options for the response type vary based on the responder. Note: For more information about response configuration commands and parameters, refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide. Page 10-5

98 Chapter 10: Configuring Actions, Events and Responses: Action Components Action Components Figure 10-4 illustrates a sample action configuration: action name event name response name config action MyAction event MyEvent response MyResponse Figure 10-4 Example of the Action Command Action declarations consist of the following elements: An action name, which is a user-defined name for the action. An event name, which is a previously user-defined name of an event. The response name, which is a previously user-defined name of a response. Note: For more information about this command, refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide. Page 10-6

99 Chapter 10: Configuring Actions, Events and Responses: Configuring an Event, Response and Action Configuring an Event, Response and Action In this scenario, you will: Configure an event that occurs when the discrete input 0/1 closes. Configure a response that opens a relay output point Configure an action that associates the event with the response. To configure the event, response and action: 1. At the main prompt, configure event one_close with event originator input0/1 and event type close: config event one_close content input 0/1 close Note: For information about specific event originators and event types, refer to command config event content in the Remote RMC-700 and Remote RMM-800 Command Reference Guide. 2. Configure response Output0_1 with responder output 0/1 and response type open: config response Output0_1 content output 0/1 open Note: For information about specific responders and response types, refer to the response configuration commands in the Remote RMC-700 and Remote RMM-800 Command Reference Guide. 3. Configure action One_Close with event one_close and response Output0_1: config action One_Close event one_close response Output0_1 4. (optional) Verify that the action has been configured properly: show actions One_Close The command response similar to the following displays: Page 10-7

100 Chapter 10: Configuring Actions, Events and Responses: Configuring an Event, Response and Action (Dub)>show actions One_Close Action Name : One_Close Action Description : Event Name : One_Close Event Description : Event Originator : input 0/1 Event Type : close Response Name : Output0_1 Response Description : Response Responder : output 0/1 Response Type : open Response Parameters : No parameters configured for this response. (Dub)> 5. Save the configuration. Page 10-8

101 Configuring Technician Laptop Access This chapter provides information on configuring Remote RMC-700 and Remote RMM-800 network access to locally-connected technician laptops. Guide to this Chapter Configuration Overview Assigning IP Addresses to Technician Laptops Configuring IPTables for Network Address Translation CHAPTER 11 Page 11-1

102 Chapter 11: Configuring Technician Laptop Access: Configuration Overview Configuration Overview Figure 11-1 displays what happens when a technician s laptop accesses the network by connecting to Remote RMM-800 or Remote RMC-700. IP Network (Public Address) IPTables rules allow laptops on the private network to send packets to the WAN with Remote RMC-700 s public address. ( ) Server IPTables DHCP Server The DHCP Server assigns a private IP address to the technician laptop. Remote RMC-700 (or Remote RMM-700 or Remote RMM-800) Technician Laptop (Private Address) Figure 11-1 Technician Laptop Access via Remote RMX-3200 When the technician s laptop is connected to one of the Ethernet ports on Remote RMM-800 or Remote RMC-700, the DHCP server automatically assigns an IP address to the laptop. IP addresses that may be assigned to the technician s laptop Page 11-2

103 Chapter 11: Configuring Technician Laptop Access: Configuration Overview are configured using DHCP server configuration commands in the Remote RMM-800 or Remote RMC-700 CLI. For more information on configuring the DHCP server, refer to section Assigning IP Addresses to Technician Laptops on page IPTables is configured for Network Address Translation (NAT) to allow multiple laptops to use private IP addresses on the local network and a single public IP address on the WAN. For more information on configuring IPTables and NAT, refer to section Configuring IPTables for Network Address Translation on page Tip: If you have available public IP addresses, DHCP can assign them to connected laptops, which lets you skip the IPTables configuration. Page 11-3

104 Chapter 11: Configuring Technician Laptop Access: Assigning IP Addresses to Technician Laptops Assigning IP Addresses to Technician Laptops Remote RMC-700 and Remote RMM-800 use the DHCP server to assign IP addresses to network devices. CLI commands are entered to specify valid ranges of IP addresses that may be assigned. Important: For a laptop to access the network through Remote RMM-800 or Remote RMC-700 using this procedure, the laptop must be configured to obtain its IP address automatically. In this scenario, you will: Enable the DHCP server Configure a secondary bridge switch IP address Configure the DHCP server interface Configure the DHCP server subnet Configure the DHCP server router Configure the DHCP server IP address range Configure the default time that a network device can keep a DHCP server-assigned IP address Configure the maximum time that a network device can keep a DHCP server-assigned IP address. To configure the DHCP server to assign IP addresses to technician laptops: 1. Enable the DHCP server: config dhcp-server enable 2. Configure secondary bridge switch IP address /24: config interface bridge switch ip address /24 secondary Important: This step is important because an interface must exist on the same subnet that the DHCP server will be servicing. If this interface does not exist, the DHCP server will not start up. 3. Configure the DHCP server interface as bridge switch: config dhcp-server interface bridge switch 4. Configure the DHCP server subnet as /24: config dhcp-server subnet /24 5. Configure the DHCP server router as : config dhcp-server subnet /24 router Page 11-4

105 Chapter 11: Configuring Technician Laptop Access: Assigning IP Addresses to Technician Laptops 6. Configure the DHCP server IP address range as to : config dhcp-server subnet /24 range Note: When the DHCP server assigns IP addresses to network devices, it automatically starts with the highest value IP address in the range. 7. Configure the default time that a network device can keep an IP address assigned by the DHCP server as 4500 seconds: config dhcp-server subnet /24 default-lease Configure the maximum time that a network device can keep an IP address assigned by the DHCP server as 6000 seconds: config dhcp-server subnet /24 max-lease (optional) Verify that the DHCP server has been configured properly: show dhcp-server The command response similar to the following displays: (Dub)>show dhcp-server Admin State: enabled Broadcast: disabled Authority: disabled Config file: Note: User specified configuration files will override configured DHCP server settings. Interfaces: bridge switch Subnets: /24 range= / router= default-lease=4500 max-lease=6000 DNS: Hosts: test MAC=00:00:00:00:00:00 IP= (Dub)> 10. Save the configuration. Page 11-5

106 Chapter 11: Configuring Technician Laptop Access: Configuring IPTables for Network Address Translation Configuring IPTables for Network Address Translation IPTables rules must be configured to enable network address translation for laptops on the private network. Without NAT, devices with private addresses cannot send packets to devices outside the LAN. Note: For more information on IPTables, refer to an IPTables man page (version 1.2.7a). In this scenario, you will: Flush all Iptables Configure a rule in the PREROUTING chain that accepts all packets from a source subnet that go to a specified destination address Set the default action for the PREROUTING chain to drop all packets Configure a rule in the POSTROUTING chain that masquerades all TCP packets from a specified source subnet. To configure IPTables for address translation: 1. Flush all IPTables: config iptables -t nat -F config iptables -t filter -F config iptables -t mangle -F 2. Configure a rule in the PREROUTING chain in the mangle table that accepts all packets from source subnet /24 and to destination address : config iptables -t mangle -A PREROUTING -s /24 -d j ACCEPT 3. Set the default action for the PREROUTING chain to drop all packets: config iptables t mangle P PREROUTING DROP CAUTION: If you are connected to Remote RMM-800 or Remote RMC-700 via an SSH connection and you set the default action to drop all packets without first configuring a rule to accept packets between your workstation and Remote RMM-800 or Remote RMC-700 (as in step 2), your connection to Remote RMM-800 or Remote RMC-700 will be lost. Page 11-6

107 Chapter 11: Configuring Technician Laptop Access: Configuring IPTables for Network Address Translation 4. Configure a rule in the POSTROUTING chain that masquerades all tcp packets from source subnet /24: config iptables -t nat -A POSTROUTING -s /24 -p tcp -j MASQUERADE 5. (optional) Verify that the IPTables commands have been configured properly: show iptables configuration The command response similar to the following displays: (Dub)>show iptables configuration Table nat Chain PREROUTING (policy ACCEPT) Chain POSTROUTING (policy ACCEPT) -s /24 -p tcp -j MASQUERADE Chain OUTPUT (policy ACCEPT) Table filter Chain INPUT (policy ACCEPT) -i lo -j ACCEPT Chain FORWARD (policy ACCEPT) Chain OUTPUT (policy ACCEPT) -d /8 -j ACCEPT Table mangle Chain PREROUTING (policy DROP) -i lo -j ACCEPT -s /24 -d j ACCEPT Chain INPUT (policy ACCEPT) -i lo -j ACCEPT Chain FORWARD (policy ACCEPT) Chain OUTPUT (policy ACCEPT) -d /8 -j ACCEPT Chain POSTROUTING (policy ACCEPT) -d /8 -j ACCEPT (Dub)> 6. Save the configuration. Page 11-7

108 Chapter 11: Configuring Technician Laptop Access: Configuring IPTables for Network Address Translation Page 11-8

109 Configuring Event Correlations This chapter provides information about configuring event correlations. Guide to this Chapter Overview Correlation Expression Components Configuring an Event Correlation CHAPTER 12 Page 12-1

110 Chapter 12: Configuring Event Correlations: Overview Overview Event correlation is the ability to identify a unique condition by comparing the states of multiple events and aggregating into a single event. The goals of Remote RMC-700 and Remote RMM-800 event correlation are to: Report the correlated condition to a network management system Include the correlated condition as an individual component in other event correlations (if defined) Perform an automatic response (if defined) Event Correlation Components Event correlation is represented by an event originator named correlation and the following components: A description of the event correlation A boolean-like expression to define the event correlation Properties controlling how the expression is evaluated. The evaluation of the correlation expression results in a true or false state for the event correlation. Page 12-2

111 Chapter 12: Configuring Event Correlations: Correlation Expression Components Correlation Expression Components The following illustrates a basic expression configuration: Term Operator Term OriginatorType Instance State and OriginatorType Instance State Figure 12-1 Correlation Expression Example A Term in a correlation expression is used to test the current state of an originator. The Term consists collectively of the following elements: Originator Type, which is one of the Remote RMC-700 and Remote RMM-800 event originator types. The type can also be correlation, which refers to other event correlations. Instance value, which is one of the valid instances for the specified type, for example, 0/1, 2. State, which is a valid state for the originator. In the case of a measurement, the state may be a relational operator and a numeric value (for example, < 48 or > 95). Originator Types and States Table 12-1 lists the types of originators that are valid for the correlation expressions, the associated events that are valid as a state comparison and those originators that can be used as multi-originators. Multi-originators must have either an any or an all operator before the multiple instance token. See Operators on page 12-4 for details. Table 12-1 Event Originator Types and States Originator Type Valid State Events Multi Support analog high, in-band, inputsaturated, loss of signal, low yes - point ranges input close, open yes - point ranges output close, open yes - point ranges correlation false, true no measurement high, in-band, inputsaturated, loss of signal, low, <, <=, =, >=, >,!= yes - point ranges Page 12-3

112 Chapter 12: Configuring Event Correlations: Correlation Expression Components Examples Examples of these components combined are shown below: analog 0/1 high correlation examplecorr false measurement ExtTemp1 > 90 Operators The valid operators that can be used in a correlation expression are listed in the following table, along with possible usages and example results for each. Table 12-2 Operators and Usage Operator Usage Example Result and expression analog 0/1 high and output 0/1 open or expression analog 0/1 high or measurement exttemp > 110 When both expressions are true, the evaluation is true. When either expression is true, the evaluation is true. not all any expression not analog 0/1 in-band expression all input 0/1-12 close expression any 3 input 0/1-5 close When negating a true expression, the evaluation is false. When all expressions are true, the evaluation is true. When at least three (3) expressions are true, the evaluation is true. If no number is entered after any, the default value is 1. Expression Evaluation In an expression, the precedence order for evaluation is as follows: 1. Term 2. not 3. and 4. or If a Term is a nested expression, it is fully evaluated as the evaluation of the Term, as is typical with most programming languages. Nested expressions in parentheses are supported, allowing complex expressions to be contained in a single correlation Page 12-4

113 Chapter 12: Configuring Event Correlations: Correlation Expression Components expression. The use of parentheses can improve the readability of expressions which mix and, not and or operators. Example Expressions The examples below show various forms of Terms in nested expressions. all input 0/1-4 open and ( analog 0/1 loss-of-signal or analog 0/1 low ) not ( any 3 analog 0/1-4 in-band and correlation mycorrelation false ) all input 1/1,3,5,7 open and correlation mycorrelation true all input 0,2/1-4 open Configuring a Time Period (Optional) You can optionally configure a time period (duration) during which a correlation expression must remain in a true or false state before the correlation itself changes state to match the expression. For example, you may want to configure a scenario where an alarm is generated when a door is open for an extended period of time rather than a brief open/close situation. Page 12-5

114 Chapter 12: Configuring Event Correlations: Configuring an Event Correlation Configuring an Event Correlation In this scenario, you will: Configure a correlation expression for two open door alarm events Configure the time (duration) for which the expression must remain true or false before the correlation matches the expression s state Create two alarm table entries for the open door events. To configure an event correlation for two open door alarm events: 1. At the main prompt, configure an event correlation named DoorAlarms with a description of Correlation for open door alarms: config correlation DoorAlarms description Correlation for open door alarms 2. Configure the true duration time in the expression for 900 seconds, meaning an alarm will be sent if the door is open for 15 minutes; set the false duration time to 0 seconds (immediate), meaning an alarm will be sent immediately upon closure: config correlation DoorAlarms duration Configure the correlation expression for the two doors as input 0/1 open and input 0/2 open: config correlation DoorAlarms expression input 0/1 open and input 0/2 open 4. (optional) Verify that the action has been configured properly: show correlation DoorAlarms The command response appears similar to the following: (Dub)>show correlation DoorAlarms Name : DoorAlarms Expression : input 0/1 open and input 0/2 open True Duration : 900 False Duration : 0 Evaluation : false and false = false Value : false Description : Correlation for open door alarms (Dub)> Page 12-6

115 Chapter 12: Configuring Event Correlations: Configuring an Event Correlation To configure the alarm table entry for the open door correlation: 1. At the main prompt, configure the alarm entry name dooropen: config alarm-entry dooropen 2. Configure the alarm entry dooropen with the following parameters: event originator correlation DoorAlarms event type true event severity major alarm message Door is open config alarm-entry dooropen event correlation DoorAlarms true major Door is open 3. Configure the alarm entry dooropen with the following parameters: event originator correlation DoorAlarms event type false event severity normal alarm message Door is closed config alarm-entry dooropen event correlation DoorAlarms false normal Door is closed 4. Save the configuration. Note: For an example of configuring an event correlation using a measurement, see section Configuring a Measurement Table Entry for State Transitions and Durations in Chapter 14: Configuring Measurements and the Measurement Table. Page 12-7

116 Chapter 12: Configuring Event Correlations: Configuring an Event Correlation Page 12-8

117 Configuring Alarm Entries in the Central Alarm Table This chapter provides an overview of the central alarm table along with step-bystep scenarios for configuring and using alarm entries in the central alarm table. Guide to this Chapter Overview Alarm Protocol Formats Configuring an Alarm Entry for a Temperature Sensor Configuring an Alarm Entry for a Discrete Input CHAPTER 13 Configuring an Alarm Entry for a Serial Connection Failure Configuring an Alarm Entry for a Power Supply Failure Configuring an Alarm Entry for a TCP Connection that Goes Down Configuring an Alarm Entry for a Telnet Connection that Comes Up Testing Alarm Table Configurations Page 13-1

118 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Overview Overview The central alarm table collects and communicates the state of all alarms reported by Remote RMM-800 or Remote RMC-700. It is a table of alarm entries that contains information for each attainable severity level and has the following features: Event/alarm associations The central alarm table lets users associate events with alarm responses in a single command. This is easier than configuring events and alarm responses using the action subsystem, which requires three commands for associating events with alarm responses. Alarm Nagging Alarm nagging causes an alarm entry to send an alarm message in all formats enabled for that entry at a specified time interval. For information about configuring the alarm nagging interval, refer to section Configuring an Alarm Entry for a Temperature Sensor on page Alarm reporting in a variety of formats The central alarm table can report alarm statuses in raw, SNMP, or TL1 format. For more information on these formats, refer to section Alarm Protocol Formats on page For information about commands that configure central alarm table entries and data, refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide. Page 13-2

119 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Alarm Protocol Formats Alarm Protocol Formats The central alarm table supports multiple alarm protocol formats, including: Raw SNMP TL1 You can enable and disable each alarm protocol format independently of the others (meaning that you can have more than one format enabled at a time). Raw The central alarm table supports raw alarm output that can be used for alarm formats that are not directly supported by Remote RMM-800 or Remote RMC-700. A script or application can take the alarm information from the raw output and translate it into any type of alarm message. SNMP The central alarm table supports SNMP through alarm traps in the aimediationv2.mib. Alarm traps are sent to all enabled SNMP management hosts. In order to receive alarm traps, at least one SNMP management host must be configured. TL1 The central alarm table supports TL1 reporting through virtual TL1 NEs. You must configure and enable the desired virtual TL1 NEs to use them with the central alarm table. Page 13-3

120 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Temperature Sensor Configuring an Alarm Entry for a Temperature Sensor In this scenario, you will: Configure an alarm entry description Configure a category name Configure SNMP trap support Configure the interval at which the alarm will send its state Configure a network element name Configure the alarm actions that signal when the detected temperature has exceeded a maximum threshold, passed below a minimum threshold, or entered into an acceptable range. Important: This scenario does not show how to configure the analog input that is associated with the alarm entry. For information on configuring analog inputs, refer to command config discrete analog in the Remote RMC-700 and Remote RMM-800 Command Reference Guide. To configure the temperature sensor alarm entry: 1. At the main prompt, configure description Temperature sensor: config alarm-entry tempsensor description Temperature sensor 2. Configure category name envalms: config alarm-entry tempsensor category envalms 3. Enable SNMP trap support: config alarm-entry tempsensor trap enable 4. Configure the SNMP trap priority level to high: config alarm-entry tempsensor trap priority high 5. Configure the interval at which the alarm entry sends its state information to 5 seconds when the alarm state is critical: config alarm-entry tempsensor nagging 5 critical 6. Configure network element name sensorunit: config alarm-entry tempsensor ne-name sensorunit Page 13-4

121 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Temperature Sensor 7. Configure an event for alarm entry tempsensor with the following settings: Event originator analog 0/1 Event trigger high Event severity level critical Alarm event message Temperature above safe threshold - followed by the actual high value for the alarm entry. config alarm-entry tempsensor event analog 0/1 high critical Temperature above safe threshold - $(value) Note: Keyword $(value) is replaced with the current value of the analog input. If the event associated with the analog input does not contain an event message value, no substitution takes place. 8. Configure a second event for alarm entry tempsensor with the following settings: Event originator analog 0/1 Important: All events configured for an alarm entry must have the same event originator. Event trigger low Event severity level minor Alarm event message Temperature below low threshold - followed by the actual low value for the alarm entry. config alarm-entry tempsensor event analog 0/1 low minor Temperature below low threshold - $(value) 9. Configure a third event for alarm entry tempsensor with the following settings: Event originator analog 0/1 Event trigger in-band Event severity level normal Alarm event message Temperature in normal range. config alarm-entry tempsensor event analog 0/1 in-band normal Temperature in normal range Page 13-5

122 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Temperature Sensor 10. (optional) Verify that the alarm entry has been configured properly: show alarm-entries name tempsensor The command response appears similar to the following: (Dub)>show alarm-entries name tempsensor Name - tempsensor State - normal Current Message - Description - Temperature sensor Nagging Interval - 5 Nagging Level - critical Trap - enabled Trap Priority - high Raw - enabled TL1 - disabled TL1 AID - TL1 Class - env TL1 Affect - nsa TL1 Type - TL1NE - 1 Category - envalms NE Name - TempSensor Alarm Actions: Severity Originator Trigger Message critical analog 0/1 high Temperature above sa minor analog 0/1 low Temperature below lo normal analog 0/1 in-band Temperature in norma (Dub)> 11. Save the configuration. Configuring Analog Input Values The values reported by Remote analog inputs oftentimes show rapid fluctuations as compared to the values read from a digital multi-meter. This is by design and does not indicate a problem with the Remote. Digital multi-meters utilize sophisticated internal circuitry to minimize these inherent fluctuations when displaying measurements to the user. To compensate for these variations, Remote provides two analog input features: analog averaging and analog adjustment. Analog Averaging Users can specify the level at which Remote will average measurement values. The goal is for a reasonable, steady-state value to measure consistently with both the Remote and an external meter. Summarized in Table 13-1 are the valid averaging values with typical examples of when they may be applied to a measurement. Page 13-6

123 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Temperature Sensor. Value high medium low none Description Table 13-1 Analog Averaging Values Provides the most averaging, but provides slower response to rapid changes in the measured value. This setting is typically used with environmental or other sensors which measure conditions that do not change quickly. The typical value used when the unscaled value fluctuates by +/-.01 V or ma. This setting is recommended for measurements which are not expected to change instantaneously, but may change significantly over a short period of time (for example, 1 minute). Provides faster response to value fluctuation while still providing a small level of averaging. This setting is recommended for measurements which may change very rapidly during alarm conditions, but which will still benefit from the smoothing feature during steady-state operation. No averaging will be applied and raw values will be reported. This is the default value. Measurement Example Temperature/Humidity Fuel Level Battery Voltage The following example shows how to configure discrete analog 0/1 with medium level averaging: config discrete analog 0/1 averaging medium Analog Adjustment A fixed adjustment can be applied to an analog input value to raise or lower the value to match a reference value. By adjusting both the minimum and maximum sensor readings by the same amount, the offset can be applied without changing the scaling factor of the analog input. Note that these values affect only the current conditions. For example, to configure a voltage sensor for 0-10V scaling to gallons of fuel, an offset of +7 gallons can be applied by scaling the 0-10V to gallons. This scenario is configured as follows: config discrete analog 0/1 minimum 0 7 config discrete analog 0/1 maximum Page 13-7

124 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Discrete Input Configuring an Alarm Entry for a Discrete Input In this scenario, you will: Configure an alarm entry description Configure TL1 alarm protocol support Configure an alarm action that occurs when a light turns off, which opens an input Configure an alarm action that occurs when a light turns on, which closes an input. Important: This scenario does not show how to configure the discrete input that is associated with the alarm entry. For information on configuring discrete inputs, refer to command config discrete input in the Remote RMC-700 and Remote RMM-800 Command Reference Guide. To configure the open input alarm entry: 1. At the main prompt, configure description Light switch: config alarm-entry input0_1 description Light Switch 2. Enable tl1 alarm protocol support and set the TL1 alarm class to eqpt (equipment) and the TL1 service state to sa (service-affecting): config alarm-entry input0_1 tl1 enable config alarm-entry input0_1 tl1 eqpt config alarm-entry input0_1 tl1 sa Note: For information on configuring the TL1 NE and TL1 MUX that monitor the alarm, refer to Chapter 16: Configuring and Connecting TL1 Infrastructure. 3. Configure an event for alarm entry input0_1 with the following settings: Event originator input 0/1 Event trigger open Event severity level major Alarm event message Light off. config alarm-entry input0_1 event input 0/1 open major Light off Page 13-8

125 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Discrete Input 4. Configure an event for alarm entry input0_1 with the following settings: Event originator input 0/1 Event trigger close Event severity level major Alarm event message Light on. config alarm-entry input0_1 event input 0/1 close major Light on 5. (optional) Verify that the alarm entry has been configured properly: show alarm-entries name input0_1 The command response appears similar to the following: (Dub)>show alarm-entries name input0_1 Name - input0_1 State - normal Current Message - Description - Light Switch Nagging Interval - 0 Nagging Level - major Trap - enabled Raw - disabled TL1 - enabled TL1 AID - TL1 Class - eqpt TL1 Affect - sa TL1 Type - TL1NE - 1 Category - NE Name - Alarm Actions: Severity Originator Trigger Message major input 0/1 open Light off major input 0/1 close Light on (Dub)> 6. Save the configuration. Page 13-9

126 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Serial Connection Failure Configuring an Alarm Entry for a Serial Connection Failure In this scenario, you will: Configure an alarm entry description Configure SNMP alarm protocol support Configure an alarm action that signals that a serial connection failure has occurred. Important: This scenario does not show how to configure the serial port that is associated with the alarm entry. For information on configuring serial ports, refer to command config controller serial in the Remote RMC-700 and Remote RMM-800 Command Reference Guide. To configure an alarm entry for a serial connection failure: 1. At the main prompt, configure description Serial connection failure: config alarm-entry SerConnFail description Serial connection failure 2. Enable SNMP trap alarm protocol support: config alarm-entry SerConnFail trap enable 3. Configure an event for alarm entry SerConnFail with the following settings: Event originator serial 1 Event trigger conn-failed Event severity level major Alarm event message The serial connection has failed. config alarm-entry SerConnFail event serial 1 conn-failed major The serial connection has failed Page 13-10

127 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Serial Connection Failure 4. (optional) Verify that the alarm entry has been configured properly: show alarm-entries name SerConnFail The command response appears similar to the following: (Dub)>show alarm-entries name SerConnFail Name - SerConnFail State - normal Current Message - Description - Serial connection failure Nagging Interval - 0 Nagging Level - major Trap - enabled Raw - disabled TL1 - disabled TL1 AID - TL1 Class - env TL1 Affect - nsa TL1 Type - TL1NE - 1 Category - NE Name - Alarm Actions: Severity Originator Trigger Message major serial 1 conn-faile The serial connectio (Dub)> 5. Save the configuration. Page 13-11

128 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Power Supply Failure Configuring an Alarm Entry for a Power Supply Failure In this scenario, you will: Configure an alarm entry description Configure TL1 alarm protocol support Configure an alarm action that signals that a power supply failure has occurred. To configure an alarm entry for a power supply failure: 1. At the main prompt, configure description 24 volt power supply failure: config alarm-entry powerfail24 description 24 volt power supply failure 2. Enable tl1 alarm protocol support and set the TL1 alarm class to eqpt (equipment) and the TL1 service state to sa (service-affecting): config alarm-entry powerfail24 tl1 enable config alarm-entry powerfail24 tl1 eqpt config alarm-entry powerfail24 tl1 sa Note: For information on configuring the TL1 NE and TL1 MUX that monitor the alarm, refer to Chapter 16: Configuring and Connecting TL1 Infrastructure. 3. Configure an event for alarm entry powerfail5 with the following settings: Event originator system Event trigger power-fail-24 Event severity level critical Alarm event message 24 volt power supply failure. config alarm-entry powerfail24 event system power-fail-24 critical 24 volt power supply failure Page 13-12

129 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Power Supply Failure 4. (optional) Verify that the alarm entry has been configured properly: show alarm-entries name powerfail24 The command response appears similar to the following: (Dub)>show alarm-entries name powerfail24 Name - powerfail24 State - normal Current Message - Description - 24 volt power supply failure Nagging Interval - 0 Nagging Level - major Trap - enabled Raw - disabled TL1 - enabled TL1 AID - TL1 Class - eqpt TL1 Affect - sa TL1 Type - TL1NE - 1 Category - NE Name - Alarm Actions: Severity Originator Trigger Message critical system power-fail 24 volt power supply (Dub)> 5. Save the configuration. Page 13-13

130 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a TCP Connection that Goes Down Configuring an Alarm Entry for a TCP Connection that Goes Down In this scenario, you will: Configure an alarm entry description Configure SNMP alarm protocol support Configure an alarm action that signals that a TCP connection has gone down. To configure an alarm entry for a TCP connection that goes down: 1. At the main prompt, configure description TCP connection down: config alarm-entry TCPConnDown description TCP connection down 2. Enable SNMP trap alarm protocol support: config alarm-entry TCPConnDown trap enable 3. Configure an event for alarm entry TCPConnDown with the following settings: Event originator tcp :5001 Event trigger conn-down Event severity level major Alarm event message TCP connection down. config alarm-entry TCPConnDown event tcp :5001 conndown major TCP connection down Page 13-14

131 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a TCP Connection that Goes Down 4. (optional) Verify that the alarm entry has been configured properly: show alarm-entries name TCPConnDown The command response appears similar to the following: (Dub)>show alarm-entries name TCPConnDown Name - TCPConnDown State - normal Current Message - Description - TCP connection down Nagging Interval - 0 Nagging Level - major Trap - enabled Raw - disabled TL1 - disabled TL1 AID - TL1 Class - env TL1 Affect - nsa TL1 Type - TL1NE - 1 Category - NE Name - Alarm Actions: Severity Originator Trigger Message major tcp conn-down TCP connection down (Dub)> 5. Save the configuration. Page 13-15

132 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Telnet Connection that Comes Up Configuring an Alarm Entry for a Telnet Connection that Comes Up In this scenario, you will: Configure an alarm entry description Configure SNMP alarm protocol support Configure an alarm action that signals that a Telnet connection has come up. To configure the Telnet connection up alarm entry: 1. At the main prompt, configure description Telnet connection up: config alarm-entry TelnetConnUp description Telnet connection up 2. Enable SNMP trap alarm protocol support: config alarm-entry TelnetConnUp trap enable 3. Configure an event for alarm entry TelnetConnUp with the following settings: Event originator telnet :6001 Event trigger conn-up Event severity level normal Alarm event message Telnet connection now up. config alarm-entry TelnetConnUp event telnet :6001 conn-up normal Telnet connection now up Tip: This same scenario can be followed to configure a connection up alarm entry for SSH. Simply substitute SSH for Telnet. Page 13-16

133 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Configuring an Alarm Entry for a Telnet Connection that Comes Up 4. (optional) Verify that the alarm entry has been configured properly: show alarm-entries name TelnetConnUp The command response appears similar to the following: (Dub)>show alarm-entries name TelnetConnUp Name - TelnetConnUp State - normal Current Message - Description - Telnet connection up Nagging Interval - 0 Nagging Level - major Trap - enabled Raw - disabled TL1 - disabled TL1 AID - TL1 Class - env TL1 Affect - nsa TL1 Type - TL1NE - 1 Category - NE Name - Alarm Actions: Severity Originator Trigger Message normal telnet conn-up Telnet connection no (Dub)> 5. Save the configuration. Page 13-17

134 Chapter 13: Configuring Alarm Entries in the Central Alarm Table: Testing Alarm Table Configurations Testing Alarm Table Configurations After you configure alarm table entries, you can simulate test traps from the alarm table to test your alarm table configurations before actual alarm traps are sent. Test mode traps are sent to the management station. In this scenario, you will simulate a test trap from Remote for a specific alarm entry. To simulate a test trap from the Remote alarm table: 1. Simulate a test trap with a normal state for 5 minutes for alarm entry GPS_Failure: diag test alarm-entry GPS_Failure mode normal 5 2. (optional) Verify that the GPS_Failure alarm entry is being simulated: show test alarm-entries This command response displays the alarm entries that are currently being simulated (in test mode). (Dub)>show (Dub) show>test (Dub) show test> alarm-entries Name State Current alarm message Explosive_Gas normal Explosive Gas Not Detected GPS_Failure normal GPS Normal Generator_OilPressur normal --- NewTest normal --- Toxic_Gas normal --- (Dub) show test Page 13-18

135 Configuring Measurements and the Measurement Table This chapter provides an overview of the Remote RMX-3200 s and Remote RMM-700 s measurement table and step-by-step scenarios for configuring a measurement table entry, an alarm entry for a measurement and an event correlation for a measurement. Guide to this Chapter Overview Configuring a Measurement Table Entries for Temperature and Humidity Sensors CHAPTER 14 Configuring an Alarm Entry for a Measurement Configuring a Measurement Table Entry for State Transitions and Durations Page 14-1

136 Chapter 14: Configuring Measurements and the Measurement Table: Overview Overview In addition to its central alarm table, the Remote RMC-700 and Remote RMM-800 provide a measurement table that collects analog measurement values and reports these values to a central management station, such as Optima. These measurement values can be sourced from the Remote RMX-3200 s or Remote RMM-700 s analog input, from a script running on the Remote RMM-800 or Remote RMC-700 that monitors an attached network element, or via SNMP from a network element that is monitored by SNMP proxy. The Remote RMM-800 or Remote RMC-700 measurement table stores a 7-day history of collected values. Figure 14-1 Remote RMC-700 Measurement Table Each entry in the measurement table is identified by a name and contains an analog value, units of measure (such as V, %, deg C, or deg F), the originator of the data (such as analog 0/1 or script jobname_measurementname), the NE name, an optional description and category and the maximum, minimum and average measured values over the reporting interval. You can configure a measurement table entry such that the state of the measurement will change based on the current value of the measurement. These states include: Loss-of-signal The value has passed below the minimum measurable threshold Low The value has passed below the minimum value that is considered normal Page 14-2

137 Chapter 14: Configuring Measurements and the Measurement Table: Overview In-band The value falls between the minimum normal value and the maximum normal value High The value has passed above the maximum value that is considered normal Input-saturated The value has passed above the maximum measurable threshold Offline The originator of the value has gone offline and is not reporting a value Use for Measuring State Transitions and Durations Transition and duration information for state changes on alarm entries and status points can also be obtained. The measurement table entry provides a new originator which contains a function that references an alarm entry or status point and calculates the measurement counts the number of times an originator (alarm entry or status point) transitions to a particular state within a measurement interval. The transition count is reported as a whole number and resets to zero at the start of each measurement counts the number of seconds an originator (alarm entry or status point) is in a particular state within a measurement interval. The duration count is reported as a sum for the current measurement interval and is rounded to the nearest whole second. The duration count will reset to zero at the start of each measurement interval. See Configuring a Measurement Table Entry for State Transitions and Durations on page for an example. Use with Alarm Table Entries Measurement table entries can be used in connection with Remote RMX-3200 s or Remote RMM-700 s alarm table. You can set up alarm entries with different events that are triggered in response to fluctuations in the current state of a measurement. See section Configuring an Alarm Entry for a Measurement for an example. Use with Event Correlations You can create event correlations to be used with measurement table entries. The example in section Configuring a Measurement Table Entry for State Transitions and Durations correlates a temperature measurement exceeding a specified value with an input being open to create an alarm for fire danger. For more information on configuring correlations, see Chapter 12: Configuring Event Correlations. Page 14-3

138 Chapter 14: Configuring Measurements and the Measurement Table: Overview Use with Proxied SNMP NEs See Chapter 19: Configuring the SNMP Proxy for information on how to use the measurement table with proxied SNMP NEs. Relevant topics include Configuring a Mediation SNMP Measurement Template and Configuring a Mediation SNMP Network Element. Page 14-4

139 Chapter 14: Configuring Measurements and the Measurement Table: Configuring a Measurement Table Entries for Temperature and Humidity Sensors Configuring a Measurement Table Entries for Temperature and Humidity Sensors Sample Configuration for Discrete Analog Temperature Sensor In this scenario, you will: Configure a measurement table entry with name and description Configure a category name Configure measurement units Configure a network element name Configure the normal (in-band), maximum and minimum values Configure the originator for a measurement table entry Enable the measurement table entry To configure a measurement table entry for an external temperature sensor: 1. At the main prompt, configure measurement table entry ExtTemp1 with description External temperature sensor: config meas-table entry ExtTemp1 description External temperature 2. Configure category name envalms: config meas-table entry ExtTemp1 category envalms 3. Configure measurement units Degrees F: config meas-table entry ExtTemp1 units Degrees F 4. Configure network element name sensorunit: config meas-table entry ExtTemp1 ne-name sensorunit 5. Configure the normal range for measurement values: config meas-table entry ExtTemp1 band Configure the maximum measurable value: config meas-table entry ExtTemp1 maximum Configure the minimum measurable value: config meas-table entry ExtTemp1 minimum Configure the originator for this measurement: config meas-table entry ExtTemp1 originator analog 0/1 Page 14-5

140 Chapter 14: Configuring Measurements and the Measurement Table: Configuring a Measurement Table Entries for Temperature and Humidity Sensors 9. Enable the measurement table entry: config meas-table entry ExtTemp1 enable 10. (optional) Verify that the measurement table entry has been configured properly: show meas-table entries ExtTemp1 The command response similar to the following displays: (Dub)>show meas-table entries ExtTemp1 Name - ExtTemp1 (static) State - in-band Originator - analog 0/1 Description - External temperature sensor NE Name - sensorunit Category - envalms Report Interval - 0 Low-Band High-Band Hysteresis - 0. Max-Limit Min-Limit Units - Degrees F Current Value - 72 Interval Value -? Interval Minimum -? Interval Maximum -? Interval Average -? (Dub)> 11. Save the configuration. Sample Configuration for SiteBus Temperature Sensor The following is a sample configuration for a measurement table entry for the SiteBus temperature sensor. Adjust the sensor name, NE name and other values to fit your specific implementation. config meas-table entry TempSensor1 config meas-table entry TempSensor1 category Temp Sensor config meas-table entry TempSensor1 description One Wire Temp Sensor config meas-table entry TempSensor1 originator sitebus Temp/temperatureF config meas-table entry TempSensor1 report-interval 15 config meas-table entry TempSensor1 band config meas-table entry TempSensor1 hysteresis 2 config meas-table entry TempSensor1 maximum 150 config meas-table entry TempSensor1 minimum -10 config meas-table entry TempSensor1 ne-name Test_RMX3200 Page 14-6

141 Chapter 14: Configuring Measurements and the Measurement Table: Configuring a Measurement Table Entries for Temperature and Humidity Sensors config meas-table entry TempSensor1 units degrees Fahrenheit Page 14-7

142 Chapter 14: Configuring Measurements and the Measurement Table: Configuring a Measurement Table Entries for Temperature and Humidity Sensors Sample Configuration for SiteBus Combined Temperature and Humidity Sensor The following is a sample configuration for temperature (tempf) and humidity (RelHum) measurement table entries for sensor type sbtemphumidity named temphum1, the SiteBus one-wire combined temperature and humidity sensor. The sensor has already been configured. config meas-table entry tempf config meas-table entry tempf category Environment config meas-table entry tempf description Sitebus Temperature Sensor reading config meas-table entry tempf originator sitebus temphum1/temperaturef config meas-table entry tempf report-interval 300 config meas-table entry tempf band config meas-table entry tempf hysteresis 2 config meas-table entry tempf maximum 150 config meas-table entry tempf minimum -10 config meas-table entry tempf units degrees Farenheit config meas-table entry RelHum category Environment config meas-table entry RelHum description Sitebus Humidity Sensor reading config meas-table entry RelHum originator sitebus temphum1/humidity config meas-table entry RelHum report-interval 300 config meas-table entry RelHum band config meas-table entry RelHum hysteresis 3 config meas-table entry RelHum maximum 100 config meas-table entry RelHum minimum 0 config meas-table entry RelHum units percent The commands show meas-table entries tempf and show meas-table entries RelHum verify the configuration and display the measurement values: Page 14-8

143 Chapter 14: Configuring Measurements and the Measurement Table: Configuring a Measurement Table Entries for Temperature and Humidity Sensors (RMC27)>show (RMC27) show>meas-table entries tempf Name - tempf (static) State - in-band Originator - sitebus temphum1/temperaturef Description - Sitebus Temperature Sensor reading NE Name - thermsens Category - Environment Report Interval Low-Band - 20 High-Band Hysteresis - 2 Max-Limit Min-Limit Units - degrees Fahrenheit Current Value Interval Value Interval Minimum Interval Maximum Interval Average (RMC27) show>meas-table entries RelHum Name - RelHum (static) State - low Originator - sitebus temphum1/humidity Description - Sitebus Humidity Sensor reading NE Name - humidsens Category - Environment Report Interval Low-Band - 30 High-Band - 70 Hysteresis - 3 Max-Limit Min-Limit - 0 Units - percent Current Value Interval Value Interval Minimum Interval Maximum Interval Average (RMC27) show> Page 14-9

144 Chapter 14: Configuring Measurements and the Measurement Table: Configuring an Alarm Entry for a Measurement Configuring an Alarm Entry for a Measurement In this scenario, you will: Configure an alarm entry description and category Configure the network element name associated with this alarm entry Configure SNMP trap alarm protocol support Configure different alarm actions that occur when a measurement is normal, low, high, falls below the measurable range, or rises above the measurable range To configure the measurement alarm entry: 1. At the main prompt, configure alarm entry ExtTemp with description External temperature alarm: config alarm-entry ExtTemp description External temperature alarm 2. Configure category name envalms: config alarm-entry ExtTemp category envalms 3. Configure network element name sensorunit: config alarm-entry ExtTemp ne-name sensorunit 4. Enable SNMP trap alarm protocol support with priority normal: config alarm-entry ExtTemp trap enable config alarm-entry ExtTemp trap priority normal 5. Configure an event for alarm entry ExtTemp with the following settings: Event originator measurement ExtTemp1 Event trigger high Event severity level major Alarm event message $(value). Note: Keyword $(value) is replaced with the current measurement value. config alarm-entry ExtTemp event measurement ExtTemp1 high major $(value) Page 14-10

145 Chapter 14: Configuring Measurements and the Measurement Table: Configuring an Alarm Entry for a Measurement 6. Configure an event for alarm entry ExtTemp with the following settings: Event originator measurement ExtTemp1 Event trigger low Event severity level major Alarm event message $(value). config alarm-entry ExtTemp event measurement ExtTemp1 low major $(value) 7. Configure an event for alarm entry ExtTemp with the following settings: Event originator measurement ExtTemp1 Event trigger in-band Event severity level normal Alarm event message $(value). config alarm-entry ExtTemp event measurement ExtTemp1 in-band normal $(value) 8. Configure an event for alarm entry ExtTemp with the following settings: Event originator measurement ExtTemp1 Event trigger input-saturated Event severity level critical Alarm event message Input saturated. config alarm-entry ExtTemp event measurement ExtTemp1 inputsaturated critical Input saturated 9. Configure an event for alarm entry ExtTemp with the following settings: Event originator measurement ExtTemp1 Event trigger loss-of-signal Event severity level critical Alarm event message Signal loss. config alarm-entry ExtTemp event measurement ExtTemp1 loss-ofsignal critical Signal loss Page 14-11

146 Chapter 14: Configuring Measurements and the Measurement Table: Configuring an Alarm Entry for a Measurement 10. (optional) Verify that the alarm entry has been configured properly: show alarm-entries name ExtTemp The command response similar to the following displays: (Dub)>show alarm-entries name ExtTemp Name - ExtTemp State - normal Current Message - Description - Exterior temperature alarm Nagging Interval - 0 Nagging Level - major Trap - enabled Trap Priority - normal Raw - disabled TL1 - disabled TL1 AID - TL1 Class - env TL1 Affect - nsa TL1 Type - TL1NE - 1 Category - envalms NE Name - sensorunit Originator - measurement ExtTemp1 Alarm Actions: Severity Trigger Message major high $(value) major low $(value) normal in-band $(value) critical input-saturated Input saturated critical loss-of-signal Signal loss (Dub)> 11. Save the configuration. Page 14-12

147 Chapter 14: Configuring Measurements and the Measurement Table: Configuring a Measurement Table Entry for State Transitions and Durations Configuring a Measurement Table Entry for State Transitions and Durations In this scenario, you will: Configure a measurement table entry with name and description Configure the originator to use function to measure the number of state transitions To configure a measurement table entry that tracks the number of times the alarm table entry ExtTemp1 transitions to the major state: 1. At the main prompt, configure measurement table entry ExtTemp1_Transitions with description Number of External temperature high alarms: config meas-table entry ExtTemp1_Transitions description Number of External temperature high alarms 2. Configure the originator for this measurement with the following settings: Measurement Originator alarm-entry ExtTemp1 Active state major config meas-table entry ExtTemp1_Transitions (alarm-entry ExtTemp1, major) Note: The measurement can be used to measure the number of seconds an alarm is in the specified active state. 3. (optional) Verify that the measurement table entry has been configured properly: show meas-table entries ExtTemp1_Transitions The command response similar to the following displays: Page 14-13

148 Chapter 14: Configuring Measurements and the Measurement Table: Configuring a Measurement Table Entry for State Transitions and Durations (Dub)>show meas-table entries ExtTemp1_Transitions Name ExtTemp1_Transitions (static) State in-band Originator ( alarm-entry ExtTemp1, major ) Description Number of External temperature high alarms NE Name - Category - Report Interval - 0 Low-Band - 0 High-Band - 0 Hysteresis - 0 Max-Limit - 0 Min-Limit - 0 Units - Current Value - 3 Interval Value - 0 Interval Minimum - 0 Interval Maximum - 0 Interval Average - 0 (Dub)> Page 14-14

149 Chapter 14: Configuring Measurements and the Measurement Table: Configuring an Event Correlation for a Measurement Configuring an Event Correlation for a Measurement In this scenario, you will: Configure a correlation expression for fire danger, when a measurement from a temperature sensor exceeds a specified value while an alarm event from a smoke detector (connected to input 0/3) exists Configure the time (duration) for which the expression must remain true or false before the correlation matches the expression s state Create two alarm table entries for the correlation. To configure an event correlation for fire danger: 1. At the main prompt, configure an event correlation named FireDanger with description Correlation for temperature and smoke: config correlation FireDanger description Correlation for temperature and smoke 2. Configure the correlation expression for the value of measurement ExtTemp1 as greater than or equal to 90 and the smoke detector (input 0/3) as open: config correlation FireDanger expression measurement ExtTemp1 >= 90 and input 0/3 open 3. Configure the true duration time in the expression for 120 seconds, meaning an alarm will be sent if these conditions persist for two minutes; set the false duration time to 0 seconds (immediate), meaning an alarm will be sent immediately when either condition no longer exists: config correlation FireDanger duration (optional) Verify that the action has been configured properly: show correlation FireDanger The command response similar to the following displays: (Dub)>show correlation FireDanger Name : FireDanger Expression : measurement ExtTemp1 >= 90 and input 0/3 open True Duration : 90 False Duration : 0 Evaluation : false and false = false Value : false Description : Correlation for temperature and smoke (Dub)> Page 14-15

150 Chapter 14: Configuring Measurements and the Measurement Table: Configuring an Event Correlation for a Measurement To configure the alarm table entry for the fire danger correlation: 1. At the main prompt, configure the alarm entry name dooropen: config alarm-entry firedanger 2. Configure the alarm entry dooropen with the following parameters: event originator correlation FireDanger event type true event severity critical alarm message Fire alarm exists config alarm-entry firedanger event correlation FireDanger true critical Fire alarm exists 3. Configure the alarm entry doorclosed with the following parameters: event originator correlation FireDanger event type false event severity normal alarm message Fire alarm is cleared config alarm-entry dooropen event correlation FireDanger false normal Fire alarm is cleared 4. Save the configuration. Page 14-16

151 Configuring Mediation Connections This chapter provides information about how to configure mediation connections, events, responses and actions. Guide to this Chapter Overview Secure Terminal Server Access Configuring a TCP to Asynchronous Serial Connection Configuring a Telnet to Asynchronous Serial Connection CHAPTER 15 Configuring a SSH to Asynchronous Serial Connection Configuring an Asynchronous Serial to Asynchronous Serial Connection Configuring an Asynchronous Serial to TCP Connection Page 15-1

152 Chapter 15: Configuring Mediation Connections: Overview Overview Mediation connections allow you to connect different protocols. Examples of mediation connections include: Asynchronous to TCP connections and TCP to asynchronous connections Asynchronous to asynchronous connections TCP to TL1 multiplexer connections and TL1 multiplexer to network element (NE) connections A mediation connection can be configured to have multiple hops; however, the connection must have a source endpoint and a destination endpoint at a minimum. In addition, the connection can have data filters in the middle, for example, the Telnet filter acts as a Telnet server proxy. Except for mediation connections between an NE and a TL1 multiplexer, mediation connections are established through the configuration of events, responses and actions. Note: For more information on how to configure mediation connections between an NE and a TL1 multiplexer, refer to Chapter 16: Configuring and Connecting TL1 Infrastructure. Page 15-2

153 Chapter 15: Configuring Mediation Connections: Secure Terminal Server Access Secure Terminal Server Access The secure terminal server access feature provides a layer of encryption and authentication, creating a secure connection from a workstation to Remote RMM-800 or Remote RMC-700 to access a connected NE. The connection from Remote RMM- 800 or Remote RMC-700 to the NEs is not secure. The Secure Shell Protocol (SSH) is used to provide the secure connection and is suitable for both an interactive user session via a client like PuTTY or through any available SSH client library. The Redirect application provides SSH as an option for a virtual serial port s protocol in addition to TCP and Telnet protocols. Redirect also allows for user authentication options to be configured. Figure 15-1 shows the secure connection using SSH and a non-secure connection using Telnet. Figure 15-1 Secure and Non-Secure Connections Page 15-3

154 Chapter 15: Configuring Mediation Connections: Secure Terminal Server Access Terminal Server User Access A built-in user profile called restricted is available for users, which allows terminal server access but no CLI or FTP access. At the CLI, a user with the restricted profile will only be able to logout; no files will be available for retrieval via SFTP. TACACS+ Configuration If your Remote RMM-800 or Remote RMC-700 is configured for TACACS+, authorization and accounting of the secure terminal server login is performed according to your Remote RMX-3200 s or Remote RMM-700 s configuration. The authorization uses a TACACS+ service, aimediation, which is different from the one used for CLI logins. The aimediation service must be added to the TACACS+ server and associated with the appropriate users and groups. See the config mediation tacacs-service command in the Remote RMC-700 and Remote RMM-800 Command Reference Guide for more information. Page 15-4

155 Chapter 15: Configuring Mediation Connections: Configuring a TCP to Asynchronous Serial Connection Configuring a TCP to Asynchronous Serial Connection In this scenario, you will configure a mediation connection between a TCP port and an asynchronous serial controller. You will set up an action, event and response that cause the TCP port and controller to connect. To configure a TCP connection to an asynchronous connection: 1. Configure event tcp40010 with originator tcp :40010 and event type incoming-connection: config event tcp40010 content tcp :40010 incomingconnection Note: The TCP originator IP address is optional if it is the same as the Remote RMM-800 or Remote RMC-700 bridge switch interface IP address. 2. Configure response tcp40010toserial2 with responder tcp :40010 and response type dest serial 2: config response tcp40010toserial2 content tcp :40010 connect dest serial 2 3. Configure action tcptoserial2 with event tcp40010 and response tcp40010toserial2: config action tcptoserial2 event tcp40010 response tcp40010toserial2 4. (optional) Verify that the TCP to asynchronous connection has been configured properly: show actions tcptoserial2 The command response similar to the following displays: (Dub)>show actions tcptoserial2 Action Name : tcptoserial2 Action Description : Event Name : tcp40010 Event Description : Event Originator : tcp :40010 Event Type : incoming-connection Response Name : tcp40010toserial2 Response Description : Response Responder : tcp :40010 Response Type : connect Response Parameters : dest=serial 2 (Dub)> Page 15-5

156 Chapter 15: Configuring Mediation Connections: Configuring a TCP to Asynchronous Serial Connection 5. Configure controller serial 2 to connect and disconnect as DCD goes active and inactive: config controller serial 2 connect mode dcd config controller serial 2 disconnect mode dcd 6. Configure the application mode as destination: config controller serial 2 application destination 7. (optional) Verify that a connection is established: show connections The command response similar to the following displays: (Dub)>show connections tcp :40010:4 -> serial 2 (Dub)> Note: The 4 that comes after the TCP port number is an internal reference number generated by Remote RMM-800 or Remote RMC Save the configuration. Page 15-6

157 Chapter 15: Configuring Mediation Connections: Configuring a Telnet to Asynchronous Serial Connection Configuring a Telnet to Asynchronous Serial Connection In this scenario, you will configure a mediation connection between a Telnet port and an asynchronous serial controller. You will set up an action, event and response that cause the Telnet port and controller to connect. To configure a Telnet to asynchronous serial connection: 1. Configure event IncTelnetConn to signal that an incoming telnet connection request has been received on port at IP address : config event IncTelnetConn content telnet :60002 incoming-connection 2. Configure response telnet60002toserial1 to connect Telnet port at IP address to destination serial 1: config response telnet60002toserial1 content telnet :60002 connect dest serial 1 3. Configure response telnet60002toserial1 to cause a Telnet connection from port at IP address to operate in binary mode: config response telnet60002toserial1 content telnet :60002 connect options -b 4. Configure action telnettoserial to associate event IncTelnetConn with response telnet60002toserial1: config action telnettoserial event IncTelnetConn response telnet60002toserial1 5. (optional) Verify that the Telnet to asynchronous connection has been configured properly: show actions telnettoserial The command response similar to the following displays: Page 15-7

158 Chapter 15: Configuring Mediation Connections: Configuring a Telnet to Asynchronous Serial Connection (Dub)>show actions telnettoserial Action Name : telnettoserial Action Description : Event Name : IncTelnetConn Event Description : Event Originator : telnet :60002 Event Type : incoming-connection Response Name : telnet60002toserial1 Response Description : Response Responder : telnet :60002 Response Type : connect Response Parameters : dest=serial 1 options=-b (Dub)> 6. Configure controller serial 1 to connect and disconnect as DCD goes active and inactive: config controller serial 1 connect mode dcd config controller serial 1 disconnect mode dcd 7. Configure the application mode as destination: config controller serial 1 application destination 8. (optional) Verify that a connection is established: show connections The command response similar to the following displays: (Dub)>show connections telnet :40010:4 -> serial 1 (Dub)> Note: The 4 that comes after the TCP port number is an internal reference number generated by Remote RMM-800 or Remote RMC Save the configuration. Page 15-8

159 Chapter 15: Configuring Mediation Connections: Configuring a SSH to Asynchronous Serial Connection Configuring a SSH to Asynchronous Serial Connection In this scenario, you will configure a mediation connection between an SSH port and an asynchronous serial controller. You will set up an action, event and response that cause the SSH port and controller to connect. In addition, you will configure: A user profile authorized for terminal server access A service that is passed to the TACACS+ server when authenticating users for mediation To configure an SSH to asynchronous serial connection: 1. Configure event IncSSHConn to signal that an incoming SSH connection request has been received on port at IP address : config event IncSSHConn content ssh :20001 incoming-connection 2. Configure response SSH20001ToSerial2 to connect SSH port at IP address to destination serial 2: config response SSH20001ToSerial2 content ssh :20001 connect dest serial 2 3. Configure action SSHToSerial to associate event IncSSHConn with response SSH20001ToSerial2: config action SSHToSerial event IncSSHConn response ssh20001toserial2 4. (optional) Verify that the SSH to asynchronous connection has been configured properly: show actions SSHToSerial The command response similar to the following displays: Page 15-9

160 Chapter 15: Configuring Mediation Connections: Configuring a SSH to Asynchronous Serial Connection (Dub)>show actions SSHToSerial Action Name : SSHToSerial Action Description : Event Name : IncSSHConn Event Description : Event Originator : ssh :20001 Event Type : incoming-connection Response Name : ssh20001toserial2 Response Description : Response Responder : ssh :20001 Response Type : connect Response Parameters : dest=serial 2 (Dub)> 5. Configure controller serial 2 to connect and disconnect as DCD goes active and inactive: config controller serial 2 connect mode dcd config controller serial 2 disconnect mode dcd 6. Configure the application mode as destination: config controller serial 2 application destination 7. (optional) Verify that a connection is established: show connections The command response similar to the following displays: (Dub)>show connections ssh :20001:4 -> serial 2 (Dub)> Note: The 4 that comes after the TCP port number is an internal reference number generated by Remote RMM-800 or Remote RMC (Optional) Create a new user named ebh, password jimbo, with the restricted profile, authorizing this user for terminal server access: config users add ebh restricted jimbo jimbo 9. (Optional) Configure the aimediation service (the default) on the TACACS+ server, which will be used when authenticating users for mediation: config mediation default tacacs-service Note: You will need to add priv_lvl=0 to the aimediation service on the TACACS+ server. 10. Save the configuration. Page 15-10

161 Chapter 15: Configuring Mediation Connections: Configuring an Asynchronous Serial to Asynchronous Serial Connection Configuring an Asynchronous Serial to Asynchronous Serial Connection In this scenario, you will configure a mediation connection between two asynchronous serial controllers. You will set up an action, event and response that cause the controllers to connect. To configure an asynchronous serial to asynchronous serial connection: 1. Configure event serial2up with originator serial 2 and event type up: config event serial2up content serial 2 up 2. Configure response serial2connect with responder serial 2 and response type connect with destination serial 1: config response serial2connect content serial 2 connect dest serial 1 3. Configure action serial2toserial1 with event serial2up and response serial2connect: config action serial2toserial1 event serial2up response serial2connect 4. (optional) Verify that the asynchronous to asynchronous connection has been configured properly: show actions serial2toserial1 The command response similar to the following displays: (Dub)>show actions serial2toserial1 Action Name : serial2toserial1 Action Description : Event Name : serial2up Event Description : Event Originator : serial 2 Event Type : up Response Name : serial2connect Response Description : Response Responder : serial 2 Response Type : connect Response Parameters : dest=serial 1 (Dub)> Page 15-11

162 Chapter 15: Configuring Mediation Connections: Configuring an Asynchronous Serial to Asynchronous Serial Connection 5. (optional) At the main prompt, configure controller serial 1 with application mode destination: config controller serial 1 application destination Note: By default, asynchronous serial controllers are configured to act as both sources and destinations for connections, which makes configuration of this command optional. 6. (optional) Configure connection mode activity: config controller serial 1 connect mode activity 7. Configure controller serial 2 application mode as source: config controller serial 2 application source 8. Configure connection mode dcd: config controller serial 2 connect mode dcd 9. (optional) Verify that the serial controllers have been configured properly: show controllers serial 1 The command response similar to the following displays: (Dub)>show controllers serial 1 serial 1 status=enabled link-state=down encapsulation= baud=9600 databits=8 stopbits=1 parity=none resource-state=unassigned flow-control=none linemode=rs232 dial-timer=1 init-string= connect-mode= activity rts-connect-mode=on dtr-connect-mode=on disconnect-mode= rts-disconnect-mode=off dtr-disconnect-mode=off parity-errors=0 description=asynchronous port application=destination (Dub)> show controllers serial 2 The command response similar to the following displays: Page 15-12

163 Chapter 15: Configuring Mediation Connections: Configuring an Asynchronous Serial to Asynchronous Serial Connection (Dub)>show controllers serial 2 serial 2 status=enabled link-state=down encapsulation= baud=9600 databits=8 stopbits=1 parity=none resource-state=unassigned flow-control=none linemode=rs232 dial-timer=1 init-string= connect-mode=dcd rts-connect-mode=on dtr-connect-mode=on disconnect-mode= rts-disconnect-mode=off dtr-disconnect-mode=off parity-errors=0 description=asynchronous port application=source (Dub)> 10. (optional) Manually connect a device to controller serial 2 and send data. 11. (optional) Verify that a connection is established: show connections The command response similar to the following displays: (Dub)>show connections serial 2 -> serial 1 (Dub)> 12. Save the configuration. Page 15-13

164 Chapter 15: Configuring Mediation Connections: Configuring an Asynchronous Serial to TCP Connection Configuring an Asynchronous Serial to TCP Connection In this scenario, you will configure a mediation connection between an asynchronous serial controller and a TCP port. You will set up an action, event and response that cause the controller and TCP port to connect. To configure an asynchronous to TCP connection: 1. Configure event serial1up with originator serial 1 and event type up: config event serial1up content serial 1 up 2. Configure response serial1connecttonoc with responder serial 1 and response type connect. The destination of the connect response is TCP port 5001 at IP address : config response serial1connecttonoc content serial 1 connect dest tcp : Configure action serial1tonoc with event serial1up and response serial1connecttonoc: config action serial1tonoc event serial1up response serial1connecttonoc 4. (optional) Verify that the asynchronous to TCP connection has been configured properly: show actions serial1tonoc The command response similar to the following displays: (Dub)>show actions serial1tonoc Action Name : serial1tonoc Action Description : Event Name : serial1up Event Description : Event Originator : serial 1 Event Type : up Response Name : serial1connecttonoc Response Description : Response Responder : serial 1 Response Type : connect Response Parameters : dest=tcp :5001 (Dub)> 5. Configure the application mode as source: config controller serial 1 application source Page 15-14

165 Chapter 15: Configuring Mediation Connections: Configuring an Asynchronous Serial to TCP Connection 6. (optional) Verify that a connection is established: show connections The command response similar to the following displays: (Dub)>show connections serial 1 -> tcp :5001 (Dub)> 7. Save the configuration. Page 15-15

166 Chapter 15: Configuring Mediation Connections: Configuring an Asynchronous Serial to TCP Connection Page 15-16

167 Configuring and Connecting TL1 Infrastructure This chapter provides information about how to configure a TL1 multiplexer and a virtual TL1 NE. This chapter also provides step-by-step scenarios on how to configure a meditation connection from a TL1 multiplexer to an NE with a TCP or asynchronous connection and how to configure a virtual TL1 NE to establish a meditation connection to a TL1 multiplexer. Guide to this Chapter Overview Configuring a TL1 Multiplexer CHAPTER 16 Configuring a Virtual TL1 NE Configuring the TCP Port for a TL1 Multiplexer Configuring a Telnet Connection to a TL1 Multiplexer Configuring a Telnet Connection to a Virtual TL1 NE Page 16-1

168 Chapter 16: Configuring and Connecting TL1 Infrastructure: Overview Overview In order to configure TL1 alarms and mediation connections on Remote RMM-800 or Remote RMC-700, you must configure the infrastructure for TL1 reporting. TL1 is an ASCII-based language for management of network elements. The TL1 infrastructure on Remote RMC-700 and Remote RMM-800 consists of TL1 multiplexers and virtual TL1 NEs (VNEs). A TL1 multiplexer is a software component that uses TIDs to multiplex several TL1 data streams onto a single TCP connection. It can be configured to connect to varbinds, real TL1 NEs and scripts that generate TL1. A TL1 multiplexer acts like a TL1 GNE, which provides a single point of contact to multiple subtending NEs. A virtual TL1 NE is a simulation of a TL1 NE environment for generating TL1 alarms and responding to TL1 commands. A VNE typically might be used for generating alarms based upon digital and analog inputs and controlling relay outputs. Note: TL1 multiplexers and TL1 NEs must be configured for use on the Remote RMM-800 or Remote RMC-700. Refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide. Page 16-2

169 Chapter 16: Configuring and Connecting TL1 Infrastructure: Configuring a TL1 Multiplexer Configuring a TL1 Multiplexer In this scenario, you will: Configure a mediation connection from the TL1 multiplexer to a Varbind (VNE) Configure a TCP mediation connection from the TL1 multiplexer to a real NE Configure an asynchronous mediation connection from the TL1 multiplexer to a real NE. The traffic from these NE s will be multiplexed onto a single TCP connection through a TL1 multiplexer. To configure a TL1 multiplexer: 1. At the main prompt, configure a mediation connection from tl1mux 2 to tl1ne 2: config mediation tl1mux 2 conn tl1ne2 2. Configure a mediation connection from tl1mux 2 to a real NE with IP address , TCP port 5003 and whose TID is TCPTID: config mediation tl1mux 2 conn :5003-TCPTID 3. Configure a mediation connection from tl1mux 2 to a real NE connected to asynchronous port async2 and whose TID is ASYNCTID: config mediation tl1mux 2 conn async2-asynctid 4. Enable tl1mux 2: config mediation tl1mux 2 enable 5. (optional) Verify that tl1mux 2 has been configured properly: show mediation tl1muxes 2 The command response similar to the following displays: (Dub)>show mediation tl1muxes 2 Mux-ID - 2 State - enabled Connection Strings: tl1ne :5003-TCPTID async2-asynctid (Dub)> 6. Save the configuration. Page 16-3

170 Chapter 16: Configuring and Connecting TL1 Infrastructure: Configuring a Virtual TL1 NE Configuring a Virtual TL1 NE In this scenario, you will configure the login information, TID and message settings for a virtual TL1 NE. Note: A virtual NE listens for a connection from a TL1 multiplexer above it in the TL1 infrastructure. Once a multiplexer has made a connection to the VNE, a user or OSS can log in using the ACT-USER command. Currently, each VNE supports a single user session. To configure a virtual TL1 NE: 1. At the main prompt, configure a user with login name JohnDoe and password Password for tl1ne 2: config mediation tl1ne 2 user JohnDoe Password 2. Configure tl1ne 2 and its TID as mytid: config mediation tl1ne 2 tid mytid 3. Enable tl1ne 2: config mediation tl1ne 2 enable 4. Configure tl1ne 2 to send autonomous messages without a login: config mediation tl1ne 2 automsgs nologon 5. Configure tl1ne 2 to send header messages without a login: config mediation tl1ne 2 rtrvhdr nologon 6. (optional) Verify that tl1ne 2 has been configured properly: show mediation tl1nes 2 The command response similar to the following displays: (Dub)>show mediation tl1nes 2 NE-ID - 2 State - enabled AutoMsgs - nologon RtrvHdr - nologon TID - mytid Description: Users: UID PID JohnDoe Password (Dub)> 7. Save the configuration. Page 16-4

171 Chapter 16: Configuring and Connecting TL1 Infrastructure: Configuring the TCP Port for a TL1 Multiplexer Configuring the TCP Port for a TL1 Multiplexer To configure an incoming TCP connection to connect to a TL1 multiplexer using In this scenario, you will: Configure an event that matches an incoming TCP connection on TCP port Configure a response that connects the incoming TCP connection to a TL1 multiplexer Configure an action that associates the event with the response. When Remote RMM-800 or Remote RMC-700 receives the incoming TCP connection, the action connects it to the TL1 multiplexer. events, responses and actions: 1. At the main prompt, configure event ossconnection with originator as tcp and event type as incoming-connection: config event ossconnection content tcp incoming-connection 2. Configure response connecttomux2 with the responder as tcp and with the response type as connect. The destination is tl1mux 2: config response connecttomux2 content tcp connect dest tl1mux 2 3. Configure action osstomux with event ossconnection and response connecttomux2: config action osstomux event ossconnection response connecttomux2 4. (optional) Verify that action osstomux has been configured properly: show actions osstomux The command response similar to the following displays: 5. Save the configuration. Page 16-5 (Dub)>show actions osstomux Action Name : osstomux Action Description : Event Name : ossconnection Event Description : Event Originator : tcp Event Type : incoming-connection Response Name : connecttomux2 Response Description : Response Responder : tcp Response Type : connect Response Parameters : dest=tl1mux 2 (Dub)>

172 Chapter 16: Configuring and Connecting TL1 Infrastructure: Configuring a Telnet Connection to a TL1 Multiplexer Configuring a Telnet Connection to a TL1 Multiplexer In this scenario, you will: Configure an event to signal that an incoming Telnet connection request has been received on a port Configure a response to connect a Telnet port to a TL1 multiplexer destination Configure an action to associate the event with the response. To configure a Telnet connection to a TL1 multiplexer: 1. At the main prompt, configure event telnetconn to signal that an incoming telnet connection request has been received on port 40004: config event telnetconn content telnet incoming-connection 2. Configure response telnet40004tomux3 to connect Telnet port to destination tl1mux 3: config response telnet40004tomux3 content telnet connect dest tl1mux 3 3. Configure action telnettomux to associate event telnetconn with response telnet40004tomux3: config action telnettomux event telnetconn response telnet40004tomux3 4. (optional) Verify that the connection has been configured properly: show actions telnettomux The command response similar to the following displays: (Dub)>show actions telnettomux Action Name : telnettomux Action Description : Event Name : telnetconn Event Description : Event Originator : telnet Event Type : incoming-connection Response Name : telnet40004tomux3 Response Description : Response Responder : telnet Response Type : connect Response Parameters : dest=tl1mux 3 (Dub)> 5. Save the configuration. Page 16-6

173 Chapter 16: Configuring and Connecting TL1 Infrastructure: Configuring a Telnet Connection to a Virtual TL1 NE Configuring a Telnet Connection to a Virtual TL1 NE In this scenario, you will: Configure an event to signal that an incoming Telnet connection request has been received on a port Configure a response to connect a Telnet port to a VNE destination Configure an action to associate the event with the response. To configure a Telnet connection to a VNE: 1. At the main prompt, configure event telnetconn to signal that an incoming telnet connection request has been received on port 40004: config event telnetconn content telnet incoming-connection 2. Configure response telnet40004tovne3 to connect Telnet port to destination tl1ne 3: config response telnet40004tovne3 content telnet connect dest tl1ne 3 3. Configure action telnettovne to associate event telnetconn with response telnet40004tovne3: config action telnettovne event telnetconn response telnet40004tovne3 4. (optional) Verify that the connection has been configured properly: show actions telnettovne The command response similar to the following displays: (Dub)>show actions telnettovne Action Name : telnettovne Action Description : Event Name : telnetconn Event Description : Event Originator : telnet Event Type : incoming-connection Response Name : telnet40004tovne3 Response Description : Response Responder : telnet Response Type : connect Response Parameters : dest=tl1ne 3 (Dub)> 5. Save the configuration. Page 16-7

174 Chapter 16: Configuring and Connecting TL1 Infrastructure: Configuring a Telnet Connection to a Virtual TL1 NE Page 16-8

175 Configuring DHCP This chapter provides information on configuring the DHCP server with an associated host and subnet and configuring DHCP client support. Guide to this Chapter DHCP Server Overview Configuring a DHCP Server Configuring a DHCP Server Subnet Configuring a Host on a DHCP Server CHAPTER 17 Configuring BOOTP/DHCP Relay Configuring DHCP Client Support Page 17-1

176 Chapter 17: Configuring DHCP: DHCP Server Overview DHCP Server Overview The DHCP server lets hosts connected to Remote RMM-800 or Remote RMC-700's or Remote RMM-700 s Ethernet interfaces request and obtain IP addresses from Remote RMM-800 or Remote RMC-700. It also lets hosts discover information about the network to which they are attached. Available IP addresses are allocated by a network administrator who enters them into a DHCP configuration file. The DHCP protocol then automatically assigns new IP addresses to hosts from the pool of IP addresses. At startup, the DHCP server reads the DHCP configuration file and stores a list of available addresses on each subnet in memory. When a client requests an address, the DHCP server allocates an address for it. Each client is assigned a lease that expires after an amount of time chosen by the administrator. Clients to which leases are assigned are expected to renew them in order to continue to use the addresses. Once a lease has expired, the client to which that lease was assigned is no longer permitted to use the leased IP address. DHCP Client Support Providing DHCP client support on Remote RMM-800 or Remote RMC-700 will allow the Remote RMM-800 or Remote RMC-700 device to dynamically configure its network information from a DHCP server. This reduces the amount of configuration required from the user to gain network access to a Remote RMM-800 or Remote RMC-700 and centralizes the control of IP address to a single DHCP server. With the DHCP client enabled on an interface, Remote RMC-700 and Remote RMM-800 have the ability to dynamically configure an interface's IP address, DNS server information, domain name information and NTP server information. Note: For more information on DHCP, refer to the dhcpd linux man page. Page 17-2

177 Chapter 17: Configuring DHCP: Configuring a DHCP Server Configuring a DHCP Server In this scenario, you will: Enable DHCP authority mode Enable DHCP broadcast mode Configure the DHCP server to use a configuration file Configure the DHCP server to run on the bridge interface Configure the DHCP server subnet with an IP address and subnet mask. To configure the DHCP server settings: 1. At the main prompt, enable the DHCP authority mode: config dhcp-server authority 2. Enable the DHCP broadcast mode: config dhcp-server broadcast 3. Configure the DHCP server to run on interface bridge switch: config dhcp-server interface bridge switch 4. Configure the DHCP server subnet with IP address and subnet mask : config dhcp-server subnet Note: Up to 25 subnets are configurable on the DHCP server. For information on further DHCP server subnet configurations, refer to section Configuring a DHCP Server Subnet on page Page 17-3

178 Chapter 17: Configuring DHCP: Configuring a DHCP Server 5. (optional) Verify that the DHCP server has been configured properly: show dhcp-server The command response similar to the following displays: (Dub)>show dhcp-server Admin State: disabled Broadcast: enabled Authority: enabled Config file: Note: User specified configuration files will override configured DHCP server settings. Interfaces: bridge switch Subnets: /16 range= / router= default-lease=3600 max-lease=28800 DNS: Hosts: (Dub)> 6. Save the configuration. Tip: Remote RMC-700 and Remote RMM-800 let you specify a DHCP server configuration file. This file overrides any DHCP server settings configured in the Remote RMM-800 or Remote RMC-700 CLI. If you do not specify the correct DHCP server configuration file, Remote RMM-800 or Remote RMC-700 generates an error. The following command specifies file dhcpconfig1.txt as the DHCP configuration file: config dhcp-server config-file dhcpconfig1.txt The DHCP server configuration file must exist in Remote RMM-800 or Remote RMC-700 directory /config/dhcp before you can specify it as the configuration file in the Remote RMM-800 or Remote RMC-700 CLI. For information about creating a DHCP server configuration file, refer to the dhcpd.conf man page. Page 17-4

179 Chapter 17: Configuring DHCP: Configuring a DHCP Server Subnet Configuring a DHCP Server Subnet In this scenario, you will set up the following items for a DHCP server subnet: Configure a maximum lease time Configure a default lease time Configure a domain name server address Configure an IP address range Configure a router address. To configure settings for DHCP server subnet /16: 1. Configure maximum lease time 40000: config dhcp-server subnet /16 max-lease Configure default lease time 36000: config dhcp-server subnet /16 default-lease Configure domain name server : config dhcp-server subnet /16 domain-name-server Configure IP address range to : config dhcp-server subnet /16 range Configure router : config dhcp-server subnet /16 router Page 17-5

180 Chapter 17: Configuring DHCP: Configuring a DHCP Server Subnet 6. (optional) Verify that the DHCP server has been configured properly: show dhcp-server The command response similar to the following displays: (Dub)>show dhcp-server Admin State: disabled Broadcast: enabled Authority: enabled Config file: Note: User specified configuration files will override configured DHCP server settings. Interfaces: bridge switch Subnets: /16 range= / router= default-lease=36000 max-lease=40000 DNS: Hosts: (Dub)> 7. Save the configuration. Page 17-6

181 Chapter 17: Configuring DHCP: Configuring a Host on a DHCP Server Configuring a Host on a DHCP Server In this scenario, you will: Configure a DHCP server host Configure a host hardware address Configure a host IP address. To configure a host on a DHCP server: 1. Configure host firsthostconfig with hardware address 12:e3:a2:45:c5:b3: config dhcp-server host firsthostconfig hardware-address 12:e3:a2:45:c5:b3 2. Configure host firsthostconfig with IP address : config dhcp-server host firsthostconfig ip address Note: The host IP address must be within one of the subnetworks being served by the DHCP server. For more information, refer to section Configuring a DHCP Server Subnet on page (optional) Verify that the DHCP server has been configured properly: show dhcp-server The command response similar to the following displays: (Dub)>show dhcp-server Admin State: disabled Broadcast: enabled Authority: enabled Config file: Note: User specified configuration files will override configured DHCP server settings. Interfaces: bridge switch Subnets: /16 range= / router= default-lease=36000 max-lease=40000 DNS: Hosts: firsthostconfig MAC=12:E3:A2:45:C5:B3 IP= (Dub)> 4. Save the configuration. Page 17-7

182 Chapter 17: Configuring DHCP: Configuring BOOTP/DHCP Relay Configuring BOOTP/DHCP Relay In this scenario, you will configure the BOOTP/DHCP server and enable BOOTP/DHCP relay. When BOOTP/DHCP relay is enabled, Remote RMM-800 or Remote RMC-700 acts as a BOOTP/DHCP relay agent; it passes BOOTP/DHCP configuration information between BOOTP/DHCP clients and servers. To configure and enable BOOTP/DHCP relay: 1. Configure the BOOTP/DHCP server IP address as : config dhcp-relay server Enable BOOTP/DHCP relay: config dhcp-relay enable 3. (optional) Verify that the BOOTP/DHCP relay settings have been configured properly: show dhcp-relay The command response similar to the following displays: (Dub)>show dhcp-relay bootp/dhcp relay is enabled bootp/dhcp relay servers: (Dub)> 4. Save the configuration. Page 17-8

183 Chapter 17: Configuring DHCP: Configuring DHCP Client Support Configuring DHCP Client Support In this scenario, you will enable DHCP client support and configure a ten-minute interval for Remote RMM-800 or Remote RMC-700 to retry contacting the DHCP server. Note: DHCP client support cannot be enabled on the bridge group switch if a static IP address has already been configured. You must remove the static IP address before enabling DHCP client support. To enable DHCP client support and configure the retry-timeout interval: 1. Enable DHCP client support: config interface bridge switch ip dhcp enable 2. Configure the DHCP retry-timeout value as 10 minutes: config interface bridge switch ip dhcp retry-timeout (optional) Verify that the DHCP client settings have been configured properly: show interface bridge switch The command response similar to the following displays: Note: The DHCP-related statements (shown below in boldface type) do not appear unless DHCP client support is enabled. (Dub)>show interface bridge switch bridge switch system-name=br_switch status=enabled link-state=up address= /16 dhcp-status=enabled dhcp-state=bound dhcp-retry-timeout=10 dhcp-address= /16 dhcp-lease-acquired=fri Apr 16 13:57:37 EST 2010 dhcp-lease-expires=sun Apr 18 13:57:37 EST 2010 dhcp-routers= dhcp-server-id= Stats: Bytes Packets Errors Dropped Overrun Framing Rx Tx ethernet 1 Stats: Bytes Packets Errors Dropped Overrun Framing Rx Tx ethernet 2 Stats: Bytes Packets Errors Dropped Overrun Framing Rx Tx More-- 4. Save the configuration. Page 17-9

184 Chapter 17: Configuring DHCP: Configuring DHCP Client Support Page 17-10

185 Configuring Relay Outputs This chapter provides information about how to configure relay outputs. Guide to this Chapter Overview Configuring the Mediation TL1 Command Configuring TL1 Commands to Control a Relay Output Configuring SNMP to Operate a Relay Output CHAPTER 18 Directly Controlling a Relay Output Page 18-1

186 Chapter 18: Configuring Relay Outputs: Overview Overview In this chapter, you will complete a scenario that activates a relay output using a TL1 command. You will configure a virtual NE (VNE) to generate an event when it receives a specific TL1 command. Relay outputs have two states: open and close. You will configure a VNE to generate an event when a matching TL1 command is received. The TL1 VNE will compare the incoming command code, TID and AID against a configured command. If there is a match, the TL1 VNE will generate the event, which triggers the response to turn on the device (a fan). Note: For more information on how to configure a TL1 multiplexer and a TL1 VNE, refer to Configuring a TL1 Multiplexer on page 16-3 and Configuring a Virtual TL1 NE on page Page 18-2

187 Chapter 18: Configuring Relay Outputs: Configuring the Mediation TL1 Command Configuring the Mediation TL1 Command Remote RMC-700 and Remote RMM-800 TL1 VNEs can generate events in response to TL1 commands. VNEs match up incoming command codes, TIDs and AIDs against preconfigured command, TID and AID tuplets. If the VNE finds a match, it generates a corresponding event. This event can trigger any response in the system and is used to create a command for relay output activation. In this scenario, you will configure a fan control application that supports configured TL1 commands OPR-EXT-CONT and RLS-EXT-CONT. Note: For information about valid default Remote RMM-800 or Remote RMC-700 TL1 commands, refer to Chapter 26: TL1 Commands. All available TL1 commands are documented in the Telcordia GR 833-CORE documentation. To configure TL1 command patterns for a fan application: 1. Configure TL1 command pattern identifier fanon with TL1 command OPR-EXT- CONT, TID mytid and AID 1-fan: config mediation tl1command fanon OPR-EXT-CONT mytid 1-fan 2. Configure TL1 command pattern identifier fanoff with TL1 command RLS-EXT- CONT, TID mytid and AID 1-fan: config mediation tl1command fanoff RLS-EXT-CONT mytid 1-fan 3. (optional) Verify that TL1 command pattern fanon has been configured properly: show mediation tl1commands fanon The command response similar to the following displays: (Dub)>show mediation tl1commands fanon Name - fanon Command Pattern - OPR-EXT-CONT TID - mytid AID - 1-fan (Dub)> 4. (optional) Verify that TL1 command pattern fanoff has been configured properly: show mediation tl1commands fanoff The command response similar to the following displays: (Dub)>show mediation tl1commands fanoff Name - fanoff Command Pattern - RLS-EXT-CONT TID - mytid AID - 1-fan (Dub)> Page 18-3

188 Chapter 18: Configuring Relay Outputs: Configuring TL1 Commands to Control a Relay Output Configuring TL1 Commands to Control a Relay Output In this scenario, you will: Configure events that occur when specific TL1 commands are received on a virtual TL1 NE Configure responses that open and close a relay output Configure actions that associate the events with the responses. To configuretl1 commands to control relay outputs: 1. At the main prompt, configure event fanoncmd with originator tl1ne 2 and event type tl1cmd-rcvd with command fanon: config event fanoncmd content tl1ne 2 tl1cmd-rcvd fanon 2. At the main prompt, configure event fanoffcmd with originator tl1ne 2 and event type tl1cmd-rcvd with command fanoff: config event fanoffcmd content tl1ne 2 tl1cmd-rcvd fanoff 3. (optional) At the main prompt, add description Fan control to discrete output 0/1: config discrete output 0/1 description Fan control 4. Configure response fanonreponse with responder output 0/1 and response type close: config response fanonresponse content output 0/1 close 5. Configure response fanoffreponse with responder output 0/1 and response type open: config response fanoffresponse content output 0/1 open 6. Configure action fanonaction with the event fanoncmd and response fanonresponse: config action fanonaction event fanoncmd response fanonresponse 7. Configure action fanoffaction with the event fanoffcmd and response fanoffresponse: config action fanoffaction event fanoffcmd response fanoffresponse Page 18-4

189 Chapter 18: Configuring Relay Outputs: Configuring TL1 Commands to Control a Relay Output 8. (optional) Verify that action fanonaction has been configured properly: show actions fanonaction The command response similar to the following displays: (Dub)>show actions fanonaction Action Name : fanonaction Action Description : Event Name : fanoncmd Event Description : Event Originator : tl1ne 2 Event Type : tl1cmd-rcvd fanon Response Name : fanonresponse Response Description : Response Responder : output 0/1 Response Type : close Response Parameters : No parameters configured for this response. (Dub)> 9. (optional) Verify that action fanoffaction has been configured properly: show actions fanoffaction The command response similar to the following displays: (Dub)>show actions fanoffaction Action Name : fanoffaction Action Description : Event Name : fanoffcmd Event Description : Event Originator : tl1ne 2 Event Type : tl1cmd-rcvd fanoff Response Name : fanoffresponse Response Description : Response Responder : output 0/1 Response Type : open Response Parameters : No parameters configured for this response. (Dub)> 10. Save the configuration. Page 18-5

190 Chapter 18: Configuring Relay Outputs: Configuring SNMP to Operate a Relay Output Configuring SNMP to Operate a Relay Output In this scenario, you will: Configure SNMP events to generate manager sets Configure relay output close and open responses Configure actions to associate the events with the responses. To configure SNMP to manage a relay output: 1. Configure SNMP event snmpclose with manager set output1_close: config event snmpclose content snmp manager-set output1_close 2. Configure SNMP event snmpopen with manager set output1_open: config event snmpopen content snmp manager-set output1_open 3. Configure response switchclose to close output 0/1: config response switchclose content output 0/1 close 4. Configure response switchopen to open output 0/1: config response switchopen content output 0/1 open 5. Configure action snmpoutputclose to associate event snmpclose with response switchclose: config action snmpoutputclose event snmpclose response switchclose 6. Configure action snmpoutputopen to associate event snmpopen with response switchopen: config action snmpoutputopen event snmpopen response switchopen Page 18-6

191 Chapter 18: Configuring Relay Outputs: Configuring SNMP to Operate a Relay Output 7. (optional) Verify that action snmpoutputclose has been configured properly: show actions snmpoutputclose The command response similar to the following displays: (Dub)>show actions snmpoutputclose Action Name : snmpoutputclose Action Description : Event Name : snmpclose Event Description : Event Originator : snmp Event Type : manager-set output1_close Response Name : switchclose Response Description : Response Responder : output 0/1 Response Type : close Response Parameters : No parameters configured for this response. (Dub)> 8. (optional) Verify that action snmpoutputopen has been configured properly: show actions snmpoutputopen The command response similar to the following displays: (Dub)>show actions snmpoutputopen Action Name : snmpoutputopen Action Description : Event Name : snmpopen Event Description : Event Originator : snmp Event Type : manager-set output1_open Response Name : switchopen Response Description : Response Responder : output 0/1 Response Type : open Response Parameters : No parameters configured for this response. (Dub)> 9. Save the configuration. 10. To cause the events to occur, issue an SNMP set on the aimediation event object, which is in the aimediationv2 MIB. Use the same names that were used for the manager sets in the SNMP events (output1_close and output1_open). Page 18-7

192 Chapter 18: Configuring Relay Outputs: Directly Controlling a Relay Output Directly Controlling a Relay Output In this scenario, you will directly open and close a relay output. To directly open and close a relay output: 1. Open output 0/1: diag output 0/1 open 2. Close output 0/1 for 10 seconds: diag output 0/1 close (optional) Verify the status of output 0/1: show discrete outputs 0/1 The command response similar to the following displays: (Dub)>show discrete outputs 0/1 ID - 0/1 Description - Resource State - unassigned Value - open (Dub)> Note: For details on the operation of the output relays for Remote RMC-700 and Remote RMM-800, see the Remote RMX-3200 Installation Guide or the Remote RMM-700 Installation Guide. Note: For additional related information, see the Remote RMC-700 and Remote RMM-800 Command Reference Guide sections config discrete analog, config discrete output, and show discrete. Page 18-8

193 Configuring the SNMP Proxy This chapter provides information about how to configure the Remote RMM-800 or Remote RMC-700 SNMP Proxy feature. Guide to this Chapter SNMP Proxy Feature Overview SNMP Proxy Configuration Information Configuring a Mediation SNMP Event Template CHAPTER 19 Configuring a Mediation SNMP Point Template Configuring a Mediation SNMP NE Template Configuring a Mediation SNMP Measurement Template Configuring a Mediation SNMP Network Element Configuration Results Page 19-1

194 Chapter 19: Configuring the SNMP Proxy: SNMP Proxy Feature Overview SNMP Proxy Feature Overview The Remote RMC-700 and Remote RMM-800 SNMP Proxy feature allows for virtual network elements (NEs) to represent devices which are subtended from Remote RMM-800 or Remote RMC-700. Remote RMM-800 or Remote RMC-700 acts as the SNMP manager for the real NE. This means that an NE can be hidden on the network, yet still monitored by Remote RMM-800 or Remote RMC-700. The various states of the NEs are represented in Remote RMM-800 or Remote RMC- 700 s alarm table, which provides a mechanism for management systems to query the state and receive alarms. One major benefit of this feature is a reduction in IP address requirements for sites, where private addressing can be used between the SNMP device and Remote RMM- 800 or Remote RMC-700. Figure 19-1 shows the interaction of the mediation NEs (snmp ne1 and snmp ne2) inside Remote RMC-700 and Remote RMM-800 with the real SNMP NEs and the action and alarm table mediation subsystems. Figure 19-1 Remote SNMP Proxy Configuration Page 19-2

195 Chapter 19: Configuring the SNMP Proxy: SNMP Proxy Configuration Information SNMP Proxy Configuration Information At a high level, the following information must be configured for the SNMP proxy feature: SNMP NE name and associated host information, points and events The address of the SNMP Manager SNMP Templates The mapping of incoming SNMP traps to mediation events utilizes a template mechanism which allows for a common mapping to be shared among multiple mediation SNMP NEs or multiple instances within the same NE. The templates define how the proxied device s SNMP MIB is used by the proxy SNMP NE. There are two types of mappings: events and points, thus two types of templates that are user-definable. Point Template The point template defines how a stateful item on the proxied device is managed by Remote RMM-800 or Remote RMC-700. For each state, the following information is configurable: severity; message; varbind; offline state message and severity; and trap OID. The varbind and trap OID are used to match incoming traps. Event Template Events are simple stateless mappings between an SNMP trap and a mediation event. Events are not mapped to the Remote RMM-800 or Remote RMC-700 alarm table. An event template consists, at a minimum, of a trap-oid and a message parameter. NE Template The NE template contains device model definitions for a proxied SNMP network element. This template can then be referenced by other NEs of that model. The templates can be stored and applied as individual patch configurations for easy distribution to multiple Remote RMC-700s,Remote RMM-800s, and/or Remote RMM- 700s. Measurement Template The measurement template describes parameters such as poll OID, trap OID and varbind value used to obtain the value for a point on a proxied NE. This template can then be applied to other proxied NEs. Using Variables in Templates Page 19-3

196 Chapter 19: Configuring the SNMP Proxy: SNMP Proxy Configuration Information Template events and points can contain variables in their OID and varbind values. The values of the variables are defined when the template is referenced in the event or point configuration of a mediation SNMP NE. The predefined variables that are available for use in these templates are described in Table Table 19-1 Predefined Template Variables Variable $(point) $(event) $(measurement) $(snmpne) Description Contains the name of the point configured on the mediation SNMP NE Contains the name of the event configured on the mediation SNMP NE Contains the name of the measurement configured on the mediation SNMP NE Contains the name of the mediation SNMP NE SNMP NE The mediation SNMP NE is a mediation event originator. The originator type is snmpne and the originator instance is the name of the mediation NE. The snmpne contains site-specific information and can be linked with a previously created event template or a point template for part of its definition. The name of the NE is used as the NE name value for mediation alarm table entries and responses. SNMP Manager The configurable information for the SNMP manager is the port on which the SNMP manager listens for incoming SNMP notifications. The default port is 162. Page 19-4

197 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Event Template Configuring a Mediation SNMP Event Template In this scenario, you will configure a mediation SNMP event template named coldstartdef, which creates a reboot event for the proxied NE. Note that not all possible parameters are used in this example. See the Remote RMC-700 and Remote RMM-800 Command Reference Guide for details on each parameter. To configure a mediation SNMP event template: 1. Configure event template name coldstartdef: config mediation snmp event-template coldstartdef 2. (optional) Configure an associated description Reboot event: config mediation snmp event-template coldstartdef description Reboot event 3. Configure the trap OID : config mediation snmp event-template coldstartdef trap-oid Configure the message $(event) event on $(snmpne): config mediation snmp event-template coldstartdef message $(event) event on NE $(snmpne) 5. (optional) Verify that the event template has been configured properly: show mediation snmp event-template coldstartdef The command response similar to the following displays: (Dub)>show mediation snmp event-template coldstartdef Name: coldstartdef Description: Reboot event Message: $(event) event on NE $(snmpne) Trap OID: (Dub)> 6. Save the configuration. Page 19-5

198 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Point Template Configuring a Mediation SNMP Point Template In this scenario, you will configure a mediation SNMP point template named ifentrydef, which is a template for a row in the interface table on the proxied NE. For each state (up and down) you will configure the: poll value dynamic poll table and trap map, or the poll OID trap OID varbind match severity message poll default state To configure a mediation SNMP point template: 1. Configure the point template name ifentrydef: config mediation snmp point-template ifentrydef 2. (optional) Configure an associated description Entry in IfTable: config mediation snmp point-template ifentrydef description Entry in IfTable 3. Configure the dynamic poll table with the following settings: table oid match column (number) 2 match value (for specified column) $(ifdescr) state (table) column 8 config mediation snmp point-template ifentrydef poll-table $(ifdescr) 8 Note: If you configure a dynamic poll table (Step 3), you will not configure a poll ID (Step 4) and vice versa. 4. Configure the poll OID $(ifIndex)for template ifentrydef: config mediation snmp point-template ifentrydef poll-oid $(ifindex) 5. Configure the Up state: config mediation snmp point-template ifentrydef state up Page 19-6

199 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Point Template 6. Configure the poll value of 1 for the up state: config mediation snmp event-template ifentrydef state up pollvalue 1 7. Configure the trap oid for the up state: config mediation snmp point-template ifentrydef state up trap-oid Configure the varbind match $(ifindex) for the up state, that is, the OID equals the value of $(ifindex): config mediation snmp point-template ifentrydef state up varbindmatch $(ifindex) 9. Configure the severity as normal for the up state: config mediation snmp point-template ifentrydef state up severity normal 10. Configure the message as $(point) is up for the up state: config mediation snmp point-template ifentrydef state up message $(point) is up You will now configure similar parameters for the down state using the same point template, ifentrydef. 11. Configure the down state for point template ifentrydef: config mediation snmp point-template ifentrydef state down 12. Configure the poll value of 2 for the down state: config mediation snmp event-template ifentrydef state down pollvalue Configure the trap oid the down state: config mediation snmp point-template ifentrydef state down trapoid Configure the varbind match $(ifindex) for the down state: config mediation snmp point-template ifentrydef state down varbind-match $(ifindex) 15. Configure the severity as major for the down state: config mediation snmp point-template ifentrydef state down severity major 16. Configure the message as $(point) is down: config mediation snmp point-template ifentrydef state down message $(point) is down Page 19-7

200 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Point Template 17. Configure the default polling state for points in this template as up. config mediation snmp point-template ifentrydef poll-default-state up 18. (optional) Verify that the point template has been configured properly: show mediation snmp point-template ifentrydef The command response similar to the following displays: (Dub)>show mediation snmp point-template ifentrydef Name: ifentrydef Description: Entry in IfTable Poll OID: $(ifIndex) State: down Message: $(point) is down Poll Value: 2 Severity: major Trap OID: Varbind Match: = $(ifindex) State: up Message: $(point) is up Poll Value: 1 Severity: normal Trap OID: Varbind Match: = $(ifindex) (Dub)> 19. Save the configuration. Page 19-8

201 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP NE Template Configuring a Mediation SNMP NE Template In this scenario, you will configure a mediation SNMP NE template, which is a template containing device model definitions for a proxied SNMP network element. For this template, you will configure the: template name Template1 description point, which refers to an existing point template and associated values event, which refers to an the existing event template and associated values NE template, which refers to the existing NE template and an associated value. To configure a mediation SNMP NE template: 1. Configure the NE template name Template1: config mediation snmp ne-template Template1 2. (optional) Configure a description for Template1 called Sample template: config mediation snmp ne-template Template1 description Sample template 3. Configure point modem with the following settings: point template ifentrydef parameter ifdesc value serial_modem config mediation snmp ne-template Template1 point modem ifentrydef ifdesc serial_modem 4. Configure event runningconfigchange with the following settings: event template (existing) configchangedef parameter file value running-config config mediation snmp ne-template Template1 event runningconfigchange configchangedef file running-config Page 19-9

202 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP NE Template 5. Configure NE template alarm1 with the following settings: NE template (existing) alarms parameter num value 1 config mediation snmp ne-template Template1 ne-template alarm1 alarms num 1 6. (optional) Verify that the NE template has been configured properly: show mediation snmp ne-template Template1 The command response similar to the following displays: (Dub)>show mediation snmp (Dub) show mediation snmp>ne-templates Template1 Name: Template1 Description: Sample template Event: runningconfigchange Template: configchangedef Parameter: file = running-config Point: modem Template: ifentrydef Parameter: ifdescr = serial_modem Template Reference: alarm1 Template: alarms Parameter: num = 1 (Dub) show mediation snmp> 7. Save the configuration. Page 19-10

203 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Measurement Template Configuring a Mediation SNMP Measurement Template In this scenario, you will configure a mediation SNMP measurement template, which defines the way a mediation SNMP NE obtains the value for a point on a proxied SNMP network element. We will look at two examples of measurement templates: an example that configures an individual measurement and a second example that configures a group of measurements. For the first template, you will configure the: template name aldef and description Single measurement poll OID which numeric value to consider significant if the response is a string trap OID, varbind match and varbind value. For the second template, you will configure the: template name altabledef and description Measurement group dynamic poll table which numeric value to consider significant if the response is a string trap OID, varbind ID and varbind value. To configure a mediation SNMP measurement template that configures an individual measurement: 1. Configure the point template name aldef: config mediation snmp measurement-template aldef 2. (optional) Configure an associated description Single measurement: config mediation snmp measurement-template aldef description Single measurement 3. Configure the poll OID $(alIndex) for template aldef: config mediation snmp measurement-template aldef poll-oid $(alindex) 4. Configure the template aldef to consider as significant the second numeric value in a string response: config mediation snmp measurement-template aldef value-match 2 5. Configure an SNMP trap named critical, with a trap OID for the critical state: Page 19-11

204 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Measurement Template config mediation snmp measurement-template aldef trap critical trap-oid Configure the varbind-match for the critical state; that is, the OID to use to retrieve the value of $alindex: config mediation snmp measurement-template aldef trap critical varbind-match $alindex 7. Configure a varbind value of for for the critical state: config mediation snmp measurement-template aldef trap critical varbind-value Configure the template aldef to consider as significant the second numeric value in a string response for critical traps: config mediation snmp measurement-template aldef trap critical value-match 2 9. (optional) Verify that the point template has been configured properly: show mediation snmp measurement-template aldef The command response similar to the following displays: (Dub)>show mediation snmp measurement-templates aldef Name: aldef Description: Single measurement Poll OID: $(alIndex) Value Match Index: 2 Value Conversion Multiplier: 1 Trap: critical Trap OID: Varbind Value: Value Match Index: 2 Varbind Match: = $alindex (Dub)> 10. Save the configuration. To configure a mediation SNMP measurement template that configures a group of measurements: 1. Configure the point template name altabledef: config mediation snmp measurement-template altabledef 2. (optional) Configure an associated description Measurement group: config mediation snmp measurement-template altabledef description Measurement group Page 19-12

205 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Measurement Template 3. Configure the dynamic poll table with the following settings: table OID match column (number) 7 match value (for specified column) 5 config mediation snmp measurement-template altabledef poll-table Configure the template altabledef to consider as significant the second numeric value in a string response: config mediation snmp measurement-template altabledef value-match 2 5. Configure an SNMP trap named critical, with a trap OID for the critical state: config mediation snmp measurement-template altabledef trap critical trap-oid Configure the varbind OID for the critical state: config mediation snmp measurement-template altabledef trap critical varbind-id Configure a varbind value of for for the critical state: config mediation snmp measurement-template altabledef trap critical varbind-value Configure the template altabledef to consider as significant the second numeric value in a string response for critical traps: config mediation snmp measurement-template altabledef trap critical value-match 2 Page 19-13

206 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Measurement Template 9. (optional) Verify that the point template has been configured properly: show mediation snmp measurement-template altabledef The command response similar to the following displays: (Dub)>show mediation snmp measurement-templates altabledef Name: altabledef Description: Measurement group Poll Table OID: ID Column: 7 Value Column: 5 Value Match Index: 2 Value Conversion Multiplier: 1 Trap: critical Trap OID: Varbind Value: Value Match Index: 2 Varbind ID: (Dub)> 10. Save the configuration. Page 19-14

207 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Network Element Configuring a Mediation SNMP Network Element In this scenario, you will configure information specific to a mediation SNMP NE including: The host parameters A link to the previously defined event template, coldstartdef, which defines the associated event A link to the previously defined point template, ifentrydef, which defines the associated event A link to the previously defined measurement template, altabledef, which defines a means of obtaining a value for a point on a proxied NE. To configure a mediation SNMP NE: 1. Configure the name, ProxyNE, for the mediation SNMP NE: config mediation snmpne ProxyNE 2. Configure the network element name, ProxyNE: config mediation snmpne ProxyNE ne-name ProxyNE 3. Configure the host with an IP address of , port number 161, community name administrator and SNMP version number v1. These parameters are used for polling the device. config mediation snmpne ProxyNE host administrator v1 4. Configure the category as NECategory: config mediation snmpne ProxyNE category NECategory 5. Configure status point ethernet1 with a link to the previously defined ifentrydef point template, a replaceable parameter name ifindex and a value for that parameter as 1: config mediation snmpne ProxyNE point ethernet1 ifentrydef ifindex 1 6. Configure status point ethernet2 with a link to the previously defined ifentrydef point template, a replaceable parameter name ifindex and a value for that parameter as 2: config mediation snmpne ProxyNE point ethernet2 ifentrydef ifindex 2 7. Configure an event named reboot, with a link to the previously defined coldstartdef event template: config mediation snmpne ProxyNE event reboot coldstartdef Page 19-15

208 Chapter 19: Configuring the SNMP Proxy: Configuring a Mediation SNMP Network Element 8. Configure a measurement named analog, with a link to the previously defined altabledef measurement template: config mediation snmpne ProxyNE measurement analog altabledef 9. (optional) Verify that the ProxyNE SNMP NE has been configured properly: show mediation snmpne ProxyNE The command response similar to the following displays: (Dub)>show mediation snmpne ProxyNE Name: ProxyNE Description: Host: :161 SNMP Community: administrator SNMP Version: v1 Category: NECategory NE Name: ProxyNE Measurement Poll Interval: 60 Point Poll Interval: 3600 Connectivity OID: Connectivity State: offline Last Connectivity Poll Reply: unknown Event: reboot Template: coldstartdef Last Trap: Unknown Point: ethernet1 Template: ifentrydef Current State: down Last Trap: Unknown Last Poll Reply: Unknown Parameter: ifindex = 1 Point: ethernet2 Template: ifentrydef Current State: down Last Trap: Unknown Last Poll Reply: Unknown Parameter: ifindex = 2 Measurement: analog Template: altabledef Last Poll Reply: unknown (Dub)> 10. Save the configuration. Page 19-16

209 Configuration Results Remote RMC-700 and Remote RMM-800 Version 6.4x Configuration Guide Chapter 19: Configuring the SNMP Proxy: Configuration Results The following is a partial example of a running-config, which shows the results of the template points and events used to construct a mediation SNMP NE containing a port with two states (up and down), Ethernet ports 1 and 2 and a reboot notification. config mediation snmp event-template coldstartdef description Reboot event message $(event) event on NE $(snmpne) trap-oid exit config mediation snmp measurement-template a1tabledef description Measurement group poll-table value-match 2 trap critical trap-oid varbind-id value-match 2 exit trap critcal varbind-value exit exit config mediation snmp point-template ifentrydef description Entry in IfTable poll-oid $(ifindex) state up message $(point) is up poll-value 1 trap-oid varbind-match $(ifindex) exit state down message $(point) is down poll-value 2 severity major trap-oid varbind-match $(ifindex) exit poll-default-state up exit config mediation snmp ne-template Template1 description Sample template event runningconfigchange configchangedef file running-config point modem ifentrydef ifdesc serial_modem ne-template alarm1 alarms num 1 exit config mediation snmpne ProxyNE category NECategory ne-name ProxyNE host administrator v1 event reboot coldstartdef measurement analog a1tabledef point ethernet1 ifentrydef ifindex 1 point ethernet2 ifentrydef ifindex 2 (Dub)> Page 19-17

210 Chapter 19: Configuring the SNMP Proxy: Configuration Results Note: Alarms, events, actions and responses for SNMP proxy will not display in running-config as they are implicitly added to the configuration. Only if the user makes a change to one of the entities will these four items display in running-config. This applies only to new SNMP proxy configurations, not those loaded from saved configurations. The configuration will add the following alarm entries and actions automatically. config alarm-entry ProxyNE_ethernet1_snmpne event snmpne ProxyNE point ethernet1 trap up event $(message) event snmpne ProxyNE point ethernet1 trap down event $(message) ne-name MyNE category some-category config alarm-entry ProxyNE_ethernet2_snmpne event snmpne ProxyNE point ethernet2 trap up event $(message) event snmpne ProxyNE point ethernet2 trap down event $(message) ne-name ProxyNE category some-category config event ProxyNE_reboot_snmpne content snmpne ProxyNE trap reboot config response ProxyNE_trap_snmpne content snmp trap message $(message) ne-name ProxyNE category some-category config action ProxyNE_reboot_snmpne event ProxyNE_reboot_snmpne response ProxyNE_trap_snmpne Page 19-18

211 Configuring Jobs This chapter includes scenarios that contain step-by-step procedures on how to configure jobs for Remote RMM-800 or Remote RMC-700. Guide to this Chapter Job Configuration Overview Installing a Script Package Installing a Script Package Configuring a Job with a Script Package and Script CHAPTER 20 Configuring a Job with a Job Property Configuring a Job with a Job Task Configuring Job Start Times Configuring Dynamic Memory for a Job Viewing Job Information on the Remote Web Interface Page 20-1

212 Chapter 20: Configuring Jobs: Job Configuration Overview Job Configuration Overview A job contains the specifications for running an instance of a script. It refers to a script defined within a package and specifies the parameters for execution on Remote RMM-800 or Remote RMC-700. Scripts are defined in packages and specify the parameters for execution when the associated jobs run. Note: All job configuration examples in this document are set up in the CLI. Users can use the Remote Web Interface to view status of script jobs and packages. See Accessing the Web Interface on page 2-8 for access instructions, and Viewing Job Information on the Remote Web Interface on page for details about the GUI scripts feature. Script Package Components Before you configure a job on Remote RMM-800 or Remote RMC-700, you must first create a script package. A script package (.pkg file) contains two basic components: Python modules A package manifest file Python Modules A script package can contain one or more Python modules (.py or.pyc files). Each Python module can contain one or more scripts or it can be empty. A script is a Python class that defines a run and stop method, which implements the scripting interface on Remote RMM-800 or Remote RMC-700. A script can define job properties, which pass runtime parameters and/or settings (such as, connection information for a network element, baud rates, TID s, phone numbers, software version and user name and password information) to Remote RMM-800 or Remote RMC-700 when a job is executed. In addition, a script can define job tasks and the properties required to request IP configuration for a device or open a server socket connection to receive and transmit data. In addition to Python modules, the script package can also contain Python packages. A Python package is a way to store Python modules in a hierarchical directory structure. For example, a Python package named PkgA will be created when you create a directory named PkgA. This directory will store additional modules or subpackages. In order for Python to recognize the directory as a Python package, the directory needs to include a file named init.py. However, the file can be empty. Package Manifest File A Package Manifest file is an XML file that acts as a table of contents for the script package. The package manifest lists which scripts the package contains, what tasks must be configured to use the scripts and any supported properties for the script. Page 20-2

213 Chapter 20: Configuring Jobs: Job Configuration Overview Once a script package is created on a local workstation, you can use an SFTP utility to transfer the script package directly to the pkgstage directory on Remote RMM-800 or Remote RMC-700. After you transfer the script package, you can install it onto Remote RMM-800 or Remote RMC-700. When a script package is installed on Remote RMM-800 or Remote RMC-700, it is stored in a database for executing jobs. A job must refer to a script package and a script in order for it to execute properly. Basically, a job configured through the Remote RMM-800 or Remote RMC-700 CLI runs the function(s) within the script module. After configuring and executing a job, the script package is retrieved from the package database and run by the script engine. Page 20-3

214 Chapter 20: Configuring Jobs: Installing a Script Package Installing a Script Package Important: This procedure assumes that you have obtained a script package from Westell (in this example, examplescript pkg). In this scenario, you will: Use an SFTP utility to transfer a script package to the Remote RMM-800 or Remote RMC-700 staging area Install the script package To install a script package: Using an SFTP utility, transfer examplescript pkg from the local workstation to the pkgstage directory on Remote RMM-800 or Remote RMC At the main CLI prompt, install script package examplescript pkg to Remote RMM-800 or Remote RMC-700: config pkgs install name examplescript 2. (optional) Verify that the script package has been installed properly: show pkgs summary The command response similar to the following displays: (Dub)>show pkgs summary Package Version examplescript (Dub)> Tip: To display the contents and attributes of script package examplescript, enter show pkgs name examplescript. Note: Some jobs need to be restarted when the configuration changes, including: Battery Monitor (including the Battery Learner) Analog Monitor Page 20-4

215 Chapter 20: Configuring Jobs: Configuring a Job with a Script Package and Script Configuring a Job with a Script Package and Script Important: This procedure assumes that the user has obtained a script package from Westell (in this example, examplescript pkg) and the procedure Installing a Script Package on page 20-4 has been completed. In this scenario, you will configure a job with a script that prints a string of text to two log files (stdout.log and stderr.log). To configure a job with a script package and script: 1. At the main prompt, create job printlog: config jobs name printlog 2. Configure job printlog to use script package examplescript and script capture_example and define the minimum acceptable version level for an installed package as 1.0.0: config jobs name printlog script examplescript capture_example (optional) Verify that the job has been configured with the proper script package and script: show jobs name printlog status The command response similar to the following displays: (Dub)>show jobs name printlog status Job: printlog Package: examplescript Min version: Script: capture_example Cron start: disabled Start at boot: disabled Memory limit (Kb): 1024 Output capture: disabled Max start attempts: 1 Run state: idle (Dub)> 4. Save the configuration. Page 20-5

216 Chapter 20: Configuring Jobs: Configuring a Job with a Job Property Configuring a Job with a Job Property Important: This procedure assumes that the user has obtained a script package from Westell (in this example, examplescript pkg) and the procedure, Configuring a Job with a Script Package and Script on page 20-5 has been completed. In this scenario, you will configure a job that uses a script that prints a string of text to two log files. During runtime, the two files will be created in the job s data directory when job capture is enabled. To configure a job with a job property: 1. At the main prompt, enable output capture for job printlog: config jobs name printlog capture 2. Configure job printlog with job property capture_text and assign it the property value of Hello World: config jobs name printlog property capture_text Hello World Note: To include spaces or special characters, quotes must be included. By entering job property value hello world, job printlog will run script capture_example and pass runtime job property capture_text. This indicates that value Hello World will be written to the stdout.log and stderr.log files located in the job s data directory on Remote RMM-800 or Remote RMC (optional) Verify that the job has been configured with the proper job property: show jobs name printlog properties The command response similar to the following displays: (Dub)>show jobs name printlog properties Name Value capture_text Hello World (Dub)> 4. Save the configuration. 5. Run job printlog: exec-job printlog run A run ID is assigned. 6. (optional) Verify that the job has been executed successfully: show jobs name printlog history The command response similar to the following displays: Page 20-6

217 Chapter 20: Configuring Jobs: Configuring a Job with a Job Property (Dub) show jobs name printlog>history Run ID Start time End time Exit state /02/03 22:35: /02/03 22:35:33 normal (Dub) show jobs name printlog> 7. (optional) SFTP to Remote RMM-800 or Remote RMC-700 to verify that the output of the job has been recorded to the stdout.log and stderr.log files located in the job s data directory (jobdata/printlog). Page 20-7

218 Chapter 20: Configuring Jobs: Configuring a Job with a Job Task Configuring a Job with a Job Task Important: This procedure assumes that the user has obtained a script package from Westell (in this example, examplescript pkg) and the procedure Installing a Script Package on page 20-4 has been completed. In this scenario, you will configure a job with a job task. The job uses a script that starts a server, which accepts an incoming socket connection. When a connection is established, the script listens for data from the connection. When data is sent, the script determines if it should modify the data based on the value yes entered for job property upper_case and then writes back the changed data in uppercase. To configure a job with a job task: 1. At the main prompt, create and configure job echodata to use script package examplescript and script echo_example. Define the minimum acceptable version level for an installed package as 1.0.0: config jobs name echodata script examplescript echo_example Create task new_ip and assign the task type as ifconfig: config jobs name echodata task new_ip type ifconfig 3. Assign address property value to task new_ip: config jobs name echodata task new_ip property address Assign controller property br_switch to task new_ip: config jobs name echodata task new_ip property controller br_switcheth0_1 5. (optional) Verify that the task new_ip has been configured properly: show jobs name echodata task new_ip The command response similar to the following displays: (Dub)>show jobs name echodata task new_ip Task: new_ip Position: 1 Type: ifconfig Properties: Name Value address controller br_switch (Dub)> 6. Create task server_sock and assign the task type as serversocket: config jobs name echodata task server_sock type serversocket Page 20-8

219 Chapter 20: Configuring Jobs: Configuring a Job with a Job Task 7. Assign the task property port as 50008, ifconfig as new_ip, type as STREAM and listen as 5 to task server_sock: config jobs name echodata task server_sock property port config jobs name echodata task server_sock property ifconfig new_ip config jobs name echodata task server_sock property type STREAM config jobs name echodata task server_sock property listen 5 8. (optional) Verify that the task server_sock has been configured properly: show jobs name echodata task server_sock The command response similar to the following displays: (Dub)>show jobs name echodata task server_sock Task: server_sock Position: 2 Type: serversocket Properties: Name Value address ifconfig new_ip listen 5 port type STREAM (Dub)> 9. Enable capture output for job echodata: config jobs name echodata capture 10. Configure job echodata with the job property upper_case and assign it with the value of yes: config jobs name echodata property upper_case yes 11. (optional) Verify that job echodata has been configured with the proper job properly: show jobs name echodata properties The command response similar to the following displays: (Dub)>show jobs name echodata properties Name Value upper_case yes (Dub)> 12. Save the configuration. 13. Run job echodata: exec-job echodata run A run ID is assigned. Page 20-9

220 Chapter 20: Configuring Jobs: Configuring Job Start Times Configuring Job Start Times In this scenario, you will configure a job to start on August 7 and to run through September 30 at 12:30 p.m., 5:30 p.m. and 7:30 p.m. every Monday, Wednesday and Friday. To configure start times for a job: 1. At the main prompt, configure job printlog to start on August 7 and to run through September 30 every Monday, Wednesday and Friday at 12:30 p.m., 5:30 p.m. and 7:30 p.m.: config jobs name printlog start-at ,17, ,3,5 A start-at index number of 1 is assigned. 2. (optional) Verify that job printlog has been configured with the proper starting times: show jobs name printlog starts * The command response similar to the following displays: (Dub)>show jobs name printlog starts * Cron start: disabled Start at bootup: disabled Start-at index: 1 Month: 8-9 Day: 7-30 Hour: 12,17,19 Minute: 30 Weekday: 1,3,5 No scheduled start time (Dub)> 3. Save the configuration. Page 20-10

221 Chapter 20: Configuring Jobs: Configuring Dynamic Memory for a Job Configuring Dynamic Memory for a Job In this scenario, you will configure the amount of dynamic memory that Remote RMM-800 or Remote RMC-700 can use while running job printlog. To configure dynamic memory for a job: 1. At the main prompt, configure Remote RMM-800 or Remote RMC-700 to use 2024 kilobytes of dynamic memory while running job printlog: config jobs name printlog memory (optional) Verify that the dynamic memory has been configured properly for job printlog: show jobs name printlog status The command response similar to the following displays: (Dub)>show jobs name printlog status Job: printlog Package: Min version: any Script: Title: Cron start: disabled Start at boot: disabled Memory limit (Kb): 2024 Stack size (Kb): 1024 Output capture: enabled Max start attempts: 1 Run state: idle (Dub)> 3. Save the configuration. Page 20-11

222 Chapter 20: Configuring Jobs: Viewing Job Information on the Remote Web Interface Viewing Job Information on the Remote Web Interface Remote RMC-700 and Remote RMM-800 users can view Script Package and Script Job information and status on the Remote Web Interface. 1. Click the System button on the menu bar and select Scripts, as shown in Figure The Script Jobs display opens as shown in Figure 20-2.This initial view includes columns for each job s name, title, script, and status. Select scripts to open scripts page Figure 20-1 Remote Web Interface Home Page with cursor poised to open Scripts Figure 20-2 Initial view of the Script Jobs display 2. Click the Job name to open detailed information about the job, as shown in Figure Page 20-12

223 Chapter 20: Configuring Jobs: Viewing Job Information on the Remote Web Interface Click arrow to reveal more details Figure 20-3 Script Jobs page with Job details displayed 3. At the bottom of the display, click the downward-pointing arrows next to History, Output files, and/or Properties to reveal more details as shown in Figure Figure 20-4 Jobs page with History, Output files, and Properties details open Page 20-13

224 Chapter 20: Configuring Jobs: Viewing Job Information on the Remote Web Interface 4. To view the Output files, click on the file name. The file will open under a new tab. 5. To view Packages and Package Versions, click the Packages tab at the top of the Scripts page as shown in Figure Figure 20-5 Packages display Page 20-14

225 Configuring Modules This chapter includes scenarios that contain step-by-step procedures on how to configure modules for Remote RMC-700 and Remote RMM-800. Guide to this Chapter Module Configuration Overview Configuring Modules Using Command Line Interface Configuring Modules Using Web Interface CHAPTER 21 Page 21-1

226 Chapter 21: Configuring Modules: Module Configuration Overview Module Configuration Overview A module is a pre-packaged, turn-key solution built to address a specific area of site management, such as Power Management or Environmental/HVAC Monitoring and Control. Each module is composed of individual applications that provide a slice of functionality and equipment (alarms, measurements, sensors, etc.) used to address a specific purpose within a module. The module applications define Network Elements (NEs) that represent physical equipment at the site. Each NE defines the set of alarms and measurements essential for effectively managing the operation of that physical piece of equipment. In addition to NEs, the module and its applications can define parameters that are configuration items used to customize the operation of the module. Controls are another feature of modules that provide application-specific logic as well as an interface to allow users to initiate an action, such as remotely starting a generator. Once a module is installed, the user must realize or configure an instance of an NE for each piece of physical equipment at the site. An NE is realized by selecting the NE type from a list of options provided by the module and then customizing the NE instance by configuring its associated parameters. The NE type is similar to selecting the vendor and model of the physical piece of equipment. It is important to note that many parameters may have a default value, but others may not have a default value. The module may designate certain parameters to be required, in which case they must have a value before the NE will transition to the online state and become functional. Using NE sets, users can customize the number of instances of NEs of a particular type based on what actual physical equipment is at a site as compared to the fixed number of instances that are defined in the module. Once an NE set has been configured with new instances, the NE will need to be realized, just as the moduledefined NEs must be realized. The web interface for module configuration provides an alternative to the command line interface. The web interface is used for initial site installation and small, individual site changes once the site is managed in Optima. Refer to Configuring Modules Using Command Line Interface on page 21-3 and Configuring Modules Using Web Interface on page Page 21-2

227 Chapter 21: Configuring Modules: Configuring Modules Using Command Line Interface Configuring Modules Using Command Line Interface Installing Modules In this scenario, you will: Use an SFTP utility to transfer the module to the Remote RMM-800 or Remote RMC-700 staging area Install the module Show the installed modules To install a module: 1. Using an SFTP utility, transfer the SYSTEM mod and TOWER tgz module files from the local workstation to the modules directory on Remote RMM- 800 or Remote RMC At the main CLI prompt, install all module files in the staging area: exec site install The command response similar to the following displays: (Dub)>exec site install The modules System and Tower were installed successfully. (Dub)> Note: In this example, TOWER tgz is a module bundle which contains two individual modules packaged together. 3. (optional) Verify that the module has been installed properly: show site modules The command response similar to the following displays: (Dub)>show site modules Module Version Description Date System System :54:03 Tower Tower Management Applicat :55:28 TowerTenants Tower Management Live Vie :55:28 Tip: To display module applications and details, enter show site modules { modulename } Page 21-3

228 Chapter 21: Configuring Modules: Configuring Modules Using Command Line Interface Enabling an Optional Application In this scenario, you will: Display applications available in an installed module. Enable an application in the Tower module. 1. Display the applications and details from the module Tower: show site modules Tower The command response similar to the following displays: >show site modules Tower Name - Tower Display Name - Description - Tower Management Applications, Reports, and Live View Product Version Compatibility Version Build ID Build Date :55: Application Type State Description ACPowerMonitoring optional disabled An application for monitoring AC Po AccessManagement optional disabled An application for site access mana AssetTampering optional disabled An application that monitors asset BatteryMonitoring optional disabled An application for monitoring batte CabinetMonitoring optional disabled Application for monitoring the cabi DASMonitoring optional disabled An application for monitoring distr DCPowerMonitoring optional disabled An application for monitoring DC Po EnvironmentalMonitor optional disabled Application for monitoring the envi FuelMonitoring optional disabled An application for monitoring fuel GeneratorManagement optional disabled An application for monitoring gener HVACControl optional disabled Application that allows for HVAC co HVACEnergyMonitoring optional disabled Application that monitors HVAC ener HVACMonitoring optional disabled Application that allows for HVAC mo RectifierMonitoring optional disabled An application for monitoring the r Surveillance optional disabled An application for surveillance TenantDCMetering optional disabled An application for tenant metering TenantMetering optional disabled An application for monitoring energ TowerLightMonitoring optional disabled An application for monitoring tower UPSMonitoring optional disabled An application for monitoring UPSs 2. Enable the Environmental Monitoring application from the Tower module: config site module Tower application EnvironmentalMonitoring enable 3. Confirm that the Environmental Monitoring application has been enabled: show site modules Tower Page 21-4

229 Chapter 21: Configuring Modules: Configuring Modules Using Command Line Interface The command line response State column shall display that Environmental Monitoring has been enabled. 4. Applications can be disabled by using the above command with disable instead of enable. Realizing and Configuring Network Elements In this scenario, you will: Realize the indoortemperature Network Element (NE) and configure several parameter valuesshow the NEs To realize and configure NEs: 1. Select type SiteBusTemperature for Network Element indoortemperature: config site network-element indoortemperature type SiteBusTemperature 2. In this example, a SiteBusTemperature sensor has already been installed.. To customize the module with this data, set the value of parameter ID to AE05A5: config site network-element indoortemperature param ID AE05A5 3. Configure thresholds for the high temperature alarm and the low temperature alarm by setting the values of the parameters hightemperature and lowtemperature: config site network-element indoortemperature param hightemperature 100 config site network-element indoortemperature param lowtemperature Verify that the network elements are in the online state: show site network-elements The command response similar to the following displays: Page 21-5

230 Chapter 21: Configuring Modules: Configuring Modules Using Command Line Interface (Dub)>show site network-elements Network Element Category Type State backhaulsender BackhaulSender offline indoorhumidityzzzz HumiditySensor offline indoortemperature TemperatureSensor SiteBusTemperaturezzzzzz online monitor ModuleMonitor offline outdoorhumidity HumiditySensor offline outdoortemperatur TemperatureSensor offline smokedetector SmokeDetector offline 5. (optional) Display the details of the NE that includes the list of parameters: show site network-elements indoortemperature The command response similar to the following displays: (Dub)>show site network-elements indoortemperature Name - indoortemperature Description - Main indoor temperature sensor Category - TemperatureSensor Type - RMBTemperature State - online InternalState - Online Parameters Name - REF_temperatureUnits Value - F Type - reference Description - Referenced from temperatureunits. Per-NE configuration of units is not supported. Name Value Type Description - hightemperature (configured) - reference - High Temperature Alarming Point Name - lowtemperature Value - 50 Type - reference Description - Low Temperature Alarming Point Name - peripheralnumber Value - 2 (configured) Type - integer (1-12) Description - Peripheral number for RMB Page 21-6

231 Chapter 21: Configuring Modules: Configuring Modules Using Command Line Interface Configuring an NE Set In this scenario, you will: Configure two NEs (instances) in a network element set. Configure a description for each NE (instance). Configure a display name for each NE (instance). Show information for the NE set and NEs (instances). To configure an NE set: 1. At the main prompt, configure NE (instance) Tenant1Power in NE set TenantPowerMeter: config site network-element-set TenantPowerMeter instance Tenant1Power Note: NE (instance) names (for example, Tenant1Power) must be unique within the site. In addition, a module may define a format to which the NE name must conform. For example, the module may allow you to enter any characters for the beginning of an NE name but require that the name end with certain characters (for example, Power). To view the name format, execute the command show site network-elements-sets <NE Set>. The Name Restriction field shows the format. 2. Configure description This is Tenant1Power. for NE (instance) Tenant1Power in NE set TenantPowerMeter: config site network-element-set TenantPowerMeter instance Tenant1Power description This is Tenant1Power. 3. Configure display name Tenant1PowerMeter for NE (instance) Tenant1Power in NE set TenantPowerMeter: config site network-element-set TenantPowerMeter instance Tenant1Power display-name Tenant1PowerMeter Note: NE (instance) display names, which are used within the Optima application, must be unique within the site. 4. Configure NE (instance) Tenant2Power in NE set TenantPowerMeter: config site network-element-set TenantPowerMeter instance Tenant2Power 5. Configure description This is Tenant2Power. for NE (instance) Tenant2Power in NE set TenantPowerMeter: config site network-element-set TenantPowerMeter instance Tenant2Power description This is Tenant2Power. Page 21-7

232 Chapter 21: Configuring Modules: Configuring Modules Using Command Line Interface 6. Configure display name Tenant2PowerMeter for NE (instance) Tenant2Power in NE set TenantPowerMeter: config site network-element-set TenantPowerMeter instance Tenant2Power display-name Tenant2PowerMeter 7. (optional) Verify that the NE set has been configured properly: show site network-elements-sets TenantPowerMeter The command response similar to the following displays: (Dub)>show site network-elements-sets TenantPowerMeter Name - TenantPowerMeter Description - NE Set for TenantPowerMeter Category - PowerMeterCategory Max Elements - 3 Name Restriction - (.*Power) Instances Name - Tenant1Power Description - This is Tenant1Power. Display Name - Tenant1PowerMeter Activity State - Active Name - Tenant2Power Description - This is Tenant2Power. Display Name - Tenant2PowerMeter Activity State - Active (Dub)> 8. Realize NE (instance) Tenant1Power and Tenant2Power using scenario Realizing and Configuring Network Elements on page Save the configuration. Initiating a Control Action In this scenario, you will: Initiate the control action to turn on the ventilation fan Show the state of the controls Note: In this example, the fan network element provides the fan-controller control. Controls will automatically go to the online state once the host network element is online and all the control s required parameters that do not have default values have been configured. To initiate a control action: Page 21-8

233 Chapter 21: Configuring Modules: Configuring Modules Using Command Line Interface 1. Select the run action for control fan-controller: exec site control-action fan-controller run 2. (optional) Show the current state of all controls: show site controls The command response similar to the following displays: (Dub)>show site controls Control Category State Admin fan-controller VentilationFan Running enabled Tip: To display the details for control fan-controller, enter show site controls fan-controller Page 21-9

234 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Configuring Modules Using Web Interface Installing Modules In this scenario, you will: Use an SFTP utility to transfer the module to the Remote RMM-800 or Remote RMC-700 staging area Log into the web interface and navigate to the NetworkElements and Modules Configuration pages Install the module View the list of installed modules Enable an optional application To install a module: 1. Using an SFTP utility, transfer the TOWER module file from the local workstation to the modules directory on Remote RMM-800 or Remote RMC-700. Note: Users might have different modules than the one in this example 2. Using a browser, access the web interface and enter a valid usename and password on the login page. From the Home Page, click the Configuration button on the Display Control tab bar and select Network Elements. The NetworkElements Configuration page will be displayed. See Figure Navigation selections Figure 21-1 The initial Remote RMM-800 or Remote RMC-700 web interface Network Elements display The Network Elements Configuration display s navigation selections shown in Figure 21-1 let users navigate with one click between Network Elements (view Page 21-10

235 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface NEs, add and remove NE Sets, and edit NE parameters), Applications (view and enable of disable applications), Global Parameters (view and edit), and Modules (view and install selected or install all). 3. Click the Modules button. Installedand available Modules will be displayed. See Figure Buttons to install available modules Figure 21-2 Modules display showing Installed Modules above and Available Modules below. This instance shoes one module, TOWER, available. 4. The available modules list will show the TOWER module that was transferred to the staging area. Click on Install All Modules. 5. When the installation is complete, the Modules display reappears in a few seconds with a list of installed modules in the upper panel. See Figure Figure 21-3 The screen displays installed modules Page Click the Applications button in the navigation selections. The Applications page will be displayed as shown in Figure 21-4.

236 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Figure 21-4 The Applications page shows all applications and their states. 7. Click the checkmark box for Environmental Monitoring in the Enabled column and click Save to enable the application. The checkmark will remain and the state will change to Enabled as shown in Figure Page 21-12

237 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Figure 21-5 The Applications page shows Environmental Monitoring enabled. To disable an application, click on that application s checkmark box in the Enabled column and click Save. The checkmark will disappear and the State column will change from Enabled to Disabled. If the checkmark box is grayed out, as it is with Backhaul in Figure 21-5, the user cannot disable that application. Realizing and Configuring Network Elements In this scenario, you will: Realize the indoortemperature Network Element (NE) and configure several parameter values Realize the indoorhumidity NE and configure a parameter value View the list of NEs Page Return to the Network Elements display by clicking the Network Elements button in the navigation selections. 2. Clickon Indoor Temperature (see Figure 21-6). Important: Network Elements such as indoortemperature and indoorhumidity will not appear by default; the user must enable their parent Application. Follow Steps 6 and 7 in the Installing Modules instructions and use the Applications page shown in Figure 21-5 to enable applications. The

238 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface indoortemperature and indoorhumidity NEs are part of the EnvironmentalMonitoring application. Note: The Network Element display includes an information icon at upper right next to the Add and Remove buttons, as shown in Figure Hovering the cursor over this icon yields informational messages about the display and possible user actions. Information icon Figure 21-6 Screen display of Network Elements with the cursor poised to select Indoor Temperature. 3. The indoortemperature NE page will open, displaying details of this NE. See Figure Page 21-14

239 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Figure 21-7 Initial screen display of the Indoor Temperature NE 4. Select RMB Temperature from the Type pull-down menu and click the Save button at lower right. The parameters of this NE will display as shown in Figure Page 21-15

240 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Figure 21-8 The display of parameters of Indoor Temperature type RMB Temperature 5. Click on peripheralnumber to highlight that line, and then click on the value column in that line to open the value edit window. Set the value at 2, click outside the edit window (See Note on Page 21-16), and click Save. After the user saves this change, the screen should appear as shown in Figure Note: On this and other screens in this web interface, small red triangles appear in affected cells to mark pending settings changes which the user has made. A triangle appears each time the user changes a setting and then clicks the cursor outside that cell. The Save button will save these changes. The Discard button will discard changes. A popup window prompts the user to confirm a Discard. Page 21-16

241 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Figure 21-9 The screen display of parameters from network element Indoor Temperature type RMB Temperature after the peripheralnumber value was changed to 2 in Step Using the same methods described in step 5, click on hightemperature, set the value at 100, and click Save. 7. Using the same methods described in step 5, click on lowtemperature, set the value at 60, and click Save. 8. Clickthe Network Elements selection to return to the Network Elements page. 9. Click on indoorhumidity to display details of this NE. 10. Using the same methods described in steps 4 and 5, select RMBHumidity, set the peripheralnumber value at 2, and Save. Viewing Network Elements Sub-Components The Network Elements page also lets users view NE sub-components, NEs with subcomponents are displayed with a small arrow on the left of the Display column, as shown in Figure Page 21-17

242 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Arrows indicating parent NEs with child components Figure Network Elements page with clickable arrows at left. When the user clicks one of these arrows, the contents open in a tree-style display showing sub-components and, in some cases, sub-components within subcomponents. See Figure and Figure The user can view details of any sub-component by clicking on the display field. Figure Network Elements page with sub-components revealed in tree-style display Page 21-18

243 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Configuring an NE Set In this scenario, you will: Configure an NE (instance) in a network element set. Configure a display name and description for an NE (instance). 1. SelectApplications to display the Applications page. Using the technique described in step 7. on Page 21-12, enable the TenantMetering application. 2. Clickon Network Elements to return to the Network Elements page. 3. Click the Add button at upper right on the Network Elements page. The box Add NE will appear. Pull down the NE Set menu as shown in Figure and select TenantPowerMeter. Figure The Add NE window showing the menu of available NE Sets. 4. Type Tenant1Power in the Name box. See Figure Note: The name must conform to the pattern specified below the name box. When this is shown as.+power as shown in Figure 21-13, the name must end with the word Power. Page 21-19

244 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Specified Name Pattern Figure The Add NE window prompts the user for a name, display, and description of the NE Set being added. 5. Type Tenant 1 Power Meter in the Display box and This is Tenant 1 Power in the Description box. See Figure Click Save. Tenant1Power will appear on the Network Elements page as shown in Figure 21-14, including the display of TenantPowerMeter in the NE Set column. Figure The Network Elements list showing Tenant1Power and its NE set name TenantPowerMeter 6. Realize the added NEs using the steps specified in Realizing and Configuring Network Elements on page Page 21-20

245 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface To remove an NE Set, select the NE Set from the list on the Network Elements page. Click the Remove button at upper right. A Confirm Remove box will appear asking the user to confirm the intention to remove the NE Set instance. Configuring Discrete Inputs with the Remote Web Interface Remote RMC-700 and Remote RMM-800 can manage up to 12 peripheral units with up to 64 digital discrete inputs each. In addition, Remote RMC-700 and Remote RMM-700 each have their own 12 onboard discrete inputs, and Remote RMM-800 has 16 onboard discrete inputs. Once a peripheral s type is assigned, it will appear on the Remote s Web Interface Peripheral List. Users can use this Web Interface feature to configure the discrete s enable state and description and to configure an alarm on the discrete. Refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide sections config discrete, config peripherals, show discrete, show peripherals, and show alarm-entries for additional information. Discrete Inputs Page Features Refresh button Editable fields Apply and Reset buttons Figure Discrete Inputs page features In this scenario, you will: Configure a specific Discrete input with a Description. Name, configure, and enable the alarm for the Discrete Input. Page 21-21

246 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface 1. In the Remote Web Interface, click the Configuration button and select Discrete Inputs. The Discrete Inputs pages opens as shown in Figure Figure Initial view of the Discrete Inputs page 2. Using the tree display on the left side of the page, click the plus sign icon next to the name of the peripheral unit with the discrete inputs to be configured. The list of that peripheral s discrete inputs opens. See Figure Figure Opening the peripheral tree to view discrete inputs Page 21-22

247 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Note: Not all peripherals support digital discrete inputs. A message will appear informing the user if a peripheral that does not support digital discrete inputs is selected. 3. Click on an unassigned input in the tree. Fields for that input and its alarm will open as shown in Figure Figure Blank configuration fields for an unassigned input 4. In the top field at upper right named for the selected discrete input, type the description of the discrete input in the Description field. Click the Enabled box. You can click Apply to save the configuration to this point, or wait until you have configured the alarm. The description you entered will appear in the Description column of the tree display next to that discrete input once you click Apply. Notes: Click the Reset button at any time during the inputting process to reset the field being edited or all fields completed up to that point. Whenever you enter configuration information which can be saved, the Apply button becomes active and you can click Apply to save the configuration to that point. Once you click Apply, the Reset button will no longer reset the configuration fields completed before you clicked Apply. Applying these changes with the Apply button only updates the running configuration. To save the configuration, click the System button, select Backup & Restore, and save to startup config. Page 21-23

248 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface 5. Click the Enabled checkbox in the Alarms section to open the Alarm fields for editing, See Figure Figure Alarm fields opened for editing 6. Type the desired Alarm name in the Name field and a description in the Description field. Note: The Alarm Name field accepts up to 64 alphanumeric, dash, or underscore characters. It does not allow spaces. An alert will appear if the entry does not conform. 7. Click twice in the Alarms table Severity column in the open state row to open the drop-down menu of severities. See Figure Click field to open for editing Figure Configuring alarm severity level 8. Select the severity level for the open state alarm from the drop-down menu. Page 21-24

249 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface 9. Click to open the Message field for the open state alarm, then type in the desired message. 10. Repeat the above two steps to populate the closed state and offline state Alarm Severity and Message fields. Note: The Alarms table will not permit users to create conflicts among the open and closed state alarms. If the user changes open to closed in the State column, the corresponding closed alarm row automatically will toggle to open, and vice-versa. See Figure User changes alarm state close to open Alarms table automatically toggles open to close Figure Alarms table prevents open-close conflicts 11. Click outside the Alarms table, then click Apply to open the alarm configuration. The Advanced fields, such as Nagging Interval, are not typically used for alarms. When the Discrete Input configuration is complete, both of the Enabled checkboxes will be checked and the page will look similar to below. Figure A completed Discrete Input configuration Page 21-25

250 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Editing Discrete Inputs In this scenario, you will: Edit a previously configured discrete input All the settings described throughout the preceding section, Configuring Discrete Inputs with the Remote Web Interface, can be edited. Editing in the Remote Web Interface is done the same way as the initial configuration. 1. Log into a Remote RMM-800 or Remote RMC-700 Web Interface. Click the Configuration button on the menu bar, and select Discrete Inputs. The Discrete Inputs page opens. 2. Select the Discrete Input to be edited in the tree. The fields of settings open on the right. 3. Click in the field to be edited. See Figure 21-23, in which the user is poised to change the severity of the GPS Failure open alarm state from Critical to Major. 4. Repeat steps 2 and 3 to edit other fields as needed. 5. Edit the fields as needed. Click Apply. The edited configuration will appear as shown in. Figure Discrete Input page with the user poised to edit an alarm setting for GPS Failure Page 21-26

251 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Figure Discrete Input page with the GPS Failure alarm changed to Major Page 21-27

252 Chapter 21: Configuring Modules: Configuring Modules Using Web Interface Page 21-28

253 Configuring the Peripheral Management Subsystem This chapter provides information on the expansion peripheral management subsystem and gives examples of how to configure expansion peripherals. This subsystem provides communication, coordination, auto-discovery and state maintenance for Remote RMC-700 and Remote RMM-800 peripheral management. Guide to this Chapter Peripheral Management Subsystem Overview Expansion Peripheral Unit Discovery CHAPTER 22 Expansion Peripheral States Configuring Remote RMM-800 or Remote RMC-700 to Manage an Expansion Peripheral Configuring Discrete I/O Points on an Expansion Peripheral Configuring Alarms for an Expansion Peripheral Configuring SiteBus Devices for an Expansion Peripheral Disconnecting a Managed Expansion Peripheral Page 22-1

254 Chapter 22: Configuring the Peripheral Management Subsystem: Peripheral Management Subsystem Overview Peripheral Management Subsystem Overview The peripheral management subsystem lets Remote RMM-800 or Remote RMC-700 manage up to 12 peripherals. Expand peripherals provide additional alarm and port capacity that is easily managed through the Remote RMM-800 or Remote RMC-700 Command Line Interface. RMB-1 Peripheral Unit The RMB-1 peripheral unit (refer to Figure 22-1) is powered via PoE from Remote RMM-800, and can be powered via a user-supplied PoE injector for use with Remote RMM-700 or Remote RMC-700. RMB-1 contains the following inputs and outputs: Sixty-four digital bistate inputs Four relay outputs Four current inputs (4-20 ma) Four voltage inputs (0-10V, positive only) A four-terminal SiteBus Four sets of auxiliary terminals, which are not electrically connected to other RMB-1 I/O terminals Built-in temperature and humidity sensors Figure 22-1 RMB-1 Peripheral Unit Page 22-2

255 Chapter 22: Configuring the Peripheral Management Subsystem: Peripheral Management Subsystem Overview RMB-2 Peripheral Unit The RMB-2 peripheral unit (refer to Figure 22-2) offers similar capabilities to RMB-1 in a chassis that is sized to be easily mounted in a standard 19-inch, 21-inch, or 23-inch rack. RMB-2 s digital bistate inputs support both wet and dry contacts, while RMB-1 s digital bistate inputs support dry contacts only. Figure 22-2 RMB-2 Peripheral Unit For technical specifications on RMB-1 and RMB-2 and for details on physically connecting to RMB terminals, see the RMB-1 and/or RMB-2 Installation Guide. RMB-1 and RMB-2 Identification Each RMB peripheral unit has a name that is defined in the following format: RMB1-XXXXXX XXXXXX represents the low-order three bytes of the peripheral s MAC address (for example, RMB1-0E68F4). Note that the name begins with RMB1 regardless of whether the peripheral unit is an RMB-1 or an RMB-2. Important: Figure 22-3 Page 22-3

256 Chapter 22: Configuring the Peripheral Management Subsystem: Expansion Peripheral Unit Discovery Expansion Peripheral Unit Discovery Expansion peripheral units announce themselves at all times to all locally-connected Remote RMM-800 or Remote RMC-700s. These announcements do not cross bridged or routed WAN links, but they do traverse Ethernet bridges and hubs. When Remote RMM-800 or Remote RMC-700 discovers an expansion unit, it is made available for association with a unit number by user command. The unit number configuration settings are applied to the unit, which puts the unit under Remote RMM- 800 or Remote RMC-700 s management control. For more information on setting up unit number/peripheral associations, refer to Configuring Remote RMM-800 or Remote RMC-700 to Manage an Expansion Peripheral on page Important: Only one Remote RMM-800 or Remote RMC-700 at a time can manage a peripheral unit. The first one that connects to the unit will manage it. However, if the management connection drops, another Remote RMM- 800 or Remote RMC-700 could become the new managing device. This situation is a misconfiguration. Page 22-4

257 Chapter 22: Configuring the Peripheral Management Subsystem: Expansion Peripheral States Expansion Peripheral States Every discovered peripheral has an Admin state and Oper state field. The values associated with these states appear in the output for command show peripherals. The Administrative State is the configured state of the peripheral. Table 22-1 lists the potential administrative states. Table 22-1 Potential Expansion Peripheral Administrative States Administrative State Managed Unmanaged Description Indicates that Remote RMM-800 or Remote RMC-700 is ready to actively manage the peripheral. This state goes into effect when the user issues command config peripheral manage for the specified peripheral. Indicates that Remote RMM-800 or Remote RMC-700 is not ready to actively manage the peripheral. The Operation State is the actual, operational state of a discovered peripheral. Table 22-2 lists the potential operation states. Table 22-2 Potential Expansion Peripheral Operation States Operation State Unmanaged OtherManaged AdminManaged Connecting Description Specifies that the peripheral has been discovered, but has not been configured for management. Note: The Administrative State will also be Unmanaged. Specifies that the peripheral is under the management of another Remote RMM-800 or Remote RMC-700. Specifies that the peripheral has been configured under the management of Remote RMM-800 or Remote RMC- 700, but has not actively been managed. Note: This state usually occurs when the expansion peripheral is configured, but is not connected to Remote RMM-800 or Remote RMC-700. Specifies that Remote RMM-800 or Remote RMC-700 is attempting to establish a management connection to the peripheral. Page 22-5

258 Chapter 22: Configuring the Peripheral Management Subsystem: Expansion Peripheral States Table 22-2 Potential Expansion Peripheral Operation States (Continued) Operation State Initializing IncompatibleManaged Downloading Managed Online Description Specifies that Remote RMM-800 or Remote RMC-700 has established a management connection to the peripheral and is exchanging initial setup messages with it. Specifies that the following conditions exist: Remote RMM-800 or Remote RMC-700 has successfully set up and initialized a management connection to the peripheral. The peripheral s firmware is incompatible with Remote RMM-800 or Remote RMC-700 s firmware. Remote RMM-800 or Remote RMC-700 is not currently downloading compatible firmware to the peripheral (and perhaps cannot, for some reason). When a peripheral is in this state, only basic peripheral management functions are available, such as updating the image and reloading. Specifies that Remote RMM-800 or Remote RMC-700 is downloading a new firmware image to the peripheral. Specifies that Remote RMM-800 or Remote RMC-700 has successfully set up and initialized a management connection to the peripheral. Specifies that the peripheral is fully operational. Remote RMM-800 or Remote RMC-700 has established a management connection to it and it is fully functioning as part of Remote RMM-800 or Remote RMC-700. Page 22-6

259 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring Remote RMM-800 or Remote RMC-700 to Manage an Expansion Peripheral Configuring Remote RMM-800 or Remote RMC-700 to Manage an Expansion Peripheral An expansion peripheral is managed by Remote RMM-800 or Remote RMC-700 when it is: Configured through the Remote RMM-800 or Remote RMC-700 Connected to the Remote RMM-800 or Remote RMC-700 Capable of operating as an extension of the Remote RMM-800 or Remote RMC- 700 s discrete I/O subsystem. Management of a peripheral by Remote RMM-800 or Remote RMC-700 requires peripheral type and peripheral name configuration. In this scenario, you will: Configure a discrete peripheral unit Configure a description for the discrete peripheral unit Configure Remote RMM-800 or Remote RMC-700 to manage the peripheral device. To configure Remote RMM-800 or Remote RMC-700 to manage an expansion peripheral: 1. Configure description Unit manages RMB-12462B for peripheral unit 2: config peripheral 2 description Unit manages RMB-12462B Note: The peripheral type is inferred from the peripheral name prefix (for example, DEP = discrete-expansion). If desired, you can explicitly configure the peripheral type with command config peripheral type. 2. Configure Remote RMM-800 or Remote RMC-700 peripheral unit 2 to manage peripheral device RMB-12462B: config peripheral 2 manage RMB-12462B Notes: Configuring the peripheral name associated with a unit number causes Remote RMM-800 or Remote RMC-700 to attempt active management of the specified device. If the device has been discovered, Remote RMM- 800 or Remote RMC-700 connects to it and starts managing it immediately. If the device has not been discovered, Remote RMM-800 or Remote RMC-700 begins actively managing it as soon as it is discovered. Page 22-7

260 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring Remote RMM-800 or Remote RMC-700 to Manage an Expansion Peripheral All peripherals have a hard-coded, unique name. This unique name is printed on a label affixed to the expansion module. 3. (optional) Verify that the expansion peripheral has been configured properly: show peripherals unit 2 The output will look similar to the following: (JT-RMM2)>show (JT-RMM2) show>peripheral unit 2 Unit number: 2 Description: Type: RMB-1 Admin state: Managed Name: RMB B IP address: N/A Oper state: Online Manager name: JT-RMM2 Manager IP address: Type: RMB-1 Model: B A:0 Firmware version: 1.20 Firmware build date: ,09:34:20.0,-05:00 Firmware build ID: 001 Serial number: Manufacture date: 03/26/12 Stage2 bootloader version: 1.01 Stage2 bootloader build date: Mon Mar 8 10:10:22 EST 2010 MAC address: 00:40:72:12:46:2B Chassis serial number: Chassis slot number: 1 Chassis model: B A:0 Chassis manufacture date: 03/26/12 Chassis MAC address: 00:40:72:12:46:2B (JT-RMM2) show> Note: The output above shows the expansion peripheral in online mode, which indicates that the peripheral is fully operational. Remote RMM-800 or Remote RMC-700 has established a management connection to it and it is fully functioning as part of Remote RMM-800 or Remote RMC-700. For more information on management states, refer to section Expansion Peripheral States on page Save the configuration. Page 22-8

261 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring Discrete I/O Points on an Expansion Peripheral Configuring Discrete I/O Points on an Expansion Peripheral Display points on an expansion peripheral are configured using the same commands that configure and display Remote RMM-800 or Remote RMC-700 s on-board I/O points. In this scenario, you will: Configure a default alarm entry for a discrete input point on a peripheral unit Enable the discrete input point on the peripheral unit Configure a description for a discrete output on the unit Enable a discrete analog point on the unit. To configure discrete I/O points for the discrete expansion peripheral: 1. Configure default alarm entries for discrete input 2/2: config discrete input 2/2 alarm-default 2. Enable discrete input 2/2: config discrete input 2/2 enable 3. Configure description Output 12 for discrete output 2/12: config discrete output 2/12 description Output Enable discrete analog 2/3 config discrete analog 2/3 enable Note: For more information on discrete analog input settings, refer to section Configuring an Alarm Entry for a Temperature Sensor on page (optional) Verify that the discrete I/O points have been configured properly: show discrete inputs 2/2 The display will look similar to the following for the discrete input: (Dub)>show discrete inputs 2/2 ID - 2/2 Description - State - enable Value - open (Dub)> Page 22-9

262 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring Discrete I/O Points on an Expansion Peripheral show discrete outputs 2/12 The display will look similar to the following for the discrete output: (Dub)>show discrete outputs 2/12 ID - 2/12 Description - Output 12 Value - closed (Dub)> show discrete analogs 2/3 The display will look similar to the following for the analog input: (Dub)>show discrete analogs 2/3 ID - 2/3 Description - State - disable Low Band - 0 High Band - 0 Hysteresis - 2 Interval - 0 Max Loop Value - 30 Min Loop Value - 30 Max Sensor Reading - 40 Min Sensor Reading - 40 Units - ma Mode - current Value - 0 ma (Dub)> 6. Save the configuration. Page 22-10

263 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring Alarms for an Expansion Peripheral Configuring Alarms for an Expansion Peripheral Alarms configured for expansion peripheral I/O points are set up the same way as alarms configured for on-board Remote RMM-800 or Remote RMC-700 I/O points the same commands are used. In this scenario, you will: Configure an alarm entry that signals when a discrete connection on a peripheral unit opens To configure alarms for an expansion peripheral: 1. Configure alarm entry discretedown as a major alarm that signals when input 2/2 opens: config alarm-entry discretedown event input 2/2 open major Discrete input 2/2 is open 2. Configure alarm entry discretedown as a normal alarm that signals when input 2/2 closes: config alarm-entry discretedown event input 2/2 close normal Discreteinput 2/2 is closed 3. (optional) Verify that the alarm entries have been configured properly: show alarm-entries name discretedown The display will look similar to the following for alarm entry discretedown: Page 22-11

264 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring Alarms for an Expansion Peripheral (JT-RMM2)>show (JT-RMM2) show>alarm-entries name discretedown Name - discretedown State - major Hidden Severity - disabled Current Message - Discrete input 2/2 is open Description - Simulation Mode - disabled Nagging Interval - 0 Nagging Level - major Trap - enabled Trap Priority - disabled Raw - disabled TL1 - disabled TL1 AID - TL1 Class - env TL1 Affect - nsa TL1 Type - TL1NE - 1 NE Display Name - RMM700 Category - NE Name - Originator - input 2/2 Alarm Actions: Severity Trigger Message major open Discrete input 2/2 is open normal close Discrete input 2/2 is closed (JT-RMM2) show> 4. Save the configuration. Page 22-12

265 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring SiteBus Devices for an Expansion Peripheral Configuring SiteBus Devices for an Expansion Peripheral The RMB expansion peripherals include a four-terminal SiteBus, where you can connect sensors that transmit data over a single wire. Each of these one-wire SiteBus devices has a unique hexadecimal ID, which is discovered by RMB. After a SiteBus device is connected and the device has been discovered, the device can be configured for management by Remote RMM-800 or Remote RMC-700. The device type determines how data from the device will be interpreted and what points will be created for the device. The only SiteBus device types supported for Remote RMM-800 or Remote RMC-700 are sbtemp and sbtemphumidity. The specific points available as measurement table entry originators for the sbtemp type are temperaturec and temperaturef. The specific points available as measurement table entry originators for the sbtemphumidity type are temperaturec, temperaturef, and humidity. In this scenario, you will: Connect a device to a SiteBus terminal and discover its hexadecimal ID Configure a SiteBus device for management by Remote RMM-800 or Remote RMC-700 To configure a SiteBus device: 1. Power down the RMB peripheral by disconnecting its Ethernet connection to Remote RMM-800 or Remote RMC Use RMB s punchdown tool to physically connect the device to a SiteBus terminal. Note: For more information, see the step ConnectInputs and Outputs in the RMB-1 Installation Guide or RMB-2 Installation Guide. 3. Power up the RMB peripheral by reconnecting its Ethernet connection to Remote RMM-800 or Remote RMC-700. This will require a user-supplied PoE injector for the Remote RMC-700 or Remote RMM-700. RMB discovers the newly connected SiteBus device. 4. Obtain the hexadecimal ID for the newly connected SiteBus device: show sitebus In the following example, device AE05A5 has been discovered, but is not yet managed by Remote RMM-800 or Remote RMC-700. Page 22-13

266 Chapter 22: Configuring the Peripheral Management Subsystem: Configuring SiteBus Devices for an Expansion Peripheral (Dub)>show (Dub) show>sitebus ID Periph:Bus State Managed Name AE05A5 1:1 Unmanaged Name ID State Type Description (Dub) show> 5. Configure the device with name temp1: config sitebus temp1 Note: Each SiteBus device should be assigned a unique name in order to track and store its reported values in the measurement table. 6. Configure device temp1 with hexadecimal ID AE05A5: config sitebus temp1 id AE05A5 7. Assign device type sbtemp to device temp1: config sitebus temp1 type sbtemp 8. Add description Temperature Sensor 1 to device temp1: config sitebus temp1 description Temperature Sensor 1 9. (optional) Verify that the SiteBus device has been configured properly: show sitebus The display will look similar to the following: (Dub)>show (Dub) show>sitebus ID Periph:Bus State Managed Name AE05A5 1:1 Managed temp1 Name ID State Type Description temp AE05A5 Online sbtemp Temperature Sensor 1 (Dub) show> 10. Save the configuration. Note: For information on configuring measurement-table entries for a SiteBus device, see Sample Configuration for SiteBus Temperature Sensor and Sample Configuration for SiteBus Combined Temperature and Humidity Sensor. Page 22-14

267 Chapter 22: Configuring the Peripheral Management Subsystem: Disconnecting a Managed Expansion Peripheral Disconnecting a Managed Expansion Peripheral When Remote RMM-800 or Remote RMC-700 is disconnected from a managed peripheral, a trap is generated. Remote RMM-800 or Remote RMC-700 notices physical disconnections 20 to 30 seconds after they occur. In this scenario, you will disconnect the managed peripheral unit. To disconnect a managed expansion peripheral, configure the unit 2 expansion peripheral to become unmanaged: config peripheral 2 no manage When Remote RMM-800 or Remote RMC-700 is reconnected to an expansion peripheral after a temporarily disconnection: Output state changes that occurred during the disconnection are applied to the output s points. Events are generated that report on the current state of enabled expansion peripheral inputs. This includes changes that occurred and persisted during the disconnection. Page 22-15

268 Chapter 22: Configuring the Peripheral Management Subsystem: Disconnecting a Managed Expansion Peripheral Page 22-16

269 Configuring SiteBus Devices This chapter provides information on configuring SiteBus devices for Remote RMM-800 or Remote RMC-700. Guide to this Chapter Configuring SiteBus Devices CHAPTER 24 Page 24-1

270 Chapter 24: Configuring SiteBus Devices: Configuring SiteBus Devices Configuring SiteBus Devices Remote RMC-700 and Remote RMM-800 include a SiteBus port that will accommodate up to 12 one-wire devices. Each of these one-wire SiteBus devices has a unique hexadecimal ID. Once a SiteBus device has been connected and the device has been discovered, you can configure the device for management by Remote RMM-800 or Remote RMC-700. The device type determines how data from the device will be interpreted and what points will be created for the device. The only SiteBus device types supported for Remote RMM-800 or Remote RMC-700 are sbtemp and sbtemphumidity. The specific points available as measurement table entry originators for the sbtemp type are temperaturec and temperaturef. The specific points available as measurement table entry originators for the sbtemphumidity type are temperaturec, temperaturef, and humidity. In this scenario, you will: Connect a device to a SiteBus terminal and discover its hexadecimal ID Configure a SiteBus device for management by Remote RMM-800 or Remote RMC-700 To configure a SiteBus device: 1. Connect one or more DS18B20 1-wire digital thermometer(s) to Remote RMX s or Remote RMM-700 s SiteBus port using an RJ45 ethernet cable. 2. Remote RMM-800 or Remote RMC-700 discovers the newly connected SiteBus device(s). 3. Obtain the hexadecimal ID for the newly connected SiteBus device: show sitebus In the following example, device AE05A528 has been discovered, but is not yet managed by Remote RMM-800 or Remote RMC-700. (Dub)>show (Dub) show>sitebus ID Periph:Bus State Managed Name AE05A528 0:1 Unmanaged Name ID State Type Description (Dub) show> 4. Configure the device with name temp1: Page 24-2

271 Chapter 24: Configuring SiteBus Devices: Configuring SiteBus Devices config sitebus temp1 Note: Each SiteBus device should be assigned a unique name in order to track and store its reported values in the measurement table. 5. Configure device temp1 with hexadecimal ID AE05A5: config sitebus temp1 id AE05A5 6. Assign device type sbtemp to device temp1: config sitebus temp1 type sbtemp 7. Add description Temperature Sensor 1 to device temp1: config sitebus temp1 description Temperature Sensor 1 8. (optional) Verify that the SiteBus device has been configured properly: show sitebus The display will look similar to the following: (Dub)>show (Dub) show>sitebus ID Periph:Bus State Managed Name AE05A5 1:1 Managed temp1 Name ID State Type Description temp AE05A5 Online sbtemp Temperature Sensor 1 (Dub) show> 9. Save the configuration. For information on configuring a measurement-table entry for a SiteBus device, see Sample Configuration for SiteBus Temperature Sensor and Sample Configuration for SiteBus Combined Temperature and Humidity Sensor. Page 24-3

272 Chapter 24: Configuring SiteBus Devices: Configuring SiteBus Devices Page 24-4

273 Using Configuration Wizards This chapter provides information on the three available configuration wizards. Guide to this Chapter Configuration Wizard Overview Using the initsetup Wizard Using the bistate-alarms Wizard Using the serial-port Wizard CHAPTER 25 Page 25-1

274 Chapter 25: Using Configuration Wizards: Configuration Wizard Overview Configuration Wizard Overview A configuration wizard is a script or program accessed from the CLI that prompts you for configuration information, then generates and applies the associated commands in running the configuration. When you execute the command config use-wizard from the CLI, you can set up a configuration without entering individual CLI commands. Three wizard scripts are provided to help simplify the configuration process for Remote RMC-700 and Remote RMM-800: A setup wizard for initial connectivity configuration on an unconfigured Remote RMM-800 or Remote RMC-700 A wizard for common serial port setups A wizard that configures alarm table entries for bi-state points. Page 25-2

275 Chapter 25: Using Configuration Wizards: Using the initsetup Wizard Using the initsetup Wizard In this scenario, you will configure the initial setup for Remote RMM-800 or Remote RMC-700 using the initsetup wizard. The wizard prompts you for all of the required and optional information. Note: The running-config file is automatically saved to a network-recovery file when you run the initsetup wizard and apply the output to the running-config file. If the running configuration is lost, you can copy file network-recovery to file running-config to restore the initial system configuration. To configure the initial setup: 1. From the main prompt, access the initsetup wizard: config use-wizard initsetup The initsetup wizard screen displays: (Dub)>config use-wizard initsetup initsetup This wizard configures initial connectivity settings. An asterisk (*) in a selection list denotes the default value. Ctrl-c aborts the wizard. NOTE: This wizard provides only basic configuration. For additional configuration options, consult the command reference guide. Hostname of this device: 2. Enter the desired hostname. 3. Enter the desired IP address for the device when prompted. 4. Enter the desired subnet mask or mask length when prompted. Page 25-3

276 Chapter 25: Using Configuration Wizards: Using the initsetup Wizard 5. (optional) Select (y/n) to add login accounts. If yes, select whether or not to require strong passwords. Enter the desired login name and password. If strong passwords are required, the password must be from 8 to 20 characters and contain at one upper-case, lower-case and special punctuation character. Select the desired user profile: 1) supervisor, 2) management, or 3) status. Select (y/n) whether to add another user 6. If a wireless modem is installed, you will be prompted whether to configure the WAN connection. The following settings are configurable and are for wireless modem cards only: Wireless service provider Access point name PPP authentication method Remote server if used as default route 7. Enter the desired default route when prompted. 8. (optional) Select (y/n) to configure DHCP. If yes, select the IP address for the DHCP router. Enter 1 to not use the device IP address (default) or 2 to use the device IP address Enter the desired DHCP server settings when prompted. The following settings are configurable: DHCP router IP address Subnet mask or mask length The lowest address to serve The number of addresses to serve 9. (optional) Enter the desired clock settings when prompted. The following settings are configurable: The standard timezone Daylight savings time The current time and date 10. (optional) Enter the desired NTP settings when prompted. The wizard asks you for the primary and secondary server IP addresses. Page 25-4

277 Chapter 25: Using Configuration Wizards: Using the initsetup Wizard 11. (optional) Enter the desired SNMP v3 user settings when prompted. The following settings are configurable: User name Authentication protocol Authentication pass phrase Privacy protocol Privacy passphrase Select (y/n) whether to add another user 12. (optional) Enter the desired SNMP community settings when prompted. The following settings are configurable: The read-only community string The read-write community string The SNMP version If SNMP v3 is selected, you will be prompted for the SNMP v3 user name. You will then select the v3 desired authentication. 13. (optional) Enter the desired SNMP manager information when prompted. The following settings are configurable: An IP address A community string for traps An SNMP version. If SNMP version 3 or SNMP version 3 inform requests is selected, then you will be prompted for the type of v3 authentication. Select (y/n) whether to add another SNMP manager 14. (optional) Enter the application package server information when prompted. The following settings are configurable: An IP address A package directory on the server An FTP username and password 15. For the final step, select one of the following options when prompted: (a) Apply the settings to running-config (s) Save the commands to a patch configuration file (v) View the commands (c) Cancel You are returned to the main CLI when complete. Page 25-5

278 Chapter 25: Using Configuration Wizards: Using the bistate-alarms Wizard Using the bistate-alarms Wizard In this scenario, you will configure a bistate point on Remote RMC-700 or Remote RMM-800 with the bistate-alarms wizard. The wizard prompts you for all of the required and optional configuration information Note: This wizard also allows you to configure bistate points on expansion units. To configure bistate points: 1. From the main prompt, access the bistate-alarms wizard: config use-wizard bistate-alarms The bistate alarm entry wizard screen displays: (Dub)>config use-wizard bistate-alarms bistate alarm entry wizard This wizard configures alarm entries for bistate (discrete input) points. Ctrl-c aborts the wizard. NOTE: This wizard provides only basic configuration. For additional configuration options, consult the command reference guide. Enter number of the unit containing point(s) to configure. Use 0 or blank for the base unit. Use 1-12 for a peripheral unit. Enter unit number (leave blank for base unit): 2. Enter the desired unit number (0 is the base unit). The wizard states which point is currently selected and prompts you for: Choosing a different point (range 1-12) Configuring the selected point Ending the configuration 3. (optional) Enter a description for the point when prompted. 4. Enter the desired alarm name when prompted. 5. Select the state of the point when it is alarmed (open/close) when prompted. 6. Select the desired severity level for the alarmed point from the list presented. 7. Enter a new alarm message or accept the default alarm message when prompted. Page 25-6

279 Chapter 25: Using Configuration Wizards: Using the bistate-alarms Wizard 8. Enter a new normal state message or accept the default normal state message when prompted. 9. (optional) Enter the desired nagging interval when prompted. 10. (optional) Enter the desired network element name for the alarm entry when prompted. 11. (optional) Enter an alarm category for the alarm entry when prompted. The wizard takes you back to the initial bi-state point prompt (configured in step 2). 12. If desired, follow this procedure again to configure another bistate point. 13. When you are finished configuring points, select one of the following options when prompted: (a) Apply the settings to running-config (s) Save the commands to a patch configuration file (v) View the commands (c) Cancel You are returned to the main CLI when complete. Page 25-7

280 Chapter 25: Using Configuration Wizards: Using the serial-port Wizard Using the serial-port Wizard In this scenario, you will configure a Remote RMC-700 or Remote RMM-800 serial port with the serial-port wizard. To configure a Remote RMC-700 or Remote RMM-800 serial port: 1. From the main prompt, access the serial-port wizard: config use-wizard serial-port The serial port wizard screen displays: (Dub)>config use-wizard serial-port serial port setup wizard This wizard configures serial ports. An asterisk (*) in a selection list denotes the default value. Ctrl-c aborts the wizard. NOTE: This wizard provides only basic configuration. For additional configuration options, consult the command reference guide. Enter number of the unit containing the port(s) to configure. Use 0 or blank for the base unit. Use 1-12 for a peripheral unit. Enter unit number (leave blank for base unit): Port currently selected is 1 <port number> choose a different port (range 1-2) (c) configure this port (d) done Choose option (leave blank to skip this port): 2. Enter the desired port number. The wizard states which port is currently selected and lists options for: Choosing a different port (1-2) Configuring the selected port Ending the configuration 3. Select one of the options. 4. (optional) Enter a description for the port when prompted. The wizard lists the default line settings and asks if you would like to accept those settings. Page 25-8

281 Chapter 25: Using Configuration Wizards: Using the serial-port Wizard 5. (optional) Enter the desired line settings. The following settings are configurable: The line mode The baud rate The parity The number of databits The number of stop bits The wizard asks you to select an application for the serial port. Application options include terminal server, serial-to-ip, TBOS, or none (basic async port). 6. Select an application for the serial port. Note: The remaining prompts for the serial port configuration will vary based upon the application you select. 7. Enter the desired values for the application as prompted. 8. If desired, follow this procedure again to configure another serial port. 9. When you are finished configuring the ports, select one of the following options when prompted: (a) Apply the settings to running-config (s) Save the commands to a patch configuration file (v) View the commands (c) Cancel. You are returned to the main CLI when complete. Page 25-9

282 Chapter 25: Using Configuration Wizards: Using the serial-port Wizard Page 25-10

283 TL1 Commands This chapter lists the default TL1 commands that are supported by Remote RMC- 700 s and Remote RMM-700 s Virtual Network Elements (VNEs). Guide to this Chapter Overview Default TL1 VNE Commands Unsupported TL1 Commands CHAPTER 26 Page 26-1

284 Chapter 26: TL1 Commands: Overview Overview This chapter discusses the following topics: The default Remote RMC-700 and Remote RMM-800 TL1 command set Recognizing the failure messages associated with TL1 commands that aren t supported by Remote RMM-800 or Remote RMC-700. You should be familiar with Remote RMM-800 or Remote RMC-700 actions and TL1 on Remote RMM-800 or Remote RMC-700 before reading this chapter. For more information on these topics, refer to Chapter 10: Configuring Actions, Events and Responses and Chapter 16: Configuring and Connecting TL1 Infrastructure. Page 26-2

285 Chapter 26: TL1 Commands: Default TL1 VNE Commands Default TL1 VNE Commands The default TL1 commands supported by Remote RMC-700 and Remote RMM-800 are a small subset of all available TL1 commands. The following default commands are supported: ACT-USER ACT-USER ALW-MSG-ALL CANC-USER RTRV-ALM-ALL RTRV-ALM-DS3 RTRV-ALM-EC1 RTRV-ALM-ENV RTRV-ALM-EQPT RTRV-ALM-OC3 RTRV-ALM-T1 RTRV-HDR Description This command lets a remote user log into the VNE on Remote RMM-800 or Remote RMC-700. Format ACT-USER:tid:user:ctag::password; Parameters tid user ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC-700. Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Page 26-3

286 Chapter 26: TL1 Commands: Default TL1 VNE Commands password Defines the user password for a VNE on Remote RMM-800 or Remote RMC-700. Examples This example displays a normal response when command ACT- USER:Remote:ai:1::ai; is entered. Remote RMC :58:44 M 1 COMPLD /* 1 User(s) Logged On */ ; ALW-MSG-ALL Description This command causes Remote RMM-800 or Remote RMC-700 to resume transmission of automatic messages after being in the inhibit message mode. Note: Remote RMC-700 and Remote RMM-800 do not currently support the inhibit message TL1 command. Because of this, Remote RMC-700 and Remote RMM-800 are always in ALW-MSG-ALL mode. Format ALW-MSG-ALL:tid:[ aid ]:ctag; Parameters tid aid cta g Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Examples This example displays a normal response when command ALW-MSG- ALL:Remote:AID:1; is entered. Page 26-4

287 Chapter 26: TL1 Commands: Default TL1 VNE Commands Remote RMC :47:44 M 1 COMPLD /* ALW-MSG-ALL:Remote:AID:1 */ ; CANC-USER Description This command lets the connected user log out of the VNE on Remote RMM-800 or Remote RMC-700. Format CANC-USER:tid:aid:ctag; Parameters tid aid ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Examples This example displays a normal response when command CANC- USER:Remote:ai:1; is entered. Remote RMC :07:18 M 1 COMPLD /* CANC-USER:Remote:ai:1 */ /* Your session has been disconnected. */ ; RTRV-ALM-ALL Description This command causes Remote RMM-800 or Remote RMC-700 to return all alarms. Format Page 26-5

288 Chapter 26: TL1 Commands: Default TL1 VNE Commands RTRV-ALM-ALL:tid:[ aid ]:ctag::; Parameters tid aid ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to input commands. Each input command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding input command. Examples This example displays a normal response when command RTRV-ALM-ALL:Remote::1::; is entered. Remote RMC :00:02 M 1 COMPLD /* RTRV-ALM-ALL:Remote::1:: */ "INPUT0_19,ENV:CR,MISC,NSA,09-27, ,,,:\"INPUT 0/19 CLOSE\",:," ; RTRV-ALM-DS3 Description This command causes Remote RMM-800 or Remote RMC-700 to return all alarms designated with the DS3 modifier during Remote RMM-800 or Remote RMC-700 configuration. Points associated with class DS3, which transmits digital signals at Mbps over a T-3 facility, are generally programmed with this modifier. Format RTRV-ALM-DS3:tid:[ aid ]:ctag::; Parameters tid aid Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Page 26-6

289 Chapter 26: TL1 Commands: Default TL1 VNE Commands ctag Defines the correlation tag used to correlate responses to input commands. Each input command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding input command. Examples This example displays a normal response when command RTRV-ALM-DS3:Remote::1::; is entered. Remote RMC :46:19 M 1 COMPLD /* RTRV-ALM-DS3:Remote::1:: */ "INPUT0_1,DS3:CR,MISC,NSA,09-18, ,,,:\"INPUT 0/1 CLOSE\",:," ; RTRV-ALM-EC1 Description This command causes Remote RMM-800 or Remote RMC-700 to return all alarms designated with the EC1 modifier during Remote RMM-800 or Remote RMC-700 configuration. Points associated with class EC1, which is a facility with electrical levels at Mbps, are generally programmed with this modifier. Format RTRV-ALM-EC1:tid:[ aid ]:ctag::; Parameters tid aid ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to input commands. Each input command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding input command. Examples This example displays a normal response when command RTRV-ALM-EC1:Remote::1::; is entered. Page 26-7

290 Chapter 26: TL1 Commands: Default TL1 VNE Commands Remote RMC :08:18 M 1 COMPLD /* RTRV-ALM-EC1:Remote::1:: */ "INPUT0_2,EC1:CR,MISC,NSA,09-18, ,,,:\"INPUT 0/2 CLOSE\",:," ; RTRV-ALM-ENV Description This command causes Remote RMM-800 or Remote RMC-700 to return all alarms for points designated with environment modifiers during Remote RMM-800 or Remote RMC-700 configuration. Points associated with environmental alarms, such as high temperature, are generally programmed with this modifier. Format RTRV-ALM-ENV:tid:[ aid ]::ctag; Parameters tid aid ctag Defines the target identifier for a VNE on Remote RMC-700 and Remote RMM-800. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Examples This example displays a normal response when command RTRV-ALM-ENV:Remote::1; is entered. Remote RMC :19:02 M 1 COMPLD /* RTRV-ALM-ENV:Remote::1 */ "INPUT0_19:CR,MISC,09-27, ,\"INPUT 0/19 CLOSE\"" ; RTRV-ALM-EQPT Description Page 26-8

291 Chapter 26: TL1 Commands: Default TL1 VNE Commands This command causes Remote RMM-800 or Remote RMC-700 to return all alarms for points designated with equipment modifiers during Remote RMM-800 or Remote RMC-700 configuration. Points associated with equipment alarms, such as link down, are generally programmed with this modifier. Format RTRV-ALM-EQPT:tid:[ aid ]::ctag; Parameters tid aid ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Examples This example displays a normal response when command RTRV-ALM-EQPT:Remote::1; is entered. Remote RMC :27:36 M 1 COMPLD /* RTRV-ALM-EQPT:Remote::1:: */ "INPUT0_4,EQPT:CR,MISC,NSA,09-18, ,,,:\"INPUT 0/4 CLOSE\",:," ; RTRV-ALM-OC3 Description This command causes Remote RMM-800 or Remote RMC-700 to return all alarms designated with the OC3 modifier during Remote RMM-800 or Remote RMC-700 configuration. Points associated with class OC3, which is an optical fiber line that carries 155mbps, are generally programmed with this modifier. Format RTRV-ALM-OC3:tid:[ aid ]::ctag; Parameters Page 26-9

292 Chapter 26: TL1 Commands: Default TL1 VNE Commands tid aid ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Examples This example displays a normal response when command RTRV-ALM-OC3:Remote::1; is entered. Remote RMC :16:00 M 1 COMPLD /* RTRV-ALM-OC3:Remote::1:: */ "INPUT0_3,OC3:CR,MISC,NSA,09-18, ,,,:\"INPUT 0/3 CLOSE\",:," ; RTRV-ALM-T1 Description This command causes Remote RMM-800 or Remote RMC-700 to return all alarms designated with the T1 modifier during Remote RMM-800 or Remote RMC-700 configuration. Points associated with class T1, which is a digital transmission link with a capacity of Mbps, are generally programmed with this modifier. Format RTRV-ALM-T1:tid:[ aid ]::ctag; Parameters tid aid ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the user name for a VNE on Remote RMM-800 or Remote RMC Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Examples Page 26-10

293 Chapter 26: TL1 Commands: Default TL1 VNE Commands This example displays a normal response when command RTRV-ALM-T1:Remote::1; is entered. Remote RMC :30:34 M 1 COMPLD /* RTRV-ALM-T1:Remote::1:: */ "INPUT0_5,T1:CR,MISC,NSA,09-18, ,,,:\"INPUT 0/5 CLOSE\",:," ; RTRV-HDR Description This command causes Remote RMM-800 or Remote RMC-700 to send its TL1 System Identifier (SID) header to the OSS. The SID is used primarily to check the status of the communications link. Format RTRV-HDR:tid::ctag; Parameters tid ctag Defines the target identifier for a VNE on Remote RMM-800 or Remote RMC-700. Defines the correlation tag used to correlate responses to commands. Each command has a unique correlation tag. A response includes the identical correlation tag to the one used for the corresponding command. Examples This example displays a normal response when command RTRV-HDR:Remote::1; is entered. IP 1 < Remote RMC :18:17 M 1 COMPLD /* RTRV-HDR:Remote::1 */ ; Page 26-11

294 Chapter 26: TL1 Commands: Unsupported TL1 Commands Unsupported TL1 Commands Remote RMC-700 and Remote RMM-800 TL1 VNE s only take action when default or configured TL1 commands are entered. A failure message occurs when an invalid command is entered, which causes Remote RMM-800 or Remote RMC-700 to give a deny response. Responses include a ctag that is identical to the invalid command. Example This example displays the failure message that occurs when unsupported command REPT-ALM-ENV:Remote:ALL:1; is entered. Remote RMC :01:37 M 1 DENY ICNV /* Input, Command Not Valid */ /* The command code entered is not a valid command code. */ ; Page 26-12

295 Backing Up and Restoring the Remote Configuration This appendix provides step-by-step scenarios on how to back up and restore the Remote RMM-800 or Remote RMC-700 configuration. Guide to this Appendix Backing Up the Configuration Restoring the Configuration APPENDIX A Page A-1

296 Appendix A: Backing Up and Restoring the Remote Configuration: Backing Up the Configuration Backing Up the Configuration In this scenario, you will back up the Remote RMM-800 or Remote RMC-700 configuration file. Important: There are two configuration files. The startup configuration file (primary.cnf) is the configuration used to start Remote RMM-800 or Remote RMC-700. The running configuration file (running-config) includes configuration changes that have been made since startup. Note: This procedure refers only to the SFTP utility for backing up the configuration. however, you may be required to use a different utility, depending on the remote access protocol option. Refer to the remote access configuration commands in the Remote RMC-700 and Remote RMM-800 Command Reference Guide for information on enabling FTP or SFTP. To back up the configuration: 1. Using an SFTP utility, connect to and log into Remote RMM-800 or Remote RMC Change the current directory to the config directory on Remote RMM-800 or Remote RMC Locate the Remote RMM-800 or Remote RMC-700 configuration file (primary.cnf or running-config) in the config directory. 4. Get the configuration file from the config directory on Remote RMM-800 or Remote RMC-700. The configuration file is copied to the working directory on your workstation. Page A-2

297 Appendix A: Backing Up and Restoring the Remote Configuration: Restoring the Configuration Restoring the Configuration In this scenario, you will restore the Remote RMM-800 or Remote RMC-700 configuration file. Notes: You must have supervisor permissions to completely restore the Remote RMM-800 or Remote RMC-700 configuration. Users with management permission can restore the configuration; however, user information will not be modified. This procedure refers only to the SFTP utility for backing up the configuration. however, you may be required to use another utility, depending on the remote access protocol option. Refer to the remote access configuration commands in the Remote RMC-700 and Remote RMM-800 Command Reference Guide for information on enabling the protocols. Important: There are two configuration files. The startup configuration file (primary.cnf) is the configuration used to start Remote RMM-800 or Remote RMC-700. The running configuration file (running-config) includes configuration changes that have been made since startup. To restore the configuration: 1. Using an SFTP utility, connect to and log into Remote RMM-800 or Remote RMC Change the local current directory to the working directory on your workstation. 3. Locate the Remote RMM-800 or Remote RMC-700 configuration file (primary.cnf or running-config) file in the working directory. 4. Change from the current directory to the config directory on Remote RMM-800 or Remote RMC Put the configuration file in the config directory. 6. Close the SFTP connection to Remote RMM-800 or Remote RMC-700 and exit the SFTP utility. 7. For these changes to the startup configuration file to become part of the running configuration, Remote RMM-800 or Remote RMC-700 must be rebooted or command copy startup-config running-config must be entered. Or use the web interface, as shown in Figure A-1. Log into Remote RMM-800 or Remote RMC-700. Click the System button on the menu bar, and select Backup & Restore.In the Restore Configuration box, select startup-config. Click Apply. Page A-3

298 Appendix A: Backing Up and Restoring the Remote Configuration: Restoring the Configuration Figure A-1 Cursor is poised to Apply startup-config in the Restore Configuration box Page A-4

299 Command Identifications Commands config config action Command identifications are used when including and excluding commands for a user-defined profile. The IDs are contained in the supervisor command tree. For information on configuring userdefined profiles, see Creating a Custom Profile on page 3-7. The following table contains some of the valid command identifications for the Remote RMC-700 and Remote RMM-800: Identifications /config /config/action APPENDIX B config alarm-entry config apply-patch config banner config clock config clock daylight-savings config clock local-time config clock timezone config controller config controller bridge /config/alarm-entry /config/apply-patch /config/banner /config/clock /config/clock/daylight-savings /config/clock/local-time /config/clock/timezone /config/controller /config/controller/bridge Page B-1

300 Appendix B: Command Identifications: Commands config controller ethernet config controller nat64 config controller ethernet assign config controller ethernet bridge config controller ethernet description config controller ethernet disable config controller ethernet enable config controller ethernet hardware-address config controller ethernet proxyarp config controller ethernet speed config controller ethernet unassign config controller openvpn config correlation config dhcp-relay config dhcp-server config discrete config event config hostname config interface config interface bridge config interface ethernet config interface ethernet description config interface ethernet disable Identifications (Continued) /config/controller/eth /config/controller/nat64 /config/controller/eth/assign /config/controller/eth/bridge /config/controller/eth/description /config/controller/eth/disable /config/controller/eth/enable /config/controller/eth/hwaddr /config/controller/eth/proxy-arp /config/controller/eth/speed /config/controller/eth/unassign /config/controller/openvpn/ /config/correlation /config/dhcp-relay /config/dhcp-server /config/discrete /config/event /config/hostname /config/interface /config/interface/bridge /config/interface/eth /config/interface/eth/description /config/interface/eth/disable Page B-2

301 Appendix B: Command Identifications: Commands config interface ethernet enable config interface ethernet ip config interface openvpn config interface serial config ip config ip arp config ip domain-name config ip name-server config ip route config route-v6 config iptables config iptables-v6 config jobs config meas-table config mediation config ntp config ntp disable config ntp enable config ntp poll-interval config ntp server config pkgs config profile config profile copy config profile exclude config profile include Identifications (Continued) /config/interface/eth/enable /config/interface/eth/ip /config/interface/openvpn /config/interface/wan /config/ip /config/ip/arp /config/ip/domain-name /config/ip/name-server /config/ip/route /config/ip/route-v6 /config/iptables /config/iptables-v6 /config/jobs /config/meas-table /config/mediation /config/ntp /config/ntp/disable /config/ntp/enable /config/ntp/poll-interval /config/ntp/server /config/pkgs /config/profile /config/profile/copy /config/profile/exclude /config/profile/include Page B-3

302 Appendix B: Command Identifications: Commands config profile priv-lvl config ras config ras accounting config ras authorization config ras retry config ras server config ras shell config ras timeout config remote-access config response config snmp config site control config site module config site network-element config site network-element-set config site network-elements status-points config site param config snmp auth-trap config snmp community config snmp host config timeout config use-wizard config users config users add config users delete Identifications (Continued) /config/profile/priv-lvl /config/ras /config/ras/accounting /config/ras/authorization /config/ras/retry /config/ras/server /config/ras/shell /config/ras/timeout /config/remote-access /config/response /config/snmp /config/site/control /config/site/module /config/site/network-element /config/site/network-element-set /config/site/network-element/statuspoints /config/site/param /config/snmp/auth-trap /config/snmp/community /config/snmp/host /config/timeout /config/use-wizard /config/users /config/users/add /config/users/delete Page B-4

303 Appendix B: Command Identifications: Commands config users password copy debug debug dhcp-client debug ethernet debug ethernet all debug ethernet controller debug ethernet interface debug level debug mediation debug modem debug openvpn debug ppp debug serial debug site debug snmp diag diag break diag clear diag controller diag ip route show diag ip route-v6 show diag line-monitor diag line-status diag mediation Identifications (Continued) /config/users/password /copy /debug /debug/dhcp-client /debug/ethernet /debug/ethernet/all /debug/ethernet/controller /debug/ethernet/interface /debug/level /debug/mediation /debug/modem /debug/openvpn /debug/ppp /debug/serial /debug/site /debug/snmp /diag /diag/break /diag/clear /diag/controller /diag/ip/route/show diag/ip/route-v6/show /diag/line-monitor /diag/line-status /diag/mediation Page B-5

304 Appendix B: Command Identifications: Commands diag mmdisplay diag output diag peripheral diag ps diag snapshot diag tcpdump diag test diag top diag usb diag who diag whoami erase exec site control-action exec site install exec site uninstall exec-job exit halt help password ping reload running-config show show actions Identifications (Continued) /diag/mmdisplay /diag/output /diag/peripheral /diag/ps /diag/snapshot /diag/tcpdump /diag/test /diag/top /diag/usb /diag/who /diag/whoami /erase /exec/site/control-action /exec/site/install /exec/site/uninstall /exec-job /exit /halt /help /password /ping /reload /running-config /show /show/actions Page B-6

305 Appendix B: Command Identifications: Commands show alarm-entries show audit show banner show bootp show clock show compact-flash show config-file show connections show controllers show controllers nat64 show correlations show debugging show dhcp-relay show dhcp-server show discrete show events show expansion-images show interfaces show inventory show ip show iptables show jobs show licenses show listeners show log-file Identifications (Continued) /show/alarm-entries /show/audit /show/banner /show/bootp /show/clock /show/compact-flash /show/config-file /show/connections /show/controllers /show/controllers/nat64 /show/correlations /show/debugging /show/dhcp-relay /show/dhcp-server /show/discrete /show/events /show/expansion-images /show/interfaces /show/inventory /show/ip /show/iptables /show/jobs /show/licenses /show/listeners /show/log-file Page B-7

306 Appendix B: Command Identifications: Commands show meas-table show mediation show ntp show peripherals show pkgs show product show profiles show ras show remote-access show resource-tracking show responses show running-config show site controls show site modules show site network-elements show site network-elements-sets show site network-elements status points show site params show snmp show test show timeout show users show version ssh telnet Identifications (Continued) /show/meas-table /show/mediation /show/ntp /show/peripherals /show/pkgs /show/product /show/profiles /show/ras /show/remote-access /show/resource-tracking /show/responses /show/running-config /show/site/controls /show/site/modules /show/site/network-elements /show/site/network-elements-sets /show/site/network-elements/statuspoints /show/site/params /show/snmp /show/test /show/timeout /show/users /show/version /ssh /telnet Page B-8

307 Appendix B: Command Identifications: Commands trace-route Identifications (Continued) /trace-route Page B-9

308 Appendix B: Command Identifications: Page B-10

309 Glossary Symbols init.py The init.py file is required in the script package for each module directory so that Python will recognize and search the directory for Python code. Content is not required in the file; however, it generally contains a Python document string. If Python module subdirectories are not used, this file does not need to exist. GLOSSARY A action An action is a correlation between an event and response that controls system alarming, logging, and connection behavior on Remote RMM- 800 or Remote RMC-700. AID AID is an acronym for access-identifier. It identifies the NE system component to which the TL1 alarm applies. Page Glossary-1

310 Glossary: A alarm affect The alarm affect designates a TL1 alarm as service-affecting or non-service-affecting. alarm class An alarm class is a designation of a TL1 alarm as environmental or equipment-related. TL1 alarms designated as environmental signal the occurrence of events such as temperature or pressure changes. TL1 alarms designated as equipment-related signal the occurrence of events such as device failures or malfunctions. alarm code The alarm code identifies the severity of an automatic alarm message based on a condition. The alarm conditions are critical (CR), major (MJ), minor (MN), and nonalarmed (NA). alarm message The alarm message is the text displayed for a TL1 alarm when a specified environmental event occurs. alarm type The alarm type is the value for TL1 environmental alarm response. For valid alarm type values, refer to the Bellcore GR-833-CORE documentation. analog reporting interval The analog reporting interval is the rate at which events are generated for an analog input. analog input Analog inputs monitor input current and support five different events that represent input current transitions. Page Glossary-2

311 Glossary: B application mode The application mode sets up a serial controller as a destination for internal connections or gives the controller the ability to initiate internal connections when a system event occurs. asynchronous Asynchronous transmission (or async) refers to a simple protocol where the transmitting device does not need to be synchronized with the receiving device. The transmitter can send data when data is ready to be sent. Each character of this data contains start and stop bits, which indicate the beginning and end of each character. B band The band sets the high and low threshold values for analog input event generation. banner The banner is the initial text that appears when the user logs into Remote RMM-800 or Remote RMC-700. baud rate The baud rate is the speed of a connection in bits per second. bit-level encoding Bit-level encoding is the method by which binary codes represent characters of data. T1 lines have available linecode options Binary 8 Zeros Substitution (B8ZS) and Alternate Mark Inversion (AMI). E1 lines have available linecode options High Density Bipolar Three (HDB3) and Alternate Mark Inversion (AMI). Page Glossary-3

312 Glossary: C boolean An expression whose value can be either true or false. bridge controller A bridge controller groups controllers into an Ethernet bridge group. The controller is named bridge switch because it is a bridge that (by default) includes both of the Ethernet switch ports. Controller bridge switch can be configured to include or exclude Ethernet ports. bridge group A bridge group is a set of controllers assigned to a single bridge unit and network interface. Each bridge group runs a separate Spanning Tree and is addressable using a unique IP address. bridge interface The bridge interface routes packets to and from the bridge controller. C CDMA Code Division Multiple Access (CDMA) is a digital technology that uses spread spectrum techniques for transmitting voice or data over the air. Spread spectrum technology separates users by assigning digital codes within the same broad spectrum. The benefit of CDMA is that it provides higher user capacity and immunity from interfering signals. CDMA is available in 800 megahertz or 1900 megahertz frequencies. central alarm table The central alarm table is a table that maintains the state of all alarms on Remote RMM-800 or Remote RMC-700. It can be configured to communicate alarm state changes in a variety of management protocols. Page Glossary-4

313 Glossary: C chat file A chat file contains the connection initialization string for ports that are configured for PPP encapsulation. It is stored in the /config/chat directory on Remote RMM-800 or Remote RMC-700. The user must SFTP the chat file to the /config/chat directory on Remote RMM-800 or Remote RMC-700 prior to configuring the file as the connection initialization string. CLI Command line interface. A user interface whereby the user types one line of instructions at a time at a command prompt. CLI session timeout The command line interface (CLI) session timeout is the amount of time (in minutes) that can elapse before an Remote RMM-800 or Remote RMC-700 session expires due to inactivity. community string A community string is a password used with the SNMP protocol that is used for both read-only and read-write privileges. condition type A condition type refers to a TL1 alarm type that is based on standards listed in the Bellcore GR-833-CORE documentation. configuration wizard A configuration wizard is a user-friendly utility accessed from the CLI that prompts the user for configuration information, then generates and applies the associated commands in the running configuration. connection mode The connection mode specifies how an asynchronous serial controller determines that it is up (for example, has an asynchronous connection). Page Glossary-5

314 Glossary: D connection string The connection string is a string of characters sent to the attached device at initialization by an Remote RMM-800 or Remote RMC-700 asynchronous serial controller. Depending on the connection settings, this string may or may not be sent to the attached device. controller A controller is a concept that is applied throughout the CLI. It is a software object on Remote RMC-700 and Remote RMM-800 that sends and receives a stream of bytes. A controller can be a physical device, such as an Ethernet transceiver, or it can be a virtual entity such as OpenVPN client. cost Cost is a metric used in spanning tree calculations to determine the best path for reaching a destination. The higher a path's cost, the less desirable it is to use that path and the more likely the spanning tree algorithm is to disable the port if a network loop occurs. cut-through Cut-through support lets users connect directly to a serial port and issue commands directly to network elements. D data bits Data bits are the number of bits per character transmitted or received by an asynchronous serial controller. daylight savings Daylight saving time is when clocks are set ahead one hour to provide an extra hour of daylight during summer. In the U.S., daylight saving time presently starts on the Page Glossary-6

315 Glossary: D second Sunday in March and ends on the first Sunday in November. Daylight saving time start and end dates vary in some other countries, and some countries do not use daylight saving time. default lease time The default lease time is the amount of time, in seconds, a device can use an IP address assigned by the DHCP server. The default lease time is assigned to a device when no other lease time is specified by the user. default static route The default static route is used to route a packet to a destination when there is no other better route in the IP routing table. delimiting character The delimiting character defines the beginning and ending of the banner. Most characters, such as #, ~, %, *, and ), can be applied as the delimiting character. destination address In a static route, the destination address is the IP address of the network. DHCP authority mode The DHCP authority mode configures the DHCP server to respond to misconfigured DHCP clients with DHCP negative acknowledgement (DHCPNAK) messages. If this option is not configured, the client must wait until the old IP address lease has expired before obtaining correct IP address information after moving to a new subnetwork. DHCP broadcast mode The DHCP broadcast mode configures the DHCP server to send DHCP request responses as broadcast packets instead of unicast packets. Page Glossary-7

316 Glossary: D DHCP protocol The DHCP protocol lets a host that is unknown to the network administrator automatically access a new IP address for its network. The network administrator allocates address pools in each subnet and enters them into the DHCP configuration file. DHCP server The DHCP server provides automatic IP address and network configurations to remote devices. For example, the DHCP server can provide dynamic IP address information to a technician s laptop. DHCP server host The DHCP server host is a host that is served by the DHCP server. It can access and obtain IP address and network configurations from the server. digital input Digital inputs generate two events that reflect the state of the input: open and close. disconnect mode The disconnect mode is a handshake from a device attached to Remote RMM-800 or Remote RMC-700 that terminates or accepts termination of an asynchronous connection. discrete alarm Digital discrete alarms are basic open or closed circuits where no data communication is involved. Monitored devices have either a set of dry or wet contact closure outputs. The outputs from the monitored devices are relay switches that close or open upon a given alarm condition. They are called dry when the monitored device (a network element) does not apply voltage to the alarm connection. They are called wet when the monitored device applies voltage to the alarm connection. Page Glossary-8

317 Glossary: E discrete expansion peripheral A discrete expansion peripheral is a component that allows the user to add additional discrete inputs, analog inputs, and relay outputs to Remote RMX-3200 s or Remote RMM-700 s configuration. These additional I/O points are managed through Remote RMM-800 or Remote RMC-700. discrete peripheral unit The discrete peripheral unit is a space on Remote RMM-800 or Remote RMC-700 that holds the I/O configuration information for a discrete peripheral. Units are numbered 0 to 4, with 0 representing the on-board discrete I/O subsystem. domain name Domain names are used to represent IP addresses on a network and are formatted as a series of alphanumeric characters separated by periods (for example, DNS server A DNS server translates alphanumeric addresses into corresponding IP addresses. DTR signal DTR is a control signal on an Remote RMM-800 or Remote RMC-700 asynchronous RS-232 serial port. E encapsulation Communications encapsulation is a method for transmitting multiple protocols within the same network. The frames of one type of protocol are carried within the frames of another. The available communications encapsulation formats for Remote RMC-700 and Remote RMM-800 are HDLC and PPP. Page Glossary-9

318 Glossary: E EvDO EvDO (Evolution-Data Only) is an upgraded version of the cdma2000 system. The 1xEvDO system uses the bandwidth of one or more 1.23 MHz radio channels as the existing cdma2000 system. It provides for multiple voice channels and medium rate data services. The EvDO version changes the modulation technology to allow for a maximum data transmission rate of approximately 2.4 Mbps on the forward channel. The EvDO system uses the same reverse channel, which limits the uplink data transmission rate to approximately 200 kbps. The EvDO system has an upgraded packet data transmission control system that allows for bursty data transmission rather than for more continuous voice data transmission. The industry standard for EvDO is IS-856. event An event is an incident that is triggered by an external or internal event. An event can be anything from a discrete input opening or closing, a serial controller going up or down, a TCP connection request, or a power supply failure. event correlation Event correlation provides the ability to define a unique condition by comparing the states of multiple events and aggregating them into a single event. event originator An event originator is the system component that generates an event. event type An event type identifies the cause of the generated event. Page Glossary-10

319 Glossary: F F filter A filter is an intermediate connection point that performs a processing operation on data passing through a mediation connection. A telnet filter is a telnet session to a device that does not support Telnet, such as a craft port on an NE, to function smoothly. flow control Flow control allows a receiving device to tell a sending device to stop sending data when the data comes in faster than the receiver can process it and to start sending it when the receiver is ready. forward delay Forward delay defines the amount of time a controller participating in a bridge group that is running the spanning tree protocol (STP) spends in the listening state before entering the learning state, the amount of time a controller spends in the learning state before entering the forwarding state, and the aging time for dynamic entries in the filtering database during a network topology change. framing Framing is an error control procedure with multiplexed digital channels, where bits are inserted so that the receiver can identify the timeslots that are allocated to each subchannel. Refer to the Remote RMC-700 and Remote RMM-800 Command Reference Guide for information on the framing formats Remote RMC-700 and Remote RMM-800 utilize. FTP FTP (File Transfer Protocol) is a communications protocol that governs the transfer of files from one computer to another over a network. Page Glossary-11

320 Glossary: G G gateway address The gateway address is the IP address of the next node location in a route. GPRS GPRS (General Packet Radio Service) is a packet-switched mobile datacom service that is widely expected to be the next major step forward in the evolution of GSM technology. It enables high-speed mobile datacom and is most useful for data applications such as mobile internet browsing, , and push technologies. It has demonstrated transmission rates as fast as 115Kbps. H hello time The hello time is the interval between the generation of configuration bridge PDUs when the bridge is either the root bridge or when it is trying to become the root bridge. history runs The history runs is the number of history entries kept for a job. HSPA High Speed Packet Access (HSPA) is a collection of mobile telephony protocols that extend and improve the performance of existing UMTS (Universal Mobile Telecommunications System) protocols. Page Glossary-12

321 Glossary: I HTTP HTTP (Hypertext Transfer Protocol) provides a standard for Web browsers and servers to communicate. It provides less security for sensitive information than HTTPS. HTTPS HTTPS (Hyper Text Transfer Protocol Secure) provides the necessary security to protect sensitive data. On Remote RMC-700 and Remote RMM-800, HTTPS is implemented by incorporating an SSL layer that encrypts the HTTP packets between the web server and client/browser. hysteresis Hysteresis is a guard region around high and low thresholds on an analog input that prevents rapid generation of events when input current oscillates rapidly across the threshold. I inactivity timeout The inactivity timeout sets the frequency (in minutes) that RX statistics will be checked on a link in the event that a wireless service provider does not provide lcprequests (keep alives) in their network, or imposes time limitations on the network connections. interface An interface is another concept that is applied throughout the CLI. It is an entity to which you can route IP packets. An interface must be associated with a controller, which may be an underlying physical port. IP forwarding Page Glossary-13

322 Glossary: J IP forwarding allows IP packets received on an interface to be forwarded to other interfaces. IP routing table The IP routing table is a database in a router that keeps track of paths to particular networks and network destinations. More specifically, it associates network addresses with gateway addresses. Iptables Iptables is the method by which IP packets are filtered or manipulated for Remote RMC-700 and Remote RMM-800. IP packets are filtered or manipulated using three iptables: filter, which filters IP packets, mangle, which manipulates IP packets, and NAT, which routes IP packets. J job A job contains the specifications for running an instance of a script. It refers to a script defined within a package and specifies the parameters for execution on Remote RMM-800 or Remote RMC-700. job property A job property is a runtime parameter for a job on Remote RMM-800 or Remote RMC These properties are used within a Python script. job task A job task is an optional initialization step for a job before it runs a script. Tasks are used when a super user is required for job configuration, since scripts cannot be run by a privileged user on Remote RMM-800 or Remote RMC-700. Page Glossary-14

323 Glossary: K K keep-alive disconnect time The keep-alive disconnect time defines the number of seconds that a peer receives no packets before it is considered to be disconnected. Valid values are 20 to keep-alive inactivity time The keep-alive inactivity time defines the number of seconds that a session must be inactive before a ping packet is transmitted. Valid values are 5 to 60. keep-alive packets Keep-alive packets are sent from both the client and server when no user data is being transmitted. When one side of the connection fails to receive packets, a notification is sent to indicate a disconnected peer. These packets also maintain an active firewall state. L LCP echo request An LCP echo request is a packet sent from a client-side controller to a server-side controller to signal if a PPP link is still available. PPPD stops if LCP echo requests are not received by the server. LCP echo requests are sent only if LCP is enabled. line buildout Line buildout refers to the length of the cable (in feet) that is connecting the devices on each end of a T1 line or the level of attenuation (in decibels) required for the devices on each end of a T1 line to communicate. Buildout is usually specified by cable length for shorter connections and by level of attenuation for longer connections. Page Glossary-15

324 Glossary: L linemode Linemode is the type of hardware connection of an asynchronous link. There are two values for linemode: RS232 and RS422. RS232 is a set of standards that specify the type of interfaces connected to an asynchronous controller. The three types of interfaces are electrical, functional, and mechanical, which are used for communicating to computers, terminals, and modems. RS422 is a standard that defines a balanced interface that does not accompany a physical connector. local fallback Local fallback indicates local user authentication will be used when attempts to contact the primary and secondary RAS servers fail. local identity The local identity is supplied by the local site and sent to a remote device. The identity is similar to a user name for CHAP and PAP authentication on a point-to-point connection. local method The local method specifies the protocol Remote RMM-800 or Remote RMC-700 uses to authenticate a peer device on a serial controller PPP link. The two available methods are challenge handshake authentication protocol (CHAP) and password authentication protocol (PAP). local secret The local secret is supplied by the local site and sent to a remote device. The secret is similar to a password for CHAP and PAP authentication on a point-to-point connection. LTE LTE (Long Term Evolution) is a standard for wireless communication of high-speed data for mobile phones and data terminals. LTE is the natural upgrade path for carriers with both GMTS/UMTS networks and CDMA2000 networks. Page Glossary-16

325 Glossary: M M MAC address A MAC address is the address for a device as it is identified at the Media Access Control layer in the network architecture. MAC address capture MAC address capture refers to the process of listening to traffic on an Ethernet controller and then adding any MAC addresses learned to the controller s MAC address table. MAC address table A MAC address table is a list containing the MAC addresses of all the devices that are permitted access to Remote RMM-800 or Remote RMC-700 through an Ethernet controller. A MAC address table can contain a maximum of 32 MAC addresses. management information base A Management Information Base (MIB) is a repository of characteristics managed in a network device. Each managed device knows how to respond to standard queries issued by network management protocols (such as SNMP). maximum current The maximum current is the highest valid current allowed on a specified analog input and the sensor value associated with that current. maximum lease time The maximum lease time is the maximum amount of time, in seconds, a device can use an IP address assigned by the DHCP server. mediation connection Page Glossary-17

326 Glossary: N Mediation connections are connections that allow the interconnection of different protocols. The protocols on each side are terminated in the middle so that the interconnection can occur. minimum current The minimum current is the lowest valid current that will be present on the specified analog input and the sensor value associated with that current. MRU The MRU sets the maximum number of data bytes that can be received in a single PPP frame on a WAN port. MTU The MTU sets the maximum number of data bytes that can be transmitted in a single PPP frame on a WAN port. N nagging Nagging is the process of repeatedly generating an alarm message at fixed intervals even in the absence of an alarm state change. This is particularly useful for SNMP traps which do not provide guaranteed delivery. nagging interval The nagging interval configures the number of seconds between instances of an alarm sending its state to all enabled protocols. nagging level The nagging level defines the severity level at which an alarm will repeatedly send its state to all enabled protocols. Page Glossary-18

327 Glossary: O Network Address Translation Network Address Translation (NAT) is an iptables chain that allows multiple devices on a private network to share a single, globally routable public address. network element A network element is a processor controlled entity on the telecommunications network that provides switching and transport network functions and contains network operations functions. network element set An NE set provides a way to customize the number of instances of NEs of a particular type based on what actual physical equipment is at a site as compared to the fixed number of instances that are defined in the module. Once an NE set has been configured with new instances, the NE will need to be realized, just as the moduledefined NEs must be realized. notification code The notification code provides an indication of the severity of a TL1 alarm. NTP polling interval The minimum and maximum NTP polling intervals indicate the timeframe each host on a network has to connect to the NTP server to retrieve and transmit data. NTP server An NTP server maintains a common clock time among hosts within a network. O OID Page Glossary-19 OID (Object Identifier) points to a specific parameter in the SNMP agent.

328 Glossary: P offset When configuring the timezone for Remote RMM-800 or Remote RMC-700, offset is the number of hours and minutes difference between the desired time zone and the default time zone, which is standard GMT OpenVPN OpenVPN is a software package that establishes a VPN between an AI VPN server and AI network element clients. SSL is used to manage the VPN connection and encrypted UDP packets for data transmission. Both the management and data traffic are passed as UDP packets on a single port. The customer s external firewall needs to open one UDP port for all connected client network elements. originator An originator is a physical and visible component within Remote RMM-800 or Remote RMC-700 that generates the event, such as an analog input or digital input, serial controller, TL1 multiplexer, or an Ethernet controller. output signal There are two types of output signals on Remote RMC-700 and Remote RMM-800 asynchronous serial ports: DTR and RTS. DTR and RTS may be used as part of the connect and disconnect handshake. RTS may be used for hardware flow control. P package manifest The package manifest is an XML file that serves as a table of contents for the attributes of a script package. Page Glossary-20

329 Glossary: P packet framing Packet framing refers to the method by which packets are sent over a serial line. Framing options for T1 serial lines are D4 and ESF. Framing options for E1 serial lines are CRC4, no-crc4, multiframe-crc4, and multiframe-no-crc4. parity Bit parity is the process for detecting whether or not bits of data have been altered during data transmission. peripheral device A peripheral device is a system component that expands Remote RMX-3200 sor Remote RMM-700 s functionality. The only peripheral device currently available for Remote RMM-800 or Remote RMC-700 is the discrete expansion peripheral, which adds additional I/O points that are controlled by Remote RMM-800 or Remote RMC peripheral management subsystem The peripheral management subsystem is the subsystem that lets Remote RMM-800 or Remote RMC-700 manage up to 12 discrete expansion peripherals at remote locations. PID A PID is the TL1 password. position A position indicates where in the list order a task should appear and when it should be executed. PPP PPP (Point to Point Protocol) is a data link level protocol typically used to encapsulate network level packets over an asynchronous serial line. Page Glossary-21

330 Glossary: P PPPoE PPPoE (Point-to-Point Protocol over Ethernet) is a protocol for encapsulating PPP frames in Ethernet frames. PPPoE is used to virtually dial to another Ethernet machine, making a point to point connection. This connection can then be used to transport IP packets, based upon the features of PPP. preferred roaming list (PRL) On a CDMA/EvDO cellular modem, the PRL (Preferred Roaming List) is used to configure the radio channels and network carriers used by the modem. When carriers change their networks, it is useful to update the PRL to pick up the changes. priority level The priority level determines which interface within a standby group will become the master router. The higher the priority level, the more likely an interface will become the master router. A priority level of 255 specifies that an interface will become the master router. privilege level The privilege level is configured for a user-defined profile when RAS mode authorization is set to priv-lvl. The RAS server returns a privilege level to Remote RMM-800 or Remote RMC-700 and matches it up with the correct profile. profile A profile gives a user designated permissions for operating commands in Remote RMM-800 or Remote RMC-700. User profiles can be status, management, supervisor, or restricted. Python package A Python package is a directory used to store Python modules. The package can contain subpackages, resulting in a hierarchical directory structure. Each package directory must include a file named init.py to indicate to Python that this is a package. However, the file can be empty. Page Glossary-22

331 Glossary: R R RADIUS RADIUS authenticates a user and authorizes a profile from a remote location. RAS accounting RAS accounting is the method for tracking user logins and command entry when Remote RMM-800 or Remote RMC-700 is configured for TACACS+ remote authentication. An accounting start packet or stop packet is issued each time a user logs into or out of Remote RMM-800 or Remote RMC-700. An accounting start packet is also issued for each command that is entered. RAS authorization RAS authorization is the method by which Remote RMM-800 or Remote RMC-700 grants command access when TACACS+ remote authentication is configured. Access can be granted based on command level or privilege level. Command level authorization requires Remote RMM-800 or Remote RMC-700 to contact the TACACS+ server for each command the user runs. Individual commands are then allowed or denied. Privilege level authorization configures the TACACS+ authorization method based on the privilege returned from the TACACS+ server. RAS server A RAS server is a device that provides user authentication and provisioning for access into the network using RADIUS software or the TACACS+ protocol. RAS timeout The RAS timeout is the amount of time that the device waits for a response from the RAS servers before falling back on local authentication. raw alarm output Raw alarm output is a Remote RMM-800 or Remote RMC-700 alarm format that contains all information about the alarm and the event that caused it. It can be used for alarm formats that are not directly supported by Remote RMM-800 or Remote Page Glossary-23

332 Glossary: R RMC-700. A script or application can take the alarm information from the raw output and translate it into any type of alarm message. relay output Relay outputs can close or open an external circuit to cause connected devices to respond. remote access protocol The remote access protocol defines the methods for establishing a CLI session and transferring files. remote authentication Remote authentication is the method by which users are granted access to Remote RMM-800 or Remote RMC-700 through a remote server. Available remote authentication methods are RADIUS and TACACS+. remote identity The remote identity is supplied by a remote device and sent to the local device. remote method The remote method specifies the protocol a peer device uses to authenticate Remote RMM-800 or Remote RMC-700 for a controller PPP link. remote secret The remote identity secret is supplied by a remote device and sent to the local device. required task property A required task property is a value dependent on the task type required for a job. Both the ifconfig and serversocket task types have their own required properties defined within the package manifest XML, which are needed to run a job. Page Glossary-24

333 Glossary: S responder A responder is a visible component within Remote RMM-800 or Remote RMC-700, such as a serial or Ethernet controller, that implements responses. response A response is an executed result associated with a system event by configuration of an action rule on Remote RMM-800 or Remote RMC-700. response type A response type defines the activity that can be executed by the responder, such as disable, enable, or close. restart attempts The number of times Remote RMM-800 or Remote RMC-700 will attempt to restart a job if it stops abnormally. RTS signal The RTS signal is a control signal that may be used as part of the connect and disconnect handshake or for hardware flow control. The RTS signal is ignored if flow control is enabled. running configuration The running configuration (current Remote RMM-800 or Remote RMC-700 configuration) displays the current user modifications to the configuration. S script Page Glossary-25 A script is a Python class that defines a run and stop method, which implements the scripting interface on Remote RMM-800 or Remote RMC-700. A script can define job

334 Glossary: S properties, which pass runtime parameters and/or settings (such as, connection information for a network element, baud rates, TID s, phone numbers, software version, and user name and password information) to Remote RMM-800 or Remote RMC-700 when a job is executed. In addition, a script can define job tasks and the properties required to request IP configuration for a device or open a server socket connection to receive and transmit data. script package A script package is a compressed file that stores Python modules, Python packages, and the Package Manifest file. The modules included in the script package will be referenced by jobs, which are configured to run on Remote RMM-800 or Remote RMC-700. secret A secret is a shared encryption key that matches the encryption key configured on the server to provide secure access. secure sockets layer The Secure Sockets Layer (SSL) is the dominant security protocol for Internet/Web monetary transactions and communications. Information being transmitted is encrypted only the client and the server at the other end have the encryption key. server type Server type is the type of remote user authentication used to provide security on a RAS server. The two supported options are TACACS+ and RADIUS. service effect The service effect is the effect on customer telephone service of the condition reported by a TL1 alarm. SNMP Simple Network Management Protocol (SNMP) is a standard specification for exchanging information between Remote RMM-800 or Remote RMC-700 and a monitoring system. Page Glossary-26

335 Glossary: S SNMP management station Management stations are used to oversee network activity generated by SNMP agents, which are hardware and/or software processes that report on each network device. The trap table is a list of all available management stations. SNMP management system An SNMP management system is a system that can manage virtually any network type. It is widely deployed in TCP/IP networks, but actual transport independence means it is not limited to TCP/IP. SNMP trap SNMP traps are SNMP alarm messages. SNMP trap queue The SNMP trap queue saves SNMP traps when network connectivity is lost. When the network comes back up, the SNMP traps are sent. This feature accommodates wireless connections on Remote RMM-800 or Remote RMC-700, which are less reliable than regular connections. When trap queuing is enabled, pings are sent to SNMP hosts before traps are sent. Traps are queued when the ping to the SNMP host fails. Spanning Tree Protocol The Spanning Tree Protocol deactivates links between networks so that information packets are channeled along one path and do not search endlessly for a destination. SSH Secure Shell Protocol. An encrypting data transmission protocol used particularly for encryption of terminal connections. SSH permits secure remote access over a network from one computer to another. staging area The staging area is the pkgstage directory on Remote RMM-800 or Remote RMC- 700 that stores script packages prior to their installation. Page Glossary-27

336 Glossary: T stop bits A stop bit is a zero bit appended to a character transmitted on an asynchronous port. STP maximum age The STP maximum age specifies the maximum amount of time allowed before protocol information for the spanning tree protocol (STP) is discarded. T TACACS+ TACACS+ is a protocol that provides remote user authentication. task position A task position is the order in which a task will be executed within Remote RMM-800 or Remote RMC-700. The position indicates where in the list a task should appear. Unless a user specifies a new position for a task, Remote RMM-800 or Remote RMC- 700 adds new tasks to the end of the list. task property A task property is a required or optional parameter for a task. These parameters differ depending on the task type (ifconfig or serversocket) configured for a task. task type There are two types that can be assigned to a task. The task type ifconfig creates a subinterface for the job, which lasts for the lifetime of the job. The task type serversocket binds a socket for the lifetime of the job. text block Page Glossary-28

337 Glossary: U A text block is a field of a TL1 alarm response. The TL1 text block is a quoted text line in the response block of a TL1 autonomous message. The exact format of a TL1 text block varies based on the type of autonomous message being created. For more information about the exact TL1 text block formats for different types of TL1 autonomous messages, refer to the Bellcore GR-833-CORE documentation. TID The TID is the TL1 target identifier. TL1 command A TL1 command pattern can generate a system event. TL1 commands are delivered through a communication path to a virtual NE. TL1 multiplexer A TL1 multiplexer is a device that multiplexes more than one TL1 data stream onto a single TCP connection. trap A trap is an SNMP alarm message. U UID The UID is the TL1 user name. UMTS UMTS (Universal Mobile Telecommunications System) is one of the third-generation (3G) cell phone technologies, which is also being developed into a 4G technology. Page Glossary-29

338 Glossary: V units Units is the unit name for measurements associated with analog inputs. user datagram protocol The user datagram protocol (UDP) is part of the TCP/IP protocol suite. It was created to provide a way for applications to access the connectionless features of IP. UDP provides for exchange of datagrams without acknowledgements or guaranteed delivery. This protocol is normally bundled with IP-layer software. V Varbind In an SNMP message, a varbind consists of a sequence of two fields: an Object ID and the value for/from that Object ID. virtual TL1 NE A virtual TL1 NE is a simulation of a TL1 NE environment that provides the ability to generate TL1 alarms on behalf of a digital and analog inputs state changes, and other system events. It also can be used to generate system responses, such as closing and opening relay outputs upon receipt of TL1 commands. VLAN The term VLAN is specified by IEEE 802.1Q. It defines a method of differentiating traffic on a LAN by tagging the Ethernet frames. By extension, VLAN is used to mean the traffic separated by Ethernet frame tagging or similar mechanisms. VPN client The VPN client is the device that requests for a VPN session to be established on the VPN network. Page Glossary-30

339 Glossary: W VPN server The VPN server is a device that provides a VPN session to clients on the VPN network. W WAN Wide Area Network (WAN) is a computer network that covers a broad area (i.e., any network whose communications links cross metropolitan, regional, or national boundaries). wireless backhaul Wireless backhaul is the wireless connection from an individual base station (tower) to the central network (backbone). The Kentrox wireless backhaul solution layers a VPN on top of the wireless network. The VPN network is a logical extension of the overall private management network. Page Glossary-31

340 Glossary: W Page Glossary-32

341 Index A accessing CLI locally 2-2 help 2-2 web interface 2-8 accessing the CLI using local connection 2-2 action command example 10-6 components 10-6 configuring 10-7 description 10-2 alarm nagging 13-2 reporting 13-2 simulation alarm table central 13-2 description 13-2 features 13-2 test mode analog adjustment 13-7 averaging 13-6 B banner configuring 2-4 bi-state points configuring 25-6 BOOTP/DHCP relay configuring 17-8 C central alarm table protocol formats 13-3 raw alarm support 13-3 SNMP support 13-3 TL1 reporting support 13-3 CLI accessing with remote connection 2-7 commands excluding 3-7 identifications B-1 including 3-7, B-1 Concurrent Login Limits 3-5 configuration backing up A-2 factory 4-4 file 4-3 fragment 4-3 restoring A-3 running 4-2, 4-5 configuration file A-3 configuring alarm entry 13-4, 13-8, 13-10, alarms for expansion peripheral asynchronous serial to asynchronous serial connection asynchronous to TCP connection banner 2-4 BOOTP/DHCP relay 17-8 CLI session timeout 2-5 custom profile 3-7 default route 2-5 DHCP client 17-9 DHCP server 11-4, 17-3, 17-5 domain name 5-2 event, response, action 10-7 expansion peripherals 22-7 GPRS 9-4 host name 2-5 host on DHCP server 17-7 I/O points for discrete expansion peripheral 22-9 initial setup using wizard 25-3 IP address 2-5 IP settings 5-2 IPTables 11-6 IPv6 settings 5-4 jobs 20-1 measurement table entry 14-5 mediation TL1 command 18-3 modules 21-1 network element sets 21-2 NTP 5-7 OpenVPN 9-7 ppp encapsulation settings 9-4 script package 20-4 serial port using wizard 25-8 session timeout 2-5 SiteBus devices 22-13, 24-2 SNMP event template 19-5 SNMP measurement template SNMP NE SNMP point template 19-6, 19-9 SNMP to manage a relay output 18-6 SSH to asynchronous serial connection 15-9 static routes 8-1 strong password 3-3 system clock parameters 5-7 TCP connection 15-5 INDEX Page Index-1

342 Index: Telnet 13-16, 15-7, 16-6, 16-7 TL1 multiplexer 16-3 VPN 9-7 wireless modem 9-3 wireless network 9-1 Configuring an NE Set 21-7 Configuring Concurrent Login Limits 3-5 Configuring Modules Using Command Line Interface 21-3 Configuring Modules Using Web Interface controller bridge 6-2 definition 6-2 Ethernet 6-2 OpenVPN 6-2 serial 6-2 types 6-2 copy network recovery file 4-5 correlation expression configuring a time period 12-5 evaluation 12-4 operators 12-4 originator types and states 12-3 term 12-3 D DHCP client 17-9 DHCP server configuring 17-3 configuring a host 17-7 configuring subnet 17-5 E Ethernet 6-4 controllers 6-2 interfaces 6-4 ports 1-4, 1-6, 6-2, 6-4 event alarm associations 13-2 command example 10-4 components 10-4 configuring 10-7 correlation 12-2 description 10-2 event correlation components 12-2 configuring 12-6 description 12-2 expression components 12-3 expression example 12-3 H Heading 1 Installing a Script Pagkage 20-4 help I accessing 2-2 interface bridge 6-4 definition 6-4 description 6-4 Ethernet 6-4 modem 6-5 OpenVPN 6-4 serial 6-5 J job configuring dynamic memory configuring start times configuring with a job property 20-6 configuring with a job task 20-8 description 20-2 script package and script 20-5 K Kentrox Kickstart 2-2 L laptop access for Remote 11-1 assigning IP addresses 11-4 Login Limits 3-5 M measurement table entries configuration examples 14-5 states 14-2 use with alarm table 14-3 use with event correlations 14-3 overview 14-2 mediation connections description 15-2 N Network Address Translation configuring IPTables 11-6 enabling for laptop 11-6 network element sets configuring 21-2 description of 21-2 instance 21-2 NTP 5-7 P Package Manifest file 20-2 password changing 3-4 entering 2-3 strong 3-3 peripheral RMB RMB peripherals administrative states 22-5 configuring alarms configuring discrete I/O points 22-9 configuring SiteBus devices 22-13, 24-2 disconnecting a managed expansion discovery 22-4 expansion states 22-5 management configuration 22-7 operation states 22-5 overview 22-2 profile configuring B-1 creating custom 3-7 protocols 15-2 Python modules 20-2 R relay output configuring SNMP 18-6 configuring TL1 commands 18-4 description 18-2 open and close 18-8 Remote features 1-2 front panel connectors 1-4 RMX 1-5 Remote RMC-700 and Remote RMM- 700 TL1 Commands 26-1 Remote RMC-700 Hardware Configuration 1-4 responder 10-5 response components 10-5 configuring 10-7 description 10-2 restore network settings 4-5 RMX3200 overview 1-5 running configuration 4-2 running-config 2-5 S script components 20-2 Package Manifest file 20-2 Python modules 20-2 script package configuring a job 20-5 Page Index-2

343 Remote RMX-3200 Version 6.4x Configuration Guide Index:: creating and installing 20-4 SiteBus Combined Temperature and Humidity Sensor 14-8 SiteBus devices 22-13, 24-2 SNMP event template 19-5 manager 19-4 measurement template mediation event originator 19-4 NE template 19-9 network element point template 19-6 SNMP proxy configuration 19-2 configuration information 19-3 description 19-2 strong password 3-3 T templates NE 19-9 TL1 default commands 26-2 U users adding 3-2 deleting 3-6 V verify user environment 2-5 Virtual NE 16-4, 16-7 Virtual Network Elements 26-1 VNE 16-7 VPN configuring 9-7 W web interface accessing 2-8 functions 2-8 Home page 2-9 restore network settings 4-5 save running configuration 4-2 wireless network configurations 9-2 configuring for Remote 9-2 overview 9-2 wizards bistate-alarms 25-6 description 25-2 initsetup 25-3 serial-port 25-8 types 25-2 Page Index-3

344 Index: Page Index-4

345 Copyrights and License Statements Copyright by Kentrox and/or Westell Technologies The material discussed in this publication is the proprietary property of Westell. Westell retains all rights to reproduction and distribution of this publication. This product includes software copyrighted by the GNU General Public License and/or the GNU Lesser General Public License. The source for the GPL portions of the software is available at TRADEMARKS: Kentrox, the Kentrox logo, and other names are intellectual property of WestellTechnologies. Linux is a registered trademark of Linus Torvalds. CHAPTER 1 All other trademarks or registered trademarks appearing in this publication are property of their respective companies. To view entire license files and copyright statements for all open source code used in this product, use the show licenses command. Refer to the show licenses instructions in Remote RMC-700 and Remote RMM-800 Command Reference Guide. Page 1-1