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 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'modulation_period': <shinken.property.StringProp object at 0x7f7803c83c10>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'business_impact_modulation_name': <shinken.property.StringProp object at 0x7f7803c83b50>, 'business_impact': <shinken.property.IntegerProp object at 0x7f7803c83bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
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 0x7f780209a150>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'check_command': <shinken.property.StringProp object at 0x7f780209a090>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'checkmodulation_name': <shinken.property.StringProp object at 0x7f7802091b90>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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_name()[source]
id = 0
imported_from
module_type
my_type = 'command'
name
poller_tag
properties = {'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'command_line': <shinken.property.StringProp object at 0x7f7804305090>, 'poller_tag': <shinken.property.StringProp object at 0x7f78043050d0>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f7804305110>, 'module_type': <shinken.property.StringProp object at 0x7f7804305150>, 'timeout': <shinken.property.IntegerProp object at 0x7f7804305190>, 'enable_environment_macros': <shinken.property.BoolProp object at 0x7f78043051d0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'command_name': <shinken.property.StringProp object at 0x7f7804321fd0>}
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.ListProp object at 0x7f7803eaced0>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'address1': <shinken.property.StringProp object at 0x7f7803eb1050>, 'address2': <shinken.property.StringProp object at 0x7f7803eb1090>, 'address3': <shinken.property.StringProp object at 0x7f7803eb10d0>, 'address4': <shinken.property.StringProp object at 0x7f7803eb1110>, 'address5': <shinken.property.StringProp object at 0x7f7803eb1150>, 'address6': <shinken.property.StringProp object at 0x7f7803eb1190>, 'contactgroups': <shinken.property.ListProp object at 0x7f7803eac910>, 'is_admin': <shinken.property.BoolProp object at 0x7f7803eb1210>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f7803eaca10>, 'can_submit_commands': <shinken.property.BoolProp object at 0x7f7803eb11d0>, 'contact_name': <shinken.property.StringProp object at 0x7f7803eac850>, 'password': <shinken.property.StringProp object at 0x7f7803eb1310>, 'pager': <shinken.property.StringProp object at 0x7f7803eacfd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'notificationways': <shinken.property.ListProp object at 0x7f7803eb12d0>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'service_notification_commands': <shinken.property.ListProp object at 0x7f7803eacf10>, 'host_notification_period': <shinken.property.StringProp object at 0x7f7803eacd90>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'expert': <shinken.property.BoolProp object at 0x7f7803eb1250>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f7803eac950>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'service_notification_period': <shinken.property.StringProp object at 0x7f7803eace10>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f7803eacf50>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f7803eb1290>, 'email': <shinken.property.StringProp object at 0x7f7803eacf90>, 'alias': <shinken.property.StringProp object at 0x7f7803eac8d0>, 'service_notification_options': <shinken.property.ListProp object at 0x7f7803eace90>, 'host_notification_options': <shinken.property.ListProp object at 0x7f7803eace50>}
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 0x7f78042d9c50>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f7803eb1350>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'downtimes': <shinken.property.StringProp object at 0x7f7803eb1390>}
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 0x7f78042d9b90>, 'unknown_members': <shinken.property.ListProp object at 0x7f7803e89b90>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'members': <shinken.property.ListProp object at 0x7f7803e89b10>, 'alias': <shinken.property.StringProp object at 0x7f7803eb1810>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'contactgroup_name': <shinken.property.StringProp object at 0x7f7803eb17d0>, 'id': <shinken.property.IntegerProp object at 0x7f7803eb1610>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
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 0x7f78042d9890>, 'creation_type': <shinken.property.StringProp object at 0x7f7803c83350>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'discoveryrule_order': <shinken.property.IntegerProp object at 0x7f7803c83390>, 'discoveryrule_name': <shinken.property.StringProp object at 0x7f7803c83110>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f7803c83410>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f7803c833d0>}
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 0x7f78042d9890>, 'discoveryrun_command': <shinken.property.StringProp object at 0x7f7803c836d0>, 'discoveryrun_name': <shinken.property.StringProp object at 0x7f7803c834d0>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'current_launch': <shinken.property.StringProp object at 0x7f7803c83710>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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 0x7f78042d9890>, 'last_notification': <shinken.property.IntegerProp object at 0x7f7804305790>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'contacts': <shinken.property.ListProp object at 0x7f7804305b10>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f7804305a10>, 'escalation_options': <shinken.property.ListProp object at 0x7f7804305ad0>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'contact_groups': <shinken.property.ListProp object at 0x7f7804305b50>, 'escalation_name': <shinken.property.StringProp object at 0x7f7804305690>, 'escalation_period': <shinken.property.StringProp object at 0x7f7804305a90>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f78043059d0>, 'first_notification': <shinken.property.IntegerProp object at 0x7f7804305750>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f7804305a50>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'time_based': <shinken.property.BoolProp object at 0x7f7804305b90>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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_downtime()[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_excluded_for(service)[source]

Check whether this host should have the passed service be “excluded” or “not included”.

An host can define service_includes and/or service_excludes directive to either white-list-only or black-list some services from itself.

is_excluded_for_sdesc(sdesc, is_tpl=False)[source]

Check whether this host should have the passed service description be “excluded” or “not included”.

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 0x7f7803eaa390>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7f7803eaa590>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f780432d710>, 'labels': <shinken.property.StringProp object at 0x7f7803eaa750>, 'action_url': <shinken.property.StringProp object at 0x7f7803eaa250>, 'escalations': <shinken.property.ListProp object at 0x7f7803eaa5d0>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f780432d950>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f780432da50>, '2d_coords': <shinken.property.StringProp object at 0x7f7803eaa3d0>, 'icon_image': <shinken.property.StringProp object at 0x7f7803eaa290>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7f7803eaabd0>, 'check_period': <shinken.property.StringProp object at 0x7f780432d7d0>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'display_name': <shinken.property.StringProp object at 0x7f780432d510>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f780432dc50>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f7803eaa450>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f780432da10>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7f7803eaaad0>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f780432d910>, 'trigger': <shinken.property.StringProp object at 0x7f7803eaa910>, 'parents': <shinken.property.ListProp object at 0x7f780432d590>, 'initial_state': <shinken.property.CharProp object at 0x7f780432d650>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f780432dc90>, 'notification_options': <shinken.property.ListProp object at 0x7f780432dd10>, 'host_name': <shinken.property.StringProp object at 0x7f780432d450>, 'snapshot_period': <shinken.property.StringProp object at 0x7f7803eaab50>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f780432dd50>, 'event_handler': <shinken.property.StringProp object at 0x7f780432d8d0>, 'obsess_over_host': <shinken.property.BoolProp object at 0x7f780432d810>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f780432d890>, 'alias': <shinken.property.StringProp object at 0x7f780432d4d0>, 'service_excludes': <shinken.property.ListProp object at 0x7f7803eaa6d0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f7803eaa650>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f7803eaa990>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'custom_views': <shinken.property.ListProp object at 0x7f7803eaaa90>, 'check_command': <shinken.property.StringProp object at 0x7f780432d610>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f780432d790>, 'check_interval': <shinken.property.IntegerProp object at 0x7f780432d6d0>, 'notes': <shinken.property.StringProp object at 0x7f7803eaa1d0>, 'check_freshness': <shinken.property.BoolProp object at 0x7f780432d850>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f780432d750>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f7803eaa2d0>, 'service_includes': <shinken.property.ListProp object at 0x7f7803eaa710>, 'hostgroups': <shinken.property.ListProp object at 0x7f780432d5d0>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f7803eaa510>, 'notes_url': <shinken.property.StringProp object at 0x7f7803eaa210>, 'service_overrides': <shinken.property.ListProp object at 0x7f7803eaa690>, 'maintenance_period': <shinken.property.StringProp object at 0x7f7803eaa610>, 'realm': <shinken.property.StringProp object at 0x7f7803eaa490>, 'contacts': <shinken.property.ListProp object at 0x7f780432db50>, 'notification_period': <shinken.property.StringProp object at 0x7f780432dcd0>, 'trending_policies': <shinken.property.ListProp object at 0x7f7803eaa9d0>, 'resultmodulations': <shinken.property.ListProp object at 0x7f7803eaa550>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f780432da90>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f7803eaa810>, 'stalking_options': <shinken.property.ListProp object at 0x7f7803eaa190>, 'macromodulations': <shinken.property.ListProp object at 0x7f7803eaaa50>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f780432d9d0>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f7803eaa850>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f780432d990>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7f7803eaab90>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f780432dad0>, 'contact_groups': <shinken.property.ListProp object at 0x7f780432dbd0>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f7803eaa7d0>, 'address': <shinken.property.StringProp object at 0x7f780432d550>, 'trigger_name': <shinken.property.StringProp object at 0x7f7803eaa950>, 'vrml_image': <shinken.property.StringProp object at 0x7f7803eaa350>, '3d_coords': <shinken.property.StringProp object at 0x7f7803eaa410>, 'snapshot_command': <shinken.property.StringProp object at 0x7f7803eaab10>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'checkmodulations': <shinken.property.ListProp object at 0x7f7803eaaa10>, 'poller_tag': <shinken.property.StringProp object at 0x7f7803eaa4d0>, 'icon_set': <shinken.property.StringProp object at 0x7f7803eaa310>, 'business_impact': <shinken.property.IntegerProp object at 0x7f7803eaa8d0>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f780432d690>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f7803eaa890>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f7803eaa790>}
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 0x7f7803e89090>, 'child_dependencies': <shinken.property.StringProp object at 0x7f7803e82e90>, 'last_time_unreachable': <shinken.property.IntegerProp object at 0x7f7803e821d0>, 'childs': <shinken.property.StringProp object at 0x7f7803e82e10>, 'business_rule': <shinken.property.StringProp object at 0x7f7803e89190>, 'last_perf_data': <shinken.property.StringProp object at 0x7f7803e82c10>, 'acknowledgement': <shinken.property.StringProp object at 0x7f7803e82690>, 'actions': <shinken.property.StringProp object at 0x7f7803e82d90>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f7803e82950>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f7803e827d0>, 's_time': <shinken.property.FloatProp object at 0x7f7803e828d0>, 'checks_in_progress': <shinken.property.StringProp object at 0x7f7803e824d0>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f7803e82390>, 'last_notification': <shinken.property.FloatProp object at 0x7f7803e82910>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f7803e82410>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f7803e829d0>, 'last_state': <shinken.property.StringProp object at 0x7f7803eaaf50>, 'topology_change': <shinken.property.BoolProp object at 0x7f7803e89290>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f7803e82f50>, 'impacts': <shinken.property.StringProp object at 0x7f7803e82fd0>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f7803e82090>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f7803e89210>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f7803e82e50>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f7803e82610>, 'notifications_in_progress': <shinken.property.StringProp object at 0x7f7803e82510>, 'u_time': <shinken.property.FloatProp object at 0x7f7803e82890>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f7803eaaf90>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f7803e82750>, 'broks': <shinken.property.StringProp object at 0x7f7803e82dd0>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f7803e82a50>, 'last_state_update': <shinken.property.StringProp object at 0x7f7803e82450>, 'execution_time': <shinken.property.FloatProp object at 0x7f7803e82850>, 'start_time': <shinken.property.IntegerProp object at 0x7f7803e82ad0>, 'flapping_changes': <shinken.property.StringProp object at 0x7f7803e825d0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'notified_contacts': <shinken.property.StringProp object at 0x7f7803e82cd0>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f7803e82310>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f7803e82b50>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f7803e82d10>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f7803e823d0>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f7803eaae90>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f7803e82a10>, 'in_checking': <shinken.property.BoolProp object at 0x7f7803eaacd0>, 'last_state_change': <shinken.property.FloatProp object at 0x7f7803e82050>, 'long_output': <shinken.property.StringProp object at 0x7f7803e82290>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f7803e82210>, 'end_time': <shinken.property.IntegerProp object at 0x7f7803e82b10>, 'timeout': <shinken.property.IntegerProp object at 0x7f7803e82a90>, 'output': <shinken.property.StringProp object at 0x7f7803e82250>, 'perf_data': <shinken.property.StringProp object at 0x7f7803e82bd0>, 'state_before_impact': <shinken.property.StringProp object at 0x7f7803e89050>, 'is_impact': <shinken.property.StringProp object at 0x7f7803e82f10>, 'check_type': <shinken.property.IntegerProp object at 0x7f7803e82710>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f7803e82d50>, 'source_problems': <shinken.property.StringProp object at 0x7f7803e82f90>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f7803eaaf10>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f7803e891d0>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f7803e82650>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f7803e82790>, 'latency': <shinken.property.FloatProp object at 0x7f7803eaad50>, 'state_changed_since_impact': <shinken.property.StringProp object at 0x7f7803e890d0>, 'current_event_id': <shinken.property.StringProp object at 0x7f7803eaaed0>, 'last_state_type': <shinken.property.StringProp object at 0x7f7803eaafd0>, 'downtimes': <shinken.property.StringProp object at 0x7f7803e82550>, 'last_time_up': <shinken.property.IntegerProp object at 0x7f7803e82150>, 'last_hard_state': <shinken.property.StringProp object at 0x7f7803e820d0>, 'next_chk': <shinken.property.IntegerProp object at 0x7f7803eaac90>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f7803e89150>, 'comments': <shinken.property.StringProp object at 0x7f7803e82590>, 'last_check_command': <shinken.property.StringProp object at 0x7f7803e89390>, 'state': <shinken.property.StringProp object at 0x7f7803eaadd0>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f7803e82810>, 'last_chk': <shinken.property.IntegerProp object at 0x7f7803eaac50>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f7803e82990>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7f7803e89350>, 'is_problem': <shinken.property.StringProp object at 0x7f7803e82ed0>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>, 'pack_id': <shinken.property.IntegerProp object at 0x7f7803e892d0>, 'return_code': <shinken.property.IntegerProp object at 0x7f7803e82b90>, 'is_flapping': <shinken.property.BoolProp object at 0x7f7803e822d0>, 'customs': <shinken.property.StringProp object at 0x7f7803e82c50>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f7803e89250>, 'got_default_realm': <shinken.property.BoolProp object at 0x7f7803e82c90>, 'state_id': <shinken.property.IntegerProp object at 0x7f7803eaae10>, 'services': <shinken.property.StringProp object at 0x7f7803e82490>, 'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'state_type': <shinken.property.StringProp object at 0x7f7803eaae50>, 'attempt': <shinken.property.IntegerProp object at 0x7f7803eaad90>, 'act_depend_of': <shinken.property.ListProp object at 0x7f7803e82350>, 'triggers': <shinken.property.StringProp object at 0x7f7803e89310>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f7803e826d0>, 'last_time_down': <shinken.property.IntegerProp object at 0x7f7803e82190>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f7803eaac10>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f7803eaad10>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f7803e89110>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f7803e82110>}
s_time
scheduled_downtime_depth
service_excludes = []
service_includes = []
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

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 0x7f7803ebead0>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f7803ebeb50>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'dependency_period': <shinken.property.StringProp object at 0x7f7803ebeb90>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f7803ebeb10>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f7803ebea90>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f7803ebe910>, 'host_name': <shinken.property.StringProp object at 0x7f7803ebea50>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f7803ebea10>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}

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 0x7f78042d9b90>, 'contact_groups': <shinken.property.StringProp object at 0x7f780432d250>, 'escalation_period': <shinken.property.StringProp object at 0x7f780432d190>, 'last_notification': <shinken.property.IntegerProp object at 0x7f780432d110>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f780432d150>, 'contacts': <shinken.property.StringProp object at 0x7f780432d210>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f780432d2d0>, 'escalation_options': <shinken.property.ListProp object at 0x7f780432d1d0>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f780432d090>, 'host_name': <shinken.property.StringProp object at 0x7f7804305f90>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f780432d290>, 'first_notification': <shinken.property.IntegerProp object at 0x7f780432d0d0>}
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 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f780209a690>, 'notes': <shinken.property.StringProp object at 0x7f780209a050>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'vrml_image': <shinken.property.StringProp object at 0x7f780209a710>, '3d_coords': <shinken.property.StringProp object at 0x7f780209a8d0>, 'notes_url': <shinken.property.StringProp object at 0x7f780209a5d0>, 'host_name': <shinken.property.StringProp object at 0x7f780209a490>, 'icon_image': <shinken.property.StringProp object at 0x7f780209a610>, '2d_coords': <shinken.property.StringProp object at 0x7f780209a810>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'statusmap_image': <shinken.property.StringProp object at 0x7f780209a790>}
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 0x7f78042d9890>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f7803e89c50>, 'realm': <shinken.property.StringProp object at 0x7f7803e89d90>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'alias': <shinken.property.StringProp object at 0x7f7803e89c90>, 'notes': <shinken.property.StringProp object at 0x7f7803e89cd0>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'unknown_members': <shinken.property.ListProp object at 0x7f7803e89b90>, 'action_url': <shinken.property.StringProp object at 0x7f7803e89d50>, 'notes_url': <shinken.property.StringProp object at 0x7f7803e89d10>, 'members': <shinken.property.ListProp object at 0x7f7803e89b10>, 'id': <shinken.property.IntegerProp object at 0x7f7803e89c10>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
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(deep_level)[source]
get_initial_status_brok()[source]
get_next_schedule_brok()[source]
get_plus_and_delete(prop)[source]
get_property_by_inheritance(prop, deep_level)[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 0x7f78042d9b90>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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 an item into our containers, 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]

For all items and templates inherite properties and custom variables.

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

Indexes an item into our name_to_item dictionary. If an object holding the same item’s name/key already exists in the index then the conflict is managed by the manage_conflict method.

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, partial=False)[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, templates=False)[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 un-index) an item from our containers.

Parameters:item (Item # or subclass of) – The item to be removed.
remove_template(tpl)[source]

Removes and unindex 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)[source]

Unindex an item from our name_to_item dict. :param item: The item to unindex

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 0x7f7803e89b10>, 'unknown_members': <shinken.property.ListProp object at 0x7f7803e89b90>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
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 0x7f7803c83cd0>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'modulation_period': <shinken.property.StringProp object at 0x7f7803c83fd0>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'modules': <shinken.property.ListProp object at 0x7f7803c83090>, 'module_type': <shinken.property.StringProp object at 0x7f7803c83050>, 'module_name': <shinken.property.StringProp object at 0x7f7803ebef90>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
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 0x7f78042d9890>, 'host_notification_commands': <shinken.property.ListProp object at 0x7f7803eb1b90>, 'notificationway_name': <shinken.property.StringProp object at 0x7f7803eb1950>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f7803eb19d0>, 'service_notification_options': <shinken.property.ListProp object at 0x7f7803eb1b50>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'service_notification_period': <shinken.property.StringProp object at 0x7f7803eb1ad0>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f7803eb1c10>, 'host_notification_options': <shinken.property.ListProp object at 0x7f7803eb1b10>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f7803eb1a10>, 'host_notification_period': <shinken.property.StringProp object at 0x7f7803eb1a50>, 'service_notification_commands': <shinken.property.ListProp object at 0x7f7803eb1bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'pack_name': <shinken.property.StringProp object at 0x7f780209ab90>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'macros': <shinken.property.StringProp object at 0x7f780209ac90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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 0x7f7803eac490>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'realm_members': <shinken.property.ListProp object at 0x7f7803eac450>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'realm_name': <shinken.property.StringProp object at 0x7f7803eac410>, 'unknown_members': <shinken.property.ListProp object at 0x7f7803e89b90>, 'default': <shinken.property.BoolProp object at 0x7f7803eac4d0>, 'broker_complete_links': <shinken.property.BoolProp object at 0x7f7803eac510>, 'members': <shinken.property.ListProp object at 0x7f7803e89b10>, 'id': <shinken.property.IntegerProp object at 0x7f7803eac390>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'serialized_confs': <shinken.property.DictProp object at 0x7f7803eac550>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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 0x7f78042d9890>, 'resultmodulation_name': <shinken.property.StringProp object at 0x7f7804305250>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'modulation_period': <shinken.property.StringProp object at 0x7f7804305490>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'exit_code_modulation': <shinken.property.IntegerProp object at 0x7f7804305450>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'exit_codes_match': <shinken.property.IntListProp object at 0x7f7804305350>}
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]

For a given host, look for all copy we must create for for_each property :type host: shinken.objects.host.Host :return Service

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_downtime()[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 0x7f78043a9b90>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7f780433eed0>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f78043a9e50>, 'labels': <shinken.property.ListProp object at 0x7f780431a050>, 'obsess_over_service': <shinken.property.BoolProp object at 0x7f78043a9fd0>, 'action_url': <shinken.property.StringProp object at 0x7f780433ec90>, 'escalations': <shinken.property.ListProp object at 0x7f780433ef10>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f7803e99410>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f780433e950>, 'icon_image': <shinken.property.StringProp object at 0x7f780433ecd0>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7f780431a610>, 'check_period': <shinken.property.StringProp object at 0x7f78043a9f90>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'display_name': <shinken.property.StringProp object at 0x7f78043a9c10>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f780433ea10>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f780433ed90>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f780433e910>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7f780431a510>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f7803e991d0>, 'trigger': <shinken.property.StringProp object at 0x7f780431a310>, 'initial_state': <shinken.property.CharProp object at 0x7f78043a9d50>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f780433ea50>, 'notification_options': <shinken.property.ListProp object at 0x7f780433ead0>, 'host_name': <shinken.property.StringProp object at 0x7f78043a9ad0>, 'snapshot_period': <shinken.property.StringProp object at 0x7f780431a590>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f780433eb10>, 'event_handler': <shinken.property.StringProp object at 0x7f7803e990d0>, 'aggregation': <shinken.property.StringProp object at 0x7f780431a4d0>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f7803e99090>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f780433ef90>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f780431a390>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'notes': <shinken.property.StringProp object at 0x7f780433ec10>, 'check_command': <shinken.property.StringProp object at 0x7f78043a9d10>, 'parallelize_check': <shinken.property.BoolProp object at 0x7f780433edd0>, 'servicegroups': <shinken.property.ListProp object at 0x7f78043a9c90>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f78043a9f50>, 'check_interval': <shinken.property.IntegerProp object at 0x7f78043a9dd0>, 'merge_host_contacts': <shinken.property.BoolProp object at 0x7f780433efd0>, 'notes_url': <shinken.property.StringProp object at 0x7f780433ec50>, 'custom_views': <shinken.property.ListProp object at 0x7f780431a490>, 'check_freshness': <shinken.property.BoolProp object at 0x7f7803e99050>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f78043a9ed0>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f780433ed10>, 'host_dependency_enabled': <shinken.property.BoolProp object at 0x7f780431a090>, 'checkmodulations': <shinken.property.ListProp object at 0x7f780431a410>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f780433ee50>, 'is_volatile': <shinken.property.BoolProp object at 0x7f78043a9cd0>, 'default_value': <shinken.property.StringProp object at 0x7f780431a290>, 'maintenance_period': <shinken.property.StringProp object at 0x7f780433ef50>, 'contacts': <shinken.property.ListProp object at 0x7f780433eb50>, 'notification_period': <shinken.property.StringProp object at 0x7f780433ea90>, 'trending_policies': <shinken.property.ListProp object at 0x7f780431a3d0>, 'resultmodulations': <shinken.property.ListProp object at 0x7f780433ee90>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f780433e990>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f780431a150>, 'stalking_options': <shinken.property.ListProp object at 0x7f780433ebd0>, 'macromodulations': <shinken.property.ListProp object at 0x7f780431a450>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f7803e999d0>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f780431a190>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f7803e99590>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7f780431a5d0>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f780433e9d0>, 'contact_groups': <shinken.property.ListProp object at 0x7f780433eb90>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f780431a110>, 'service_description': <shinken.property.StringProp object at 0x7f78043a9bd0>, 'trigger_name': <shinken.property.StringProp object at 0x7f780431a350>, 'service_dependencies': <shinken.property.ListProp object at 0x7f780431a210>, 'snapshot_command': <shinken.property.StringProp object at 0x7f780431a550>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'duplicate_foreach': <shinken.property.StringProp object at 0x7f780431a250>, 'poller_tag': <shinken.property.StringProp object at 0x7f780433ee10>, 'icon_set': <shinken.property.StringProp object at 0x7f780433ed50>, 'business_impact': <shinken.property.IntegerProp object at 0x7f780431a2d0>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f78043a9d90>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f780431a1d0>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f780431a0d0>}
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 0x7f7804321a10>, 'child_dependencies': <shinken.property.StringProp object at 0x7f7804321b90>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f7804321250>, 'business_rule': <shinken.property.StringProp object at 0x7f7804321b10>, 'last_perf_data': <shinken.property.StringProp object at 0x7f7804321690>, 'acknowledgement': <shinken.property.StringProp object at 0x7f7804321110>, 'actions': <shinken.property.ListProp object at 0x7f7804321810>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f78043213d0>, 'flapping_changes': <shinken.property.ListProp object at 0x7f780431afd0>, 'last_time_critical': <shinken.property.IntegerProp object at 0x7f780431ab50>, 's_time': <shinken.property.FloatProp object at 0x7f7804321350>, 'last_time_warning': <shinken.property.IntegerProp object at 0x7f780431ab10>, 'checks_in_progress': <shinken.property.ListProp object at 0x7f780431ae90>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f780431ad90>, 'last_notification': <shinken.property.FloatProp object at 0x7f7804321390>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f780431ae10>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f7804321450>, 'last_state': <shinken.property.StringProp object at 0x7f780431a910>, 'topology_change': <shinken.property.BoolProp object at 0x7f7804321c90>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f7804321910>, 'impacts': <shinken.property.ListProp object at 0x7f7804321990>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f780431aa10>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f7804321c10>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f7804321b50>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f7804321090>, 'notifications_in_progress': <shinken.property.DictProp object at 0x7f780431aed0>, 'u_time': <shinken.property.FloatProp object at 0x7f7804321310>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f780431a990>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f78043211d0>, 'broks': <shinken.property.ListProp object at 0x7f7804321850>, 'last_time_unknown': <shinken.property.IntegerProp object at 0x7f780431ab90>, 'last_state_update': <shinken.property.FloatProp object at 0x7f780431ae50>, 'execution_time': <shinken.property.FloatProp object at 0x7f78043212d0>, 'start_time': <shinken.property.IntegerProp object at 0x7f7804321550>, 'state_type': <shinken.property.StringProp object at 0x7f780431ac10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'notified_contacts': <shinken.property.ListProp object at 0x7f7804321750>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f7804321050>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f78043215d0>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f7804321790>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f780431ac50>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f7804321490>, 'in_checking': <shinken.property.BoolProp object at 0x7f780431a710>, 'last_state_change': <shinken.property.FloatProp object at 0x7f780431a9d0>, 'long_output': <shinken.property.StringProp object at 0x7f780431acd0>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f780431abd0>, 'current_event_id': <shinken.property.IntegerProp object at 0x7f780431a890>, 'end_time': <shinken.property.IntegerProp object at 0x7f7804321590>, 'timeout': <shinken.property.IntegerProp object at 0x7f7804321510>, 'output': <shinken.property.StringProp object at 0x7f780431ac90>, 'perf_data': <shinken.property.StringProp object at 0x7f7804321650>, 'state_before_impact': <shinken.property.StringProp object at 0x7f78043219d0>, 'is_impact': <shinken.property.BoolProp object at 0x7f78043218d0>, 'check_type': <shinken.property.IntegerProp object at 0x7f7804321190>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f78043217d0>, 'source_problems': <shinken.property.ListProp object at 0x7f7804321950>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f780431a8d0>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f7804321bd0>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f78043210d0>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f7804321210>, 'latency': <shinken.property.FloatProp object at 0x7f780431a790>, 'state_changed_since_impact': <shinken.property.BoolProp object at 0x7f7804321a50>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f78043214d0>, 'last_state_type': <shinken.property.StringProp object at 0x7f780431a950>, 'downtimes': <shinken.property.ListProp object at 0x7f780431af50>, 'last_hard_state': <shinken.property.StringProp object at 0x7f780431aa50>, 'next_chk': <shinken.property.IntegerProp object at 0x7f780431a6d0>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f7804321ad0>, 'comments': <shinken.property.ListProp object at 0x7f780431af90>, 'last_check_command': <shinken.property.StringProp object at 0x7f7804321d50>, 'state': <shinken.property.StringProp object at 0x7f780431a810>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f7804321290>, 'last_chk': <shinken.property.IntegerProp object at 0x7f780431a690>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f7804321410>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7f7804321d10>, 'is_problem': <shinken.property.BoolProp object at 0x7f7804321890>, 'last_time_ok': <shinken.property.IntegerProp object at 0x7f780431aad0>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>, 'return_code': <shinken.property.IntegerProp object at 0x7f7804321610>, 'is_flapping': <shinken.property.BoolProp object at 0x7f780431ad10>, 'customs': <shinken.property.DictProp object at 0x7f7804321710>, 'host': <shinken.property.StringProp object at 0x7f78043216d0>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f7804321c50>, 'state_id': <shinken.property.IntegerProp object at 0x7f780431a850>, 'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f780431add0>, 'attempt': <shinken.property.IntegerProp object at 0x7f780431a7d0>, 'act_depend_of': <shinken.property.ListProp object at 0x7f780431ad50>, 'triggers': <shinken.property.ListProp object at 0x7f7804321cd0>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f7804321150>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f780431a650>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f780431a750>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f7804321a90>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f780431aa90>}
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
unique_key
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, was_partial=False)[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_partial_service(item, index=True, var_tuple=None)[source]
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()[source]

For all items and templates inherite properties and custom variables.

apply_partial_inheritance(prop)[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 (Service) – 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, service)[source]

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

Parameters:
find_srv_by_name_and_hostname(host_name, sdescr)[source]
find_srvs_by_hostname(host_name)[source]
inner_class

alias of Service

late_linkify_s_by_commands(commands)[source]
linkify(hosts, commands, timeperiods, contacts, resultmodulations, businessimpactmodulations, escalations, servicegroups, triggers, checkmodulations, macromodulations)[source]
linkify_s_by_hst(hosts)[source]
linkify_s_by_sg(servicegroups)[source]
linkify_templates()[source]
name_property = 'unique_key'
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

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]
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 0x7f7803ebe790>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f7803ebe810>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'explode_hostgroup': <shinken.property.BoolProp object at 0x7f7803ebe890>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f7803ebe3d0>, 'service_description': <shinken.property.StringProp object at 0x7f7803ebe750>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f7803ebe550>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'dependency_period': <shinken.property.StringProp object at 0x7f7803ebe850>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f7803ebe7d0>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f7803ebe710>, 'host_name': <shinken.property.StringProp object at 0x7f7803ebe6d0>, 'dependent_service_description': <shinken.property.StringProp object at 0x7f7803ebe690>}

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 0x7f78042d9b90>, 'contact_groups': <shinken.property.StringProp object at 0x7f7804305e90>, 'escalation_period': <shinken.property.StringProp object at 0x7f7804305dd0>, 'service_description': <shinken.property.StringProp object at 0x7f7804305cd0>, 'last_notification': <shinken.property.IntegerProp object at 0x7f7804305d50>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'use': <shinken.property.ListProp object at 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f7804305d90>, 'contacts': <shinken.property.StringProp object at 0x7f7804305e50>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f7804305f10>, 'escalation_options': <shinken.property.ListProp object at 0x7f7804305e10>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f7804305c90>, 'host_name': <shinken.property.StringProp object at 0x7f7804305c10>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f7804305ed0>, 'first_notification': <shinken.property.IntegerProp object at 0x7f7804305d10>}
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 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f780209aa90>, 'notes': <shinken.property.StringProp object at 0x7f780209a9d0>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'icon_image': <shinken.property.StringProp object at 0x7f780209aa50>, 'notes_url': <shinken.property.StringProp object at 0x7f780209aa10>, 'host_name': <shinken.property.StringProp object at 0x7f780209a910>, 'service_description': <shinken.property.StringProp object at 0x7f780209a990>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
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 0x7f78042d9890>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'alias': <shinken.property.StringProp object at 0x7f7803ebe250>, 'notes': <shinken.property.StringProp object at 0x7f7803ebe290>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'unknown_members': <shinken.property.ListProp object at 0x7f7803e89b90>, 'action_url': <shinken.property.StringProp object at 0x7f7803ebe310>, 'notes_url': <shinken.property.StringProp object at 0x7f7803ebe2d0>, 'members': <shinken.property.ListProp object at 0x7f7803e89b10>, 'id': <shinken.property.IntegerProp object at 0x7f7803eb1fd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>, 'servicegroup_name': <shinken.property.StringProp object at 0x7f7803ebe210>}
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(hosts, services)[source]
linkify_sg_by_srv(hosts, 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_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 0x7f7803dc25d0>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'register': <shinken.property.IntegerProp object at 0x7f7803dc2610>, 'is_active': <shinken.property.BoolProp object at 0x7f7803dc26d0>, 'dateranges': <shinken.property.ListProp object at 0x7f7803dc2650>, 'alias': <shinken.property.StringProp object at 0x7f7803dc2590>, 'timeperiod_name': <shinken.property.StringProp object at 0x7f7803dc2510>, 'exclude': <shinken.property.ListProp object at 0x7f7803dc2690>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
resolve_daterange(dateranges, entry)[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>}
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 0x7f78042d9890>, 'code_src': <shinken.property.StringProp object at 0x7f7803c83950>, 'name': <shinken.property.StringProp object at 0x7f78042d9a90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f78042d9b90>, 'trigger_name': <shinken.property.StringProp object at 0x7f7803c838d0>, 'register': <shinken.property.BoolProp object at 0x7f78042d9bd0>, 'imported_from': <shinken.property.StringProp object at 0x7f78042d9b50>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f78042d9c50>, 'code_bin': <shinken.property.StringProp object at 0x7f7803c83990>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f78042d9c10>, 'tags': <shinken.property.ListProp object at 0x7f78042d9cd0>, 'hash': <shinken.property.StringProp object at 0x7f78042d9c90>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f7803c839d0>}
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: 2.4.1
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.