Struct icinga2_api::types::common::checkable::IcingaCheckable

pub struct IcingaCheckable {

    pub custom_var: IcingaCustomVarObject,
    pub acknowledgement: IcingaAcknowledgementType,
    pub acknowledgement_expiry: Option<OffsetDateTime>,
    pub acknowledgement_last_change: Option<OffsetDateTime>,
    pub action_url: Option<String>,
    pub check_attempt: u64,
    pub check_command: IcingaCheckCommandName,
    pub check_interval: Option<Duration>,
    pub check_period: Option<IcingaTimePeriodName>,
    pub check_timeout: Option<Duration>,
    pub command_endpoint: Option<IcingaEndpointName>,
    pub downtime_depth: u64,
    pub enable_active_checks: bool,
    pub enable_event_handler: bool,
    pub enable_flapping: bool,
    pub enable_notifications: bool,
    pub enable_passive_checks: bool,
    pub enable_perfdata: bool,
    pub event_command: Option<IcingaEventCommandName>,
    pub executions: Option<()>,
    pub flapping: bool,
    pub flapping_current: f64,
    pub flapping_ignore_states: Option<Vec<IcingaHostOrServiceState>>,
    pub flapping_last_change: Option<OffsetDateTime>,
    pub flapping_threshold: f64,
    pub flapping_threshold_low: f64,
    pub flapping_threshold_high: f64,
    pub force_next_check: bool,
    pub force_next_notification: bool,
    pub handled: bool,
    pub icon_image: Option<String>,
    pub icon_image_alt: Option<String>,
    pub last_check: OffsetDateTime,
    pub last_check_result: IcingaCheckResult,
    pub last_hard_state_change: OffsetDateTime,
    pub last_reachable: bool,
    pub last_state_change: Option<OffsetDateTime>,
    pub last_state_type: IcingaStateType,
    pub last_state_unreachable: Option<OffsetDateTime>,
    pub max_check_attempts: u64,
    pub next_check: Option<OffsetDateTime>,
    pub next_update: Option<OffsetDateTime>,
    pub notes: Option<String>,
    pub notes_url: Option<String>,
    pub previous_state_change: Option<OffsetDateTime>,
    pub problem: bool,
    pub retry_interval: Option<Duration>,
    pub severity: u64,
    pub state_type: IcingaStateType,
    pub volatile: bool,
}

shared attributes on any checkable object (host and service)

Fields

custom_var: IcingaCustomVarObject

shared config object and custom variable fields

acknowledgement: IcingaAcknowledgementType

the type of acknowledgement (includes None)

acknowledgement_expiry: Option<OffsetDateTime>

when the acknowledgement expires

acknowledgement_last_change: Option<OffsetDateTime>

when the acknowledgement last changed

action_url: Option<String>

URL for actions for the checkable (host or service)

check_attempt: u64

the current check attempt number

check_command: IcingaCheckCommandName

the name of the check command

check_interval: Option<Duration>

the interval used for checks when the host/service is in a HARD state

check_period: Option<IcingaTimePeriodName>

name of a time period when this host/service is checked

check_timeout: Option<Duration>

check timeout

command_endpoint: Option<IcingaEndpointName>

the endpoint the command is executed on

downtime_depth: u64

number of active downtimes on the host/service

enable_active_checks: bool

whether active checks are enabled

enable_event_handler: bool

enabled event handlers for this host/service

enable_flapping: bool

whether flap detection is enabled

enable_notifications: bool

whether notifications are enabled

enable_passive_checks: bool

whether passive checks are enabled

enable_perfdata: bool

whether performance data processing is enabled

event_command: Option<IcingaEventCommandName>

the name of an event command that should be executed every time the host/service state changes or the host/service is in a SOFT state

executions: Option<()>

contains the state of execute-command executions

flapping: bool

whether the host/service is flapping between states

flapping_current: f64

current flapping value in percent

flapping_ignore_states: Option<Vec<IcingaHostOrServiceState>>

a list of states that should be ignored during flapping calculations

flapping_last_change: Option<OffsetDateTime>

when the last flapping change occurred

flapping_threshold: f64

deprecated and has no effect, replaced by flapping_threshold_low and flapping_threshold_high

flapping_threshold_low: f64

the flapping lower bound in percent for a host/service to be considered flapping

flapping_threshold_high: f64

the flapping upper bound in percent for a host/service to be considered flapping

force_next_check: bool

force the next check (execute it now)

force_next_notification: bool

force next notification (send it now)

handled: bool

whether the host/service problem is handled (downtime or acknowledgement)

icon_image: Option<String>

icon image for the host/service

icon_image_alt: Option<String>

icon image alt text for the host/service

last_check: OffsetDateTime

when the last check occurred

last_check_result: IcingaCheckResult

the result of the last check

last_hard_state_change: OffsetDateTime

when the last hard state change occurred

last_reachable: bool

whether the host/service was reachable when the last check occurred

last_state_change: Option<OffsetDateTime>

when the last state change occurred

last_state_type: IcingaStateType

the previous state type (soft/hard)

last_state_unreachable: Option<OffsetDateTime>

when the last UNREACHABLE state occurred

max_check_attempts: u64

the number of times the host/service is checked before changing into a new hard state

next_check: Option<OffsetDateTime>

when the next check occurs

next_update: Option<OffsetDateTime>

when the next check update is to be expected

notes: Option<String>

notes for the host/service

notes_url: Option<String>

URL for notes for the host/service

previous_state_change: Option<OffsetDateTime>

when the previous state change occurred

problem: bool

whether the host/service is considered to be in a problem state type (not up)

retry_interval: Option<Duration>

the interval used for checks when the host/service is in a SOFT state

severity: u64

pre-calculated value, higher means more severe

state_type: IcingaStateType

the current state type (soft/hard)

volatile: bool

treat all state changes as HARD changes

Trait Implementations

impl Clone for IcingaCheckable

fn clone(&self) -> IcingaCheckable

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CustomVarHolder for IcingaCheckable

fn custom_var_value(&self, name: &str) -> Option<&Value>

retrieve a reference to the value of the named custom variable if it exists

fn custom_var_deserialized<T>(&self, name: &str) -> Option<T>

where T: DeserializeOwned,

deserialize the Value into a user provided data type

impl Debug for IcingaCheckable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IcingaCheckable

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IcingaCheckable

fn eq(&self, other: &IcingaCheckable) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for IcingaCheckable

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IcingaCheckable