Perle Systems 5500320-12 manual

PerleVIEW V1.2 PerleVIEW Device Management System User’s Guide Version 1.2 Part #5500320-12 May 2013[...]

PerleVIEW V1.2 Copyright S tatement This document must not be repro duced in any way whatsoever , either printed or electronicall y , without the consent of: Perle Systems Limi ted, 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 desig[...]

PerleVIEW V1.2 3 Chapter 1 Introduc tion ........................................................ 7 User Guide ...... .............................. .............................. .................. 7 PerleVIEW User Guide Layout.. ............................................................... 7 Typeface Conventions .............. .................[...]

4 T able of Contents Software Updates ........ ................................................. ............... ........... 29 File Transfers ........... ................................................. ................ .............. 30 Apply Settings ........... ................ .................................................. ........... 31 [...]

5 T able of Contents Chapter 8 Events ............................................................... 91 Events ................................................. ........................ ................ 91 Automatic Event Handling .................................. ...................... 91 Event Filter Settings .. ................................[...]

6 T able of Contents PerleVIEW Generated Even ts ............................. .................... 135 PerleVIEW Generated non D evice Events ......... .................... 139 Remap MCR-MGT Management Module Events ................... 140 Appendix C Device Scripts ............................................. 141 Introduction ....................[...]

7 Introduction Chapter 1 1 User Guide This user guide is provided to help you unde rstand th e management features of PerleVIEW . PerleVIEW is a Network Management System design ed to help you maintain, control, configure, update and track the health of devices on y our network. PerleVIEW can discover devices, automatically respond to events from t[...]

8 PerleVIEW Fea tures This utility can b e used to configure param ete rs used by PerleV iew if you are having problems connecting to PerleVIEW using your web brow ser . This utility allows you to stop or start th e PerleVIEW server , configure SQL connection parame ters, define W eb connection parame ters, modify the PerleVIEW Administrator (maste[...]

9 Prerequisite s Prerequisites PerleVIEW Server Requirement s One of these operating systems or a virtual system. z W indows Server 200 3 and 2003 R2 z W indows Server 200 8 and 2008 R2 z W indows Serv er 2012 z VMW are ESX, ESXI z Microsoft Hyper-V PerleVIEW will enable these serv ices on your PerleVIEW server . An y missing components will be act[...]

10 Prerequisite s z Chrome 8.x or higher z Safari 5 or high er[...]

11 Basic Concept s Chapter 2 2 PerleVIEW is a Device Management System designed to provide you with information and control of a large number of devices deployed throughout y our 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[...]

12 Guided T our of the PerleVIEW User Interface Guided T our of the PerleVIEW User Interface The first time you log into PerleVIEW you will see th e Getting Started W izard. This W izard will help you set up and co nfigure the parameters to be u sed with PerleVIEW . See Getting S tarted W izard for more information. Each time thereafter you connect[...]

13 Health S tatus 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 m anaged network. Y o u can drill down though submenus to focus in on a device, hardware or events. For each category , [...]

14 Licensing Information Licensing Information PerleVIEW is provided to you with a free, 30 day evaluation peri od. During the free trial period, you can use all the features of PerleV IEW . The current status of your fr ee trial will be displaye d to the right of the Device health box on the title bar . Once the 30 day trial perio d expires, you a[...]

15 Online Help Online Help Online help is provided in PerleVIEW . Y ou can click on the ( ) icon to get page level help . Y ou can also get help from the PerleVIEW User ’ s Guide online by selecting Help -> Help Content s .[...]

16 Getting S t arted Chapter 3 3 Inst alling PerleVIEW on your Server The PerleVIEW Setup Wi zard installs PerleVIEW on your Windows Server and helps you setup the operating parameters to be used with PerleVIEW . To B e g i n Double-cli ck on the PerleVIEW -setup.exe to launch the installation of PerleVIEW . This must be executed on the server you [...]

17 Installing PerleVIEW on yo ur Server T hen click on the Install button to continue . Next, read the Privacy Poli cy and again, check the I Agree checkbox , then click on the Install button to continue. By default, P erleVIEW will be installed in t his destination folder C:Program Files (x86)Per le Systems LimitedPerleVIEW . T o change the d e[...]

18 Installing PerleVIEW on yo ur Server PerleVIEW is installing.[...]

19 Installing PerleVIEW on yo ur Server Y ou must accept the licensing agreement to inst all Microsoft SQL Serv er . Read the license agreement, then select the checkbo x to indicate that you agree to th e terms of the license agreement.[...]

20 Installing PerleVIEW on yo ur Server SQL Connection Parameters If this is a new SQL connection, PerleVIEW will onl y require yo u to configure the SQL Server Name and the Database User . If you are using a existing SQL Server , th en the following sc reen will appear . Click on the Yes button after you have completed the fields. SQL Server The S[...]

21 Installing PerleVIEW on yo ur Server At this time, the installation program will attempt to establish a connection to the SQL Server usin g the parameters entered on this screen. If this operation does not succeed, an error message will be displayed and the i nstall will return to this screen to allow the you to modify the parameters and try aga[...]

22 Installing PerleVIEW on yo ur Server Next you will be asked to setup the parameters that PerleVIEW will use wh en communicating with a W eb Client (browser). This incl udes enabling/disabling HTTP/H TTPS, 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[...]

23 Installing PerleVIEW on yo ur Server After entering the parameters, PerleVIEW w ill now create the PerleVIEW website on IIS Click the Ok button proceed. PerleVIEW has successfully b een installed on you r server . Click the Finish button.[...]

24 Logging into PerleVIEW Logging into PerleVIEW Login Y o u can connect to PerleVIEW using any of the supported W eb browsers. See PerleVIEW W eb Client Requirements for list of supported W eb Browsers. 1. Open your web browser and type in the IP addr ess of the server where you installed PerleVIEW followed by a colon (:) and the port number to co[...]

25 Getting S tarted Wizard Getting S tarted Wizard The first time you connect to PerleVIEW , you will see the Getting Started W izard screen. The Getting Started wizard will guide you through the initial setup of discovering devices, setting up user security , checking your Internet connection, checki ng for software updates and setting the paramet[...]

26 Getting S tarted Wizard Discovering Devices This part of the wizard will guide you throu gh 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. T o see[...]

27 Getting S tarted Wizard User Security In order to log in to PerleVIEW , you must be a valid W indows 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 PerleVIE W . This gives you an extra level of control as to wh[...]

28 Getting S tarted Wizard Internet Connection On some networks, access to the Internet is provid ed via a proxy server . Pe rleVIEW needs to reach the Internet for some of its functions to work such as sending T weets and lookin g for software updates. If a proxy server is being used on you r network, you should en ter its access information here.[...]

29 Getting S tarted Wizard Sof tware Updates By default, PerleVIEW wil l notify the administrator of any new updates for itself or for any firmware for devices it manages. PerleVIEW wil l update th e notification bar with a download pending message when an update is available. Pe rleVIEW can also be configured to automa tically download software up[...]

30 Getting S tarted Wizard File T ransfers PerleVIEW uses file transfers for a number of f unctions. This includes, but is not limited to downloading firmware u pdates, downloading/uploading d evice configuration, deploying scripts (only if file transfer mode is used). PerleVIEW can use HTTP (or HTTPS) to transfer files or alternatively it can use [...]

31 Getting S tarted Wizard Apply Settings Click on the Finish button to continue. The Default Discovery T ask will now start to collect information from your network. For mo re information on this task see PerleVIEW Default T asks . TFTP Server By default, PerleVIEW will install its TFTP server on port 69. PerleVIEW will use its TFTP server to tran[...]

32 W orking with Device Operations Chapter 4 4 Discovering Devices Menu Selection: Discovering Devices Required Authorization: PerleVIEW Administrator PerleVIEW needs to add devices to its internal databa se in order to provide statuses on these devices. The way that PerleVIEW adds devices to it’ s database is by running a device disco very task.[...]

33 Discovering Devices is found, it will be saved as the working credenti al for that device. If possible group devices with similar credentials into the same device discovery task instance. Launching Discovering Devices D evices ->Discovering Devices Working with Discovering Devices T asks PerleVIEW provides the following discovery task fu ncti[...]

34 Discovering Devices Add a Device Discovery T ask Each device discovery task instance can have unique operating parame ters. Add Click the Add button to create a new Device Discovery T ask instance. Ta s k n a m e Use a meaningful name to uniquely id entify this device discovery task instance. Schedule Manual - do not automatically run this task.[...]

35 Discovering Devices Settings for All Discovery T asks Click on the Settin gs for All Disc overy T a sks button to view and configure global parameters which apply to all discovery task instances. For more information see Configure Device Settings . Support ICMP ping messages If all devices in your network are reachable by sending an ICMP message[...]

36 Discovering Devices Show All Devices Click on the Show All De vices button to shows all of the devices which are present in the PerleVIEW device database. See Groups V iews for more information. T ask Det ails/Last Run Results This panel displays the task details of the selected discovery task instance. It shows the Last Run Results for the curr[...]

37 Discovering Devices Vie w L o g The View Log but ton will display PerleVIEW related messages for this task . T o see the full list of PerleVIEW generated messages see Appendix B, "Event Informatio n" . T arget Result s The T arget Result s button will display the results from the tar get devices.[...]

38 Device Scripting Device Scripting Menu Selection: Device scripting Minimum Required Authorization: Device Operator PerleVIEW allows you to create Devi ce 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. Y ou can find these logs under “ T a[...]

39 Device Scripting Each deploy script task instance can have unique operati ng parameters. Add Click the Add button to create a new Deploy Script task instance. Ta s k N a m e T argets Schedule Script Insert Script from Library Reboot target device after executing script Operate in file transfer mode Apply Enter a name to uniquely identify this de[...]

40 Device Scripting Manage Script Library These scripts are used by the “Deploy Script” tasks. Click on the Manage Script Library button t o add new script files to the script library , delete existing script files or import existing scrip t files from a dif f erent location. Import Add Delete Import a file from another lo cation into the scrip[...]

41 Backup/Restore Device List Backup/Restore Device List Menu Selection: Backup/Restore Device List Minimum Run Authorization: PerleVIEW Administrator If you ever lose the conten ts of the PerleVIEW datab ase, you can use this backup feature to restore the lists of devices to the PerleVIEW database . The restore device list feature would l aunch a [...]

42 Backup/Restore Device List Y ou can either select to run the Restore immediately or have it run at a later ti me by selecting the “ Run at ” option. Click the Apply button to create the discovery task instance for this restore operation.[...]

43 Backup/Restore Devi ce Configuration Backup/Restore Device Configuration Menu Selection: Backup/Restore Device Configuration Minimum Run Authorization: PerleVIEW Administrator PerleVIEW provides the ability to backup and restore in dividual device configurations to the PerleVIEW repository . Each device’ s configuration will be saved to a sepa[...]

44 Backup/Restore Devi ce Configuration Run Now T o run a existing Backup Device Configuration task im mediately , select the ta sk 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. Ta s k n a m e T argets Schedule Working with Restore Device Configuration PerleVI[...]

45 Backup/Restore Devi ce Configuration Run Now T o run an existin g 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 Devi ce Configuration task instance. Ta s k n a m e T argets Schedule Reboot Enter a name to uniquely identify[...]

46 Backup/Restore Devi ce Configuration T ask Det ails This window displays the current task details of the selected Backup De vice Configuration task instance. T o delete device configu ration from the PerleVIEW database, click on “Device with Saved Configuration” optio n. Devices with saved configuration Select the device with the save d conf[...]

47 Configure Device Setting s Configure Device Settings Menu Selection: Device Settings Minimum Run Authorization: PerleVIEW Administrator This function allows you to chang e a number of device related, global parameters. These include settings for Device Discovery tasks, Device credenti als, Polling timers and Network protocol settings. Launching [...]

Exclude the following IP addresses and ranges from device discover . Automatically discover device when a SNMP trap is received from that device. At time of discovery , set PerleVIEW as a trap host for the discovered device. 48 Configure Device Setting s Credentials These credentials are the global se ttings used when PerleVIEW attemp ts to discove[...]

49 Configure Device Setting s SNMP Credentials As each device is discovered, the credentials configur ed 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 Read/Write SNMP Communities Login Credentials As each device is discovered, the credentials list ed wil[...]

50 Configure Device Setting s SSH Keys As each device is discovered, the credentials list ed will be tried on it until one set is found to work . This set will be saved as the wo rking credentials for that device. Administrator/ Operator Private Key Polling Polling parameters allow you to customize how oft en a device or hardware within PerleVIEW?[...]

HTTP/HTTPS Te l n e t , S S H Connection Timeout SNMP , ICMP and Perle Discovery pr otocol Timeout Retries 51 Custom Device Groups Protocol Settings Custom Device Group s For more information on Custom Device Groups see Creat ing Custom V iews by Groups . Specify the maximum time to wait when establishing various typ es of connections between Perle[...]

52 Group s of Devices, Hardware, and Event s Chapter 5 5 Group s V iews Group V iews allows you to quickly and easily see the Devices, Hardware and Events found in yo ur managed network. Y ou can quickly drill down thoug h submenus to get details about these devices, hardware or events. From these submenus you can manage and control most features o[...]

53 Groups V iews Working with Device V iews T o V iew All Devices select Devices -> All Devices from the left navigation panel. Devices ->All Devices This view shows all of the devices which ar e 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 healt[...]

Details Delete Edit 54 Groups V iews Protocols (Device) Click on this button to change the parameters related to proto col timeouts and retries for the selected device or devices. Protocol Settings Use the Details button to bring up a table with various informati on and actions that can be performed on th e selected device. The same can be achieved[...]

55 Groups V iews Credentials (Device/s) Select the Credential butt on to delete or override credentials for this device or devices. Timeout Specify how long to wait for a reply from the device after sending either a UDP message on port 33816, an SN MP message, a ping message or a Perle Discovery request. This fiel d should co ntain the value in sec[...]

56 Groups V iews Credentials (Device/s) T o access all of PerleVIEW’ s features at least one Read or Read/W rite 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 commu nity if you do not want to attempt SNMP R[...]

57 Groups V iews This panel displays the device details. This is the same view you would get if you were to select a specific device from the Devices section on the left-hand navigati on panel or double click on the device from the “All Device” view . Device -> Det ails Admin Login Select the check box to enter in you r own Admin Login crede[...]

58 Groups V iews The information in this table is collected from the PerleVIEW da tabase. When the table is being displayed, the information is updated every minute. Not all columns are applicab le to all hardware. If not applicab le, the entry will be left blank. For information on Redi scover this device see Rediscover devices . Health Details Th[...]

59 Groups V iews Device Det ails -> Hard ware 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” butt on on the top, right hand of the table. Column Details Ty p e This is the type of hardware inserted in this chassis slot. Health This is the curr[...]

60 Groups V iews Device Det ails -> Hardware -> Edit Select the hardware you want to edit, then click the Edit button . Edit Hardware Preferr ed Name The name the you typed in the Pr eferred field for this hardware. Use Preferr ed Name Check this box to use the Preferred Name from the above Name field. This would override a name retrieved fro[...]

61 Groups V iews Event s 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 wil l be able to view the events that are critical and deal with thos e events first. Click on the Events tab to see the lis t of events assoc[...]

62 Groups V iews Click on any of the buttons below to ch ange the details for a selected event. Comment Mark as acknowledged Mark as unacknowledged Delete Device Protocols Y o u can enter specific values to be used during communication wit h this device. These values will overwrite the values saved for this device during discovery . A blank value w[...]

63 Groups V iews Device Credentials Configure SNMP credentials , Login cr edentials and SSH keys to be associated with the selected device or devices. Credential inform a ti on entered her e will be stored in the database for the selected device/s. These will be the creden tials that PerleVIEW will attempt to use the next time it needs to access th[...]

64 Groups V iews Device Det ails -> Cred entials T o access all of PerleVIEW’ s features at leas t one Read or Read/W rite community must be configured within PerleVIEW to match a SN MP community config ured on the target device. Attempted Credentials SNMP Read The check mark indicates that a SNMP Read community was found for this device durin[...]

65 Groups V iews Device Det ails T ools The Device details “T ools” tab allows you perfor m actions directly on th e device. These include pinging the device to see if it is still reachable or to access the device via a W eb or T erminal interface. Even though you are accessing the device, PerleVIEW is still involved in the connection. If login[...]

66 Groups V iews V iew Devices by Subnet s V iew Devices by subnets group s your devices based on the subnet they reside on. Y ou can choose to view all devices on a particular subn et or use the subnet information to drill down to a specific device on that subnet. T o view device by subn ets select Device s -> Subnets from the left navigation p[...]

67 Groups V iews Limited Functionality Devices that show up under th e “Limited Functionality” grouping are devi ces 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 lates[...]

68 Groups V iews Device -> Not Configured Select the device you are interested in working with from the list, then click one of the action buttons. T o work with this device, cli ck on the Det ails button , Edit button or Delete button . These are the details of this unc onfigured device. Click on the Assign IP Address Butt on to assign an IP ad[...]

69 Groups V iews 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. T o work with thi s device, click on the Det ails button , Edit button or Delete button .[...]

70 Groups V iews T o update this device with the latest firmware see Check for Firmware Update and Deploying Firmware . W orking with Hardware Vi ews PerleVIEW supplies you with four pre-defined Group V iews under the submenu Hardware. These groups represent distinct hardw are in your system. They are as follows: z All Hardware - V iew all discover[...]

71 Groups V iews T o view All Hardware select Hardware -> All Hardware from the left navigation panel. Hardware->All Hardware All Hardware -> Edit For this example select th e chassis (device named tmc- mcr-mgt), then click the Edit button . To e d i t multiple media converters, select the boxes beside th e fields to be edited. The text en[...]

72 Groups V iews Hardware->Management Modules T o view all Media Converters select Hardware -> Me dia Converters fro m the left navigati on panel. Hardware->Media Converters T o view all Port select Hardware ->Ports from the left navigation panel. Hardware->Port s See Groups V iews for more information. Working with Event Views Perle[...]

73 Groups V iews Managed devices must be configured to send events (traps) to Pe rleVIEW . After PerleVIEW receives the event, it applies any configured filters to the event, it then pe rforms any actions configured under Automatic event handling and lastly the event is ad ded to the PerleVIEW database for later viewing. For more information on Eve[...]

74 Hardware Activities Chapter 6 6 Collecting S t atistics 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 modu le ports. Launch[...]

75 Collecting S tatistics T o run an existing statistics collect ion task instance immediately , sel ect the task from the list, then click on the Run Now button. Add a St atistics Collection T ask Each Statistics Collection task instance can have unique operating parameters. Add T o Add a new Statistics Colle c tion instance, click on the Add butt[...]

76 Collecting S tatistics Edit a St atistics Collection T ask Once the task has been run, only the S tatistics Coll ection task instance name can be edited. T o change target devices and parameters, you must creat e a new statistics collection task instance. Input Frames Number of good frames receive d in the following categories; z Unicast frames [...]

77 Collecting S tatistics Edit T o Edit a Statistics Collecti on task instance, click on the Edit button . T ask Det ails This panel displays the current task details of this task instance as well as the Last Run Results. See W orking with Device V iews for more details on logs, details and resu lts.[...]

78 Check for Firmware Update Check for Firmware Up date Menu Selection: Check for Firmware Up dates Required Authorization: PerleVIEW Administrator PerleVIEW can check the Perle W eb site for new firm ware updates for the devices that it manages. There are two options with regards to the action take n by PerleVIEW if an u pdate is available. The fi[...]

Internet Proxy 79 Check for Firmware Update Check Now Result s Internet Proxy Download Now Downlo ad Now indicates th at there is a download pending. Hi ghlight the entry and then select the Download Now button . The firmware will be transferred from the Perle W eb si te to the PerleVIEW repository . Deploy Update Deploy Update will create a new Ad[...]

80 Check for Firmware Update Firmware Deployment T asks Firmware Deployment Ta s k s 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. T o deploy firmware yo u need to create firmware deployment tasks instances. See Deploying Firmware .[...]

81 Deploying Firmware Deploying Firmware Menu Selection: Deploying Firmware Required Authorization: Devi ce Administrator PerleVIEW manages it’ s firmware within the PerleV IEW’ s repository . Firmware images are uploaded into the repository . Y ou can create firmware deploym ent tasks instances to dow nload the firmware to target devices. Laun[...]

82 Deploying Firmware Add a Deploying Firmware T ask T o 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 Pe rleVIEW database. Y o u will be prompted to accept the licensing agreement in order to continue. Speci fy your country . If[...]

83 Custom Hardware Groups Custom Hardware Group s For more information on Custom Hardware Groups see Appendix A, Custom V iews by Groups .[...]

84 T asks Chapter 7 7 T ask PerleVIEW provides you with the ab ility to create task instances fo r common functions you need to perform on your devices. By creating tasks this gi ves you the ability to control and schedule when certain functions w ill be performed (exampl e: discovering devices or deployi ng software). PerleVIEW Common T asks z Dis[...]

85 T asks T asks Menu Selection: Ta s k s Minimum Required Authorization: Depending on the task T asks 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 yo ur own instance of task using t his menu. As an example, you ma[...]

86 T asks Run Now T o run a task immediately , select a task from the task list, then click on the Run Now button. That task will execute immediately usin g the parameters configured for th at task instance. Once run, the task will resume its normal schedule. Add T o create a new task, click on the Add butto n, then select a task from the drop down[...]

87 T ask Results T ask Result s Menu Selection: T ask 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 T ask Results T ask -> T ask Result s Working with T ask Result s PerleVIEW provides the following actions which can be performed[...]

88 T ask Results T o view the Log or T arget Results see W orking with Device V iews End Time Shows the time when this task instance finished runnin g. St a r t T i m e Shows the time when this task instance started running. User This is the user that created this task.[...]

89 T ask Results Cleanup T ask Result s Cleanup Menu Selection: T ask 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 periodical ly in an attempt to maintain th[...]

90 T ask Results Cleanup Click the Apply button to save your changes. T o run a clean up task immediately , click on the Run Now button. Run Now Results This subsection defines the criteria for removing task results associated with manually run tasks (as opposed to schedu led tasks). Y ou can set the maximum number of task results t o keep for all [...]

91 Event s Chapter 8 8 Event s 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 ev ent which is generated by PerleVIEW itself (for example: PerleVIEW detect s that a device is no longer reach able). After PerleVIEW receives the event, it applies any config[...]

92 Automatic Event Handling Working with Automatic Event Handling PerleVIEW provides the following autom atic event handling task function s. 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 E[...]

Events Sources 93 Automatic Event Handling Actions Select the action that you want PerleVIEW to perform if it receives this event. Y ou can select multiple actions. The following actions are available: z Send an E-mail. See Send E-mail . z Send an SMS text message (via E-mail). See Send SMS T ext Message (via E-mail) . z Send a T weet on T witter .[...]

94 Automatic Event Handling After completin g the fiel ds, you can click on the Te s t b u t t o n to test the connection to the E-Mail server . PerleVIEW will send a test message of “PerleVIEW event actio n handler test E-m ail message”. If the test E-Mail is received at the destin ation, the test is successf ul. If not successful, then correc[...]

95 Automatic Event Handling After completing the field s, click on the T est button to test the SMS conn ection. PerleVIEW will send a test message of “PerleVIEW event action ha ndler test SMS text message”. If the SMS is received at the destination, the test is successful. If not successful, then correct the parameters in error and retry the t[...]

96 Automatic Event Handling After completing the field s, click on the T est button to have PerleVIEW send a test tweet using the authorized user ’ s T witte r account. PerleVIEW will send a test message of “PerleVIEW event action handler test T witter message”. If the tweet is issu ed, the test is success ful . If not successful, then correc[...]

97 Automatic Event Handling After completing the field s, click on the T est button to have PerleVIEW send a test trap to the trap receiver . PerleVIEW will send a test message of “T rap being sent indicates that a PerleVIEW user has issued a test trap in order to verify his event handler trap configuration”. If the trap is received by the trap[...]

98 Automatic Event Handling[...]

99 Event Filter Setting s 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 , W a rning, Normal and Informational) sent from devices as well as ones generated by the PerleVIEW application. This [...]

100 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 manual ly at any time or periodically on a configured schedule. By scheduling a regular clean[...]

101 Administration Chapter 9 9 Administration PerleVIEW administration tasks enables you to se t up PerleVIEW global configuratio n parameters, user account settings, view or exp ort the Audit logs and configure when softw are updates to PerleVIEW will be performed. Working with Administration Functions The Administration drop down men u allows for[...]

102 PerleVIEW Server Setting s Working with Server Sett ings PerleVIEW provides the following options fo r Server Settings. z Force Secure Conn ections to devices (HTTPS/SSH) z V alidate CA certificates z Configure W eb T erminal TCP Listening ports PerleVIEW Server Setting Force Secur e Connections to device (HTTPS/SSH) Select the Force Secure Con[...]

103 PerleVIEW User Accounts PerleVIEW User Account s Menu Selection: PerleVIEW User Accounts Minimum Required Authorization: PerleVIEW Administrator PerleVIEW uses a concept of authentication fo r logging users into PerleVIEW and a concept of authorization for giving users and groups access righ ts to target devices. PerleVIEW uses W indows authent[...]

Rights Device V iew 104 PerleVIEW User Accounts PerleVIEW always requires one PerleVIEW admini strato r in order to operat e. This “master” administrator user is the user you configu red du ring your installation of PerleVIEW. The PerleVIEW Master administrator cannot be deleted through the PerleVIEW web interface, however the name, domain and [...]

105 PerleVIEW User Accounts PerleVIEW User Account s (Add) T o Add a new User to the PerleVIEW database, click on the Add Us er button . T o 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 Domain Full Nam e PerleVIEW Administrator Inherit device access permissions[...]

106 PerleVIEW User Accounts Click the Add button to Add device access rules for this user . Y ou can add multiple “device access” rules for the same user . Add Device Access Rule (User) Add User Group Click the Apply button to save your changes. Name Domain Description PerleVIEW Administrator Click the Add button to add device access rules for [...]

Access Level Devices 107 PerleVIEW User Accounts Add Device Access Rule (Group) User Account s (Edit) Edit User The “W in dow Group Membership” area shows groups t hat this user belongs to. These groups must be configured on the W indows Server User A ccounts as well as on the PerleVIEW database. Select the device access level which will be ass[...]

108 PerleVIEW User Accounts The “Device access” area shows the device access th at this user has. The device access can be obtained in two ways. First the us er can inherit the device access by belonging to a group and any access for that group will be inhe rited. Secondly , device access can be added for a user by selecting the Add button and [...]

109 PerleVIEW File Tr a nsfer Settings PerleVIEW File T ransfer Settings Menu Selection: File Transfer Settings Minimum Required Authorization: PerleVIEW Administrator PerleVIEW uses file transfers for a number of f unctions. This includes but is not limited to downloading firmware u pdates, downloading/uploading d evice configuration, deploying sc[...]

Repository Location TFTP Server Win do w s Network Credentials 11 0 PerleVIEW File Tr a nsfer Settings The Repository location is the locati on on your PerleV IEW server where your downloaded software and confi guration files will be stored. If you choose to specify your own software location to store your updates the server path needs to be in Mic[...]

111 PerleVIEW Updates PerleVIEW Updates Menu Selection: PerleVIEW Updates Required Authorization: PerleVIEW Administrator PerleVIEW can be set to automati cal ly check for firmware updates to itself. PerleVIEW can either notify the administrator that updates are avail able or automatically download the updates to the PerleVIEW server . After the so[...]

11 2 PerleVIEW Updates Check Now T o 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 save d to the PerleVIEW server . Internet Proxy Button On some networks, access to[...]

11 3 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 th e web application. The Audit Log record s all internal PerleV iew application messages. It al lows you to monitor wh[...]

11 4 PerleVIEW Audit Trail Log Source T ype 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. V alid results include Successful, Failure, Cancelled, St opped or Pending. User This is the name of the user that perf ormed the[...]

11 5 Internet Proxy Server Internet Proxy Server Menu Selection: Internet Proxy S erver Minimum Required Authorization: PerleVIEW Administrator On some networks, access to the Internet is provid ed via a proxy server . Pe rleVIEW needs to reach the Internet for some of its functions to work such as sending T weets, E-mails and looking for software [...]

11 6 E-mail Account Settings E-mail Account Settings Menu Selection: E-mail Account Setting s Minimum Required Authorization: PerleVIEW Administrator PerleVIEW has the capabilities of notifying you vi a E-mai l of events occurring on your network. These events could be ge nerated by devices or by PerleVIEW when it detects a status change (i.e. loss[...]

11 7 E-mail Account Settings Password Specify a password for authentication. Confirm password T ype the password again to confirm. Domain (optional ) Specify a domain name if the E-mail server requires it.[...]

11 8 T witter Users T witter Users Menu Selection: T witter Users Minimum Required Authorization: PerleVIEW Administrator PerleVIEW has the capabilities of notifying you via tweets on yo ur T witter account of events occurring on your target devices or on PerleVIEW its elf. T o setup for tweets, you need to follow these steps. 1. Have an existing T[...]

11 9 T witter Users Enter your T witter useri d and password, then click the Authorize app button. Success Y o u should receive a message indicat ing that PerleVIEW is now authorized to po st tweets on behalf for this user .[...]

120 PerleVIEW Admin Utility Chapter 10 10 PerleVIEW Admin Utility This utility can b e used to configure paramete rs used by PerleV iew if you are having problems connecting to PerleVIEW u sing your web browser . An example would be th e configuration of the HTTP port which PerleVIEW listens on for client connections. This utility also allows you t[...]

121 SQL Connection This screen allows you to stop or start the Pe rleVIEW server . PerleVIEW S tartup PerleVIEW Shutdown SQL Connection PerleVIEW uses these parameters to connect to your SQL Server . The server can be eithe r locally (on the same server) or remote to the PerleVIEW server . Configure the following param eters: Start up a l l PerleVI[...]

122 SQL Connection Connect to database If you are using W indo ws Authenticati on Mode, type in the Windows user name (FQDN if required) as defi ned within your W indows Server environment. If you selected SQL Au thentication mode you will need to provide the user name you configured for this user in the SQL server configuration. If the SQL server [...]

123 Web Connection W eb Connection PerleVIEW uses these parameters fo r connections from W eb browsers. Enable HTTPS When checked, web clients will be allo wed to connect to Pe rleVIEW using the HTTPS protocol. Y ou can specify th e port number that PerleVIEW will listen on for this connectio n. Default port: 60000 Va l u e s : 1-65535 Enable HTTP [...]

124 PV Admin (PerleVIEW Administrator) PV A d m i n (PerleVIEW Administrator) Configure the following param eters: Ty p e Name Domain Full Name Master Administrator . Enter a Master Administrator Name. T yp e in a domain name if required by y our network. T yp e in Administrators Full Nam e (optional).[...]

125 PerleView Software Update PerleV iew Sof tware Up date This utility is used to deploy softw are updates for PerleVIEW . Ob taining the software and placi ng it on the server can be performed manually or by Pe rleVIEW . PerleVIEW can be set to automatically check for firmware updates to itself . See PerleVIEW Updates to set the parameters for au[...]

126 PerleView Software Update Y o u will be prompted on whether you want to remove the PerleVIEW database. Click the Y es button to remove the PerleVIEW database. Cli ck the No button to keep the database and continue the uninstall. PerleV IEW will now be uninstall from this server .[...]

PerleVIEW V1.0 127 Custom V iews by Group s Appendix A A Creating Custom V iews by Group s Menu Selection: Custom Device/Hardware/ Events Groups Minimum Run Authorization: Every one PerleVIEW has a very powerful grouping feature. It allows you to create cu stom views of devices, hardware and events. By creating group vi ews you can clearly see the [...]

128 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 “Bosto n” 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 wit[...]

129 Creating Custom Views by Groups Add Device Group 1. T yp e in the name of the group (Boston_Servers). 2. Select the checkbox “Share with all PerleVIEW users”, if you want to share th is 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 t[...]

130 Creating Custom Views by Groups 8. Y o ur Custom Device Group will now be displayed within the left navig ation panel under Group V iews (Devices). Group View of Boston_Servers This view has the same properties as any other device view . See Groups V iews . for more details. Example 2 Y o u can create a Custom Hardware Group to view selected SF[...]

131 Creating Custom Views by Groups Add Hardware Group 1. T ype in the name of the gro up 2. Select the checkbox “Share with all PerleVIEW users”, if you want to share th is 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. Clic[...]

132 Creating Custom Views by Groups Example 3 In this example you want to cr eate a Custom Event Group to view all unacknowledged events with either a Critical or a Major health status. Y o ur criteria is: z all unacknowledged events z health status of Critical or Major Custom Group s First you need to add a Group for Events by selecting Event s fr[...]

133 Creating Custom Views by Groups z Select “Severity” from the first drop down box . z Select “is” for the operator . z Select “Critical” for th e 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 . Y o u should now have tw[...]

134 Creating Custom Views by Groups View Group of Una cknowledged Event s This view has the same properties as any other event view . See Grou ps V iews for more informati on. This view can be customized by clicking on the “Columns” but ton on the top, right hand of the table. Click on the magnify glass to app ly filters to this view[...]

PerleVIEW V1.0 135 Event Information Appendix B B PerleVIEW Generated Event s Event Severity Healt h Statu s 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) functi ons. Please upgrade your Device firmware to the late[...]

Event Information 136 PerleVIEW Generated Events Major Major V erifyi ng credentials for de vice {0} at IP address {1} failed to complete. This may be do to network or datab ase timeout errors. Please ru n rediscovery on this device to retry this fun ction. Major Major Retrieving device identity for de vice {0} at IP address {1} failed to complete.[...]

Event Information 137 PerleVIEW Generated Events 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 faile d verification for device {0} at IP address {1}. Please check your device credentials settings. Minor Minor All SS[...]

Event Information 138 PerleVIEW Generated Events Informational No rmal SSH key op erator lo gin credentials successful for device {0} at IP address {1} Informational No rmal SNMP read-only credentials passed verification for d evice {0} at IP address {1}. Informational No rmal SNMP read/write credential s passed verif ication for device {0} at IP a[...]

Event Information 139 PerleVIEW Generated non Device Events PerleVIEW Generated non Device Event s Event Severity Healt h Statu s Message Critical Critical $(SWPr oductName) IIS web app lication failed to start. V iew the $(SWProductName) Audit log for more details. Critical Critical $(SWProductNam e) IIS W eb appl ication is now started. V iew the[...]

Event Information 140 Remap MCR-MG T Management Modu le Events Remap MCR-MG T Manage ment Module Event s System Level Fault Critical Module Level Fault Major Persistent Error Minor One T i me Error Wa r n i n g Significant Error Wa r n i n g Normal Normal Informational I nformational user {0} at IP address {1} logged off the $(SWProductName) W eb s[...]

141 Device Script s Appendix C 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 sc ript will be composed of “CLI” (Command Line Interface) commands. PerleVIEW provides a “slot macro” that will enab le you to replace any CL I comman[...]

Device Scripts 142 Introduction Parameter added:password-script <password> Command:set user Parameter added:password-script <password> Command:set server Parameter added: ssl-passphrase-script<password> Command:set snmp v3-security readonly Parameter added:auth-passwo rd-script <password> Command:set snmp v3- security readwr[...]