Interface QueryObjectsParams

See

doc/12-icinga2-api.md L581-L585

interface QueryObjectsParams {
    attrs?: string[];
    filter?: string;
    joins?: string[];
    meta?: string[];
}

Properties

attrs? filter? joins? meta?

Properties

Optional attrs

attrs?: string[]

Limited attribute list in the output.

Optional filter

filter?: string

For example host.display_name == "Host 1" or host.name=="Host 1" && service.name=="Service 1"

https://icinga.com/docs/icinga-2/latest/doc/12-icinga2-api/#filters

Optional joins

joins?: string[]

Join related object types and their attributes specified as list (?joins=host for the entire set, or selectively by ?joins=host.name).

Optional meta

meta?: string[]

Enable meta information using ?meta=used_by (references from other objects) and/or ?meta=location (location information) specified as list. Defaults to disabled.

Settings

Member Visibility

Theme

On This Page