reporttool
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| reporttool [2007/11/01 15:28] – faltin | reporttool [2011/04/03 17:28] (current) – [Reports] faltin | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== The report tool ====== | ====== The report tool ====== | ||
| - | {{tools: | + | {{tools: |
| 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 22: | Line 22: | ||
| * To navigate back to the report home page, use the " | * To navigate back to the report home page, use the " | ||
| - | * The search bars on top are shortcuts | + | * The search bars on top are short-cuts |
| - | ===== IP Device Center | + | ===== IP address scope - graphical view ===== |
| - | The IP device center is a dashboard for a given device showing relevant information. It presents | + | 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 what is more, how full they are, i.e. how many machines they contain. NAV introduces a tabular view that gives an excellent overview on a single page: |
| - | 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: | + | {{ screenshot: |
| + | A prerequisite for this tool to work is that you have seeded your database with one or more scope prefixes. The scope prefixes defines your total address room. You may have both IPv4 and IPv4 scopes. Each scope can be visualized as shown in the example. | ||
| - | ===== IP address | + | You may also use the reserved prefix option in Seed Database. A reserved prefix is a prefix that is allocated for a purpose, but is not yet in production. For more info on registering |
| - | For large networks the task of maintaining | + | A brief explanation |
| - | + | ||
| - | {{ screenshot: | + | |
| + | * Layout | ||
| + | * For IPv4 each row is a /24 scope and the columns counts from 0-255 | ||
| + | * For IPv6... (to be completed) | ||
| + | * A coloured area means that this prefix is in use or allocated | ||
| + | * reserved prefixes are brown | ||
| + | * in cases where there are many small subnets (meaning too small to display in a good manner), the row is blue | ||
| + | * prefixes in use follow a colour scheme based on their utilization rate: | ||
| + | * a very heavily used prefix will be red | ||
| + | * a lightly used prefix will have a light colour | ||
| + | * The displayed percentage is the actual percentage of the IP addresses in the prefix that are in use. If you click on this link you will be directed to the machine tracker that can display the actual IP addresses (and mac addresses) that are in use. | ||
| + | * If you click on the row titles on the left you will be directed to a report displaying all prefixes in that area | ||
| + | * If you click on an actual allocated prefix you will e directed to a report displaying details regarding this prefixes | ||
| + | * If you uncheck the "Show unused address rows" you will get a collapsed view removing rows where there are no allocations. | ||
| ===== Service matrix ===== | ===== Service matrix ===== | ||
| Line 50: | Line 60: | ||
| ====== Configuration ====== | ====== Configuration ====== | ||
| - | As mentioned the report system is highly configurable, | + | As mentioned the report system is highly configurable, |
| - | (In a later version of NAV 3.4 we will strengthen the means of editing reports by adding | + | |
| - | if interested, see [[devel: | + | |
| - | ==== report.conf | + | ==== Report configuration |
| The NAV reports are made based on the '' | The NAV reports are made based on the '' | ||
| - | 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 '' |
| 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 67: | Line 75: | ||
| < | < | ||
| gwport { | gwport { | ||
| + | $description = " | ||
| $sql= " | $sql= " | ||
| | | ||
| Line 96: | Line 105: | ||
| $url_otherbox=" | $url_otherbox=" | ||
| $url_remoteif=" | $url_remoteif=" | ||
| + | $explain_gwp=" | ||
| + | $sum=" | ||
| } | } | ||
| </ | </ | ||
| - | The syntax of report.conf is: | + | The syntax of the report |
| Each report is enclosed within brackets: | Each report is enclosed within brackets: | ||
| Line 111: | Line 122: | ||
| This report is seen as '' | This report is seen as '' | ||
| - | Further explanation of the report.conf syntax: | + | Further explanation of the report |
| ^Command | ^Command | ||
| - | |$sql=" | + | | $description=" |
| - | | $title=" | + | | $sql=" |
| - | | $name_MYCOL | + | | $title=" |
| - | | $explain_MYCOL |shows an explanation as popup in the browser when you hold the curser over the column header.| | + | | $name_MYCOL |
| - | | $order_by |defines | + | | $explain_MYCOL |
| - | | $url_MYCOL |makes a hyperlink to another report or elsewhere. Takes parameters from the current report| | + | | $order_by |
| - | | $hide |columns | + | | $url_MYCOL |
| - | | $extra |extra " | + | | $hide |
| - | | $sum |shows the total of a given column (currently not working)| | + | | $extra |
| + | | $sum | Show the sum total of a given column (which must contain numeric values) | | ||
reporttool.1193930934.txt.gz · Last modified: by faltin