objects Package

Diagrams

Simple Item class diagram :

Simple Items class diagram :

Simple DummyCommand class diagram :

Inheritance diagram of shinken.objects.command.DummyCommand

Package

objects Package

The objects package contains definition classes of the different objects
that can be declared in configuration files.

businessimpactmodulation Module

class shinken.objects.businessimpactmodulation.Businessimpactmodulation(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'businessimpactmodulation'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'modulation_period': <shinken.property.StringProp object at 0x7f91b7335550>, 'business_impact': <shinken.property.IntegerProp object at 0x7f91b7335510>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'business_impact_modulation_name': <shinken.property.StringProp object at 0x7f91b7335490>}
class shinken.objects.businessimpactmodulation.Businessimpactmodulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Businessimpactmodulation

linkify(timeperiods)[source]
linkify_cm_by_tp(timeperiods)[source]
name_property = 'business_impact_modulation_name'

checkmodulation Module

class shinken.objects.checkmodulation.CheckModulation(params={})[source]

Bases: shinken.objects.item.Item

get_check_command(t_to_go)[source]
get_name()[source]
id = 1
is_correct()[source]
late_linkify_cw_by_commands(commands)[source]
macros = {}
my_type = 'checkmodulation'
properties = {'check_period': <shinken.property.StringProp object at 0x7f91b5856950>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'check_command': <shinken.property.StringProp object at 0x7f91b5685650>, 'checkmodulation_name': <shinken.property.StringProp object at 0x7f91b583a9d0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
class shinken.objects.checkmodulation.CheckModulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of CheckModulation

linkify(timeperiods, commands)[source]
name_property = 'checkmodulation_name'
new_inner_member(name=None, params={})[source]

command Module

class shinken.objects.command.Command(params={})[source]

Bases: shinken.objects.item.Item

command_line
command_name
definition_order
enable_environment_macros
fill_data_brok_from(data, brok_type)[source]
get_initial_status_brok()[source]
get_name()[source]
id = 0
imported_from
module_type
my_type = 'command'
name
poller_tag
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'command_line': <shinken.property.StringProp object at 0x7f91b794dc50>, 'poller_tag': <shinken.property.StringProp object at 0x7f91b794dc90>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f91b794dcd0>, 'module_type': <shinken.property.StringProp object at 0x7f91b794dd10>, 'timeout': <shinken.property.IntegerProp object at 0x7f91b794dd50>, 'enable_environment_macros': <shinken.property.BoolProp object at 0x7f91b794dd90>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'command_name': <shinken.property.StringProp object at 0x7f91b794dbd0>}
pythonize()[source]
reactionner_tag
timeout
use
class shinken.objects.command.Commands(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Command

name_property = 'command_name'
class shinken.objects.command.DummyCommand[source]

Bases: object

config Module

contact Module

class shinken.objects.contact.Contact(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
get_notification_commands(type)[source]
id = 1
is_correct()[source]
macros = {'CONTACTPAGER': 'pager', 'CONTACTGROUPNAMES': 'get_groupnames', 'CONTACTGROUPNAME': 'get_groupname', 'CONTACTNAME': 'contact_name', 'CONTACTADDRESS3': 'address3', 'CONTACTADDRESS2': 'address2', 'CONTACTADDRESS1': 'address1', 'CONTACTALIAS': 'alias', 'CONTACTADDRESS6': 'address6', 'CONTACTADDRESS5': 'address5', 'CONTACTADDRESS4': 'address4', 'CONTACTEMAIL': 'email'}
my_type = 'contact'
old_properties = {'min_criticity': 'min_business_impact'}
properties = {'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'address1': <shinken.property.StringProp object at 0x7f91b6db0910>, 'address2': <shinken.property.StringProp object at 0x7f91b6db0950>, 'address3': <shinken.property.StringProp object at 0x7f91b6db0990>, 'address4': <shinken.property.StringProp object at 0x7f91b6db09d0>, 'address5': <shinken.property.StringProp object at 0x7f91b6db0a10>, 'address6': <shinken.property.StringProp object at 0x7f91b6db0a50>, 'contactgroups': <shinken.property.StringProp object at 0x7f91b6db01d0>, 'is_admin': <shinken.property.BoolProp object at 0x7f91b6db0ad0>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f91b6db02d0>, 'can_submit_commands': <shinken.property.BoolProp object at 0x7f91b6db0a90>, 'contact_name': <shinken.property.StringProp object at 0x7f91b6db0110>, 'password': <shinken.property.StringProp object at 0x7f91b6db0b90>, 'pager': <shinken.property.StringProp object at 0x7f91b6db08d0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'notificationways': <shinken.property.StringProp object at 0x7f91b6db0b50>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'service_notification_commands': <shinken.property.StringProp object at 0x7f91b6db0810>, 'host_notification_period': <shinken.property.StringProp object at 0x7f91b6db0690>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f91b6db0210>, 'host_notification_commands': <shinken.property.StringProp object at 0x7f91b6db07d0>, 'service_notification_period': <shinken.property.StringProp object at 0x7f91b6db0710>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f91b6db0850>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f91b6db0b10>, 'email': <shinken.property.StringProp object at 0x7f91b6db0890>, 'alias': <shinken.property.StringProp object at 0x7f91b6db0190>, 'service_notification_options': <shinken.property.StringProp object at 0x7f91b6db0790>, 'host_notification_options': <shinken.property.StringProp object at 0x7f91b6db0750>}
raise_cancel_downtime_log_entry()[source]
raise_enter_downtime_log_entry()[source]
raise_exit_downtime_log_entry()[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f91b6db0bd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'downtimes': <shinken.property.StringProp object at 0x7f91b6db0c10>}
want_host_notification(t, state, type, business_impact, cmd=None)[source]
want_service_notification(t, state, type, business_impact, cmd=None)[source]
class shinken.objects.contact.Contacts(items)[source]

Bases: shinken.objects.item.Items

explode(contactgroups, notificationways)[source]
inner_class

alias of Contact

late_linkify_c_by_commands(commands)[source]
linkify(timeperiods, commands, notificationways)[source]
linkify_with_notificationways(notificationways)[source]
name_property = 'contact_name'

contactgroup Module

class shinken.objects.contactgroup.Contactgroup(params={})[source]

Bases: shinken.objects.itemgroup.Itemgroup

get_contactgroup_members()[source]
get_contacts()[source]
get_contacts_by_explosion(contactgroups)[source]
get_name()[source]
id = 1
macros = {'CONTACTGROUPALIAS': 'alias', 'CONTACTGROUPMEMBERS': 'get_members'}
my_type = 'contactgroup'
properties = {'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'unknown_members': <shinken.property.StringProp object at 0x7f91b7303510>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'members': <shinken.property.StringProp object at 0x7f91b7303490>, 'alias': <shinken.property.StringProp object at 0x7f91b73101d0>, 'contactgroup_name': <shinken.property.StringProp object at 0x7f91b7310190>, 'id': <shinken.property.IntegerProp object at 0x7f91b6db0e50>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
class shinken.objects.contactgroup.Contactgroups(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

add_contactgroup(cg)[source]
add_member(cname, cgname)[source]
explode()[source]
get_members_by_name(cgname)[source]
inner_class

alias of Contactgroup

linkify(contacts)[source]
linkify_cg_by_cont(contacts)[source]
name_property = 'contactgroup_name'

discoveryrule Module

class shinken.objects.discoveryrule.Discoveryrule(params={})[source]

Bases: shinken.objects.matchingitem.MatchingItem

get_name()[source]
id = 1
macros = {}
my_type = 'discoveryrule'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'creation_type': <shinken.property.StringProp object at 0x7f91b731fc90>, 'discoveryrule_name': <shinken.property.StringProp object at 0x7f91b731fb90>, 'discoveryrule_order': <shinken.property.IntegerProp object at 0x7f91b731fcd0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b731fd10>}
class shinken.objects.discoveryrule.Discoveryrules(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Discoveryrule

name_property = 'discoveryrule_name'

discoveryrun Module

class shinken.objects.discoveryrun.Discoveryrun(params={})[source]

Bases: shinken.objects.matchingitem.MatchingItem

check_finished()[source]
get_name()[source]
get_output()[source]
id = 1
is_finished()[source]
is_first_level()[source]
launch(ctx=[], timeout=300)[source]
my_type = 'discoveryrun'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'discoveryrun_name': <shinken.property.StringProp object at 0x7f91b731fdd0>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'discoveryrun_command': <shinken.property.StringProp object at 0x7f91b731ffd0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'current_launch': <shinken.property.StringProp object at 0x7f91b7335050>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
class shinken.objects.discoveryrun.Discoveryruns(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Discoveryrun

linkify(commands)[source]
name_property = 'discoveryrun_name'

escalation Module

class shinken.objects.escalation.Escalation(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
get_next_notif_time(t_wished, status, creation_time, interval)[source]
id = 1
is_correct()[source]
is_eligible(t, status, notif_number, in_notif_time, interval)[source]
my_type = 'escalation'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'last_notification': <shinken.property.IntegerProp object at 0x7f91b7954390>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'contacts': <shinken.property.StringProp object at 0x7f91b7954710>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f91b7954610>, 'escalation_options': <shinken.property.ListProp object at 0x7f91b79546d0>, 'contact_groups': <shinken.property.StringProp object at 0x7f91b7954750>, 'escalation_name': <shinken.property.StringProp object at 0x7f91b7954290>, 'escalation_period': <shinken.property.StringProp object at 0x7f91b7954690>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f91b79545d0>, 'first_notification': <shinken.property.IntegerProp object at 0x7f91b7954350>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f91b7954650>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'time_based': <shinken.property.BoolProp object at 0x7f91b7954790>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
class shinken.objects.escalation.Escalations(items)[source]

Bases: shinken.objects.item.Items

add_escalation(es)[source]
explode(hosts, hostgroups, contactgroups)[source]
inner_class

alias of Escalation

linkify(timeperiods, contacts, services, hosts)[source]
linkify_es_by_h(hosts)[source]
linkify_es_by_s(services)[source]
name_property = 'escalation_name'

host Module

This is the main class for the Host. In fact it’s mainly about the configuration part. for the running one, it’s better to look at the schedulingitem class that manage all scheduling/consume check smart things :)

class shinken.objects.host.Host(params={})[source]

Bases: shinken.objects.schedulingitem.SchedulingItem

acknowledgement
acknowledgement_type
act_depend_of
act_depend_of_me
action_url
actions
active_checks_enabled
add_business_rule_act_dependency(h, status, timeperiod, inherits_parent)[source]
add_host_act_dependency(h, status, timeperiod, inherits_parent)[source]
add_host_chk_dependency(h, status, timeperiod, inherits_parent)[source]
address
alias
attempt
broks
business_impact
business_impact_modulations
business_rule
business_rule_downtime_as_ack
business_rule_host_notification_options
business_rule_output_template
business_rule_service_notification_options
business_rule_smart_notifications
check_command
check_flapping_recovery_notification
check_freshness
check_interval
check_period
check_type
checkmodulations
checks_in_progress
child_dependencies
childs
chk_depend_of
chk_depend_of_me
comments
configuration_errors
configuration_warnings
contact_groups
contacts
current_event_id
current_notification_id
current_notification_number
current_problem_id
custom_views
customs
definition_order
del_host_act_dependency(other)[source]
display_name
downtimes
duration_sec
early_timeout
end_time
escalations
event_handler
event_handler_enabled
execution_time
failure_prediction_enabled
fill_parents_dependency()[source]
fill_predictive_missing_parameters()[source]
find_service_by_name(service_description)[source]
first_notification_delay
flap_detection_enabled
flap_detection_options
flapping_changes
flapping_comment_id
freshness_threshold
get_ack_author_name()[source]
get_ack_comment()[source]
get_check_command()[source]
get_data_for_checks()[source]
get_data_for_event_handler()[source]
get_data_for_notifications(contact, n)[source]
get_dbg_name()[source]
get_duration()[source]
get_duration_sec()[source]
get_full_name()[source]
get_groupname()[source]
get_groupnames()[source]
get_host_tags()[source]
get_hostgroups()[source]
get_name()[source]
get_obsessive_compulsive_processor_command()[source]
get_realm()[source]
get_services()[source]
get_total_services()[source]
get_total_services_critical()[source]
get_total_services_ok()[source]
get_total_services_unknown()[source]
get_total_services_warning()[source]
got_business_rule
got_default_realm
has_been_checked
hash
high_flap_threshold
host_name
hostgroups
icon_image
icon_image_alt
icon_set
id = 1
impacts
imported_from
in_checking
in_hard_unknown_reach_phase
in_maintenance
in_scheduled_downtime
in_scheduled_downtime_during_last_check
initial_state
is_correct()[source]
is_flapping
is_impact
is_linked_with_host(other)[source]
is_problem
is_state(status)[source]
labels
last_check_command
last_chk
last_event_id
last_hard_state
last_hard_state_change
last_hard_state_id
last_notification
last_perf_data
last_problem_id
last_state
last_state_change
last_state_id
last_state_type
last_state_update
last_time_down
last_time_non_ok_or_up()[source]
last_time_unreachable
last_time_up
latency
long_output
low_flap_threshold
macromodulations
macros = {'HOSTPERFDATA': 'perf_data', 'HOSTGROUPNAMES': 'get_groupnames', 'HOSTCHECKCOMMAND': 'get_check_command', 'LASTHOSTSTATECHANGE': 'last_state_change', 'HOSTSTATE': 'state', 'TOTALHOSTSERVICES': 'get_total_services', 'HOSTNOTESURL': 'notes_url', 'HOSTREALM': 'get_realm', 'HOSTADDRESS30': 'address30', 'HOSTADDRESS31': 'address31', 'HOSTEVENTID': 'current_event_id', 'LASTHOSTCHECK': 'last_chk', 'HOSTPERCENTCHANGE': 'percent_state_change', 'HOSTLATENCY': 'latency', 'HOSTADDRESS6': 'address6', 'HOSTADDRESS7': 'address7', 'HOSTADDRESS4': 'address4', 'HOSTADDRESS5': 'address5', 'HOSTADDRESS2': 'address2', 'HOSTADDRESS3': 'address3', 'HOSTADDRESS0': 'address0', 'HOSTADDRESS1': 'address1', 'HOSTADDRESS17': 'address17', 'HOSTACKAUTHOR': 'get_ack_author_name', 'HOSTADDRESS8': 'address8', 'HOSTADDRESS9': 'address9', 'HOSTSTATEID': 'state_id', 'HOSTDURATION': 'get_duration', 'HOSTNAME': 'host_name', 'TOTALHOSTSERVICESUNKNOWN': 'get_total_services_unknown', 'HOSTNOTES': 'notes', 'HOSTACTIONURL': 'action_url', 'HOSTDURATIONSEC': 'get_duration_sec', 'MAXHOSTATTEMPTS': 'max_check_attempts', 'HOSTEXECUTIONTIME': 'execution_time', 'HOSTACKAUTHORALIAS': 'get_ack_author_name', 'TOTALHOSTSERVICESWARNING': 'get_total_services_warning', 'LASTHOSTEVENTID': 'last_event_id', 'HOSTADDRESS28': 'address28', 'HOSTPROBLEMID': 'current_problem_id', 'HOSTADDRESS18': 'address18', 'HOSTADDRESS19': 'address19', 'HOSTACKCOMMENT': 'get_ack_comment', 'HOSTADDRESS15': 'address15', 'HOSTADDRESS14': 'address14', 'LONGHOSTOUTPUT': 'long_output', 'HOSTADDRESS16': 'address16', 'HOSTOUTPUT': 'output', 'HOSTADDRESS10': 'address10', 'HOSTADDRESS11': 'address11', 'HOSTATTEMPT': 'attempt', 'HOSTADDRESS13': 'address13', 'LASTHOSTDOWN': 'last_time_down', 'HOSTALIAS': 'alias', 'TOTALHOSTSERVICESCRITICAL': 'get_total_services_critical', 'HOSTSTATETYPE': 'state_type', 'HOSTBUSINESSIMPACT': 'business_impact', 'HOSTACKAUTHORNAME': 'get_ack_author_name', 'LASTHOSTSTATEID': 'last_state_id', 'HOSTADDRESS12': 'address12', 'LASTHOSTUP': 'last_time_up', 'HOSTDOWNTIME': 'get_downtime', 'HOSTADDRESS22': 'address22', 'TOTALHOSTSERVICESOK': 'get_total_services_ok', 'HOSTDISPLAYNAME': 'display_name', 'LASTHOSTPERFDATA': 'last_perf_data', 'HOSTADDRESS25': 'address25', 'HOSTADDRESS24': 'address24', 'HOSTADDRESS27': 'address27', 'HOSTADDRESS26': 'address26', 'HOSTADDRESS21': 'address21', 'HOSTADDRESS20': 'address20', 'HOSTADDRESS23': 'address23', 'LASTHOSTUNREACHABLE': 'last_time_unreachable', 'HOSTADDRESS29': 'address29', 'LASTHOSTPROBLEMID': 'last_problem_id', 'LASTHOSTSTATE': 'last_state', 'HOSTADDRESS': 'address', 'HOSTGROUPNAME': 'get_groupname'}
maintenance_period
manage_stalking(c)[source]
max_check_attempts
modified_attributes
my_own_business_impact
my_type = 'host'
name
next_chk
notes
notes_url
notification_interval
notification_is_blocked_by_contact(n, contact)[source]
notification_is_blocked_by_item(type, t_wished=None)[source]
notification_options
notification_period
notifications_enabled
notifications_in_progress
notified_contacts
obsess_over_host
ok_up = 'UP'
old_properties = {'normal_check_interval': 'check_interval', 'hostgroup': 'hostgroups', 'criticity': 'business_impact', 'retry_check_interval': 'retry_interval'}
output
pack_id
parent_dependencies
parents
passive_checks_enabled
pending_flex_downtime
percent_state_change
perf_data
poller_tag
problem_has_been_acknowledged
process_perf_data
processed_business_rule
properties = {'statusmap_image': <shinken.property.StringProp object at 0x7f91b7951d90>, 'business_impact_modulations': <shinken.property.StringProp object at 0x7f91b7951f90>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f91b6f7e310>, 'labels': <shinken.property.ListProp object at 0x7f91b7959150>, 'action_url': <shinken.property.StringProp object at 0x7f91b7951c50>, 'escalations': <shinken.property.StringProp object at 0x7f91b7951fd0>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f91b6f7e550>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f91b6f7e650>, 'icon_image': <shinken.property.StringProp object at 0x7f91b7951c90>, 'check_period': <shinken.property.StringProp object at 0x7f91b6f7e3d0>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'display_name': <shinken.property.StringProp object at 0x7f91b6f7e110>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f91b6f7e850>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f91b7951e50>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f91b6f7e610>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f91b6f7e510>, 'trigger': <shinken.property.StringProp object at 0x7f91b7959310>, 'parents': <shinken.property.ListProp object at 0x7f91b6f7e190>, 'initial_state': <shinken.property.CharProp object at 0x7f91b6f7e250>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f91b6f7e890>, 'notification_options': <shinken.property.ListProp object at 0x7f91b6f7e910>, 'host_name': <shinken.property.StringProp object at 0x7f91b6f7e050>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f91b6f7e950>, 'event_handler': <shinken.property.StringProp object at 0x7f91b6f7e4d0>, 'obsess_over_host': <shinken.property.BoolProp object at 0x7f91b6f7e410>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f91b6f7e490>, 'alias': <shinken.property.StringProp object at 0x7f91b6f7e0d0>, 'service_excludes': <shinken.property.ListProp object at 0x7f91b7959110>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f91b7959090>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f91b7959390>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'custom_views': <shinken.property.ListProp object at 0x7f91b7959490>, 'check_command': <shinken.property.StringProp object at 0x7f91b6f7e210>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f91b6f7e390>, 'check_interval': <shinken.property.IntegerProp object at 0x7f91b6f7e2d0>, 'notes': <shinken.property.StringProp object at 0x7f91b7951bd0>, 'check_freshness': <shinken.property.BoolProp object at 0x7f91b6f7e450>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f91b6f7e350>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f91b7951cd0>, 'hostgroups': <shinken.property.StringProp object at 0x7f91b6f7e1d0>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f91b7951f10>, 'notes_url': <shinken.property.StringProp object at 0x7f91b7951c10>, 'service_overrides': <shinken.property.ListProp object at 0x7f91b79590d0>, 'maintenance_period': <shinken.property.StringProp object at 0x7f91b7959050>, 'realm': <shinken.property.StringProp object at 0x7f91b7951e90>, 'contacts': <shinken.property.StringProp object at 0x7f91b6f7e750>, 'notification_period': <shinken.property.StringProp object at 0x7f91b6f7e8d0>, 'trending_policies': <shinken.property.ListProp object at 0x7f91b79593d0>, 'resultmodulations': <shinken.property.StringProp object at 0x7f91b7951f50>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f91b6f7e690>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f91b7959210>, 'stalking_options': <shinken.property.ListProp object at 0x7f91b6f7e990>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f91b6f7e5d0>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f91b7959250>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f91b6f7e590>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'macromodulations': <shinken.property.ListProp object at 0x7f91b7959450>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f91b6f7e6d0>, 'contact_groups': <shinken.property.StringProp object at 0x7f91b6f7e7d0>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f91b79591d0>, 'address': <shinken.property.StringProp object at 0x7f91b6f7e150>, 'trigger_name': <shinken.property.ListProp object at 0x7f91b7959350>, 'vrml_image': <shinken.property.StringProp object at 0x7f91b7951d50>, '3d_coords': <shinken.property.StringProp object at 0x7f91b7951e10>, '2d_coords': <shinken.property.StringProp object at 0x7f91b7951dd0>, 'checkmodulations': <shinken.property.ListProp object at 0x7f91b7959410>, 'poller_tag': <shinken.property.StringProp object at 0x7f91b7951ed0>, 'icon_set': <shinken.property.StringProp object at 0x7f91b7951d10>, 'business_impact': <shinken.property.IntegerProp object at 0x7f91b79592d0>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f91b6f7e290>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f91b7959290>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f91b7959190>}
raise_alert_log_entry()[source]
raise_cancel_downtime_log_entry()[source]
raise_enter_downtime_log_entry()[source]
raise_event_handler_log_entry(command)[source]
raise_exit_downtime_log_entry()[source]
raise_flapping_start_log_entry(change_ratio, threshold)[source]
raise_flapping_stop_log_entry(change_ratio, threshold)[source]
raise_freshness_log_entry(t_stale_by, t_threshold)[source]
raise_initial_state()[source]
raise_no_next_check_log_entry()[source]
raise_notification_log_entry(n)[source]
reactionner_tag
realm
register_child(child)[source]
resultmodulations
retain_nonstatus_information
retain_status_information
retry_interval
return_code
running_properties = {'state_id_before_impact': <shinken.property.StringProp object at 0x7f91b7927910>, 'child_dependencies': <shinken.property.StringProp object at 0x7f91b7927750>, 'last_time_unreachable': <shinken.property.IntegerProp object at 0x7f91b7959a50>, 'childs': <shinken.property.StringProp object at 0x7f91b79276d0>, 'business_rule': <shinken.property.StringProp object at 0x7f91b7927a10>, 'last_perf_data': <shinken.property.StringProp object at 0x7f91b79274d0>, 'acknowledgement': <shinken.property.StringProp object at 0x7f91b7959f10>, 'actions': <shinken.property.StringProp object at 0x7f91b7927650>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f91b7927210>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f91b7927090>, 's_time': <shinken.property.FloatProp object at 0x7f91b7927190>, 'checks_in_progress': <shinken.property.StringProp object at 0x7f91b7959d50>, 'chk_depend_of': <shinken.property.StringProp object at 0x7f91b7959c10>, 'last_notification': <shinken.property.FloatProp object at 0x7f91b79271d0>, 'chk_depend_of_me': <shinken.property.StringProp object at 0x7f91b7959c90>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f91b7927290>, 'last_state': <shinken.property.StringProp object at 0x7f91b7959810>, 'topology_change': <shinken.property.BoolProp object at 0x7f91b7927b10>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f91b7927810>, 'impacts': <shinken.property.StringProp object at 0x7f91b7927890>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f91b7959910>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f91b7927a90>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f91b7927710>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f91b7959e90>, 'notifications_in_progress': <shinken.property.StringProp object at 0x7f91b7959d90>, 'u_time': <shinken.property.FloatProp object at 0x7f91b7927150>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f91b7959850>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f91b7959fd0>, 'broks': <shinken.property.StringProp object at 0x7f91b7927690>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f91b7927310>, 'last_state_update': <shinken.property.StringProp object at 0x7f91b7959cd0>, 'execution_time': <shinken.property.FloatProp object at 0x7f91b7927110>, 'start_time': <shinken.property.IntegerProp object at 0x7f91b7927390>, 'flapping_changes': <shinken.property.StringProp object at 0x7f91b7959e50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'notified_contacts': <shinken.property.StringProp object at 0x7f91b7927590>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f91b7959b90>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f91b7927410>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f91b79275d0>, 'act_depend_of_me': <shinken.property.StringProp object at 0x7f91b7959c50>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f91b7959750>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f91b79272d0>, 'in_checking': <shinken.property.BoolProp object at 0x7f91b7959590>, 'last_state_change': <shinken.property.FloatProp object at 0x7f91b79598d0>, 'long_output': <shinken.property.StringProp object at 0x7f91b7959b10>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f91b7959a90>, 'end_time': <shinken.property.IntegerProp object at 0x7f91b79273d0>, 'timeout': <shinken.property.IntegerProp object at 0x7f91b7927350>, 'output': <shinken.property.StringProp object at 0x7f91b7959ad0>, 'perf_data': <shinken.property.StringProp object at 0x7f91b7927490>, 'state_before_impact': <shinken.property.StringProp object at 0x7f91b79278d0>, 'is_impact': <shinken.property.StringProp object at 0x7f91b79277d0>, 'check_type': <shinken.property.IntegerProp object at 0x7f91b7959f90>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f91b7927610>, 'source_problems': <shinken.property.StringProp object at 0x7f91b7927850>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f91b79597d0>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f91b7927a50>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f91b7959ed0>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f91b7927050>, 'latency': <shinken.property.FloatProp object at 0x7f91b7959610>, 'state_changed_since_impact': <shinken.property.StringProp object at 0x7f91b7927950>, 'current_event_id': <shinken.property.StringProp object at 0x7f91b7959790>, 'last_state_type': <shinken.property.StringProp object at 0x7f91b7959890>, 'downtimes': <shinken.property.StringProp object at 0x7f91b7959dd0>, 'last_time_up': <shinken.property.IntegerProp object at 0x7f91b79599d0>, 'last_hard_state': <shinken.property.StringProp object at 0x7f91b7959950>, 'next_chk': <shinken.property.IntegerProp object at 0x7f91b7959550>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f91b79279d0>, 'comments': <shinken.property.StringProp object at 0x7f91b7959e10>, 'last_check_command': <shinken.property.StringProp object at 0x7f91b7927bd0>, 'state': <shinken.property.StringProp object at 0x7f91b7959690>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f91b79270d0>, 'last_chk': <shinken.property.IntegerProp object at 0x7f91b7959510>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f91b7927250>, 'is_problem': <shinken.property.StringProp object at 0x7f91b7927790>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>, 'pack_id': <shinken.property.IntegerProp object at 0x7f91b7927b50>, 'return_code': <shinken.property.IntegerProp object at 0x7f91b7927450>, 'is_flapping': <shinken.property.BoolProp object at 0x7f91b7959b50>, 'customs': <shinken.property.StringProp object at 0x7f91b7927510>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f91b7927ad0>, 'got_default_realm': <shinken.property.BoolProp object at 0x7f91b7927550>, 'state_id': <shinken.property.IntegerProp object at 0x7f91b79596d0>, 'services': <shinken.property.StringProp object at 0x7f91b7959d10>, 'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'state_type': <shinken.property.StringProp object at 0x7f91b7959710>, 'attempt': <shinken.property.IntegerProp object at 0x7f91b7959650>, 'act_depend_of': <shinken.property.StringProp object at 0x7f91b7959bd0>, 'triggers': <shinken.property.StringProp object at 0x7f91b7927b90>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f91b7959f50>, 'last_time_down': <shinken.property.IntegerProp object at 0x7f91b7959a10>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f91b79594d0>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f91b79595d0>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f91b7927990>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f91b7959990>}
s_time
scheduled_downtime_depth
service_excludes
service_overrides
services
set_impact_state()[source]
set_state_from_exit_status(status)[source]
set_unreachable()[source]
should_be_scheduled
source_problems
stalking_options
start_time
state
state_before_hard_unknown_reach_phase
state_before_impact
state_changed_since_impact
state_id
state_id_before_impact
state_type
state_type_id
statusmap_image
tags
time_to_orphanage
timeout
topology_change
trending_policies
trigger
trigger_broker_raise_enabled
trigger_name
triggers
u_time
unset_impact_state()[source]
use
vrml_image
was_in_hard_unknown_reach_phase
class shinken.objects.host.Hosts(items)[source]

Bases: shinken.objects.item.Items

apply_dependencies()[source]
create_business_rules(hosts, services)[source]
create_business_rules_dependencies()[source]
explode(hostgroups, contactgroups, triggers)[source]
fill_predictive_missing_parameters()[source]
find_hosts_that_use_template(tpl_name)[source]
inner_class

alias of Host

late_linkify_h_by_commands(commands)[source]
linkify(timeperiods=None, commands=None, contacts=None, realms=None, resultmodulations=None, businessimpactmodulations=None, escalations=None, hostgroups=None, triggers=None, checkmodulations=None, macromodulations=None)[source]
linkify_h_by_h()[source]
linkify_h_by_hg(hostgroups)[source]
linkify_h_by_realms(realms)[source]
name_property = 'host_name'

hostdependency Module

class shinken.objects.hostdependency.Hostdependencies(items)[source]

Bases: shinken.objects.item.Items

apply_inheritance()[source]
delete_hostsdep_by_id(ids)[source]
explode(hostgroups)[source]
is_correct()[source]
linkify(hosts, timeperiods)[source]
linkify_h_by_hd()[source]
linkify_hd_by_h(hosts)[source]
linkify_hd_by_tp(timeperiods)[source]
class shinken.objects.hostdependency.Hostdependency(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 0
my_type = 'hostdependency'
properties = {'inherits_parent': <shinken.property.BoolProp object at 0x7f91b731f510>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f91b731f590>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'dependency_period': <shinken.property.StringProp object at 0x7f91b731f5d0>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f91b731f550>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f91b731f4d0>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f91b731f350>, 'host_name': <shinken.property.StringProp object at 0x7f91b731f490>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f91b731f410>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}

hostescalation Module

class shinken.objects.hostescalation.Hostescalation(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'hostescalation'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'contacts': <shinken.property.StringProp object at 0x7f91b7954dd0>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f91b7954e90>, 'escalation_options': <shinken.property.ListProp object at 0x7f91b7954d90>, 'contact_groups': <shinken.property.StringProp object at 0x7f91b7954e10>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f91b7954d10>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f91b7954c50>, 'escalation_period': <shinken.property.StringProp object at 0x7f91b7954d50>, 'host_name': <shinken.property.StringProp object at 0x7f91b7954b90>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f91b7954e50>, 'first_notification': <shinken.property.IntegerProp object at 0x7f91b7954c90>, 'last_notification': <shinken.property.IntegerProp object at 0x7f91b7954cd0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
class shinken.objects.hostescalation.Hostescalations(items)[source]

Bases: shinken.objects.item.Items

explode(escalations)[source]
inner_class

alias of Hostescalation

name_property = ''

hostextinfo Module

This is the main class for the Host ext info. In fact it’s mainly about the configuration part. Parameters are merged in Hosts so it’s no use in running part

class shinken.objects.hostextinfo.HostExtInfo(params={})[source]

Bases: shinken.objects.item.Item

definition_order
get_dbg_name()[source]
get_full_name()[source]
get_name()[source]
host_name
icon_image
icon_image_alt
id = 1
imported_from
is_correct()[source]
macros = {'HOSTNOTES': 'notes', 'HOSTNAME': 'host_name', 'HOSTNOTESURL': 'notes_url'}
my_type = 'hostextinfo'
name
notes
notes_url
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f91b5856c90>, 'notes': <shinken.property.StringProp object at 0x7f91b5856cd0>, 'vrml_image': <shinken.property.StringProp object at 0x7f91b5856690>, '3d_coords': <shinken.property.StringProp object at 0x7f91b5856e50>, 'notes_url': <shinken.property.StringProp object at 0x7f91b5856b90>, 'host_name': <shinken.property.ListProp object at 0x7f91b5856ad0>, 'icon_image': <shinken.property.StringProp object at 0x7f91b5856c10>, '2d_coords': <shinken.property.StringProp object at 0x7f91b5856dd0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'statusmap_image': <shinken.property.StringProp object at 0x7f91b5856d90>}
statusmap_image
use
vrml_image
class shinken.objects.hostextinfo.HostsExtInfo(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of HostExtInfo

merge(hosts)[source]
merge_extinfo(host, extinfo)[source]
name_property = 'host_name'

hostgroup Module

class shinken.objects.hostgroup.Hostgroup(params={})[source]

Bases: shinken.objects.itemgroup.Itemgroup

get_hostgroup_members()[source]
get_hosts()[source]
get_hosts_by_explosion(hostgroups)[source]
get_name()[source]
id = 1
macros = {'HOSTGROUPMEMBERS': 'members', 'HOSTGROUPNOTES': 'notes', 'HOSTGROUPACTIONURL': 'action_url', 'HOSTGROUPALIAS': 'alias', 'HOSTGROUPNOTESURL': 'notes_url'}
my_type = 'hostgroup'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f91b73035d0>, 'realm': <shinken.property.StringProp object at 0x7f91b7303710>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'alias': <shinken.property.StringProp object at 0x7f91b7303610>, 'notes': <shinken.property.StringProp object at 0x7f91b7303650>, 'unknown_members': <shinken.property.StringProp object at 0x7f91b7303510>, 'action_url': <shinken.property.StringProp object at 0x7f91b73036d0>, 'notes_url': <shinken.property.StringProp object at 0x7f91b7303690>, 'members': <shinken.property.StringProp object at 0x7f91b7303490>, 'id': <shinken.property.StringProp object at 0x7f91b7303590>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
class shinken.objects.hostgroup.Hostgroups(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

add_member(hname, hgname)[source]
explode()[source]
get_members_by_name(hgname)[source]
inner_class

alias of Hostgroup

linkify(hosts=None, realms=None)[source]
linkify_hg_by_hst(hosts)[source]
linkify_hg_by_realms(realms)[source]
name_property = 'hostgroup_name'

item Module

This class is a base class for nearly all configuration elements like service, hosts or contacts.

class shinken.objects.item.Item(params={})[source]

Bases: object

acknowledge_problem(sticky, notify, persistent, author, comment, end_time=0)[source]
add_comment(comment)[source]
add_downtime(downtime)[source]
check_for_expire_acknowledge()[source]
clean()[source]

Clean useless things not requested once item has been fully initialized&configured. Like temporary attributes such as “imported_from”, etc..

compact_unique_attr_value(val)[source]
compute_hash()[source]
copy()[source]

Return a copy of the item, but give him a new id

del_comment(comment_id)[source]
del_downtime(downtime_id)[source]
explode_trigger_string_into_triggers(triggers)[source]
fill_data_brok_from(data, brok_type)[source]
fill_default()[source]

Fill missing properties if they are missing

get_all_plus_and_delete()[source]
get_check_result_brok()[source]
get_customs_properties_by_inheritance(items)[source]
get_initial_status_brok()[source]
get_next_schedule_brok()[source]
get_plus_and_delete(prop)[source]
get_property_by_inheritance(items, prop)[source]
get_property_value_for_brok(prop, tab)[source]
get_raw_import_values()[source]
get_templates()[source]
get_update_status_brok()[source]
has_plus(prop)[source]
init_running_properties()[source]
is_correct()[source]
is_tpl()[source]

Return if the elements is a template

linkify_one_command_with_commands(commands, prop)[source]
linkify_with_triggers(triggers)[source]
classmethod load_global_conf(conf)[source]

Used to put global values in the sub Class like hosts or services

macros = {}
old_properties_names_to_new()[source]
prepare_for_conf_sending()[source]
properties = {'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
pythonize()[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
unacknowledge_problem()[source]
unacknowledge_problem_if_not_sticky()[source]
class shinken.objects.item.Items(items)[source]

Bases: object

apply_inheritance()[source]
apply_partial_inheritance(prop)[source]
clean()[source]

Request to remove the unnecessary attributes/others from our items

compute_hash()[source]
create_commandcall(prop, commands, command)[source]
create_reversed_list()[source]
create_tpl_list()[source]
evaluate_hostgroup_expression(expr, hosts, hostgroups, look_in='hostgroups')[source]
explode_contact_groups_into_contacts(contactgroups)[source]
explode_host_groups_into_hosts(hosts, hostgroups)[source]
explode_trigger_string_into_triggers(triggers)[source]
fill_default()[source]
find_by_filter(filters)[source]
find_by_name(name)[source]
find_id_by_name(name)[source]
find_tpl_by_name(name)[source]
is_correct()[source]
linkify_command_list_with_commands(commands, prop)[source]
linkify_one_command_with_commands(commands, prop)[source]
linkify_s_by_plug(modules)[source]
linkify_templates()[source]
linkify_with_business_impact_modulations(business_impact_modulations)[source]
linkify_with_checkmodulations(checkmodulations)[source]
linkify_with_contacts(contacts)[source]
linkify_with_escalations(escalations)[source]
linkify_with_macromodulations(macromodulations)[source]
linkify_with_resultmodulations(resultmodulations)[source]
linkify_with_timeperiods(timeperiods, prop)[source]
linkify_with_triggers(triggers)[source]
no_loop_in_parents(attr1, attr2)[source]

Find loop in dependencies. For now, used with the following attributes :

(self, parents) => host dependencies from host object (host_name, dependent_host_name) => host dependencies from hostdependencies object (service_description, dependent_service_description) => service dependencies from servicedependencies object
old_properties_names_to_new()[source]
prepare_for_sending()[source]
pythonize()[source]
remove_templates()[source]

Remove useless templates (& properties) of our items ; otherwise we could get errors on config.is_correct()

remove_twins()[source]

itemgroup Module

class shinken.objects.itemgroup.Itemgroup(params={})[source]

Bases: shinken.objects.item.Item

add_string_member(member)[source]
copy_shell()[source]
fill_default()[source]
get_initial_status_brok()[source]
has(prop)[source]
id = 0
is_correct()[source]
properties = {'members': <shinken.property.StringProp object at 0x7f91b7303490>, 'unknown_members': <shinken.property.StringProp object at 0x7f91b7303510>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
pythonize()[source]
replace_members(members)[source]
class shinken.objects.itemgroup.Itemgroups(items)[source]

Bases: shinken.objects.item.Items

add(ig)[source]
fill_default()[source]
get_members_by_name(gname)[source]

macromodulation Module

class shinken.objects.macromodulation.MacroModulation(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
is_active()[source]
is_correct()[source]
macros = {}
my_type = 'macromodulation'
properties = {'macromodulation_name': <shinken.property.StringProp object at 0x7f91b7335610>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'modulation_period': <shinken.property.StringProp object at 0x7f91b7335910>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
class shinken.objects.macromodulation.MacroModulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of MacroModulation

linkify(timeperiods)[source]
name_property = 'macromodulation_name'

matchingitem Module

This is a utility class for factorizing matching functions for discovery runners and rules.

class shinken.objects.matchingitem.MatchingItem(params={})[source]

Bases: shinken.objects.item.Item

is_matching(key, value, look_in='matches')[source]
is_matching_disco_datas(datas)[source]

module Module

class shinken.objects.module.Module(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
macros = {}
my_type = 'module'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'module_type': <shinken.property.StringProp object at 0x7f91b731f990>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'module_name': <shinken.property.StringProp object at 0x7f91b731f910>, 'modules': <shinken.property.ListProp object at 0x7f91b731f9d0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
class shinken.objects.module.Modules(items)[source]

Bases: shinken.objects.item.Items

explode()[source]
inner_class

alias of Module

linkify()[source]
linkify_s_by_plug()[source]
name_property = 'module_name'

notificationway Module

class shinken.objects.notificationway.NotificationWay(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
get_notification_commands(type)[source]
id = 1
is_correct()[source]
late_linkify_nw_by_commands(commands)[source]
macros = {}
my_type = 'notificationway'
old_properties = {'min_criticity': 'min_business_impact'}
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'notificationway_name': <shinken.property.StringProp object at 0x7f91b7310390>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f91b7310410>, 'service_notification_options': <shinken.property.ListProp object at 0x7f91b7310590>, 'host_notification_commands': <shinken.property.StringProp object at 0x7f91b73105d0>, 'service_notification_period': <shinken.property.StringProp object at 0x7f91b7310510>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f91b7310650>, 'host_notification_options': <shinken.property.ListProp object at 0x7f91b7310550>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f91b7310450>, 'host_notification_period': <shinken.property.StringProp object at 0x7f91b7310490>, 'service_notification_commands': <shinken.property.StringProp object at 0x7f91b7310610>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
want_host_notification(t, state, type, business_impact, cmd=None)[source]
want_service_notification(t, state, type, business_impact, cmd=None)[source]
class shinken.objects.notificationway.NotificationWays(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of NotificationWay

linkify(timeperiods, commands)[source]
name_property = 'notificationway_name'
new_inner_member(name=None, params={})[source]

pack Module

class shinken.objects.pack.Pack(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'pack'
properties = {'pack_name': <shinken.property.StringProp object at 0x7f91b4fb7090>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'macros': <shinken.property.StringProp object at 0x7f91b4fb7190>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
class shinken.objects.pack.Packs(items)[source]

Bases: shinken.objects.item.Items

create_pack(buf, name)[source]
inner_class

alias of Pack

load_file(path)[source]
name_property = 'pack_name'

realm Module

class shinken.objects.realm.Realm(params={})[source]

Bases: shinken.objects.itemgroup.Itemgroup

add_string_member(member)[source]
count_brokers()[source]
count_pollers()[source]
count_reactionners()[source]
count_receivers()[source]
fill_potential_satellites_by_type(sat_type)[source]
get_all_subs_satellites_by_type(sat_type)[source]
get_name()[source]
get_nb_of_must_have_satellites(type)[source]
get_potential_satellites_by_type(type)[source]
get_realm_members()[source]
get_realms()[source]
get_realms_by_explosion(realms)[source]
get_satellties_by_type(type)[source]
id = 1
macros = {'REALMNAME': 'realm_name', 'REALMMEMBERS': 'members'}
my_type = 'realm'
prepare_for_satellites_conf()[source]
properties = {'higher_realms': <shinken.property.StringProp object at 0x7f91b7303d50>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'realm_members': <shinken.property.StringProp object at 0x7f91b7303d10>, 'realm_name': <shinken.property.StringProp object at 0x7f91b7303cd0>, 'unknown_members': <shinken.property.StringProp object at 0x7f91b7303510>, 'default': <shinken.property.BoolProp object at 0x7f91b7303d90>, 'broker_complete_links': <shinken.property.BoolProp object at 0x7f91b7303dd0>, 'members': <shinken.property.StringProp object at 0x7f91b7303490>, 'id': <shinken.property.IntegerProp object at 0x7f91b7303c50>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
pythonize()[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'serialized_confs': <shinken.property.StringProp object at 0x7f91b7303e10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
class shinken.objects.realm.Realms(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

explode()[source]
get_default()[source]
get_members_by_name(pname)[source]
inner_class

alias of Realm

linkify()[source]
linkify_p_by_p()[source]
name_property = 'realm_name'
prepare_for_satellites_conf()[source]

resultmodulation Module

class shinken.objects.resultmodulation.Resultmodulation(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
module_return(return_code)[source]
my_type = 'resultmodulation'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'resultmodulation_name': <shinken.property.StringProp object at 0x7f91b794de10>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'modulation_period': <shinken.property.StringProp object at 0x7f91b7954090>, 'exit_code_modulation': <shinken.property.StringProp object at 0x7f91b7954050>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'exit_codes_match': <shinken.property.ListProp object at 0x7f91b794df10>}
pythonize()[source]
class shinken.objects.resultmodulation.Resultmodulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Resultmodulation

linkify(timeperiods)[source]
linkify_rm_by_tp(timeperiods)[source]
name_property = 'resultmodulation_name'

schedulingitem Module

This class is a common one for service/host. Here you will find all scheduling related functions, like the schedule or the consume_check. It’s a very important class!

class shinken.objects.schedulingitem.SchedulingItem(params={})[source]

Bases: shinken.objects.item.Item

add_attempt()[source]
add_flapping_change(b)[source]
business_rule_notification_is_blocked()[source]
check_and_set_unreachability()[source]
check_for_flexible_downtime()[source]
compensate_system_time_change(difference)[source]
consume_result(c)[source]
create_business_rules(hosts, services, running=False)[source]
create_business_rules_dependencies()[source]
create_notifications(type, t_wished=None)[source]
current_event_id = 0
current_problem_id = 0
deregister_a_problem(pb)[source]
disable_active_checks()[source]
do_check_freshness()[source]
do_i_raise_dependency(status, inherit_parents)[source]
eval_triggers()[source]
expand_business_rule_item_macros(template_string, item)[source]
get_business_rule_output()[source]
get_escalable_contacts(n)[source]
get_event_handlers(externalcmd=False)[source]
get_next_notification_time(n)[source]
get_perfdata_command()[source]
get_time_to_orphanage()[source]
is_escalable(n)[source]
is_max_attempts()[source]
is_no_action_dependent()[source]
is_no_check_dependent()[source]
launch_check(t, ref_check=None, force=False, dependent=False)[source]
manage_internal_check(hosts, services, c)[source]
no_more_a_problem()[source]
prepare_notification_for_sending(n)[source]
raise_dependencies_check(ref_check)[source]
rebuild_ref()[source]

Rebuild the possible reference a schedulingitem can have

register_a_problem(pb)[source]
register_son_in_parent_child_dependencies(son)[source]
remove_in_progress_check(c)[source]
remove_in_progress_notification(n)[source]
remove_in_progress_notifications()[source]
scatter_notification(n)[source]
schedule(force=False, force_time=None)[source]
set_myself_as_problem()[source]
status_to_short_status(status)[source]
update_business_impact_value()[source]
update_event_and_problem_id()[source]
update_flapping()[source]
update_hard_unknown_phase_state()[source]
update_in_checking()[source]
update_notification_command(n)[source]

service Module

This Class is the service one, s it manage all service specific thing. If you look at the scheduling part, look at the scheduling item class

class shinken.objects.service.Service(params={})[source]

Bases: shinken.objects.schedulingitem.SchedulingItem

acknowledgement
acknowledgement_type
act_depend_of
act_depend_of_me
action_url
actions
active_checks_enabled
add_business_rule_act_dependency(srv, status, timeperiod, inherits_parent)[source]
add_service_act_dependency(srv, status, timeperiod, inherits_parent)[source]
add_service_chk_dependency(srv, status, timeperiod, inherits_parent)[source]
aggregation
attempt
broks
business_impact
business_impact_modulations
business_rule
business_rule_downtime_as_ack
business_rule_host_notification_options
business_rule_output_template
business_rule_service_notification_options
business_rule_smart_notifications
check_command
check_flapping_recovery_notification
check_freshness
check_interval
check_period
check_type
checkmodulations
checks_in_progress
child_dependencies
chk_depend_of
chk_depend_of_me
comments
configuration_errors
configuration_warnings
contact_groups
contacts
current_event_id
current_notification_id
current_notification_number
current_problem_id
custom_views
customs
default_value
definition_order
display_name
downtimes
duplicate(host)[source]
duplicate_foreach
duration_sec
early_timeout
end_time
escalations
event_handler
event_handler_enabled
execution_time
failure_prediction_enabled
fill_daddy_dependency()[source]
first_notification_delay
flap_detection_enabled
flap_detection_options
flapping_changes
flapping_comment_id
freshness_threshold
get_ack_author_name()[source]
get_ack_comment()[source]
get_check_command()[source]
get_data_for_checks()[source]
get_data_for_event_handler()[source]
get_data_for_notifications(contact, n)[source]
get_dbg_name()[source]
get_duration()[source]
get_duration_sec()[source]
get_full_name()[source]
get_groupnames()[source]
get_host_tags()[source]
get_hostgroups()[source]
get_name()[source]
get_obsessive_compulsive_processor_command()[source]
get_realm()[source]
get_service_tags()[source]
got_business_rule
has_been_checked
hash
high_flap_threshold
host
host_dependency_enabled
host_name
hostgroup_name
icon_image
icon_image_alt
icon_set
id = 1
impacts
imported_from
in_checking
in_hard_unknown_reach_phase
in_maintenance
in_scheduled_downtime
in_scheduled_downtime_during_last_check
initial_state
is_correct()[source]
is_flapping
is_impact
is_problem
is_state(status)[source]
is_volatile
labels
last_check_command
last_chk
last_event_id
last_hard_state
last_hard_state_change
last_hard_state_id
last_notification
last_perf_data
last_problem_id
last_state
last_state_change
last_state_id
last_state_type
last_state_update
last_time_critical
last_time_non_ok_or_up()[source]
last_time_ok
last_time_unknown
last_time_warning
latency
long_output
low_flap_threshold
macromodulations
macros = {'LASTSERVICESTATEID': 'last_state_id', 'SERVICEDURATION': 'get_duration', 'SERVICEGROUPNAME': 'get_groupname', 'SERVICEPROBLEMID': 'current_problem_id', 'SERVICEACKCOMMENT': 'get_ack_comment', 'LASTSERVICEPROBLEMID': 'last_problem_id', 'SERVICEACKAUTHORNAME': 'get_ack_author_name', 'LASTSERVICESTATECHANGE': 'last_state_change', 'LASTSERVICESTATE': 'last_state', 'LASTSERVICEOK': 'last_time_ok', 'SERVICEACTIONURL': 'action_url', 'LONGSERVICEOUTPUT': 'long_output', 'SERVICEEVENTID': 'current_event_id', 'LASTSERVICEEVENTID': 'last_event_id', 'LASTSERVICECRITICAL': 'last_time_critical', 'SERVICEOUTPUT': 'output', 'SERVICEDURATIONSEC': 'get_duration_sec', 'SERVICEPERCENTCHANGE': 'percent_state_change', 'SERVICEDOWNTIME': 'get_downtime', 'SERVICEACKAUTHORALIAS': 'get_ack_author_name', 'MAXSERVICEATTEMPTS': 'max_check_attempts', 'SERVICEDESC': 'service_description', 'LASTSERVICECHECK': 'last_chk', 'SERVICEPERFDATA': 'perf_data', 'SERVICESTATETYPE': 'state_type', 'LASTSERVICEWARNING': 'last_time_warning', 'SERVICENOTES': 'notes', 'SERVICEDISPLAYNAME': 'display_name', 'SERVICELATENCY': 'latency', 'SERVICEACKAUTHOR': 'get_ack_author_name', 'SERVICEATTEMPT': 'attempt', 'SERVICESTATE': 'state', 'LASTSERVICEUNKNOWN': 'last_time_unknown', 'SERVICEGROUPNAMES': 'get_groupnames', 'SERVICEISVOLATILE': 'is_volatile', 'SERVICECHECKCOMMAND': 'get_check_command', 'SERVICEBUSINESSIMPACT': 'business_impact', 'SERVICENOTESURL': 'notes_url', 'SERVICEEXECUTIONTIME': 'execution_time', 'LASTSERVICEPERFDATA': 'last_perf_data', 'SERVICESTATEID': 'state_id'}
maintenance_period
manage_stalking(c)[source]
max_check_attempts
merge_host_contacts
modified_attributes
my_own_business_impact
my_type = 'service'
name
next_chk
notes
notes_url
notification_interval
notification_is_blocked_by_contact(n, contact)[source]
notification_is_blocked_by_item(type, t_wished=None)[source]
notification_options
notification_period
notifications_enabled
notifications_in_progress
notified_contacts
obsess_over_service
ok_up = 'OK'
old_properties = {'normal_check_interval': 'check_interval', 'hostgroups': 'hostgroup_name', 'hostgroup': 'hostgroup_name', 'criticity': 'business_impact', 'retry_check_interval': 'retry_interval'}
output
parallelize_check
parent_dependencies
passive_checks_enabled
pending_flex_downtime
percent_state_change
perf_data
poller_tag
problem_has_been_acknowledged
process_perf_data
processed_business_rule
properties = {'hostgroup_name': <shinken.property.StringProp object at 0x7f91b7aa4ad0>, 'business_impact_modulations': <shinken.property.StringProp object at 0x7f91b7941c10>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f91b7aa4d90>, 'labels': <shinken.property.ListProp object at 0x7f91b7941d50>, 'obsess_over_service': <shinken.property.BoolProp object at 0x7f91b7aa4f10>, 'action_url': <shinken.property.StringProp object at 0x7f91b79419d0>, 'escalations': <shinken.property.StringProp object at 0x7f91b7941c50>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f91b732f350>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f91b7941690>, 'icon_image': <shinken.property.StringProp object at 0x7f91b7941a10>, 'check_period': <shinken.property.StringProp object at 0x7f91b7aa4ed0>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'display_name': <shinken.property.StringProp object at 0x7f91b7aa4b50>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f91b7941750>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f91b7941ad0>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f91b7941650>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f91b732f110>, 'trigger': <shinken.property.StringProp object at 0x7f91b7933050>, 'initial_state': <shinken.property.CharProp object at 0x7f91b7aa4c90>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f91b7941790>, 'notification_options': <shinken.property.ListProp object at 0x7f91b7941810>, 'host_name': <shinken.property.StringProp object at 0x7f91b7aa4a10>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f91b7941850>, 'event_handler': <shinken.property.StringProp object at 0x7f91b7aa4fd0>, 'aggregation': <shinken.property.StringProp object at 0x7f91b7933210>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f91b7aa4f90>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f91b7941cd0>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f91b79330d0>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'notes': <shinken.property.StringProp object at 0x7f91b7941950>, 'check_command': <shinken.property.StringProp object at 0x7f91b7aa4c50>, 'parallelize_check': <shinken.property.BoolProp object at 0x7f91b7941b10>, 'servicegroups': <shinken.property.StringProp object at 0x7f91b7aa4bd0>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f91b7aa4e90>, 'check_interval': <shinken.property.IntegerProp object at 0x7f91b7aa4d10>, 'merge_host_contacts': <shinken.property.BoolProp object at 0x7f91b7941d10>, 'notes_url': <shinken.property.StringProp object at 0x7f91b7941990>, 'custom_views': <shinken.property.ListProp object at 0x7f91b79331d0>, 'check_freshness': <shinken.property.BoolProp object at 0x7f91b7aa4f50>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f91b7aa4e10>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f91b7941a50>, 'host_dependency_enabled': <shinken.property.BoolProp object at 0x7f91b7941d90>, 'checkmodulations': <shinken.property.ListProp object at 0x7f91b7933150>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f91b7941b90>, 'is_volatile': <shinken.property.BoolProp object at 0x7f91b7aa4c10>, 'default_value': <shinken.property.StringProp object at 0x7f91b7941f90>, 'maintenance_period': <shinken.property.StringProp object at 0x7f91b7941c90>, 'contacts': <shinken.property.StringProp object at 0x7f91b7941890>, 'notification_period': <shinken.property.StringProp object at 0x7f91b79417d0>, 'trending_policies': <shinken.property.ListProp object at 0x7f91b7933110>, 'resultmodulations': <shinken.property.StringProp object at 0x7f91b7941bd0>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f91b79416d0>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f91b7941e50>, 'stalking_options': <shinken.property.ListProp object at 0x7f91b7941910>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f91b732f810>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f91b7941e90>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f91b732f4d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'macromodulations': <shinken.property.ListProp object at 0x7f91b7933190>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f91b7941710>, 'contact_groups': <shinken.property.StringProp object at 0x7f91b79418d0>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f91b7941e10>, 'service_description': <shinken.property.StringProp object at 0x7f91b7aa4b10>, 'trigger_name': <shinken.property.ListProp object at 0x7f91b7933090>, 'service_dependencies': <shinken.property.ListProp object at 0x7f91b7941f10>, 'duplicate_foreach': <shinken.property.StringProp object at 0x7f91b7941f50>, 'poller_tag': <shinken.property.StringProp object at 0x7f91b7941b50>, 'icon_set': <shinken.property.StringProp object at 0x7f91b7941a90>, 'business_impact': <shinken.property.IntegerProp object at 0x7f91b7941fd0>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f91b7aa4cd0>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f91b7941ed0>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f91b7941dd0>}
raise_alert_log_entry()[source]
raise_cancel_downtime_log_entry()[source]
raise_enter_downtime_log_entry()[source]
raise_event_handler_log_entry(command)[source]
raise_exit_downtime_log_entry()[source]
raise_flapping_start_log_entry(change_ratio, threshold)[source]
raise_flapping_stop_log_entry(change_ratio, threshold)[source]
raise_freshness_log_entry(t_stale_by, t_threshold)[source]
raise_initial_state()[source]
raise_no_next_check_log_entry()[source]
raise_notification_log_entry(n)[source]
reactionner_tag
resultmodulations
retain_nonstatus_information
retain_status_information
retry_interval
return_code
running_properties = {'state_id_before_impact': <shinken.property.IntegerProp object at 0x7f91b794d5d0>, 'child_dependencies': <shinken.property.StringProp object at 0x7f91b794d750>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f91b7933dd0>, 'business_rule': <shinken.property.StringProp object at 0x7f91b794d6d0>, 'last_perf_data': <shinken.property.StringProp object at 0x7f91b794d250>, 'acknowledgement': <shinken.property.StringProp object at 0x7f91b7933c90>, 'actions': <shinken.property.ListProp object at 0x7f91b794d3d0>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f91b7933f50>, 'flapping_changes': <shinken.property.ListProp object at 0x7f91b7933b90>, 'last_time_critical': <shinken.property.IntegerProp object at 0x7f91b7933750>, 's_time': <shinken.property.FloatProp object at 0x7f91b7933ed0>, 'last_time_warning': <shinken.property.IntegerProp object at 0x7f91b7933710>, 'checks_in_progress': <shinken.property.ListProp object at 0x7f91b7933a90>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f91b7933990>, 'last_notification': <shinken.property.FloatProp object at 0x7f91b7933f10>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f91b7933a10>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f91b7933fd0>, 'last_state': <shinken.property.StringProp object at 0x7f91b7933510>, 'topology_change': <shinken.property.BoolProp object at 0x7f91b794d850>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f91b794d4d0>, 'impacts': <shinken.property.ListProp object at 0x7f91b794d550>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f91b7933610>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f91b794d7d0>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f91b794d710>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f91b7933c10>, 'notifications_in_progress': <shinken.property.ListProp object at 0x7f91b7933ad0>, 'u_time': <shinken.property.FloatProp object at 0x7f91b7933e90>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f91b7933590>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f91b7933d50>, 'broks': <shinken.property.ListProp object at 0x7f91b794d410>, 'last_time_unknown': <shinken.property.IntegerProp object at 0x7f91b7933790>, 'last_state_update': <shinken.property.FloatProp object at 0x7f91b7933a50>, 'execution_time': <shinken.property.FloatProp object at 0x7f91b7933e50>, 'start_time': <shinken.property.IntegerProp object at 0x7f91b794d110>, 'state_type': <shinken.property.StringProp object at 0x7f91b7933810>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'notified_contacts': <shinken.property.ListProp object at 0x7f91b794d310>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f91b7933bd0>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f91b794d190>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f91b794d350>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f91b7933850>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f91b794d050>, 'in_checking': <shinken.property.BoolProp object at 0x7f91b7933310>, 'last_state_change': <shinken.property.FloatProp object at 0x7f91b79335d0>, 'long_output': <shinken.property.StringProp object at 0x7f91b79338d0>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f91b79337d0>, 'current_event_id': <shinken.property.IntegerProp object at 0x7f91b7933490>, 'end_time': <shinken.property.IntegerProp object at 0x7f91b794d150>, 'timeout': <shinken.property.IntegerProp object at 0x7f91b794d0d0>, 'output': <shinken.property.StringProp object at 0x7f91b7933890>, 'perf_data': <shinken.property.StringProp object at 0x7f91b794d210>, 'state_before_impact': <shinken.property.StringProp object at 0x7f91b794d590>, 'is_impact': <shinken.property.BoolProp object at 0x7f91b794d490>, 'check_type': <shinken.property.IntegerProp object at 0x7f91b7933d10>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f91b794d390>, 'source_problems': <shinken.property.ListProp object at 0x7f91b794d510>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f91b79334d0>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f91b794d790>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f91b7933c50>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f91b7933d90>, 'latency': <shinken.property.FloatProp object at 0x7f91b7933390>, 'state_changed_since_impact': <shinken.property.BoolProp object at 0x7f91b794d610>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f91b794d090>, 'last_state_type': <shinken.property.StringProp object at 0x7f91b7933550>, 'downtimes': <shinken.property.ListProp object at 0x7f91b7933b10>, 'last_hard_state': <shinken.property.StringProp object at 0x7f91b7933650>, 'next_chk': <shinken.property.IntegerProp object at 0x7f91b79332d0>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f91b794d690>, 'comments': <shinken.property.ListProp object at 0x7f91b7933b50>, 'last_check_command': <shinken.property.StringProp object at 0x7f91b794d8d0>, 'state': <shinken.property.StringProp object at 0x7f91b7933410>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f91b7933e10>, 'last_chk': <shinken.property.IntegerProp object at 0x7f91b7933290>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f91b7933f90>, 'is_problem': <shinken.property.BoolProp object at 0x7f91b794d450>, 'last_time_ok': <shinken.property.IntegerProp object at 0x7f91b79336d0>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>, 'return_code': <shinken.property.IntegerProp object at 0x7f91b794d1d0>, 'is_flapping': <shinken.property.BoolProp object at 0x7f91b7933910>, 'customs': <shinken.property.ListProp object at 0x7f91b794d2d0>, 'host': <shinken.property.StringProp object at 0x7f91b794d290>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f91b794d810>, 'state_id': <shinken.property.IntegerProp object at 0x7f91b7933450>, 'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f91b79339d0>, 'attempt': <shinken.property.IntegerProp object at 0x7f91b79333d0>, 'act_depend_of': <shinken.property.ListProp object at 0x7f91b7933950>, 'triggers': <shinken.property.StringProp object at 0x7f91b794d890>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f91b7933cd0>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f91b7933250>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f91b7933350>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f91b794d650>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f91b7933690>}
s_time
scheduled_downtime_depth
service_dependencies
service_description
servicegroups
set_impact_state()[source]
set_state_from_exit_status(status)[source]
set_unreachable()[source]
should_be_scheduled
source_problems
stalking_options
start_time
state
state_before_hard_unknown_reach_phase
state_before_impact
state_changed_since_impact
state_id
state_id_before_impact
state_type
state_type_id
tags
time_to_orphanage
timeout
topology_change
trending_policies
trigger
trigger_broker_raise_enabled
trigger_name
triggers
u_time
unset_impact_state()[source]
use
was_in_hard_unknown_reach_phase
class shinken.objects.service.Services(items)[source]

Bases: shinken.objects.item.Items

apply_dependencies()[source]
apply_implicit_inheritance(hosts)[source]
apply_inheritance(hosts)[source]
clean()[source]
copy_create_service_from_another(hosts, s, hname)[source]
create_business_rules(hosts, services)[source]
create_business_rules_dependencies()[source]
create_reversed_list()[source]
delete_services_by_id(ids)[source]
explode(hosts, hostgroups, contactgroups, servicegroups, servicedependencies, triggers)[source]
find_srv_by_name_and_hostname(host_name, name)[source]
find_srv_id_by_name_and_hostname(host_name, name)[source]
find_srvs_by_hostname(host_name)[source]
inner_class

alias of Service

late_linkify_s_by_commands(commands)[source]
linkify(hosts, commands, timeperiods, contacts, resultmodulations, businessimpactmodulations, escalations, servicegroups, triggers, checkmodulations, macromodulations)[source]
linkify_s_by_hst(hosts)[source]
linkify_s_by_sg(servicegroups)[source]
override_properties(hosts)[source]
remove_exclusions(hosts)[source]

servicedependency Module

class shinken.objects.servicedependency.Servicedependencies(items)[source]

Bases: shinken.objects.item.Items

add_service_dependency(dep_host_name, dep_service_description, par_host_name, par_service_description)[source]
apply_inheritance(hosts)[source]
delete_servicesdep_by_id(ids)[source]
explode(hostgroups)[source]
explode_hostgroup(sd, hostgroups)[source]
is_correct()[source]
linkify(hosts, services, timeperiods)[source]
linkify_s_by_sd()[source]
linkify_sd_by_s(hosts, services)[source]
linkify_sd_by_tp(timeperiods)[source]
class shinken.objects.servicedependency.Servicedependency(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 0
my_type = 'servicedependency'
properties = {'inherits_parent': <shinken.property.BoolProp object at 0x7f91b731f190>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f91b731f210>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f91b731f110>, 'explode_hostgroup': <shinken.property.BoolProp object at 0x7f91b731f290>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f91b731f1d0>, 'dependency_period': <shinken.property.StringProp object at 0x7f91b731f250>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f91b7310d50>, 'host_name': <shinken.property.StringProp object at 0x7f91b731f0d0>, 'dependent_service_description': <shinken.property.StringProp object at 0x7f91b731f050>, 'service_description': <shinken.property.StringProp object at 0x7f91b731f150>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f91b7310ed0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}

serviceescalation Module

class shinken.objects.serviceescalation.Serviceescalation(params={})[source]

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'serviceescalation'
properties = {'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'contact_groups': <shinken.property.StringProp object at 0x7f91b7954a90>, 'escalation_period': <shinken.property.StringProp object at 0x7f91b79549d0>, 'service_description': <shinken.property.StringProp object at 0x7f91b79548d0>, 'last_notification': <shinken.property.IntegerProp object at 0x7f91b7954950>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f91b7954990>, 'contacts': <shinken.property.StringProp object at 0x7f91b7954a50>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f91b7954b10>, 'escalation_options': <shinken.property.ListProp object at 0x7f91b7954a10>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f91b7954890>, 'host_name': <shinken.property.StringProp object at 0x7f91b7954810>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f91b7954ad0>, 'first_notification': <shinken.property.IntegerProp object at 0x7f91b7954910>}
class shinken.objects.serviceescalation.Serviceescalations(items)[source]

Bases: shinken.objects.item.Items

explode(escalations)[source]
inner_class

alias of Serviceescalation

name_property = ''

serviceextinfo Module

This is the main class for the Service ext info. In fact it’s mainly about the configuration part. Parameters are merged in Service so it’s no use in running part

class shinken.objects.serviceextinfo.ServiceExtInfo(params={})[source]

Bases: shinken.objects.item.Item

definition_order
get_dbg_name()[source]
get_full_name()[source]
get_name()[source]
host_name
icon_image
icon_image_alt
id = 1
imported_from
is_correct()[source]
macros = {'SERVICENOTES': 'notes', 'SERVICEDESC': 'service_description', 'SERVICENOTESURL': 'notes_url', 'SERVICEACTIONURL': 'action_url'}
my_type = 'serviceextinfo'
name
notes
notes_url
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f91b5856f10>, 'notes': <shinken.property.StringProp object at 0x7f91b6dcf990>, 'icon_image': <shinken.property.StringProp object at 0x7f91b5856ed0>, 'notes_url': <shinken.property.StringProp object at 0x7f91b5856e90>, 'host_name': <shinken.property.ListProp object at 0x7f91b755b750>, 'service_description': <shinken.property.StringProp object at 0x7f91b5685890>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
service_description
use
class shinken.objects.serviceextinfo.ServicesExtInfo(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of ServiceExtInfo

merge(services)[source]
merge_extinfo(service, extinfo)[source]
name_property = 'host_name'

servicegroup Module

class shinken.objects.servicegroup.Servicegroup(params={})[source]

Bases: shinken.objects.itemgroup.Itemgroup

get_name()[source]
get_servicegroup_members()[source]
get_services()[source]
get_services_by_explosion(servicegroups)[source]
id = 1
macros = {'SERVICEGROUPNOTES': 'notes', 'SERVICEGROUPALIAS': 'alias', 'SERVICEGROUPMEMBERS': 'members', 'SERVICEGROUPACTIONURL': 'action_url', 'SERVICEGROUPNOTESURL': 'notes_url'}
my_type = 'servicegroup'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'alias': <shinken.property.StringProp object at 0x7f91b7310bd0>, 'notes': <shinken.property.StringProp object at 0x7f91b7310c10>, 'unknown_members': <shinken.property.StringProp object at 0x7f91b7303510>, 'action_url': <shinken.property.StringProp object at 0x7f91b7310c90>, 'notes_url': <shinken.property.StringProp object at 0x7f91b7310c50>, 'members': <shinken.property.StringProp object at 0x7f91b7303490>, 'id': <shinken.property.StringProp object at 0x7f91b7310990>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>, 'servicegroup_name': <shinken.property.StringProp object at 0x7f91b7310b90>}
class shinken.objects.servicegroup.Servicegroups(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

add_member(cname, sgname)[source]
explode()[source]
inner_class

alias of Servicegroup

linkify(services)[source]
linkify_sg_by_srv(services)[source]
name_property = 'servicegroup_name'

timeperiod Module

class shinken.objects.timeperiod.Timeperiod(params={})[source]

Bases: shinken.objects.item.Item

apply_inheritance()[source]
check_and_log_activation_change()[source]
check_exclude_rec()[source]
clean_cache()[source]
explode(timeperiods)[source]
fill_data_brok_from(data, brok_type)[source]
find_next_invalid_time_from_cache(t)[source]
find_next_valid_time_from_cache(t)[source]
get_initial_status_brok()[source]
get_min_from_t(t)[source]
get_name()[source]
get_next_invalid_time_from_t(t)[source]
get_next_valid_time_from_t(t)[source]
get_not_in_min_from_t(f)[source]
get_raw_import_values()[source]
get_unresolved_properties_by_inheritance(items)[source]
has(prop)[source]
id = 1
is_correct()[source]
is_time_valid(t)[source]
linkify(timeperiods)[source]
my_type = 'timeperiod'
properties = {'use': <shinken.property.StringProp object at 0x7f91b710a510>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'register': <shinken.property.IntegerProp object at 0x7f91b710a550>, 'is_active': <shinken.property.BoolProp object at 0x7f91b710a610>, 'dateranges': <shinken.property.ListProp object at 0x7f91b710a590>, 'alias': <shinken.property.StringProp object at 0x7f91b710a4d0>, 'timeperiod_name': <shinken.property.StringProp object at 0x7f91b710a450>, 'exclude': <shinken.property.ListProp object at 0x7f91b710a5d0>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
resolve_daterange(dateranges, entry)[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>}
class shinken.objects.timeperiod.Timeperiods(items)[source]

Bases: shinken.objects.item.Items

apply_inheritance()[source]
explode()[source]
inner_class

alias of Timeperiod

is_correct()[source]
linkify()[source]
name_property = 'timeperiod_name'

trigger Module

class shinken.objects.trigger.Trigger(params={})[source]

Bases: shinken.objects.item.Item

compile()[source]
eval(myself, ctx)[source]
get_name()[source]
id = 1
my_type = 'trigger'
properties = {'use': <shinken.property.ListProp object at 0x7f91b7800950>, 'code_src': <shinken.property.StringProp object at 0x7f91b7335310>, 'name': <shinken.property.StringProp object at 0x7f91b7800b50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f91b7800c50>, 'trigger_name': <shinken.property.StringProp object at 0x7f91b7335290>, 'imported_from': <shinken.property.StringProp object at 0x7f91b7800c10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f91b7800cd0>, 'code_bin': <shinken.property.StringProp object at 0x7f91b7335350>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f91b7800c90>, 'tags': <shinken.property.ListProp object at 0x7f91b7800d50>, 'hash': <shinken.property.StringProp object at 0x7f91b7800d10>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f91b7335390>}
class shinken.objects.trigger.Triggers(items)[source]

Bases: shinken.objects.item.Items

compile()[source]
create_trigger(src, name)[source]
inner_class

alias of Trigger

load_file(path)[source]
load_objects(conf)[source]
name_property = 'trigger_name'