objects 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 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'modulation_period': <shinken.property.StringProp object at 0x7f0047c24910>, 'business_impact': <shinken.property.IntegerProp object at 0x7f0047c24890>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'business_impact_modulation_name': <shinken.property.StringProp object at 0x7f0047c24790>}
class shinken.objects.businessimpactmodulation.Businessimpactmodulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Businessimpactmodulation

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

checkmodulation Module

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

Bases: shinken.objects.item.Item

get_check_command(t_to_go)[source]
get_name()[source]
id = 1
is_correct()[source]
late_linkify_cw_by_commands(commands)[source]
macros = {}
my_type = 'checkmodulation'
properties = {'check_period': <shinken.property.StringProp object at 0x7f0047c24e90>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'check_command': <shinken.property.StringProp object at 0x7f0047c24e10>, 'checkmodulation_name': <shinken.property.StringProp object at 0x7f0047c24a90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.checkmodulation.CheckModulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of CheckModulation

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

command Module

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

Bases: shinken.objects.item.Item

command_line
command_name
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 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'command_line': <shinken.property.StringProp object at 0x7f0048506850>, 'poller_tag': <shinken.property.StringProp object at 0x7f0048506890>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f00485068d0>, 'module_type': <shinken.property.StringProp object at 0x7f0048506910>, 'timeout': <shinken.property.IntegerProp object at 0x7f0048506950>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'command_name': <shinken.property.StringProp object at 0x7f00485067d0>}
pythonize()[source]
reactionner_tag
timeout
use
class shinken.objects.command.Commands(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Command

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

Bases: object

config Module

contact Module

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

Bases: shinken.objects.item.Item

get_name()[source]
get_notification_commands(type)[source]
id = 1
is_correct()[source]
macros = {'CONTACTPAGER': 'pager', 'CONTACTGROUPNAMES': 'get_groupnames', 'CONTACTGROUPNAME': 'get_groupname', 'CONTACTNAME': 'contact_name', 'CONTACTADDRESS3': 'address3', 'CONTACTADDRESS2': 'address2', 'CONTACTADDRESS1': 'address1', 'CONTACTALIAS': 'alias', 'CONTACTADDRESS6': 'address6', 'CONTACTADDRESS5': 'address5', 'CONTACTADDRESS4': 'address4', 'CONTACTEMAIL': 'email'}
my_type = 'contact'
old_properties = {'min_criticity': 'min_business_impact'}
properties = {'address1': <shinken.property.StringProp object at 0x7f00485af950>, 'address2': <shinken.property.StringProp object at 0x7f00485af990>, 'address3': <shinken.property.StringProp object at 0x7f00485af9d0>, 'address4': <shinken.property.StringProp object at 0x7f00485afa10>, 'address5': <shinken.property.StringProp object at 0x7f00485afa50>, 'address6': <shinken.property.StringProp object at 0x7f00485afa90>, 'contactgroups': <shinken.property.StringProp object at 0x7f00485af210>, 'is_admin': <shinken.property.BoolProp object at 0x7f00485afb10>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f00485af6d0>, 'can_submit_commands': <shinken.property.BoolProp object at 0x7f00485afad0>, 'contact_name': <shinken.property.StringProp object at 0x7f00485af050>, 'password': <shinken.property.StringProp object at 0x7f00485afbd0>, 'pager': <shinken.property.StringProp object at 0x7f00485af910>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'notificationways': <shinken.property.StringProp object at 0x7f00485afb90>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'service_notification_commands': <shinken.property.StringProp object at 0x7f00485af850>, 'host_notification_period': <shinken.property.StringProp object at 0x7f00485af710>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f00485af650>, 'host_notification_commands': <shinken.property.StringProp object at 0x7f00485af810>, 'service_notification_period': <shinken.property.StringProp object at 0x7f00485af750>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f00485af890>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f00485afb50>, 'email': <shinken.property.StringProp object at 0x7f00485af8d0>, 'alias': <shinken.property.StringProp object at 0x7f00485af0d0>, 'service_notification_options': <shinken.property.StringProp object at 0x7f00485af7d0>, 'host_notification_options': <shinken.property.StringProp object at 0x7f00485af790>}
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 0x7f00487a8d10>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f00485afc10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'downtimes': <shinken.property.StringProp object at 0x7f00485afc50>}
want_host_notification(t, state, type, business_impact, cmd=None)[source]
want_service_notification(t, state, type, business_impact, cmd=None)[source]
class shinken.objects.contact.Contacts(items)[source]

Bases: shinken.objects.item.Items

explode(contactgroups, notificationways)[source]
inner_class

alias of Contact

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

contactgroup Module

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

Bases: shinken.objects.itemgroup.Itemgroup

get_contactgroup_members()[source]
get_contacts()[source]
get_contacts_by_explosion(contactgroups)[source]
get_name()[source]
id = 1
macros = {'CONTACTGROUPALIAS': 'alias', 'CONTACTGROUPMEMBERS': 'get_members'}
my_type = 'contactgroup'
properties = {'contactgroup_name': <shinken.property.StringProp object at 0x7f00487e31d0>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'alias': <shinken.property.StringProp object at 0x7f00487e3210>, 'unknown_members': <shinken.property.StringProp object at 0x7f00487cb1d0>, 'members': <shinken.property.StringProp object at 0x7f00487cb150>, 'id': <shinken.property.IntegerProp object at 0x7f00485afe90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
class shinken.objects.contactgroup.Contactgroups(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

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

alias of Contactgroup

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

discoveryrule Module

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

Bases: shinken.objects.matchingitem.MatchingItem

get_name()[source]
id = 1
macros = {}
my_type = 'discoveryrule'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'creation_type': <shinken.property.StringProp object at 0x7f00487bdc90>, 'discoveryrule_name': <shinken.property.StringProp object at 0x7f00487bdb90>, 'discoveryrule_order': <shinken.property.IntegerProp object at 0x7f00487bdcd0>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487bdd10>}
class shinken.objects.discoveryrule.Discoveryrules(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Discoveryrule

name_property = 'discoveryrule_name'

discoveryrun Module

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

Bases: shinken.objects.matchingitem.MatchingItem

check_finished()[source]
get_name()[source]
get_output()[source]
id = 1
is_finished()[source]
is_first_level()[source]
launch(ctx=[], timeout=300)[source]
my_type = 'discoveryrun'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'discoveryrun_command': <shinken.property.StringProp object at 0x7f00487bdfd0>, 'discoveryrun_name': <shinken.property.StringProp object at 0x7f00487bddd0>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'current_launch': <shinken.property.StringProp object at 0x7f00487ce050>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.discoveryrun.Discoveryruns(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Discoveryrun

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

escalation Module

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

Bases: shinken.objects.item.Item

get_name()[source]
get_next_notif_time(t_wished, status, creation_time, interval)[source]
id = 1
is_correct()[source]
is_eligible(t, status, notif_number, in_notif_time, interval)[source]
my_type = 'escalation'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f0048515210>, 'contacts': <shinken.property.StringProp object at 0x7f00485152d0>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f00485151d0>, 'escalation_options': <shinken.property.ListProp object at 0x7f0048515290>, 'contact_groups': <shinken.property.StringProp object at 0x7f0048515310>, 'escalation_name': <shinken.property.StringProp object at 0x7f0048506e10>, 'escalation_period': <shinken.property.StringProp object at 0x7f0048515250>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f0048515190>, 'first_notification': <shinken.property.IntegerProp object at 0x7f0048506ed0>, 'last_notification': <shinken.property.IntegerProp object at 0x7f0048506f10>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'time_based': <shinken.property.BoolProp object at 0x7f0048515350>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.escalation.Escalations(items)[source]

Bases: shinken.objects.item.Items

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

alias of Escalation

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

host Module

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

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

Bases: shinken.objects.schedulingitem.SchedulingItem

acknowledgement
acknowledgement_type
act_depend_of
act_depend_of_me
action_url
actions
active_checks_enabled
add_business_rule_act_dependency(h, status, timeperiod, inherits_parent)[source]
add_host_act_dependency(h, status, timeperiod, inherits_parent)[source]
add_host_chk_dependency(h, status, timeperiod, inherits_parent)[source]
address
alias
attempt
broks
business_impact
business_impact_modulations
business_rule
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
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_host_tags()[source]
get_hostgroups()[source]
get_name()[source]
get_obsessive_compulsive_processor_command()[source]
get_realm()[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_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]
last_chk
last_event_id
last_hard_state
last_hard_state_change
last_hard_state_id
last_notification
last_perf_data
last_problem_id
last_state
last_state_change
last_state_id
last_state_type
last_state_update
last_time_down
last_time_non_ok_or_up()[source]
last_time_unreachable
last_time_up
latency
long_output
low_flap_threshold
macromodulations
macros = {'HOSTPERFDATA': 'perf_data', 'HOSTGROUPNAMES': 'get_groupnames', 'HOSTCHECKCOMMAND': 'get_check_command', 'LASTHOSTSTATECHANGE': 'last_state_change', 'HOSTSTATE': 'state', 'TOTALHOSTSERVICES': 'get_total_services', 'HOSTNOTESURL': 'notes_url', 'HOSTREALM': 'get_realm', 'HOSTADDRESS30': 'address30', 'HOSTADDRESS31': 'address31', 'HOSTEVENTID': 'current_event_id', 'LASTHOSTCHECK': 'last_chk', 'HOSTPERCENTCHANGE': 'percent_state_change', 'HOSTLATENCY': 'latency', 'HOSTADDRESS6': 'address6', 'HOSTADDRESS7': 'address7', 'HOSTADDRESS4': 'address4', 'HOSTADDRESS5': 'address5', 'HOSTADDRESS2': 'address2', 'HOSTADDRESS3': 'address3', 'HOSTADDRESS0': 'address0', 'HOSTADDRESS1': 'address1', 'HOSTADDRESS17': 'address17', 'HOSTACKAUTHOR': 'get_ack_author_name', 'HOSTADDRESS8': 'address8', 'HOSTADDRESS9': 'address9', 'HOSTSTATEID': 'state_id', 'HOSTDURATION': 'get_duration', 'HOSTNAME': 'host_name', 'TOTALHOSTSERVICESUNKNOWN': 'get_total_services_unknown', 'HOSTNOTES': 'notes', 'HOSTACTIONURL': 'action_url', 'HOSTDURATIONSEC': 'get_duration_sec', 'MAXHOSTATTEMPTS': 'max_check_attempts', 'HOSTEXECUTIONTIME': 'execution_time', 'HOSTACKAUTHORALIAS': 'get_ack_author_name', 'TOTALHOSTSERVICESWARNING': 'get_total_services_warning', 'LASTHOSTEVENTID': 'last_event_id', 'HOSTADDRESS28': 'address28', 'HOSTPROBLEMID': 'current_problem_id', 'HOSTADDRESS18': 'address18', 'HOSTADDRESS19': 'address19', 'HOSTACKCOMMENT': 'get_ack_comment', 'HOSTADDRESS15': 'address15', 'HOSTADDRESS14': 'address14', 'LONGHOSTOUTPUT': 'long_output', 'HOSTADDRESS16': 'address16', 'HOSTOUTPUT': 'output', 'HOSTADDRESS10': 'address10', 'HOSTADDRESS11': 'address11', 'HOSTATTEMPT': 'attempt', 'HOSTADDRESS13': 'address13', 'LASTHOSTDOWN': 'last_time_down', 'HOSTALIAS': 'alias', 'TOTALHOSTSERVICESCRITICAL': 'get_total_services_critical', 'HOSTSTATETYPE': 'state_type', 'HOSTBUSINESSIMPACT': 'business_impact', 'HOSTACKAUTHORNAME': 'get_ack_author_name', 'LASTHOSTSTATEID': 'last_state_id', 'HOSTADDRESS12': 'address12', 'LASTHOSTUP': 'last_time_up', 'HOSTDOWNTIME': 'get_downtime', 'HOSTADDRESS22': 'address22', 'TOTALHOSTSERVICESOK': 'get_total_services_ok', 'HOSTDISPLAYNAME': 'display_name', 'LASTHOSTPERFDATA': 'last_perf_data', 'HOSTADDRESS25': 'address25', 'HOSTADDRESS24': 'address24', 'HOSTADDRESS27': 'address27', 'HOSTADDRESS26': 'address26', 'HOSTADDRESS21': 'address21', 'HOSTADDRESS20': 'address20', 'HOSTADDRESS23': 'address23', 'LASTHOSTUNREACHABLE': 'last_time_unreachable', 'HOSTADDRESS29': 'address29', 'LASTHOSTPROBLEMID': 'last_problem_id', 'LASTHOSTSTATE': 'last_state', 'HOSTADDRESS': 'address', 'HOSTGROUPNAME': 'get_groupname'}
maintenance_period
manage_stalking(c)[source]
max_check_attempts
modified_attributes
my_own_business_impact
my_type = 'host'
name
next_chk
notes
notes_url
notification_interval
notification_is_blocked_by_contact(n, contact)[source]
notification_is_blocked_by_item(type, t_wished=None)[source]
notification_options
notification_period
notifications_enabled
notifications_in_progress
notified_contacts
obsess_over_host
ok_up = 'UP'
old_properties = {'normal_check_interval': 'check_interval', 'hostgroup': 'hostgroups', 'criticity': 'business_impact', 'retry_check_interval': 'retry_interval'}
output
pack_id
parent_dependencies
parents
passive_checks_enabled
pending_flex_downtime
percent_state_change
perf_data
poller_tag
problem_has_been_acknowledged
process_perf_data
properties = {'statusmap_image': <shinken.property.StringProp object at 0x7f0048532810>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f0048532750>, 'business_impact_modulations': <shinken.property.StringProp object at 0x7f0048532a10>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f0048556110>, 'hostgroups': <shinken.property.StringProp object at 0x7f0048515c90>, 'checkmodulations': <shinken.property.ListProp object at 0x7f0048532c10>, 'action_url': <shinken.property.StringProp object at 0x7f00485326d0>, 'notes_url': <shinken.property.StringProp object at 0x7f0048532690>, 'escalations': <shinken.property.StringProp object at 0x7f0048532a50>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f0048556050>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f0048556150>, '2d_coords': <shinken.property.StringProp object at 0x7f0048532850>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f0048515e10>, 'check_period': <shinken.property.StringProp object at 0x7f0048515e90>, 'maintenance_period': <shinken.property.StringProp object at 0x7f0048532a90>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'display_name': <shinken.property.StringProp object at 0x7f0048515bd0>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f0048556350>, 'contacts': <shinken.property.StringProp object at 0x7f0048556290>, 'notification_period': <shinken.property.StringProp object at 0x7f00485563d0>, 'trending_policies': <shinken.property.ListProp object at 0x7f0048532bd0>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f00485328d0>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f0048515dd0>, 'resultmodulations': <shinken.property.StringProp object at 0x7f00485329d0>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f0048556190>, 'icon_image': <shinken.property.StringProp object at 0x7f0048532710>, 'stalking_options': <shinken.property.ListProp object at 0x7f0048532610>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f0048515fd0>, 'trigger': <shinken.property.StringProp object at 0x7f0048532b50>, 'parents': <shinken.property.ListProp object at 0x7f0048515c50>, 'host_name': <shinken.property.StringProp object at 0x7f0048515b10>, 'initial_state': <shinken.property.CharProp object at 0x7f0048515d10>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f0048556390>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f00485560d0>, 'notification_options': <shinken.property.ListProp object at 0x7f0048556410>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f0048515e50>, 'icon_set': <shinken.property.StringProp object at 0x7f0048532790>, 'macromodulations': <shinken.property.ListProp object at 0x7f0048532c50>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f0048556210>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f0048556450>, 'event_handler': <shinken.property.StringProp object at 0x7f0048515f90>, 'contact_groups': <shinken.property.StringProp object at 0x7f0048556310>, 'obsess_over_host': <shinken.property.BoolProp object at 0x7f0048515ed0>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f0048515f50>, 'alias': <shinken.property.StringProp object at 0x7f0048515b90>, 'address': <shinken.property.StringProp object at 0x7f0048515c10>, 'realm': <shinken.property.StringProp object at 0x7f0048532910>, 'trigger_name': <shinken.property.ListProp object at 0x7f0048532b90>, 'vrml_image': <shinken.property.StringProp object at 0x7f00485327d0>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, '3d_coords': <shinken.property.StringProp object at 0x7f0048532890>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f0048532ad0>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'notes': <shinken.property.StringProp object at 0x7f0048532650>, 'check_command': <shinken.property.StringProp object at 0x7f0048515cd0>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f0048532990>, 'poller_tag': <shinken.property.StringProp object at 0x7f0048532950>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f0048556090>, 'check_interval': <shinken.property.IntegerProp object at 0x7f0048515d90>, 'business_impact': <shinken.property.IntegerProp object at 0x7f0048532b10>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f0048515d50>, 'custom_views': <shinken.property.ListProp object at 0x7f0048532c90>, 'check_freshness': <shinken.property.BoolProp object at 0x7f0048515f10>}
raise_alert_log_entry()[source]
raise_cancel_downtime_log_entry()[source]
raise_enter_downtime_log_entry()[source]
raise_event_handler_log_entry(command)[source]
raise_exit_downtime_log_entry()[source]
raise_flapping_start_log_entry(change_ratio, threshold)[source]
raise_flapping_stop_log_entry(change_ratio, threshold)[source]
raise_freshness_log_entry(t_stale_by, t_threshold)[source]
raise_initial_state()[source]
raise_no_next_check_log_entry()[source]
raise_notification_log_entry(n)[source]
reactionner_tag
realm
register_child(child)[source]
resultmodulations
retain_nonstatus_information
retain_status_information
retry_interval
return_code
running_properties = {'state_id_before_impact': <shinken.property.StringProp object at 0x7f0048f69610>, 'child_dependencies': <shinken.property.StringProp object at 0x7f0048f69f10>, 'last_time_unreachable': <shinken.property.IntegerProp object at 0x7f00487b6250>, 'childs': <shinken.property.StringProp object at 0x7f0048f691d0>, 'business_rule': <shinken.property.StringProp object at 0x7f00485c4b90>, 'last_perf_data': <shinken.property.StringProp object at 0x7f0048ceecd0>, 'acknowledgement': <shinken.property.StringProp object at 0x7f00487b6710>, 'actions': <shinken.property.StringProp object at 0x7f0048cee3d0>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f00487b6950>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f00487b6850>, 'checks_in_progress': <shinken.property.StringProp object at 0x7f00487b6550>, 'chk_depend_of': <shinken.property.StringProp object at 0x7f00487b6410>, 'last_notification': <shinken.property.FloatProp object at 0x7f00487b6910>, 'chk_depend_of_me': <shinken.property.StringProp object at 0x7f00487b6490>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f00487b69d0>, 'last_state': <shinken.property.StringProp object at 0x7f0048532fd0>, 'topology_change': <shinken.property.BoolProp object at 0x7f0048f78450>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f0048f69e10>, 'impacts': <shinken.property.StringProp object at 0x7f0048f69390>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f00487b6110>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f004893b250>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f0048f69d50>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f00487b6690>, 'notifications_in_progress': <shinken.property.StringProp object at 0x7f00487b6590>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f00487b6050>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f00487b67d0>, 'broks': <shinken.property.StringProp object at 0x7f0048f69210>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f00487b6a50>, 'last_state_update': <shinken.property.StringProp object at 0x7f00487b64d0>, 'execution_time': <shinken.property.FloatProp object at 0x7f00487b68d0>, 'start_time': <shinken.property.IntegerProp object at 0x7f0048f70190>, 'flapping_changes': <shinken.property.StringProp object at 0x7f00487b6650>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'notified_contacts': <shinken.property.StringProp object at 0x7f0048cee7d0>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f00487b6390>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f0048f700d0>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f0048cee790>, 'act_depend_of_me': <shinken.property.StringProp object at 0x7f00487b6450>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f0048532f10>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f00487b6a10>, 'in_checking': <shinken.property.BoolProp object at 0x7f0048532d90>, 'last_state_change': <shinken.property.FloatProp object at 0x7f00487b60d0>, 'long_output': <shinken.property.StringProp object at 0x7f00487b6310>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f00487b6290>, 'end_time': <shinken.property.IntegerProp object at 0x7f0048f70110>, 'timeout': <shinken.property.IntegerProp object at 0x7f00487b6a90>, 'output': <shinken.property.StringProp object at 0x7f00487b62d0>, 'perf_data': <shinken.property.StringProp object at 0x7f0048c116d0>, 'state_before_impact': <shinken.property.StringProp object at 0x7f0048f69290>, 'is_impact': <shinken.property.StringProp object at 0x7f0048f69e90>, 'check_type': <shinken.property.IntegerProp object at 0x7f00487b6790>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f0048cee110>, 'source_problems': <shinken.property.StringProp object at 0x7f0048f694d0>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f0048532f90>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f00485c4ad0>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f00487b66d0>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f00487b6810>, 'latency': <shinken.property.FloatProp object at 0x7f0048532dd0>, 'state_changed_since_impact': <shinken.property.StringProp object at 0x7f0048f69190>, 'current_event_id': <shinken.property.StringProp object at 0x7f0048532f50>, 'last_state_type': <shinken.property.StringProp object at 0x7f00487b6090>, 'downtimes': <shinken.property.StringProp object at 0x7f00487b65d0>, 'last_time_up': <shinken.property.IntegerProp object at 0x7f00487b61d0>, 'last_hard_state': <shinken.property.StringProp object at 0x7f00487b6150>, 'next_chk': <shinken.property.IntegerProp object at 0x7f0048532d50>, 'comments': <shinken.property.StringProp object at 0x7f00487b6610>, 'state': <shinken.property.StringProp object at 0x7f0048532e50>, 'last_chk': <shinken.property.IntegerProp object at 0x7f0048532d10>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f00487b6990>, 'is_problem': <shinken.property.StringProp object at 0x7f0048f69e50>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>, 'pack_id': <shinken.property.IntegerProp object at 0x7f0048f78050>, 'return_code': <shinken.property.IntegerProp object at 0x7f0048f70090>, 'is_flapping': <shinken.property.BoolProp object at 0x7f00487b6350>, 'customs': <shinken.property.StringProp object at 0x7f0048cee890>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f004893b110>, 'got_default_realm': <shinken.property.BoolProp object at 0x7f0048cee810>, 'state_id': <shinken.property.IntegerProp object at 0x7f0048532e90>, 'services': <shinken.property.StringProp object at 0x7f00487b6510>, 'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'state_type': <shinken.property.StringProp object at 0x7f0048532ed0>, 'attempt': <shinken.property.IntegerProp object at 0x7f0048532e10>, 'act_depend_of': <shinken.property.StringProp object at 0x7f00487b63d0>, 'triggers': <shinken.property.StringProp object at 0x7f0048f78390>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f00487b6750>, 'last_time_down': <shinken.property.IntegerProp object at 0x7f00487b6210>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f0048532cd0>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f00487b6890>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f0048f69690>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f00487b6190>}
scheduled_downtime_depth
services
set_impact_state()[source]
set_state_from_exit_status(status)[source]
set_unreachable()[source]
should_be_scheduled
source_problems
stalking_options
start_time
state
state_before_hard_unknown_reach_phase
state_before_impact
state_changed_since_impact
state_id
state_id_before_impact
state_type
state_type_id
statusmap_image
tags
time_to_orphanage
timeout
topology_change
trending_policies
trigger
trigger_name
triggers
unset_impact_state()[source]
use
vrml_image
was_in_hard_unknown_reach_phase
class shinken.objects.host.Hosts(items)[source]

Bases: shinken.objects.item.Items

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

alias of Host

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

hostdependency Module

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

Bases: shinken.objects.item.Items

apply_inheritance()[source]
delete_hostsdep_by_id(ids)[source]
explode(hostgroups)[source]
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 0x7f00487bd510>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f00487bd590>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'dependency_period': <shinken.property.StringProp object at 0x7f00487bd5d0>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f00487bd550>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f00487bd4d0>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f00487bd310>, 'host_name': <shinken.property.StringProp object at 0x7f00487bd490>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f00487bd410>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}

hostescalation Module

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

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'hostescalation'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'first_notification': <shinken.property.IntegerProp object at 0x7f00485157d0>, 'contacts': <shinken.property.StringProp object at 0x7f0048515910>, 'escalation_options': <shinken.property.ListProp object at 0x7f00485158d0>, 'contact_groups': <shinken.property.StringProp object at 0x7f0048515950>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f0048515850>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f0048515790>, 'escalation_period': <shinken.property.StringProp object at 0x7f0048515890>, 'host_name': <shinken.property.StringProp object at 0x7f0048515710>, 'last_notification': <shinken.property.IntegerProp object at 0x7f0048515810>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
class shinken.objects.hostescalation.Hostescalations(items)[source]

Bases: shinken.objects.item.Items

explode(escalations)[source]
inner_class

alias of Hostescalation

name_property = ''

hostextinfo Module

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

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

Bases: shinken.objects.item.Item

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 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f0047f2f8d0>, 'notes': <shinken.property.StringProp object at 0x7f0047f2f810>, 'vrml_image': <shinken.property.StringProp object at 0x7f0047f2f910>, '3d_coords': <shinken.property.StringProp object at 0x7f0047f2f9d0>, 'notes_url': <shinken.property.StringProp object at 0x7f0047f2f850>, 'host_name': <shinken.property.ListProp object at 0x7f0047f2f790>, 'icon_image': <shinken.property.StringProp object at 0x7f0047f2f890>, '2d_coords': <shinken.property.StringProp object at 0x7f0047f2f990>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'statusmap_image': <shinken.property.StringProp object at 0x7f0047f2f950>}
statusmap_image
use
vrml_image
class shinken.objects.hostextinfo.HostsExtInfo(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of HostExtInfo

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

hostgroup Module

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

Bases: shinken.objects.itemgroup.Itemgroup

get_hostgroup_members()[source]
get_hosts()[source]
get_hosts_by_explosion(hostgroups)[source]
get_name()[source]
id = 1
macros = {'HOSTGROUPMEMBERS': 'members', 'HOSTGROUPNOTES': 'notes', 'HOSTGROUPACTIONURL': 'action_url', 'HOSTGROUPALIAS': 'alias', 'HOSTGROUPNOTESURL': 'notes_url'}
my_type = 'hostgroup'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f00487cb290>, 'realm': <shinken.property.StringProp object at 0x7f00487cb3d0>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'alias': <shinken.property.StringProp object at 0x7f00487cb2d0>, 'notes': <shinken.property.StringProp object at 0x7f00487cb310>, 'unknown_members': <shinken.property.StringProp object at 0x7f00487cb1d0>, 'action_url': <shinken.property.StringProp object at 0x7f00487cb390>, 'notes_url': <shinken.property.StringProp object at 0x7f00487cb350>, 'members': <shinken.property.StringProp object at 0x7f00487cb150>, 'id': <shinken.property.StringProp object at 0x7f00487cb250>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
class shinken.objects.hostgroup.Hostgroups(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

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

alias of Hostgroup

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

item Module

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

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

Bases: object

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

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

compute_hash()[source]
copy()[source]

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

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

Fill missing properties if they are missing

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

Return if the elements is a template

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

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

macros = {}
old_properties_names_to_new()[source]
prepare_for_conf_sending()[source]
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
pythonize()[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
unacknowledge_problem()[source]
unacknowledge_problem_if_not_sticky()[source]
class shinken.objects.item.Items(items)[source]

Bases: object

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

Request to remove the unnecessary attributes/others from our items

compute_hash()[source]
create_reversed_list()[source]
create_tpl_list()[source]
evaluate_hostgroup_expression(expr, hosts, hostgroups, look_in='hostgroups')[source]
explode_contact_groups_into_contacts(contactgroups)[source]
explode_host_groups_into_hosts(hosts, hostgroups)[source]
explode_trigger_string_into_triggers(triggers)[source]
fill_default()[source]
find_by_name(name)[source]
find_id_by_name(name)[source]
find_tpl_by_name(name)[source]
is_correct()[source]
linkify_command_list_with_commands(commands, prop)[source]
linkify_one_command_with_commands(commands, prop)[source]
linkify_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]
old_properties_names_to_new()[source]
prepare_for_sending()[source]
pythonize()[source]
remove_templates()[source]

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

remove_twins()[source]

itemgroup Module

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

Bases: shinken.objects.item.Item

add_string_member(member)[source]
copy_shell()[source]
fill_default()[source]
get_initial_status_brok()[source]
has(prop)[source]
id = 0
is_correct()[source]
properties = {'members': <shinken.property.StringProp object at 0x7f00487cb150>, 'unknown_members': <shinken.property.StringProp object at 0x7f00487cb1d0>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
pythonize()[source]
replace_members(members)[source]
class shinken.objects.itemgroup.Itemgroups(items)[source]

Bases: shinken.objects.item.Items

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

macromodulation Module

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

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
is_active()[source]
is_correct()[source]
macros = {}
my_type = 'macromodulation'
properties = {'macromodulation_name': <shinken.property.StringProp object at 0x7f0047c26050>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'modulation_period': <shinken.property.StringProp object at 0x7f0047c26490>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.macromodulation.MacroModulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of MacroModulation

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

matchingitem Module

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

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

Bases: shinken.objects.item.Item

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

module Module

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

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
macros = {}
my_type = 'module'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'module_type': <shinken.property.StringProp object at 0x7f00487bd990>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'module_name': <shinken.property.StringProp object at 0x7f00487bd910>, 'modules': <shinken.property.ListProp object at 0x7f00487bd9d0>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
class shinken.objects.module.Modules(items)[source]

Bases: shinken.objects.item.Items

explode()[source]
inner_class

alias of Module

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

notificationway Module

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

Bases: shinken.objects.item.Item

get_name()[source]
get_notification_commands(type)[source]
id = 1
is_correct()[source]
late_linkify_nw_by_commands(commands)[source]
macros = {}
my_type = 'notificationway'
old_properties = {'min_criticity': 'min_business_impact'}
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'notificationway_name': <shinken.property.StringProp object at 0x7f00487e33d0>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f00487e3450>, 'service_notification_options': <shinken.property.ListProp object at 0x7f00487e35d0>, 'host_notification_commands': <shinken.property.StringProp object at 0x7f00487e3610>, 'service_notification_period': <shinken.property.StringProp object at 0x7f00487e3550>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f00487e3690>, 'host_notification_options': <shinken.property.ListProp object at 0x7f00487e3590>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f00487e3490>, 'host_notification_period': <shinken.property.StringProp object at 0x7f00487e34d0>, 'service_notification_commands': <shinken.property.StringProp object at 0x7f00487e3650>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
want_host_notification(t, state, type, business_impact, cmd=None)[source]
want_service_notification(t, state, type, business_impact, cmd=None)[source]
class shinken.objects.notificationway.NotificationWays(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of NotificationWay

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

pack Module

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

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'pack'
properties = {'pack_name': <shinken.property.StringProp object at 0x7f0047f2fed0>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'macros': <shinken.property.StringProp object at 0x7f0047f2ff10>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.pack.Packs(items)[source]

Bases: shinken.objects.item.Items

create_pack(buf, name)[source]
inner_class

alias of Pack

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

realm Module

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

Bases: shinken.objects.itemgroup.Itemgroup

add_string_member(member)[source]
count_brokers()[source]
count_pollers()[source]
count_reactionners()[source]
count_receivers()[source]
fill_potential_brokers()[source]
fill_potential_pollers()[source]
fill_potential_reactionners()[source]
fill_potential_receivers()[source]
get_all_subs_pollers()[source]
get_all_subs_reactionners()[source]
get_name()[source]
get_nb_of_must_have_satellites(type)[source]
get_potential_satellites_by_type(type)[source]
get_realm_members()[source]
get_realms()[source]
get_realms_by_explosion(realms)[source]
get_satellties_by_type(type)[source]
id = 1
macros = {'REALMNAME': 'realm_name', 'REALMMEMBERS': 'members'}
my_type = 'realm'
prepare_for_satellites_conf()[source]
properties = {'higher_realms': <shinken.property.StringProp object at 0x7f00487cbcd0>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'realm_members': <shinken.property.StringProp object at 0x7f00487cbc90>, 'realm_name': <shinken.property.StringProp object at 0x7f00487cbc50>, 'unknown_members': <shinken.property.StringProp object at 0x7f00487cb1d0>, 'default': <shinken.property.BoolProp object at 0x7f00487cbd10>, 'broker_complete_links': <shinken.property.BoolProp object at 0x7f00487cbd50>, 'members': <shinken.property.StringProp object at 0x7f00487cb150>, 'id': <shinken.property.IntegerProp object at 0x7f00487cbbd0>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
pythonize()[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'serialized_confs': <shinken.property.StringProp object at 0x7f00487cbd90>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.realm.Realms(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

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

alias of Realm

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

resultmodulation Module

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

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
module_return(return_code)[source]
my_type = 'resultmodulation'
properties = {'exit_code_modulation': <shinken.property.StringProp object at 0x7f0048506bd0>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'resultmodulation_name': <shinken.property.StringProp object at 0x7f00485069d0>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'modulation_period': <shinken.property.StringProp object at 0x7f0048506c10>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'exit_codes_match': <shinken.property.ListProp object at 0x7f0048506ad0>}
pythonize()[source]
class shinken.objects.resultmodulation.Resultmodulations(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of Resultmodulation

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

schedulingitem Module

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

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

Bases: shinken.objects.item.Item

add_attempt()[source]
add_flapping_change(b)[source]
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)[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_escalable_contacts(n)[source]
get_event_handlers(externalcmd=False)[source]
get_next_notification_time(n)[source]
get_perfdata_command()[source]
get_time_to_orphanage()[source]
is_escalable(n)[source]
is_max_attempts()[source]
is_no_action_dependent()[source]
is_no_check_dependent()[source]
launch_check(t, ref_check=None, force=False)[source]
manage_internal_check(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
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
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]
got_business_rule
has_been_checked
hash
high_flap_threshold
host
host_name
hostgroup_name
icon_image
icon_image_alt
icon_set
id = 1
impacts
imported_from
in_checking
in_hard_unknown_reach_phase
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
last_chk
last_event_id
last_hard_state
last_hard_state_change
last_hard_state_id
last_notification
last_perf_data
last_problem_id
last_state
last_state_change
last_state_id
last_state_type
last_state_update
last_time_critical
last_time_non_ok_or_up()[source]
last_time_ok
last_time_unknown
last_time_warning
latency
long_output
low_flap_threshold
macromodulations
macros = {'LASTSERVICESTATEID': 'last_state_id', 'SERVICEDURATION': 'get_duration', 'SERVICEGROUPNAME': 'get_groupname', 'SERVICEPROBLEMID': 'current_problem_id', 'SERVICEACKCOMMENT': 'get_ack_comment', 'LASTSERVICEPROBLEMID': 'last_problem_id', 'SERVICEACKAUTHORNAME': 'get_ack_author_name', 'LASTSERVICESTATECHANGE': 'last_state_change', 'LASTSERVICESTATE': 'last_state', 'LASTSERVICEOK': 'last_time_ok', 'SERVICEACTIONURL': 'action_url', 'LONGSERVICEOUTPUT': 'long_output', 'SERVICEEVENTID': 'current_event_id', 'LASTSERVICEEVENTID': 'last_event_id', 'LASTSERVICECRITICAL': 'last_time_critical', 'SERVICEOUTPUT': 'output', 'SERVICEDURATIONSEC': 'get_duration_sec', 'SERVICEPERCENTCHANGE': 'percent_state_change', 'SERVICEDOWNTIME': 'get_downtime', 'SERVICEACKAUTHORALIAS': 'get_ack_author_name', 'MAXSERVICEATTEMPTS': 'max_check_attempts', 'SERVICEDESC': 'service_description', 'LASTSERVICECHECK': 'last_chk', 'SERVICEPERFDATA': 'perf_data', 'SERVICESTATETYPE': 'state_type', 'LASTSERVICEWARNING': 'last_time_warning', 'SERVICENOTES': 'notes', 'SERVICEDISPLAYNAME': 'display_name', 'SERVICELATENCY': 'latency', 'SERVICEACKAUTHOR': 'get_ack_author_name', 'SERVICEATTEMPT': 'attempt', 'SERVICESTATE': 'state', 'LASTSERVICEUNKNOWN': 'last_time_unknown', 'SERVICEGROUPNAMES': 'get_groupnames', 'SERVICEISVOLATILE': 'is_volatile', 'SERVICECHECKCOMMAND': 'get_check_command', 'SERVICEBUSINESSIMPACT': 'business_impact', 'SERVICENOTESURL': 'notes_url', 'SERVICEEXECUTIONTIME': 'execution_time', 'LASTSERVICEPERFDATA': 'last_perf_data', 'SERVICESTATEID': 'state_id'}
maintenance_period
manage_stalking(c)[source]
max_check_attempts
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
properties = {'active_checks_enabled': <shinken.property.BoolProp object at 0x7f004857ef90>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f00484fca50>, 'business_impact_modulations': <shinken.property.StringProp object at 0x7f00484fcc10>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f00484fc650>, 'duplicate_foreach': <shinken.property.StringProp object at 0x7f00484fcd50>, 'obsess_over_service': <shinken.property.BoolProp object at 0x7f004851f090>, 'action_url': <shinken.property.StringProp object at 0x7f00484fc9d0>, 'notes_url': <shinken.property.StringProp object at 0x7f00484fc990>, 'escalations': <shinken.property.StringProp object at 0x7f00484fcc50>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f00484fc590>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f00484fc690>, 'check_period': <shinken.property.StringProp object at 0x7f004851f050>, 'maintenance_period': <shinken.property.StringProp object at 0x7f00484fcc90>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'poller_tag': <shinken.property.StringProp object at 0x7f00484fcb50>, 'display_name': <shinken.property.StringProp object at 0x7f004857ecd0>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f00484fc750>, 'parallelize_check': <shinken.property.BoolProp object at 0x7f00484fcb10>, 'notification_period': <shinken.property.StringProp object at 0x7f00484fc7d0>, 'trending_policies': <shinken.property.ListProp object at 0x7f00484fce90>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f00484fcad0>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f004857ef50>, 'resultmodulations': <shinken.property.StringProp object at 0x7f00484fcbd0>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f00484fc6d0>, 'icon_image': <shinken.property.StringProp object at 0x7f00484fca10>, 'stalking_options': <shinken.property.ListProp object at 0x7f00484fc910>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f004851f890>, 'trigger': <shinken.property.StringProp object at 0x7f00484fce10>, 'host_name': <shinken.property.StringProp object at 0x7f004857eb90>, 'initial_state': <shinken.property.CharProp object at 0x7f004857edd0>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f00484fc790>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f00484fc610>, 'notification_options': <shinken.property.ListProp object at 0x7f00484fc810>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f004857efd0>, 'default_value': <shinken.property.StringProp object at 0x7f00484fcd90>, 'icon_set': <shinken.property.StringProp object at 0x7f00484fca90>, 'macromodulations': <shinken.property.ListProp object at 0x7f00484fcf10>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f00484fc710>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f00484fc850>, 'event_handler': <shinken.property.StringProp object at 0x7f004851f550>, 'aggregation': <shinken.property.StringProp object at 0x7f00484fcf90>, 'contact_groups': <shinken.property.StringProp object at 0x7f00484fc8d0>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f004851f410>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f00484fcb90>, 'service_description': <shinken.property.StringProp object at 0x7f004857ec50>, 'trigger_name': <shinken.property.ListProp object at 0x7f00484fce50>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'service_dependencies': <shinken.property.ListProp object at 0x7f00484fcd10>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f00484fccd0>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'notes': <shinken.property.StringProp object at 0x7f00484fc950>, 'check_command': <shinken.property.StringProp object at 0x7f004857ed90>, 'checkmodulations': <shinken.property.ListProp object at 0x7f00484fced0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f004857ec10>, 'servicegroups': <shinken.property.StringProp object at 0x7f004857ed10>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f00484fc5d0>, 'check_interval': <shinken.property.IntegerProp object at 0x7f004857eed0>, 'contacts': <shinken.property.StringProp object at 0x7f00484fc890>, 'business_impact': <shinken.property.IntegerProp object at 0x7f00484fcdd0>, 'is_volatile': <shinken.property.BoolProp object at 0x7f004857ed50>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f004857ee50>, 'custom_views': <shinken.property.ListProp object at 0x7f00484fcf50>, 'check_freshness': <shinken.property.BoolProp object at 0x7f004851f190>}
raise_alert_log_entry()[source]
raise_cancel_downtime_log_entry()[source]
raise_enter_downtime_log_entry()[source]
raise_event_handler_log_entry(command)[source]
raise_exit_downtime_log_entry()[source]
raise_flapping_start_log_entry(change_ratio, threshold)[source]
raise_flapping_stop_log_entry(change_ratio, threshold)[source]
raise_freshness_log_entry(t_stale_by, t_threshold)[source]
raise_initial_state()[source]
raise_no_next_check_log_entry()[source]
raise_notification_log_entry(n)[source]
reactionner_tag
resultmodulations
retain_nonstatus_information
retain_status_information
retry_interval
return_code
running_properties = {'state_id_before_impact': <shinken.property.IntegerProp object at 0x7f00485062d0>, 'child_dependencies': <shinken.property.StringProp object at 0x7f0048506410>, 'flapping_changes': <shinken.property.ListProp object at 0x7f0048519910>, 'business_rule': <shinken.property.StringProp object at 0x7f0048506390>, 'last_perf_data': <shinken.property.StringProp object at 0x7f0048519f10>, 'actions': <shinken.property.ListProp object at 0x7f00485060d0>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f0048519c50>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f0048519b50>, 'last_time_critical': <shinken.property.IntegerProp object at 0x7f00485194d0>, 'last_time_warning': <shinken.property.IntegerProp object at 0x7f0048519490>, 'checks_in_progress': <shinken.property.ListProp object at 0x7f0048519810>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f0048519710>, 'last_notification': <shinken.property.FloatProp object at 0x7f0048519c10>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f0048519790>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f0048519cd0>, 'last_state': <shinken.property.StringProp object at 0x7f0048519290>, 'topology_change': <shinken.property.BoolProp object at 0x7f0048506510>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f00485061d0>, 'impacts': <shinken.property.ListProp object at 0x7f0048506250>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f0048519390>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f0048506490>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f00485063d0>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f0048519990>, 'notifications_in_progress': <shinken.property.ListProp object at 0x7f0048519850>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f0048519310>, 'triggers': <shinken.property.StringProp object at 0x7f0048506550>, 'broks': <shinken.property.ListProp object at 0x7f0048506110>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f0048519d50>, 'last_state_update': <shinken.property.FloatProp object at 0x7f00485197d0>, 'execution_time': <shinken.property.FloatProp object at 0x7f0048519bd0>, 'start_time': <shinken.property.IntegerProp object at 0x7f0048519dd0>, 'state_type': <shinken.property.StringProp object at 0x7f0048519590>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'notified_contacts': <shinken.property.ListProp object at 0x7f0048519fd0>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f0048519950>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f0048519e50>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f0048506050>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f00485195d0>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f0048519d10>, 'state_before_impact': <shinken.property.StringProp object at 0x7f0048506290>, 'last_state_change': <shinken.property.FloatProp object at 0x7f0048519350>, 'state_id': <shinken.property.IntegerProp object at 0x7f00485191d0>, 'long_output': <shinken.property.StringProp object at 0x7f0048519650>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f0048519550>, 'current_event_id': <shinken.property.IntegerProp object at 0x7f0048519210>, 'end_time': <shinken.property.IntegerProp object at 0x7f0048519e10>, 'timeout': <shinken.property.IntegerProp object at 0x7f0048519d90>, 'output': <shinken.property.StringProp object at 0x7f0048519610>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f0048519ad0>, 'perf_data': <shinken.property.StringProp object at 0x7f0048519ed0>, 'in_checking': <shinken.property.BoolProp object at 0x7f00485190d0>, 'is_impact': <shinken.property.BoolProp object at 0x7f0048506190>, 'check_type': <shinken.property.IntegerProp object at 0x7f0048519a90>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f0048506090>, 'source_problems': <shinken.property.ListProp object at 0x7f0048506210>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f0048519250>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f0048506450>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f00485199d0>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f0048519b10>, 'latency': <shinken.property.FloatProp object at 0x7f0048519110>, 'state_changed_since_impact': <shinken.property.BoolProp object at 0x7f0048506310>, 'last_time_unknown': <shinken.property.IntegerProp object at 0x7f0048519510>, 'last_state_type': <shinken.property.StringProp object at 0x7f00485192d0>, 'downtimes': <shinken.property.ListProp object at 0x7f0048519890>, 'last_hard_state': <shinken.property.StringProp object at 0x7f00485193d0>, 'next_chk': <shinken.property.IntegerProp object at 0x7f0048519090>, 'comments': <shinken.property.ListProp object at 0x7f00485198d0>, 'state': <shinken.property.StringProp object at 0x7f0048519190>, 'last_chk': <shinken.property.IntegerProp object at 0x7f0048519050>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f0048519c90>, 'is_problem': <shinken.property.BoolProp object at 0x7f0048506150>, 'last_time_ok': <shinken.property.IntegerProp object at 0x7f0048519450>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>, 'return_code': <shinken.property.IntegerProp object at 0x7f0048519e90>, 'customs': <shinken.property.ListProp object at 0x7f0048519f90>, 'host': <shinken.property.StringProp object at 0x7f0048519f50>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f00485064d0>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f0048506350>, 'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f0048519750>, 'attempt': <shinken.property.IntegerProp object at 0x7f0048519150>, 'act_depend_of': <shinken.property.ListProp object at 0x7f00485196d0>, 'acknowledgement': <shinken.property.StringProp object at 0x7f0048519a10>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f0048519a50>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f00484fcfd0>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f0048519b90>, 'is_flapping': <shinken.property.BoolProp object at 0x7f0048519690>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f0048519410>}
scheduled_downtime_depth
service_dependencies
service_description
servicegroups
set_impact_state()[source]
set_state_from_exit_status(status)[source]
set_unreachable()[source]
should_be_scheduled
source_problems
stalking_options
start_time
state
state_before_hard_unknown_reach_phase
state_before_impact
state_changed_since_impact
state_id
state_id_before_impact
state_type
state_type_id
tags
time_to_orphanage
timeout
topology_change
trending_policies
trigger
trigger_name
triggers
unset_impact_state()[source]
use
was_in_hard_unknown_reach_phase
class shinken.objects.service.Services(items)[source]

Bases: shinken.objects.item.Items

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

alias of Service

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

servicedependency Module

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

Bases: shinken.objects.item.Items

add_service_dependency(dep_host_name, dep_service_description, par_host_name, par_service_description)[source]
apply_inheritance(hosts)[source]
delete_servicesdep_by_id(ids)[source]
explode(hostgroups)[source]
explode_hostgroup(sd, hostgroups)[source]
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 0x7f00487bd150>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f00487bd1d0>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f00487bd0d0>, 'explode_hostgroup': <shinken.property.BoolProp object at 0x7f00487bd250>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f00487bd190>, 'dependency_period': <shinken.property.StringProp object at 0x7f00487bd210>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f00487e3d50>, 'host_name': <shinken.property.StringProp object at 0x7f00487bd090>, 'dependent_service_description': <shinken.property.StringProp object at 0x7f00487e3fd0>, 'service_description': <shinken.property.StringProp object at 0x7f00487bd110>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f00487e3ed0>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}

serviceescalation Module

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

Bases: shinken.objects.item.Item

get_name()[source]
id = 1
my_type = 'serviceescalation'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'first_notification': <shinken.property.IntegerProp object at 0x7f00485154d0>, 'contacts': <shinken.property.StringProp object at 0x7f0048515610>, 'escalation_options': <shinken.property.ListProp object at 0x7f00485155d0>, 'contact_groups': <shinken.property.StringProp object at 0x7f0048515650>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f0048515550>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f0048515450>, 'escalation_period': <shinken.property.StringProp object at 0x7f0048515590>, 'host_name': <shinken.property.StringProp object at 0x7f00485153d0>, 'service_description': <shinken.property.StringProp object at 0x7f0048515490>, 'last_notification': <shinken.property.IntegerProp object at 0x7f0048515510>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
class shinken.objects.serviceescalation.Serviceescalations(items)[source]

Bases: shinken.objects.item.Items

explode(escalations)[source]
inner_class

alias of Serviceescalation

name_property = ''

serviceextinfo Module

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

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

Bases: shinken.objects.item.Item

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 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f0047f2fdd0>, 'notes': <shinken.property.StringProp object at 0x7f0047f2fd10>, 'icon_image': <shinken.property.StringProp object at 0x7f0047f2fd90>, 'notes_url': <shinken.property.StringProp object at 0x7f0047f2fd50>, 'host_name': <shinken.property.ListProp object at 0x7f0047f2fc50>, 'service_description': <shinken.property.StringProp object at 0x7f0047f2fcd0>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
service_description
use
class shinken.objects.serviceextinfo.ServicesExtInfo(items)[source]

Bases: shinken.objects.item.Items

inner_class

alias of ServiceExtInfo

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

servicegroup Module

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

Bases: shinken.objects.itemgroup.Itemgroup

get_name()[source]
get_servicegroup_members()[source]
get_services()[source]
get_services_by_explosion(servicegroups)[source]
id = 1
macros = {'SERVICEGROUPNOTES': 'notes', 'SERVICEGROUPALIAS': 'alias', 'SERVICEGROUPMEMBERS': 'members', 'SERVICEGROUPACTIONURL': 'action_url', 'SERVICEGROUPNOTESURL': 'notes_url'}
my_type = 'servicegroup'
properties = {'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'alias': <shinken.property.StringProp object at 0x7f00487e3c10>, 'notes': <shinken.property.StringProp object at 0x7f00487e3c50>, 'unknown_members': <shinken.property.StringProp object at 0x7f00487cb1d0>, 'action_url': <shinken.property.StringProp object at 0x7f00487e3cd0>, 'notes_url': <shinken.property.StringProp object at 0x7f00487e3c90>, 'members': <shinken.property.StringProp object at 0x7f00487cb150>, 'id': <shinken.property.StringProp object at 0x7f00487e39d0>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>, 'servicegroup_name': <shinken.property.StringProp object at 0x7f00487e3bd0>}
class shinken.objects.servicegroup.Servicegroups(items)[source]

Bases: shinken.objects.itemgroup.Itemgroups

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

alias of Servicegroup

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

timeperiod Module

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

Bases: shinken.objects.item.Item

apply_inheritance()[source]
check_and_log_activation_change()[source]
check_exclude_rec()[source]
clean_cache()[source]
explode(timeperiods)[source]
fill_data_brok_from(data, brok_type)[source]
find_next_invalid_time_from_cache(t)[source]
find_next_valid_time_from_cache(t)[source]
get_initial_status_brok()[source]
get_min_from_t(t)[source]
get_name()[source]
get_next_invalid_time_from_t(t)[source]
get_next_valid_time_from_t(t)[source]
get_not_in_min_from_t(f)[source]
get_raw_import_values()[source]
get_unresolved_properties_by_inheritance(items)[source]
has(prop)[source]
id = 1
is_correct()[source]
is_time_valid(t)[source]
linkify(timeperiods)[source]
my_type = 'timeperiod'
properties = {'use': <shinken.property.StringProp object at 0x7f00487c6590>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'register': <shinken.property.IntegerProp object at 0x7f00487c65d0>, 'is_active': <shinken.property.BoolProp object at 0x7f00487c6690>, 'dateranges': <shinken.property.ListProp object at 0x7f00487c6610>, 'alias': <shinken.property.StringProp object at 0x7f00487c6550>, 'timeperiod_name': <shinken.property.StringProp object at 0x7f00487c64d0>, 'exclude': <shinken.property.ListProp object at 0x7f00487c6650>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
resolve_daterange(dateranges, entry)[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.timeperiod.Timeperiods(items)[source]

Bases: shinken.objects.item.Items

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

alias of Timeperiod

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

trigger Module

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

Bases: shinken.objects.item.Item

compile()[source]
eval(myself, ctx)[source]
get_name()[source]
id = 1
my_type = 'trigger'
properties = {'trigger_name': <shinken.property.StringProp object at 0x7f0047e70b10>, 'use': <shinken.property.ListProp object at 0x7f00487a8c50>, 'code_src': <shinken.property.StringProp object at 0x7f0047e70b50>, 'name': <shinken.property.StringProp object at 0x7f00487a8c90>, 'imported_from': <shinken.property.StringProp object at 0x7f00487a8bd0>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f00487a8d10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f00487a8cd0>, 'code_bin': <shinken.property.StringProp object at 0x7f0047e70b90>, 'hash': <shinken.property.StringProp object at 0x7f00487a8d50>, 'tags': <shinken.property.ListProp object at 0x7f00487a8d90>}
class shinken.objects.trigger.Triggers(items)[source]

Bases: shinken.objects.item.Items

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

alias of Trigger

load_file(path)[source]
load_objects(conf)[source]
name_property = 'trigger_name'
Read the Docs v: 1.4.2
Versions
latest
stable
branch-1.4
2.4.1
2.4
2.4---4
2.4---3
2.4---2
2.4---1
2.4-----1
2.2
2.2---1
2.0.3
1.4.2
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.