Object Types
============

ConsoleLogger
-------------

Specifies Icinga 2 logging to the console.

Example:

    object ConsoleLogger "my-debug-console" {
      severity = "debug"
    }

Attributes:

  Name            |Description
  ----------------|----------------
  severity        |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information".

FileLogger
----------

Specifies Icinga 2 logging to a file.

Example:

    object FileLogger "my-debug-file" {
      severity = "debug",
      path = "/var/log/icinga2/icinga2-debug.log"
    }

Attributes:

  Name            |Description
  ----------------|----------------
  path            |**Required.** The log path.
  severity        |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information".

SyslogLogger
------------

Specifies Icinga 2 logging to syslog.

Example:

    object SyslogLogger "my-crit-syslog" {
      severity = "critical"
    }

Attributes:

  Name            |Description
  ----------------|----------------
  severity        |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information".

CheckCommand
------------

A check command definition. Additional default command macros can be
defined here.

Example:

    object CheckCommand "check_snmp" inherits "plugin-check-command" {
      command = "$plugindir$/check_snmp -H $address$ -C $community$ -o $oid$",

      macros = {
        address = "127.0.0.1",
        community = "public",
      }
    }

NotificationCommand
-------------------

A notification command definition.

Example:

    object NotificationCommand "mail-service-notification" inherits "plugin-notification-command" {
      command = [ 
        "/opt/bin/send-mail-notification",
        "$CONTACTEMAIL$",
        "$NOTIFICATIONTYPE$ - $HOSTNAME$ - $SERVICEDESC$ - $SERVICESTATE$",
        {{{***** Icinga  *****

    Notification Type: $NOTIFICATIONTYPE$

    Service: $SERVICEDESC$
    Host: $HOSTALIAS$
    Address: $HOSTADDRESS$
    State: $SERVICESTATE$

    Date/Time: $LONGDATETIME$

    Additional Info: $SERVICEOUTPUT$

    Comment: [$NOTIFICATIONAUTHORNAME$] $NOTIFICATIONCOMMENT$}}}
      ]
    }

EventCommand
------------

An event command definition.

> **Note**
>
> Similar to Icinga 1.x event handlers.

Example:

    object EventCommand "restart-httpd-event" inherits "plugin-event-command" {
      command = "/opt/bin/restart-httpd.sh",
    }


Service
-------

Service objects describe network services and how they should be checked
by Icinga 2.

> **Best Practice**
>
> Rather than creating a *Service* object for a specific host it is usually easier
> to just create a *Service* template and using the *services* attribute in the *Host*
> object to associate these templates with a host.

Example:

    object Service "localhost-uptime" {
      host = "localhost",
      short_name = "uptime",

      display_name = "localhost Uptime",

      check_command = "check_snmp",

      macros = {
        community = "public",
        oid = "DISMAN-EVENT-MIB::sysUpTimeInstance"
      }

      check_interval = 60s,
      retry_interval = 15s,

      servicegroups = [ "all-services", "snmp" ],
    }

Attributes:

  Name            |Description
  ----------------|----------------
  host            |**Required.** The host this service belongs to. There must be a *Host* object with that name.
  short_name      |**Required.** The service name. Must be unique on a per-host basis (Similar to the service_description attribute in Icinga 1.x).
  display_name    |**Optional.** A short description of the service.
  macros          |TODO
  check\_command  |**Required.** The name of the check command.
  max\_check\_attempts|TODO
  check\_period   |TODO
  check\_interval |**Optional.** The check interval (in seconds).
  retry\_interval |**Optional.** The retry interval (in seconds). This is used when the service is in a soft state. Defaults to 1/5th of the check interval if not specified.
  event\_command  |TODO
  flapping\_threshold|TODO
  volatile        |TODO
  host\_dependencies|TODO
  service\_dependencies|TODO
  groups          |**Optional.** The service groups this service belongs to.
  notifications   |TODO

ServiceGroup
------------

A group of services.

Example:

    object ServiceGroup "snmp" {
      display_name = "SNMP services",
    }

Attributes:

  Name            |Description
  ----------------|----------------
  display_name    |**Optional.** A short description of the service group.

Notification
------------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  host            |TODO
  service         |TODO
  macros          |TODO
  users           |TODO
  user_groups     |TODO
  times           |TODO
  notification_command|TODO
  notification_interval|TODO
  notification_period|TODO
  notification_type_filter|TODO
  notification_state_filter|TODO

User
----

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  display_name    |TODO
  macros          |TODO
  groups          |TODO
  enable_notifications|TODO
  notification_period|TODO
  notification_type_filter|TODO
  notification_state_filter|TODO

UserGroup
---------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  display_name    |TODO

TimePeriod
----------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  display_name    |TODO
  methods         |TODO
  ranges          |TODO

TimePeriod
----------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  display_name    |TODO

Domain
------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  acl             |TODO

Host
----

A host.

> **Note**
>
> Unlike in Icinga 1.x hosts are not checkable objects in Icinga 2.

Example:

    object Host "localhost" {
      display_name = "The best host there is",

      groups = [ "all-hosts" ],

      check = "ping",
      
      host_dependencies = [ "router" ],

      service_dependencies = [
        { host = "db-server", service = "mysql" }
      ],

      services["ping"] = {
        templates = [ "ping" ]
      },

      services["http"] = {
        templates = [ "my-http" ],

        macros = {
          vhost = "test1.example.org",
          port = 81
        }
      }
    }

Attributes:

  Name            |Description
  ----------------|----------------
  display_name    |**Optional.** A short description of the host.
  check           |**Optional.** A service that is used to determine whether the host is up or down. This must be a service short name of a service that belongs to the host.
  groups          |**Optional.** A list of host groups this host belongs to.
  host_dependencies|**Optional.** An array of host names which this host depends on. These dependencies are used to determine whether the host is unreachable.
  service_dependencies|**Optional.** An array of service names which this host depends on. Each array element must be a dictionary containing the keys "host" and "service". These dependencies are used to determine whether the host is unreachable.
  services        |**Optional.** Inline definition of services. Each dictionary item specifies a service.<br /><br />The *templates* attribute can be used to specify an array of templates that should be inherited by the service.<br /><br />The new service's name is "hostname:service" - where "service" is the dictionary key in the services dictionary.<br /><br />The dictionary key is used as the service's short name.
  macros          |TODO

HostGroup
---------

A group of hosts.

Example:

    object HostGroup "my-hosts" {
      display_name = "My hosts",
    }

Attributes:

  Name            |Description
  ----------------|----------------
  display_name    |**Optional.** A short description of the host group.

PerfdataWriter
--------------

Writes check result performance data to a defined path using macro
pattern.

Example

    object PerfdataWriter "pnp" {
      perfdata_path = "/var/spool/icinga2/perfdata/service-perfdata",

      format_template = "DATATYPE::SERVICEPERFDATA\tTIMET::$TIMET$\tHOSTNAME::$HOSTNAME$\tSERVICEDESC::$SERVICEDESC$\tSERVICEPERFDATA::$SERVICEPERFDATA$\tSERVICECHECKCOMMAND::$SERVICECHECKCOMMAND$\tHOSTSTATE::$HOSTSTATE$\tHOSTSTATETYPE::$HOSTSTATETYPE$\tSERVICESTATE::$SERVICESTATE$\tSERVICESTATETYPE::$SERVICESTATETYPE$",

      rotation_interval = 15s,
    }

Attributes:

  Name            |Description
  ----------------|----------------
  perfdata\_path  |**Optional.** Path to the service perfdata file. Defaults to IcingaLocalStateDir + "/cache/icinga2/perfdata/perfdata".
  format\_template|**Optional.** Format template for the perfdata file. Defaults to a template that's suitable for use with PNP4Nagios.
  rotation\_interval|**Optional.** Rotation interval for the file specified in *perfdata\_path*. Defaults to 30 seconds.

> **Note**
>
> When rotating the perfdata file the current UNIX timestamp is appended to the path specified
> in *perfdata\_path* to generate a unique filename.

IdoMySqlConnection
------------------

IDO DB schema compatible output into MySQL database.

Example:

    library "db_ido_mysql"

    object IdoMysqlConnection "mysql-ido" {
      host = "127.0.0.1",
      port = 3306,
      user = "icinga",
      password = "icinga",
      database = "icinga",
      table_prefix = "icinga_",
      instance_name = "icinga2",
      instance_description = "icinga2 dev instance"
      cleanup = {
        downtimehistory_age = 24h,
	logentries_age = 24h,
      }
    }

Attributes:

  Name            |Description
  ----------------|----------------
  host            |**Optional.** MySQL database host address. Defaults to "localhost".
  port            |**Optional.** MySQL database port. Defaults to 3306.
  user            |**Optional.** MySQL database user with read/write permission to the icinga database. Defaults to "icinga".
  password        |**Optional.** MySQL database user's password. Defaults to "icinga".
  database        |**Optional.** MySQL database name. Defaults to "icinga".
  table\_prefix   |**Optional.** MySQL database table prefix. Defaults to "icinga\_".
  instance\_name  |**Optional.** Unique identifier for the local Icinga 2 instance. Defaults to "default".
  instance\_description|**Optional.** Description for the Icinga 2 instance.
  cleanup         |**Optional.** Dictionary with items for historical table cleanup.

Cleanup Items:

  ----------------|----------------
  acknowledgement_age |**Optional.** Max age for acknowledgement table rows (entry_time)
  commenthistory_age |**Optional.** Max age for commenthistory table rows (entry_time)
  contactnotifications_age |**Optional.** Max age for contactnotifications table rows (start_time)
  contactnotificationmethods_age |**Optional.** Max age for contactnotificationmethods table rows (start_time)
  downtimehistory_age |**Optional.** Max age for downtimehistory table rows (entry_time)
  eventhandlers_age |**Optional.** Max age for eventhandlers table rows (start_time)
  externalcommands_age |**Optional.** Max age for externalcommands table rows (entry_time)
  flappinghistory_age |**Optional.** Max age for flappinghistory table rows (event_time)
  hostchecks_age |**Optional.** Max age for hostchecks table rows (start_time)
  logentries_age |**Optional.** Max age for logentries table rows (logentry_time)
  notifications_age |**Optional.** Max age for notifications table rows (start_time)
  processevents_age |**Optional.** Max age for processevents table rows (event_time)
  statehistory_age |**Optional.** Max age for statehistory table rows (state_time)
  servicechecks_age |**Optional.** Max age for servicechecks table rows (start_time)
  systemcommands_age |**Optional.** Max age for systemcommands table rows (start_time)

LiveStatusListener
------------------

Livestatus API interface available as TCP or UNIX socket.

Example:

    library "livestatus"

    object LivestatusListener "livestatus-tcp" {
      socket_type = "tcp",
      bind_host = "127.0.0.1",
      bind_port = "6558"
    }

    object LivestatusListener "livestatus-unix" {
      socket_type = "unix",
      socket_path = "/var/run/icinga2/livestatus"
    }

Attributes:

  Name            |Description
  ----------------|----------------
  socket\_type    |**Optional.** Specifies the socket type. Can be either "tcp" or "unix". Defaults to "unix".
  bind\_host      |**Optional.** Only valid when socket\_type is "tcp". Host address to listen on for connections. Defaults to "127.0.0.1".
  bind\_port      |**Optional.** Only valid when *socket\_type* is "tcp". Port to listen on for connections. Defaults to 6558.
  socket\_path    |**Optional.** Only valid when *socket\_type* is "unix". Specifies the path to the UNIX socket file. Defaults to IcingaLocalStateDir + "/run/icinga2/livestatus".

> **Note**
>
> UNIX sockets are not supported on Windows.

StatusDataWriter
----------------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  status\_path    |TODO
  objects\_path   |TODO

ExternalCommandListener
-----------------------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  command\_path   |TODO

CompatLogger
------------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  log\_dir        |TODO
  rotation\_method|TODO

CheckResultReader
-----------------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  spool\_dir      |TODO

CheckerComponent
----------------

TODO

Example:

    library "checker"

    object CheckerComponent "checker" { }

NotificationComponent
---------------------

TODO

Example:

    library "notification"

    object NotificationComponent "notification" { }

ClusterListener
---------------

TODO

Example:

    TODO

Attributes:

  Name            |Description
  ----------------|----------------
  cert\_path      |TODO
  ca\_path        |TODO
  bind\_host      |TODO
  bind\_port      |TODO
  peers           |TODO

Endpoint
--------

Endpoint objects are used to specify connection information for remote
Icinga 2 instances.

Example:

    library "cluster"

    object Endpoint "icinga-c2" {
      node = "192.168.5.46",
      service = 7777,
    }

Attributes:

  Name            |Description
  ----------------|----------------
  node            |**Required.** The hostname/IP address of the remote Icinga 2 instance.
  service         |**Required.** The service name/port of the remote Icinga 2 instance.
  config\_files   |TODO
  accept\_config  |TODO