Skip to content

Commit 57c7fac

Browse files
intellitrend-teamintellitrend-team
committed
[INIT] Initial commit
0 parents  commit 57c7fac

10 files changed

+873
-0
lines changed

‎LICENSE

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# IntelliTrend Zabbix CSV Host Importer
2+
3+
This is a Zabbix frontend module that provides a simplified host import via CSV files.
4+
5+
![csv-host-importer](./images/csv-host-importer.png)
6+
7+
## License
8+
9+
This software is licensed under the GNU Lesser General Public License v3.0.
10+
11+
## Changelog
12+
13+
### Version 5.0.2
14+
15+
* Added support for templates
16+
17+
### Version 5.0.1
18+
19+
* Improved validation of CSV input
20+
21+
### Version 5.0.0
22+
23+
* Initial public release
24+
25+
## Requirements
26+
27+
- Zabbix 5.4
28+
- File write access to the Zabbix frontend server
29+
- Super admin permissions for the Zabbix users that want to use the frontend module
30+
31+
## Installation
32+
33+
For Debian and Ubuntu server, the Zabbix Frontend modules are usually placed in ``/usr/share/zabbix/modules/``.
34+
35+
Copy the folder `modules/csv-host-importer` to `/usr/share/zabbix/modules/csv-host-importer` on the Zabbix frontend web server.
36+
37+
Then go to `Administration`, `General`, `Modules`, click `Scan directory` and enable the new module in the list.
38+
39+
## Usage
40+
41+
Once the frontend module is activated, a new menu entry `Host CSV Importer` should appear under `Configuration`.
42+
43+
You can download an example CSV file from there or use the [example.csv](./example.csv) from the repo and edit the list to your liking.
44+
45+
Here is a list of supported CSV columns:
46+
47+
| Name | Purpose | Optional |
48+
| ------------ | ------------------------------------------------------------ | -------- |
49+
| NAME | Host name. | ❌ |
50+
| VISIBLE_NAME | Host visible name. | ✔ |
51+
| HOST_GROUPS | List of host group names, separated by a comma. Missing host groups are created automatically. | ❌ |
52+
| TEMPLATES | List of template names to assign to the host, separated by a comma. Templates must exist with the specified name. | ✔ |
53+
| AGENT_IP | Interface: Zabbix Agent IP address. | ✔ |
54+
| AGENT_DNS | Interface: Zabbix Agent DNS name. | ✔ |
55+
| SNMP_IP | Interface: SNMP IP address. | ✔ |
56+
| SNMP_DNS | Interface: SNMP DNS name. | ✔ |
57+
| SNMP_VERSION | Interface: SNMP version number (1, 2 or 3). | ✔ |
58+
| DESCRIPTION | Host description field. | ✔ |
59+
60+
Additional hints:
61+
62+
* The columns are case-insensitive, so ``NAME``, ``name`` and ``NaMe`` are all valid.
63+
* The columns must be in the first line of the CSV file.
64+
* The separator character must be ";".
65+
66+
The CSV file can then imported in the same menu entry. You get a chance to preview the host list before the actual import.
67+

‎example.csv

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
NAME;VISIBLE_NAME;HOST_GROUPS;TEMPLATES;AGENT_IP;AGENT_DNS;SNMP_IP;SNMP_DNS;SNMP_VERSION;DESCRIPTION
2+
example1;Example Host Agent;First host group, second host group;Linux by Zabbix agent;127.0.0.1;localhost;;;;Example Zabbix Agent host
3+
example2;Example Host SNMP;Third host group;Generic SNMP;;;127.0.0.1;localhost;2;Example SNMPv2 host

‎images/csv-host-importer.png

11.9 KB
Loading

‎modules/csv-host-importer/Module.php

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?php
2+
/**
3+
* Zabbix CSV Import Frontend Module
4+
*
5+
* @version 5.0.2
6+
* @author Wolfgang Alper <wolfgang.alper@intellitrend.de>
7+
* @copyright IntelliTrend GmbH, https://www.intellitrend.de
8+
* @license GNU Lesser General Public License v3.0
9+
*
10+
* You can redistribute this library and/or modify it under the terms of
11+
* the GNU LGPL as published by the Free Software Foundation,
12+
* either version 3 of the License, or any later version.
13+
* However you must not change author and copyright information.
14+
*/
15+
16+
declare(strict_types = 1);
17+
18+
namespace Modules\Ichi;
19+
20+
use APP;
21+
use CController as CAction;
22+
23+
/**
24+
* Please see Core\CModule class for additional reference.
25+
*/
26+
class Module extends \Core\CModule {
27+
28+
/**
29+
* Initialize module.
30+
*/
31+
public function init(): void {
32+
// Initialize main menu (CMenu class instance).
33+
APP::Component()->get('menu.main')->findOrAdd(_('Configuration'))->getSubmenu()->add((new \CMenuItem(_('Host CSV Importer')))->setAction('ichi.import'));
34+
}
35+
36+
/**
37+
* Event handler, triggered before executing the action.
38+
*
39+
* @param CAction $action Action instance responsible for current request.
40+
*/
41+
public function onBeforeAction(CAction $action): void {
42+
}
43+
44+
/**
45+
* Event handler, triggered on application exit.
46+
*
47+
* @param CAction $action Action instance responsible for current request.
48+
*/
49+
public function onTerminate(CAction $action): void {
50+
}
51+
}

0 commit comments

Comments
 (0)