Welcome to pynag’s documentation!¶

Control Package¶

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

exception pynag.Control.ControlError(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.errors.PynagError

Base class for all errors in this module.

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¶

init_d_path = '/etc/init.d'¶

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.

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>¶

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>¶

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>¶

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:

ModelError 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>¶

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>¶

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>¶

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:

ModelError 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>¶

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

exception pynag.Model.InvalidMacro(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.Model.ModelError

Raised when a method is inputted with an invalid macro.

exception pynag.Model.ModelError(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.errors.PynagError

Base class for errors in this module.

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>¶

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 0x7f81f3e7a050>, {})¶

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:

ModelError 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>¶

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>¶

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>¶

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:

ModelError 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>¶

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>¶

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 package contains low-level objects and parsers.

If you are looking for a high-level way to parse nagios configs, see pynag.Model instead.

Everything you see in this file is for backwards compatibility only.

Plugins Package¶

Python Nagios extensions

exception pynag.Plugins.PluginError(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.errors.PynagError

Base class for errors in this module.

class pynag.Plugins.PluginHelper¶

Bases: object

PluginHelper takes away some of the tedious work of writing Nagios plugins. Primary features include:

• Keep a collection of your plugin messages (queue for both summary and longoutput)
• Keep record of exit status
• Keep a collection of your metrics (for both perfdata and thresholds)
• Automatic Command-line arguments
• Make sure output of your plugin is within Plugin Developer Guidelines

Usage: p = PluginHelper() p.status(warning) p.add_summary(‘Example Plugin with warning status’) p.add_metric(‘cpu load’, ‘90’) p.exit()

add_long_output(message)¶

Appends message to the end of Plugin long_output. Message does not need a suffix

Examples:

>>> p = PluginHelper()
>>> p.add_long_output('Status of sensor 1')
>>> p.add_long_output('* Temperature: OK')
>>> p.add_long_output('* Humidity: OK')
>>> p.get_long_output()
u'Status of sensor 1\n* Temperature: OK\n* Humidity: OK'

add_metric(label=u'', value=u'', warn=u'', crit=u'', min=u'', max=u'', uom=u'', perfdatastring=None)¶

Add numerical metric (will be outputted as nagios performanca data)

Examples:

>>> p = PluginHelper()
>>> p.add_metric(label="load1", value="7")
>>> p.add_metric(label="load5", value="5")
>>> p.add_metric(label="load15",value="2")
>>> p.get_perfdata()
"'load1'=7;;;; 'load5'=5;;;; 'load15'=2;;;;"

>>> p = PluginHelper()
>>> p.add_metric(perfdatastring="load1=6;;;;")
>>> p.add_metric(perfdatastring="load5=4;;;;")
>>> p.add_metric(perfdatastring="load15=1;;;;")
>>> p.get_perfdata()
"'load1'=6;;;; 'load5'=4;;;; 'load15'=1;;;;"

add_option(*args, **kwargs)¶

Same as self.parser.add_option()

add_status(new_status=None)¶

Update exit status of the nagios plugin. This function will keep history of the worst status added

Examples: >>> p = PluginHelper() >>> p.add_status(0) # ok >>> p.add_status(2) # critical >>> p.add_status(1) # warning >>> p.get_status() # 2

>>> p = PluginHelper()
>>> p.add_status('warning')
>>> p.add_status('ok')
>>> p.get_status()
1
>>> p.add_status('okay')
Traceback (most recent call last):
...
Exception: Invalid status supplied "okay"

add_summary(message)¶

Adds message to Plugin Summary

arguments = None¶

check_all_metrics()¶

Checks all metrics (add_metric() against any thresholds set in self.options.thresholds or with –threshold from commandline)

check_metric(metric_name, thresholds)¶

Check one specific metric against a list of thresholds. Updates self.status() and writes to summary or longout as appropriate.

Arguments:

metric_name – A string representing the name of the metric (the label part of the performance data) thresholds – a list in the form of [ (level,range) ] where range is a string in the format of “start..end”

Examples: >>> p = PluginHelper() >>> thresholds = [(warning,‘2..5’), (critical,‘5..inf’)] >>> p.get_plugin_output() u’Unknown -‘ >>> p.add_metric(‘load15’, ‘3’) >>> p.check_metric(‘load15’,thresholds) >>> p.get_plugin_output() u”Warning - Warning on load15 | ‘load15’=3;@2:5;~:5;;”

>>> p = PluginHelper()
>>> thresholds = [(warning,'2..5'), (critical,'5..inf')]
>>> p.add_metric('load15', '3')
>>> p.verbose = True
>>> p.check_metric('load15',thresholds)
>>> p.get_plugin_output()
u"Warning - Warning on load15 | 'load15'=3;@2:5;~:5;;\nWarning on load15"

Invalid metric: >>> p = PluginHelper() >>> p.add_status(ok) >>> p.add_summary(‘Everythings fine!’) >>> p.get_plugin_output() u’OK - Everythings fine!’ >>> thresholds = [(warning,‘2..5’), (critical,‘5..inf’)] >>> p.check_metric(‘never_added_metric’, thresholds) >>> p.get_plugin_output() u’Unknown - Everythings fine!. Metric never_added_metric not found’

Invalid threshold: >>> p = PluginHelper() >>> thresholds = [(warning, ‘invalid’), (critical,‘5..inf’)] >>> p.add_metric(‘load1’, ‘10’) >>> p.check_metric(‘load1’, thresholds) Traceback (most recent call last): ... SystemExit: 3

Returns:

None

convert_perfdata(perfdata)¶

Converts new threshold range format to old one. Returns None.

Examples:

x..y -> x:y inf..y -> :y -inf..y -> :y x..inf -> x: -inf..inf -> :

debug(message)¶

exit(exit_code=None, summary=None, long_output=None, perfdata=None)¶

Print all collected output to screen and exit nagios style, no arguments are needed

except if you want to override default behavior.

Arguments:

summary – Is this text as the plugin summary instead of self.get_summary() long_output – Use this text as long_output instead of self.get_long_output() perfdata – Use this text instead of self.get_perfdata() exit_code – Use this exit code instead of self.status()

get_default_values(section_name=None, config_file=None)¶

Returns an optionParser.Values instance of all defaults after parsing extra opts config file

The Nagios extra-opts spec we use is the same as described here: http://nagiosplugins.org/extra-opts

Arguments

get_long_output()¶

Returns all long_output that has been added via add_long_output

get_metric(label)¶

Return one specific metric (PerfdataMetric object) with the specified label. Returns None if not found.

Example: >>> p = PluginHelper() >>> p.add_metric(label=”load1”, value=”7”) >>> p.add_metric(label=”load15”,value=”2”) >>> p.get_metric(“load1”) ‘load1’=7;;;; >>> p.get_metric(“unknown”) # Returns None

get_perfdata()¶

Get perfdatastring for all valid perfdatametrics collected via add_perfdata

Examples: >>> p = PluginHelper() >>> p.add_metric(label=”load1”, value=”7”, warn=”-inf..10”, crit=”10..inf”) >>> p.add_metric(label=”load5”, value=”5”, warn=”-inf..7”, crit=”7..inf”) >>> p.add_metric(label=”load15”,value=”2”, warn=”-inf..5”, crit=”5..inf”) >>> p.get_perfdata() “‘load1’=7;10:;~:10;; ‘load5’=5;7:;~:7;; ‘load15’=2;5:;~:5;;”

Example with legacy output (show_legacy should be set with a cmdline option): >>> p.show_legacy = True >>> p.get_perfdata() “‘load1’=7;10:;~:10;; ‘load5’=5;7:;~:7;; ‘load15’=2;5:;~:5;;”

get_plugin_output(exit_code=None, summary=None, long_output=None, perfdata=None)¶

Get all plugin output as it would be printed to screen with self.exit()

Examples of functionality: >>> p = PluginHelper() >>> p.get_plugin_output() u’Unknown -‘

>>> p = PluginHelper()
>>> p.add_summary('Testing')
>>> p.add_long_output('Long testing output')
>>> p.add_long_output('More output')
>>> p.get_plugin_output(exit_code=0)
u'OK - Testing\nLong testing output\nMore output'

>>> p = PluginHelper()
>>> p.add_summary('Testing')
>>> p.add_status(0)
>>> p.get_plugin_output()
u'OK - Testing'

>>> p = PluginHelper()
>>> p.show_status_in_summary = False
>>> p.add_summary('Testing')
>>> p.add_metric(label="load1", value="7")
>>> p.add_metric(label="load5", value="5")
>>> p.add_metric(label="load15",value="2")
>>> p.get_plugin_output(exit_code=0)
u"Testing | 'load1'=7;;;; 'load5'=5;;;; 'load15'=2;;;;"

>>> p = PluginHelper()
>>> p.show_status_in_summary = False
>>> p.add_summary('Testing')
>>> p.add_long_output('Long testing output')
>>> p.add_long_output('More output')
>>> p.add_metric(label="load1", value="7")
>>> p.add_metric(label="load5", value="5")
>>> p.add_metric(label="load15",value="2")
>>> p.get_plugin_output(exit_code=0)
u"Testing | 'load1'=7;;;; 'load5'=5;;;; 'load15'=2;;;;\nLong testing output\nMore output"

get_status()¶

Returns the worst nagios status (integer 0,1,2,3) that has been put with add_status()

If status has never been added, returns 3 for UNKNOWN

get_summary()¶

options = None¶

parse_arguments(argument_list=None)¶

Parsers commandline arguments, prints error if there is a syntax error.

Creates:

self.options – As created by OptionParser.parse() self.arguments – As created by OptionParser.parse()

Arguments:

argument_list – By default use sys.argv[1:], override only if you know what you are doing.

Returns:

None

run_function(function, *args, **kwargs)¶

Executes “function” and exits Nagios style with status “unkown” if there are any exceptions. The stacktrace will be in long_output.

Example: >>> p = PluginHelper() >>> p.add_status(‘ok’) >>> p.get_status() 0 >>> p.add_status(‘okay’) Traceback (most recent call last): ... Exception: Invalid status supplied “okay” >>> p.run_function( p.add_status, ‘warning’ ) >>> p.get_status() 1 >>> p.run_function( p.add_status, ‘okay’ ) Traceback (most recent call last): ... SystemExit: 3

set_long_output(message)¶

Overwrite current long_output with message

Example: >>> s = PluginHelper() >>> s.add_long_output(‘first long output’) >>> s.set_long_output(‘Fatal error’) >>> s.get_long_output() u’Fatal error’

set_summary(message)¶

Overwrite current summary with message

Example: >>> s = PluginHelper() >>> s.add_summary(‘first summary’) >>> s.set_summary(‘Fatal error’) >>> s.get_summary() u’Fatal error’

set_timeout(seconds=50)¶

Configures plugin to timeout after seconds number of seconds

show_debug = False¶

show_legacy = False¶

show_longoutput = True¶

show_perfdata = True¶

show_status_in_summary = True¶

show_summary = True¶

status(new_status=None)¶

Same as get_status() if new_status=None, otherwise call add_status(new_status)

thresholds = None¶

timeout = 58¶

verbose = False¶

class pynag.Plugins.simple(shortname=None, version=None, blurb=None, extra=None, url=None, license=None, plugin=None, timeout=15, must_threshold=True)¶

Bases: object

Nagios plugin helper library based on Nagios::Plugin

Sample usage

from pynag.Plugins import WARNING, CRITICAL, OK, UNKNOWN, simple as Plugin

# Create plugin object np = Plugin() # Add arguments np.add_arg(“d”, “disk”) # Do activate plugin np.activate() ... check stuff, np[‘disk’] to address variable assigned above... # Add a status message and severity np.add_message( WARNING, “Disk nearing capacity” ) # Get parsed code and messages (code, message) = np.check_messages() # Return information and exit nagios_exit(code, message)

activate()¶

Parse out all command line options and get ready to process the plugin. This should be run after argument preps

add_arg(spec_abbr, spec, help_text, required=1, action=u'store')¶

Add an argument to be handled by the option parser. By default, the arg is not required.

required = optional parameter action = [store, append, store_true]

add_message(code, message)¶

Add a message with code to the object. May be called multiple times. The messages added are checked by check_messages, following.

Only CRITICAL, WARNING, OK and UNKNOWN are accepted as valid codes.

add_perfdata(label, value, uom=None, warn=None, crit=None, minimum=None, maximum=None)¶

Append perfdata string to the end of the message

check_messages(joinstr=u' ', joinallstr=None)¶

Check the current set of messages and return an appropriate nagios return code and/or a result message. In scalar context, returns only a return code; in list context returns both a return code and an output message, suitable for passing directly to nagios_exit()

joinstr = string

A string used to join the relevant array to generate the message string returned in list context i.e. if the ‘critical’ array is non-empty, check_messages would return:

joinstr.join(critical)

joinallstr = string

By default, only one set of messages are joined and returned in the result message i.e. if the result is CRITICAL, only the ‘critical’ messages are included in the result; if WARNING, only the ‘warning’ messages are included; if OK, the ‘ok’ messages are included (if supplied) i.e. the default is to return an ‘errors-only’ type message.

If joinallstr is supplied, however, it will be used as a string to join the resultant critical, warning, and ok messages together i.e. all messages are joined and returned.

check_perfdata_as_metric()¶

check_range(value)¶

Check if a value is within a given range. This should replace change_threshold eventually. Exits with appropriate exit code given the range.

Taken from: http://nagiosplug.sourceforge.net/developer-guidelines.html Range definition

Generate an alert if x... 10 < 0 or > 10, (outside the range of {0 .. 10}) 10: < 10, (outside {10 .. #}) ~:10 > 10, (outside the range of {-# .. 10}) 10:20 < 10 or > 20, (outside the range of {10 .. 20}) @10:20 # 10 and # 20, (inside the range of {10 .. 20})

code_string2int(code_text)¶

Changes CRITICAL, WARNING, OK and UNKNOWN code_text to integer representation for use within add_message() and nagios_exit()

nagios_exit(code_text, message)¶

Exit with exit_code, message, and optionally perfdata

perfdata_string()¶

send_nsca(*args, **kwargs)¶

Wrapper around pynag.Utils.send_nsca - here for backwards compatibility

new_threshold_syntax Module¶

These are helper functions and implementation of proposed new threshold format for nagios plugins according to: http://nagiosplugins.org/rfc/new_threshold_syntax

In short, plugins should implement a –threshold option which takes argument in form of:

# metric={metric},ok={range},warn={range},crit={range},unit={unit}prefix={SI prefix}

Example:

–treshold metric=load1,ok=0..5,warning=5..10,critical=10..inf

exception pynag.Plugins.new_threshold_syntax.Error(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.errors.PynagError

Base class for errors in this module.

exception pynag.Plugins.new_threshold_syntax.InvalidThreshold(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.Plugins.new_threshold_syntax.Error

Raised when an invalid threshold was provided.

pynag.Plugins.new_threshold_syntax.check_range(value, range)¶

Returns True if value is within range, else False

Arguments:

value – Numerical value to check, can be any number range – string in the format of “start..end”

Examples: >>> check_range(5, “0..10”) True >>> check_range(11, “0..10”) False

pynag.Plugins.new_threshold_syntax.check_threshold(value, ok=None, warning=None, critical=None)¶

Checks value against warning/critical and returns Nagios exit code.

Format of range_threshold is according to: http://nagiosplugins.org/rfc/new_threshold_syntax

This function returns (in order of appearance):

int(0) - If no levels are specified, return OK int(3) - If any invalid input provided, return UNKNOWN int(0) - If an ok level is specified and value is within range, return OK int(2) - If a critical level is specified and value is within range, return CRITICAL int(1) - If a warning level is specified and value is within range, return WARNING int(2) - If an ok level is specified, return CRITICAL int(0) - Otherwise return OK

Arguments:

value – value to check ok – ok range warning – warning range critical – critical range

# Example Usage: >>> check_threshold(88, warning=”90..95”, critical=”95..100”) 0 >>> check_threshold(92, warning=”90..95”, critical=”95..100”) 1 >>> check_threshold(96, warning=”90..95”, critical=”95..100”) 2

pynag.Plugins.new_threshold_syntax.convert_to_classic_format(threshold_range)¶

Take threshold string as and normalize it to the format supported by plugin development team

The input (usually a string in the form of ‘the new threshold syntax’) is a string in the form of x..y

The output will be a compatible string in the older nagios plugin format @x:y

Examples:

>>> convert_to_classic_format("0..5")
u'@0:5'
>>> convert_to_classic_format("inf..5")
u'5:'
>>> convert_to_classic_format("5..inf")
u'~:5'
>>> convert_to_classic_format("inf..inf")
u'@~:'
>>> convert_to_classic_format("^0..5")
u'0:5'
>>> convert_to_classic_format("10..20")
u'@10:20'
>>> convert_to_classic_format("10..inf")
u'~:10'

pynag.Plugins.new_threshold_syntax.parse_threshold(threshold)¶

takes a threshold string as an input and returns a hash map of options and values

Examples:

>>> parse_threshold('metric=disk_usage,ok=0..90,warning=90..95,critical=95..100')
{u'thresholds': [(0, u'0..90'), (1, u'90..95'), (2, u'95..100')], u'metric': u'disk_usage'}

Utils Package¶

Misc utility classes and helper functions for pynag

This module contains misc classes and conveninence functions that are used throughout the pynag library.

class pynag.Utils.AttributeList(value=None)¶

Bases: object

Parse a list of nagios attributes into a parsable format. (e. contact_groups)

This makes it handy to mangle with nagios attribute values that are in a comma seperated format.

Typical comma-seperated format in nagios configuration files looks something like this:

contact_groups     +group1,group2,group3

Examples:

>>> i = AttributeList('+group1,group2,group3')
>>> i.operator
'+'
>>> i.fields
['group1', 'group2', 'group3']

# if your data is already in a list format you can use it directly: >>> i = AttributeList([‘group1’, ‘group2’, ‘group3’]) >>> i.fields [‘group1’, ‘group2’, ‘group3’]

# white spaces will be stripped from all fields >>> i = AttributeList(‘+group1, group2’) >>> i +group1,group2 >>> i.fields [‘group1’, ‘group2’]

append(object)¶

Same as list.append():

Args:

object: Item to append into self.fields (typically a string)

Example:

>>> i = AttributeList('group1,group2,group3')
>>> i.append('group5')
>>> i.fields
['group1', 'group2', 'group3', 'group5']

count(value)¶

Same as list.count()

Args:

value: Any object that might exist in self.fields (string)

Returns:

The number of occurances that ‘value’ has in self.fields

Example:

>>> i = AttributeList('group1,group2,group3')
>>> i.count('group3')
1

extend(iterable)¶

Same as list.extend()

Args:

iterable: Any iterable that list.extend() supports

Example:

>>> i = AttributeList('group1,group2,group3')
>>> i.extend(['group4', 'group5'])
>>> i.fields
['group1', 'group2', 'group3', 'group4', 'group5']

index(value, start=0, stop=None)¶

Same as list.index()

Args:

value: object to look for in self.fields

start: start at this index point

stop: stop at this index point

Returns:

The index of ‘value’ (integer)

Examples:

>>> i = AttributeList('group1,group2,group3')
>>> i.index('group2')
1
>>> i.index('group3', 2, 5)
2

insert(index, object)¶

Same as list.insert()

Args:

object: Any object that will be inserted into self.fields (usually a string)

Example:

>>> i = AttributeList('group1,group2,group3')
>>> i.insert(1, 'group4')
>>> i.fields
['group1', 'group4', 'group2', 'group3']

remove(value)¶

Same as list.remove()

Args:

value: The object that is to be removed

Examples:

>>> i = AttributeList('group1,group2,group3')
>>> i.remove('group3')
>>> i.fields
['group1', 'group2']

reverse()¶

Same as list.reverse()

Examples:

>>> i = AttributeList('group1,group2,group3')
>>> i.reverse()
>>> i.fields
['group3', 'group2', 'group1']

sort()¶

Same as list.sort()

Examples:

>>> i = AttributeList('group3,group1,group2')
>>> i.sort()
>>> print(i.fields)
['group1', 'group2', 'group3']

exception pynag.Utils.CommandFailed(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.Utils.UtilsError

Raised when a subprocess execution was unsuccessful.

class pynag.Utils.DefaultDict(default_factory=None, *a, **kw)¶

Bases: dict

This is an alternative implementation of collections.defaultdict.

Used as a fallback if using python 2.4 or older.

Usage:

try:
    from collections import defaultdict
except ImportError:
    from pynag.Utils import defaultdict

copy()¶

class pynag.Utils.PluginOutput(stdout)¶

This class parses a typical stdout from a nagios plugin

It splits the output into the following fields:

• Summary
• Long Output
• Perfdata

Attributes:

summary (str): Summary returned by the plugin check

long_output (str)

perfdata (str): Data returned by the plugin as a string

parsed_perfdata: perfdata parsed and split

Example Usage:

>>> p = PluginOutput("Everything is ok | load1=15 load2=10")
>>> p.summary
'Everything is ok '
>>> p.long_output
''
>>> p.perfdata
'load1=15 load2=10'
>>> p.parsed_perfdata.metrics
['load1'=15;;;;, 'load2'=10;;;;]

long_output = None¶

parsed_perfdata = None¶

perfdata = None¶

summary = None¶

exception pynag.Utils.UtilsError(message, errorcode=None, errorstring=None, *args, **kwargs)¶

Bases: pynag.errors.PynagError

Base class for errors in this module.

pynag.Utils.defaultdict¶

alias of DefaultDict

pynag.Utils.grep(objects, **kwargs)¶

Returns all the elements from array that match the keywords in **kwargs

See documentation for pynag.Model.ObjectDefinition.objects.filter() for example how to use this.

Arguments:

objects (list of dict): list to be searched

kwargs (str): Any search argument provided will be checked against every dict

Examples:

array = [
{'host_name': 'examplehost', 'state':0},
{'host_name': 'example2', 'state':1},
]
grep_dict(array, state=0)
# should return [{'host_name': 'examplehost', 'state':0},]

pynag.Utils.grep_to_livestatus(*args, **kwargs)¶

Converts from pynag style grep syntax to livestatus filter syntax.

Example:

>>> grep_to_livestatus(host_name='test')
['Filter: host_name = test']
>>> grep_to_livestatus(service_description__contains='serv')
['Filter: service_description ~ serv']
>>> grep_to_livestatus(service_description__isnot='serv')
['Filter: service_description != serv']
>>> grep_to_livestatus(service_description__contains=['serv','check'])
['Filter: service_description ~ serv']
>>> grep_to_livestatus(service_description__notcontains=['serv','check'])
['Filter: service_description !~ serv']
>>> grep_to_livestatus(service_description__contains='foo', contacts__has_field='admin')
['Filter: contacts >= admin', 'Filter: service_description ~ foo']
>>> grep_to_livestatus(service_description__has_field='foo')
['Filter: service_description >= foo']
>>> grep_to_livestatus(service_description__startswith='foo')
['Filter: service_description ~ ^foo']
>>> grep_to_livestatus(service_description__notstartswith='foo')
['Filter: service_description !~ ^foo']
>>> grep_to_livestatus(service_description__endswith='foo')
['Filter: service_description ~ foo$']
>>> grep_to_livestatus(service_description__notendswith='foo')
['Filter: service_description !~ foo$']
>>> grep_to_livestatus(service_description__exists='unnecessary_arg')
['Filter: service_description ~~ .*']
>>> grep_to_livestatus(service_description__regex='^abc$')
['Filter: service_description ~ ^abc$']

pynag.Utils.is_macro(macro)¶

Test if macro is in the format of a valid nagios macro.

Args:

macro: String. Any macro, example $HOSTADDRESS$

Returns:

Boolean. True if macro is in the format of a macro, otherwise false.

Examples:

>>> is_macro('$HOSTADDRESS$')
True
>>> is_macro('$HOSTADDRESS')
False
>>> is_macro('')
False
>>> is_macro('$CONTACTNAME$')
True
>>> is_macro('$SERVICEDESC$')
True
>>> is_macro('$_SERVICE_CUSTOM$')
True
>>> is_macro('$_HOST_CUSTOM$')
True
>>> is_macro('$_CONTACT_CUSTOM$')
True

pynag.Utils.runCommand(command, raise_error_on_fail=False, shell=True, env=None)¶

Run command from the shell prompt. Wrapper around subprocess.

Args:

command (str): string containing the command line to run

raise_error_on_fail (bool): Raise CommandFailed if returncode > 0

Returns:

str: stdout/stderr of the command run

Raises:

CommandFailed if returncode > 0