3-objects.md

Objects

objects.get()

To get a single object (Host, Service, ...) use the funtion objects.get().

Parameter	Type	Description
object_type	string	Required. The object type to get, e.g. Host, Service.
name	string	Required. The objects name.
attrs	list	Optional. Get only the specified objects attributes.
joins	bool	Optional. Also get the joined object, e.g. for a Service the Host object.

Examples:

Get host webserver01.domain:

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

Get service ping4 of host webserver01.domain:

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

Get host webserver01.domain but the attributes address and state:

client.objects.get('Host', 'webserver01.domain', attrs=['address', 'state'])

Get service ping4 of host webserver01.domain and the host attributes:

client.objects.get('Service', 'webserver01.domain!ping4', joins=True)

objects.list()

To get a list of objects (Host, Service, ...) use the funtion objects.list(). You can use filters to ...

Parameter	Type	Description
object_type	string	Required. The object type to get, e.g. Host, Service.
name	string	Optional. The objects name.
attrs	list	Optional. Get only the specified objects attributes.
filters	string	Optional. The filter expression, see documentation.
filter_vars	dictionary	Optional. Variables which are available to your filter expression.
joins	bool	Optional. Also get the joined object, e.g. for a Service the Host object.

Examples:

Get all hosts:

client.objects.list('Host')

Get all hosts but limit attributes to address and state

client.objects.list('Host', attrs=['address', 'state'])

Get all hosts which have "webserver" in their host name

client.objects.list('Host', filters='match("webserver\*", host.name)')

Get all services which names start with "vHost" and are assigned to hosts named "webserver*" using filter_vars

hostname_pattern = 'webserver\*'
service_pattern = 'vHost\*'
client.objects.list('Service',
                    filters='match(hpattern, host.name) && match(spattern, service.name)',
                    filter_vars={'hpattern': hostname_pattern, 'spattern': service_pattern})

Get all services and the joined host name:

client.objects.list('Service', joins=['host.name'])

objects.create()

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

Parameter	Type	Description
object_type	string	Required. The object type to get, e.g. Host, Service.
name	string	Optional. The objects name.
templates	list	Optional. A list of templates to import.
attrs	dictionary	Optional. The objects attributes.

Examples:

Create a host:

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

Create a service for Host "localhost":

client.objects.create(
    'Service',
    'localhost!dummy',
    ['generic-service'],
    {'check_command': 'dummy'})

objects.update()

Update an object with the specified attributes.

Parameter	Type	Description
object_type	string	Required. The object type to get, e.g. Host, Service.
name	string	Optional. The objects name.
attrs	dictionary	Optional. The objects attributes.

Examples:

Change the ip address of a host:

client.objects.update(
    'Host',
    'localhost',
    {'address': '127.0.1.1'})

Update a service and change the check interval:

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

objects.delete()

Update an object with the specified attributes.

Parameter	Type	Description
object_type	string	Required. The object type to get, e.g. Host, Service.
name	string	Optional. The objects name.
filters	string	Optional. Filter expression for matching the objects.
filter_vars	dictionary	Optional. Variables which are available to your filter expression.
cascade	boolean	Optional. Also delete dependent objects. Defaults to True.

Examples:

Delete the "localhost":

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

Delete all services matching vhost\*:

client.objects.delete('Service', filters='match("vhost\*", service.name)')