Service Template


class ServiceTemplate(id_unique, description, alias, check_command, check_command_arg, normal_check_interval, retry_check_interval, max_check_attempts, active_checks_enabled, passive_checks_enabled)

This class represents a service template

  • id_unique (int) – ID of the service template

  • description (str) – Description of the service template

  • alias (str) – Alias of the service template

  • check_command (str) – Check command of the service template

  • check_command_arg (list of str) – Arguments of the check commands

  • normal_check_interval (str) – Normal check interval

  • retry_check_interval (str) – Retry check interval

  • max_check_attempts (int) – Maximum check attempts

  • active_checks_enabled (bool) – Are active checks enabled?

  • passive_checks_enabled (bool) – Are passive checks enabled?


class ServiceTemplateParam

This class represents the available parameters for a service template

ACTION_URL = 'action_url'

Action URL linked to the service template (str)

ACTIVATE = 'activate'

Is the template enabled? (bool)

ACTIVE_CHECKS_ENABLED = 'active_checks_enabled'

Set True if active checks should be enabled (bool)

ALIAS = 'alias'

Alias of the service template (str)

CHECK_COMMAND = 'check_command'

Name of the check command (str)

CHECK_COMMAND_ARGUMENTS = 'check_arguments_arguments'

Arguments that go along with the check command (list of str)

CHECK_FRESHNESS = 'check_freshness'

Set True if check freshness is enabled (bool)

CHECK_PERIOD = 'check_period'

Name of the check period (str)

COMMENT = 'comment'

Comment linked to the service template (str)

CONTACT_ADDITIVE_INHERITANCE = 'contact_additive_inheritance'

Enables contact additive inheritance (bool)

CONTACT_GROUP_ADDITIVE_INHERITANCE = 'cg_additive_inheritance'

Enables contact group additive inheritance (bool)

DESCRIPTION = 'description'

Description of the service template (str)

EVENT_HANDLER = 'event_handler'

Name of the event handler command

EVENT_HANDLER_ARGUMENTS = 'event_handler_arguments'

Arguments that go along with the event handler (list of str)

EVENT_HANDLER_ENABLED = 'event_handler_enabled'

Set True if event handler is enabled (bool)

FIRST_NOTIFICATION_DELAY = 'first_notification_delay'

Delay after which the first notification is sent, in minutes (int)

FLAP_DETECTION_ENABLED = 'flap_detection_enabled'

Set True if flap detection is enabled (bool)

FRESHNESS_THRESHOLD = 'freshness_threshold'

Threshold for freshness, in seconds (int)

GRAPH_TEMPLATE = 'graphtemplate'

Name of the graph template (str)

ICON_IMAGE = 'icon_image'

Icon image (str)

ICON_IMAGE_ALT = 'icon_image_alt'

Alternative icon image (str)

IS_VOLATILE = 'is_volatile'

Set True if service is volatile (str)

MAX_CHECK_ATTEMPTS = 'max_check_attempts'

Maximum number of attempts before a HARD state is declared (int)

NORMAL_CHECK_INTERVAL = 'normal_check_interval'

Interval between checks, in minuted (int)

NOTES = 'notes'

Notes linked to the service template (str)

NOTES_URL = 'notes_url'

Notes URL linked to the service template (str)

NOTIFICATION_INTERVAL = 'notification_interval'

Interval between notifications should be triggered, in minutes (int)

NOTIFICATION_OPTIONS = 'notification_options'

Status linked to notifications (str)

NOTIFICATION_PERIOD = 'notification_period'

Name of the notification period (str)

OBSESS_OVER_SERVICE = 'obsess_over_service'

Set True if obsess over service is enabled (bool)

PARALLELIZE_CHECK = 'parallelize_check'

Set True if parallelize checks are enabled (bool)

PASSIVE_CHECKS_ENABLED = 'passive_checks_enabled'

Set True if passive checks should be enabled (bool)

PROCESS_PERF_DATA = 'process_perf_data'

Set True if performance data processing is enabled (bool)

RECOVERY_NOTIFICATION_DELAY = 'recovery_notification_delay'

Delay after which the recovery notification is sent, in minutes (int)

RETAIN_NONSTATUS_INFORMATION = 'retain_nonstatus_information'

Set True if non status information is retained (bool)

RETAIN_STATUS_INFORMATION = 'retain_status_information'

Set True if status information is retained (bool)

RETRY_CHECK_INTERVAL = 'retry_check_interval'

Interval after which a check is retried (int)

SERVICE_NOTIFICATION_OPTIONS = 'service_notification_options'

Set the notification type (ServiceNotificationOption)

STALKING_OPTIONS = 'stalking_options'

Set the stalking options (ServiceTemplateStalkingOption)

TEMPLATE = 'template'

Template which current template is based on (str)


class ServiceTemplateStalkingOption

This class represents the available stalking options

OK = 'o'