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 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'modulation_period': <shinken.property.StringProp object at 0x7f50e15e5790>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'business_impact_modulation_name': <shinken.property.StringProp object at 0x7f50e15e56d0>, 'business_impact': <shinken.property.IntegerProp object at 0x7f50e15e5750>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
class shinken.objects.businessimpactmodulation.Businessimpactmodulations(items, index_items=True)[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 0x7f50df8ed150>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'check_command': <shinken.property.StringProp object at 0x7f50df8ed710>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'checkmodulation_name': <shinken.property.StringProp object at 0x7f50df8ede10>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
class shinken.objects.checkmodulation.CheckModulations(items, index_items=True)[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 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'command_line': <shinken.property.StringProp object at 0x7f50e1a89e10>, 'poller_tag': <shinken.property.StringProp object at 0x7f50e1a89e50>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f50e1a89e90>, 'module_type': <shinken.property.StringProp object at 0x7f50e1a89ed0>, 'timeout': <shinken.property.IntegerProp object at 0x7f50e1a89f10>, 'enable_environment_macros': <shinken.property.BoolProp object at 0x7f50e1a89f50>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'command_name': <shinken.property.StringProp object at 0x7f50e1a89d90>}
reactionner_tag
register
timeout
use
class shinken.objects.command.Commands(items, index_items=True)[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 = {'host_notification_commands': <shinken.property.StringProp object at 0x7f50e1979a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'address1': <shinken.property.StringProp object at 0x7f50e1979b90>, 'address2': <shinken.property.StringProp object at 0x7f50e1979bd0>, 'address3': <shinken.property.StringProp object at 0x7f50e1979c10>, 'address4': <shinken.property.StringProp object at 0x7f50e1979c50>, 'address5': <shinken.property.StringProp object at 0x7f50e1979c90>, 'address6': <shinken.property.StringProp object at 0x7f50e1979cd0>, 'contactgroups': <shinken.property.ListProp object at 0x7f50e1979490>, 'is_admin': <shinken.property.BoolProp object at 0x7f50e1979d50>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f50e1979590>, 'can_submit_commands': <shinken.property.BoolProp object at 0x7f50e1979d10>, 'contact_name': <shinken.property.StringProp object at 0x7f50e19793d0>, 'password': <shinken.property.StringProp object at 0x7f50e1979e50>, 'pager': <shinken.property.StringProp object at 0x7f50e1979b50>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'notificationways': <shinken.property.StringProp object at 0x7f50e1979e10>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'service_notification_commands': <shinken.property.StringProp object at 0x7f50e1979a90>, 'host_notification_period': <shinken.property.StringProp object at 0x7f50e1979910>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'expert': <shinken.property.BoolProp object at 0x7f50e1979d90>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f50e19794d0>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'service_notification_period': <shinken.property.StringProp object at 0x7f50e1979990>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f50e1979ad0>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f50e1979dd0>, 'email': <shinken.property.StringProp object at 0x7f50e1979b10>, 'alias': <shinken.property.StringProp object at 0x7f50e1979450>, 'service_notification_options': <shinken.property.ListProp object at 0x7f50e1979a10>, 'host_notification_options': <shinken.property.ListProp object at 0x7f50e19799d0>}
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 0x7f50e13f9c50>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f50e1979e90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'downtimes': <shinken.property.StringProp object at 0x7f50e1979ed0>}
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, index_items=True)[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 0x7f50e13f9b90>, 'unknown_members': <shinken.property.ListProp object at 0x7f50e15c4710>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'members': <shinken.property.ListProp object at 0x7f50e15c4690>, 'alias': <shinken.property.StringProp object at 0x7f50e15ce3d0>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'contactgroup_name': <shinken.property.StringProp object at 0x7f50e15ce390>, 'id': <shinken.property.IntegerProp object at 0x7f50e15ce150>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
class shinken.objects.contactgroup.Contactgroups(items, index_items=True)[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 0x7f50e13f9890>, 'creation_type': <shinken.property.StringProp object at 0x7f50e5414ed0>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'discoveryrule_order': <shinken.property.IntegerProp object at 0x7f50e5414f10>, 'discoveryrule_name': <shinken.property.StringProp object at 0x7f50e5414dd0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e5414f50>}
class shinken.objects.discoveryrule.Discoveryrules(items, index_items=True)[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 0x7f50e13f9890>, 'discoveryrun_command': <shinken.property.StringProp object at 0x7f50e15e5250>, 'discoveryrun_name': <shinken.property.StringProp object at 0x7f50e15e5050>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'current_launch': <shinken.property.StringProp object at 0x7f50e15e5290>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
class shinken.objects.discoveryrun.Discoveryruns(items, index_items=True)[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 0x7f50e13f9890>, 'last_notification': <shinken.property.IntegerProp object at 0x7f50e1ab8550>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'contacts': <shinken.property.ListProp object at 0x7f50e1ab88d0>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f50e1ab87d0>, 'escalation_options': <shinken.property.ListProp object at 0x7f50e1ab8890>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'contact_groups': <shinken.property.ListProp object at 0x7f50e1ab8910>, 'escalation_name': <shinken.property.StringProp object at 0x7f50e1ab8450>, 'escalation_period': <shinken.property.StringProp object at 0x7f50e1ab8850>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f50e1ab8790>, 'first_notification': <shinken.property.IntegerProp object at 0x7f50e1ab8510>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f50e1ab8810>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'time_based': <shinken.property.BoolProp object at 0x7f50e1ab8950>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
class shinken.objects.escalation.Escalations(items, index_items=True)[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_short_status()[source]
get_status()[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_snapshot
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', 'SHORTSTATUS': 'get_short_status', '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', 'HOSTADDRESS28': 'address28', 'HOSTADDRESS12': 'address12', 'LASTHOSTUP': 'last_time_up', 'STATUS': 'get_status', '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', 'FULLNAME': 'get_full_name', '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 0x7f50e1959f50>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7f50e1964190>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f50e1abc4d0>, 'labels': <shinken.property.StringProp object at 0x7f50e1964310>, 'action_url': <shinken.property.StringProp object at 0x7f50e1959e10>, 'escalations': <shinken.property.ListProp object at 0x7f50e19641d0>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f50e1abc710>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f50e1abc810>, '2d_coords': <shinken.property.StringProp object at 0x7f50e1959f90>, 'icon_image': <shinken.property.StringProp object at 0x7f50e1959e50>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7f50e1964790>, 'check_period': <shinken.property.StringProp object at 0x7f50e1abc590>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'display_name': <shinken.property.StringProp object at 0x7f50e1abc2d0>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f50e1abca10>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f50e1964050>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f50e1abc7d0>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7f50e1964690>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f50e1abc6d0>, 'trigger': <shinken.property.StringProp object at 0x7f50e19644d0>, 'parents': <shinken.property.ListProp object at 0x7f50e1abc350>, 'initial_state': <shinken.property.CharProp object at 0x7f50e1abc410>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f50e1abca50>, 'notification_options': <shinken.property.ListProp object at 0x7f50e1abcad0>, 'host_name': <shinken.property.StringProp object at 0x7f50e1abc210>, 'snapshot_period': <shinken.property.StringProp object at 0x7f50e1964710>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f50e1abcb10>, 'event_handler': <shinken.property.StringProp object at 0x7f50e1abc690>, 'obsess_over_host': <shinken.property.BoolProp object at 0x7f50e1abc5d0>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f50e1abc650>, 'alias': <shinken.property.StringProp object at 0x7f50e1abc290>, 'service_excludes': <shinken.property.ListProp object at 0x7f50e19642d0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f50e1964250>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f50e1964550>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'custom_views': <shinken.property.ListProp object at 0x7f50e1964650>, 'check_command': <shinken.property.StringProp object at 0x7f50e1abc3d0>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f50e1abc550>, 'check_interval': <shinken.property.IntegerProp object at 0x7f50e1abc490>, 'notes': <shinken.property.StringProp object at 0x7f50e1959d90>, 'check_freshness': <shinken.property.BoolProp object at 0x7f50e1abc610>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f50e1abc510>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f50e1959e90>, 'hostgroups': <shinken.property.ListProp object at 0x7f50e1abc390>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f50e1964110>, 'notes_url': <shinken.property.StringProp object at 0x7f50e1959dd0>, 'service_overrides': <shinken.property.ListProp object at 0x7f50e1964290>, 'maintenance_period': <shinken.property.StringProp object at 0x7f50e1964210>, 'realm': <shinken.property.StringProp object at 0x7f50e1964090>, 'contacts': <shinken.property.ListProp object at 0x7f50e1abc910>, 'notification_period': <shinken.property.StringProp object at 0x7f50e1abca90>, 'trending_policies': <shinken.property.ListProp object at 0x7f50e1964590>, 'resultmodulations': <shinken.property.ListProp object at 0x7f50e1964150>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f50e1abc850>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f50e19643d0>, 'stalking_options': <shinken.property.ListProp object at 0x7f50e1abcb50>, 'macromodulations': <shinken.property.ListProp object at 0x7f50e1964610>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f50e1abc790>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f50e1964410>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f50e1abc750>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7f50e1964750>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f50e1abc890>, 'contact_groups': <shinken.property.ListProp object at 0x7f50e1abc990>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f50e1964390>, 'address': <shinken.property.StringProp object at 0x7f50e1abc310>, 'trigger_name': <shinken.property.StringProp object at 0x7f50e1964510>, 'vrml_image': <shinken.property.StringProp object at 0x7f50e1959f10>, '3d_coords': <shinken.property.StringProp object at 0x7f50e1959fd0>, 'snapshot_command': <shinken.property.StringProp object at 0x7f50e19646d0>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'checkmodulations': <shinken.property.ListProp object at 0x7f50e19645d0>, 'poller_tag': <shinken.property.StringProp object at 0x7f50e19640d0>, 'icon_set': <shinken.property.StringProp object at 0x7f50e1959ed0>, 'business_impact': <shinken.property.IntegerProp object at 0x7f50e1964490>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f50e1abc450>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f50e1964450>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f50e1964350>}
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]
raise_snapshot_log_entry(command)[source]
reactionner_tag
realm
register
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 0x7f50e1971c10>, 'child_dependencies': <shinken.property.StringProp object at 0x7f50e1971a50>, 'last_time_unreachable': <shinken.property.IntegerProp object at 0x7f50e1964d50>, 'childs': <shinken.property.StringProp object at 0x7f50e19719d0>, 'business_rule': <shinken.property.StringProp object at 0x7f50e1971d10>, 'last_perf_data': <shinken.property.StringProp object at 0x7f50e19717d0>, 'acknowledgement': <shinken.property.StringProp object at 0x7f50e1971250>, 'actions': <shinken.property.StringProp object at 0x7f50e1971950>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f50e1971510>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f50e1971390>, 's_time': <shinken.property.FloatProp object at 0x7f50e1971490>, 'checks_in_progress': <shinken.property.StringProp object at 0x7f50e1971090>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f50e1964f10>, 'last_notification': <shinken.property.FloatProp object at 0x7f50e19714d0>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f50e1964f90>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f50e1971590>, 'last_state': <shinken.property.StringProp object at 0x7f50e1964b10>, 'topology_change': <shinken.property.BoolProp object at 0x7f50e1971e10>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f50e1971b10>, 'impacts': <shinken.property.StringProp object at 0x7f50e1971b90>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f50e1964c10>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f50e1971d90>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f50e1971a10>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f50e19711d0>, 'notifications_in_progress': <shinken.property.StringProp object at 0x7f50e19710d0>, 'u_time': <shinken.property.FloatProp object at 0x7f50e1971450>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f50e1964b50>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f50e1971310>, 'broks': <shinken.property.StringProp object at 0x7f50e1971990>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f50e1971610>, 'last_state_update': <shinken.property.StringProp object at 0x7f50e1964fd0>, 'execution_time': <shinken.property.FloatProp object at 0x7f50e1971410>, 'start_time': <shinken.property.IntegerProp object at 0x7f50e1971690>, 'flapping_changes': <shinken.property.StringProp object at 0x7f50e1971190>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'notified_contacts': <shinken.property.StringProp object at 0x7f50e1971890>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f50e1964e90>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f50e1971710>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f50e19718d0>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f50e1964f50>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f50e1964a50>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f50e19715d0>, 'in_checking': <shinken.property.BoolProp object at 0x7f50e1964890>, 'last_state_change': <shinken.property.FloatProp object at 0x7f50e1964bd0>, 'long_output': <shinken.property.StringProp object at 0x7f50e1964e10>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f50e1964d90>, 'end_time': <shinken.property.IntegerProp object at 0x7f50e19716d0>, 'timeout': <shinken.property.IntegerProp object at 0x7f50e1971650>, 'output': <shinken.property.StringProp object at 0x7f50e1964dd0>, 'perf_data': <shinken.property.StringProp object at 0x7f50e1971790>, 'state_before_impact': <shinken.property.StringProp object at 0x7f50e1971bd0>, 'is_impact': <shinken.property.StringProp object at 0x7f50e1971ad0>, 'check_type': <shinken.property.IntegerProp object at 0x7f50e19712d0>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f50e1971910>, 'source_problems': <shinken.property.StringProp object at 0x7f50e1971b50>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f50e1964ad0>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f50e1971d50>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f50e1971210>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f50e1971350>, 'latency': <shinken.property.FloatProp object at 0x7f50e1964910>, 'state_changed_since_impact': <shinken.property.StringProp object at 0x7f50e1971c50>, 'current_event_id': <shinken.property.StringProp object at 0x7f50e1964a90>, 'last_state_type': <shinken.property.StringProp object at 0x7f50e1964b90>, 'downtimes': <shinken.property.StringProp object at 0x7f50e1971110>, 'last_time_up': <shinken.property.IntegerProp object at 0x7f50e1964cd0>, 'last_hard_state': <shinken.property.StringProp object at 0x7f50e1964c50>, 'next_chk': <shinken.property.IntegerProp object at 0x7f50e1964850>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f50e1971cd0>, 'comments': <shinken.property.StringProp object at 0x7f50e1971150>, 'last_check_command': <shinken.property.StringProp object at 0x7f50e1971f10>, 'state': <shinken.property.StringProp object at 0x7f50e1964990>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f50e19713d0>, 'last_chk': <shinken.property.IntegerProp object at 0x7f50e1964810>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f50e1971550>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7f50e1971ed0>, 'is_problem': <shinken.property.StringProp object at 0x7f50e1971a90>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>, 'pack_id': <shinken.property.IntegerProp object at 0x7f50e1971e50>, 'return_code': <shinken.property.IntegerProp object at 0x7f50e1971750>, 'is_flapping': <shinken.property.BoolProp object at 0x7f50e1964e50>, 'customs': <shinken.property.StringProp object at 0x7f50e1971810>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f50e1971dd0>, 'got_default_realm': <shinken.property.BoolProp object at 0x7f50e1971850>, 'state_id': <shinken.property.IntegerProp object at 0x7f50e19649d0>, 'services': <shinken.property.StringProp object at 0x7f50e1971050>, 'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'state_type': <shinken.property.StringProp object at 0x7f50e1964a10>, 'attempt': <shinken.property.IntegerProp object at 0x7f50e1964950>, 'act_depend_of': <shinken.property.ListProp object at 0x7f50e1964ed0>, 'triggers': <shinken.property.StringProp object at 0x7f50e1971e90>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f50e1971290>, 'last_time_down': <shinken.property.IntegerProp object at 0x7f50e1964d10>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f50e19647d0>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f50e19648d0>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f50e1971c90>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f50e1964c90>}
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
snapshot_command
snapshot_criteria
snapshot_enabled
snapshot_interval
snapshot_period
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, index_items=True)[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, index_items=True)[source]

Bases: shinken.objects.item.Items

apply_inheritance()[source]
delete_hostsdep_by_id(ids)[source]
explode(hostgroups)[source]
inner_class

alias of Hostdependency

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 0x7f50e54146d0>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f50e5414750>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'dependency_period': <shinken.property.StringProp object at 0x7f50e5414790>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f50e5414710>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f50e5414690>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f50e5414510>, 'host_name': <shinken.property.StringProp object at 0x7f50e5414650>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f50e54145d0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}

hostescalation Module

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

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'hostescalation'
properties = {'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'contact_groups': <shinken.property.StringProp object at 0x7f50e1ab8fd0>, 'escalation_period': <shinken.property.StringProp object at 0x7f50e1ab8f10>, 'last_notification': <shinken.property.IntegerProp object at 0x7f50e1ab8e90>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f50e1ab8ed0>, 'contacts': <shinken.property.StringProp object at 0x7f50e1ab8f90>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f50e1abc090>, 'escalation_options': <shinken.property.ListProp object at 0x7f50e1ab8f50>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f50e1ab8e10>, 'host_name': <shinken.property.StringProp object at 0x7f50e1ab8d50>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f50e1abc050>, 'first_notification': <shinken.property.IntegerProp object at 0x7f50e1ab8e50>}
class shinken.objects.hostescalation.Hostescalations(items, index_items=True)[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 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f50df8edad0>, 'notes': <shinken.property.StringProp object at 0x7f50df8ed6d0>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'vrml_image': <shinken.property.StringProp object at 0x7f50df8ed550>, '3d_coords': <shinken.property.StringProp object at 0x7f50df8ed110>, 'notes_url': <shinken.property.StringProp object at 0x7f50df8ed590>, 'host_name': <shinken.property.StringProp object at 0x7f50df8ed610>, 'icon_image': <shinken.property.StringProp object at 0x7f50df8ed4d0>, '2d_coords': <shinken.property.StringProp object at 0x7f50df8ed190>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'statusmap_image': <shinken.property.StringProp object at 0x7f50df8ed9d0>}
register
statusmap_image
use
vrml_image
class shinken.objects.hostextinfo.HostsExtInfo(items, index_items=True)[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 0x7f50e13f9890>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f50e15c47d0>, 'realm': <shinken.property.StringProp object at 0x7f50e15c4910>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'alias': <shinken.property.StringProp object at 0x7f50e15c4810>, 'notes': <shinken.property.StringProp object at 0x7f50e15c4850>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'unknown_members': <shinken.property.ListProp object at 0x7f50e15c4710>, 'action_url': <shinken.property.StringProp object at 0x7f50e15c48d0>, 'notes_url': <shinken.property.StringProp object at 0x7f50e15c4890>, 'members': <shinken.property.ListProp object at 0x7f50e15c4690>, 'id': <shinken.property.IntegerProp object at 0x7f50e15c4790>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
class shinken.objects.hostgroup.Hostgroups(items, index_items=True)[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]
dump()[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()[source]
get_initial_status_brok()[source]
get_next_schedule_brok()[source]
get_plus_and_delete(prop)[source]
get_property_by_inheritance(prop)[source]
get_property_value_for_brok(prop, tab)[source]
get_raw_import_values()[source]
get_snapshot_brok(snap_output, exit_status)[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 0x7f50e13f9b90>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
unacknowledge_problem()[source]
unacknowledge_problem_if_not_sticky()[source]
class shinken.objects.item.Items(items, index_items=True)[source]

Bases: object

add_item(item, index=True)[source]

Adds a template into the items container, and index it depending on the index flag.

Parameters:
  • item – The item to add
  • index – Flag indicating if the item should be indexed
add_items(items, index_items)[source]

Add items into the items or templates container depending on the is_tpl method result.

Parameters:
  • items – The items list to add.
  • index_items – Flag indicating if the items should be indexed on the fly.
add_template(tpl)[source]

Adds and index a template into the templates container.

Parameters:tpl – The template to add
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]
evaluate_hostgroup_expression(expr, hosts, hostgroups, look_in='hostgroups')[source]
explode_contact_groups_into_contacts(item, contactgroups)[source]
explode_host_groups_into_hosts(item, hosts, hostgroups)[source]
explode_trigger_string_into_triggers(triggers)[source]
fill_default()[source]
find_by_filter(filters)[source]
find_by_name(name)[source]
find_tpl_by_name(name)[source]
get_all_tags(item)[source]
get_hosts_from_hostgroups(hgname, hostgroups)[source]
get_source(item)[source]
index_item(item, name=None)[source]

Indexes a template by name into the name_to_template dictionnary.

If an object holding the same name already exists in the index, the conflict is managed by the manage_conflict method.

An optional name may be given to force the name under which the object should be indexed.

Parameters:
  • item – The item to index
  • name – The optional name to use to index the item
index_template(tpl)[source]

Indexes a template by name into the name_to_template dictionnary.

Parameters:tpl – The template to index
is_correct()[source]
linkify_command_list_with_commands(commands, prop)[source]
linkify_item_templates(item)[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]
manage_conflict(item, name)[source]

Cheks if an object holding the same name already exists in the index.

If so, it compares their definition order: the lowest definition order is kept. If definiton order equal, an error is risen.Item

The method returns the item that should be added after it has decided which one should be kept.

If the new item has precedence over the New existing one, the existing is removed for the new to replace it.

Parameters:
  • item – The new item to check for confict
  • name – The exiting object name

:return The retained object

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_item(item)[source]

Removes and unindexes an item from the items container.

Parameters:item – The item to remove
remove_template(tpl)[source]

Removes and unindexes a template from the templates container.

Parameters:tpl – The template to remove
remove_templates()[source]

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

unindex_item(item, name=None)[source]

Unindexes an item from the items container.

An optional name may be given to indicate the mame under which the object was indexed.

Parameters:
  • item – The item to unindex
  • name – The name under which the item has been indexed.
unindex_template(tpl)[source]

Unindex a template from the templates container.

Parameters:tpl – The template to unindex

itemgroup Module

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

Bases: shinken.objects.item.Item

add_string_member(member)[source]
add_string_unknown_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.ListProp object at 0x7f50e15c4690>, 'unknown_members': <shinken.property.ListProp object at 0x7f50e15c4710>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
replace_members(members)[source]
class shinken.objects.itemgroup.Itemgroups(items, index_items=True)[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 0x7f50e15e5850>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'modulation_period': <shinken.property.StringProp object at 0x7f50e15e5b50>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
class shinken.objects.macromodulation.MacroModulations(items, index_items=True)[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 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'modules': <shinken.property.ListProp object at 0x7f50e5414c10>, 'module_type': <shinken.property.StringProp object at 0x7f50e5414bd0>, 'module_name': <shinken.property.StringProp object at 0x7f50e5414b50>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
class shinken.objects.module.Modules(items, index_items=True)[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 0x7f50e13f9890>, 'host_notification_commands': <shinken.property.StringProp object at 0x7f50e15ce7d0>, 'notificationway_name': <shinken.property.StringProp object at 0x7f50e15ce590>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f50e15ce610>, 'service_notification_options': <shinken.property.ListProp object at 0x7f50e15ce790>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'service_notification_period': <shinken.property.StringProp object at 0x7f50e15ce710>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f50e15ce850>, 'host_notification_options': <shinken.property.ListProp object at 0x7f50e15ce750>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f50e15ce650>, 'host_notification_period': <shinken.property.StringProp object at 0x7f50e15ce690>, 'service_notification_commands': <shinken.property.StringProp object at 0x7f50e15ce810>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
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, index_items=True)[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 = {'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'pack_name': <shinken.property.StringProp object at 0x7f50dffea150>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'macros': <shinken.property.StringProp object at 0x7f50dffea7d0>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
class shinken.objects.pack.Packs(items, index_items=True)[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.ListProp object at 0x7f50e15c4fd0>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'realm_members': <shinken.property.ListProp object at 0x7f50e15c4f90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'realm_name': <shinken.property.StringProp object at 0x7f50e15c4f50>, 'unknown_members': <shinken.property.ListProp object at 0x7f50e15c4710>, 'default': <shinken.property.BoolProp object at 0x7f50e1979050>, 'broker_complete_links': <shinken.property.BoolProp object at 0x7f50e1979090>, 'members': <shinken.property.ListProp object at 0x7f50e15c4690>, 'id': <shinken.property.IntegerProp object at 0x7f50e15c4ed0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'serialized_confs': <shinken.property.DictProp object at 0x7f50e19790d0>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
class shinken.objects.realm.Realms(items, index_items=True)[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]
recur_higer_realms(r, sons)[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 0x7f50e13f9890>, 'resultmodulation_name': <shinken.property.StringProp object at 0x7f50e1a89fd0>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'modulation_period': <shinken.property.StringProp object at 0x7f50e1ab8250>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'exit_code_modulation': <shinken.property.IntegerProp object at 0x7f50e1ab8210>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'exit_codes_match': <shinken.property.IntListProp object at 0x7f50e1ab8110>}
pythonize()[source]
class shinken.objects.resultmodulation.Resultmodulations(items, index_items=True)[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]
get_business_rule_output()[source]

Returns a status string for business rules based items formatted using business_rule_output_template attribute as template.

The template may embed output formatting for itself, and for its child (dependant) itmes. Childs format string is expanded into the $( and )$, using the string between brackets as format string.

Any business rule based item or child macros may be used. In addition, the $STATUS$, $SHORTSTATUS$ and $FULLNAME$ macro which name is common to hosts and services may be used to ease template writing.

Caution: only childs in state not OK are displayed.

Example:
A business rule with a format string looking like
“$STATUS$ [ $($TATUS$: $HOSTNAME$,$SERVICEDESC$ )$ ]”
Would return
“CRITICAL [ CRITICAL: host1,srv1 WARNING: host2,srv2 ]”
get_escalable_contacts(n)[source]
get_event_handlers(externalcmd=False)[source]
get_next_notification_time(n)[source]
get_perfdata_command()[source]
get_snapshot()[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]
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]
get_short_status()[source]
get_status()[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_snapshot
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 = {'SERVICEDOWNTIME': 'get_downtime', 'SERVICEACKAUTHORNAME': 'get_ack_author_name', 'LASTSERVICESTATE': 'last_state', 'SERVICEACKCOMMENT': 'get_ack_comment', 'SERVICEDURATIONSEC': 'get_duration_sec', 'SERVICEDESC': 'service_description', 'SERVICEPERFDATA': 'perf_data', 'SERVICEATTEMPT': 'attempt', 'LASTSERVICEUNKNOWN': 'last_time_unknown', 'SERVICEBUSINESSIMPACT': 'business_impact', 'LASTSERVICECRITICAL': 'last_time_critical', 'LASTSERVICECHECK': 'last_chk', 'SERVICEEVENTID': 'current_event_id', 'SERVICEPERCENTCHANGE': 'percent_state_change', 'SERVICEACKAUTHORALIAS': 'get_ack_author_name', 'MAXSERVICEATTEMPTS': 'max_check_attempts', 'LASTSERVICEPROBLEMID': 'last_problem_id', 'SERVICEDISPLAYNAME': 'display_name', 'SERVICEGROUPNAME': 'get_groupname', 'LASTSERVICEEVENTID': 'last_event_id', 'SERVICESTATE': 'state', 'SERVICEGROUPNAMES': 'get_groupnames', 'SERVICENOTESURL': 'notes_url', 'SERVICECHECKCOMMAND': 'get_check_command', 'SERVICEDURATION': 'get_duration', 'SERVICEACTIONURL': 'action_url', 'LASTSERVICESTATECHANGE': 'last_state_change', 'LONGSERVICEOUTPUT': 'long_output', 'SHORTSTATUS': 'get_short_status', 'LASTSERVICEPERFDATA': 'last_perf_data', 'SERVICESTATETYPE': 'state_type', 'LASTSERVICEWARNING': 'last_time_warning', 'SERVICEACKAUTHOR': 'get_ack_author_name', 'SERVICEEXECUTIONTIME': 'execution_time', 'SERVICESTATEID': 'state_id', 'STATUS': 'get_status', 'LASTSERVICESTATEID': 'last_state_id', 'LASTSERVICEOK': 'last_time_ok', 'SERVICEPROBLEMID': 'current_problem_id', 'SERVICELATENCY': 'latency', 'SERVICEOUTPUT': 'output', 'SERVICENOTES': 'notes', 'SERVICEISVOLATILE': 'is_volatile', 'FULLNAME': 'get_full_name'}
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 0x7f50e138ca90>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7f50e1a84c90>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f50e138cd50>, 'labels': <shinken.property.ListProp object at 0x7f50e1a84dd0>, 'obsess_over_service': <shinken.property.BoolProp object at 0x7f50e138ced0>, 'action_url': <shinken.property.StringProp object at 0x7f50e1a84a50>, 'escalations': <shinken.property.ListProp object at 0x7f50e1a84cd0>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f50e1584310>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f50e1a84710>, 'icon_image': <shinken.property.StringProp object at 0x7f50e1a84a90>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7f50e1aac3d0>, 'check_period': <shinken.property.StringProp object at 0x7f50e138ce90>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'display_name': <shinken.property.StringProp object at 0x7f50e138cb10>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f50e1a847d0>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f50e1a84b50>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f50e1a846d0>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7f50e1aac2d0>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f50e15840d0>, 'trigger': <shinken.property.StringProp object at 0x7f50e1aac0d0>, 'initial_state': <shinken.property.CharProp object at 0x7f50e138cc50>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f50e1a84810>, 'notification_options': <shinken.property.ListProp object at 0x7f50e1a84890>, 'host_name': <shinken.property.StringProp object at 0x7f50e138c9d0>, 'snapshot_period': <shinken.property.StringProp object at 0x7f50e1aac350>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f50e1a848d0>, 'event_handler': <shinken.property.StringProp object at 0x7f50e138cf90>, 'aggregation': <shinken.property.StringProp object at 0x7f50e1aac290>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f50e138cf50>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f50e1a84d50>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f50e1aac150>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'notes': <shinken.property.StringProp object at 0x7f50e1a849d0>, 'check_command': <shinken.property.StringProp object at 0x7f50e138cc10>, 'parallelize_check': <shinken.property.BoolProp object at 0x7f50e1a84b90>, 'servicegroups': <shinken.property.StringProp object at 0x7f50e138cb90>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f50e138ce50>, 'check_interval': <shinken.property.IntegerProp object at 0x7f50e138ccd0>, 'merge_host_contacts': <shinken.property.BoolProp object at 0x7f50e1a84d90>, 'notes_url': <shinken.property.StringProp object at 0x7f50e1a84a10>, 'custom_views': <shinken.property.ListProp object at 0x7f50e1aac250>, 'check_freshness': <shinken.property.BoolProp object at 0x7f50e138cf10>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f50e138cdd0>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f50e1a84ad0>, 'host_dependency_enabled': <shinken.property.BoolProp object at 0x7f50e1a84e10>, 'checkmodulations': <shinken.property.ListProp object at 0x7f50e1aac1d0>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f50e1a84c10>, 'is_volatile': <shinken.property.BoolProp object at 0x7f50e138cbd0>, 'default_value': <shinken.property.StringProp object at 0x7f50e1aac050>, 'maintenance_period': <shinken.property.StringProp object at 0x7f50e1a84d10>, 'contacts': <shinken.property.ListProp object at 0x7f50e1a84910>, 'notification_period': <shinken.property.StringProp object at 0x7f50e1a84850>, 'trending_policies': <shinken.property.ListProp object at 0x7f50e1aac190>, 'resultmodulations': <shinken.property.ListProp object at 0x7f50e1a84c50>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f50e1a84750>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f50e1a84ed0>, 'stalking_options': <shinken.property.ListProp object at 0x7f50e1a84990>, 'macromodulations': <shinken.property.ListProp object at 0x7f50e1aac210>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f50e1584910>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f50e1a84f10>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f50e1584490>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7f50e1aac390>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f50e1a84790>, 'contact_groups': <shinken.property.ListProp object at 0x7f50e1a84950>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f50e1a84e90>, 'service_description': <shinken.property.StringProp object at 0x7f50e138cad0>, 'trigger_name': <shinken.property.StringProp object at 0x7f50e1aac110>, 'service_dependencies': <shinken.property.ListProp object at 0x7f50e1a84f90>, 'snapshot_command': <shinken.property.StringProp object at 0x7f50e1aac310>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'duplicate_foreach': <shinken.property.StringProp object at 0x7f50e1a84fd0>, 'poller_tag': <shinken.property.StringProp object at 0x7f50e1a84bd0>, 'icon_set': <shinken.property.StringProp object at 0x7f50e1a84b10>, 'business_impact': <shinken.property.IntegerProp object at 0x7f50e1aac090>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f50e138cc90>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f50e1a84f50>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f50e1a84e50>}
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]
raise_snapshot_log_entry(command)[source]
reactionner_tag
register
resultmodulations
retain_nonstatus_information
retain_status_information
retry_interval
return_code
running_properties = {'state_id_before_impact': <shinken.property.IntegerProp object at 0x7f50e1a897d0>, 'child_dependencies': <shinken.property.StringProp object at 0x7f50e1a89950>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f50e1aacfd0>, 'business_rule': <shinken.property.StringProp object at 0x7f50e1a898d0>, 'last_perf_data': <shinken.property.StringProp object at 0x7f50e1a89450>, 'acknowledgement': <shinken.property.StringProp object at 0x7f50e1aace90>, 'actions': <shinken.property.ListProp object at 0x7f50e1a895d0>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f50e1a89190>, 'flapping_changes': <shinken.property.ListProp object at 0x7f50e1aacd90>, 'last_time_critical': <shinken.property.IntegerProp object at 0x7f50e1aac910>, 's_time': <shinken.property.FloatProp object at 0x7f50e1a89110>, 'last_time_warning': <shinken.property.IntegerProp object at 0x7f50e1aac8d0>, 'checks_in_progress': <shinken.property.ListProp object at 0x7f50e1aacc50>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f50e1aacb50>, 'last_notification': <shinken.property.FloatProp object at 0x7f50e1a89150>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f50e1aacbd0>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f50e1a89210>, 'last_state': <shinken.property.StringProp object at 0x7f50e1aac6d0>, 'topology_change': <shinken.property.BoolProp object at 0x7f50e1a89a50>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f50e1a896d0>, 'impacts': <shinken.property.ListProp object at 0x7f50e1a89750>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f50e1aac7d0>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f50e1a899d0>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f50e1a89910>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f50e1aace10>, 'notifications_in_progress': <shinken.property.DictProp object at 0x7f50e1aacc90>, 'u_time': <shinken.property.FloatProp object at 0x7f50e1a890d0>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f50e1aac750>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f50e1aacf50>, 'broks': <shinken.property.ListProp object at 0x7f50e1a89610>, 'last_time_unknown': <shinken.property.IntegerProp object at 0x7f50e1aac950>, 'last_state_update': <shinken.property.FloatProp object at 0x7f50e1aacc10>, 'execution_time': <shinken.property.FloatProp object at 0x7f50e1a89090>, 'start_time': <shinken.property.IntegerProp object at 0x7f50e1a89310>, 'state_type': <shinken.property.StringProp object at 0x7f50e1aac9d0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'notified_contacts': <shinken.property.ListProp object at 0x7f50e1a89510>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f50e1aacdd0>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f50e1a89390>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f50e1a89550>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f50e1aaca10>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f50e1a89250>, 'in_checking': <shinken.property.BoolProp object at 0x7f50e1aac4d0>, 'last_state_change': <shinken.property.FloatProp object at 0x7f50e1aac790>, 'long_output': <shinken.property.StringProp object at 0x7f50e1aaca90>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f50e1aac990>, 'current_event_id': <shinken.property.IntegerProp object at 0x7f50e1aac650>, 'end_time': <shinken.property.IntegerProp object at 0x7f50e1a89350>, 'timeout': <shinken.property.IntegerProp object at 0x7f50e1a892d0>, 'output': <shinken.property.StringProp object at 0x7f50e1aaca50>, 'perf_data': <shinken.property.StringProp object at 0x7f50e1a89410>, 'state_before_impact': <shinken.property.StringProp object at 0x7f50e1a89790>, 'is_impact': <shinken.property.BoolProp object at 0x7f50e1a89690>, 'check_type': <shinken.property.IntegerProp object at 0x7f50e1aacf10>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f50e1a89590>, 'source_problems': <shinken.property.ListProp object at 0x7f50e1a89710>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f50e1aac690>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f50e1a89990>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f50e1aace50>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f50e1aacf90>, 'latency': <shinken.property.FloatProp object at 0x7f50e1aac550>, 'state_changed_since_impact': <shinken.property.BoolProp object at 0x7f50e1a89810>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f50e1a89290>, 'last_state_type': <shinken.property.StringProp object at 0x7f50e1aac710>, 'downtimes': <shinken.property.ListProp object at 0x7f50e1aacd10>, 'last_hard_state': <shinken.property.StringProp object at 0x7f50e1aac810>, 'next_chk': <shinken.property.IntegerProp object at 0x7f50e1aac490>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f50e1a89890>, 'comments': <shinken.property.ListProp object at 0x7f50e1aacd50>, 'last_check_command': <shinken.property.StringProp object at 0x7f50e1a89b10>, 'state': <shinken.property.StringProp object at 0x7f50e1aac5d0>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f50e1a89050>, 'last_chk': <shinken.property.IntegerProp object at 0x7f50e1aac450>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f50e1a891d0>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7f50e1a89ad0>, 'is_problem': <shinken.property.BoolProp object at 0x7f50e1a89650>, 'last_time_ok': <shinken.property.IntegerProp object at 0x7f50e1aac890>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>, 'return_code': <shinken.property.IntegerProp object at 0x7f50e1a893d0>, 'is_flapping': <shinken.property.BoolProp object at 0x7f50e1aacad0>, 'customs': <shinken.property.DictProp object at 0x7f50e1a894d0>, 'host': <shinken.property.StringProp object at 0x7f50e1a89490>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f50e1a89a10>, 'state_id': <shinken.property.IntegerProp object at 0x7f50e1aac610>, 'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f50e1aacb90>, 'attempt': <shinken.property.IntegerProp object at 0x7f50e1aac590>, 'act_depend_of': <shinken.property.ListProp object at 0x7f50e1aacb10>, 'triggers': <shinken.property.ListProp object at 0x7f50e1a89a90>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f50e1aaced0>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f50e1aac410>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f50e1aac510>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f50e1a89850>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f50e1aac850>}
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
snapshot_command
snapshot_criteria
snapshot_enabled
snapshot_interval
snapshot_period
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, index_items=True)[source]

Bases: shinken.objects.item.Items

add_item(item, index=True)[source]

Adds and index an item into the items container.

This implementation takes into account that a service has two naming attribute: host_name and service_description.

Parameters:
  • item – The item to add
  • index – Flag indicating if the item should be indexed
add_template(tpl)[source]

Adds and index a template into the templates container.

This implementation takes into account that a service has two naming attribute: host_name and service_description.

Parameters:tpl – The template to add
apply_dependencies()[source]
apply_implicit_inheritance(hosts)[source]
apply_inheritance(hosts)[source]
clean()[source]
create_business_rules(hosts, services)[source]
create_business_rules_dependencies()[source]
delete_services_by_id(ids)[source]
explode(hosts, hostgroups, contactgroups, servicegroups, servicedependencies, triggers)[source]

Explodes services, from host_name, hostgroup_name, and from templetes.

Parameters:
  • hosts – The hosts container
  • hostgroups – The hostgoups container
  • contactgroups – The concactgoups container
  • servicegroups – The servicegoups container
  • servicedependencies – The servicedependencies container
  • triggers – The triggers container
explode_services_duplicates(hosts, s)[source]

Explodes services holding a duplicate_foreach clause.

Parameters:
  • hosts – The hosts container
  • s – The service to explode
explode_services_from_hosts(hosts, s, hnames)[source]

Explodes a service based on a lis of hosts.

Parameters:
  • hosts – The hosts container
  • s – The base service to explode
  • hnames – The host_name list to exlode sevice on
explode_services_from_templates(hosts, t)[source]

Explodes services from templates. All hosts holding the specified templates are bound the service.

Parameters:
  • hosts – The hosts container
  • s – The service to explode
find_srv_by_name_and_hostname(host_name, sdescr)[source]
find_srvs_by_hostname(host_name)[source]
index_item(item)[source]

Indexes a template by name into the name_to_template dictionnary.

This implementation takes into account that a service has two naming attribute: host_name and service_description.

Parameters:item – The item to index
inner_class

alias of Service

is_excluded_for_host(host, service)[source]
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]
register_service_dependencies(s, servicedependencies)[source]

Registers a service dependencies.

Parameters:
  • s – The service to register
  • servicedependencies – The servicedependencies container
register_service_into_servicegroups(s, servicegroups)[source]

Registers a service into the service groups declared in its servicegroups attribute.

Parameters:
  • s – The service to register
  • servicegroups – The servicegroups container
unindex_item(item)[source]

Unindexes an item from the items container.

This implementation takes into account that a service has two naming attribute: host_name and service_description.

Parameters:
  • item – The item to unindex
  • name – The name under which the item has been indexed.

servicedependency Module

class shinken.objects.servicedependency.Servicedependencies(items, index_items=True)[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]
inner_class

alias of Servicedependency

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 0x7f50e5414350>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f50e54143d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'explode_hostgroup': <shinken.property.BoolProp object at 0x7f50e5414450>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f50e15ceed0>, 'service_description': <shinken.property.StringProp object at 0x7f50e5414310>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f50e5414090>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'dependency_period': <shinken.property.StringProp object at 0x7f50e5414410>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f50e5414390>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f50e54142d0>, 'host_name': <shinken.property.StringProp object at 0x7f50e5414290>, 'dependent_service_description': <shinken.property.StringProp object at 0x7f50e5414210>}

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 0x7f50e13f9b90>, 'contact_groups': <shinken.property.StringProp object at 0x7f50e1ab8c50>, 'escalation_period': <shinken.property.StringProp object at 0x7f50e1ab8b90>, 'service_description': <shinken.property.StringProp object at 0x7f50e1ab8a90>, 'last_notification': <shinken.property.IntegerProp object at 0x7f50e1ab8b10>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'use': <shinken.property.ListProp object at 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f50e1ab8b50>, 'contacts': <shinken.property.StringProp object at 0x7f50e1ab8c10>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f50e1ab8cd0>, 'escalation_options': <shinken.property.ListProp object at 0x7f50e1ab8bd0>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f50e1ab8a50>, 'host_name': <shinken.property.StringProp object at 0x7f50e1ab89d0>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f50e1ab8c90>, 'first_notification': <shinken.property.IntegerProp object at 0x7f50e1ab8ad0>}
class shinken.objects.serviceescalation.Serviceescalations(items, index_items=True)[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 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f50dffea390>, 'notes': <shinken.property.StringProp object at 0x7f50df8edbd0>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'icon_image': <shinken.property.StringProp object at 0x7f50df8edc10>, 'notes_url': <shinken.property.StringProp object at 0x7f50df8edb50>, 'host_name': <shinken.property.StringProp object at 0x7f50df8eda90>, 'service_description': <shinken.property.StringProp object at 0x7f50df8edb90>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
register
service_description
use
class shinken.objects.serviceextinfo.ServicesExtInfo(items, index_items=True)[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 0x7f50e13f9890>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'alias': <shinken.property.StringProp object at 0x7f50e15ced50>, 'notes': <shinken.property.StringProp object at 0x7f50e15ced90>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'unknown_members': <shinken.property.ListProp object at 0x7f50e15c4710>, 'action_url': <shinken.property.StringProp object at 0x7f50e15cee10>, 'notes_url': <shinken.property.StringProp object at 0x7f50e15cedd0>, 'members': <shinken.property.ListProp object at 0x7f50e15c4690>, 'id': <shinken.property.IntegerProp object at 0x7f50e15ceb90>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>, 'servicegroup_name': <shinken.property.StringProp object at 0x7f50e15ced10>}
class shinken.objects.servicegroup.Servicegroups(items, index_items=True)[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 0x7f50e5401590>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'register': <shinken.property.IntegerProp object at 0x7f50e54015d0>, 'is_active': <shinken.property.BoolProp object at 0x7f50e5401690>, 'dateranges': <shinken.property.ListProp object at 0x7f50e5401610>, 'alias': <shinken.property.StringProp object at 0x7f50e5401550>, 'timeperiod_name': <shinken.property.StringProp object at 0x7f50e144d690>, 'exclude': <shinken.property.ListProp object at 0x7f50e5401650>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
resolve_daterange(dateranges, entry)[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>}
class shinken.objects.timeperiod.Timeperiods(items, index_items=True)[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 0x7f50e13f9890>, 'code_src': <shinken.property.StringProp object at 0x7f50e15e54d0>, 'name': <shinken.property.StringProp object at 0x7f50e13f9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f50e13f9b90>, 'trigger_name': <shinken.property.StringProp object at 0x7f50e15e5450>, 'register': <shinken.property.BoolProp object at 0x7f50e13f9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f50e13f9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f50e13f9c50>, 'code_bin': <shinken.property.StringProp object at 0x7f50e15e5510>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f50e13f9c10>, 'tags': <shinken.property.ListProp object at 0x7f50e13f9cd0>, 'hash': <shinken.property.StringProp object at 0x7f50e13f9c90>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f50e15e5550>}
class shinken.objects.trigger.Triggers(items, index_items=True)[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'
Read the Docs v: latest
Versions
latest
documentation
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.