Cairs Traffic and Alarms Documentation

Transcription

1 Cairs Traffic and Alarms Documentation Release Brett Burbidge Jun 27, 2017

2

3 Contents 1 Topics Installation Admin Guide Indices and tables 47 i

4 ii

5 Attention: Traffic & Alarms, formerly known as UTA or CAT, documentation is avaliable here. CTA is short for Cairs Traffic & Alarms. For more information about Cairs please go to.. _a link: Contents 1

6 2 Contents

7 CHAPTER 1 Topics Installation Installing UTA on Windows Server (2008 R2/2012) Authors: Brett Burbidge Install IIS Open Server Manager Add Web Server IIS Roll Add the following Roll Services 3

8 4 Chapter 1. Topics

9 Click Install Restart the server Run Amie (Pronounced Amy) Note: We are currently working on this topic. More to come soon! Verify the following settings by following the steps below 1. Open IIS on the web server 2. Verify: In Application Pools you should have a UTA app pool 3. Verify: In the Default Web Site you should see a UTA directory with the UTA App Pool Click the UTA directory then Basic Settings.... To verify app pool If both of these check out, continue, if not please retrace the steps above. IIS Settings - Authentication Open IIS and select the UTA folder under the Default Web Site There are 3 different Authentication options. Forms - Uses a username and password This is the easiest to configure but not JITC certified. IIS Settings ASP.NET Impersonation: Disabled Basic: Disabled Digest: Disabled Anonymous: Enabled Forms: Enabled Windows: Disabled App Settings Authenticaiton_Mode: Forms Windows Uses the users domain credentials to login This is easy to configure and also JITC certified. Note: Only users on the current domain will be able to access UTA Installation 5

10 IIS Settings ASP.NET Impersonation: Disabled Basic: Disabled Digest: Disabled Anonymous: Disabled Forms: Disabled Windows: Enabled App Settings Authenticaiton_Mode: Windows Certificate Uses the users CAC Certificate to login Note: This is more complicated to configure and requires that the server has a HTTPS certificate and a DNS entry. This is JITC certified. Any users in or out of the domain will be able to access UTA. The UTA url might have to be whitelisted. IIS Settings ASP.NET Impersonation: Disabled Basic: Disabled Digest: Disabled Anonymous: Enabled Windows: Disabled Forms: Disabled App Settings Authenticaiton_Mode: Certificate Create Database Open SQL Management Studio Right Click on Databases New Database (Name it traffic and select a location), click OK Add Database User to Traffic Database. Note: An existing CairsUser can be used or a new one created Under Security, Logins, Create or select a User Go to User Mapping page and select Traffic, then select db_owner Click Ok to close the dialog box 6 Chapter 1. Topics

11 The Cairs Connection UTA queries the CallRecord table in the Cairs database for some reports. The following steps go through how to configure the connection. Note: This is a one-way connection. UTA only reads from the CallRecord table for reports, it does not write any data to Cairs. Add the Cairs database connection string in two places 1. In IIS Settings (a) Open IIS, select Default Web Site, Select UTA, double click on Application Settings. (b) Edit CAIRS_CONNECTIONSTRING set Value to the cairs database connection string. image of iis settings... Installing UTA on Windows Server 2012 R2 Authors: Brett Burbidge Install IIS Open Server Manager Go to Local Server Click on Manage (top right corner) Click Add Roles and Features 1.1. Installation 7

12 On the Add Roles and Features Wizard Click Next Select Role-based or Feature-based installation Click Next 8 Chapter 1. Topics

13 Select a server from the server pool (this server will already be selected in the Server Pool list) Click Next 1.1. Installation 9

14 Find Web Server & check the box Click Add Features in the dialog window Click Next 10 Chapter 1. Topics

15 Under.NET Framework 4.5 Check ASP.NET 4.5 if available Click Next 1.1. Installation 11

16 Click Next again Select the following Roles Services (Check each role listed below) Common HTTP Features * Default Document * Directory Browsing * HTTP Errors * Static Content Health and Diagnostics * HTTP Logging Performance * Static Content Compression Security * Request Filtering * Windows Authentication Management Tools * IIS Management Console Click Next 12 Chapter 1. Topics

17 Click Install 1.1. Installation 13

18 Verify IIS installation Click the windows start button (lower left corner) Type the letters iis Select the top option Internet Information Services (IIS) Manager Warning: If IIS Manager does now show up in the search; restart the server and then retrace the steps above. 14 Chapter 1. Topics

19 Expand the top node (This will be the server name) Click No if asked to stay connected to the latest Web Platform Components... (check Do not show this message, if so inclinded) Ensure the top node is selected and double click on the Request Filtering icon Ensure the list is emtpy 1.1. Installation 15

20 Traffic Install The following steps will guide you through the Traffic & Alarms installation. Copy Install Files Important: The applicaiton will run where the files are placed. If you place the files in C:UsersBobUTA they will run from that location. The files are not copied to different locations during the installation. Typically enterprise server installations have an E or D drive where applications run from. References to X:indicate the drive you choose to run. Copy the UTA#.#.#.#.zip file to X:UTA folder Extract the.zip file in X:UTA The result will look like the following Verify the following settings by following the steps below 1. Open IIS on the web server 2. Verify: In Application Pools you should have a UTA app pool 3. Verify: In the Default Web Site you should see a UTA directory with the UTA App Pool Click the UTA directory then click the Basic Settings action on the right pane to verify installation. If both of these check out, continue, if not please retrace the steps above. 16 Chapter 1. Topics

21 IIS Settings - Authentication Open IIS and select the UTA folder under the Default Web Site There are 3 different Authentication options. Forms - Uses a username and password This is the easiest to configure but NOT JITC certified. IIS Settings ASP.NET Impersonation: Disabled Basic: Disabled Digest: Disabled Anonymous: Enabled Forms: Enabled Windows: Disabled App Settings Authenticaiton_Mode: Forms Windows Uses the users domain credentials to login This is easy to configure and also JITC certified. Note: Only users on the current domain will be able to access UTA. IIS Settings ASP.NET Impersonation: Disabled Basic: Disabled Digest: Disabled Anonymous: Disabled Forms: Disabled Windows: Enabled App Settings Authenticaiton_Mode: Windows Certificate Uses the users CAC Certificate to login Note: This is more complicated to configure and requires that the server has a HTTPS certificate from an certified authority. This is JITC certified. Any users in or out of the domain will be able to access UTA. The UTA machine name or DSN entry might have to be whitelisted Installation 17

22 IIS Settings ASP.NET Impersonation: Disabled Basic: Disabled Digest: Disabled Anonymous: Enabled Windows: Disabled Forms: Disabled App Settings Authenticaiton_Mode: Certificate Create Database Open SQL Management Studio Right Click on Databases New Database (Name it traffic and select a location), click OK Add Database User to Traffic Database. Note: An existing CairsUser can be used or a new one created Under Security, Logins, Create or select a User Go to User Mapping page and select Traffic, then select db_owner Click Ok to close the dialog box The Cairs Connection UTA queries the CallRecord table in the Cairs database for some reports. The following steps go through how to configure the connection. Note: This is a one-way connection. UTA only reads from the CallRecord table for reports, it does not write any data to Cairs. Add the Cairs database connection string in two places 1. In IIS Settings (a) Open IIS, select Default Web Site, Select UTA, double click on Application Settings. (b) Edit CAIRS_CONNECTIONSTRING set Value to the cairs database connection string. 18 Chapter 1. Topics

23 image of iis settings... Updating UTA Authors: Brett Burbidge Note: We are currently working on this topic. More to come soon! How to updage UTA Admin Guide System By Brett Burbidge Note: We are currently working on this topic. More to come soon! General Export Event Viewer Logs Authors: Brett Burbidge 1.2. Admin Guide 19

24 Introduction This document describes how to export the Event Monitor logs that are specific to the UTA product. The Event Monitor is a log file built into windows. UTA will write to this log if there are catastrophic events that prohibit the logs being written to the database or if there are windows based issues with the UTA service. This document describes how to export this data in an.evtx format. Export the Event Viewer Logs Follow the instructions below to export the UTA System Log. 1. On the server where the UTA product is running open the Event Viewer by going to Start > Administrative Tools > Event Viewer 2. Expand the Windows Logs folder 3. Click on the Application folder 4. In the Actions pane on the right click the Filter Current Log... button. A Filter Current Log window will appear. 5. There is a dropdown called Event sources: In that drop down type Traffic and Alarms and click the OK button. 6. The events in the main pane will be filtered. 7. If there are records in the main pane then follow the instructions below. If there is nothing in the main pane, then there are no events from Traffic and Alarms system in the event log. 8. In the Actions pane on the right click the Save Filter Log File As... button. A Save As window will appear. 9. In the File name enter UTA Event Viewer Log evtx. Replace the with todays date in this format DDMMYYYY. That is todays date, todays month and todays year. Export System Logs Authors: Brett Burbidge Introduction Below describes how to export the UTA system logs. 1. Login and accept the warning screen. 2. Select the Admin menu (if you are not an Admin see this screen change-user-profile). 3. Select the System Log menu item. 4. Enter a Start and End Date, Search text (optional) and Severity (optional). 5. Select the Export button. 20 Chapter 1. Topics

25 Adding Alarm Recipients Authors: Brett Burbidge Traffic By Brett Burbidge Note: We are currently working on this topic. More to come soon! Alarms Contact Closures Authors: Brett Burbidge This example will show to setup UTA to watch for contact closures through a Teleboss 850. Definitions An Alarm Element is a managed device that sits on the network. In this example our Alarm Element is a Teleboss 850. The Teleboss is the termination point for contact closures. It monitors the state of the contact closures. When the state changes the teleboss sends a message to UTA. UTA recieves this message and translates it to the correct alarm. These messages are sent from the Teleboss to UTA via the Simple Network Management Protocol (SNMP) using SNMP Traps. The Teleboss sends specific information in each Trap to signal the contact closure state change. These different Traps need to be defined in UTA. They are called Monitors. Each Alarm Element can have many Monitors 1.2. Admin Guide 21

26 This example goes through how to setup an Alarm Element with its different Monitors to send the appriate alarms when the state of a contact closure changes. Prerequisites Before we start creating Alarm Elements and Monitors in the software we need to map out the different contact closures and where they sit in the Teleboss. Below is a screenshot of an Excel spreadsheet that contains the an example configuration. We will go through each of these below. We will fill out the Trap Numbers later. Click here to download an example configuration file Each contact closure module in the teleboss can hold 8 contact closures. When the state of the contact closure changes (from open to close, or close to open) a message with the corresponding ID (number) is sent out as an SNMP trap. We read this trap ID in UTA and create the correct alarm. If the state of the contact closure is changed back to the default state, meaning the alarm has been corrected, we clear the alarm in UTA. So we need two IDs for each contact closure. An ID that sets the alarm and the ID that clear it. You can see those in the image above. Module: is the name of the module in the Teleboss. Alarm Position: is the physical location of the wires plugged into the back of the Teleboss. Contact Close Name: name of the contact closure. Trap Numbers: These are the ID s passed in the Trap that will create/acknowlege specific alarms in UTA. Hint: Take a minute now and make your own spreadsheet with your site information. We will gather the Monitor Trap Numbers later. Ensure UTA & Teleboss Connections Follow the steps in Teleboss Connection before you continue. Alarm Element Creation Follow the steps below to create the Teleboss as an Alarm Element in UTA: 1. Open UTA & Login 22 Chapter 1. Topics

27 2. Click the Admin dropdown 3. Select Alarm Elements 4. In the main window click the New Element button Example: Enter the Alarm Element information: 1. Name (the name of the Teleboss) 2. Ip Address (the ip address of the Teleboss) 3. Port (leave this blank) 4. Community Name (leave this blank) 5. Type (select Teleboss) 6. Collector Port (leave this blank) 7. Collection File Path (leave this blank) 8. SNMP Version (select one ) 9. Click Save This will send you back to the Alarm Elements screen Finished Example: 1.2. Admin Guide 23

28 Element Monitors Monitors are part of the Alarm Element that trigger alarms based on the ID recieved from the SNMP Trap. This section will go through how to setup these in the Teleboss and in UTA. Note: Make sure your excel spreadsheet is finished with your modules and contact closures defined. Before we start looking at UTA Monitors lets configure the Teleboss and fill out the rest of your excel sheet. Open Putty.exe and login to the teleboss After logging into the Teleboss via SSH type setup and press Enter. Select option F (Action Defintions) 24 Chapter 1. Topics

29 Select option A (Hostname/IP Address 1) Enter the IP address of the UTA server Press the Enter button 1.2. Admin Guide 25

30 Press the Enter button to go back one more menu Select option E (Alarm/Event Defintions) Select option C (EventSensor Device Settings) 26 Chapter 1. Topics

31 Note: If you don t have an C option here it means that the modules have not been installed or the device needs to be rebooted. In the device above there are two modules (Windows and Dooors) Select an option. In this example I am going to click C (Contact Closure 2). The screen will change to what you see below. We are looking at the 8 contact closures on the Doors module Admin Guide 27

32 Each Teleboss module has 8 possible contact closure connections. In the menu (shown above) you can see all 8 contact closures. We are going to configure each of these according to the Excel spreadsheet we filled out earlier. Name your Module Select option A (Device Name) Enter the Module name you want here and then press the Enter key. I will name mine Doors. Configure the Module Select option B (Contat Closure 1) You should see something similar to this: 28 Chapter 1. Topics

33 The following list explains each of the items seen in this screen: 1. Sensor Name: Just a reference to the section name. 2. Contact Slosure Endabled: this contact closure is triggering when changes occure. 3. Event State: The default state of the contact closure connected. 4. Threshold: The amount of time (in seconds) that the contact closure state must be in. For example if 2, the state must be closed for 2 seconds for this to trigger a trap. 5. Event State Actions: What to do when the event state has changed. 6. Return to Normal Actions: What to do when the event state has been changed back to default state. 7. Event State Class: We don t use this but it can be seen on the Traps captured by UTA. 8. Return to Normal Class: We don t use this either. 9. Event Trap Number: IMPORTANT: This must be a Unique number for this whole Teleboss. This number tells UTA which alarm to trigger. 10. Return to Normal Trap Number: IMPORTANT: This must be a Unique number for this whole Teleboss. This number tells UTA which alarm to turn off. 11. Active Alarm Alias: Just text so you know what the active state is. Front door shut in this example is the default state. 12. Inactive Alarm Alias: Just text so you know what the inactive state is. Front door open in this example. Complete your Spreadsheet In the image below I have entered the individual Event Trap Number and Return to Normal Trap Numbers in the spreadsheet Admin Guide 29

34 Note: Remember that the Event Trap Number and Return to Normal Trap Number be unique for the entire Teleboss. When completing your spreadsheet make sure to fill in each of the Trap Numbers for both Evnet Trap Number and Return to Normal Trap Number. I normally just put them one digit apart as seen in the example above. Configure your Contact Closure Now we need to change each of the following contact closure properties to match your spreadsheet. To do that enter the letter of the property you want to change. Use the guide below to help. A: Sensor Name B: ON C: OPEN D: 2 E: Press Enter and type trap(1) then press Enter. Explanation below. F: Press Enter and type trap(1) then press Enter. G: Info H: Info I: 1000 J: 1001 K: Enter open status text that makes sense for this sensor L: Enter closed status text that makes sense for this sensor Your complete screen should look similar to this: 30 Chapter 1. Topics

35 Configure the remaining Teleboss Modules Now Go through your Teleboss and set up each module and contact closure to match your spreadsheet. Your spreadsheet and teleboss should look similar to this: 1.2. Admin Guide 31

36 UTA Monitor Creation The UTA Alarm Monitors watch the contact closures you created in the Teleboss. This section will cover adding the Alarm Monitors in UTA and testing the Alarm Creation. 1. Open UTA and Login. 2. Go to Admin>Alarm Elements. 3. Click the Monitors button on the Alarm Element you created earlier. 4. Click New Monitor. Example: With the new Alarm Monitor open fill out the information for this monitor. Hint: For each Contact Closure you configured in the Teleboss we need to create a new Alarm Monitor for each one. Fun! Name: the name of the contact closure from your excel spreadsheet. Alarm Key: the Trap Number you entered into the Teleboss. The first number in the Trap Numbers column. Alarm Key Value: leave this blank. Clear Alarm Key: the Return to Normal Trap Number. The second number in the Trap Numbers column. Clear Alarm Key Value: leave this blank. 32 Chapter 1. Topics

37 Message: this is the alarm message that will be displayed when an new alarm is generated from this. For exampl this could be Back door open. Escalation: select the Escalation pattern from the dropdown list. Press the Save button to save the Alarm Monitor. Example: Your Alarm Monitor is now ready to create alarms when the Teleboss sends a 1000 Trap message Admin Guide 33

38 Cairs Traffic and Alarms Documentation, Release Testing Contact Closures If you have the Teleboss installed and ready to receive contact closures from a real system skip to Check UTA for Alarms. Create Contact Closure Test Most of the time we don t have access to the systems that generate the contact closures during setup. Follow the instructions below to create your own contact closure tester with the Teleboss. Strip two wires on both sides and secure one side into the Teleboss module slot 1+ and slot 1-. Below is the module installed in the Teleboss. The default state of the Front Door Alarm is open. This means that the current state is non alarming (pun not intended). 34 Chapter 1. Topics

39 Cairs Traffic and Alarms Documentation, Release To create an alarm close the circuit. Closing the circuit will tell the Teleboss to send an SNMP Trap to the UTA server Admin Guide 35

40 Cairs Traffic and Alarms Documentation, Release Chapter 1. Topics

41 Check UTA for Alarms 1. Open UTA and Login. 2. Go to Alarms > Active Alarms. 3. You should see an alarm that looks like this: If you don t see an alarm on the Active Alarms page we need to do some more troubleshooting. Troubleshooting Hint: If you did not see an alarm in Active Alarms go back through each step above and ensure that IP s, trap numbers are correct. Check the System Log for Traps Go to Admin > System Logs and check for traps received. You should see something like this: 1.2. Admin Guide 37

42 Important: Make sure you touched the wires together for at least 2 seconds to create the alarm. 2 seconds comes from the Threshold setting found on the specific Contact Closure. Finished This concludes the section on setting up Contact Closures. Happy alarming. Teleboss Connection Authors: Brett Burbidge This example will demonstrate how to setup the connection between the Teleboss and the UTA to communicate via Simple Network Management Protocol (SNMP) using SNMP Traps. Assumptions This section assumes the following setup is in place. 1. UTA server is installed and on the network 2. A Teleboss is configured and on the same network as UTA 3. The IP of the Teleboss and UTA server are known 4. You understand Putty and how to login to the Teleboss using SSH. If one of the assumptions above is incorrect please follow other steps in this manual. Connection Tests We will ping the UTA server from the Teleboss and vice versa to test the connection. 38 Chapter 1. Topics

43 Note: Ping might not be enabled on the network firewalls. If you can run Putty on SSH from the UTA server to the Teleboss everything should be okay. But this is a good test if Ping is enabled. 1. Login to the Teleboss 2. Type ping [ip address of UTA] 3. Let the ping run then press Ctrl+c to stop the ping Like this: Warning: if the ping is unresolved it might be that UTA and the Teleboss cannot talk to each other. 1. Login to the UTA server and ping the Teleboss 1.2. Admin Guide 39

44 Like this: If everything is successful move to the next section. Teleboss Setup 1. Login to the Teleboss 2. Type the word setup and press the enter key You should see this: 1. Press F (Action Definitions) 2. Press A (Hostname/IP Address 1) 40 Chapter 1. Topics

45 3. Enter the IP address of the UTA server and press the Enter key You should see something like this: is the IP of the UTA server UTA Setup We need to add a new Alarm Element for this Teleboss in UTA. Follow the instructions below to create this new element. 1. Open UTA in a browser and login 2. Add a new Alarm Element by going to Admin > Alarm Elements > New Element Example: Enter the Alarm Element (Teleboss) information: 1. Name (the name of the Teleboss)e 2. Ip Address (the ip address of the Teleboss) 3. Port (leave this blank) 4. Community Name (leave this blank) 5. Type (select Teleboss) 6. Collector Port (leave this blank) 7. Collection File Path (leave this blank) 8. SNMP Version (select one ) 9. Click Save 1.2. Admin Guide 41

46 Your new Alarm Element should look something like this:..image:: images/uta_alarm_element.jpg Test the Setup 1. Go back to the Teleboss and press the Enter button until you are out of the menu. (This may take multiple times) 2. Type dotrap then press the Enter key. 3. You should see a COMPLETE message in the Teleboss window. See below: Behind the scenes the Teleboss is sending a type 1 SNMP Trap to the IP address we setup earlier in Action Definitions/Hostname/IP Address 1. We need to see if this Trap made it to UTA. 1. Open UTA in a browser and login 2. Navigate to Alarms/Traps 3. You should see something similar to this: 42 Chapter 1. Topics

47 Note: If you don t see anything in the log please continue this troubleshooting guide below. Troubleshooting You should only be here if the tests above did not work. Incorrect Alarm Element Configuration 1. In UTA go to Admin/System Log 2. In Putty type dotrap again. 3. Press the Search button in the Admin/System Log to see if there are any new results. If you see something like this: It means that your Alarm Element is not setup properly. The IP address you have for your Alarm Element is probably incorrect Admin Guide 43

48 Note: To fix this, edit your Alarm Element with the proper IP Address and do this test again. Incorrect UTA IP Address It is possible that the IP Address you put into the Teleboss is incorrect. 1. On the UTA server open a cmd window and type ipconfig. Remember or write down the IP address of the server. 2. Go back to Putty and ensure the correct Teleboss is open. 3. Type the word setup and press the enter key. You should see this: 1. Press F (Action Definitions) 2. Press A (Hostname/IP Address 1) 3. Enter the IP address of the UTA server and press the Enter key Note: Try the dotrap test again and see if you get different results. Firewall Settings If none of the steps above fixed the connection issues there could be firewalls preventing the communication. Check the firewalls on the UTA server and also on the network between the UTA and Teleboss. 44 Chapter 1. Topics

49 Hint: In order for SNMP to work port 162 UDP/TCP must be open Admin Guide 45

50 46 Chapter 1. Topics

51 CHAPTER 2 Indices and tables genindex modindex search 47