mirror of
https://github.com/Icinga/icinga2.git
synced 2025-07-29 16:44:29 +02:00
Docs: Add get_templates{,s} to Library Reference
This commit is contained in:
parent
1cda421bad
commit
6118f69c50
@ -908,6 +908,58 @@ function get_objects(type);
|
|||||||
Returns an array of objects whose type matches the specified type. `type` must refer
|
Returns an array of objects whose type matches the specified type. `type` must refer
|
||||||
to a type object.
|
to a type object.
|
||||||
|
|
||||||
|
### get_template <a id="objref-get_template"></a>
|
||||||
|
|
||||||
|
Signature:
|
||||||
|
|
||||||
|
```
|
||||||
|
function get_template(type, name);
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns the template with the specified type and name, or `null` if no such object exists. `type` must refer
|
||||||
|
to a type object.
|
||||||
|
|
||||||
|
> **Note**
|
||||||
|
>
|
||||||
|
> Only the name and debug info attributes are available for templates accessed in the DSL.
|
||||||
|
> Object attributes are not available in this scope.
|
||||||
|
|
||||||
|
You can use this functionality to check whether a template exists e.g. on a satellite endpoint
|
||||||
|
and if not, import a different template.
|
||||||
|
|
||||||
|
```
|
||||||
|
object Host "icinga-agent47.localdomain" {
|
||||||
|
if (get_template(Host, "master-host-tmpl")) {
|
||||||
|
import "master-host-tmpl"
|
||||||
|
} else {
|
||||||
|
import "generic-host"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### get_templates <a id="objref-get_templates"></a>
|
||||||
|
|
||||||
|
Signature:
|
||||||
|
|
||||||
|
```
|
||||||
|
function get_templates(type);
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns an array of templates whose type matches the specified type. `type` must refer
|
||||||
|
to a type object.
|
||||||
|
|
||||||
|
> **Note**
|
||||||
|
>
|
||||||
|
> Only the name and debug info attributes are available for templates accessed in the DSL.
|
||||||
|
> Object attributes are not available in this scope.
|
||||||
|
|
||||||
|
You can use this function to iterate over all available template names, similar to what
|
||||||
|
the [templates API URL endpoint](12-icinga2-api.md#icinga2-api-config-templates) provides.
|
||||||
|
|
||||||
|
```
|
||||||
|
<1> => get_templates(Host).map(n => n.name)
|
||||||
|
[ "ssh-agent" ]
|
||||||
|
```
|
||||||
|
|
||||||
## Math object <a id="math-object"></a>
|
## Math object <a id="math-object"></a>
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user