]> granicus.if.org Git - icinga2/blob - doc/18-language-reference.md
Documentation: Reorganize Livestatus and alternative Frontends
[icinga2] / doc / 18-language-reference.md
1 # <a id="language-reference"></a> Language Reference
2
3 ## <a id="object-definition"></a> Object Definition
4
5 Icinga 2 features an object-based configuration format. You can define new
6 objects using the `object` keyword:
7
8     object Host "host1.example.org" {
9       display_name = "host1"
10
11       address = "192.168.0.1"
12       address6 = "::1"
13     }
14
15 In general you need to write each statement on a new line. Expressions started
16 with `{`, `(` and `[` extend until the matching closing character and can be broken
17 up into multiple lines.
18
19 Alternatively you can write multiple statements on a single line by separating
20 them with a semicolon:
21
22     object Host "host1.example.org" {
23       display_name = "host1"
24
25       address = "192.168.0.1"; address6 = "::1"
26     }
27
28 Each object is uniquely identified by its type (`Host`) and name
29 (`host1.example.org`). Some types have composite names, e.g. the
30 `Service` type which uses the `host_name` attribute and the name
31 you specified to generate its object name.
32
33 Exclamation marks (!) are not permitted in object names.
34
35 Objects can contain a comma-separated list of property
36 declarations. Instead of commas semicolons may also be used.
37 The following data types are available for property values:
38
39 All objects have at least the following attributes:
40
41 Attribute            | Description
42 ---------------------|-----------------------------
43 name                 | The name of the object. This attribute can be modified in the object definition to override the name specified with the `object` directive.
44 type                 | The type of the object.
45
46 ## Expressions
47
48 The following expressions can be used on the right-hand side of assignments.
49
50 ### <a id="numeric-literals"></a> Numeric Literals
51
52 A floating-point number.
53
54 Example:
55
56     27.3
57
58 ### <a id="duration-literals"></a> Duration Literals
59
60 Similar to floating-point numbers except for the fact that they support
61 suffixes to help with specifying time durations.
62
63 Example:
64
65     2.5m
66
67 Supported suffixes include ms (milliseconds), s (seconds), m (minutes),
68 h (hours) and d (days).
69
70 Duration literals are converted to seconds by the config parser and
71 are treated like numeric literals.
72
73 ### <a id="string-literals"></a> String Literals
74
75 A string.
76
77 Example:
78
79     "Hello World!"
80
81 Certain characters need to be escaped. The following escape sequences
82 are supported:
83
84 Character                 | Escape sequence
85 --------------------------|------------------------------------
86 "                         | \\"
87 \\                        | \\\\
88 &lt;TAB&gt;               | \\t
89 &lt;CARRIAGE-RETURN&gt;   | \\r
90 &lt;LINE-FEED&gt;         | \\n
91 &lt;BEL&gt;               | \\b
92 &lt;FORM-FEED&gt;         | \\f
93
94 In addition to these pre-defined escape sequences you can specify
95 arbitrary ASCII characters using the backslash character (\\) followed
96 by an ASCII character in octal encoding.
97
98 ### <a id="multiline-string-literals"></a> Multi-line String Literals
99
100 Strings spanning multiple lines can be specified by enclosing them in
101 {{{ and }}}.
102
103 Example:
104
105     {{{This
106     is
107     a multi-line
108     string.}}}
109
110 Unlike in ordinary strings special characters do not have to be escaped
111 in multi-line string literals.
112
113 ### <a id="boolean-literals"></a> Boolean Literals
114
115 The keywords `true` and `false` are used to denote truth values.
116
117 ### <a id="null-value"></a> Null Value
118
119 The `null` keyword can be used to specify an empty value.
120
121 ### <a id="dictionary"></a> Dictionary
122
123 An unordered list of key-value pairs. Keys must be unique and are
124 compared in a case-sensitive manner.
125
126 Individual key-value pairs must either be comma-separated or on separate lines.
127 The comma after the last key-value pair is optional.
128
129 Example:
130
131     {
132       address = "192.168.0.1"
133       port = 443
134     }
135
136 Identifiers may not contain certain characters (e.g. space) or start
137 with certain characters (e.g. digits). If you want to use a dictionary
138 key that is not a valid identifier you can enclose the key in double
139 quotes.
140
141 ### <a id="array"></a> Array
142
143 An ordered list of values.
144
145 Individual array elements must be comma-separated.
146 The comma after the last element is optional.
147
148 Example:
149
150     [ "hello", 42 ]
151
152 An array may simultaneously contain values of different types, such as
153 strings and numbers.
154
155 ### <a id="expression-operators"></a> Operators
156
157 The following operators are supported in expressions. The operators are by descending precedence.
158
159 Operator | Precedence | Examples (Result)                             | Description
160 ---------|------------|-----------------------------------------------|--------------------------------
161 ()       | 1          | (3 + 3) * 5                                   | Groups sub-expressions
162 ()       | 1          | Math.random()                                 | Calls a function
163 []       | 1          | a[3]                                          | Array subscript
164 .        | 1          | a.b                                           | Element access
165 !        | 2          | !"Hello" (false), !false (true)               | Logical negation of the operand
166 ~        | 2          | ~true (false)                                 | Bitwise negation of the operand
167 +        | 2          | +3                                            | Unary plus
168 -        | 2          | -3                                            | Unary minus
169 *        | 3          | 5m * 10 (3000)                                | Multiplies two numbers
170 /        | 3          | 5m / 5 (60)                                   | Divides two numbers
171 %        | 3          | 17 % 12 (5)                                   | Remainder after division
172 +        | 4          | 1 + 3 (4), "hello " + "world" ("hello world") | Adds two numbers; concatenates strings
173 -        | 4          | 3 - 1 (2)                                     | Subtracts two numbers
174 <<       | 5          | 4 << 8 (1024)                                 | Left shift
175 >>       | 5          | 1024 >> 4 (64)                                | Right shift
176 <        | 6         | 3 < 5 (true)                                  | Less than
177 >        | 6         | 3 > 5 (false)                                 | Greater than
178 <=       | 6         | 3 <= 3 (true)                                 | Less than or equal
179 >=       | 6         | 3 >= 3 (true)                                 | Greater than or equal
180 in       | 7          | "foo" in [ "foo", "bar" ] (true)              | Element contained in array
181 !in      | 7          | "foo" !in [ "bar", "baz" ] (true)             | Element not contained in array
182 ==       | 8         | "hello" == "hello" (true), 3 == 5 (false)     | Equal to
183 !=       | 8         | "hello" != "world" (true), 3 != 3 (false)     | Not equal to
184 &        | 9          | 7 & 3 (3)                                     | Binary AND
185 ^        | 10          | 17 ^ 12 (29)                                  | Bitwise XOR
186 &#124;   | 11          | 2 &#124; 3 (3)                                | Binary OR
187 &&       | 13         | true && false (false), 3 && 7 (7), 0 && 7 (0) | Logical AND
188 &#124;&#124; | 14     | true &#124;&#124; false (true), 0 &#124;&#124; 7 (7)| Logical OR
189 =        | 12         | a = 3                                         | Assignment
190 =>       | 15         | x => x * x (function with arg x)              | Lambda, for loop
191
192 ### <a id="function-calls"></a> Function Calls
193
194 Functions can be called using the `()` operator:
195
196     const MyGroups = [ "test1", "test" ]
197
198     {
199       check_interval = len(MyGroups) * 1m
200     }
201
202 A list of available functions is available in the [Library Reference](19-library-reference.md#library-reference) chapter.
203
204 ## <a id="dictionary-operators"></a> Assignments
205
206 In addition to the `=` operator shown above a number of other operators
207 to manipulate attributes are supported. Here's a list of all
208 available operators:
209
210 ### <a id="operator-assignment"></a> Operator =
211
212 Sets an attribute to the specified value.
213
214 Example:
215
216     {
217       a = 5
218       a = 7
219     }
220
221 In this example `a` has the value `7` after both instructions are executed.
222
223 ### <a id="operator-additive-assignment"></a> Operator +=
224
225 The += operator is a shortcut. The following expression:
226
227     {
228       a = [ "hello" ]
229       a += [ "world" ]
230     }
231
232 is equivalent to:
233
234     {
235       a = [ "hello" ]
236       a = a + [ "world" ]
237     }
238
239 ### <a id="operator-substractive-assignment"></a> Operator -=
240
241 The -= operator is a shortcut. The following expression:
242
243     {
244       a = 10
245       a -= 5
246     }
247
248 is equivalent to:
249
250     {
251       a = 10
252       a = a - 5
253     }
254
255 ### <a id="operator-multiply-assignment"></a> Operator \*=
256
257 The *= operator is a shortcut. The following expression:
258
259     {
260       a = 60
261       a *= 5
262     }
263
264 is equivalent to:
265
266     {
267       a = 60
268       a = a * 5
269     }
270
271 ### <a id="operator-dividing-assignment"></a> Operator /=
272
273 The /= operator is a shortcut. The following expression:
274
275     {
276       a = 300
277       a /= 5
278     }
279
280 is equivalent to:
281
282     {
283       a = 300
284       a = a / 5
285     }
286
287 ## <a id="indexer"></a> Indexer
288
289 The indexer syntax provides a convenient way to set dictionary elements.
290
291 Example:
292
293     {
294       hello.key = "world"
295     }
296
297 Example (alternative syntax):
298
299     {
300       hello["key"] = "world"
301     }
302
303 This is equivalent to writing:
304
305     {
306       hello += {
307         key = "world"
308       }
309     }
310
311 If the `hello` attribute does not already have a value it is automatically initialized to an empty dictionary.
312
313 ## <a id="template-imports"></a> Template Imports
314
315 Objects can import attributes from other objects.
316
317 Example:
318
319     template Host "default-host" {
320       vars.colour = "red"
321     }
322
323     template Host "test-host" {
324       import "default-host"
325
326       vars.colour = "blue"
327     }
328
329     object Host "localhost" {
330       import "test-host"
331
332       address = "127.0.0.1"
333       address6 = "::1"
334     }
335
336 The `default-host` and `test-host` objects are marked as templates
337 using the `template` keyword. Unlike ordinary objects templates are not
338 instantiated at run-time. Parent objects do not necessarily have to be
339 templates, however in general they are.
340
341 The `vars` dictionary for the `localhost` object contains all three
342 custom attributes and the custom attribute `colour` has the value `"blue"`.
343
344 Parent objects are resolved in the order they're specified using the
345 `import` keyword.
346
347 ## <a id="constants"></a> Constants
348
349 Global constants can be set using the `const` keyword:
350
351     const VarName = "some value"
352
353 Once defined a constant can be accessed from any file. Constants cannot be changed
354 once they are set.
355
356 Icinga 2 provides a number of special global constants. Some of them can be overridden using the `--define` command line parameter:
357
358 Variable            |Description
359 --------------------|-------------------
360 PrefixDir           |**Read-only.** Contains the installation prefix that was specified with cmake -DCMAKE_INSTALL_PREFIX. Defaults to "/usr/local".
361 SysconfDir          |**Read-only.** Contains the path of the sysconf directory. Defaults to PrefixDir + "/etc".
362 ZonesDir            |**Read-only.** Contains the path of the zones.d directory. Defaults to SysconfDir + "/zones.d".
363 LocalStateDir       |**Read-only.** Contains the path of the local state directory. Defaults to PrefixDir + "/var".
364 RunDir              |**Read-only.** Contains the path of the run directory. Defaults to LocalStateDir + "/run".
365 PkgDataDir          |**Read-only.** Contains the path of the package data directory. Defaults to PrefixDir + "/share/icinga2".
366 StatePath           |**Read-write.** Contains the path of the Icinga 2 state file. Defaults to LocalStateDir + "/lib/icinga2/icinga2.state".
367 ObjectsPath         |**Read-write.** Contains the path of the Icinga 2 objects file. Defaults to LocalStateDir + "/cache/icinga2/icinga2.debug".
368 PidPath             |**Read-write.** Contains the path of the Icinga 2 PID file. Defaults to RunDir + "/icinga2/icinga2.pid".
369 Vars                |**Read-write.** Contains a dictionary with global custom attributes. Not set by default.
370 NodeName            |**Read-write.** Contains the cluster node name. Set to the local hostname by default.
371 UseVfork            |**Read-write.** Whether to use vfork(). Only available on *NIX. Defaults to true.
372 AttachDebugger      |**Read-write.** Whether to attach a debugger when Icinga 2 crashes. Defaults to false.
373 RunAsUser           |**Read-write.** Defines the user the Icinga 2 daemon is running as. Used in the `init.conf` configuration file.
374 RunAsGroup          |**Read-write.** Defines the group the Icinga 2 daemon is running as. Used in the `init.conf` configuration file.
375
376 ## <a id="apply"></a> Apply
377
378 The `apply` keyword can be used to create new objects which are associated with
379 another group of objects.
380
381     apply Service "ping" to Host {
382       import "generic-service"
383
384       check_command = "ping4"
385
386       assign where host.name == "localhost"
387     }
388
389 In this example the `assign where` condition is a boolean expression which is
390 evaluated for all objects of type `Host` and a new service with name "ping"
391 is created for each matching host. [Expression operators](18-language-reference.md#expression-operators)
392 may be used in `assign where` conditions.
393
394 The `to` keyword and the target type may be omitted if there is only one target
395 type, e.g. for the `Service` type.
396
397 Depending on the object type used in the `apply` expression additional local
398 variables may be available for use in the `where` condition:
399
400 Source Type       | Target Type | Variables
401 ------------------|-------------|--------------
402 Service           | Host        | host
403 Dependency        | Host        | host
404 Dependency        | Service     | host, service
405 Notification      | Host        | host
406 Notification      | Service     | host, service
407 ScheduledDowntime | Host        | host
408 ScheduledDowntime | Service     | host, service
409
410 Any valid config attribute can be accessed using the `host` and `service`
411 variables. For example, `host.address` would return the value of the host's
412 "address" attribute - or null if that attribute isn't set.
413
414 More usage examples are documented in the [monitoring basics](3-monitoring-basics.md#using-apply-expressions)
415 chapter.
416
417 ## <a id="apply-for"></a> Apply For
418
419 [Apply](18-language-reference.md#apply) rules can be extended with the
420 [for loop](18-language-reference.md#for-loops) keyword.
421
422     apply Service "prefix-" for (key => value in host.vars.dictionary) to Host {
423       import "generic-service"
424
425       check_command = "ping4"
426       vars.host_value = value
427     }
428
429
430 Any valid config attribute can be accessed using the `host` and `service`
431 variables. The attribute must be of the Array or Dictionary type. In this example
432 `host.vars.dictionary` is of the Dictionary type which needs a key-value-pair
433 as iterator.
434
435 In this example all generated service object names consist of `prefix-` and
436 the value of the `key` iterator. The prefix string can be omitted if not required.
437
438 The `key` and `value` variables can be used for object attribute assignment, e.g. for
439 setting the `check_command` attribute or custom attributes as command parameters.
440
441 `apply for` rules are first evaluated against all objects matching the `for loop` list
442 and afterwards the `assign where` and `ignore where` conditions are evaluated.
443
444 It is not necessary to check attributes referenced in the `for loop` expression
445 for their existance using an additional `assign where` condition.
446
447 More usage examples are documented in the [monitoring basics](3-monitoring-basics.md#using-apply-for)
448 chapter.
449
450 ## <a id="group-assign"></a> Group Assign
451
452 Group objects can be assigned to specific member objects using the `assign where`
453 and `ignore where` conditions.
454
455     object HostGroup "linux-servers" {
456       display_name = "Linux Servers"
457
458       assign where host.vars.os == "Linux"
459     }
460
461 In this example the `assign where` condition is a boolean expression which is evaluated
462 for all objects of the type `Host`. Each matching host is added as member to the host group
463 with the name "linux-servers". Membership exclusion can be controlled using the `ignore where`
464 condition. [Expression operators](18-language-reference.md#expression-operators) may be used in `assign where` and
465 `ignore where` conditions.
466
467 Source Type       | Variables
468 ------------------|--------------
469 HostGroup         | host
470 ServiceGroup      | host, service
471 UserGroup         | user
472
473
474 ## <a id="boolean-values"></a> Boolean Values
475
476 The `assign where`, `ignore where`, `if` and `while`  statements, the `!` operator as
477 well as the `bool()` function convert their arguments to a boolean value based on the
478 following rules:
479
480 Description          | Example Value     | Boolean Value
481 ---------------------|-------------------|--------------
482 Empty value          | null              | false
483 Zero                 | 0                 | false
484 Non-zero integer     | -23945            | true
485 Empty string         | ""                | false
486 Non-empty string     | "Hello"           | true
487 Empty array          | []                | false
488 Non-empty array      | [ "Hello" ]       | true
489 Empty dictionary     | {}                | false
490 Non-empty dictionary | { key = "value" } | true
491
492 For a list of supported expression operators for `assign where` and `ignore where`
493 statements, see [expression operators](18-language-reference.md#expression-operators).
494
495 ## <a id="comments"></a> Comments
496
497 The Icinga 2 configuration format supports C/C++-style and shell-style comments.
498
499 Example:
500
501     /*
502      This is a comment.
503      */
504     object Host "localhost" {
505       check_interval = 30 // this is also a comment.
506       retry_interval = 15 # yet another comment
507     }
508
509 ## <a id="includes"></a> Includes
510
511 Other configuration files can be included using the `include` directive.
512 Paths must be relative to the configuration file that contains the
513 `include` directive.
514
515 Example:
516
517     include "some/other/file.conf"
518     include "conf.d/*.conf"
519
520 Wildcard includes are not recursive.
521
522 Icinga also supports include search paths similar to how they work in a
523 C/C++ compiler:
524
525     include <itl>
526
527 Note the use of angle brackets instead of double quotes. This causes the
528 config compiler to search the include search paths for the specified
529 file. By default $PREFIX/share/icinga2/include is included in the list of search
530 paths. Additional include search paths can be added using
531 [command-line options](8-cli-commands.md#config-include-path).
532
533 Wildcards are not permitted when using angle brackets.
534
535 ## <a id="recursive-includes"></a> Recursive Includes
536
537 The `include_recursive` directive can be used to recursively include all
538 files in a directory which match a certain pattern.
539
540 Example:
541
542     include_recursive "conf.d", "*.conf"
543     include_recursive "templates"
544
545 The first parameter specifies the directory from which files should be
546 recursively included.
547
548 The file names need to match the pattern given in the second parameter.
549 When no pattern is specified the default pattern "*.conf" is used.
550
551 ## <a id="zone-includes"></a> Zone Includes
552
553 The `include_zones` recursively includes all subdirectories for the
554 given path.
555
556 In addition to that it sets the `zone` attribute for all objects created
557 in these subdirectories to the name of the subdirectory.
558
559 Example:
560
561     include_zones "etc", "zones.d", "*.conf"
562     include_zones "puppet", "puppet-zones"
563
564 The first parameter specifies a tag name for this directive. Each `include_zones`
565 invocation should use a unique tag name. When copying the zones' configuration
566 files Icinga uses the tag name as the name for the destination directory in
567 `/var/lib/icinga2/api/config`.
568
569 The second parameter specifies the directory which contains the subdirectories.
570
571 The file names need to match the pattern given in the third parameter.
572 When no pattern is specified the default pattern "*.conf" is used.
573
574 ## <a id="library"></a> Library directive
575
576 The `library` directive can be used to manually load additional
577 libraries. Libraries can be used to provide additional object types and
578 functions.
579
580 Example:
581
582     library "snmphelper"
583
584 ## <a id="functions"></a> Functions
585
586 Functions can be defined using the `function` keyword.
587
588 Example:
589
590     function multiply(a, b) {
591       return a * b
592     }
593
594 When encountering the `return` keyword further execution of the function is terminated and
595 the specified value is supplied to the caller of the function:
596
597     log(multiply(3, 5))
598
599 In this example the `multiply` function we declared earlier is invoked with two arguments (3 and 5).
600 The function computes the product of those arguments and makes the result available to the
601 function's caller.
602
603 When no value is supplied for the `return` statement the function returns `null`.
604
605 Functions which do not have a `return` statement have their return value set to the value of the
606 last expression which was performed by the function. For example, we could have also written our
607 `multiply` function like this:
608
609     function multiply(a, b) {
610       a * b
611     }
612
613 Anonymous functions can be created by omitting the name in the function definition. The
614 resulting function object can be used like any other value:
615
616     var fn = function() { 3 }
617
618     fn() /* Returns 3 */
619
620 ## <a id="lambdas"></a> Lambda Expressions
621
622 Functions can also be declared using the alternative lambda syntax.
623
624 Example:
625
626     f = (x) => x * x
627
628 Multiple statements can be used by putting the function body into braces:
629
630     f = (x) => {
631       log("Lambda called")
632       x * x
633     }
634
635 Just like with ordinary functions the return value is the value of the last statement.
636
637 For lambdas which take exactly one argument the braces around the arguments can be omitted:
638
639     f = x => x * x
640
641 ## <a id="nullary-lambdas"></a> Abbreviated Lambda Syntax
642
643 Lambdas which take no arguments can also be written using the abbreviated lambda syntax.
644
645 Example:
646
647     f = {{ 3 }}
648
649 This creates a new function which returns the value 3.
650
651 ## <a id="variable-scopes"></a> Variable Scopes
652
653 When setting a variable Icinga checks the following scopes in this order whether the variable
654 already exists there:
655
656 * Local Scope
657 * `this` Scope
658 * Global Scope
659
660 The local scope contains variables which only exist during the invocation of the current function,
661 object or apply statement. Local variables can be declared using the `var` keyword:
662
663     function multiply(a, b) {
664       var temp = a * b
665       return temp
666     }
667
668 Each time the `multiply` function is invoked a new `temp` variable is used which is in no way
669 related to previous invocations of the function.
670
671 When setting a variable which has not previously been declared as local using the `var` keyword
672 the `this` scope is used.
673
674 The `this` scope refers to the current object which the function or object/apply statement
675 operates on.
676
677     object Host "localhost" {
678       check_interval = 5m
679     }
680
681 In this example the `this` scope refers to the "localhost" object. The `check_interval` attribute
682 is set for this particular host.
683
684 You can explicitly access the `this` scope using the `this` keyword:
685
686     object Host "localhost" {
687       var check_interval = 5m
688   
689       /* This explicitly specifies that the attribute should be set
690        * for the host, if we had omitted `this.` the (poorly named)
691        * local variable `check_interval` would have been modified instead.
692        */
693       this.check_interval = 1m 
694   }
695
696 Similarly the keywords `locals` and `globals` are available to access the local and global scope.
697
698 Functions also have a `this` scope. However unlike for object/apply statements the `this` scope for
699 a function is set to whichever object was used to invoke the function. Here's an example:
700
701      hm = {
702        h_word = null
703  
704        function init(word) {
705          h_word = word
706        }
707      }
708
709      /* Let's invoke the init() function */
710      hm.init("hello")
711
712 We're using `hm.init` to invoke the function which causes the value of `hm` to become the `this`
713 scope for this function call.
714
715 ## <a id="closures"></a> Closures
716
717 By default `function`s, `object`s and `apply` rules do not have access to variables declared
718 outside of their scope (except for global variables).
719
720 In order to access variables which are defined in the outer scope the `use` keyword can be used:
721
722     function MakeHelloFunction(name) {
723       return function() use(name) {
724         log("Hello, " + name)
725       }
726     }
727
728 In this case a new variable `name` is created inside the inner function's scope which has the
729 value of the `name` function argument.
730
731 Alternatively a different value for the inner variable can be specified:
732
733     function MakeHelloFunction(name) {
734       return function() use (greeting = "Hello, " + name) {
735         log(greeting)
736       }
737     }
738
739 ## <a id="conditional-statements"></a> Conditional Statements
740
741 Sometimes it can be desirable to only evaluate statements when certain conditions are met. The if/else
742 construct can be used to accomplish this.
743
744 Example:
745
746     a = 3
747
748     if (a < 5) {
749       a *= 7
750     } else if (a > 10) {
751       a *= 5
752     } else {
753       a *= 2
754     }
755
756 An if/else construct can also be used in place of any other value. The value of an if/else statement
757 is the value of the last statement which was evaluated for the branch which was taken:
758
759     a = if (true) {
760       log("Taking the 'true' branch")
761       7 * 3
762     } else {
763       log("Taking the 'false' branch")
764       9
765     }
766
767 This example prints the log message "Taking the 'true' branch" and the `a` variable is set to 21 (7 * 3).
768
769 The value of an if/else construct is null if the condition evaluates to false and no else branch is given.
770
771 ## <a id="while-loops"></a> While Loops
772
773 The `while` statement checks a condition and executes the loop body when the condition evaluates to `true`.
774 This is repeated until the condition is no longer true.
775
776 Example:
777
778     var num = 5
779
780     while (num > 5) {
781         log("Test")
782         num -= 1
783     }
784
785 The `continue` and `break` keywords can be used to control how the loop is executed: The `continue` keyword
786 skips over the remaining expressions for the loop body and begins the next loop evaluation. The `break` keyword
787 breaks out of the loop.
788
789 ## <a id="for-loops"></a> For Loops
790
791 The `for` statement can be used to iterate over arrays and dictionaries.
792
793 Example:
794
795     var list = [ "a", "b", "c" ]
796
797     for (item in list) {
798       log("Item: " + item)
799     }
800
801 The loop body is evaluated once for each item in the array. The variable `item` is declared as a local
802 variable just as if the `var` keyword had been used.
803
804 Iterating over dictionaries can be accomplished in a similar manner:
805
806     var dict = { a = 3, b = 7 }
807
808     for (key => value in dict) {
809       log("Key: " + key + ", Value: " + value)
810     }
811
812 The `continue` and `break` keywords can be used to control how the loop is executed: The `continue` keyword
813 skips over the remaining expressions for the loop body and begins the next loop evaluation. The `break` keyword
814 breaks out of the loop.
815
816 ## <a id="throw"></a> Exceptions
817
818 Built-in commands may throw exceptions to signal errors such as invalid arguments. User scripts can throw exceptions
819 using the `throw` keyword.
820
821 Example:
822
823     throw "An error occurred."
824
825 There is currently no way for scripts to catch exceptions.
826
827 ## <a id="types"></a> Types
828
829 All values have a static type. The `typeof` function can be used to determine the type of a value:
830
831     typeof(3) /* Returns an object which represents the type for numbers */
832
833 The following built-in types are available:
834
835 Type       | Examples          | Description
836 -----------|-------------------|------------------------
837 Number     | 3.7               | A numerical value.
838 Boolean    | true, false       | A boolean value.
839 String     | "hello"           | A string.
840 Array      | [ "a", "b" ]      | An array.
841 Dictionary | { a = 3 }         | A dictionary.
842
843 Depending on which libraries are loaded additional types may become available. The `icinga`
844 library implements a whole bunch of other [object types](6-object-types.md#object-types),
845 e.g. Host, Service, CheckCommand, etc.
846
847 Each type has an associated type object which describes the type's semantics. These
848 type objects are made available using global variables which match the type's name:
849
850     /* This logs 'true' */
851     log(typeof(3) == Number)
852
853 The type object's `prototype` property can be used to find out which methods a certain type
854 supports:
855
856     /* This returns: ["contains","find","len","lower","replace","reverse","split","substr","to_string","upper"] */
857     keys(String.prototype)
858
859 Additional documentation on type methods is available in the
860 [library reference](19-library-reference.md#library-reference).
861
862 ## <a id="reserved-keywords"></a> Reserved Keywords
863
864 These keywords are reserved and must not be used as constants or custom attributes.
865
866     object
867     template
868     include
869     include_recursive
870     library
871     null
872     true
873     false
874     const
875     var
876     this
877     use
878     apply
879     to
880     where
881     import
882     assign
883     ignore
884     function
885     return
886     for
887     if
888     else
889     in
890
891 You can escape reserved keywords using the `@` character. The following example
892 tries to set `vars.include` which references a reserved keyword and generates
893 an error:
894
895     [2014-09-15 17:24:00 +0200] critical/config: Location:
896     /etc/icinga2/conf.d/hosts/localhost.conf(13):   vars.sla = "24x7"
897     /etc/icinga2/conf.d/hosts/localhost.conf(14):
898     /etc/icinga2/conf.d/hosts/localhost.conf(15):   vars.include = "some cmdb export field"
899                                                          ^^^^^^^
900     /etc/icinga2/conf.d/hosts/localhost.conf(16): }
901     /etc/icinga2/conf.d/hosts/localhost.conf(17):
902
903     Config error: in /etc/icinga2/conf.d/hosts/localhost.conf: 15:8-15:14: syntax error, unexpected include (T_INCLUDE), expecting T_IDENTIFIER
904     [2014-09-15 17:24:00 +0200] critical/config: 1 errors, 0 warnings.
905
906 You can escape the `include` keyword by prefixing it with an additional `@` character:
907
908     object Host "localhost" {
909       import "generic-host"
910
911       address = "127.0.0.1"
912       address6 = "::1"
913
914       vars.os = "Linux"
915       vars.sla = "24x7"
916
917       vars.@include = "some cmdb export field"
918     }
919