Application Note Creating a Composite Report For Managed Hosts 12-Oct-2016 Revision 1.0 Compiled by: Larry Balon

Transcription

1 Application Note Creating a Composite Report For Managed Hosts 12-Oct-2016 Revision 1.0 Compiled by: Larry Balon entuity.com info@entuity.com

2 Table of Contents 1.0 Purpose Device Sub-Report Port Attributes Sub-Report Disk Attributes Sub-Report Creating the Composite Report Revision History Copyright 2016 Entuity, Ltd. Entuity and Entuity logo are registered trademarks of Entuity, Ltd. All other products and trademarks are the property of their respective owners. entuity.com Page 2

3 1.0 Purpose The purpose of the document is to provide a procedure that will allow an Entuity administrator to create a composite report for Managed Hosts. The procedure uses Entuity s Report Builder utility and it requires that the Entuity server be running Entuity 14.5 or later. The composite report will report on the following: Device: Managed Host attributes (manufacturer, model, serial number, name) Managed host time series information (reachable status, reachable time, ICMP know %, and active Sessions Ports: Port status and inbound/outbound bandwidth utilization (tabular data and graphs) Disks/Volumes: Volume name, Volume Size, Free Space (bytes), Free Space Percentage Three individual reports will be created and tested first. The composite report will be created last and will combine the 3 individual reports into one. This application note assumes the reader is already familiar with the Entuity web UI. This report may also be used to report on Linux-based firewalls such as Checkpoint and Nokia. entuity.com Page 3

4 2.0 Device Sub-Report This section will provide a procedure to create the report for the device. This report can be run as a standalone report after it is created or it can be placed into a composite report as sub-report. The pre-requisite for this report is that the Managed Hosts have already been placed into an Entuity view. All reports will be run against this view. 1. From the Explorer menu, choose a Managed host and drag the following items into the Drop Box: Manufacturer, Model, Version, Polled IP address. This can be done from the Explorer interface. entuity.com Page 4

5 2. Click the Report Builder icon in the upper right corner of the left window pane. At the main menu of the Report Builder, select the Inventory Table hyperlink to bring up the report template. The report template will pre-populate with the attributes previously selected. 3. Change the name of the report to Device Attributes. Click the Add Column button 4 times to add 4 fields to the report. entuity.com Page 5

6 4. Click the hyperlink labeled None in the Value column on row 5. This will display the Static Attribute Selection panel. 5. Click the Find Attributes bar. Click the plus sign to the left of the Objects label. Click the device name or IP address to expand the attributes for the device. Click on the plus sign to the left of the Stream Attributes label. Select the following Stream Attributes: Active Sessions, Device Reachable Status, Device Reachable Time and ICMP Reachable Known % (not shown in screenshot). Click OK to accept the selections. entuity.com Page 6

7 6. Select one of the attributes and click OK to place it in the column. Select the next column field by clicking the None hyperlink. Place the next attribute into the next column. Repeat until all of the attributes are in the columns. 7. Click the Preview button to preview the report. A single device will be displayed in the report. entuity.com Page 7

8 8. Close the window and click the radio button Ignore Selection at the bottom of the page. Change the view to the view that contains the Managed Hosts. 9. Scroll to the top of the page. Click the Report Options hyperlink. Uncheck the Navigation Framework box and set all margins to zero. Uncheck the box labeled Include Standard Header. entuity.com Page 8

9 10. Click the Preview button to preview the report. The report will display all devices in a tabular format with no report controls or headers. Click the Publish button to publish the report into the User Defined reports folder. entuity.com Page 9

10 3.0 Port Attributes Sub-Report This section will provide a procedure to create the report for all ports in the Managed Host view. This report can be run as a standalone report after it is created or it can be placed into a composite report as sub-report. The report will contain a row filter that will restrict reporting on ports to those that are operationally up. The pre-requisite for this report is that the Managed Hosts have already been placed into an Entuity view. All reports will be run against this view. 1. Clear out the Drop Box. Next, select a Managed Host port that is operationally up. Insure that the UI display is set for Rate so that the port utilization displays in BPS. Drag the inbound and outbound rates and the Operational Status field into the Dropbox. 2. Click the Report Builder icon in the upper right corner of the left window pane. Select Multi-chart/table report. Scroll down to the button labeled Organize Layout. Click this button. Scroll down and click Customize Layout. In the Below field, select 1 row and 3 columns. Click OK to save the layout. entuity.com Page 10

11 3. Drag the Inbound Traffic Rate, Outbound Traffic Rate and Operational Status fields into the columns. Click OK to save the layout. 4. In the Tabular Data section, change the label for Inbound Traffic Rate to Inbound Traffic. Change the label for Outbound Traffic Rate to Outbound Traffic. Click the Inbound Traffic Rate hyperlink. This will bring up the Static Attribute Panel. Change the Inbound and Outbound Traffic Aggregation Method from Last Value to Mean. Click OK to accept the changes. entuity.com Page 11

12 5. Scroll to the top of the web page. Change the name of the report to Port Attributes. Click on the Report Options hyperlink to open it. Uncheck the Navigation Framework box and change the left, right, top and bottom margins to 0. Uncheck the box labeled Include Standard Header. In the Chart Title box, enter the following text: #ifdescr# Enter the text with the hashtags and insure the case is correct. This is actually a variable that will display the interface description of the interface on the chart. 6. Scroll to the bottom of the page and click the Preview button to preview the report. It will contain a single port graph and the mean inbound/outbound bandwidth values and the port operational status. Close the window. entuity.com Page 12

13 7. In the upper-right corner of the page, check the box labeled Show Advanced Options. Scroll to the bottom of the page. Click the hyperlink to the right of the label named Row Filter. Enter the following text into the Expression Field: portoperationalstatus == 1 Click OK after entering the expression. 8. Click the radio button labeled Ignore Selection, and use objects from view. Select the view containing the Managed Hosts. Change the Chart Height to 140px. entuity.com Page 13

14 9. Click the Preview button to preview the report. The report will contain charts from all of the operationally up ports contained in the view which has the Managed Hosts. The number of charts displayed is dependent upon the number of operationally up ports in the view. After reviewing the report, close the window and click the Publish button to publish the report. entuity.com Page 14

15 4.0 Disk Attributes Sub-Report This section will provide a procedure to create the report for disks/volumes in the Managed Host view. This report can be run as a standalone report after it is created or it can be placed into a composite report as sub-report. The report will report the volume name, volume size, free space (in bytes) and free space percentage. The pre-requisite for this report is that the Managed Hosts have already been placed into an Entuity view. All reports will be run against this view. 1. Clear out the Drop Box. Next, select a Managed Host device. Click the Advanced Tab to display the Advanced information. Scroll down to the Associated Attributes section and locate the Volumes attribute. 2. Click the hyperlink for one of the volumes listed in the right column. On the next page, drag the following attributes into the Dropbox: Name, Size, Free (%) and Free Space. entuity.com Page 15

16 3. Click the Report Builder button located in the upper right corner of the left window pane to launch the Report Builder. Select the Inventory Table report. Change the name of the report to Disk Attributes. Click the Report Options hyperlink. Uncheck the box labeled Navigation controls. Set the margins for left, right, top and bottom to 0. Uncheck the box labeled Include Standard Header. 4. Click the Preview button to preview the report. The information from a single disk is displayed in the report. Close the report window. entuity.com Page 16

17 5. Scroll to the bottom of the report template page. Click the radio button labeled Ignore selection, and use objects from view. In the Include objects of type field, select Other Types... Select Volumes from the Reportable Types window. 6. Click Preview to preview the report. A list of all disk volumes from the view with the Managed Hosts is displayed. The number of volumes displayed will be dependent upon the number of volumes contained in the view. After reviewing the report, close the window and click the Publish button to publish it to the repository. entuity.com Page 17

18 5.0 Creating the Composite Report This section will summarize the steps required to create the composite report. The report will combine the three previously created reports into a single report. 1. From the Web UI, go to Reports -> User Defined Reports. Confirm that the 3 previously created reports are in the repository. 2. Click the Report Builder button to launch the Report Builder. Scroll down and select the Composite Report hyperlink. Assign a name to the report and click the Add Sub-Report button. Click the hyperlink labeled None in the sub-report column. Select Device Attributes report from the list and click OK. entuity.com Page 18

19 3. Click the Show Advanced Options button. Next, click the hyperlink labeled Middle in the Position column. Change this to Top. 4. Click the Add Property button in the Hidden Property Fields section. Click the hyperlink labeled None to the left of label # 2. This will bring up the Static Attribute Selection panel. entuity.com Page 19

20 5. Click the button labeled Define Attribute. In the description field, enter the following text: volumeserverobjectids In the expression field, enter the following text: join(foreach(get_associated_objects("volumes"),concat(entuity_server_info()[0],":",id)),",") Click OK after entering the text. Click OK a second time to save the attribute. 6. Click the Add Sub-Report button. Click the hyperlink labeled None in the sub-report column. Select Disk Attributes report from the list and click OK. entuity.com Page 20

21 7. In row 2, click the hyperlink labeled Default in the Parameters column. This will display a Sub-Report Parameters panel. 8. Click the hyperlink named default to the left of the label named serverobjectids. Click the radio button labeled Field. Enter the following text into the box at the bottom of the panel: volumeserverobjectids Click OK to save the serverobjectid parameters. Click OK again to save the Sub-Report parameters. entuity.com Page 21

22 9. Scroll to the bottom of the screen. Confirm that the Parameters value for the Disk Attributes report displays Overridden. Click the radio button labeled Ignore selection and use objects from view. Change the view selection to the view containing the Managed Hosts. 10. Click the Preview button to preview the report. The report will now contain the device attributes and the disk attributes on a single report. Scroll through the report to view all of the Managed Hosts. entuity.com Page 22

23 11. Click the Add Sub-Report button. Click the hyperlink labeled None in the sub-report column. Select Port Attributes report from the list and click OK. 12. click the hyperlink labeled Middle in the Position column. Change this to Bottom. entuity.com Page 23

24 13. Click the Add Property button in the Hidden Property Fields section. Click the hyperlink labeled None to the left of label # 2. This will bring up the Static Attribute Selection panel. 14. Click the button labeled Define Attribute. In the description field, enter the following text: portserverobjectids In the expression field, enter the following text: join(foreach(get_associated_objects("ports"),concat(entuity_server_info()[0],":",id)),",") Click OK after entering the text. Click OK a second time to save the attribute. entuity.com Page 24

25 15. In row 3, click the hyperlink labeled Default in the Parameters column. This will display a Sub-Report Parameters panel. 16. Click the hyperlink named default to the left of the label named serverobjectids. Click the radio button labeled Field. Enter the following text into the box at the bottom of the panel: portserverobjectids Click OK to save the serverobjectid parameters. Click OK again to save the Sub-Report parameters. entuity.com Page 25

26 17. Click Preview to preview the report. Confirm that the report displays device attributes, disk attributes and port attributes for each device. Close the window. Click Publish to publish the report. entuity.com Page 26

27 Revision History Version: 1.0 Created by: Larry Balon Last Modified on: 12-Oct-2016 Modified by: Changes Initial Document Created Version: Created by: Last Modified on: Modified by: Changes entuity.com Page 27