Skip to content

Commit

Permalink
update documentation for release 1.00
Browse files Browse the repository at this point in the history
update documentation for release 1.00 (issue #23)
  • Loading branch information
Tontonitch committed Jan 4, 2019
1 parent 57948ae commit 5ad7ce0
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# CHANGELOG
# ========================================================================
#
# Possible change types: enhancement, feature, bugfix, add
# Possible change types: enhancement, feature, bugfix, add, extra
#
# ----------------------------------------------------------------------
# * 1.00
Expand All @@ -24,7 +24,7 @@
# - feature: use ifname instead of ifdesc (thanks freneticf)
# - feature: added Netapp cDOT support (new nodetype "netapp-cdot")
# - feature: added HPUX support (new nodetype "hpux")
# - feature: added --trafficwithpkts option
# - feature: added --trafficwithpkt option
# - feature: added --snmp-maxmsgsize option
# - feature: added nagiosxi as grapher solution
# - feature: added graphite support (thanks Israel Ochoa)
Expand Down
6 changes: 2 additions & 4 deletions doc/02-what-s-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# What's new

* New & enhanced supported node types: cisco, hp, netscreen, netapp, bigip, bluecoat, brocade, brocade-nos, nortel.
* New & enhanced supported node types: Cisco, HP, Netscreen, Netapp (7-mode, cDOT), F5 BigIP, Bluecoat, Brocade, Brocade-NOS, Nortel, EMC Datadomain, Linux/UNIX/Windows/...

![Vendors](images/what-s-new/Vendors.png)

Expand Down Expand Up @@ -47,6 +47,4 @@



Complete list of changes in the 0.05 release [here](tiki-
index.php?page=Nagios+plugins+-+interfacetable_v3t+-+changelog+-+0.05 "Nagios
plugins - interfacetable_v3t - changelog - 0.05" )
Complete list of changes available [here](https://raw.githubusercontent.com/Tontonitch/interfacetable_v3t/master/CHANGELOG)
7 changes: 5 additions & 2 deletions doc/05-plugin-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@
| ------- | ----------- | ------------- |
| -e, --exclude | \* Comma separated list of interfaces globally excluded from the monitoring. Excluding an interface from that tracking is usually done for the interfaces that we don't want any tracking. For example: <br>+ virtual interfaces <br>+ loopback interfaces <br>\* Excluded interfaces are represented by black overlayed rows in the interface table or are listed in the config table if enabled <br>\* Excluding an interface globally will also exclude it from any tracking (traffic and property tracking). | |
| -i, --include | \* Comma separated list of interfaces globally included in the monitoring. <br>\* By default, all the interfaces are included. <br>\* There are some cases where you need to include an interface which is part of a group of previously excluded interfaces. | |
| --alias-matching | Allow you to specify alias in addition to interface names as inclusion/exclusion arguments (for global, traffic and property inclusion/exclusion). | _disabled_ |
| --exclude-but-calculate | Allow calculation of interface data for excluded interfaces, and show them in the table | _disabled_ |

### Traffic checks (load & packet errors/discards)

Expand Down Expand Up @@ -134,7 +136,7 @@
| --max-repetitions=integer | Available only for snmp v2c/v3. Increasing this value may enhance snmp query performances by gathering more results at one time. Setting it to 1 would disable the use of get-bulk. | Automatically set by the system |
| --snmp-timeout | Define the Transport Layer timeout in seconds for the snmp queries. Value can be from 1 to 60. Note: multiply it by the snmp-retries+1 value to calculate the complete timeout. | 2 |
| --snmp-retries | Define the number of times to retry sending a SNMP message. Value can be from 0 to 20. | 2 |
| --snmp-maxmsgsize | Size of the SNMP message in octets, usefull in case of too Long responses. Be carefull with network filters. Range 484 - 65535. Apply only to netsnmp perl bindings. | The default is 1472 octets for UDP/IPv4, 1452 octets for UDP/IPv6, 1460 octets for TCP/IPv4, and 1440 octets for TCP/IPv6 |
| --snmp-maxmsgsize | Size of the SNMP message in octets, useful in case of too Long responses. Be carefull with network filters. Range 484 - 65535. Apply only to netsnmp perl bindings. | The default is 1472 octets for UDP/IPv4, 1452 octets for UDP/IPv6, 1460 octets for TCP/IPv4, and 1440 octets for TCP/IPv6 |
| --(no)unixsnmp | Use unix snmp utilities for snmp requests (table/bulk requests), in place of perl bindings. | Default is to use perl bindings. |

### Graphing options
Expand All @@ -146,7 +148,7 @@
| --perfdatathreshold | Define which thresholds are printed in the generated performance data. Can be: <br>\* 'full' : thresholds in the generated performance data are generated for include plugin related stats, interface load stats, and packet error stats <br>\* 'loadonly' : thresholds in the generated performance data include plugin related stats and interface load stats <br>\* 'globalonly' : thresholds in the generated performance data include only plugin related stats <br>Default is 'full'. 'loadonly' or 'globalonly' could be used in case of a too long plugin output producing problems with nagios/icinga's buffers. | full |
| --perfdatadir | When specified, the performance data are written directly to a file in the specified location instead of transmitted to Icinga/Nagios. Please use the same hostname as in Icinga/Nagios for -H or -h. | /usr/local/pnp4nagios/var/spool |
| --perfdataservicedesc | (only used when using --perfdatadir and --grapher pnp4nagios). Service description to use in the generated performance data. Should match what is used in the Nagios/Icinga configuration. Optional if environment macros are enabled in nagios.cfg/icinga.cfg (enable\_environment\_macros=1). | "Interface status" |
| -g, --grapher | Specify the used graphing solution. Can be: <br>\* pnp4nagios <br>\* nagiosgrapher <br>\* netwaysgrapherv2 | pnp4nagios |
| -g, --grapher | Specify the used graphing solution. Can be: <br>\* pnp4nagios <br>\* nagiosgrapher <br>\* netwaysgrapherv2 <br>\* ingraph <br>\* graphite <br>\* nagiosxi | pnp4nagios |
| --grapherurl | Graphing system url | /pnp4nagios |
| --portperfunit | In/out traffic in perfdata could be reported in bits (counters) or in bps (calculated value). <br>Using bps avoid abnormal load values to be plotted on the graphs. <br>_!!! WARNING !!! <br>switching from one mode to the other require the change of the Data Source Type (DST) in the rrd files already generated by pnp4nagios (or similar action for the other graphing solutions) <br>!!! WARNING !!!_ <br>Possible values: bit or bps (default) <br>Note that the 'octet' choice has been removed. Please contact me if you used it | bps _(or installation related)_ |

Expand All @@ -162,6 +164,7 @@
| --(no)vlan | Add the vlan attribution property for each interface in the interface table. This option is available only for the following nodetypes: cisco, hp, nortel | _disabled_ |
| --(no)ipinfo | Add the ip information for each interface in the interface table. | _enabled_ |
| --(no)alias | Add the alias information for each interface in the interface table. | _disabled_ |
| --ifname | Use OID ifName instead of ifDesc for nodetype standard. | _disabled_ |
| --accessmethod | Allow you to generate links in the HTML page to access your device. Access method for the link to the host in the HTML page. <br>Format: method\[:link\]\[,method\[:link\]\] <br>\* Method can be: ssh, telnet, http or https <br>\* Link is by default the hostaddress, but can be an http address for example. <br>Example: <br>\--accessmethod telnet,http:http://$HOSTADDRESS$/na\_admin <br>will produce 2 links: <br>1\. a telnet link (default is to $HOSTADDRESS$) <br>2\. a http link to [http://$HOSTADDRESS$/na\_admin](http://$HOSTADDRESS$/na_admin) <br>Note: <br>"," is the multiple link definition separator (same as some other options) <br>":" separate the method and the custom link (custom link can include the : character) | none |
| --htmltabledir | Specifies the directory in the file system where HTML interface table are stored. | _Installation related_ |
| --htmltableurl | Specifies the URL by which the interface table are accessible. | _Installation related_ |
Expand Down
11 changes: 11 additions & 0 deletions doc/20-supported-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
| ProCurve Switch 6410 | |
| ProCurve Switch 2900-48G (J9050A) | revision T.13.71 |
| ProCurve Switch 5412zl Intelligent Edge (J8698A) | revision K.15.08.0013, ROM K.15.28 |

**Juniper**

| Device | Notes |
Expand Down Expand Up @@ -108,6 +109,16 @@
| SPARC Enterprise M5000 | tested on solaris 10 u8/u9/u10 and bge, sppp interfaces |
| SPARC Enterprise T5120 | tested on solaris 10 u8/u9/u10 and e1000g interfaces |
| SPARC Enterprise T3-1 | tested on solaris 10 u8/u9/u10 and igb interfaces |

**Linux-Unix**

| Device | Notes |
| ---------------------------------------- | ----- |
| RedHat flavors | |
| Debian flavors | |
| Solaris | |
| HPUX 11.31 | |

**Vmware guests**

| Device | Notes |
Expand Down

0 comments on commit 5ad7ce0

Please sign in to comment.