PerleVIEW Device Management System User’s Guide Version 1.2 Part #5500320-12 May 2013 PerleVIEW V1.
Copyright Statement This document must not be reproduced in any way whatsoever, either printed or electronically, without the consent of: Perle Systems Limited, 60 Renfrew Drive Markham, ON Canada L3R 0E1 Perle reserves the right to make changes without further notice, to any products to improve reliability, function, or design. Perle, the Perle logo, and PerleVIEW are trademarks of Perle Systems Limited. Microsoft, Windows and Internet Explorer are trademarks of Microsoft Corporation.
Table of Contents Chapter 1 Introduction........................................................7 User Guide.................................................................................... 7 PerleVIEW User Guide Layout................................................................. 7 Typeface Conventions ............................................................................. 8 PerleVIEW Features ..................................................................... 8 Prerequisites ..............
Table of Contents Software Updates ................................................................................... 29 File Transfers .......................................................................................... 30 Apply Settings ........................................................................................ 31 Chapter 4 Working with Device Operations....................32 Discovering Devices.................................................................. 32 Device Scripting....
Table of Contents Chapter 8 Events ...............................................................91 Events ......................................................................................... 91 Automatic Event Handling ........................................................ 91 Event Filter Settings .................................................................. 99 Event Cleanup .......................................................................... 100 Custom Event Groups ....................
Table of Contents PerleVIEW Generated Events ................................................. 135 PerleVIEW Generated non Device Events ............................. 139 Remap MCR-MGT Management Module Events ................... 140 Appendix C Device Scripts.............................................141 Introduction ..............................................................................
1 Introduction Chapter 1 User Guide This user guide is provided to help you understand the management features of PerleVIEW. PerleVIEW is a Network Management System designed to help you maintain, control, configure, update and track the health of devices on your network. PerleVIEW can discover devices, automatically respond to events from these devices and track your device hardware and software inventory.
PerleVIEW Features This utility can be used to configure parameters used by PerleView if you are having problems connecting to PerleVIEW using your web browser. This utility allows you to stop or start the PerleVIEW server, configure SQL connection parameters, define Web connection parameters, modify the PerleVIEW Administrator (master) account and lastly update the PerleVIEW software running on this server. Typeface Conventions Most text is presented in the typeface used in this paragraph.
Prerequisites Feature Description Device Scripting Device scripting allows you to create tasks with embedded scripts files that you can deploy to all your devices or a single device. This can save time in that you do not have to connect to each device and send it the same script file. PerleVIEW Updates PerleVIEW can notify you of any PerleVIEW software updates required or automatically download these updates to the PerleVIEW server. These updates can then be applied at a later date.
Prerequisites z Chrome 8.
2 Basic Concepts Chapter 2 PerleVIEW is a Device Management System designed to provide you with information and control of a large number of devices deployed throughout your network. A device is an IP addressable, manageable control point. PerleVIEW supports the Perle Managed Media Convertor family. Management of these modules is provided via the MCR-MGT management module.
Guided Tour of the PerleVIEW User Interface Guided Tour of the PerleVIEW User Interface The first time you log into PerleVIEW you will see the Getting Started Wizard. This Wizard will help you set up and configure the parameters to be used with PerleVIEW. See Getting Started Wizard for more information. Each time thereafter you connect you will see the Home page. The Home page provides links to frequently used features.
Health Status Panel Navigating PerleVIEW The left-hand side of this screen is referred to as the “Navigation” panel. Using this panel you can quickly and easily see views for the Devices, Hardware and Events found in your managed network. You can drill down though submenus to focus in on a device, hardware or events. For each category, you can select from an existing PerleVIEW group or a custom group if you have created any.
Licensing Information Licensing Information PerleVIEW is provided to you with a free, 30 day evaluation period. During the free trial period, you can use all the features of PerleVIEW. The current status of your free trial will be displayed to the right of the Device health box on the title bar. Once the 30 day trial period expires, you are required to purchase PerleVIEW if you intend to keep using the application.
Online Help Online Help Online help is provided in PerleVIEW. You can click on the ( ) icon to get page level help. You can also get help from the PerleVIEW User’s Guide online by selecting Help -> Help Contents.
3 Getting Started Chapter 3 Installing PerleVIEW on your Server The PerleVIEW Setup Wizard installs PerleVIEW on your Windows Server and helps you setup the operating parameters to be used with PerleVIEW. To Begin Double-click on the PerleVIEW-setup.exe to launch the installation of PerleVIEW. This must be executed on the server you wish to install PerleVIEW. Click the Next button to continue. PerleVIEW will perform some basic checks before running the install.
Installing PerleVIEW on your Server Then click on the Install button to continue. Next, read the Privacy Policy and again, check the I Agree checkbox, then click on the Install button to continue. By default, PerleVIEW will be installed in this destination folder C:\Program Files (x86)\Perle Systems Limited\PerleVIEW. To change the destination folder either type in the path to be used or click the Browse button to browse to a new location. Click the Next button to continue the installation.
Installing PerleVIEW on your Server PerleVIEW is installing.
Installing PerleVIEW on your Server You must accept the licensing agreement to install Microsoft SQL Server. Read the license agreement, then select the checkbox to indicate that you agree to the terms of the license agreement.
Installing PerleVIEW on your Server SQL Connection Parameters If this is a new SQL connection, PerleVIEW will only require you to configure the SQL Server Name and the Database User. If you are using a existing SQL Server, then the following screen will appear. Click on the Yes button after you have completed the fields. SQL Server The Server Name consists of two parts separated by a backslash (\). The first part of the name is the hostname or IP address.
Installing PerleVIEW on your Server Network Protocol SQL Server Resolution Protocol will be used to determine how to connect to the selected SQL instance. If the SQL instance is local then the connection will use “Shared Memory”. If the SQL instance selected is remote then TCP/IP will be used and SQL Server Resolution Protocol (UDP port 1434) to obtain the connection information (i.e the port number) from the remote instance.
Installing PerleVIEW on your Server Next you will be asked to setup the parameters that PerleVIEW will use when communicating with a Web Client (browser). This includes enabling/disabling HTTP/HTTPS, the TCP ports that will used for these protocols and the name of the PerleVIEW master admin user. Please note that the master admin user must also exist in the server’s Windows user list. By default, this is set to the same user who is installing PerleVIEW. When completed, click the Next button to continue.
Installing PerleVIEW on your Server After entering the parameters, PerleVIEW will now create the PerleVIEW website on IIS Click the Ok button proceed. PerleVIEW has successfully been installed on your server. Click the Finish button.
Logging into PerleVIEW Logging into PerleVIEW Login You can connect to PerleVIEW using any of the supported Web browsers. See PerleVIEW Web Client Requirements for list of supported Web Browsers. 1. Open your web browser and type in the IP address of the server where you installed PerleVIEW followed by a colon (:) and the port number to connect on, then press Enter. For example: http://123.123.123.123:50000 https://123.123.123.
Getting Started Wizard Getting Started Wizard The first time you connect to PerleVIEW, you will see the Getting Started Wizard screen. The Getting Started wizard will guide you through the initial setup of discovering devices, setting up user security, checking your Internet connection, checking for software updates and setting the parameters to be used for file transfers. You can run the “Getting Started” Wizard at any time by selecting “Getting Started” under the “Help” pull down menu.
Getting Started Wizard Discovering Devices This part of the wizard will guide you through setting up the default device discovery task. PerleVIEW uses device discovery as the method by which it adds devices to its internal database. Before a device can be monitored or controlled, it must first be added to the PerleVIEW device database. To see more information on the Device Discovery task see Discovering Devices . Click on the Next button to continue.
Getting Started Wizard User Security In order to log into PerleVIEW, you must be a valid Windows user on the PerleVIEW server. By default, PerleVIEW is configured such that you also have to be configured on the PerleVIEW application as a user before you can successfully log into PerleVIEW. This gives you an extra level of control as to which Windows users will be allowed to access the PerleVIEW application. For more information about User Security and Configuring Users see PerleVIEW User Accounts .
Getting Started Wizard Internet Connection On some networks, access to the Internet is provided via a proxy server. PerleVIEW needs to reach the Internet for some of its functions to work such as sending Tweets and looking for software updates. If a proxy server is being used on your network, you should enter its access information here. Click on the Next button to continue. Use Proxy Server (HTTP/HTTPS) Select use Proxy server if you need a Proxy server to reach the Internet.
Getting Started Wizard Software Updates By default, PerleVIEW will notify the administrator of any new updates for itself or for any firmware for devices it manages. PerleVIEW will update the notification bar with a download pending message when an update is available. PerleVIEW can also be configured to automatically download software updates to the PerleVIEW server and firmware updates to the PerleVIEW repository.
Getting Started Wizard File Transfers PerleVIEW uses file transfers for a number of functions. This includes, but is not limited to downloading firmware updates, downloading/uploading device configuration, deploying scripts (only if file transfer mode is used). PerleVIEW can use HTTP (or HTTPS) to transfer files or alternatively it can use TFTP. PerleVIEW comes with TFTP server software. You can define how TFTP is used on PerleVIEW in the “File Transfers” screen. See PerleVIEW File Transfer Settings .
Getting Started Wizard TFTP Server By default, PerleVIEW will install its TFTP server on port 69. PerleVIEW will use its TFTP server to transfer all files. Select use existing TFTP server and Window File Sharing if you have an existing setup for file transfer. PerleVIEW will use Windows file transfer to transfer files between PerleVIEW and the TFTP server. Configured your TFTP server and port number to transfer files between target devices and your TFTP server.
4 Working with Device Operations Chapter 4 Discovering Devices Menu Selection: Discovering Devices Required Authorization: PerleVIEW Administrator PerleVIEW needs to add devices to its internal database in order to provide statuses on these devices. The way that PerleVIEW adds devices to it’s database is by running a device discovery task. PerleVIEW will also add devices to its database if it receives a trap message from a device not in its database.
Discovering Devices is found, it will be saved as the working credential for that device. If possible group devices with similar credentials into the same device discovery task instance. Launching Discovering Devices Devices ->Discovering Devices Working with Discovering Devices Tasks PerleVIEW provides the following discovery task functions.
Discovering Devices Add a Device Discovery Task Each device discovery task instance can have unique operating parameters. Add Click the Add button to create a new Device Discovery Task instance. Task name Use a meaningful name to uniquely identify this device discovery task instance. Schedule Manual - do not automatically run this task. This task can only be run from the Run Now button.
Discovering Devices Support ICMP ping messages If all devices in your network are reachable by sending an ICMP message, then select this checkbox to optimize the discovery of these devices. PerleVIEW will first send a ICMP message to see if the device is reachable before sending requests to gather information about this device.
Discovering Devices Show All Devices Click on the Show All Devices button to shows all of the devices which are present in the PerleVIEW device database. See Groups Views for more information. Task Details/Last Run Results This panel displays the task details of the selected discovery task instance. It shows the Last Run Results for the current task that was run, the name of the task, who submitted the task, status of the task, schedule and the start and end times.
Discovering Devices View Log The View Log button will display PerleVIEW related messages for this task. To see the full list of PerleVIEW generated messages see Appendix B, "Event Information". Target Results The Target Results button will display the results from the target devices.
Device Scripting Device Scripting Menu Selection: Device scripting Minimum Required Authorization: Device Operator PerleVIEW allows you to create Device scripts (which are lists of CLI commands) that can be sent to one or many devices. Scripts will be executed on each device and the results be will logged. You can find these logs under “Tasks --> Task Results” under the associated task name. CLI commands for the Perle MCR-MGT management Module can be found on our website at http://www.perle.
Device Scripting Each deploy script task instance can have unique operating parameters. Add Click the Add button to create a new Deploy Script task instance. Task Name Enter a name to uniquely identify this device script task instance. Targets Select the device(s) to which you want to deploy this script. Scripts can be deployed to Device groups, Custom Groups or selected individual devices. Schedule See Add a Device Discovery Task for configuration parameters.
Device Scripting Manage Script Library These scripts are used by the “Deploy Script” tasks. Click on the Manage Script Library button to add new script files to the script library, delete existing script files or import existing script files from a different location. Import Import a file from another location into the script library. The script is displayed in the “Edit script” window and can be edited if needed. Add Add a new script file to the Script Library.
Backup/Restore Device List Backup/Restore Device List Menu Selection: Backup/Restore Device List Minimum Run Authorization: PerleVIEW Administrator If you ever lose the contents of the PerleVIEW database, you can use this backup feature to restore the lists of devices to the PerleVIEW database. The restore device list feature would launch a discovery task instance with all the IP addresses of your previously discovered (and backed up) devices defined for that instance.
Backup/Restore Device List You can either select to run the Restore immediately or have it run at a later time by selecting the “Run at” option. Click the Apply button to create the discovery task instance for this restore operation.
Backup/Restore Device Configuration Backup/Restore Device Configuration Menu Selection: Backup/Restore Device Configuration Minimum Run Authorization: PerleVIEW Administrator PerleVIEW provides the ability to backup and restore individual device configurations to the PerleVIEW repository. Each device’s configuration will be saved to a separate file which will be permanently associated with that device. Once backed up, if a need ever arises, you will be able to restore the configuration to that device.
Backup/Restore Device Configuration Run Now To run a existing Backup Device Configuration task immediately, select the task from the list, then click on the Run Now button. Add Click on the Add button to create a new Backup Device Configuration task instance. Task name Enter a name to uniquely identify this backup task instance. Targets Choose which devices to back up. This can be done by selecting individual devices or by selecting a device group.
Backup/Restore Device Configuration Run Now To run an existing Restore Device Configuration task instance immediately, select the task from the list, then click on the Run Now button. Add Click the Add button to create a new Restore Device Configuration task instance. Task name Enter a name to uniquely identify this Restore Device Configuration task instance. Targets Choose which devices to you wish to restore the configuration for.
Backup/Restore Device Configuration Task Details This window displays the current task details of the selected Backup Device Configuration task instance. To delete device configuration from the PerleVIEW database, click on “Device with Saved Configuration” option. Devices with saved configuration For each device on the list, you are presented with some basic information on the device. This view can be customized by clicking on the “Columns” button on the top, right hand of the table.
Configure Device Settings Configure Device Settings Menu Selection: Device Settings Minimum Run Authorization: PerleVIEW Administrator This function allows you to change a number of device related, global parameters. These include settings for Device Discovery tasks, Device credentials, Polling timers and Network protocol settings.
Configure Device Settings Exclude the following IP addresses and ranges from device discover. To exclude certain IP addresses or IP ranges from the device discovery task, add entries to the table. Valid options are IP addresses and IP ranges. Exclude a single IP address or a range of IP addresses. examples: 172.16.1.5 (excludes a single IP address) 172.16.10.1 - 172.16.10.100 (excludes addresses 1-100 in the specified subnet of 172.16.
Configure Device Settings SNMP Credentials As each device is discovered, the credentials configured will be tried on it until one set is found to work. This set will be saved as the working credentials for that device. Read SNMP Communities You can configure up to 10 SNMP Read communities within PerleVIEW. These configured SNMP communities need to match the configured SNMP Read communities configured on one or more of your devices.
Configure Device Settings Operator Credentials Use operator login depending on the privilege level that the users has on the target device. These credentials are used to log into the device. (example Direct management of the device using Telnet). Configure up to 10 Operator user names and passwords that PerleVIEW will validate against the device until a valid pair is found. SSH Keys As each device is discovered, the credentials listed will be tried on it until one set is found to work.
Custom Device Groups Protocol Settings HTTP/HTTPS Telnet, SSH Connection Timeout Specify the maximum time to wait when establishing various types of connections between PerleVIEW and the device. SNMP, ICMP and Perle Discovery protocol Timeout Specify how long to wait for a reply from the device after sending either a UDP message on port 33816, an SNMP message, a ping message or a Perle Discovery request. This field should contain the value in seconds of the device which has the longest response time.
5 Groups of Devices, Hardware, and Events Chapter 5 Groups Views Group Views allows you to quickly and easily see the Devices, Hardware and Events found in your managed network. You can quickly drill down though submenus to get details about these devices, hardware or events. From these submenus you can manage and control most features of your devices as well, you can view and edit your installed hardware modules such as management modules, media converter modules and individual media converter ports.
Groups Views Working with Device Views To View All Devices select Devices -> All Devices from the left navigation panel. Devices ->All Devices This view shows all of the devices which are present in the PerleVIEW device database. At the top of the screen there is a count for the number of devices in the list which fall into each health category. For an “All Device” view, this count will match the count on the title bar.
Groups Views Details Use the Details button to bring up a table with various information and actions that can be performed on the selected device. The same can be achieved simply by clicking on the device name. For more information see Working with Device Views . Delete Use the Delete button to remove a device or devices from the PerleVIEW database. All information for the device will be lost. Edit Use the edit button to change parameters for this device or devices.
Groups Views Timeout Specify how long to wait for a reply from the device after sending either a UDP message on port 33816, an SNMP message, a ping message or a Perle Discovery request. This field should contain the value in seconds of the device which has the longest response time.
Groups Views Credentials (Device/s) To access all of PerleVIEW’s features at least one Read or Read/Write community must be configured within PerleVIEW to match a SNMP community configured on the target device. Select credentials to delete SNMP Read Community Select the checkbox for SNMP Read community if you do not want to attempt SNMP Read credentials for this device.
Groups Views Admin Login Select the check box to enter in your own Admin Login credentials. These credentials will be used when attempting to validate credentials on this device/s. Operator SSH Key Select the check box to enter in your own Admin Operator SSH Keys. These credentials will be used when attempting to validate credentials on this device/s. Admin SSH Key Select the check box to enter in your own Admin SSH Key.
Groups Views Health Details This is the current health status of this device. To see more information on device generated messages (see your MCR-MGT users guide for Device messages). User Access Level This is the device access level for this device for the current user logged into PerleVIEW. Valid user access levels are Device View, Device Admin and Device Operator. For more information on user access levels see PerleVIEW User Accounts .
Groups Views Device Details -> Hardware For each device on the list, you are presented with some basic information on the device. This view can be customized by clicking on the “Columns” button on the top, right hand of the table. Column Details Type This is the type of hardware inserted in this chassis slot. Health This is the current health status for this device.To see more information on health statuses see Health Status Panel .
Groups Views Preferred Name The name the you typed in the Preferred field for this hardware. Use Preferred Name Check this box to use the Preferred Name from the above Name field. This would override a name retrieved from the hardware. Custom 1, 2, 3 These field can be used to save information about this hardware to be used in logs, views and reports. Device Details -> Hardware -> Edit For each device on the list, you are presented with some basic information on the device.
Groups Views Custom 1, 2, 3 These field can be used to save information about this hardware to be used in logs, views and reports. Events Details From this screen you are able to add a comment to an event, set an event as acknowledged or not, or delete the event from the database. By managing events on your network you will be able to view the events that are critical and deal with those events first. Click on the Events tab to see the list of events associated with this device.
Groups Views Click on any of the buttons below to change the details for a selected event. Comment Enter a comment about this event. Mark as acknowledged Mark an event as acknowledged if you have viewed or have no further action for this event. Mark as unacknowledged Unmark a previously marked acknowledged event as unacknowledged so that you are aware that an action is needed for this event. To help manage events, you can set up Automatic Event Handling or Event Filter Settings .
Groups Views SNMP, ICMP and Perle Discovery protocol Timeout Specify how long to wait for a reply from the device after sending either a UDP message on port 33816, an SNMP message, a ping message or a Perle proprietary message. This field should contain the value in seconds of the device which has the longest response time.
Groups Views Device Details -> Credentials To access all of PerleVIEW’s features at least one Read or Read/Write community must be configured within PerleVIEW to match a SNMP community configured on the target device. Attempted Credentials SNMP Read The check mark indicates that a SNMP Read community was found for this device during the discovery process, these credentials were tried and were found to be successful.
Groups Views Operator Login Select the check box to enter in your own Operator Login credentials. These will be used when attempting to validate credentials on this device. Admin Login Select the check box to enter in your own Admin Login credentials. These will be used when attempting to validate credentials on this device. Operator SSH Key Select the check box to enter in your own Operator SSH Key credentials. These will be used when attempting to validate credentials on this device.
Groups Views View Devices by Subnets View Devices by subnets groups your devices based on the subnet they reside on. You can choose to view all devices on a particular subnet or use the subnet information to drill down to a specific device on that subnet. To view device by subnets select Devices -> Subnets from the left navigation panel. Devices -> Subnets To view details see Groups Views . View Devices by Health This view allows you to view all devices grouped by their current health status.
Groups Views Limited Functionality Devices that show up under the “Limited Functionality” grouping are devices that meet one of the following criteria; Unsupported firmware These devices are running firmware which is the pre v1.5 which is required in order to be fully supported by PerleVIEW. These devices need to be upgraded to the latest version of software available. You can have PerleVIEW automatically retrieve the latest device firmware by enabling the “Check for Firmware Updates” feature.
Groups Views Device -> Not Configured Select the device you are interested in working with from the list, then click one of the action buttons. To work with this device, click on the Details button, Edit button or Delete button. These are the details of this unconfigured device. Click on the Assign IP Address Button to assign an IP address.
Groups Views Assign IP Address Successful Device - Unsupported Firmware Select the device you are interested in working with from the list, then click one of the action buttons. To work with this device, click on the Details button, Edit button or Delete button.
Groups Views To update this device with the latest firmware see Check for Firmware Update and Deploying Firmware . Working with Hardware Views PerleVIEW supplies you with four pre-defined Group Views under the submenu Hardware. These groups represent distinct hardware in your system. They are as follows: z All Hardware - View all discovered hardware on your network.
Groups Views To view All Hardware select Hardware -> All Hardware from the left navigation panel. Hardware->All Hardware All Hardware -> Edit For this example select the chassis (device named tmc-mcr-mgt), then click the Edit button. To edit multiple media converters, select the boxes beside the fields to be edited. The text entered in these fields will be added to all selected hardware. See Working with Device Views for more information.
Groups Views Hardware->Management Modules To view all Media Converters select Hardware -> Media Converters from the left navigation panel. Hardware->Media Converters To view all Port select Hardware ->Ports from the left navigation panel. Hardware->Ports See Groups Views for more information. Working with Event Views PerleVIEW supplies you with one pre-defined Group View under the submenu Events. z All Events - View all events generated by your devices or PerleVIEW.
Groups Views Managed devices must be configured to send events (traps) to PerleVIEW. After PerleVIEW receives the event, it applies any configured filters to the event, it then performs any actions configured under Automatic event handling and lastly the event is added to the PerleVIEW database for later viewing. For more information on Events and Automatic Event handling see Automatic Event Handling .
6 Hardware Activities Chapter 6 Collecting Statistics Menu Selection: Collect Statistics Minimum Required Authorization: Device Operator PerleVIEW provides you with the ability to create tasks to collect statistics from media converter ports on your devices. Statistics are only available on rate converting media converter module ports.
Collecting Statistics To run an existing statistics collection task instance immediately, select the task from the list, then click on the Run Now button. Add a Statistics Collection Task Each Statistics Collection task instance can have unique operating parameters. Add To Add a new Statistics Collection instance, click on the Add button. Task Name Use a meaningful name to uniquely identify this statistics collection task.
Collecting Statistics Input Frames Number of good frames received in the following categories; z Unicast frames z Broadcast frames z Multicast frames z Pause frames Number of bad frames received in the following categories; z Undersized frames Output Frames z Fragmented frames z Oversized frames z Jabber frames z MAC receive error frames z FCS error Number of good frames transmitted in the following categories; z Unicast frames z Broadcast frames z Multicast frames z Pause frames N
Collecting Statistics Edit To Edit a Statistics Collection task instance, click on the Edit button. Task Details This panel displays the current task details of this task instance as well as the Last Run Results. See Working with Device Views for more details on logs, details and results.
Check for Firmware Update Check for Firmware Update Menu Selection: Check for Firmware Updates Required Authorization: PerleVIEW Administrator PerleVIEW can check the Perle Web site for new firmware updates for the devices that it manages. There are two options with regards to the action taken by PerleVIEW if an update is available. The first is to only have PerleVIEW notify the administrator that new firmware updates are available for its target devices.
Check for Firmware Update Check Now Results Download Now Download Now indicates that there is a download pending. Highlight the entry and then select the Download Now button. The firmware will be transferred from the Perle Web site to the PerleVIEW repository. Deploy Update Deploy Update will create a new Add Task Deploy Firmware task instance. For configuration parameters see Add a Deploying Firmware Task. Delete Update Highlight the update to be deleted then select the Delete Update button.
Check for Firmware Update Firmware Deployment Tasks Firmware Deployment Tasks After the firmware has been download to the PerleVIEW repository or a directory location created by you, this firmware needs to be deployed to the target devices. To deploy firmware you need to create firmware deployment tasks instances. See Deploying Firmware.
Deploying Firmware Deploying Firmware Menu Selection: Deploying Firmware Required Authorization: Device Administrator PerleVIEW manages it’s firmware within the PerleVIEW’s repository. Firmware images are uploaded into the repository. You can create firmware deployment tasks instances to download the firmware to target devices. Launching Deploying Firmware Hardware->Deploying Firmware Working with Deploying Firmware PerleVIEW provides the following task functions for Deploying Firmware.
Deploying Firmware Add a Deploying Firmware Task To create a task to deploy firmware to devices that are managed by PerleVIEW, click on the Add button. When you are done, click the Apply button to add the task to the PerleVIEW database. You will be prompted to accept the licensing agreement in order to continue. Specify your country. If you reside in Germany you must select “Germany” as your country. Germany has unique licensing requirements. After selecting your country, click the I Agree button.
Custom Hardware Groups Custom Hardware Groups For more information on Custom Hardware Groups see Appendix A, Custom Views by Groups.
7 Tasks Chapter 7 Task PerleVIEW provides you with the ability to create task instances for common functions you need to perform on your devices. By creating tasks this gives you the ability to control and schedule when certain functions will be performed (example: discovering devices or deploying software).
Tasks Tasks Menu Selection: Tasks Minimum Required Authorization: Depending on the task Tasks are used by PerleVIEW to perform a variety of functions. If you need to perform an action which is different from the one being performed by the default system task, you can create your own instance of task using this menu. As an example, you may be going through an expansion which will be adding devices over the next month in a particular subnet.
Tasks Run Now To run a task immediately, select a task from the task list, then click on the Run Now button.That task will execute immediately using the parameters configured for that task instance. Once run, the task will resume its normal schedule. Add To create a new task, click on the Add button, then select a task from the drop down list. To create a Discovering Device task instance see Discovering Devices. To create a Collecting Statistics task instance see Collecting Statistics.
Task Results Task Results Menu Selection: Task Results Minimum Required Authorization: None This menu item provides access to the task results for all task instances which have been run by PerleVIEW. Launching Task Results Task -> Task Results Working with Task Results PerleVIEW provides the following actions which can be performed on a specific task result.
Task Results End Time Shows the time when this task instance finished running. Start Time Shows the time when this task instance started running. User This is the user that created this task.
Task Results Cleanup Task Results Cleanup Menu Selection: Task Results Cleanup Minimum Required Authorization: PerleVIEW Administrator The purpose if this clean up task is to remove old task results which are no longer needed from the PerleVIEW database. PerleVIEW will perform the clean up operation periodically in an attempt to maintain the number of task results in the database to the configured level.
Task Results Cleanup Run Now Results This subsection defines the criteria for removing task results associated with manually run tasks (as opposed to scheduled tasks). You can set the maximum number of task results to keep for all run now task instances. The latest results will be kept. Default: 200 task results Values: 1- 99999 task results You can optionally delete “run now” task results which are older than the specified number of hours.
8 Events Chapter 8 Events Events can come from two sources. One is an SNMP trap received from a managed device which is being monitored by PerleVIEW. The second is an event which is generated by PerleVIEW itself (for example: PerleVIEW detects that a device is no longer reachable). After PerleVIEW receives the event, it applies any configured filters to the event, it then performs any actions configured under Automatic Event Handling and lastly the event is added to the PerleVIEW database for viewing.
Automatic Event Handling Working with Automatic Event Handling PerleVIEW provides the following automatic event handling task functions. z Enable/Disable an automatic event handling task instance z Add an automatic event handling task instance z Delete an automatic event handling task instance z Edit an automatic event handling task instance Each Automatic Event Handling task instance can have unique operating parameters.
Automatic Event Handling Events Select the “type” of events you want this automatic event handling task instance to act upon. You can select all events or select the severity level of an event. Valid options are Critical, Major, Minor, Warning, Normal, Informational and Important Events (Important Events are the grouping of Critical, Major and Minor events). Sources Select the source from which the event is generated. Sources can either be a PerleVIEW application or/and a Device event.
Automatic Event Handling Subject Type in a message for the subject that is meaningful to you. By default, PerleVIEW uses internal macros to configure the subject message as: Event on ${DeviceName} at IP address ${DeviceIPAddress} Where ${DeviceName} is the actual Device Name or the Preferred Name if configured. ${DeviceIPAddress} is the IP address of the device. Body Type in a body message that is meaningful to you.
Automatic Event Handling Carrier Domain Configure a Carrier Domain. For example: @txt.bell.ca Subject Type in a message for the subject that is meaningful to you. By default, PerleVIEW configures the subject message as: Event on ${DeviceName} where ${DeviceName} is the actual Device Name or the Preferred Name if configured. Body Type in a body message that is meaningful to you.
Automatic Event Handling Message Type in a message that is meaningful to you. $[{DeviceName}]${EventMessage} where ${DeviceName} is the actual Device Name or the Preferred Name if configured. ${EventMessage} where ${EventMessage} is either a PerleVIEW generated message see Appendix B, "Event Information" or a Device generated message (see your MCR-MGT users guide for Device messages). Any tweets over 140 characters will be sent as multiple messages.
Automatic Event Handling To view SNMP traps on the Trap Receiver, you must load both the MCR-MGT Management Module MIB and the PerleVIEW MIB into the Trap Receiver (both these MIBs can be found on the Perle Web site http://www.perle.com/downloads/ After completing the fields, click on the Test button to have PerleVIEW send a test trap to the trap receiver.
Automatic Event Handling 98
Event Filter Settings Event Filter Settings Menu Selection: Event Filter Settings Minimum Required Authorization: PerleVIEW Administrator By default, PerleVIEW will capture events of all severity levels (Critical, Major, Minor, Warning, Normal and Informational) sent from devices as well as ones generated by the PerleVIEW application. This configuration lets you select which severity levels you want PerleVIEW to process.
Event Cleanup Event Cleanup Menu Selection: Event Cleanup Minimum Required Authorization: PerleVIEW Administrator PerleVIEW provides an event cleanup task that will remove old and/or acknowledged events from the PerleVIEW database. This task can be run manually at any time or periodically on a configured schedule. By scheduling a regular cleanup task, this allows you to maintain only the events that are current and relevant on your system.
9 Administration Chapter 9 Administration PerleVIEW administration tasks enables you to set up PerleVIEW global configuration parameters, user account settings, view or export the Audit logs and configure when software updates to PerleVIEW will be performed.
PerleVIEW Server Settings Working with Server Settings PerleVIEW provides the following options for Server Settings. z Force Secure Connections to devices (HTTPS/SSH) z Validate CA certificates z Configure Web Terminal TCP Listening ports PerleVIEW Server Setting Force Secure Connections to device (HTTPS/SSH) Select the Force Secure Connections to device if you want Web Manager and Web Terminal connections between PerleVIEW and the target device to be secure connections only.
PerleVIEW User Accounts PerleVIEW User Accounts Menu Selection: PerleVIEW User Accounts Minimum Required Authorization: PerleVIEW Administrator PerleVIEW uses a concept of authentication for logging users into PerleVIEW and a concept of authorization for giving users and groups access rights to target devices. PerleVIEW uses Windows authentication to control users logging into PerleVIEW.
PerleVIEW User Accounts Rights Device Access PerleVIEW Administrator This is the highest access level available on PerleVIEW. It provides access to all PerleVIEW administrator functions as well as Device Admin access. If a user is not a PerleVIEW administrator, they are a PerleVIEW operator. A PerleVIEW operator can not make any changes that would affect the configuration or operation of PerleVIEW.
PerleVIEW User Accounts PerleVIEW User Accounts (Add) To Add a new User to the PerleVIEW database, click on the Add User button. To Add a new Group to the PerleVIEW database, click on the Add Group button. Add User Click the Apply button to save your changes. Name Type in the name the user will use to log on. Domain If required type in the domain name to fully qualify the user. Full Name Type in the users full name.
PerleVIEW User Accounts Click the Add button to Add device access rules for this user. You can add multiple “device access” rules for the same user. Add Device Access Rule (User) Access Level This selects the device access level which will be assigned for this user for the devices selected below. Valid device access levels are Device Admin, Device Operator and Device View. For more information on device access levels see PerleVIEW User Accounts .
PerleVIEW User Accounts Add Device Access Rule (Group) Access Level Select the device access level which will be assigned to this group for the devices selected below. Valid device access levels are Device Admin, Device Operator and Device View. For more information on device access levels see PerleVIEW User Accounts . Devices Choose a device group or select individual devices to which this user group will be assigned the “Access Level” selected above.
PerleVIEW User Accounts The “Device access” area shows the device access that this user has. The device access can be obtained in two ways. First the user can inherit the device access by belonging to a group and any access for that group will be inherited. Secondly, device access can be added for a user by selecting the Add button and selecting device groups or individual devices you want to add for this user.
PerleVIEW File Transfer Settings PerleVIEW File Transfer Settings Menu Selection: File Transfer Settings Minimum Required Authorization: PerleVIEW Administrator PerleVIEW uses file transfers for a number of functions. This includes but is not limited to downloading firmware updates, downloading/uploading device configuration, deploying scripts (only if file transfer mode is used). PerleVIEW can use HTTP (or HTTPS) to transfer files or alternatively it can use TFTP.
PerleVIEW File Transfer Settings Repository Location The Repository location is the location on your PerleVIEW server where your downloaded software and configuration files will be stored. If you choose to specify your own software location to store your updates the server path needs to be in Microsoft Windows UNC format (Universal Naming Convention). Example \\ComputerName\SharedFolder\Resource.
PerleVIEW Updates PerleVIEW Updates Menu Selection: PerleVIEW Updates Required Authorization: PerleVIEW Administrator PerleVIEW can be set to automatically check for firmware updates to itself. PerleVIEW can either notify the administrator that updates are available or automatically download the updates to the PerleVIEW server. After the software has been downloaded from the Internet, you can then update PerleVIEW by using the PerleVIEW Admin Utility.
PerleVIEW Updates Check Now To Check for PerleVIEW Updates now, click on the Check Now button. Results of Check Now The yellow banner on the bottom of the screen will display any available downloads for PerleVIEW. Click the Download Button to have the updates saved to the PerleVIEW server. Internet Proxy Button On some networks, access to the internet is provided via a proxy server. PerleVIEW needs to access the Perle Web site in order to check for software updates.
PerleVIEW Audit Trail Log PerleVIEW Audit Trail Log Menu Selection: Audit Trail Log Minimum Required Authorization: PerleVIEW Administrator This is a log of PerleVIEW activities done by system tasks, services, or by users via the web application. The Audit Log records all internal PerleView application messages. It allows you to monitor what the PerleVIEW application is doing. The Audit Trail Log will not exceed 1 Megabyte in size.
PerleVIEW Audit Trail Log Source Type Provides information on what originated the message. Action Provides an indication of what action was performed. Result Provides information on the results of the action taken. Valid results include Successful, Failure, Cancelled, Stopped or Pending. User This is the name of the user that performed the task that created the entry in the audit log file. If the user field is blank that means that this task was started by PerleView.
Internet Proxy Server Internet Proxy Server Menu Selection: Internet Proxy Server Minimum Required Authorization: PerleVIEW Administrator On some networks, access to the Internet is provided via a proxy server. PerleVIEW needs to reach the Internet for some of its functions to work such as sending Tweets, E-mails and looking for software updates. If a proxy server is being used on your network, you should enter its access information here.
E-mail Account Settings E-mail Account Settings Menu Selection: E-mail Account Settings Minimum Required Authorization: PerleVIEW Administrator PerleVIEW has the capabilities of notifying you via E-mail of events occurring on your network. These events could be generated by devices or by PerleVIEW when it detects a status change (i.e. loss of communication with a device) or other non-device related events. Use this feature if you need to be notified via E-mail of certain events which occur in your network.
E-mail Account Settings Password Specify a password for authentication. Confirm password Type the password again to confirm. Domain Specify a domain name if the E-mail server requires it.
Twitter Users Twitter Users Menu Selection: Twitter Users Minimum Required Authorization: PerleVIEW Administrator PerleVIEW has the capabilities of notifying you via tweets on your Twitter account of events occurring on your target devices or on PerleVIEW itself. To setup for tweets, you need to follow these steps. 1. Have an existing Twitter user account or add a new user account at www.twitter.com. 2.
Twitter Users Enter your Twitter userid and password, then click the Authorize app button. Success You should receive a message indicating that PerleVIEW is now authorized to post tweets on behalf for this user.
10 PerleVIEW Admin Utility Chapter 10 PerleVIEW Admin Utility This utility can be used to configure parameters used by PerleView if you are having problems connecting to PerleVIEW using your web browser. An example would be the configuration of the HTTP port which PerleVIEW listens on for client connections. This utility also allows you to stop or start the PerleVIEW server. Using the utility to do so will ensure that an orderly and complete shutdown occurs.
SQL Connection This screen allows you to stop or start the PerleVIEW server. PerleVIEW Startup Start up all PerleVIEW services on the Windows Server. PerleVIEW Shutdown Shut down all PerleVIEW services on the Windows Server. SQL Connection PerleVIEW uses these parameters to connect to your SQL Server. The server can be either locally (on the same server) or remote to the PerleVIEW server.
SQL Connection Connect to database If you are using Windows Authentication Mode, type in the Windows user name (FQDN if required) as defined within your Windows Server environment. If you selected SQL Authentication mode you will need to provide the user name you configured for this user in the SQL server configuration. If the SQL server does not have a login account set for this user, authentication will fail and the user will receive an error message.
Web Connection Encrypt Connection PerleVIEW will force the data between PerleVIEW and the SQL server to be encrypted. This is recommended if you are concerned about someone intercepting the data between the SQL Server and PerleVIEW. Verify SQL Connection PerleVIEW verifies that a connection can be made to the SQL server. Web Connection PerleVIEW uses these parameters for connections from Web browsers.
PVAdmin (PerleVIEW Administrator) PVAdmin (PerleVIEW Administrator) Configure the following parameters: Type Master Administrator. Name Enter a Master Administrator Name. Domain Type in a domain name if required by your network. Full Name Type in Administrators Full Name (optional).
PerleView Software Update PerleView Software Update This utility is used to deploy software updates for PerleVIEW. Obtaining the software and placing it on the server can be performed manually or by PerleVIEW. PerleVIEW can be set to automatically check for firmware updates to itself. See PerleVIEW Updates to set the parameters for automatic software checking. Once the updated software has been downloaded to PerleVIEW, use this option to perform the actual update.
PerleView Software Update You will be prompted on whether you want to remove the PerleVIEW database. Click the Yes button to remove the PerleVIEW database. Click the No button to keep the database and continue the uninstall. PerleVIEW will now be uninstall from this server.
A Custom Views by Groups Appendix A Creating Custom Views by Groups Menu Selection: Custom Device/Hardware/Events Groups Minimum Run Authorization: Everyone PerleVIEW has a very powerful grouping feature. It allows you to create custom views of devices, hardware and events. By creating group views you can clearly see the views that are important to you to maintain your devices.
Creating Custom Views by Groups Here are some examples of group views z Create a custom group view of all devices who’s Name field begins with “Boston” with a health status of Major. See (Example 1). z Create a custom group of hardware with selected SFP modules. See Example 2. z Create a custom group of all unacknowledged events with a health status of Major. See Example 3.
Creating Custom Views by Groups Add Device Group 1. Type in the name of the group (Boston_Servers). 2. Select the checkbox “Share with all PerleVIEW users”, if you want to share this device view with the other users of PerleVIEW. 3. Select Group members from “By criteria”. 4. Choose Group criteria of: z Select “Match all” from the first drop down box. z Select “Health” from the next drop down box. z Select “is” for the operator. z Select “Major” from the third drop down box. 5.
Creating Custom Views by Groups 8. Your Custom Device Group will now be displayed within the left navigation panel under Group Views (Devices). Group View of Boston_Servers This view has the same properties as any other device view. See Groups Views. for more details. This view can be customized by clicking on the “Columns” button on the top, right hand of the table.
Creating Custom Views by Groups Add Hardware Group 1. Type in the name of the group 2. Select the checkbox “Share with all PerleVIEW users”, if you want to share this hardware view with other PerleVIEW users. 3. Select Group members from list box. 4. Select the checkbox beside all of the SFP modules you want to add to this group. 5. Click the Apply button to save this new Custom Hardware Group. 6.
Creating Custom Views by Groups Example 3 In this example you want to create a Custom Event Group to view all unacknowledged events with either a Critical or a Major health status. Your criteria is: z all unacknowledged events z health status of Critical or Major Custom Groups First you need to add a Group for Events by selecting Events from the drop down box and then click on the Add button. Add Event Group 1. Type in the name of the group “Unacknowledged-Events-Group” 2.
Creating Custom Views by Groups z Select “Severity” from the first drop down box. z Select “is” for the operator. z Select “Critical” for the last drop down box. z Click the Plus button (add rule) to add the second entry for severity. Change the criteria in the last drop down box from Critical to Major. You should now have two entries under submenu “Match any” as follows: Severity is Critical Severity is Major 5. The next criteria you have for this group is all events must be unacknowledged.
Creating Custom Views by Groups View Group of Unacknowledged Events This view has the same properties as any other event view. See Groups Views for more information. This view can be customized by clicking on the “Columns” button on the top, right hand of the table.
B Event Information Appendix B PerleVIEW Generated Events Event Severity Health Status Message Critical Critical Device {0} at IP address {1} is not reachable. Critical Critical Device {0} at IP address {1} firmware version {2} does not fully support $(SWProductName) functions. Please upgrade your Device firmware to the latest version. Critical Critical New Perle factory default device {0} at IP address {1} has been discovered. Please assign a proper IP address to this device.
PerleVIEW Generated Events Event Severity Health Status Message Major Major Verifying credentials for device {0} at IP address {1} failed to complete. This may be do to network or database timeout errors. Please run rediscovery on this device to retry this function. Major Major Retrieving device identity for device {0} at IP address {1} failed to complete. This may be do to network or database timeout errors. Please run rediscovery on this device to retry this function.
PerleVIEW Generated Events Event Severity Health Status Message Minor Minor All administrator credentials failed verification for device {0} at IP address {1}. Please check your device credentials settings. Minor Minor All operators credentials failed verification for device {0} at IP address {1}. Please check your device credentials settings. Minor Minor All SSH key administrators credentials failed verification for device {0} at IP address {1}. Please check your device credential settings.
PerleVIEW Generated Events Event Severity Health Status Message Informational Normal SSH key operator login credentials successful for device {0} at IP address {1} Informational Normal SNMP read-only credentials passed verification for device {0} at IP address {1}. Informational Normal SNMP read/write credentials passed verification for device {0} at IP address {1}. Informational Normal SSH key administrator credentials passed verification for device {0} at IP address {1}.
PerleVIEW Generated non Device Events PerleVIEW Generated non Device Events Event Severity Health Status Message Critical Critical $(SWProductName) IIS web application failed to start. View the $(SWProductName) Audit log for more details. Critical Critical $(SWProductName) IIS Web application is now started. View the $(SWProductName) Audit log for more details. Critical Critical $(SWProductName) Event Manager Service failed to start. View the $(SWProductName) Audit log for more details.
Remap MCR-MGT Management Module Events Event Severity Health Status Message Informational Informational user {0} at IP address {1} logged off the $(SWProductName) Web server application. Informational Informational $(SWProductName) Event Manager Service started successfully. Informational Informational $(SWProductName) Task Manager Service started successfully. Running $(SWProductName) Version {0}.
C Device Scripts Appendix C Introduction When using the Device Scripting feature of PerleVIEW, you need to provide a script which will be deployed to each of the selected devices. This script will be composed of “CLI” (Command Line Interface) commands.
Introduction Parameter added:password-script Command:set user Parameter added:password-script Command:set server Parameter added: ssl-passphrase-script Command:set snmp v3-security readonly Parameter added:auth-password-script Command:set snmp v3-security readwrite Parameter added:privacy-password-script Command:add radius auth-host Parameter added:secret-script Command:add radius accounting-host Parameter added:secret-script
