1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>5.2. Makros verstehen und wie sie arbeiten</title>
<link rel="stylesheet" href="../stylesheets/icinga-docs.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<meta name="keywords" content="Supervision, Icinga, Nagios, Linux">
<link rel="home" href="index.html" title="Icinga Version 1.14 Dokumentation">
<link rel="up" href="ch05.html" title="Kapitel 5. Die Grundlagen">
<link rel="prev" href="plugins.html" title="5.1. Icinga Plugins">
<link rel="next" href="macrolist.html" title="5.3. Standard-Makros in Icinga">
<script src="../js/jquery-min.js" type="text/javascript"></script><script src="../js/icinga-docs.js" type="text/javascript"></script>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<CENTER><IMG src="../images/logofullsize.png" border="0" alt="Icinga" title="Icinga"></CENTER>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">5.2. Makros verstehen und wie sie arbeiten</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="plugins.html">Zurück</a> </td>
<th width="60%" align="center">Kapitel 5. Die Grundlagen</th>
<td width="20%" align="right"> <a accesskey="n" href="macrolist.html">Weiter</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="section" title="5.2. Makros verstehen und wie sie arbeiten">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="macros"></a>5.2. Makros verstehen und wie sie arbeiten</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section">5.2.1. <a href="macros.html#introduction">Makros</a></span></dt>
<dt><span class="section">5.2.2. <a href="macros.html#howitworks">Makroersetzungen - wie Makros arbeiten</a></span></dt>
<dt><span class="section">5.2.3. <a href="macros.html#hostaddressexample">Beispiel 1: Host-Address Makro</a></span></dt>
<dt><span class="section">5.2.4. <a href="macros.html#commandargexample">Beispiel 2: Befehlsargument-Makros</a></span></dt>
<dt><span class="section">5.2.5. <a href="macros.html#ondemand">On-Demand-Makros</a></span></dt>
<dt><span class="section">5.2.6. <a href="macros.html#ondemandgroup">On-Demand-Gruppen-Makros</a></span></dt>
<dt><span class="section">5.2.7. <a href="macros.html#customvar">Benutzervariablen-Makros</a></span></dt>
<dt><span class="section">5.2.8. <a href="macros.html#cleaning">Makrobereinigung</a></span></dt>
<dt><span class="section">5.2.9. <a href="macros.html#environmentvars">Makros als Umgebungsvariablen</a></span></dt>
<dt><span class="section">5.2.10. <a href="macros.html#availablelist">Verfügbare Makros</a></span></dt>
</dl></div>
<div class="section" title="5.2.1. Makros">
<div class="titlepage"><div><div><h3 class="title">
<a name="introduction"></a>5.2.1. Makros</h3></div></div></div>
<p>Eine der Haupteigenschaften, die Icinga so flexibel machen, ist die Fähigkeit, Makros in Befehlsdefinitionen zu benutzen.
Makros erlauben Ihnen, Bezug auf Informationen von Hosts, Services und anderen Quellen zu nehmen.</p>
</div>
<div class="section" title="5.2.2. Makroersetzungen - wie Makros arbeiten">
<div class="titlepage"><div><div><h3 class="title">
<a name="howitworks"></a>5.2.2. Makroersetzungen - wie Makros arbeiten</h3></div></div></div>
<p>Bevor Icinga einen Befehl ausführt, ersetzt es jedes Makro, das es in der Befehlsdefinition findet, durch den
entsprechenden Wert. Diese Makroersetzung erfolgt für alle Arten von Befehlen, die Icinga ausführt - Host- und Service-Checks,
Benachrichtigungen, Eventhandler usw.</p>
<p>Bestimmte Makros können wieder Makros enthalten. Dazu zählen die Makros $HOSTNOTES$, $HOSTNOTESURL$, $HOSTACTIONURL$,
$SERVICENOTES$, $SERVICENOTESURL$ und $SERVICEACTIONURL$.</p>
</div>
<div class="section" title="5.2.3. Beispiel 1: Host-Address Makro">
<div class="titlepage"><div><div><h3 class="title">
<a name="hostaddressexample"></a>5.2.3. Beispiel 1: Host-Address Makro</h3></div></div></div>
<p>Wenn Sie Host- und Service-Makros in Befehlsdefinitionen benutzen, beziehen sich diese auf Werte für den Host oder Service, für
den der Befehl ausgeführt wird. Nehmen wir ein Beispiel. Angenommen, wir benutzen eine Host-Definition und einen
<span class="emphasis"><em>check_ping</em></span>-Befehl, die wie folgt definiert sind:</p>
<pre class="programlisting"> define host{
host_name linuxbox
address 192.168.1.2
check_command check_ping
...
}
define command{
command_name check_ping
command_line /usr/local/icinga/libexec/check_ping -H $HOSTADDRESS$ -w 100.0,25% -c 200.0,50%
}</pre>
<p>die erweiterte/endgültige auszuführende Befehlszeile für die Host-Prüfung würde so aussehen:</p>
<pre class="screen">$> /usr/local/icinga/libexec/check_ping -H 192.168.1.2 -w 100.0,25% -c 200.0,50%</pre>
<p>Ziemlich einfach, stimmt's? Die Schönheit liegt darin, dass Sie eine einzelne Befehlsdefinition für eine unbegrenzte Zahl von
Hosts nutzen können. Jeder Host kann mit der selben Befehlsdefinition geprüft werden, weil jede Host-Adresse automatisch vor der
Ausführung in der Befehlszeile ersetzt wird.</p>
</div>
<div class="section" title="5.2.4. Beispiel 2: Befehlsargument-Makros">
<div class="titlepage"><div><div><h3 class="title">
<a name="commandargexample"></a>5.2.4. Beispiel 2: Befehlsargument-Makros</h3></div></div></div>
<p>Sie können auch Argumente an Befehle übergeben, was recht handlich ist, wenn Sie Ihre Befehlsdefinitonen ziemlich generisch halten
möchten. Argumente werden in der Objektdefinition (d.h. Host oder Service) angegeben, indem sie durch Ausrufezeichen (!) vom
Befehlsnamen getrennt werden:</p>
<pre class="programlisting"> define service{
host_name linuxbox
service_description PING
check_command check_ping!200.0,25%!400.0,50%
...
}</pre>
<p>Im obigen Beispiel hat der Service-Check zwei Argumente (auf die mit <a class="link" href="macrolist.html#macrolist-arg">$ARGn$</a>-Makros
zugegriffen werden kann). Das $ARG1$-Makro wird "<span class="color"><font color="red">200.0,50%</font></span>" und $ARG2$ wird "<span class="color"><font color="red">400.0,25%</font></span>" (beide ohne Anführungszeichen). Angenommen, wir benutzen die vorher angegebene
Host-Definiton und einen wie folgt definierten <span class="emphasis"><em>check_ping</em></span>-Befehl:</p>
<pre class="programlisting"> define command{
command_name check_ping
command_line /usr/local/icinga/libexec/check_ping -H $HOSTADDRESS$ -w $ARG1$ -c $ARG2$
}</pre>
<p>die erweiterte/endgültige auszuführende Befehlszeile für die Service-Prüfung würde so aussehen:</p>
<pre class="screen">$> /usr/local/icinga/libexec/check_ping -H 192.168.1.2 -w 200.0,25% -c 400.0,50%</pre>
<div class="tip" title="Tipp" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tipp]" src="../images/tip.png"></td>
<th align="left">Tipp</th>
</tr>
<tr><td align="left" valign="top">
<p><a name="macros-bang"></a>Falls Sie Ausrufezeichen (!) in Ihren Argumenten übergeben müssen, dann können Sie das tun, indem
Sie diese mit einem Backslash (\) maskieren. Falls Sie Backslashes in Ihren Argumenten einsetzen müssen, sind diese ebenfalls mit
Backslashes zu maskieren.</p>
</td></tr>
</table></div>
<div class="tip" title="Tipp" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tipp]" src="../images/tip.png"></td>
<th align="left">Tipp</th>
</tr>
<tr><td align="left" valign="top">
<p><a name="macros-semicolon"></a>Falls Sie ein Semikolon (;) in Ihren Argumenten übergeben müssen, dann können Sie das nicht
tun, indem Sie das Zeichen in der Definition verwenden, weil es als Start eines Kommentars angesehen wird. Sie definieren stattdessen
eine $USER$-Variable in der Ressource-Datei und benutzen diese in Ihrer Definition.</p>
<p>Ressource File</p>
<pre class="programlisting">$USER255$=;</pre>
<p>Command-Definition</p>
<pre class="programlisting">define command{
command_name ...
command_line $USER1$/your_plugin "Ein Text mit einem Semikolon ($USER255$)"
}</pre>
</td></tr>
</table></div>
</div>
<div class="section" title="5.2.5. On-Demand-Makros">
<div class="titlepage"><div><div><h3 class="title">
<a name="ondemand"></a>5.2.5. On-Demand-Makros</h3></div></div></div>
<p>Wenn Sie Host- und Service-Makros in Ihren Befehlsdefinitionen benutzen, dann beziehen sie sich normalerweise auf Werte des Hosts
oder Service, für den der Befehl ausgeführt wird. Wenn beispielsweise eine Host-Prüfung für einen Host namens "linuxbox" ausgeführt
wird, werden sich all die <a class="link" href="macrolist.html" title="5.3. Standard-Makros in Icinga">Standard-Host-Makros</a> auf Werte für diesen Host beziehen ("linuxbox").</p>
<p>Wenn Sie möchten, dass sich die Werte eines Befehls auf einen anderen Host oder Service beziehen (für den der Befehl nicht
ausgeführt wird), dann können Sie die sogenannten "On-Demand-Makros" benutzen. On-Demand-Makros sehen wie normale Makros aus, außer der
Tatsache, dass sie einen Bezeichner für den Host oder Service enthalten, von dem sie ihren Wert erhalten sollen. Hier das grundsätzliche
Format von On-Demand-Makros:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>$<span class="emphasis"><em>HOSTMACRONAME</em></span>:<span class="emphasis"><em>host_name</em></span>$</p>
</li>
<li class="listitem">
<p>$<span class="emphasis"><em>SERVICEMACRONAME</em></span>:<span class="emphasis"><em>host_name</em></span>:<span class="emphasis"><em>service_description</em></span>$</p>
</li>
</ul></div>
<p>Ersetzen Sie <span class="emphasis"><em>HOSTMACRONAME</em></span> und <span class="emphasis"><em>SERVICEMACRONAME</em></span> durch den Namen eines der Standard-Host-
oder Service-Makros, die <a class="link" href="macrolist.html" title="5.3. Standard-Makros in Icinga">hier</a> zu finden sind.</p>
<p>Beachten Sie, dass der Makroname durch einen Doppelpunkt (:) vom Host- oder Service-Bezeichner getrennt ist. Für
On-Demand-Service-Makros besteht der Service-Bezeichner aus einem Host-Namen und einer Service-Beschreibung - sie sind ebenfalls durch
einen Doppelpunkt (:) voneinander getrennt.</p>
<p><span class="inlinemediaobject"><img src="../images/tip.gif"></span> Hinweis: On-Demand-Service-Makros können ein leeres Host-Namen-Feld enthalten. In diesem Fall wird automatisch
der Name des Hosts benutzt, der mit dem Service verbunden ist.</p>
<p>Beispiele für On-Demand-Host- und Service-Makros folgen:</p>
<pre class="screen"> $HOSTDOWNTIME:myhost$ <--- On-Demand-Host-Makro
$SERVICESTATEID:novellserver:DS Database$ <--- On-Demand-Service-Makro
$SERVICESTATEID::CPU Load$ <--- On-Demand-Service-Makro mit leerem Host-Namen-Feld</pre>
<p>On-Demand-Makros gibt es auch für hostgroup-, servicegroup-, contact- und contactgroup-Makros. Zum Beispiel:</p>
<pre class="screen"> $CONTACTEMAIL:john$ <--- On-Demand-Contact-Makro
$CONTACTGROUPMEMBERS:linux-admins$ <--- On-Demand-Contactgroup-Makro
$HOSTGROUPALIAS:linux-servers$ <--- On-Demand-Hostgroup-Makro
$SERVICEGROUPALIAS:DNS-Cluster$ <--- On-Demand-Servicegroup-Makro</pre>
</div>
<div class="section" title="5.2.6. On-Demand-Gruppen-Makros">
<div class="titlepage"><div><div><h3 class="title">
<a name="ondemandgroup"></a>5.2.6. On-Demand-Gruppen-Makros</h3></div></div></div>
<p>Sie können die Werte eines Makros über alle Kontakte, Hosts oder Services in einer bestimmten Gruppe mit einem speziellen Format
Ihrer On-Demand-Makrodeklaration erhalten. Sie tun dies, indem Sie auf eine bestimmte Hostgruppe, Servicegruppe oder Kontaktgruppe in
einem On-Demand-Makro verweisen und zwar wie folgt:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>$<span class="emphasis"><em>HOSTMACRONAME</em></span>:<span class="emphasis"><em>hostgroup_name</em></span>:<span class="emphasis"><em>delimiter</em></span>$</p>
</li>
<li class="listitem">
<p>$<span class="emphasis"><em>SERVICEMACRONAME</em></span>:<span class="emphasis"><em>servicegroup_name</em></span>:<span class="emphasis"><em>delimiter</em></span>$</p>
</li>
<li class="listitem">
<p>$<span class="emphasis"><em>CONTACTMACRONAME</em></span>:<span class="emphasis"><em>contactgroup_name</em></span>:<span class="emphasis"><em>delimiter</em></span>$</p>
</li>
</ul></div>
<p>Ersetzen Sie <span class="emphasis"><em>HOSTMACRONAME</em></span>, <span class="emphasis"><em>SERVICEMACRONAME</em></span> und <span class="emphasis"><em>CONTACTMACRONAME</em></span>
durch den Namen eines der Standard-Host-, Service- oder Kontaktmakros, die Sie <a class="link" href="macrolist.html" title="5.3. Standard-Makros in Icinga">hier</a> finden. Der
Begrenzer (delimiter), den Sie angeben, wird benutzt, um Makrowerte der einzelnen Gruppenmitglieder von einander zu trennen.</p>
<p>Das folgende Makro wird beispielsweise eine komma-separierte Liste von Host-Status-IDs zurückliefern, die Mitglieder der
<span class="emphasis"><em>hg1</em></span>-Hostgruppe sind:</p>
<pre class="screen"> $HOSTSTATEID:hg1:,$</pre>
<p>Diese Makrodefinition wird etwas zurückliefern, was etwa so aussieht:</p>
<pre class="screen"> 0,2,1,1,0,0,2</pre>
</div>
<div class="section" title="5.2.7. Benutzervariablen-Makros">
<div class="titlepage"><div><div><h3 class="title">
<a name="customvar"></a>5.2.7. Benutzervariablen-Makros</h3></div></div></div>
<p>Jede <a class="link" href="customobjectvars.html" title="3.5. Maßgeschneiderte Objektvariablen">Benutzerobjekt-Variable</a>, die Sie in Host-, Service- oder Contact-Definitionen
einsetzen, ist auch in Makros verfügbar. Benutzervariablen-Makros werden wie folgt benannt:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>$_HOST<span class="emphasis"><em>varname</em></span>$</p>
</li>
<li class="listitem">
<p>$_SERVICE<span class="emphasis"><em>varname</em></span>$</p>
</li>
<li class="listitem">
<p>$_CONTACT<span class="emphasis"><em>varname</em></span>$</p>
</li>
</ul></div>
<p>Nehmen Sie die folgende Host-Definition mit einer "_MACADDRESS" genannten Benutzervariablen...</p>
<pre class="programlisting"> define host{
host_name linuxbox
address 192.168.1.1
_MACADDRESS 00:01:02:03:04:05
...
}</pre>
<p>Die Benutzervariable _MACADRESS wäre in einem Makro <span class="color"><font color="red">$_HOSTMACADDRESS$</font></span> verfügbar.
Weitere Informationen zu Benutzervariablen und wie sie in Makros eingesetzt werden können, finden Sie <a class="link" href="customobjectvars.html" title="3.5. Maßgeschneiderte Objektvariablen">hier</a>.</p>
</div>
<div class="section" title="5.2.8. Makrobereinigung">
<div class="titlepage"><div><div><h3 class="title">
<a name="cleaning"></a>5.2.8. Makrobereinigung</h3></div></div></div>
<p>Einige Makros werden von potenziell gefährlichen Shell-Metazeichen bereinigt, bevor Ersetzungen in Befehlen stattfinden. Welche
Zeichen aus den Makros entfernt werden, hängt von den Einstellungen der <a class="link" href="configmain.html#configmain-illegal_macro_output_chars">illegal_macro_output_chars</a>-Direktive ab. Die folgenden Makros werden von
potenziell gefährlichen Zeichen bereinigt:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-hostoutput">$HOSTOUTPUT$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-longhostoutput">$LONGHOSTOUTPUT$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-hostperfdata">$HOSTPERFDATA$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-hostackauthor">$HOSTACKAUTHOR$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-hostackcomment">$HOSTACKCOMMENT$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-serviceoutput">$SERVICEOUTPUT$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-longserviceoutput">$LONGSERVICEOUTPUT$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-serviceperfdata">$SERVICEPERFDATA$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-serviceackauthor">$SERVICEACKAUTHOR$</a></p>
</li>
<li class="listitem">
<p><a class="link" href="macrolist.html#macrolist-serviceackcomment">$SERVICEACKCOMMENT$</a></p>
</li>
</ol></div>
</div>
<div class="section" title="5.2.9. Makros als Umgebungsvariablen">
<div class="titlepage"><div><div><h3 class="title">
<a name="environmentvars"></a>5.2.9. Makros als Umgebungsvariablen</h3></div></div></div>
<p>Die meisten Makros werden als Umgebungsvariablen zur Verfügung gestellt, um einen einfachen Einsatz in Scripts oder Befehlen zu
ermöglichen, die von Icinga ausgeführt werden. Aus Gründen der Sicherheit und der Vernunft werden <a class="link" href="macrolist.html#macrolist-user">$USERn$</a> und "on-demand" Host- und Service-Makros <span class="underline">nicht</span> als
Umgebungsvariablen zur Verfügung gestellt.</p>
<p>Umgebungsvariablen, die Standard-Makros enthalten, werden ebenso wie ihre entsprechenden Makronamen benannt (<a class="link" href="macrolist.html" title="5.3. Standard-Makros in Icinga">hier</a> aufgeführt), wobei ihnen "ICINGA_" vorangestellt wird. Beispielsweise wäre das <a class="link" href="macrolist.html#macrolist-hostname">$HOSTNAME$</a>-Makro als Umgebungsvariable "ICINGA_HOSTNAME" verfügbar.</p>
</div>
<div class="section" title="5.2.10. Verfügbare Makros">
<div class="titlepage"><div><div><h3 class="title">
<a name="availablelist"></a>5.2.10. Verfügbare Makros</h3></div></div></div>
<p>Eine Liste aller in Icinga verfügbaren Makros sowie eine Tabelle, wann sie eingesetzt werden können, finden Sie <a class="link" href="macrolist.html" title="5.3. Standard-Makros in Icinga">hier</a>.</p>
<a class="indexterm" name="idm139734672720256"></a>
<a class="indexterm" name="idm139734672718528"></a>
<a class="indexterm" name="idm139734672716976"></a>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="plugins.html">Zurück</a> </td>
<td width="20%" align="center"><a accesskey="u" href="ch05.html">Nach oben</a></td>
<td width="40%" align="right"> <a accesskey="n" href="macrolist.html">Weiter</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">5.1. Icinga Plugins </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td>
<td width="40%" align="right" valign="top"> 5.3. Standard-Makros in Icinga</td>
</tr>
</table>
</div>
<P class="copyright">© 1999-2009 Ethan Galstad, 2009-2017 Icinga Development Team, https://www.icinga.com</P>
</body>
</html>
|
