Interface Service

Service objects describe network services and how they should be checked by Icinga 2.

Best Practice

Rather than creating a Service object for a specific host it is usually easier to just create a Service template and use the apply keyword to assign the service to a number of hosts. Check the apply chapter for details.

Example:

object Service "uptime" {
  host_name = "localhost"

  display_name = "localhost Uptime"

  check_command = "snmp"

  vars.snmp_community = "public"
  vars.snmp_oid = "DISMAN-EVENT-MIB::sysUpTimeInstance"

  check_interval = 60s
  retry_interval = 15s

  groups = [ "all-services", "snmp" ]
}

See

interface Service {
    __name: string;
    acknowledgement: bigint;
    acknowledgement_expiry: number;
    acknowledgement_last_change: number;
    action_url: string;
    active: boolean;
    check_attempt: bigint;
    check_command: string;
    check_interval: number;
    check_period: string;
    check_timeout: Value;
    command_endpoint: string;
    display_name: string;
    downtime_depth: bigint;
    enable_active_checks: boolean;
    enable_event_handler: boolean;
    enable_flapping: boolean;
    enable_notifications: boolean;
    enable_passive_checks: boolean;
    enable_perfdata: boolean;
    event_command: string;
    executions: Dictionary;
    flapping: boolean;
    flapping_current: number;
    flapping_ignore_states: string[];
    flapping_last_change: number;
    flapping_threshold: number;
    flapping_threshold_high: number;
    flapping_threshold_low: number;
    force_next_check: boolean;
    force_next_notification: boolean;
    groups: string;
    ha_mode: HAMode;
    handled: boolean;
    host?: Host;
    host_name: string;
    icon_image: string;
    icon_image_alt: string;
    last_check: number;
    last_check_result: CheckResult;
    last_hard_state: ServiceState;
    last_hard_state_change: number;
    last_reachable: boolean;
    last_state: ServiceState;
    last_state_change: number;
    last_state_critical: number;
    last_state_ok: number;
    last_state_type: StateType;
    last_state_unknown: number;
    last_state_unreachable: number;
    last_state_warning: number;
    max_check_attempts: bigint;
    next_check: number;
    next_update: number;
    notes: string;
    notes_url: string;
    original_attributes: Record<string, any>;
    package: string;
    paused: boolean;
    previous_state_change: number;
    problem: boolean;
    retry_interval: number;
    severity: bigint;
    source_location: SourceLocation;
    state: ServiceState;
    state_type: StateType;
    templates: string[];
    vars: Record<string, any>;
    version: number;
    volatile: boolean;
    zone: string;
}

Hierarchy

Checkable
- Service

Index

Properties

__name acknowledgement acknowledgement_expiry acknowledgement_last_change action_url active check_attempt check_interval check_timeout display_name downtime_depth enable_active_checks enable_event_handler enable_flapping enable_notifications enable_passive_checks enable_perfdata executions flapping flapping_current flapping_ignore_states flapping_last_change flapping_threshold flapping_threshold_high flapping_threshold_low force_next_check force_next_notification groups ha_mode handled host_name icon_image icon_image_alt last_check last_check_result last_hard_state last_hard_state_change last_reachable last_state last_state_change last_state_critical last_state_ok last_state_type last_state_unknown last_state_unreachable last_state_warning max_check_attempts next_check next_update notes notes_url original_attributes package paused previous_state_change problem retry_interval severity source_location state state_type templates vars version volatile zone

navigation

check_command check_period command_endpoint event_command host?

Properties

__name

__name: string

See

lib/base/configobject.ti L59-L68

acknowledgement

acknowledgement: bigint

acknowledgement_expiry

acknowledgement_expiry: number

acknowledgement_last_change

acknowledgement_last_change: number

action_url

action_url: string

active

active: boolean

See

lib/base/configobject.ti L75

check_attempt

check_attempt: bigint

check_interval

check_interval: number

The check interval (in seconds). This interval is used for checks when the service is in a HARD state. Defaults to 5m.

See

doc/09-object-types.md L721

check_timeout

check_timeout: Value

Check command timeout in seconds. Overrides the CheckCommand's timeout attribute.

See

doc/09-object-types.md L720

display_name

display_name: string

A short description of the service.

downtime_depth

downtime_depth: bigint

enable_active_checks

enable_active_checks: boolean

enable_event_handler

enable_event_handler: boolean

enable_flapping

enable_flapping: boolean

enable_notifications

enable_notifications: boolean

enable_passive_checks

enable_passive_checks: boolean

enable_perfdata

enable_perfdata: boolean

executions

executions: Dictionary

flapping

flapping: boolean

flapping_current

flapping_current: number

flapping_ignore_states

flapping_ignore_states: string[]

flapping_last_change

flapping_last_change: number

flapping_threshold

flapping_threshold: number

Deprecated

flapping_threshold_high

flapping_threshold_high: number

flapping_threshold_low

flapping_threshold_low: number

force_next_check

force_next_check: boolean

force_next_notification

force_next_notification: boolean

groups

groups: string

The service groups this service belongs to.

ha_mode

ha_mode: HAMode

See

lib/base/configobject.ti L83

handled

handled: boolean

host_name

host_name: string

The host this service belongs to. There must be a Host object with that name.

icon_image

icon_image: string

icon_image_alt

icon_image_alt: string

last_check

last_check: number

last_check_result

last_check_result: CheckResult

last_hard_state

last_hard_state: ServiceState

The last hard state (0 = OK, 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN).

last_hard_state_change

last_hard_state_change: number

last_reachable

last_reachable: boolean

last_state

last_state: ServiceState

The previous state (0 = OK, 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN).

last_state_change

last_state_change: number

last_state_critical

last_state_critical: number

When the last CRITICAL state occurred (as a UNIX timestamp).

last_state_ok

last_state_ok: number

When the last OK state occurred (as a UNIX timestamp).

last_state_type

last_state_type: StateType

last_state_unknown

last_state_unknown: number

When the last UNKNOWN state occurred (as a UNIX timestamp).

last_state_unreachable

last_state_unreachable: number

last_state_warning

last_state_warning: number

When the last WARNING state occurred (as a UNIX timestamp).

max_check_attempts

max_check_attempts: bigint

The number of times a service is re-checked before changing into a hard state. Defaults to 3.

See

doc/09-object-types.md L718

next_check

next_check: number

next_update

next_update: number

notes

notes: string

notes_url

notes_url: string

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

paused

paused: boolean

See

lib/base/configobject.ti L76-L78

previous_state_change

previous_state_change: number

problem

problem: boolean

retry_interval

retry_interval: number

This interval is used for checks when the service is in a SOFT state. Defaults to 1m. Note: This does not affect the scheduling after a passive check result.