diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..b444d67 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,22 @@ +v0.2.3 fixed: typo's + +v0.2.2 small fixes for 0.8.7 + changed: + - ss_65xx_sfp.php + +v0.2.1 added: LICENSE + fixed: typo's + changed: + - ss_65xx_sfp.php + - cisco_sfp.xml + +v0.2b added descr (ifAlias) to query types + changed: + - ss_65xx_sfp.php + +v0.1.1 fixed small typo's + changed: + - cacti_data_query_cisco_65xx_sfp_statistics.xml + - ss_65xx_sfp.php + +v0.1 initial release diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..e764efd --- /dev/null +++ b/INSTALL @@ -0,0 +1,23 @@ +Cisco SFP statistics for cacti (c) 2007-2008 sodium + +INSTALLATION : +1. copy cisco_sfp.xml to [$cacti_home]/resources/script_server directory +2. copy ss_65xx_sfp.php to [$cacti_home]/scripts directory +3. import the following template (within cacti) + - cacti_data_query_cisco_65xx_sfp_statistics.xml +4. add Cisco - 65xx - SFP statistics to your catalyst host template +or add it to the "Associated Data Queries" in the devices list. + +That's it... + +Note: if your are running the thold plugin you should patch it (thold +baseline function can't handle negative numbers (you do NOT have to patch +if you only do high/low watermark checking. + +I have included the path file for thold. (v0.3.9) +to appy patch: cacti@nms:/usr/share/cacti/plugins/thold$ patch -p0 < thold_functions-0.3.9.patch + +Assumptions made within the code: +- When the script can not read the value from the SFP -40 (dBm) is returned +- snmp_port = 161 +- snmp_timeout = 5000 ms diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..589ce5b --- /dev/null +++ b/LICENSE @@ -0,0 +1,280 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md index cf3f173..5ea345a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# cisco-sfp +# cisco-sfp for cacti 0.8.x This is to host code for https://forums.cacti.net/viewtopic.php?f=19&t=23089 for others + +Cisco SFP statistics for cacti (c) 2007-2008 sodium + +This code is compatibile with cacti 0.8.x. There may be issues with the 1.x versions of cacti. + +## INSTALLATION : +1. copy cisco_sfp.xml to [$cacti_home]/resources/script_server directory +2. copy ss_65xx_sfp.php to [$cacti_home]/scripts directory +3. import the following template (within cacti) `cacti_data_query_cisco_65xx_sfp_statistics.xml` +4. add Cisco - 65xx - SFP statistics to your catalyst host template or add it to the "Associated Data Queries" in the devices list. + +That's it... + +## THOLD plugin compatibility + +Note: if your are running the thold plugin you should patch it (thold baseline function can't handle negative numbers (you do NOT have to patch if you only do high/low watermark checking. + +I have included the path file for thold. (v0.3.9) to appy patch: cacti@nms:/usr/share/cacti/plugins/thold$ patch -p0 < thold_functions-0.3.9.patch + +Assumptions made within the code: +- When the script can not read the value from the SFP -40 (dBm) is returned +- snmp_port = 161 +- snmp_timeout = 5000 ms diff --git a/cacti_data_query_cisco_65xx_sfp_statistics.xml b/cacti_data_query_cisco_65xx_sfp_statistics.xml new file mode 100644 index 0000000..06f78cd --- /dev/null +++ b/cacti_data_query_cisco_65xx_sfp_statistics.xml @@ -0,0 +1,362 @@ + + + Cisco - 65xx - SFP statistics + Cisco - 65xx - SFP statistics + <path_cacti>/resource/script_server/cisco_sfp.xml + hash_030013332111d8b54ac8ce939af87a7eac0c06 + + + Cisco - 65xx - SFP statistics + hash_000013d28b86240a5752f83b5ee0fde11ab178 + + + SensorTXPower + hash_01001336235416ea6d526678a4e2470baf7b47 + hash_080013b77e19e466d292239d67fa5fd8f1b3f4 + + + SensorRXPower + hash_01001336235416ea6d526678a4e2470baf7b47 + hash_080013c02d990615e0e8544cbba54721826809 + + + + + + + + + + + Get Script Server Data (Indexed) + 6 + + + + Index Type + + + + index_type + in + index_type + + + Index Value + + + + index_value + in + index_value + + + Output Type ID + + + + output_type + in + output_type + + + Output Value + on + + + + out + output + + + + + Get Script Data (Indexed) + 4 + + + + Index Type + + + + index_type + in + index_type + + + Index Value + + + + index_value + in + index_value + + + Output Type ID + + + + output_type + in + output_type + + + Output Value + on + + + + out + output + + + + + Cisco - SFP statistics (dBm) + + + |host_description| SFP |query_device| - |query_descr| + + 1 + + 350 + + 650 + + on + + 2 + + + + + + on + + on + + 10 + + -40 + + 1000 + + + + 0 + + dBm + + + + hash_080013b77e19e466d292239d67fa5fd8f1b3f4 + 002A97 + 4 + 1 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + OpticalTxPower + + 1 + + + hash_080013b77e19e466d292239d67fa5fd8f1b3f4 + 0 + 9 + 4 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + Current: + + 2 + + + hash_080013b77e19e466d292239d67fa5fd8f1b3f4 + 0 + 9 + 1 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + Average: + + 3 + + + hash_080013b77e19e466d292239d67fa5fd8f1b3f4 + 0 + 9 + 3 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + Maximum: + on + 4 + + + hash_080013c02d990615e0e8544cbba54721826809 + 00CF00 + 4 + 1 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + OpticalRxPower + + 5 + + + hash_080013c02d990615e0e8544cbba54721826809 + 0 + 9 + 4 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + Current: + + 6 + + + hash_080013c02d990615e0e8544cbba54721826809 + 0 + 9 + 1 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + Average: + + 7 + + + hash_080013c02d990615e0e8544cbba54721826809 + 0 + 9 + 3 + 0 + + hash_0600136bf08fdd497f43bb9ba34743ad1bcc94 + Maximum: + on + 8 + + + + + Data Source [sfp_tx] + + task_item_id + hash_0000137007836117f60c437b1f5cb67cddbe05|hash_000013ddc646681bbcd109379c1a64bc2e7623|hash_000013b9c7b578859f5c9bca54bd20c56742a0|hash_0000138c02b28b31623e526186de01e63a3aee + + + Data Source [sfp_rx] + + task_item_id + hash_0000133356ab3f7c36a77cb085aa5e0557eff1|hash_0000133090191545315934ac6ff62ba2230f72|hash_0000137e6cbeecb942772d1f08ed674df58959|hash_000013e78def52d478d9e25295c13ce6b185b3 + + + + + Cisco 65xx - SFP statistics + + + |host_description| - SFP Statistics - |query_device| + hash_03001380e9e4c4191a5da189ae26d0e237f015 + + + 300 + + on + hash_150013c21df5178e5c955013591239eb0afd46|hash_1500130d9c0af8b8acdc7807943937b3208e29|hash_1500136fc2d038fb42950138b0ce3e9874cc60|hash_150013e36f3adb9f152adfa5dc50fd2b23337e + + + + + sfp_tx + + -40 + + 10 + + 1 + + 600 + + 0 + + + + sfp_rx + + -40 + + 10 + + 1 + + 600 + + 0 + + + + + hash_07001374af2e42dc12956c4817c2ef5d9983f9 + + + + + hash_0700133b7caa46eb809fc238de6ef18b6e10d5 + + + + + hash_070013d39556ecad6166701bfb0e28c5a11108 + + + + + + + Daily (5 Minute Average) + 0.5 + 1 + 600 + 86400 + 1|2|3|4 + + + Weekly (30 Minute Average) + 0.5 + 6 + 700 + 604800 + 1|2|3|4 + + + Monthly (2 Hour Average) + 0.5 + 24 + 775 + 2678400 + 1|2|3|4 + + + Yearly (1 Day Average) + 0.5 + 288 + 797 + 33053184 + 1|2|3|4 + + + Optical Power + %2.1lf + + diff --git a/cisco_sfp.xml b/cisco_sfp.xml new file mode 100644 index 0000000..f790cb1 --- /dev/null +++ b/cisco_sfp.xml @@ -0,0 +1,42 @@ + + Get Cisco SFP Statistics + |path_php_binary| -q |path_cacti|/scripts/ss_65xx_sfp.php + ss_sfp + |host_hostname| |host_snmp_community| |host_snmp_version| + index + query + get + device + alphabetic + |chosen_order_field| + : + + + Interface + input + index + + + Operational status + input + status + + + Interface Description + input + descr + + + SensorTXPower + output + tx + + + SensorRXPower + output + rx + + + + + diff --git a/ss_65xx_sfp.php b/ss_65xx_sfp.php new file mode 100644 index 0000000..aef514f --- /dev/null +++ b/ss_65xx_sfp.php @@ -0,0 +1,123 @@ + diff --git a/thold_functions-0.3.9.patch b/thold_functions-0.3.9.patch new file mode 100644 index 0000000..3f0b09a --- /dev/null +++ b/thold_functions-0.3.9.patch @@ -0,0 +1,25 @@ +--- thold_functions.php.orig 2008-01-03 17:58:20.000000000 +0100 ++++ thold_functions.php 2008-01-25 11:05:24.000000000 +0100 +@@ -491,18 +491,18 @@ + return -1; // Baseline reference value not yet established + } + $current_value = get_current_value($rra_id,$ds); +- $ref_value_max = round(max($ref_values)); +- $ref_value_min = round(min($ref_values)); ++ $ref_value_max = max($ref_values); ++ $ref_value_min = min($ref_values); + + $blt_low = false; + $blt_high = false; + + if($pct_down != "") { +- $blt_low = round($ref_value_min - ($ref_value_min * $pct_down / 100)); ++ $blt_low = ($ref_value_min - abs($ref_value_min * $pct_down / 100)); + } + + if($pct_up != "") { +- $blt_high = round($ref_value_max + ($ref_value_max * $pct_up / 100)); ++ $blt_high = ($ref_value_max + abs($ref_value_max * $pct_up / 100)); + } + + $failed = 0;