Welcome to pynag’s documentation!¶

Control Package¶

The Control module includes classes to control the Nagios service and the Command submodule wraps Nagios commands.

class pynag.Control.daemon(nagios_bin='/usr/bin/nagios', nagios_cfg='/etc/nagios/nagios.cfg', nagios_init=None, sudo=True, shell=None, service_name='nagios', nagios_config=None)¶

Bases: object

Control the nagios daemon through python

>>> from pynag.Control import daemon
>>>
>>> d = daemon()   
>>> d.restart()    

SYSTEMD = 3¶

SYSV_INIT_SCRIPT = 1¶

SYSV_INIT_SERVICE = 2¶

reload()¶

Reloads Nagios.

Returns:	Return code of the reload command ran by pynag.Utils.runCommand()
Return type:	int

restart()¶

Restarts Nagios via it’s init script.

Returns:	Return code of the restart command ran by pynag.Utils.runCommand()
Return type:	int

running()¶

Checks if the daemon is running

Returns:	Whether or not the daemon is running
Return type:	bool

start()¶

Start the Nagios service.

Returns:	Return code of the start command ran by pynag.Utils.runCommand()
Return type:	int

status()¶

Obtain the status of the Nagios service.

Returns:	Return code of the status command ran by pynag.Utils.runCommand()
Return type:	int

stop()¶

Stop the Nagios service.

Returns:	Return code of the stop command ran by pynag.Utils.runCommand()
Return type:	int

systemd_service_path = '/usr/lib/systemd/system'¶

verify_config()¶

Run nagios -v config_file to verify that the conf is working

Returns:	True – if pynag.Utils.runCommand() returns 0, else None

Subpackages¶

Model Package¶

This module provides a high level Object-Oriented wrapper around pynag.Parsers.config.

Example:

>>> from pynag.Model import Service, Host
>>>
>>> all_services = Service.objects.all
>>> my_service = all_services[0]
>>> print my_service.host_name 
localhost
>>>
>>> example_host = Host.objects.filter(host_name="host.example.com")
>>> canadian_hosts = Host.objects.filter(host_name__endswith=".ca")
>>>
>>> for i in canadian_hosts:
...     i.alias = "this host is located in Canada"
...     i.save() 

class pynag.Model.Command(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

command_line¶

This is the %s attribute for object definition

command_name¶

This is the %s attribute for object definition

object_type = 'command'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c09d0>¶

rename(shortname)¶

Rename this command, and reconfigure all related objects

class pynag.Model.Contact(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

add_to_contactgroup(contactgroup)¶

address¶

This is the %s attribute for object definition

alias¶

This is the %s attribute for object definition

can_submit_commands¶

This is the %s attribute for object definition

contact_name¶

This is the %s attribute for object definition

contactgroups¶

This is the %s attribute for object definition

delete(recursive=False, cleanup_related_items=True)¶

Delete this contact and optionally remove references in groups and escalations

Works like ObjectDefinition.delete() except:

Arguments:

cleanup_related_items – If True, remove all references to this contact in contactgroups and escalations recursive – If True, remove escalations/dependencies that rely on this (and only this) contact

email¶

This is the %s attribute for object definition

get_effective_contactgroups()¶

Get a list of all Contactgroup that are hooked to this contact

get_effective_hosts()¶

Get a list of all Host that are hooked to this Contact

get_effective_services()¶

Get a list of all Service that are hooked to this Contact

host_notification_commands¶

This is the %s attribute for object definition

host_notification_options¶

This is the %s attribute for object definition

host_notification_period¶

This is the %s attribute for object definition

host_notifications_enabled¶

This is the %s attribute for object definition

object_type = 'contact'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0a50>¶

pager¶

This is the %s attribute for object definition

remove_from_contactgroup(contactgroup)¶

rename(shortname)¶

Renames this object, and triggers a change in related items as well.

Args:

shortname: New name for this object

Returns:

None

retain_nonstatus_information¶

This is the %s attribute for object definition

retain_status_information¶

This is the %s attribute for object definition

service_notification_commands¶

This is the %s attribute for object definition

service_notification_options¶

This is the %s attribute for object definition

service_notification_period¶

This is the %s attribute for object definition

service_notifications_enabled¶

This is the %s attribute for object definition

class pynag.Model.Contactgroup(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

add_contact(contact_name)¶

Adds one specific contact to this contactgroup.

alias¶

This is the %s attribute for object definition

contactgroup_members¶

This is the %s attribute for object definition

contactgroup_name¶

This is the %s attribute for object definition

delete(recursive=False, cleanup_related_items=True)¶

Delete this contactgroup and optionally remove references in hosts/services

Works like ObjectDefinition.delete() except:

Arguments:

cleanup_related_items – If True, remove all references to this group in hosts,services,etc. recursive – If True, remove dependant escalations.

get_effective_contactgroups()¶

Returns a list of every Contactgroup that is a member of this Contactgroup

get_effective_contacts()¶

Returns a list of every Contact that is a member of this Contactgroup

get_effective_hosts()¶

Return every Host that belongs to this contactgroup

get_effective_services()¶

Return every Host that belongs to this contactgroup

members¶

This is the %s attribute for object definition

object_type = 'contactgroup'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0c50>¶

remove_contact(contact_name)¶

Remove one specific contact from this contactgroup

rename(shortname)¶

Renames this object, and triggers a change in related items as well.

Args:

shortname: New name for this object

Returns:

None

class pynag.Model.Host(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

2d_coords¶

This is the %s attribute for object definition

3d_coords¶

This is the %s attribute for object definition

acknowledge(sticky=1, notify=1, persistent=0, author='pynag', comment='acknowledged by pynag', recursive=False, timestamp=None)¶

action_url¶

This is the %s attribute for object definition

active_checks_enabled¶

This is the %s attribute for object definition

add_to_contactgroup(contactgroup)¶

add_to_hostgroup(hostgroup_name)¶

Add host to a hostgroup

address¶

This is the %s attribute for object definition

alias¶

This is the %s attribute for object definition

check_command¶

This is the %s attribute for object definition

check_freshness¶

This is the %s attribute for object definition

check_interval¶

This is the %s attribute for object definition

check_period¶

This is the %s attribute for object definition

contact_groups¶

This is the %s attribute for object definition

contacts¶

This is the %s attribute for object definition

copy(recursive=False, filename=None, **args)¶

Same as ObjectDefinition.copy() except can recursively copy services

delete(recursive=False, cleanup_related_items=True)¶

Delete this host and optionally its services

Works like ObjectDefinition.delete() except for:

Arguments:

cleanup_related_items – If True, remove references found in hostgroups and escalations recursive – If True, also delete all services of this host

display_name¶

This is the %s attribute for object definition

downtime(start_time=None, end_time=None, trigger_id=0, duration=7200, author=None, comment='Downtime scheduled by pynag', recursive=False)¶

Put this object in a schedule downtime.

Arguments:

start_time – When downtime should start. If None, use time.time() (now) end_time – When scheduled downtime should end. If None use start_time + duration duration – Alternative to end_time, downtime lasts for duration seconds. Default 7200 seconds. trigger_id – trigger_id>0 means that this downtime should trigger another downtime with trigger_id. author – name of the contact scheduling downtime. If None, use current system user comment – Comment that will be put in with the downtime recursive – Also schedule same downtime for all service of this host.

Returns:

None because commands sent to nagios have no return values

Raises:

PynagError if this does not look an active object.

event_handler¶

This is the %s attribute for object definition

event_handler_enabled¶

This is the %s attribute for object definition

first_notification_delay¶

This is the %s attribute for object definition

flap_detection_enabled¶

This is the %s attribute for object definition

flap_detection_options¶

This is the %s attribute for object definition

freshness_threshold¶

This is the %s attribute for object definition

get_current_status()¶

Returns a dictionary with status data information for this object

get_effective_check_command()¶

Returns a Command object as defined by check_command attribute

Raises KeyError if check_command is not found or not defined.

get_effective_contact_groups()¶

Returns a list of all Contactgroup that belong to this Host

get_effective_contacts()¶

Returns a list of all Contact that belong to this Host

get_effective_hostgroups()¶

Returns a list of all Hostgroup that belong to this Host

get_effective_network_children(recursive=False)¶

Get all objects that depend on this one via “parents” attribute

Arguments:

recursive - If true include grandchildren in list to be returned

Returns:

a list of ObjectDefinition objects

get_effective_network_parents(recursive=False)¶

Get all objects this one depends on via “parents” attribute

Arguments:

recursive - If true include grandparents in list to be returned

Returns:

a list of ObjectDefinition objects

get_effective_services()¶

Returns a list of all Service that belong to this Host

get_related_objects()¶

high_flap_threshold¶

This is the %s attribute for object definition

host_name¶

This is the %s attribute for object definition

hostgroups¶

This is the %s attribute for object definition

icon_image¶

This is the %s attribute for object definition

icon_image_alt¶

This is the %s attribute for object definition

initial_state¶

This is the %s attribute for object definition

low_flap_threshold¶

This is the %s attribute for object definition

max_check_attempts¶

This is the %s attribute for object definition

notes¶

This is the %s attribute for object definition

notes_url¶

This is the %s attribute for object definition

notification_interval¶

This is the %s attribute for object definition

notification_options¶

This is the %s attribute for object definition

notification_period¶

This is the %s attribute for object definition

notifications_enabled¶

This is the %s attribute for object definition

object_type = 'host'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd852d8c210>¶

obsess_over_host¶

This is the %s attribute for object definition

parents¶

This is the %s attribute for object definition

passive_checks_enabled¶

This is the %s attribute for object definition

process_perf_data¶

This is the %s attribute for object definition

remove_from_contactgroup(contactgroup)¶

remove_from_hostgroup(hostgroup_name)¶

Removes host from specified hostgroup

rename(shortname)¶

Rename this host, and modify related objects

retain_nonstatus_information¶

This is the %s attribute for object definition

retain_status_information¶

This is the %s attribute for object definition

retry_interval¶

This is the %s attribute for object definition

stalking_options¶

This is the %s attribute for object definition

statusmap_image¶

This is the %s attribute for object definition

vrml_image¶

This is the %s attribute for object definition

class pynag.Model.HostDependency(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

dependency_period¶

This is the %s attribute for object definition

dependent_host_name¶

This is the %s attribute for object definition

dependent_hostgroup_name¶

This is the %s attribute for object definition

execution_failure_criteria¶

This is the %s attribute for object definition

host_name¶

This is the %s attribute for object definition

hostgroup_name¶

This is the %s attribute for object definition

inherits_parent¶

This is the %s attribute for object definition

notification_failure_criteria¶

This is the %s attribute for object definition

object_type = 'hostdependency'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0b50>¶

class pynag.Model.HostEscalation(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

contact_groups¶

This is the %s attribute for object definition

contacts¶

This is the %s attribute for object definition

escalation_options¶

This is the %s attribute for object definition

escalation_period¶

This is the %s attribute for object definition

first_notification¶

This is the %s attribute for object definition

host_name¶

This is the %s attribute for object definition

hostgroup_name¶

This is the %s attribute for object definition

last_notification¶

This is the %s attribute for object definition

notification_interval¶

This is the %s attribute for object definition

object_type = 'hostescalation'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0b90>¶

class pynag.Model.Hostgroup(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

action_url¶

This is the %s attribute for object definition

add_host(host_name)¶

Adds host to this group. Behaves like Hostgroup._add_member_to_group

alias¶

This is the %s attribute for object definition

delete(recursive=False, cleanup_related_items=True)¶

Delete this hostgroup and optionally remove references in hosts and services

Works like ObjectDefinition.delete() except:

Arguments:

cleanup_related_items – If True, remove all references to this group in hosts/services,escalations,etc recursive – If True, remove services and escalations that bind to this (and only this) hostgroup

downtime(start_time=None, end_time=None, trigger_id=0, duration=7200, author=None, comment='Downtime scheduled by pynag', recursive=False)¶

Put every host and service in this hostgroup in a schedule downtime.

Arguments:

start_time – When downtime should start. If None, use time.time() (now) end_time – When scheduled downtime should end. If None use start_time + duration duration – Alternative to end_time, downtime lasts for duration seconds. Default 7200 seconds. trigger_id – trigger_id>0 means that this downtime should trigger another downtime with trigger_id. author – name of the contact scheduling downtime. If None, use current system user comment – Comment that will be put in with the downtime recursive – For compatibility with other downtime commands, recursive is always assumed to be true

Returns:

None because commands sent to nagios have no return values

Raises:

PynagError if this does not look an active object.

get_effective_hostgroups()¶

Returns a list of every Hostgroup that is a member of this Hostgroup

get_effective_hosts()¶

Returns a list of all Host that belong to this hostgroup

get_effective_services()¶

Returns a list of all Service that belong to this hostgroup

hostgroup_members¶

This is the %s attribute for object definition

hostgroup_name¶

This is the %s attribute for object definition

members¶

This is the %s attribute for object definition

notes¶

This is the %s attribute for object definition

notes_url¶

This is the %s attribute for object definition

object_type = 'hostgroup'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0c90>¶

remove_host(host_name)¶

Remove host from this group. Behaves like Hostgroup._remove_member_from_group

rename(shortname)¶

Rename this hostgroup, and modify hosts if required

pynag.Model.Object¶

alias of HostEscalation

class pynag.Model.ObjectDefinition(item=None, filename=None, **kwargs)¶

Bases: object

Holds one instance of one particular Object definition

Example:

>>> objects = ObjectDefinition.objects.all
>>> my_object = ObjectDefinition( dict ) 

attribute_appendfield(attribute_name, value)¶

Convenient way to append value to an attribute with a comma seperated value

Example:

>>> myservice = Service()
>>> myservice.attribute_appendfield(attribute_name="contact_groups", value="alladmins")
>>> myservice.contact_groups
'+alladmins'
>>> myservice.attribute_appendfield(attribute_name="contact_groups", value='webmasters')
>>> print myservice.contact_groups
+alladmins,webmasters

attribute_is_empty(attribute_name)¶

Check if the attribute is empty

Parameters:	attribute_name – A attribute such as host_name
Returns:	True or False

attribute_removefield(attribute_name, value)¶

Convenient way to remove value to an attribute with a comma seperated value

Example:

>>> myservice = Service()
>>> myservice.contact_groups = "+alladmins,localadmins"
>>> myservice.attribute_removefield(attribute_name="contact_groups", value='localadmins')
>>> print myservice.contact_groups
+alladmins
>>> myservice.attribute_removefield(attribute_name="contact_groups", value="alladmins")
>>> print myservice.contact_groups
None

attribute_replacefield(attribute_name, old_value, new_value)¶

Convenient way to replace field within an attribute with a comma seperated value

Example:

>>> myservice = Service()
>>> myservice.contact_groups = "+alladmins,localadmins"
>>> myservice.attribute_replacefield(attribute_name="contact_groups", old_value='localadmins', new_value="webmasters")
>>> print myservice.contact_groups
+alladmins,webmasters

copy(recursive=False, filename=None, **args)¶

Copies this object definition with any unsaved changes to a new configuration object

Arguments:

filename: If specified, new object will be saved in this file. recursive: If true, also find any related children objects and copy those **args: Any argument will be treated a modified attribute in the new definition.

Examples:

myhost = Host.objects.get_by_shortname(‘myhost.example.com’)

# Copy this host to a new one myhost.copy( host_name=”newhost.example.com”, address=”127.0.0.1”)

# Copy this host and all its services:

myhost.copy(recursive=True, host_name=”newhost.example.com”, address=”127.0.0.1”)

Returns:

• A copy of the new ObjectDefinition
• A list of all copies objects if recursive is True

delete(recursive=False, cleanup_related_items=True)¶

Deletes this object definition from its configuration files.

Parameters:	recursive – If True, look for items that depend on this object and delete them as well (for example, if you delete a host, delete all its services as well) cleanup_related_items – If True, look for related items and remove references to this one. (for example, if you delete a host, remove its name from all hostgroup.members entries)

get(value, default=None)¶

self.get(x) == self[x]

get_all_macros()¶

Returns {macroname:macrovalue} hash map of this object’s macros

get_attribute(attribute_name)¶

Get one attribute from our object definition

Parameters:	attribute_name – A attribute such as host_name

get_attribute_tuple()¶

Returns all relevant attributes in the form of:

(attribute_name,defined_value,inherited_value)

get_description()¶

Returns a human friendly string describing current object.

It will try the following in order: * return self.name (get the generic name) * return self get_shortname() * return “Untitled $object_type”

get_effective_children(recursive=False)¶

Get a list of all objects that inherit this object via “use” attribute

Parameters:	recursive – If true, include grandchildren as well
Returns:	A list of ObjectDefinition objects

get_effective_command_line(host_name=None)¶

Return a string of this objects check_command with all macros (i.e. $HOSTADDR$) resolved

get_effective_notification_command_line(host_name=None, contact_name=None)¶

Get this objects notifications with all macros (i.e. $HOSTADDR$) resolved

Parameters:	host_name – Simulate notification using this host. If None: Use first valid host (used for services) contact_name – Simulate notification for this contact. If None: use first valid contact for the service
Returns:	string of this objects notifications

get_effective_parents(recursive=False, cache_only=False)¶

Get all objects that this one inherits via “use” attribute

Arguments:

recursive - If true include grandparents in list to be returned

Returns:

a list of ObjectDefinition objects

get_filename()¶

Get name of the config file which defines this object

get_id()¶

Return a unique ID for this object

get_macro(macroname, host_name=None, contact_name=None)¶

Take macroname (e.g. $USER1$) and return its actual value

Arguments:

macroname – Macro that is to be resolved. For example $HOSTADDRESS$ host_name – Optionally specify host (use this for services that

– don’t define host specifically for example ones that only – define hostgroups

Returns:

(str) Actual value of the macro. For example “$HOSTADDRESS$” becomes “127.0.0.1”

get_parents()¶

Out-dated, use get_effective_parents instead. Kept here for backwards compatibility

get_related_objects()¶

Returns a list of ObjectDefinition that depend on this object

Object can “depend” on another by a ‘use’ or ‘host_name’ or similar attribute

Returns:

List of ObjectDefinition objects

get_shortname()¶

Returns shortname of an object in string format.

For the confused, nagios documentation refers to shortnames usually as <object_type>_name.

• In case of Host it returns host_name
• In case of Command it returns command_name
• etc
• Special case for services it returns “host_name/service_description”

Returns None if no attribute can be found to use as a shortname

get_suggested_filename()¶

Get a suitable configuration filename to store this object in

Returns:	filename, eg str(‘/etc/nagios/pynag/templates/hosts.cfg’)

has_key(key)¶

Same as key in self

is_defined(attribute_name)¶

Returns True if attribute_name is defined in this object

is_dirty()¶

Returns true if any attributes has been changed on this object, and therefore it needs saving

is_registered()¶

Returns true if object is enabled (registered)

items()¶

keys()¶

move(filename)¶

Move this object definition to a new file. It will be deleted from current file.

This is the same as running:

>>> self.copy(filename=filename) 
>>> self.delete() 

Returns:	The new object definition

name¶

This is the %s attribute for object definition

object_type = None¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0690>¶

register¶

This is the %s attribute for object definition

reload_object()¶

Re-applies templates to this object (handy when you have changed the use attribute

rename(shortname)¶

Change the shortname of this object

Most objects that inherit this one, should also be responsible for updating related objects about the rename.

Args:

shortname: New name for this object

Returns:

None

rewrite(*args, **kw)¶

run_check_command(host_name=None)¶

Run the check_command defined by this service. Returns return_code,stdout,stderr

save(*args, **kw)¶

set_attribute(attribute_name, attribute_value)¶

Set (but does not save) one attribute in our object

Parameters:	attribute_name – A attribute such as host_name attribute_value – The value you would like to set

set_filename(filename)¶

Set name of the config file which this object will be written to on next save.

set_macro(macroname, new_value)¶

Update a macro (custom variable) like $ARG1$ intelligently

Returns: None

Notes: You are responsible for calling .save() after modifying the object

Examples:

>>> s = Service()
>>> s.check_command = 'okc-execute!arg1!arg2'
>>> s.set_macro('$ARG1$', 'modified1')
>>> s.check_command
'okc-execute!modified1!arg2'
>>> s.set_macro('$ARG5$', 'modified5')
>>> s.check_command
'okc-execute!modified1!arg2!!!modified5'
>>> s.set_macro('$_SERVICE_TEST$', 'test')
>>> s['__TEST']
'test'

unregister(recursive=True)¶

Short for self[‘register’] = 0 ; self.save()

use¶

This is the %s attribute for object definition

class pynag.Model.ObjectFetcher(object_type)¶

Bases: object

This class is a wrapper around pynag.Parsers.config. Is responsible for fetching dict objects from config.data and turning into high ObjectDefinition objects

Internal variables:

• _cached_objects = List of every ObjectDefinition
• _cached_id[o.get_id()] = o
• _cached_shortnames[o.object_type][o.get_shortname()] = o
• _cached_names[o.object_type][o.name] = o
• _cached_object_type[o.object_type].append( o )

all¶

filter(**kwargs)¶

Returns all objects that match the selected filter

Example:

Get all services where host_name is examplehost.example.com

>>> Service.objects.filter(host_name='examplehost.example.com') 

Get service with host_name=examplehost.example.com and service_description=’Ping’

>>> Service.objects.filter(host_name='examplehost.example.com',
...                        service_description='Ping') 

Get all services that are registered but without a host_name

>>> Service.objects.filter(host_name=None,register='1') 

Get all hosts that start with ‘exampleh’

>>> Host.objects.filter(host_name__startswith='exampleh') 

Get all hosts that end with ‘example.com’

>>> Service.objects.filter(host_name__endswith='example.com') 

Get all contactgroups that contain ‘dba’

>>> Contactgroup.objects.filter(host_name__contains='dba') 

Get all hosts that are not in the ‘testservers’ hostgroup

>>> Host.objects.filter(hostgroup_name__notcontains='testservers') 

Get all services with non-empty name

>>> Service.objects.filter(name__isnot=None) 

Get all hosts that have an address:

>>> Host.objects.filter(address_exists=True) 

get_all(*args, **kw)¶

get_by_id(id, cache_only=False)¶

Get one specific object

Returns:	ObjectDefinition
Raises:	ValueError if object is not found

get_by_name(object_name, cache_only=False)¶

Get one specific object by its object_name (i.e. name attribute)

Returns:	ObjectDefinition
Raises:	ValueError if object is not found

get_by_shortname(shortname, cache_only=False)¶

Get one specific object by its shortname (i.e. host_name for host, etc)

Parameters:	shortname – shortname of the object. i.e. host_name, command_name, etc. cache_only – If True, dont check if configuration files have changed since last parse
Returns:	ObjectDefinition
Raises:	ValueError if object is not found

get_object_types()¶

Returns a list of all discovered object types

needs_reload(*args, **kw)¶

reload_cache(*args, **kw)¶

class pynag.Model.ObjectRelations¶

Bases: object

Static container for objects and their respective neighbours

command_host = defaultdict(<type 'set'>, {})¶

command_service = defaultdict(<type 'set'>, {})¶

contact_contactgroups = defaultdict(<type 'set'>, {})¶

contact_hosts = defaultdict(<type 'set'>, {})¶

contact_services = defaultdict(<type 'set'>, {})¶

contactgroup_contactgroups = defaultdict(<type 'set'>, {})¶

contactgroup_contacts = defaultdict(<type 'set'>, {})¶

contactgroup_hosts = defaultdict(<type 'set'>, {})¶

contactgroup_services = defaultdict(<type 'set'>, {})¶

contactgroup_subgroups = defaultdict(<type 'set'>, {})¶

host_contact_groups = defaultdict(<type 'set'>, {})¶

host_contacts = defaultdict(<type 'set'>, {})¶

host_hostgroups = defaultdict(<type 'set'>, {})¶

host_services = defaultdict(<type 'set'>, {})¶

hostgroup_hostgroups = defaultdict(<type 'set'>, {})¶

hostgroup_hosts = defaultdict(<type 'set'>, {})¶

hostgroup_services = defaultdict(<type 'set'>, {})¶

hostgroup_subgroups = defaultdict(<type 'set'>, {})¶

static reset()¶

Runs clear() on every member attribute in ObjectRelations

static resolve_contactgroups()¶

Update all contactgroup relations to take into account contactgroup.contactgroup_members

static resolve_hostgroups()¶

Update all hostgroup relations to take into account hostgroup.hostgroup_members

static resolve_regex()¶

If any object relations are a regular expression, then expand them into a full list

static resolve_servicegroups()¶

Update all servicegroup relations to take into account servicegroup.servicegroup_members

service_contact_groups = defaultdict(<type 'set'>, {})¶

service_contacts = defaultdict(<type 'set'>, {})¶

service_hostgroups = defaultdict(<type 'set'>, {})¶

service_hosts = defaultdict(<type 'set'>, {})¶

service_servicegroups = defaultdict(<type 'set'>, {})¶

servicegroup_members = defaultdict(<type 'set'>, {})¶

servicegroup_servicegroups = defaultdict(<type 'set'>, {})¶

servicegroup_services = defaultdict(<type 'set'>, {})¶

servicegroup_subgroups = defaultdict(<type 'set'>, {})¶

use = defaultdict(<function <lambda> at 0x7fd8529b7b90>, {})¶

class pynag.Model.Service(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

acknowledge(sticky=1, notify=1, persistent=0, author='pynag', comment='acknowledged by pynag', timestamp=None)¶

action_url¶

This is the %s attribute for object definition

active_checks_enabled¶

This is the %s attribute for object definition

add_to_contactgroup(contactgroup)¶

add_to_servicegroup(servicegroup_name)¶

Add this service to a specific servicegroup

check_command¶

This is the %s attribute for object definition

check_freshness¶

This is the %s attribute for object definition

check_interval¶

This is the %s attribute for object definition

check_period¶

This is the %s attribute for object definition

contact_groups¶

This is the %s attribute for object definition

contacts¶

This is the %s attribute for object definition

display_name¶

This is the %s attribute for object definition

downtime(start_time=None, end_time=None, trigger_id=0, duration=7200, author=None, comment='Downtime scheduled by pynag', recursive=False)¶

Put this object in a schedule downtime.

Arguments:

start_time – When downtime should start. If None, use time.time() (now) end_time – When scheduled downtime should end. If None use start_time + duration duration – Alternative to end_time, downtime lasts for duration seconds. Default 7200 seconds. trigger_id – trigger_id>0 means that this downtime should trigger another downtime with trigger_id. author – name of the contact scheduling downtime. If None, use current system user comment – Comment that will be put in with the downtime recursive – Here for compatibility. Has no effect on a service.

Returns:

None because commands sent to nagios have no return values

Raises:

PynagError if this does not look an active object.

event_handler¶

This is the %s attribute for object definition

event_handler_enabled¶

This is the %s attribute for object definition

first_notification_delay¶

This is the %s attribute for object definition

flap_detection_enabled¶

This is the %s attribute for object definition

flap_detection_options¶

This is the %s attribute for object definition

freshness_threshold¶

This is the %s attribute for object definition

get_current_status()¶

Returns a dictionary with status data information for this object

get_effective_check_command()¶

Returns a Command object as defined by check_command attribute

Raises KeyError if check_command is not found or not defined.

get_effective_contact_groups()¶

Returns a list of all Contactgroup that belong to this Service

get_effective_contacts()¶

Returns a list of all Contact that belong to this Service

get_effective_hostgroups()¶

Returns a list of all Hostgroup that belong to this Service

get_effective_hosts()¶

Returns a list of all Host that belong to this Service

get_effective_servicegroups()¶

Returns a list of all Servicegroup that belong to this Service

get_shortname()¶

high_flap_threshold¶

This is the %s attribute for object definition

host_name¶

This is the %s attribute for object definition

hostgroup_name¶

This is the %s attribute for object definition

icon_image¶

This is the %s attribute for object definition

icon_image_alt¶

This is the %s attribute for object definition

initial_state¶

This is the %s attribute for object definition

is_volatile¶

This is the %s attribute for object definition

low_flap_threshold¶

This is the %s attribute for object definition

max_check_attempts¶

This is the %s attribute for object definition

merge_with_host()¶

Moves a service from its original file to the same file as the first effective host

notes¶

This is the %s attribute for object definition

notes_url¶

This is the %s attribute for object definition

notification_interval¶

This is the %s attribute for object definition

notification_options¶

This is the %s attribute for object definition

notification_period¶

This is the %s attribute for object definition

notifications_enabled¶

This is the %s attribute for object definition

object_type = 'service'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0990>¶

obsess_over_service¶

This is the %s attribute for object definition

passive_checks_enabled¶

This is the %s attribute for object definition

process_perf_data¶

This is the %s attribute for object definition

remove_from_contactgroup(contactgroup)¶

remove_from_servicegroup(servicegroup_name)¶

remove this service from a specific servicegroup

rename(shortname)¶

Not implemented. Do not use.

retain_nonstatus_information¶

This is the %s attribute for object definition

retain_status_information¶

This is the %s attribute for object definition

retry_interval¶

This is the %s attribute for object definition

service_description¶

This is the %s attribute for object definition

servicegroups¶

This is the %s attribute for object definition

stalking_options¶

This is the %s attribute for object definition

class pynag.Model.ServiceDependency(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

dependency_period¶

This is the %s attribute for object definition

dependent_host_name¶

This is the %s attribute for object definition

dependent_hostgroup_name¶

This is the %s attribute for object definition

dependent_service_description¶

This is the %s attribute for object definition

execution_failure_criteria¶

This is the %s attribute for object definition

host_name¶

This is the %s attribute for object definition

hostgroup_name¶

This is the %s attribute for object definition

inherits_parent¶

This is the %s attribute for object definition

notification_failure_criteria¶

This is the %s attribute for object definition

object_type = 'servicedependency'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0b10>¶

service_description¶

This is the %s attribute for object definition

class pynag.Model.ServiceEscalation(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

contact_groups¶

This is the %s attribute for object definition

contacts¶

This is the %s attribute for object definition

escalation_options¶

This is the %s attribute for object definition

escalation_period¶

This is the %s attribute for object definition

first_notification¶

This is the %s attribute for object definition

host_name¶

This is the %s attribute for object definition

hostgroup_name¶

This is the %s attribute for object definition

last_notification¶

This is the %s attribute for object definition

notification_interval¶

This is the %s attribute for object definition

object_type = 'serviceescalation'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0bd0>¶

service_description¶

This is the %s attribute for object definition

class pynag.Model.Servicegroup(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

action_url¶

This is the %s attribute for object definition

add_service(shortname)¶

Adds service to this group. Behaves like _add_object_to_group(object, group)

alias¶

This is the %s attribute for object definition

downtime(start_time=None, end_time=None, trigger_id=0, duration=7200, author=None, comment='Downtime scheduled by pynag', recursive=False)¶

Put every host and service in this servicegroup in a schedule downtime.

Arguments:

start_time – When downtime should start. If None, use time.time() (now) end_time – When scheduled downtime should end. If None use start_time + duration duration – Alternative to end_time, downtime lasts for duration seconds. Default 7200 seconds. trigger_id – trigger_id>0 means that this downtime should trigger another downtime with trigger_id. author – name of the contact scheduling downtime. If None, use current system user comment – Comment that will be put in with the downtime recursive – For compatibility with other downtime commands, recursive is always assumed to be true

Returns:

None because commands sent to nagios have no return values

Raises:

PynagError if this does not look an active object.

get_effective_servicegroups()¶

Returns a list of every Servicegroup that is a member of this Servicegroup

get_effective_services()¶

Returns a list of all Service that belong to this Servicegroup

members¶

This is the %s attribute for object definition

notes¶

This is the %s attribute for object definition

notes_url¶

This is the %s attribute for object definition

object_type = 'servicegroup'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0cd0>¶

remove_service(shortname)¶

remove service from this group. Behaves like _remove_object_from_group(object, group)

servicegroup_members¶

This is the %s attribute for object definition

servicegroup_name¶

This is the %s attribute for object definition

class pynag.Model.Timeperiod(item=None, filename=None, **kwargs)¶

Bases: pynag.Model.ObjectDefinition

alias¶

This is the %s attribute for object definition

exclude¶

This is the %s attribute for object definition

object_type = 'timeperiod'¶

objects = <pynag.Model.ObjectFetcher object at 0x7fd8529c0d10>¶

timeperiod_name¶

This is the %s attribute for object definition

pynag.Model.eventhandlers = []¶

eventhandlers – A list of Model.EventHandlers object.

all_attributes Module¶

macros Module¶

This file contains a dict object that maps Nagios Standard macronames to specific values.

i.e. macros[‘$HOSTADDR$’] should return ‘address’

Subpackages¶

Parsers Package¶

This module contains low-level Parsers for nagios configuration and status objects.

Hint: If you are looking to parse some nagios configuration data, you probably want pynag.Model module instead.

The highlights of this module are:

class Config: For Parsing nagios local nagios configuration files class Livestatus: To connect to MK-Livestatus class StatusDat: To read info from status.dat (not used a lot, migrate to mk-livestatus) class LogFiles: To read nagios log-files class MultiSite: To talk with multiple Livestatus instances

class pynag.Parsers.Config(cfg_file=None, strict=False)¶

Bases: object

Parse and write nagios config files

abspath(path)¶

Return the absolute path of a given relative path.

The current working directory is assumed to be the dirname of nagios.cfg

Args:

path: relative path to be transformed into absolute path. (string)

Returns:

Absolute path of given relative path.

Example:

>>> c = config(cfg_file="/etc/nagios/nagios.cfg")
>>> c.abspath('nagios.cfg')
'/etc/nagios/nagios.cfg'
>>> c.abspath('/etc/nagios/nagios.cfg')
'/etc/nagios/nagios.cfg'

access(*args, **kwargs)¶

Wrapper around os.access

cleanup()¶

Remove configuration files that have no configuration items

commit()¶

Write any changes that have been made to it’s appropriate file

compareObjects(item1, item2)¶

Compares two items. Returns true if they are equal

Compares every key: value pair for both items. If anything is different, the items will not be considered equal.

Args:

item1, item2: Items to be compared.

Returns:

True – Items are equal

False – Items are not equal

delete_host(object_name, user_key=None)¶

Delete a host from its configuration files

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

True on success.

delete_hostgroup(object_name, user_key=None)¶

Delete a hostgroup from its configuration files

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

True on success.

delete_object(object_type, object_name, user_key=None)¶

Delete object from configuration files

Args:

object_type: Type of the object to delete from configuration files.

object_name: Name of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

True on success.

delete_service(service_description, host_name)¶

Delete service from configuration files

Args:

service_description: service_description field value of the object to delete from configuration files.

host_name: host_name field value of the object to delete from configuration files.

Returns:

True on success.

edit_object(item, field_name, new_value)¶

Modifies a (currently existing) item.

Changes are immediate (i.e. there is no commit)

Args:

item: Item to modify.

field_name: Field that will be updated.

new_value: Updated value of field field_name

Example Usage:

edit_object( item, field_name=”host_name”, new_value=”examplehost.example.com”)

Returns:

True on success

Warning

THIS FUNCTION IS DEPRECATED. USE item_edit_field() instead

edit_service(target_host, service_description, field_name, new_value)¶

Edit a service’s attributes

Takes a host, service_description pair to identify the service to modify and sets its field field_name to new_value.

Args:

target_host: name of the host to which the service is attached to. (string)

service_description: Service description of the service to modify. (string)

field_name: Field to modify. (string)

new_value: Value to which the field_name field will be updated (string)

Returns:

True on success

Raises:

ParserError if the service is not found

exists(*args, **kwargs)¶

Wrapper around os.path.exists

extended_parse()¶

This parse is used after the initial parse() command is run.

It is only needed if you want extended meta information about hosts or other objects

flag_all_commit()¶

Flag every item in the configuration to be committed This should probably only be used for debugging purposes

get_cfg_dirs()¶

Parses the main config file for configuration directories

Returns:

List of all cfg directories used in this configuration

Example:

print(get_cfg_dirs())
['/etc/nagios/hosts','/etc/nagios/objects',...]

get_cfg_files()¶

Return a list of all cfg files used in this configuration

Filenames are normalised so that if nagios.cfg specifies relative filenames we will convert it to fully qualified filename before returning.

Returns:

List of all configurations files used in the configuration.

Example:

print(get_cfg_files()) [‘/etc/nagios/hosts/host1.cfg’,’/etc/nagios/hosts/host2.cfg’,...]

get_cfg_value(key)¶

Returns one specific value from your nagios.cfg file, None if value is not found.

Arguments:

key: what attribute to fetch from nagios.cfg (example: “command_file” )

Returns:

String of the first value found for

Example:

>>> c = Config() 
>>> log_file = c.get_cfg_value('log_file') 
# Should return something like "/var/log/nagios/nagios.log"

get_command(object_name, user_key=None)¶

Return a Command object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_contact(object_name, user_key=None)¶

Return a Contact object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_contactgroup(object_name, user_key=None)¶

Return a Contactgroup object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_host(object_name, user_key=None)¶

Return a host object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_hostdependency(object_name, user_key=None)¶

Return a hostdependency object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_hostgroup(object_name, user_key=None)¶

Return a hostgroup object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_new_item(object_type, filename)¶

Returns an empty item with all necessary metadata

Creates a new item dict and fills it with usual metadata:

• object_type : object_type (arg)
• filename : filename (arg)
• template_fields = []
• needs_commit = None
• delete_me = None
• defined_attributes = {}
• inherited_attributes = {}
• raw_definition = “define %s {nn} % object_type”

Args:

object_type: type of the object to be created (string)

filename: Path to which the item will be saved (string)

Returns:

A new item with default metadata

get_object(object_type, object_name, user_key=None)¶

Return a complete object dictionary

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: User defined key. Default None. (string)

Returns:

The item found to match all the criterias.

None if object is not found

get_object_types()¶

Returns a list of all discovered object types

get_resource(resource_name)¶

Get a single resource value which can be located in any resource.cfg file

Arguments:

resource_name: Name as it appears in resource file (i.e. $USER1$)

Returns:

String value of the resource value.

Raises:

KeyError if resource is not found

ParserError if resource is not found and you do not have permissions

get_resources()¶

Returns a list of every private resources from nagios.cfg

get_service(target_host, service_description)¶

Return a service object

Args:

target_host: host_name field of the service to be returned. This is the host to which is attached the service.

service_description: service_description field of the service to be returned.

Returns:

The item found to match all the criterias.

get_servicedependency(object_name, user_key=None)¶

Return a servicedependency object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_servicegroup(object_name, user_key=None)¶

Return a Servicegroup object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_timeperiod(object_name, user_key=None)¶

Return a Timeperiod object

Args:

object_name: object_name field value of the object to delete from configuration files.

user_key: user_key to pass to get_object()

Returns:

The item found to match all the criterias.

get_timestamps()¶

Returns hash map of all nagios related files and their timestamps

guess_cfg_file()¶

Returns a path to any nagios.cfg found on your system

Use this function if you don’t want specify path to nagios.cfg in your code and you are confident that it is located in a common location

Checked locations are as follows:

• /etc/nagios/nagios.cfg
• /etc/nagios3/nagios.cfg
• /usr/local/nagios/etc/nagios.cfg
• /nagios/etc/nagios/nagios.cfg
• ./nagios.cfg
• ./nagios/nagios.cfg
• /etc/icinga/icinga.cfg
• /usr/local/icinga/etc/icinga.cfg
• ./icinga.cfg
• ./icinga/icinga.cfg
• /etc/naemon/naemon.cfg
• /usr/local/naemon/etc/naemon.cfg
• ./naemon.cfg
• ./naemon/naemon.cfg
• /etc/shinken/shinken.cfg

Returns:

str. Path to the nagios.cfg or equivalent file

None if couldn’t find a file in any of these locations.

guess_nagios_binary()¶

Returns a path to any nagios binary found on your system

Use this function if you don’t want specify path to the nagios binary in your code and you are confident that it is located in a common location

Checked locations are as follows:

• /usr/bin/nagios
• /usr/sbin/nagios
• /usr/local/nagios/bin/nagios
• /nagios/bin/nagios
• /usr/bin/icinga
• /usr/sbin/icinga
• /usr/bin/naemon
• /usr/sbin/naemon
• /usr/local/naemon/bin/naemon.cfg
• /usr/bin/shinken
• /usr/sbin/shinken

Returns:

str. Path to the nagios binary

None if could not find a binary in any of those locations

guess_nagios_directory()¶

Returns a path to the nagios configuration directory on your system

Use this function for determining the nagios config directory in your code

Returns:

str. directory containing the nagios.cfg file

Raises:

pynag.Parsers.ConfigFileNotFound if cannot guess config file location.

isdir(*args, **kwargs)¶

Wrapper around os.path.isdir

isfile(*args, **kwargs)¶

Wrapper around os.path.isfile

islink(*args, **kwargs)¶

Wrapper around os.path.islink

item_add(item, filename)¶

Adds a new object to a specified config file.

Args:

item: Item to be created

filename: Filename that we are supposed to write the new item to. This is the path to the file. (string)

Returns:

True on success

Raises:

IOError on failed save

item_edit_field(item, field_name, new_value)¶

Modifies one field of a (currently existing) object.

Changes are immediate (i.e. there is no commit)

Args:

item: Item to be modified. Its field field_name will be set to new_value.

field_name: Name of the field that will be modified. (str)

new_value: Value to which will be set the field field_name. (str)

Example usage::

edit_object( item, field_name=”host_name”, new_value=”examplehost.example.com”) # doctest: +SKIP

Returns:

True on success

Raises:

ValueError if object is not found

IOError if save fails

item_remove(item)¶

Delete one specific item from its configuration files

Args:

item: Item that is to be rewritten

str_new_item: string representation of the new item

Examples::

item_remove( item, “define service {n name example-service n register 0 n }n” )

Returns:

True on success

Raises:

ValueError if object is not found

IOError if save fails

item_remove_field(item, field_name)¶

Removes one field of a (currently existing) object.

Changes are immediate (i.e. there is no commit)

Args:

item: Item to remove field from.

field_name: Field to remove. (string)

Example usage::

item_remove_field( item, field_name=”contactgroups” )

Returns:

True on success

Raises:

ValueError if object is not found

IOError if save fails

item_rename_field(item, old_field_name, new_field_name)¶

Renames a field of a (currently existing) item.

Changes are immediate (i.e. there is no commit).

Args:

item: Item to modify.

old_field_name: Name of the field that will have its name changed. (string)

new_field_name: New name given to old_field_name (string)

Example usage::

item_rename_field(item, old_field_name=”normal_check_interval”, new_field_name=”check_interval”)

Returns:

True on success

Raises:

ValueError if object is not found

IOError if save fails

item_rewrite(item, str_new_item)¶

Completely rewrites item with string provided.

Args:

item: Item that is to be rewritten

str_new_item: str representation of the new item

Examples::

item_rewrite( item, “define service {n name example-service n register 0 n }n” )

Returns:

True on success

Raises:

ValueError if object is not found

IOError if save fails

listdir(*args, **kwargs)¶

Wrapper around os.listdir

needs_reload()¶

Checks if the Nagios service needs a reload.

Returns:

True if Nagios service needs reload of cfg files

False if reload not needed or Nagios is not running

needs_reparse()¶

Checks if the Nagios configuration needs to be reparsed.

Returns:

True if any Nagios configuration file has changed since last parse()

open(filename, *args, **kwargs)¶

Wrapper around global open()

Simply calls global open(filename, *args, **kwargs) and passes all arguments as they are received. See global open() function for more details.

parse(*args, **kw)¶

parse_file(filename)¶

Parses a nagios object configuration file and returns lists of dictionaries.

This is more or less a wrapper around config.parse_string(), so reading documentation there is useful.

Args:

filename: Path to the file to parse (string)

Returns:

A list containing elements parsed by parse_string()

parse_maincfg(*args, **kw)¶

parse_string(string, filename='None')¶

Parses a string, and returns all object definitions in that string

Args:

string: A string containing one or more object definitions

filename (optional): If filename is provided, it will be referenced when raising exceptions

Examples:

>>> test_string = "define host {\nhost_name examplehost\n}\n"
>>> test_string += "define service {\nhost_name examplehost\nservice_description example service\n}\n"
>>> c = config()
>>> result = c.parse_string(test_string)
>>> for i in result: print i.get('host_name'), i.get('service_description', None)
examplehost None
examplehost example service

Returns:

A list of dictionaries, that look like self.data

Raises:

ParserError

print_conf(item)¶

Return a string that can be used in a configuration file

Args:

item: Item to be dumped as a string.

Returns:

String representation of item.

readlink(selfself, *args, **kwargs)¶

Wrapper around os.readlink

remove(*args, **kwargs)¶

Wrapper around os.remove

reset()¶

Reinitializes the data of a parser instance to its default values.

stat(*args, **kwargs)¶

Wrapper around os.stat

write(*args, **kw)¶

exception pynag.Parsers.ConfigFileNotFound(message, item=None)¶

Bases: pynag.Parsers.ParserError

This exception is thrown if we cannot locate any nagios.cfg-style config file.

class pynag.Parsers.ExtraOptsParser(section_name=None, config_file=None)¶

Bases: object

Get Nagios Extra-Opts from a config file as specified by http://nagiosplugins.org/extra-opts

We could ALMOST use pythons ConfParser but nagios plugin team thought it would be a good idea to support multiple values per key, so a dict datatype no longer works.

Its a shame because we have to make our own “ini” parser as a result

Usage:

# cat /etc/nagios/plugins.ini
[main]
host_name = localhost
[other section]
host_name = example.com
# EOF

e = ExtraOptsParser(section_name='main', config_file='/etc/nagios/plugins.ini')
e.get('host_name')  # returns "localhost"
e.get_values()  # Returns a dict of all the extra opts
e.getlist('host_name')  # returns all values of host_name (if more than one were specified) in a list

get(option_name, default=<object object at 0x7fd856a39570>)¶

Return the value of one specific option

Args:

option_name: The value set to this option will be returned

Returns:

The value of option_name

Raises:

ValueError when option_name cannot be found in options

get_default_config_file()¶

Return path to first readable extra-opt config-file found

According to the nagiosplugins extra-opts spec the search method is as follows:

1. Search for nagios.ini or nagios-plugins.ini in : splitted variable NAGIOS_CONFIG_PATH
2. Search in a predefined list of files
3. Return None if no config file is found

The method works as follows:

To quote the spec on NAGIOS_CONFIG_PATH:

“To use a custom location, set a NAGIOS_CONFIG_PATH environment variable to the set of directories that should be checked (this is a colon-separated list just like PATH). The first plugins.ini or nagios-plugins.ini file found in these directories will be used.”

get_default_section_name()¶

According to extra-opts standard, the default should be filename of check script being run

get_values()¶

Returns a dict with all extra-options with the granted section_name and config_file

Results are in the form of:

{
  'key': ["possible","values"]
}

getlist(option_name, default=<object object at 0x7fd856a39570>)¶

Return a list of all values for option_name

Args:

option_name: All the values set to this option will be returned

Returns:

List containing all the options set to option_name

Raises:

ValueError when option_name cannot be found in options

parse_file(filename)¶

Parses an ini-file and returns a dict of the ini values.

The datatype returned is a list of sections where each section is a dict of values.

Args:

filename: Full path to the ini-file to be parsed.

Example the following the file:

[main]
name = this is a name
key = value
key = value2

Would return:

[
  {'main':
    {
      'name': ['this is a name'],
      'key': [value, value2]
    }
  },
]

parse_string(string)¶

Parses a string that is supposed to be ini-style format.

See parse_file() for more info

Args:

string: String to be parsed. Should be in ini-file format.

Returns:

Dictionnary containing all the sections of the ini-file and their respective data.

Raises:

ParserError when line does not follow the ini format.

standard_locations = ['/etc/nagios/plugins.ini', '/usr/local/nagios/etc/plugins.ini', '/usr/local/etc/nagios/plugins.ini', '/etc/opt/nagios/plugins.ini', '/etc/nagios-plugins.ini', '/usr/local/etc/nagios-plugins.ini', '/etc/opt/nagios-plugins.ini']¶

class pynag.Parsers.Livestatus(livestatus_socket_path=None, nagios_cfg_file=None, authuser=None)¶

Bases: object

Wrapper around MK-Livestatus

Example usage:

s = Livestatus()
for hostgroup s.get_hostgroups():
    print(hostgroup['name'], hostgroup['num_hosts'])

get(table, *args, **kwargs)¶

Same as self.query(‘GET %s’ % (table,))

Extra arguments will be appended to the query.

Args:

table: Table from which the data will be retrieved

args, kwargs: These will be appendend to the end of the query to perform additionnal instructions.

Example:

get('contacts', 'Columns: name alias')

Returns:

Answer from livestatus in python format.

get_contact(contact_name)¶

Performs a GET query for a particular contact

This performs:

'''GET contacts
Filter: contact_name = %s''' % contact_name

Args:

contact_name: name of the contact to obtain livestatus data from

Returns:

Answer from livestatus in python format.

get_contactgroup(name)¶

Performs a GET query for a particular contactgroup

This performs:

'''GET contactgroups
Filter: contactgroup_name = %s''' % contactgroup_name

Args:

contactgroup_name: name of the contactgroup to obtain livestatus data from

Returns:

Answer from livestatus in python format.

get_contactgroups(*args, **kwargs)¶

Performs a GET query for all contactgroups

This performs:

'''GET contactgroups
%s %s''' % (*args, **kwargs)

Args:

args, kwargs: These will be appendend to the end of the query to perform additionnal instructions.

Returns:

Answer from livestatus in python format.

get_contacts(*args, **kwargs)¶

Performs a GET query for all contacts

This performs:

'''GET contacts
%s %s''' % (*args, **kwargs)

Args:

args, kwargs: These will be appendend to the end of the query to perform additionnal instructions.

Returns:

Answer from livestatus in python format.

get_host(host_name)¶

Performs a GET query for a particular host

This performs:

'''GET hosts
Filter: host_name = %s''' % host_name

Args:

host_name: name of the host to obtain livestatus data from

Returns:

Answer from livestatus in python format.

get_hostgroup(name)¶

Performs a GET query for a particular hostgroup

This performs:

'''GET hostgroups
Filter: hostgroup_name = %s''' % hostgroup_name

Args:

hostgroup_name: name of the hostgroup to obtain livestatus data from

Returns:

Answer from livestatus in python format.

get_hostgroups(*args, **kwargs)¶

Performs a GET query for all hostgroups

This performs:

'''GET hostgroups
%s %s''' % (*args, **kwargs)

Args:

args, kwargs: These will be appendend to the end of the query to perform additionnal instructions.

Returns:

Answer from livestatus in python format.

get_hosts(*args, **kwargs)¶

Performs a GET query for all hosts

This performs:

'''GET hosts %s %s''' % (*args, **kwargs)

Args:

args, kwargs: These will be appendend to the end of the query to perform additionnal instructions.

Returns:

Answer from livestatus in python format.

get_service(host_name, service_description)¶

Performs a GET query for a particular service

This performs:

'''GET services
Filter: host_name = %s
Filter: service_description = %s''' % (host_name, service_description)

Args:

host_name: name of the host the target service is attached to.

service_description: Description of the service to obtain livestatus data from.

Returns:

Answer from livestatus in python format.

get_servicegroup(name)¶

Performs a GET query for a particular servicegroup

This performs:

'''GET servicegroups
Filter: servicegroup_name = %s''' % servicegroup_name

Args:

servicegroup_name: name of the servicegroup to obtain livestatus data from

Returns:

Answer from livestatus in python format.

get_servicegroups(*args, **kwargs)¶

Performs a GET query for all servicegroups

This performs:

'''GET servicegroups
%s %s''' % (*args, **kwargs)

Args:

args, kwargs: These will be appendend to the end of the query to perform additionnal instructions.

Returns:

Answer from livestatus in python format.

get_services(*args, **kwargs)¶

Performs a GET query for all services

This performs:

'''GET services
%s %s''' % (*args, **kwargs)

Args:

args, kwargs: These will be appendend to the end of the query to perform additionnal instructions.

Returns:

Answer from livestatus in python format.

query(query, *args, **kwargs)¶

Performs LQL queries the livestatus socket

Queries are corrected and convienient default data are added to the query before sending it to the socket.

Args:

query: Query to be passed to the livestatus socket (string)

args, kwargs: Additionnal parameters that will be sent to pynag.Utils.grep_to_livestatus(). The result will be appended to the query.

Returns:

Answer from livestatus. It will be in python format unless specified otherwise.

Raises:

ParserError if problems connecting to livestatus.

test(raise_error=True)¶

Test if connection to livestatus socket is working

Args:

raise_error: If set to True, raise exception if test fails,otherwise return False

Raises:

ParserError if raise_error == True and connection fails

Returns:

True – Connection is OK False – there are problems and raise_error==False

exception pynag.Parsers.LivestatusNotConfiguredException(message, item=None)¶

Bases: pynag.Parsers.ParserError

This exception is raised if we tried to autodiscover path to livestatus and failed

class pynag.Parsers.LogFiles(maincfg=None)¶

Bases: object

Parses Logfiles defined in nagios.cfg and allows easy access to its content

Content is stored in python-friendly arrays of dicts. Output should be more or less compatible with mk_livestatus log output

get_flap_alerts(**kwargs)¶

Same as get_log_entries(), except return timeperiod transitions.

Takes same parameters.

get_log_entries(start_time=None, end_time=None, strict=True, search=None, **kwargs)¶

Get Parsed log entries for given timeperiod.

Args:

start_time: unix timestamp. if None, return all entries from today

end_time: If specified, only fetch log entries older than this (unix timestamp)

strict: If True, only return entries between start_time and end_time, if False, then return entries that belong to same log files as given timeset

search: If provided, only return log entries that contain this string (case insensitive)

kwargs: All extra arguments are provided as filter on the log entries. f.e. host_name=”localhost”

Returns:

List of dicts

get_logfiles()¶

Returns a list with the fullpath to every log file used by nagios.

Lists are sorted by modification times. Newest logfile is at the front of the list so usually nagios.log comes first, followed by archivelogs

Returns:

List of strings

get_notifications(**kwargs)¶

Same as get_log_entries(), except return only notifications. Takes same parameters.

get_state_history(start_time=None, end_time=None, host_name=None, strict=True, service_description=None)¶

Returns a list of dicts, with the state history of hosts and services.

Args:

start_time: unix timestamp. if None, return all entries from today

end_time: If specified, only fetch log entries older than this (unix timestamp)

host_name: If provided, only return log entries that contain this string (case insensitive)

service_description: If provided, only return log entries that contain this string (case insensitive)

Returns:

List of dicts with state history of hosts and services

class pynag.Parsers.MultiSite(*args, **kwargs)¶

Bases: pynag.Parsers.Livestatus

Wrapps around multiple Livesatus instances and aggregates the results of queries.

Example:

>>> m = MultiSite()
>>> m.add_backend(path='/var/spool/nagios/livestatus.socket', name='local')
>>> m.add_backend(path='127.0.0.1:5992', name='remote')

add_backend(path, name)¶

Add a new livestatus backend to this instance.

Arguments:

path (str): Path to file socket or remote address name (str): Friendly shortname for this backend

get_backend(backend_name)¶

Return one specific backend that has previously been added

get_backends()¶

Returns a list of mk_livestatus instances

Returns:

list. List of mk_livestatus instances

get_contact(contact_name, backend=None)¶

Same as Livestatus.get_contact()

get_contactgroup(contactgroup_name, backend=None)¶

Same as Livestatus.get_contact()

get_host(host_name, backend=None)¶

Same as Livestatus.get_host()

get_hostgroup(hostgroup_name, backend=None)¶

Same as Livestatus.get_hostgroup()

get_service(host_name, service_description, backend=None)¶

Same as Livestatus.get_service()

get_servicegroup(servicegroup_name, backend=None)¶

Same as Livestatus.get_servicegroup()

query(query, *args, **kwargs)¶

Behaves like mk_livestatus.query() except results are aggregated from multiple backends

Arguments:

backend (str): If specified, fetch only data from this backend (see add_backend()) *args: Passed directly to mk_livestatus.query() **kwargs: Passed directly to mk_livestatus.query()

class pynag.Parsers.ObjectCache(cfg_file=None, strict=False)¶

Bases: pynag.Parsers.Config

Loads the configuration as it appears in objects.cache file

get_cfg_files()¶