Interface Host

A host.

Example

object Host "icinga2-agent1.localdomain" {
display_name = "Linux Client 1"
address = "192.168.56.111"
address6 = "2a00:1450:4001:815::2003"

groups = [ "linux-servers" ]

check_command = "hostalive"
}

See

interface Host {
    __name: string;
    acknowledgement: bigint;
    acknowledgement_expiry: number;
    acknowledgement_last_change: number;
    action_url: string;
    active: boolean;
    address: string;
    address6: string;
    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;
    icon_image: string;
    icon_image_alt: string;
    last_check: number;
    last_check_result: CheckResult;
    last_hard_state: HostState;
    last_hard_state_change: number;
    last_reachable: boolean;
    last_state: HostState;
    last_state_change: number;
    last_state_down: number;
    last_state_type: StateType;
    last_state_unreachable: number;
    last_state_up: 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: HostState;
    state_type: StateType;
    templates: string[];
    vars: Record<string, any>;
    version: number;
    volatile: boolean;
    zone: string;
}

Hierarchy

  • Checkable
    • Host

Properties

__name: string
acknowledgement: bigint
acknowledgement_expiry: number
acknowledgement_last_change: number
action_url: string
active: boolean
address: string

The host's IPv4 address. Available as command runtime macro $address$ if set.

address6: string

The host's IPv6 address. Available as command runtime macro $address6$ if set.

check_attempt: bigint
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.

check_timeout: Value

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

display_name: string

A short description of the host (e.g. displayed by external interfaces instead of the name if set).

downtime_depth: bigint
enable_active_checks: boolean
enable_event_handler: boolean
enable_flapping: boolean
enable_notifications: boolean
enable_passive_checks: boolean
enable_perfdata: boolean
executions: Dictionary
flapping: boolean
flapping_current: number
flapping_ignore_states: string[]
flapping_last_change: number
flapping_threshold: number

Deprecated

flapping_threshold_high: number
flapping_threshold_low: number
force_next_check: boolean
force_next_notification: boolean
groups: string[]

A list of host groups this host belongs to.

ha_mode: HAMode
handled: boolean
icon_image: string
icon_image_alt: string
last_check: number
last_check_result: CheckResult
last_hard_state: HostState

The last hard state (0 = UP, 1 = DOWN).

last_hard_state_change: number
last_reachable: boolean
last_state: HostState

The previous state (0 = UP, 1 = DOWN).

last_state_change: number
last_state_down: number

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

last_state_type: StateType
last_state_unreachable: number
last_state_up: number

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

max_check_attempts: bigint

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

next_check: number
next_update: number
notes: string
notes_url: string
original_attributes: Record<string, any>
package: string

for example _etc

paused: boolean
previous_state_change: number
problem: boolean
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.

severity: bigint
source_location: SourceLocation
state: HostState

The current state (0 = UP, 1 = DOWN).

state_type: StateType
templates: string[]
vars: Record<string, any>
version: number
volatile: boolean
zone: string

navigation

check_command: string

The name of the check command.

check_period: string

The name of a time period which determines when this service should be checked. Not set by default (effectively 24x7).

command_endpoint: string
event_command: string