Alignak command (command)

The command model is used to represent a command in the monitored system.

A command is used:

  • for the hosts and services active checks. The command is a check plugin

used to determine the host or service state.

  • for the event handlers launched when an host / service state changes.
  • for the notifications sent to inform the users of the detected problems
resources/../_static/config_command.png
Properties
Property Type Required Default Relation
Realm
objectid True   realm
Sub-realms
boolean   True  
_users_delete
objectid list     user
_users_read
objectid list     user
_users_update
objectid list     user
Alias
string      
Command line
string      
Definition order
integer   100  
Environment macros
boolean   False  
Imported from
string   unknown  
Module type
string   fork  
Command name
string True    
Notes
string      
Poller tag
string      
Reactionner tag
string      
schema_version
integer   1  
Timeout
integer   -1  

_realm: Realm this element belongs to.

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

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

command_line: System command executed to run the command.

definition_order: Priority level if several elements have the same name

enable_environment_macros: Set Alignak environment macros before running this command.

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

module_type: A specific module type may be defined to associate commands to a dedicated worker. To be completed…

name: Unique command name

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

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.

timeout: Maximum command execution time before ALignak force the command stop.