slapos-testing: add missing eggs.
[slapos.git] / software / zabbix-agent / README.rst
1 ============================
2 Zabbix Agent Software Release
3 =============================
4
5 This Software Release allows to deploy a Zabbix Agent that will connect
6 to an existing Zabbix Server.
7
8 Please see http://www.zabbix.com/ for more informations.
9
10
11 Mandatory parameters
12 ====================
13
14 hostname
15 --------
16 Name of the machine probed by the agent.
17
18 server
19 ------
20 list of Zabbix servers to connect to, comma-seperated.
21
22 Optional parameters
23 ===================
24
25 custom-user-parameter
26 ---------------------
27 Add custom UserParameter(s) lines to the Zabbix Agent configuration file.
28
29
30 Examples of instance parameters XML
31 ===================================
32
33 Example 1
34 ~~~~~~~~~
35
36 Simple request: just request a new instance of it, with the following parameters::
37
38   <?xml version="1.0" encoding="utf-8"?>
39     <instance>
40     <parameter id="server">REPLACE BY IP(v6) OF ZABBIX SERVER</parameter>
41     <parameter id="hostname">REPLACE BY DESIRED HOSTNAME OF MACHINE</parameter>
42   </instance>
43
44 Example 2
45 ~~~~~~~~~
46
47 Deploy a Zabbix Agent instance for machine named "mymachine" connecting to a Zabbix server accessible from 2001:41d0:1:9b1a::1::
48
49   <?xml version="1.0" encoding="utf-8"?>
50     <instance>
51     <parameter id="server">2001:41d0:1:9b1a::1</parameter>
52     <parameter id="hostname">mymachine</parameter>
53   </instance>
54
55 Example 3
56 ~~~~~~~~~
57
58 Deploy a Zabbix Agent instance for machine named "mymachine" connecting to a Zabbix server accessible from 2001:41d0:1:9b1a::1, with several custom parameters::
59
60   <?xml version="1.0" encoding="utf-8"?>
61   <instance>
62     <parameter id="server">2001:41d0:1:9b1a::1</parameter>
63     <parameter id="hostname">mymachine</parameter>
64     <parameter id="custom-user-parameter">
65     UserParameter=custom_random,echo $RANDOM
66     UserParameter=custom_date,date
67     </parameter>
68   </instance>
69