Interface User

A user.

Example:

object User "icingaadmin" {
  display_name = "Icinga 2 Admin"
  groups = [ "icingaadmins" ]
  email = "icinga@localhost"
  pager = "icingaadmin@localhost.localdomain"

  period = "24x7"

  states = [ OK, Warning, Critical, Unknown ]
  types = [ Problem, Recovery ]

  vars.additional_notes = "This is the Icinga 2 Admin account."
}

Available notification state filters:

OK
Warning
Critical
Unknown
Up
Down

Available notification type filters:

DowntimeStart
DowntimeEnd
DowntimeRemoved
Custom
Acknowledgement
Problem
Recovery
FlappingStart
FlappingEnd

See

interface User {
    __name: string;
    active: boolean;
    display_name: string;
    email: string;
    enable_notifications: boolean;
    groups: string[];
    ha_mode: HAMode;
    last_notification: number;
    original_attributes: Record<string, any>;
    package: string;
    pager: string;
    paused: boolean;
    period: string;
    source_location: SourceLocation;
    states: string[];
    templates: string[];
    types: string[];
    vars: Record<string, any>;
    version: number;
    zone: string;
}

Hierarchy

  • CustomVarObject
    • User

Properties

__name active display_name email enable_notifications groups ha_mode last_notification original_attributes package pager paused period source_location states templates types vars version zone

Properties

__name

__name: string

See

lib/base/configobject.ti L59-L68

active

active: boolean

See

lib/base/configobject.ti L75

display_name

display_name: string

A short description of the user.

See

email

email: string

An email string for this user. Useful for notification commands.

See

enable_notifications

enable_notifications: boolean

Whether notifications are enabled for this user. Defaults to true.

See

groups

groups: string[]

An array of group names.

See

ha_mode

ha_mode: HAMode

See

lib/base/configobject.ti L83

last_notification

last_notification: number

When the last notification was sent for this user (as a UNIX timestamp).

See

original_attributes

original_attributes: Record<string, any>

See

lib/base/configobject.ti L87

package

package: string

for example _etc

See

lib/base/configobject.ti L70

pager

pager: string

A pager string for this user. Useful for notification commands.

See

paused

paused: boolean

See

lib/base/configobject.ti L76-L78

period

period: string

The name of a time period which determines when a notification for this user should be triggered. Not set by default (effectively 24x7).

See

source_location

source_location: SourceLocation

See

lib/base/configobject.ti L72-L74

states

states: string[]

A set of state filters when a notification for this should be triggered. By default everything is matched.

See

templates

templates: string[]

See

lib/base/configobject.ti L71

types

types: string[]

A set of type filters when a notification for this user should be triggered. By default everything is matched.

See

vars

vars: Record<string, any>

See

lib/icinga/customvarobject.ti L12

version

version: number

See

lib/base/configobject.ti L88-L90

zone

zone: string

See

lib/base/configobject.ti L69

Settings

Member Visibility

Theme

On This Page