mib2zabbix/README.md

82 lines
3 KiB
Markdown
Raw Normal View History

2016-06-01 15:33:08 +08:00
# mib2zabbix
2016-06-01 15:47:54 +08:00
This Perl script will generate a Zabbix Template in XML format from an OID tree
in a SNMP MIB file.
2016-06-01 15:33:08 +08:00
### Usage
mib2zabbix.pl [ -l | -t ] -o <OID> [OPTIONS]...
Export loaded SNMP MIB OIDs to Zabbix Template XML
--export-maps export value maps directly to Zabbix database
-t, --template generate a Zabbix template
-f, --filename=PATH output filename (default: stdout)
-N, --name=STRING template name (default: OID label)
-G, --group=STRING template group (default: 'Templates')
-e, --enable-items enable template items (default: disabled)
* enable with caution *
-o, --oid=STRING OID tree root to export
-v, --snmpver=1|2|3 SNMP version (default: 1)
-p, --port=PORT SNMP UDP port number (default: 161)
SNMP Version 1 or 2c specific
-c, --community=STRING SNMP community string (default: 'public')
SNMP Version 3 specific
-L, --level=LEVEL security level (noAuthNoPriv|authNoPriv|authPriv)
-n, --context=CONTEXT context name
-u, --username=USERNAME security name
-a, --auth=PROTOCOL authentication protocol (MD5|SHA)
-A, --authpass=PASSPHRASE authentication protocol passphrase
-x, --privacy=PROTOCOL privacy protocol (DES|AES)
-X, --privpass=PASSPHRASE privacy passphrase
--check-delay=SECONDS check interval in seconds (default: 300)
--disc-delay=SECONDS discovery interval in seconds (default: 86400)
--history=DAYS history retention in days (default: 365)
--trends=DAYS trends retention in days (default: 3650)
-h, --help print this message
### Requirements
* Perl v5+
* Pod::Usage
* XML::Simple
* Net-SNMP
* Correctly configured [MIB files](http://net-snmp.sourceforge.net/tutorial/tutorial-5/commands/mib-options.html)
### Translations
* Scalar OID -> Zabbix SNMP Item
* Table OID -> Zabbix SNMP Discovery Rule
* Table Column OID -> Zabbix Discovery Prototype
* Trap/Notification OID -> Zabbix SNMP Trap Item
* OID Enums -> Zabbix Value Map
2016-06-01 15:47:54 +08:00
### License
mib2zabbix - SNMP Template Generator for Zabbix
Copyright (C) 2016 - Ryan Armstrong <ryan@cavaliercoder.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.