Monitored host (host)

The host model is used to represent a monitored host.

An host may be a router, a server, a workstation, … that you want to be monitored by your Alignak framework.

resources/../_static/config_host.png
Properties
Property Type Required Default Relation
string      
string      
Template
boolean   False  
Element overall state
integer   3  
Realm
objectid True   realm
Sub-realms
boolean   True  
Template fields
list   []  
Templates
objectid list   [] host
Template services
boolean   True  
_users_delete
objectid list     user
_users_read
objectid list     user
_users_update
objectid list     user
Actions URL
string      
active_checks_enabled
Active checks enabled
boolean   True  
address
Host address (IPv4)
string      
address6
Host address (IPv6)
string      
Alias
string      
Business impact
integer   2  
Business impact modulations
list   []  
BR downtime as ack
boolean   False  
BR host notification options
list   [‘d’, ‘u’, ‘r’, ‘f’, ‘s’]  
BR output template
string      
BR service notification options
list   [‘w’, ‘u’, ‘c’, ‘r’, ‘f’, ‘s’]  
BR smart notifications
boolean   False  
Check command
objectid     command
Check command arguments
string      
Check freshness
boolean   False  
Check interval
integer   5  
Check period
objectid     timeperiod
Checks modulations
list   []  
custom_views
list   []  
customs
Custom variables
dict   {}  
Definition order
integer   100  
Display name
string      
Escalations
objectid list   [] hostescalation
Event handler
objectid   None command
event_handler_args
Event handler arguments
string      
event_handler_enabled
Event handler enabled
boolean   False  
First notification delay
integer   0  
Flapping detection enabled
boolean   True  
Flapping detection options
list   [‘o’, ‘d’, ‘x’]  
Freshness state
string   x  
Freshness threshold
integer   0  
high_flap_threshold
High flapping threshold
integer   50  
string      
string      
string      
Imported from
string   unknown  
Initial state
string   x  
BR labels
list   []  
Location
point   {‘type’: ‘Point’, ‘coordinates’: [48.858293, 2.294601]}  
low_flap_threshold
Low flapping threshold
integer   25  
Acknowledged
boolean   False  
ls_acknowledgement_type
Acknowledgement type
integer   1  
ls_current_attempt
Current attempt number
integer   0  
Downtimed
boolean   False  
Execution time
float   0.0  
Grafana available
boolean   False  
Grafana identifier
integer   0  
Last check time
integer   0  
Last time hard state changed
integer   0  
ls_last_notification
Last notification sent
integer   0  
Last state
string   UNREACHABLE  
Last state changed
integer   0  
Last state type
string   HARD  
Last time down
integer   0  
Last time unknown
integer   0  
Last time unreachable
integer   0  
Last time up
integer   0  
Latency
float   0.0  
Long output
string      
Next check
integer   0  
Output
string      
Check type
boolean   False  
Performance data
string      
State
string   UNREACHABLE  
State changed
integer   0  
State identifier
integer   3  
State type
string   HARD  
Macros modulations
list   []  
Maintenance period
objectid     timeperiod
Maximum check attempts
integer   1  
Host name
string True    
Notes
string      
Notes URL
string      
Notifications interval
integer   60  
Notifications options
list   [‘d’, ‘x’, ‘r’, ‘f’, ‘s’]  
Notifications period
objectid     timeperiod
notifications_enabled
Notifications enabled
boolean   True  
Parents
objectid list   [] host
passive_checks_enabled
Passive checks enabled
boolean   True  
Poller tag
string      
process_perf_data
Performance data enabled
boolean   True  
Reactionner tag
string      
Results modulations
list   []  
Retry interval
integer   0  
schema_version
integer   3  
service_excludes
list   []  
service_includes
list   []  
service_overrides
list   []  
Snapshot command
objectid     command
Snapshot criteria
list   [‘d’, ‘x’]  
snapshot_enabled
Snapshot enabled
boolean   False  
Snapshot interval
integer   5  
Snapshot period
objectid     timeperiod
Stalking options
list   []  
string      
Tags
list   []  
Time to orphanage
integer   300  
Trending policies
list   []  
boolean   False  
Trigger name
string      
Notifications users groups
objectid list   [] usergroup
Notifications users
objectid list   [] user
string      

2d_coords: Old Nagios stuff. To be deprecated

3d_coords: Old Nagios stuff. To be deprecated

_is_template: Indicate if this element is a template or a real element

_overall_state_id: The overall state is a synthesis state that considers the element state, its acknowledgement, its downtime and its children states.

_realm: Realm this element belongs to.

_sub_realm: Is this element visible in the sub-realms of its realm?

_template_fields: If this element is not a template, this field contains the list of the fields linked to the templates this element is linked to

_templates: List of templates this element is linked to.

_templates_with_services: If this element is a template, when a new element is created based upon this template, it will also inherit from the linked services templates of this template.

action_url: Element actions URL. Displayed in the Web UI as some available actions. Note that a very specific text format must be used for this field, see the Web UI documentation.

alias: Element friendly name used by the Web User Interface.

business_impact: The business impact level indicates the level of importance of this element. The highest value the most important is the element.

Allowed values: [0, 1, 2, 3, 4, 5]

business_impact_modulations: Not yet implemented (#116).

business_rule_downtime_as_ack: Not yet implemented (#146)

business_rule_host_notification_options: Not yet implemented (#146)

Allowed values: [‘d’, ‘u’, ‘r’, ‘f’, ‘s’, ‘n’]

business_rule_output_template: Not yet implemented (#146)

business_rule_service_notification_options: Not yet implemented (#146)

Allowed values: [‘w’, ‘u’, ‘c’, ‘r’, ‘f’, ‘s’, ‘n’]

business_rule_smart_notifications: Not yet implemented (#146)

check_command: Command that will be executed to check if the element is ok.

check_command_args: Separate arguments with !. For example, if your have 2 arguments, enter test1!test2

check_freshness: Passive checks only. If the freshness check is enabled, and no passive check has been received since freshness_threshold seconds, the state will be forced to freshness_state.

check_interval: Active checks only. Number of minutes between the periodical checks.

check_period: Time period during which active / passive checks can be made.

checkmodulations: Not yet implemented (#114).

definition_order: Priority level if several elements have the same name

display_name: Old Nagios stuff. To be deprecated

escalations: List of the escalations applied to this element. Not yet implemented.

event_handler: Command that should run whenever a change in the element state is detected.

first_notification_delay: Number of minutes to wait before sending out the first problem notification when a non-ok state is detected. If you set this value to 0, the first notification will be sent-out immediately.

flap_detection_enabled: Flapping occurs when an element changes state too frequently, resulting in a storm of problem and recovery notifications. Once an element is detected as flapping, all its notifications are blocked.

flap_detection_options: States involved in the flapping detection logic.

Allowed values: [‘o’, ‘d’, ‘x’]

freshness_state: Passive checks only. The state that will be forced by Alignak when the freshness check fails.

Allowed values: [‘o’, ‘d’, ‘x’]

freshness_threshold: Passive checks only. Number of seconds for the freshness check to force the freshness_state. If this value is set to 0, Alignak will use a default value (3600 seconds)

icon_image: Old Nagios stuff. To be deprecated

icon_image_alt: Old Nagios stuff. To be deprecated

icon_set: Old Nagios stuff. To be deprecated

imported_from: Item importation source (alignak-backend-import, …)

initial_state: Alignak sets this default state until a check happen

Allowed values: [‘o’, ‘d’, ‘x’]

labels: Not yet implemented (#146)

location: Element GPS coordinates

ls_acknowledged: Currently acknowledged

ls_downtimed: Currently downtimed

ls_execution_time: Last check execution time

ls_grafana: This element has a Grafana panel available

ls_grafana_panelid: Grafana panel identifier

ls_last_check: Last check timestamp

ls_last_hard_state_changed: Last time this element hard state has changed.

ls_last_state: Former state

Allowed values: [‘UP’, ‘DOWN’, ‘UNREACHABLE’]

ls_last_state_changed: Last state changed timestamp

ls_last_state_type: Former state type

Allowed values: [‘HARD’, ‘SOFT’]

ls_last_time_down: Last time this element was Down.

ls_last_time_unknown: Last time this element was Unknown.

ls_last_time_unreachable: Last time this element was Unreachable.

ls_last_time_up: Last time this element was Up.

ls_latency: Last check latency

ls_long_output: Last check long output

ls_next_check: Next check timestamp

ls_output: Last check output

ls_passive_check: Last check was active or passive?

ls_perf_data: Last check performance data

ls_state: Current state

Allowed values: [‘UP’, ‘DOWN’, ‘UNREACHABLE’]

ls_state_changed: The state has changed with the last check?

ls_state_id: Current state identifier. O: UP, 1: DOWN, 2/3: NOT USED, 4: UNREACHABLE

Allowed values: [0, 1, 2, 3, 4]

ls_state_type: Current state type

Allowed values: [‘HARD’, ‘SOFT’]

macromodulations: Not yet implemented (#115).

maintenance_period: The maintenance period of an host is a time period that defines an equivalent of scheduled downtimes for the host.

max_check_attempts: Active checks only. Number of times the check command will be executed if it returns a state other than Ok. Setting this value to 1 will raise an alert without any retry.

name: Unique host name

notes: Element notes. Free text to store element information.

notes_url: Element notes URL. Displayed in the Web UI as some URL to be navigatesd. Note that a very specific text format must be used for this field, see the Web UI documentation.

notification_interval: Number of minutes to wait before re-sending the notifications if the problem is still present. If you set this value to 0, only one notification will be sent out.

notification_options: List of the notifications types that can be sent.

Allowed values: [‘d’, ‘x’, ‘r’, ‘f’, ‘s’, ‘n’]

notification_period: Time period during which notifications can be sent.

parents: Elements which this element depends of. Used to define the network hierarchy.

poller_tag: Set a value for this element checks to be managed by a dedicated poller.

reactionner_tag: Set a value for this element notifications to be managed by a dedicated reactionner.

resultmodulations: Not yet implemented (#116).

retry_interval: Active checks only. Number of minutes to wait before scheduling a re-check. Checks are rescheduled at the retry interval when they have changed to a non-ok state. Once it has been retried max_check_attempts times without a change in its status, it will revert to being scheduled at its check_interval period.

snapshot_command: Command executed for the snapshot

snapshot_criteria: Execute the snapshot command when the state matches one of the criteria

snapshot_interval: Minimum interval between two snapshots

snapshot_period: Time period when the snapshot feature is active

stalking_options: When enabled for a specific state, Alignak will add an information log for each element check even if the state did not changed.

Allowed values: [‘o’, ‘d’, ‘x’]

statusmap_image: Old Nagios stuff. To be deprecated

tags: List of tags for this element. Intended to set tags by the Web UI

time_to_orphanage: To be clearly understood and documented…

trigger_broker_raise_enabled: To be documented

trigger_name: To be documented

usergroups: List of the users groups that will receive the sent notifications.

users: List of the users that will receive the sent notifications.

vrml_image: Old Nagios stuff. To be deprecated