This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
reporttool [2007/10/07 12:37] faltin |
reporttool [2009/03/04 07:45] morten column summing actually works now |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== The report tool ====== | ====== The report tool ====== | ||
- | {{tools:report.png| }} The report tool presents a number of reports with information from your network. The report tool also links to the IP device center, to the "IP address scope - graphical view" and the services - graphical view. | + | {{tools:report.png| }} The report tool presents a number of reports with information from your network. The report tool also links to the "IP address scope - graphical view" and the services matrix. |
Each NAV report is in essence an SQL query to the database. It shown its data in a number of columns. The | Each NAV report is in essence an SQL query to the database. It shown its data in a number of columns. The | ||
Line 12: | Line 12: | ||
An example report showing all your network equipment sorted by type: | An example report showing all your network equipment sorted by type: | ||
- | {{screenshot:equipmtypes.png?800|The equipment type report}} | + | {{screenshot:3.3:equipmentypes.png|The equipment type report}} |
From this report you can drill down on a particularly type and see the number of devices you have of this | From this report you can drill down on a particularly type and see the number of devices you have of this | ||
Line 24: | Line 24: | ||
* The search bars on top are shortcuts to interesting reports. The room searc lets you go directly to a room of interest. You may also search for a particular port name, or you may dive directly into the IP device center of a device in interest. | * The search bars on top are shortcuts to interesting reports. The room searc lets you go directly to a room of interest. You may also search for a particular port name, or you may dive directly into the IP device center of a device in interest. | ||
- | ===== IP Device Center ===== | ||
- | |||
- | The IP device center is a dashboard for a given device showing relevant information. It presents | ||
- | recent events for the device, if any. If the device is a switch or router a switch port and/or | ||
- | router interface view is given. | ||
- | |||
- | {{screenshot:devcenter.png?800|IP device center }} | ||
===== IP address scope - graphical view ===== | ===== IP address scope - graphical view ===== | ||
Line 36: | Line 29: | ||
For large networks the task of maintaining the total IP address scope may be a challenge in itself. It is useful to have an overview of all the subnets in operation, and whats more, how full they are, i.e. how many machines do they contain. NAV introduces a tabular view that gives an excellent overview on a single page: | For large networks the task of maintaining the total IP address scope may be a challenge in itself. It is useful to have an overview of all the subnets in operation, and whats more, how full they are, i.e. how many machines do they contain. NAV introduces a tabular view that gives an excellent overview on a single page: | ||
- | {{screenshot:prefixmatrix.png?800|The prefix matrix }} | + | {{ screenshot:3.3:prefixmatrix.png?700 |The prefix matrix }} |
===== Service matrix ===== | ===== Service matrix ===== | ||
Line 48: | Line 41: | ||
====== Configuration ====== | ====== Configuration ====== | ||
- | As mentioned the report system is highly configurable, you can alter the configuration file report.conf. | + | As mentioned the report system is highly configurable, you can alter the configuration file "report.local.conf", either adding new reports or overloading existing reports that exists in "report.conf". |
- | (In a later version of NAV 3.4 we will strengthen the means of editing reports by adding support for local reports, | + | |
- | if interested, see [[devel:tasklist#smj3improve_the_report_tool|details]]). | + | |
- | ==== report.conf ==== | + | ==== Report configuration ==== |
The NAV reports are made based on the ''report.conf'' configuration file. You can expand this file | The NAV reports are made based on the ''report.conf'' configuration file. You can expand this file | ||
- | with new reports as you like. Each report is in essence an SQL-query to the database (with some | + | with new reports as you like in ''report.local.conf''. Each report is in essence an SQL-query to the database (with some |
limitations). It is easy to make hyper links from data in the report to other reports or elsewhere. | limitations). It is easy to make hyper links from data in the report to other reports or elsewhere. | ||
Line 64: | Line 56: | ||
<code> | <code> | ||
gwport { | gwport { | ||
+ | $description = "Extended information about router ports."; | ||
$sql= " | $sql= " | ||
SELECT netbox.sysname, gwport.ifindex, gwport.interface, module.module, | SELECT netbox.sysname, gwport.ifindex, gwport.interface, module.module, | ||
Line 93: | Line 86: | ||
$url_otherbox="netbox?sysname=$otherbox"; | $url_otherbox="netbox?sysname=$otherbox"; | ||
$url_remoteif="swport?b1.sysname=$otherbox&s1.interface=$remoteif"; | $url_remoteif="swport?b1.sysname=$otherbox&s1.interface=$remoteif"; | ||
+ | $explain_gwp="Router Ports"; | ||
+ | $sum="gwport"; | ||
} | } | ||
</code> | </code> | ||
- | The syntax of report.conf is: | + | The syntax of the report configuration is: |
Each report is enclosed within brackets: | Each report is enclosed within brackets: | ||
Line 108: | Line 103: | ||
This report is seen as ''https://your_nav/report/r1'' | This report is seen as ''https://your_nav/report/r1'' | ||
- | Further explanation of the report.conf syntax: | + | Further explanation of the report configuration syntax: |
^Command ^Description | | ^Command ^Description | | ||
- | |$sql="SELECT ..."; |The SQL query | | + | | $description="..."; | Textual description of what the report shows | |
- | | $title="..."; |The report title | | + | | $sql="SELECT ..."; | The SQL query | |
- | | $name_MYCOL |changes the column header. | | + | | $title="..."; | The report title | |
- | | $explain_MYCOL |shows an explanation as popup in the browser when you hold the curser over the column header.| | + | | $name_MYCOL | Changes the column header. | |
- | | $order_by |defines the default ordering of the sql query. By clicking on the column headers in the report, you can sort/reverse sort on other criteria. | | + | | $explain_MYCOL | Shows an explanation as popup in the browser when you hold the curser over the column header.| |
- | | $url_MYCOL |makes a hyperlink to another report or elsewhere. Takes parameters from the current report| | + | | $order_by | Defines the default ordering of the sql query. By clicking on the column headers in the report, you can sort/reverse sort on other criteria. | |
- | | $hide |columns that must be included in the $sql because they are used in $url. $hide will not show the column in the report. | | + | | $url_MYCOL | Makes a hyperlink to another report or elsewhere. Takes parameters from the current report| |
- | | $extra |extra "static" columns at the right that can be used for hyperlinks | | + | | $hide | Columns that must be included in the $sql because they are used in $url. $hide will not show the column in the report. | |
- | | $sum |shows the total of a given column (may not work...)| | + | | $extra | Extra "static" columns at the right that can be used for hyperlinks | |
+ | | $sum | Show the sum total of a given column (which must contain numeric values) | | ||