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 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'modulation_period': <shinken.property.StringProp object at 0x7fc333cf8b90>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'business_impact_modulation_name': <shinken.property.StringProp object at 0x7fc333cf8ad0>, 'business_impact': <shinken.property.IntegerProp object at 0x7fc333cf8b50>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
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 0x7fc33284ab10>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'check_command': <shinken.property.StringProp object at 0x7fc33284ac90>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'checkmodulation_name': <shinken.property.StringProp object at 0x7fc33284ac10>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'command_line': <shinken.property.StringProp object at 0x7fc334600fd0>, 'poller_tag': <shinken.property.StringProp object at 0x7fc334622050>, 'reactionner_tag': <shinken.property.StringProp object at 0x7fc334622090>, 'module_type': <shinken.property.StringProp object at 0x7fc3346220d0>, 'timeout': <shinken.property.IntegerProp object at 0x7fc334622110>, 'enable_environment_macros': <shinken.property.BoolProp object at 0x7fc334622150>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'command_name': <shinken.property.StringProp object at 0x7fc334600f50>}
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 0x7fc333cf4e50>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'address1': <shinken.property.StringProp object at 0x7fc333cf4f90>, 'address2': <shinken.property.StringProp object at 0x7fc333cf4fd0>, 'address3': <shinken.property.StringProp object at 0x7fc333cea050>, 'address4': <shinken.property.StringProp object at 0x7fc333cea090>, 'address5': <shinken.property.StringProp object at 0x7fc333cea0d0>, 'address6': <shinken.property.StringProp object at 0x7fc333cea110>, 'contactgroups': <shinken.property.ListProp object at 0x7fc333cf4890>, 'is_admin': <shinken.property.BoolProp object at 0x7fc333cea190>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7fc333cf4990>, 'can_submit_commands': <shinken.property.BoolProp object at 0x7fc333cea150>, 'contact_name': <shinken.property.StringProp object at 0x7fc333cf47d0>, 'password': <shinken.property.StringProp object at 0x7fc333cea290>, 'pager': <shinken.property.StringProp object at 0x7fc333cf4f50>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'notificationways': <shinken.property.ListProp object at 0x7fc333cea250>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'service_notification_commands': <shinken.property.ListProp object at 0x7fc333cf4e90>, 'host_notification_period': <shinken.property.StringProp object at 0x7fc333cf4d10>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'expert': <shinken.property.BoolProp object at 0x7fc333cea1d0>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7fc333cf48d0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'service_notification_period': <shinken.property.StringProp object at 0x7fc333cf4d90>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7fc333cf4ed0>, 'retain_status_information': <shinken.property.BoolProp object at 0x7fc333cea210>, 'email': <shinken.property.StringProp object at 0x7fc333cf4f10>, 'alias': <shinken.property.StringProp object at 0x7fc333cf4850>, 'service_notification_options': <shinken.property.ListProp object at 0x7fc333cf4e10>, 'host_notification_options': <shinken.property.ListProp object at 0x7fc333cf4dd0>}
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 0x7fc3346a1b90>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7fc333cea2d0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'downtimes': <shinken.property.StringProp object at 0x7fc333cea310>}
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 0x7fc3346a1ad0>, 'unknown_members': <shinken.property.ListProp object at 0x7fc334cceb10>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'members': <shinken.property.ListProp object at 0x7fc334ccea90>, 'alias': <shinken.property.StringProp object at 0x7fc333cea790>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'contactgroup_name': <shinken.property.StringProp object at 0x7fc333cea750>, 'id': <shinken.property.IntegerProp object at 0x7fc333cea590>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
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 0x7fc3346a17d0>, 'creation_type': <shinken.property.StringProp object at 0x7fc333cf82d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'discoveryrule_order': <shinken.property.IntegerProp object at 0x7fc333cf8310>, 'discoveryrule_name': <shinken.property.StringProp object at 0x7fc333cf8090>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc333cf8390>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc333cf8350>}
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 0x7fc3346a17d0>, 'discoveryrun_command': <shinken.property.StringProp object at 0x7fc333cf8650>, 'discoveryrun_name': <shinken.property.StringProp object at 0x7fc333cf8450>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'current_launch': <shinken.property.StringProp object at 0x7fc333cf8690>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc3346a17d0>, 'last_notification': <shinken.property.IntegerProp object at 0x7fc334622710>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'contacts': <shinken.property.ListProp object at 0x7fc334622a90>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7fc334622990>, 'escalation_options': <shinken.property.ListProp object at 0x7fc334622a50>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'contact_groups': <shinken.property.ListProp object at 0x7fc334622ad0>, 'escalation_name': <shinken.property.StringProp object at 0x7fc334622610>, 'escalation_period': <shinken.property.StringProp object at 0x7fc334622a10>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7fc334622950>, 'first_notification': <shinken.property.IntegerProp object at 0x7fc3346226d0>, 'notification_interval': <shinken.property.IntegerProp object at 0x7fc3346229d0>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'time_based': <shinken.property.BoolProp object at 0x7fc334622b10>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc334cd6310>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7fc334cd6510>, 'retry_interval': <shinken.property.IntegerProp object at 0x7fc334625690>, 'labels': <shinken.property.StringProp object at 0x7fc334cd66d0>, 'action_url': <shinken.property.StringProp object at 0x7fc334cd61d0>, 'escalations': <shinken.property.ListProp object at 0x7fc334cd6550>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7fc3346258d0>, 'process_perf_data': <shinken.property.BoolProp object at 0x7fc3346259d0>, '2d_coords': <shinken.property.StringProp object at 0x7fc334cd6350>, 'icon_image': <shinken.property.StringProp object at 0x7fc334cd6210>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7fc334cd6b50>, 'check_period': <shinken.property.StringProp object at 0x7fc334625750>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'display_name': <shinken.property.StringProp object at 0x7fc334625490>, 'notification_interval': <shinken.property.IntegerProp object at 0x7fc334625bd0>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7fc334cd63d0>, 'flap_detection_options': <shinken.property.ListProp object at 0x7fc334625990>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7fc334cd6a50>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7fc334625890>, 'trigger': <shinken.property.StringProp object at 0x7fc334cd6890>, 'parents': <shinken.property.ListProp object at 0x7fc334625510>, 'initial_state': <shinken.property.CharProp object at 0x7fc3346255d0>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7fc334625c10>, 'notification_options': <shinken.property.ListProp object at 0x7fc334625c90>, 'host_name': <shinken.property.StringProp object at 0x7fc3346253d0>, 'snapshot_period': <shinken.property.StringProp object at 0x7fc334cd6ad0>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7fc334625cd0>, 'event_handler': <shinken.property.StringProp object at 0x7fc334625850>, 'obsess_over_host': <shinken.property.BoolProp object at 0x7fc334625790>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7fc334625810>, 'alias': <shinken.property.StringProp object at 0x7fc334625450>, 'service_excludes': <shinken.property.ListProp object at 0x7fc334cd6650>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7fc334cd65d0>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7fc334cd6910>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'custom_views': <shinken.property.ListProp object at 0x7fc334cd6a10>, 'check_command': <shinken.property.StringProp object at 0x7fc334625590>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7fc334625710>, 'check_interval': <shinken.property.IntegerProp object at 0x7fc334625650>, 'notes': <shinken.property.StringProp object at 0x7fc334cd6150>, 'check_freshness': <shinken.property.BoolProp object at 0x7fc3346257d0>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7fc3346256d0>, 'icon_image_alt': <shinken.property.StringProp object at 0x7fc334cd6250>, 'service_includes': <shinken.property.ListProp object at 0x7fc334cd6690>, 'hostgroups': <shinken.property.ListProp object at 0x7fc334625550>, 'reactionner_tag': <shinken.property.StringProp object at 0x7fc334cd6490>, 'notes_url': <shinken.property.StringProp object at 0x7fc334cd6190>, 'service_overrides': <shinken.property.ListProp object at 0x7fc334cd6610>, 'maintenance_period': <shinken.property.StringProp object at 0x7fc334cd6590>, 'realm': <shinken.property.StringProp object at 0x7fc334cd6410>, 'contacts': <shinken.property.ListProp object at 0x7fc334625ad0>, 'notification_period': <shinken.property.StringProp object at 0x7fc334625c50>, 'trending_policies': <shinken.property.ListProp object at 0x7fc334cd6950>, 'resultmodulations': <shinken.property.ListProp object at 0x7fc334cd64d0>, 'retain_status_information': <shinken.property.BoolProp object at 0x7fc334625a10>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7fc334cd6790>, 'stalking_options': <shinken.property.ListProp object at 0x7fc334cd6110>, 'macromodulations': <shinken.property.ListProp object at 0x7fc334cd69d0>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7fc334625950>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7fc334cd67d0>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7fc334625910>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7fc334cd6b10>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7fc334625a50>, 'contact_groups': <shinken.property.ListProp object at 0x7fc334625b50>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7fc334cd6750>, 'address': <shinken.property.StringProp object at 0x7fc3346254d0>, 'trigger_name': <shinken.property.StringProp object at 0x7fc334cd68d0>, 'vrml_image': <shinken.property.StringProp object at 0x7fc334cd62d0>, '3d_coords': <shinken.property.StringProp object at 0x7fc334cd6390>, 'snapshot_command': <shinken.property.StringProp object at 0x7fc334cd6a90>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'checkmodulations': <shinken.property.ListProp object at 0x7fc334cd6990>, 'poller_tag': <shinken.property.StringProp object at 0x7fc334cd6450>, 'icon_set': <shinken.property.StringProp object at 0x7fc334cd6290>, 'business_impact': <shinken.property.IntegerProp object at 0x7fc334cd6850>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7fc334625610>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7fc334cd6810>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7fc334cd6710>}
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 0x7fc334cc8fd0>, 'child_dependencies': <shinken.property.StringProp object at 0x7fc334cc8e10>, 'last_time_unreachable': <shinken.property.IntegerProp object at 0x7fc334cc8150>, 'childs': <shinken.property.StringProp object at 0x7fc334cc8d90>, 'business_rule': <shinken.property.StringProp object at 0x7fc334cce110>, 'last_perf_data': <shinken.property.StringProp object at 0x7fc334cc8b90>, 'acknowledgement': <shinken.property.StringProp object at 0x7fc334cc8610>, 'actions': <shinken.property.StringProp object at 0x7fc334cc8d10>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7fc334cc88d0>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7fc334cc8750>, 's_time': <shinken.property.FloatProp object at 0x7fc334cc8850>, 'checks_in_progress': <shinken.property.StringProp object at 0x7fc334cc8450>, 'chk_depend_of': <shinken.property.ListProp object at 0x7fc334cc8310>, 'last_notification': <shinken.property.FloatProp object at 0x7fc334cc8890>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7fc334cc8390>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7fc334cc8950>, 'last_state': <shinken.property.StringProp object at 0x7fc334cd6ed0>, 'topology_change': <shinken.property.BoolProp object at 0x7fc334cce210>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7fc334cc8ed0>, 'impacts': <shinken.property.StringProp object at 0x7fc334cc8f50>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7fc334cd6fd0>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7fc334cce190>, 'parent_dependencies': <shinken.property.StringProp object at 0x7fc334cc8dd0>, 'percent_state_change': <shinken.property.FloatProp object at 0x7fc334cc8590>, 'notifications_in_progress': <shinken.property.StringProp object at 0x7fc334cc8490>, 'u_time': <shinken.property.FloatProp object at 0x7fc334cc8810>, 'last_state_id': <shinken.property.IntegerProp object at 0x7fc334cd6f10>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7fc334cc86d0>, 'broks': <shinken.property.StringProp object at 0x7fc334cc8d50>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7fc334cc89d0>, 'last_state_update': <shinken.property.StringProp object at 0x7fc334cc83d0>, 'execution_time': <shinken.property.FloatProp object at 0x7fc334cc87d0>, 'start_time': <shinken.property.IntegerProp object at 0x7fc334cc8a50>, 'flapping_changes': <shinken.property.StringProp object at 0x7fc334cc8550>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'notified_contacts': <shinken.property.StringProp object at 0x7fc334cc8c50>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7fc334cc8290>, 'early_timeout': <shinken.property.IntegerProp object at 0x7fc334cc8ad0>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7fc334cc8c90>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7fc334cc8350>, 'state_type_id': <shinken.property.IntegerProp object at 0x7fc334cd6e10>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7fc334cc8990>, 'in_checking': <shinken.property.BoolProp object at 0x7fc334cd6c50>, 'last_state_change': <shinken.property.FloatProp object at 0x7fc334cd6f90>, 'long_output': <shinken.property.StringProp object at 0x7fc334cc8210>, 'duration_sec': <shinken.property.IntegerProp object at 0x7fc334cc8190>, 'end_time': <shinken.property.IntegerProp object at 0x7fc334cc8a90>, 'timeout': <shinken.property.IntegerProp object at 0x7fc334cc8a10>, 'output': <shinken.property.StringProp object at 0x7fc334cc81d0>, 'perf_data': <shinken.property.StringProp object at 0x7fc334cc8b50>, 'state_before_impact': <shinken.property.StringProp object at 0x7fc334cc8f90>, 'is_impact': <shinken.property.StringProp object at 0x7fc334cc8e90>, 'check_type': <shinken.property.IntegerProp object at 0x7fc334cc8690>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7fc334cc8cd0>, 'source_problems': <shinken.property.StringProp object at 0x7fc334cc8f10>, 'last_event_id': <shinken.property.IntegerProp object at 0x7fc334cd6e90>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7fc334cce150>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7fc334cc85d0>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7fc334cc8710>, 'latency': <shinken.property.FloatProp object at 0x7fc334cd6cd0>, 'state_changed_since_impact': <shinken.property.StringProp object at 0x7fc334cce050>, 'current_event_id': <shinken.property.StringProp object at 0x7fc334cd6e50>, 'last_state_type': <shinken.property.StringProp object at 0x7fc334cd6f50>, 'downtimes': <shinken.property.StringProp object at 0x7fc334cc84d0>, 'last_time_up': <shinken.property.IntegerProp object at 0x7fc334cc80d0>, 'last_hard_state': <shinken.property.StringProp object at 0x7fc334cc8050>, 'next_chk': <shinken.property.IntegerProp object at 0x7fc334cd6c10>, 'processed_business_rule': <shinken.property.StringProp object at 0x7fc334cce0d0>, 'comments': <shinken.property.StringProp object at 0x7fc334cc8510>, 'last_check_command': <shinken.property.StringProp object at 0x7fc334cce310>, 'state': <shinken.property.StringProp object at 0x7fc334cd6d50>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7fc334cc8790>, 'last_chk': <shinken.property.IntegerProp object at 0x7fc334cd6bd0>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7fc334cc8910>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7fc334cce2d0>, 'is_problem': <shinken.property.StringProp object at 0x7fc334cc8e50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>, 'pack_id': <shinken.property.IntegerProp object at 0x7fc334cce250>, 'return_code': <shinken.property.IntegerProp object at 0x7fc334cc8b10>, 'is_flapping': <shinken.property.BoolProp object at 0x7fc334cc8250>, 'customs': <shinken.property.StringProp object at 0x7fc334cc8bd0>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7fc334cce1d0>, 'got_default_realm': <shinken.property.BoolProp object at 0x7fc334cc8c10>, 'state_id': <shinken.property.IntegerProp object at 0x7fc334cd6d90>, 'services': <shinken.property.StringProp object at 0x7fc334cc8410>, 'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'state_type': <shinken.property.StringProp object at 0x7fc334cd6dd0>, 'attempt': <shinken.property.IntegerProp object at 0x7fc334cd6d10>, 'act_depend_of': <shinken.property.ListProp object at 0x7fc334cc82d0>, 'triggers': <shinken.property.StringProp object at 0x7fc334cce290>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7fc334cc8650>, 'last_time_down': <shinken.property.IntegerProp object at 0x7fc334cc8110>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7fc334cd6b90>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7fc334cd6c90>, 'got_business_rule': <shinken.property.BoolProp object at 0x7fc334cce090>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7fc334cc8090>}
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 0x7fc333ce5a50>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7fc333ce5ad0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'dependency_period': <shinken.property.StringProp object at 0x7fc333ce5b10>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7fc333ce5a90>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'hostgroup_name': <shinken.property.StringProp object at 0x7fc333ce5a10>, 'dependent_host_name': <shinken.property.StringProp object at 0x7fc333ce5890>, 'host_name': <shinken.property.StringProp object at 0x7fc333ce59d0>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7fc333ce5990>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}

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 0x7fc3346a1ad0>, 'contact_groups': <shinken.property.StringProp object at 0x7fc3346251d0>, 'escalation_period': <shinken.property.StringProp object at 0x7fc334625110>, 'last_notification': <shinken.property.IntegerProp object at 0x7fc334625090>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'notification_interval': <shinken.property.IntegerProp object at 0x7fc3346250d0>, 'contacts': <shinken.property.StringProp object at 0x7fc334625190>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7fc334625250>, 'escalation_options': <shinken.property.ListProp object at 0x7fc334625150>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'hostgroup_name': <shinken.property.StringProp object at 0x7fc334622fd0>, 'host_name': <shinken.property.StringProp object at 0x7fc334622f10>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7fc334625210>, 'first_notification': <shinken.property.IntegerProp object at 0x7fc334625050>}
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 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'icon_image_alt': <shinken.property.StringProp object at 0x7fc3324b3290>, 'notes': <shinken.property.StringProp object at 0x7fc3324b3110>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'vrml_image': <shinken.property.StringProp object at 0x7fc3324b3310>, '3d_coords': <shinken.property.StringProp object at 0x7fc3324b3490>, 'notes_url': <shinken.property.StringProp object at 0x7fc3324b3190>, 'host_name': <shinken.property.StringProp object at 0x7fc3324b30d0>, 'icon_image': <shinken.property.StringProp object at 0x7fc3324b3210>, '2d_coords': <shinken.property.StringProp object at 0x7fc3324b3410>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'statusmap_image': <shinken.property.StringProp object at 0x7fc3324b33d0>}
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 0x7fc3346a17d0>, 'hostgroup_name': <shinken.property.StringProp object at 0x7fc334ccebd0>, 'realm': <shinken.property.StringProp object at 0x7fc334cced10>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'alias': <shinken.property.StringProp object at 0x7fc334ccec10>, 'notes': <shinken.property.StringProp object at 0x7fc334ccec50>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'unknown_members': <shinken.property.ListProp object at 0x7fc334cceb10>, 'action_url': <shinken.property.StringProp object at 0x7fc334ccecd0>, 'notes_url': <shinken.property.StringProp object at 0x7fc334ccec90>, 'members': <shinken.property.ListProp object at 0x7fc334ccea90>, 'id': <shinken.property.IntegerProp object at 0x7fc334cceb90>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
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 0x7fc3346a1ad0>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc334ccea90>, 'unknown_members': <shinken.property.ListProp object at 0x7fc334cceb10>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
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 0x7fc333cf8c50>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'modulation_period': <shinken.property.StringProp object at 0x7fc333cf8f50>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'modules': <shinken.property.ListProp object at 0x7fc333ce5fd0>, 'module_type': <shinken.property.StringProp object at 0x7fc333ce5f90>, 'module_name': <shinken.property.StringProp object at 0x7fc333ce5f10>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
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 0x7fc3346a17d0>, 'host_notification_commands': <shinken.property.ListProp object at 0x7fc333ceab10>, 'notificationway_name': <shinken.property.StringProp object at 0x7fc333cea8d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7fc333cea950>, 'service_notification_options': <shinken.property.ListProp object at 0x7fc333ceaad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'service_notification_period': <shinken.property.StringProp object at 0x7fc333ceaa50>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7fc333ceab90>, 'host_notification_options': <shinken.property.ListProp object at 0x7fc333ceaa90>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7fc333cea990>, 'host_notification_period': <shinken.property.StringProp object at 0x7fc333cea9d0>, 'service_notification_commands': <shinken.property.ListProp object at 0x7fc333ceab50>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'pack_name': <shinken.property.StringProp object at 0x7fc3324b3810>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'macros': <shinken.property.StringProp object at 0x7fc3324b3890>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc333cf4410>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'realm_members': <shinken.property.ListProp object at 0x7fc333cf43d0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'realm_name': <shinken.property.StringProp object at 0x7fc333cf4390>, 'unknown_members': <shinken.property.ListProp object at 0x7fc334cceb10>, 'default': <shinken.property.BoolProp object at 0x7fc333cf4450>, 'broker_complete_links': <shinken.property.BoolProp object at 0x7fc333cf4490>, 'members': <shinken.property.ListProp object at 0x7fc334ccea90>, 'id': <shinken.property.IntegerProp object at 0x7fc333cf4310>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'serialized_confs': <shinken.property.DictProp object at 0x7fc333cf44d0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc3346a17d0>, 'resultmodulation_name': <shinken.property.StringProp object at 0x7fc3346221d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'modulation_period': <shinken.property.StringProp object at 0x7fc334622410>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'exit_code_modulation': <shinken.property.IntegerProp object at 0x7fc3346223d0>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'exit_codes_match': <shinken.property.IntListProp object at 0x7fc3346222d0>}
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 0x7fc333d34b10>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7fc334da8e50>, 'retry_interval': <shinken.property.IntegerProp object at 0x7fc333d34dd0>, 'labels': <shinken.property.ListProp object at 0x7fc334da8f90>, 'obsess_over_service': <shinken.property.BoolProp object at 0x7fc333d34f50>, 'action_url': <shinken.property.StringProp object at 0x7fc334da8c10>, 'escalations': <shinken.property.ListProp object at 0x7fc334da8e90>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7fc33419a390>, 'process_perf_data': <shinken.property.BoolProp object at 0x7fc334da88d0>, 'icon_image': <shinken.property.StringProp object at 0x7fc334da8c50>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7fc3345f1590>, 'check_period': <shinken.property.StringProp object at 0x7fc333d34f10>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'display_name': <shinken.property.StringProp object at 0x7fc333d34b90>, 'notification_interval': <shinken.property.IntegerProp object at 0x7fc334da8990>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7fc334da8d10>, 'flap_detection_options': <shinken.property.ListProp object at 0x7fc334da8890>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7fc3345f1490>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7fc33419a150>, 'trigger': <shinken.property.StringProp object at 0x7fc3345f1290>, 'initial_state': <shinken.property.CharProp object at 0x7fc333d34cd0>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7fc334da89d0>, 'notification_options': <shinken.property.ListProp object at 0x7fc334da8a50>, 'host_name': <shinken.property.StringProp object at 0x7fc333d34a50>, 'snapshot_period': <shinken.property.StringProp object at 0x7fc3345f1510>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7fc334da8a90>, 'event_handler': <shinken.property.StringProp object at 0x7fc33419a050>, 'aggregation': <shinken.property.StringProp object at 0x7fc3345f1450>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7fc333d34fd0>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7fc334da8f10>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7fc3345f1310>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'notes': <shinken.property.StringProp object at 0x7fc334da8b90>, 'check_command': <shinken.property.StringProp object at 0x7fc333d34c90>, 'parallelize_check': <shinken.property.BoolProp object at 0x7fc334da8d50>, 'servicegroups': <shinken.property.ListProp object at 0x7fc333d34c10>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7fc333d34ed0>, 'check_interval': <shinken.property.IntegerProp object at 0x7fc333d34d50>, 'merge_host_contacts': <shinken.property.BoolProp object at 0x7fc334da8f50>, 'notes_url': <shinken.property.StringProp object at 0x7fc334da8bd0>, 'custom_views': <shinken.property.ListProp object at 0x7fc3345f1410>, 'check_freshness': <shinken.property.BoolProp object at 0x7fc333d34f90>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7fc333d34e50>, 'icon_image_alt': <shinken.property.StringProp object at 0x7fc334da8c90>, 'host_dependency_enabled': <shinken.property.BoolProp object at 0x7fc334da8fd0>, 'checkmodulations': <shinken.property.ListProp object at 0x7fc3345f1390>, 'reactionner_tag': <shinken.property.StringProp object at 0x7fc334da8dd0>, 'is_volatile': <shinken.property.BoolProp object at 0x7fc333d34c50>, 'default_value': <shinken.property.StringProp object at 0x7fc3345f1210>, 'maintenance_period': <shinken.property.StringProp object at 0x7fc334da8ed0>, 'contacts': <shinken.property.ListProp object at 0x7fc334da8ad0>, 'notification_period': <shinken.property.StringProp object at 0x7fc334da8a10>, 'trending_policies': <shinken.property.ListProp object at 0x7fc3345f1350>, 'resultmodulations': <shinken.property.ListProp object at 0x7fc334da8e10>, 'retain_status_information': <shinken.property.BoolProp object at 0x7fc334da8910>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7fc3345f10d0>, 'stalking_options': <shinken.property.ListProp object at 0x7fc334da8b50>, 'macromodulations': <shinken.property.ListProp object at 0x7fc3345f13d0>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7fc33419a950>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7fc3345f1110>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7fc33419a510>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7fc3345f1550>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7fc334da8950>, 'contact_groups': <shinken.property.ListProp object at 0x7fc334da8b10>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7fc3345f1090>, 'service_description': <shinken.property.StringProp object at 0x7fc333d34b50>, 'trigger_name': <shinken.property.StringProp object at 0x7fc3345f12d0>, 'service_dependencies': <shinken.property.ListProp object at 0x7fc3345f1190>, 'snapshot_command': <shinken.property.StringProp object at 0x7fc3345f14d0>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'duplicate_foreach': <shinken.property.StringProp object at 0x7fc3345f11d0>, 'poller_tag': <shinken.property.StringProp object at 0x7fc334da8d90>, 'icon_set': <shinken.property.StringProp object at 0x7fc334da8cd0>, 'business_impact': <shinken.property.IntegerProp object at 0x7fc3345f1250>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7fc333d34d10>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7fc3345f1150>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7fc3345f1050>}
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 0x7fc334600990>, 'child_dependencies': <shinken.property.StringProp object at 0x7fc334600b10>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7fc3346001d0>, 'business_rule': <shinken.property.StringProp object at 0x7fc334600a90>, 'last_perf_data': <shinken.property.StringProp object at 0x7fc334600610>, 'acknowledgement': <shinken.property.StringProp object at 0x7fc334600090>, 'actions': <shinken.property.ListProp object at 0x7fc334600790>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7fc334600350>, 'flapping_changes': <shinken.property.ListProp object at 0x7fc3345f1f50>, 'last_time_critical': <shinken.property.IntegerProp object at 0x7fc3345f1ad0>, 's_time': <shinken.property.FloatProp object at 0x7fc3346002d0>, 'last_time_warning': <shinken.property.IntegerProp object at 0x7fc3345f1a90>, 'checks_in_progress': <shinken.property.ListProp object at 0x7fc3345f1e10>, 'chk_depend_of': <shinken.property.ListProp object at 0x7fc3345f1d10>, 'last_notification': <shinken.property.FloatProp object at 0x7fc334600310>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7fc3345f1d90>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7fc3346003d0>, 'last_state': <shinken.property.StringProp object at 0x7fc3345f1890>, 'topology_change': <shinken.property.BoolProp object at 0x7fc334600c10>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7fc334600890>, 'impacts': <shinken.property.ListProp object at 0x7fc334600910>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7fc3345f1990>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7fc334600b90>, 'parent_dependencies': <shinken.property.StringProp object at 0x7fc334600ad0>, 'percent_state_change': <shinken.property.FloatProp object at 0x7fc3345f1fd0>, 'notifications_in_progress': <shinken.property.DictProp object at 0x7fc3345f1e50>, 'u_time': <shinken.property.FloatProp object at 0x7fc334600290>, 'last_state_id': <shinken.property.IntegerProp object at 0x7fc3345f1910>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7fc334600150>, 'broks': <shinken.property.ListProp object at 0x7fc3346007d0>, 'last_time_unknown': <shinken.property.IntegerProp object at 0x7fc3345f1b10>, 'last_state_update': <shinken.property.FloatProp object at 0x7fc3345f1dd0>, 'execution_time': <shinken.property.FloatProp object at 0x7fc334600250>, 'start_time': <shinken.property.IntegerProp object at 0x7fc3346004d0>, 'state_type': <shinken.property.StringProp object at 0x7fc3345f1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'notified_contacts': <shinken.property.ListProp object at 0x7fc3346006d0>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7fc3345f1f90>, 'early_timeout': <shinken.property.IntegerProp object at 0x7fc334600550>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7fc334600710>, 'state_type_id': <shinken.property.IntegerProp object at 0x7fc3345f1bd0>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7fc334600410>, 'in_checking': <shinken.property.BoolProp object at 0x7fc3345f1690>, 'last_state_change': <shinken.property.FloatProp object at 0x7fc3345f1950>, 'long_output': <shinken.property.StringProp object at 0x7fc3345f1c50>, 'duration_sec': <shinken.property.IntegerProp object at 0x7fc3345f1b50>, 'current_event_id': <shinken.property.IntegerProp object at 0x7fc3345f1810>, 'end_time': <shinken.property.IntegerProp object at 0x7fc334600510>, 'timeout': <shinken.property.IntegerProp object at 0x7fc334600490>, 'output': <shinken.property.StringProp object at 0x7fc3345f1c10>, 'perf_data': <shinken.property.StringProp object at 0x7fc3346005d0>, 'state_before_impact': <shinken.property.StringProp object at 0x7fc334600950>, 'is_impact': <shinken.property.BoolProp object at 0x7fc334600850>, 'check_type': <shinken.property.IntegerProp object at 0x7fc334600110>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7fc334600750>, 'source_problems': <shinken.property.ListProp object at 0x7fc3346008d0>, 'last_event_id': <shinken.property.IntegerProp object at 0x7fc3345f1850>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7fc334600b50>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7fc334600050>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7fc334600190>, 'latency': <shinken.property.FloatProp object at 0x7fc3345f1710>, 'state_changed_since_impact': <shinken.property.BoolProp object at 0x7fc3346009d0>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7fc334600450>, 'last_state_type': <shinken.property.StringProp object at 0x7fc3345f18d0>, 'downtimes': <shinken.property.ListProp object at 0x7fc3345f1ed0>, 'last_hard_state': <shinken.property.StringProp object at 0x7fc3345f19d0>, 'next_chk': <shinken.property.IntegerProp object at 0x7fc3345f1650>, 'processed_business_rule': <shinken.property.StringProp object at 0x7fc334600a50>, 'comments': <shinken.property.ListProp object at 0x7fc3345f1f10>, 'last_check_command': <shinken.property.StringProp object at 0x7fc334600cd0>, 'state': <shinken.property.StringProp object at 0x7fc3345f1790>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7fc334600210>, 'last_chk': <shinken.property.IntegerProp object at 0x7fc3345f1610>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7fc334600390>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7fc334600c90>, 'is_problem': <shinken.property.BoolProp object at 0x7fc334600810>, 'last_time_ok': <shinken.property.IntegerProp object at 0x7fc3345f1a50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>, 'return_code': <shinken.property.IntegerProp object at 0x7fc334600590>, 'is_flapping': <shinken.property.BoolProp object at 0x7fc3345f1c90>, 'customs': <shinken.property.DictProp object at 0x7fc334600690>, 'host': <shinken.property.StringProp object at 0x7fc334600650>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7fc334600bd0>, 'state_id': <shinken.property.IntegerProp object at 0x7fc3345f17d0>, 'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7fc3345f1d50>, 'attempt': <shinken.property.IntegerProp object at 0x7fc3345f1750>, 'act_depend_of': <shinken.property.ListProp object at 0x7fc3345f1cd0>, 'triggers': <shinken.property.ListProp object at 0x7fc334600c50>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7fc3346000d0>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7fc3345f15d0>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7fc3345f16d0>, 'got_business_rule': <shinken.property.BoolProp object at 0x7fc334600a10>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7fc3345f1a10>}
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 0x7fc333ce5710>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7fc333ce5790>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'explode_hostgroup': <shinken.property.BoolProp object at 0x7fc333ce5810>, 'dependent_host_name': <shinken.property.StringProp object at 0x7fc333ce5350>, 'service_description': <shinken.property.StringProp object at 0x7fc333ce56d0>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7fc333ce54d0>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'dependency_period': <shinken.property.StringProp object at 0x7fc333ce57d0>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7fc333ce5750>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'hostgroup_name': <shinken.property.StringProp object at 0x7fc333ce5690>, 'host_name': <shinken.property.StringProp object at 0x7fc333ce5650>, 'dependent_service_description': <shinken.property.StringProp object at 0x7fc333ce5610>}

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 0x7fc3346a1ad0>, 'contact_groups': <shinken.property.StringProp object at 0x7fc334622e10>, 'escalation_period': <shinken.property.StringProp object at 0x7fc334622d50>, 'service_description': <shinken.property.StringProp object at 0x7fc334622c50>, 'last_notification': <shinken.property.IntegerProp object at 0x7fc334622cd0>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'use': <shinken.property.ListProp object at 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'notification_interval': <shinken.property.IntegerProp object at 0x7fc334622d10>, 'contacts': <shinken.property.StringProp object at 0x7fc334622dd0>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7fc334622e90>, 'escalation_options': <shinken.property.ListProp object at 0x7fc334622d90>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'hostgroup_name': <shinken.property.StringProp object at 0x7fc334622c10>, 'host_name': <shinken.property.StringProp object at 0x7fc334622b90>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7fc334622e50>, 'first_notification': <shinken.property.IntegerProp object at 0x7fc334622c90>}
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 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'icon_image_alt': <shinken.property.StringProp object at 0x7fc3324b3650>, 'notes': <shinken.property.StringProp object at 0x7fc3324b3550>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'icon_image': <shinken.property.StringProp object at 0x7fc3324b3610>, 'notes_url': <shinken.property.StringProp object at 0x7fc3324b3590>, 'host_name': <shinken.property.StringProp object at 0x7fc3324b34d0>, 'service_description': <shinken.property.StringProp object at 0x7fc3324b3510>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
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 0x7fc3346a17d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'alias': <shinken.property.StringProp object at 0x7fc333ce51d0>, 'notes': <shinken.property.StringProp object at 0x7fc333ce5210>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'unknown_members': <shinken.property.ListProp object at 0x7fc334cceb10>, 'action_url': <shinken.property.StringProp object at 0x7fc333ce5290>, 'notes_url': <shinken.property.StringProp object at 0x7fc333ce5250>, 'members': <shinken.property.ListProp object at 0x7fc334ccea90>, 'id': <shinken.property.IntegerProp object at 0x7fc333ceaf50>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>, 'servicegroup_name': <shinken.property.StringProp object at 0x7fc333ce5190>}
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 0x7fc334756510>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'register': <shinken.property.IntegerProp object at 0x7fc334756550>, 'is_active': <shinken.property.BoolProp object at 0x7fc334756610>, 'dateranges': <shinken.property.ListProp object at 0x7fc334756590>, 'alias': <shinken.property.StringProp object at 0x7fc3347564d0>, 'timeperiod_name': <shinken.property.StringProp object at 0x7fc334756450>, 'exclude': <shinken.property.ListProp object at 0x7fc3347565d0>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
resolve_daterange(dateranges, entry)[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>}
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 0x7fc3346a17d0>, 'code_src': <shinken.property.StringProp object at 0x7fc333cf88d0>, 'name': <shinken.property.StringProp object at 0x7fc3346a19d0>, 'definition_order': <shinken.property.IntegerProp object at 0x7fc3346a1ad0>, 'trigger_name': <shinken.property.StringProp object at 0x7fc333cf8850>, 'register': <shinken.property.BoolProp object at 0x7fc3346a1b10>, 'imported_from': <shinken.property.StringProp object at 0x7fc3346a1a90>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7fc3346a1b90>, 'code_bin': <shinken.property.StringProp object at 0x7fc333cf8910>, 'configuration_warnings': <shinken.property.ListProp object at 0x7fc3346a1b50>, 'tags': <shinken.property.ListProp object at 0x7fc3346a1c10>, 'hash': <shinken.property.StringProp object at 0x7fc3346a1bd0>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7fc333cf8950>}
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'