IcingaDirectorAPI 1.0.5

Python library for the Icinga Director RESTful API

IcingaDirectorAPI

IcingaDirectorAPI is a small module to interact with the Icinga Director REST API, written in Python. It is compatible with the most recent Director version (1.10) only.

Features

• simple authentication
• create, get, list, modify and delete Director Objects through object type, name and definition (in JSON/dict format)

Usage

Import

from IcingaDirectorAPI.director import Director

Authentication

For now only basic authentication (with username & password) is supported. Example:

director = Director('https://icinga-master.with-director.local:8080', 'username', 'password')

Object methods

Supported object types

For now:

• Command
• CommandTemplate
• Endpoint
• Host
• HostGroup
• HostTemplate
• Notification
• NotificationTemplate
• Service
• ServiceApplyRule
• ServiceGroup
• ServiceTemplate
• Timeperiod
• TimeperiodTemplate
• User
• UserGroup
• UserTemplate
• Zone

list()

To get a list of all objects of the same type use the function objects.list().

Parameter	Type	Description
object_type	string	Required. The object type to get.

Examples:

Get all hosts:

director.objects.list('Host')

Get all timeperiods:

director.objects.list('Timeperiod')

get()

To get a single object use the function objects.get().

Parameter	Type	Description
object_type	string	Required. The object type to get.
name	string	Required. The object's name.

Examples:

Get host webserver01.domain:

director.objects.get('Host', 'webserver01.domain')

Get service ping4 of host webserver01.domain:

director.objects.get('Service', 'webserver01.domain!ping4')

Get notification template mail_notifs:

director.objects.get('NotificationTemplate', 'mail_notifs')

create()

Create an object using templates and specify attributes (attrs).

Parameter	Type	Description
object_type	string	Required. The object's type.
name	string	Required. The objects name.
templates	list	Optional. A list of templates to import.
attrs	dictionary	Optional. The objects attributes.

Examples:

Create a host:

director.objects.create(
    'Host',
    'localhost',
    ['generic-host'],
    {'address': '127.0.0.1'})

Create a service for Host "localhost":

director.objects.create(
    'Service',
    'localhost!Ping',
    ['generic-service'],
    {'check_command': 'ping4'})

Create a notification template:

director.objects.create(
    'NotificationTemplate',
    'nt_host-to-jira',
    attrs={'command': 'c_notify', 'notification_interval': '0',
           'period': 't_24x7', 'states': ['Down', 'Up'],
           'types': ['Custom', 'Problem', 'Recovery'], 'users': ['u_jira']})

Notice the addition of the attrs= selector, when skipping the optional templates parameter. If other objects are referenced through the JSON/dict definition, they have to exist in advance of executing this command, since Director does a built-in lookup for these objects.

modify()

Modify attributes of an existing object.

Parameter	Type	Description
object_type	string	Required. The object type to get
name	string	Required. The objects name.
attrs	dictionary	Required. The objects attributes.

Examples:

Change the ip address of a host:

director.objects.modify(
    'Host',
    'localhost',
    {'address': '127.0.1.1'})

Change the used templates and the check interval of a Service:

director.objects.modify('Service',
       'localhost!dummy',
       ['generic-service'],
       {'check_interval': '10m'})

delete()

Delete a single object.

Parameter	Type	Description
object_type	string	Required. The object type to get
name	string	Required. The objects name.

Examples:

Delete Host "localhost":

director.objects.delete('Host', 'localhost')

Delete ServiceTemplate "generic-service":

director.objects.delete('ServiceTemplate', 'generic-service')

IMPORTANT: If the object, that is supposed to be deleted is still referenced in the definition of other objects (e.g. a ServiceTemplate used by Services), it cannot be deleted or Director will throw an error. It has to be removed from the object definitions prior to the delete request.