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 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'modulation_period': <shinken.property.StringProp object at 0x7f58759cd1d0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'business_impact_modulation_name': <shinken.property.StringProp object at 0x7f58759cd110>, 'business_impact': <shinken.property.IntegerProp object at 0x7f58759cd190>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
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 0x7f5873d2d1d0>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'check_command': <shinken.property.StringProp object at 0x7f5873d2d290>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'checkmodulation_name': <shinken.property.StringProp object at 0x7f5873d2d310>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'command_line': <shinken.property.StringProp object at 0x7f5875fba610>, 'poller_tag': <shinken.property.StringProp object at 0x7f5875fba650>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f5875fba690>, 'module_type': <shinken.property.StringProp object at 0x7f5875fba6d0>, 'timeout': <shinken.property.IntegerProp object at 0x7f5875fba710>, 'enable_environment_macros': <shinken.property.BoolProp object at 0x7f5875fba750>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'command_name': <shinken.property.StringProp object at 0x7f5875fba590>}
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 0x7f587568a490>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'address1': <shinken.property.StringProp object at 0x7f587568a5d0>, 'address2': <shinken.property.StringProp object at 0x7f587568a610>, 'address3': <shinken.property.StringProp object at 0x7f587568a650>, 'address4': <shinken.property.StringProp object at 0x7f587568a690>, 'address5': <shinken.property.StringProp object at 0x7f587568a6d0>, 'address6': <shinken.property.StringProp object at 0x7f587568a710>, 'contactgroups': <shinken.property.ListProp object at 0x7f5875fe9e90>, 'is_admin': <shinken.property.BoolProp object at 0x7f587568a790>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f5875fe9f90>, 'can_submit_commands': <shinken.property.BoolProp object at 0x7f587568a750>, 'contact_name': <shinken.property.StringProp object at 0x7f5875fe9dd0>, 'password': <shinken.property.StringProp object at 0x7f587568a890>, 'pager': <shinken.property.StringProp object at 0x7f587568a590>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'notificationways': <shinken.property.ListProp object at 0x7f587568a850>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'service_notification_commands': <shinken.property.ListProp object at 0x7f587568a4d0>, 'host_notification_period': <shinken.property.StringProp object at 0x7f587568a350>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'expert': <shinken.property.BoolProp object at 0x7f587568a7d0>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f5875fe9ed0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'service_notification_period': <shinken.property.StringProp object at 0x7f587568a3d0>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f587568a510>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f587568a810>, 'email': <shinken.property.StringProp object at 0x7f587568a550>, 'alias': <shinken.property.StringProp object at 0x7f5875fe9e50>, 'service_notification_options': <shinken.property.ListProp object at 0x7f587568a450>, 'host_notification_options': <shinken.property.ListProp object at 0x7f587568a410>}
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 0x7f58756f7c10>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f587568a8d0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'downtimes': <shinken.property.StringProp object at 0x7f587568a910>}
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 0x7f58756f7b50>, 'unknown_members': <shinken.property.ListProp object at 0x7f5875fe9150>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'members': <shinken.property.ListProp object at 0x7f5875fe90d0>, 'alias': <shinken.property.StringProp object at 0x7f587568ad90>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'contactgroup_name': <shinken.property.StringProp object at 0x7f587568ad50>, 'id': <shinken.property.IntegerProp object at 0x7f587568ab90>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
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 0x7f58756f7850>, 'creation_type': <shinken.property.StringProp object at 0x7f58759d38d0>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'discoveryrule_order': <shinken.property.IntegerProp object at 0x7f58759d3910>, 'discoveryrule_name': <shinken.property.StringProp object at 0x7f58759d3690>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58759d3990>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58759d3950>}
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 0x7f58756f7850>, 'discoveryrun_command': <shinken.property.StringProp object at 0x7f58759d3c50>, 'discoveryrun_name': <shinken.property.StringProp object at 0x7f58759d3a50>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'current_launch': <shinken.property.StringProp object at 0x7f58759d3c90>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f58756f7850>, 'last_notification': <shinken.property.IntegerProp object at 0x7f5875fbad10>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'contacts': <shinken.property.ListProp object at 0x7f5875fb00d0>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f5875fbaf90>, 'escalation_options': <shinken.property.ListProp object at 0x7f5875fb0090>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'contact_groups': <shinken.property.ListProp object at 0x7f5875fb0110>, 'escalation_name': <shinken.property.StringProp object at 0x7f5875fbac10>, 'escalation_period': <shinken.property.StringProp object at 0x7f5875fb0050>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f5875fbaf50>, 'first_notification': <shinken.property.IntegerProp object at 0x7f5875fbacd0>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f5875fbafd0>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'time_based': <shinken.property.BoolProp object at 0x7f5875fb0150>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f5875fca910>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7f5875fcab10>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f5875fb0c90>, 'labels': <shinken.property.StringProp object at 0x7f5875fcacd0>, 'action_url': <shinken.property.StringProp object at 0x7f5875fca7d0>, 'escalations': <shinken.property.ListProp object at 0x7f5875fcab50>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f5875fb0ed0>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f5875fb0fd0>, '2d_coords': <shinken.property.StringProp object at 0x7f5875fca950>, 'icon_image': <shinken.property.StringProp object at 0x7f5875fca810>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7f5875f9c190>, 'check_period': <shinken.property.StringProp object at 0x7f5875fb0d50>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'display_name': <shinken.property.StringProp object at 0x7f5875fb0a90>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f5875b84210>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f5875fca9d0>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f5875fb0f90>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7f5875f9c090>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f5875fb0e90>, 'trigger': <shinken.property.StringProp object at 0x7f5875fcae90>, 'parents': <shinken.property.ListProp object at 0x7f5875fb0b10>, 'initial_state': <shinken.property.CharProp object at 0x7f5875fb0bd0>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f5875b84250>, 'notification_options': <shinken.property.ListProp object at 0x7f5875b842d0>, 'host_name': <shinken.property.StringProp object at 0x7f5875fb09d0>, 'snapshot_period': <shinken.property.StringProp object at 0x7f5875f9c110>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f5875b84310>, 'event_handler': <shinken.property.StringProp object at 0x7f5875fb0e50>, 'obsess_over_host': <shinken.property.BoolProp object at 0x7f5875fb0d90>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f5875fb0e10>, 'alias': <shinken.property.StringProp object at 0x7f5875fb0a50>, 'service_excludes': <shinken.property.ListProp object at 0x7f5875fcac50>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f5875fcabd0>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f5875fcaf10>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'custom_views': <shinken.property.ListProp object at 0x7f5875f9c050>, 'check_command': <shinken.property.StringProp object at 0x7f5875fb0b90>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f5875fb0d10>, 'check_interval': <shinken.property.IntegerProp object at 0x7f5875fb0c50>, 'notes': <shinken.property.StringProp object at 0x7f5875fca750>, 'check_freshness': <shinken.property.BoolProp object at 0x7f5875fb0dd0>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f5875fb0cd0>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f5875fca850>, 'service_includes': <shinken.property.ListProp object at 0x7f5875fcac90>, 'hostgroups': <shinken.property.ListProp object at 0x7f5875fb0b50>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f5875fcaa90>, 'notes_url': <shinken.property.StringProp object at 0x7f5875fca790>, 'service_overrides': <shinken.property.ListProp object at 0x7f5875fcac10>, 'maintenance_period': <shinken.property.StringProp object at 0x7f5875fcab90>, 'realm': <shinken.property.StringProp object at 0x7f5875fcaa10>, 'contacts': <shinken.property.ListProp object at 0x7f5875b84110>, 'notification_period': <shinken.property.StringProp object at 0x7f5875b84290>, 'trending_policies': <shinken.property.ListProp object at 0x7f5875fcaf50>, 'resultmodulations': <shinken.property.ListProp object at 0x7f5875fcaad0>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f5875b84050>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f5875fcad90>, 'stalking_options': <shinken.property.ListProp object at 0x7f5875fca710>, 'macromodulations': <shinken.property.ListProp object at 0x7f5875fcafd0>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f5875fb0f50>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f5875fcadd0>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f5875fb0f10>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7f5875f9c150>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f5875b84090>, 'contact_groups': <shinken.property.ListProp object at 0x7f5875b84190>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f5875fcad50>, 'address': <shinken.property.StringProp object at 0x7f5875fb0ad0>, 'trigger_name': <shinken.property.StringProp object at 0x7f5875fcaed0>, 'vrml_image': <shinken.property.StringProp object at 0x7f5875fca8d0>, '3d_coords': <shinken.property.StringProp object at 0x7f5875fca990>, 'snapshot_command': <shinken.property.StringProp object at 0x7f5875f9c0d0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'checkmodulations': <shinken.property.ListProp object at 0x7f5875fcaf90>, 'poller_tag': <shinken.property.StringProp object at 0x7f5875fcaa50>, 'icon_set': <shinken.property.StringProp object at 0x7f5875fca890>, 'business_impact': <shinken.property.IntegerProp object at 0x7f5875fcae50>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f5875fb0c10>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f5875fcae10>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f5875fcad10>}
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 0x7f587600b610>, 'child_dependencies': <shinken.property.StringProp object at 0x7f587600b450>, 'last_time_unreachable': <shinken.property.IntegerProp object at 0x7f5875f9c750>, 'childs': <shinken.property.StringProp object at 0x7f587600b3d0>, 'business_rule': <shinken.property.StringProp object at 0x7f587600b710>, 'last_perf_data': <shinken.property.StringProp object at 0x7f587600b1d0>, 'acknowledgement': <shinken.property.StringProp object at 0x7f5875f9cc10>, 'actions': <shinken.property.StringProp object at 0x7f587600b350>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f5875f9ced0>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f5875f9cd50>, 's_time': <shinken.property.FloatProp object at 0x7f5875f9ce50>, 'checks_in_progress': <shinken.property.StringProp object at 0x7f5875f9ca50>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f5875f9c910>, 'last_notification': <shinken.property.FloatProp object at 0x7f5875f9ce90>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f5875f9c990>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f5875f9cf50>, 'last_state': <shinken.property.StringProp object at 0x7f5875f9c510>, 'topology_change': <shinken.property.BoolProp object at 0x7f587600b810>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f587600b510>, 'impacts': <shinken.property.StringProp object at 0x7f587600b590>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f5875f9c610>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f587600b790>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f587600b410>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f5875f9cb90>, 'notifications_in_progress': <shinken.property.StringProp object at 0x7f5875f9ca90>, 'u_time': <shinken.property.FloatProp object at 0x7f5875f9ce10>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f5875f9c550>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f5875f9ccd0>, 'broks': <shinken.property.StringProp object at 0x7f587600b390>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f5875f9cfd0>, 'last_state_update': <shinken.property.StringProp object at 0x7f5875f9c9d0>, 'execution_time': <shinken.property.FloatProp object at 0x7f5875f9cdd0>, 'start_time': <shinken.property.IntegerProp object at 0x7f587600b090>, 'flapping_changes': <shinken.property.StringProp object at 0x7f5875f9cb50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'notified_contacts': <shinken.property.StringProp object at 0x7f587600b290>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f5875f9c890>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f587600b110>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f587600b2d0>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f5875f9c950>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f5875f9c450>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f5875f9cf90>, 'in_checking': <shinken.property.BoolProp object at 0x7f5875f9c290>, 'last_state_change': <shinken.property.FloatProp object at 0x7f5875f9c5d0>, 'long_output': <shinken.property.StringProp object at 0x7f5875f9c810>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f5875f9c790>, 'end_time': <shinken.property.IntegerProp object at 0x7f587600b0d0>, 'timeout': <shinken.property.IntegerProp object at 0x7f587600b050>, 'output': <shinken.property.StringProp object at 0x7f5875f9c7d0>, 'perf_data': <shinken.property.StringProp object at 0x7f587600b190>, 'state_before_impact': <shinken.property.StringProp object at 0x7f587600b5d0>, 'is_impact': <shinken.property.StringProp object at 0x7f587600b4d0>, 'check_type': <shinken.property.IntegerProp object at 0x7f5875f9cc90>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f587600b310>, 'source_problems': <shinken.property.StringProp object at 0x7f587600b550>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f5875f9c4d0>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f587600b750>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f5875f9cbd0>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f5875f9cd10>, 'latency': <shinken.property.FloatProp object at 0x7f5875f9c310>, 'state_changed_since_impact': <shinken.property.StringProp object at 0x7f587600b650>, 'current_event_id': <shinken.property.StringProp object at 0x7f5875f9c490>, 'last_state_type': <shinken.property.StringProp object at 0x7f5875f9c590>, 'downtimes': <shinken.property.StringProp object at 0x7f5875f9cad0>, 'last_time_up': <shinken.property.IntegerProp object at 0x7f5875f9c6d0>, 'last_hard_state': <shinken.property.StringProp object at 0x7f5875f9c650>, 'next_chk': <shinken.property.IntegerProp object at 0x7f5875f9c250>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f587600b6d0>, 'comments': <shinken.property.StringProp object at 0x7f5875f9cb10>, 'last_check_command': <shinken.property.StringProp object at 0x7f587600b910>, 'state': <shinken.property.StringProp object at 0x7f5875f9c390>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f5875f9cd90>, 'last_chk': <shinken.property.IntegerProp object at 0x7f5875f9c210>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f5875f9cf10>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7f587600b8d0>, 'is_problem': <shinken.property.StringProp object at 0x7f587600b490>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>, 'pack_id': <shinken.property.IntegerProp object at 0x7f587600b850>, 'return_code': <shinken.property.IntegerProp object at 0x7f587600b150>, 'is_flapping': <shinken.property.BoolProp object at 0x7f5875f9c850>, 'customs': <shinken.property.StringProp object at 0x7f587600b210>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f587600b7d0>, 'got_default_realm': <shinken.property.BoolProp object at 0x7f587600b250>, 'state_id': <shinken.property.IntegerProp object at 0x7f5875f9c3d0>, 'services': <shinken.property.StringProp object at 0x7f5875f9ca10>, 'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'state_type': <shinken.property.StringProp object at 0x7f5875f9c410>, 'attempt': <shinken.property.IntegerProp object at 0x7f5875f9c350>, 'act_depend_of': <shinken.property.ListProp object at 0x7f5875f9c8d0>, 'triggers': <shinken.property.StringProp object at 0x7f587600b890>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f5875f9cc50>, 'last_time_down': <shinken.property.IntegerProp object at 0x7f5875f9c710>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f5875f9c1d0>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f5875f9c2d0>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f587600b690>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f5875f9c690>}
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 0x7f58759d3090>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f58759d3110>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'dependency_period': <shinken.property.StringProp object at 0x7f58759d3150>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f58759d30d0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f58759d3050>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f587567ae90>, 'host_name': <shinken.property.StringProp object at 0x7f587567afd0>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f587567af90>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}

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 0x7f58756f7b50>, 'contact_groups': <shinken.property.StringProp object at 0x7f5875fb07d0>, 'escalation_period': <shinken.property.StringProp object at 0x7f5875fb0710>, 'last_notification': <shinken.property.IntegerProp object at 0x7f5875fb0690>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f5875fb06d0>, 'contacts': <shinken.property.StringProp object at 0x7f5875fb0790>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f5875fb0850>, 'escalation_options': <shinken.property.ListProp object at 0x7f5875fb0750>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f5875fb0610>, 'host_name': <shinken.property.StringProp object at 0x7f5875fb0550>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f5875fb0810>, 'first_notification': <shinken.property.IntegerProp object at 0x7f5875fb0650>}
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 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f5873dd6110>, 'notes': <shinken.property.StringProp object at 0x7f5873dd6450>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'vrml_image': <shinken.property.StringProp object at 0x7f5873dd6390>, '3d_coords': <shinken.property.StringProp object at 0x7f5873dd66d0>, 'notes_url': <shinken.property.StringProp object at 0x7f5873dd64d0>, 'host_name': <shinken.property.StringProp object at 0x7f5873dd6410>, 'icon_image': <shinken.property.StringProp object at 0x7f5873dd6550>, '2d_coords': <shinken.property.StringProp object at 0x7f5873dd6090>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'statusmap_image': <shinken.property.StringProp object at 0x7f5873dd6310>}
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 0x7f58756f7850>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f5875fe9210>, 'realm': <shinken.property.StringProp object at 0x7f5875fe9350>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'alias': <shinken.property.StringProp object at 0x7f5875fe9250>, 'notes': <shinken.property.StringProp object at 0x7f5875fe9290>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'unknown_members': <shinken.property.ListProp object at 0x7f5875fe9150>, 'action_url': <shinken.property.StringProp object at 0x7f5875fe9310>, 'notes_url': <shinken.property.StringProp object at 0x7f5875fe92d0>, 'members': <shinken.property.ListProp object at 0x7f5875fe90d0>, 'id': <shinken.property.IntegerProp object at 0x7f5875fe91d0>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
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 0x7f58756f7b50>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f5875fe90d0>, 'unknown_members': <shinken.property.ListProp object at 0x7f5875fe9150>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
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 0x7f58759cd290>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'modulation_period': <shinken.property.StringProp object at 0x7f58759cd590>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'modules': <shinken.property.ListProp object at 0x7f58759d3610>, 'module_type': <shinken.property.StringProp object at 0x7f58759d35d0>, 'module_name': <shinken.property.StringProp object at 0x7f58759d3550>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
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 0x7f58756f7850>, 'host_notification_commands': <shinken.property.ListProp object at 0x7f587567a150>, 'notificationway_name': <shinken.property.StringProp object at 0x7f587568aed0>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'host_notifications_enabled': <shinken.property.BoolProp object at 0x7f587568af50>, 'service_notification_options': <shinken.property.ListProp object at 0x7f587567a110>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'service_notification_period': <shinken.property.StringProp object at 0x7f587567a090>, 'min_business_impact': <shinken.property.IntegerProp object at 0x7f587567a1d0>, 'host_notification_options': <shinken.property.ListProp object at 0x7f587567a0d0>, 'service_notifications_enabled': <shinken.property.BoolProp object at 0x7f587568af90>, 'host_notification_period': <shinken.property.StringProp object at 0x7f587568afd0>, 'service_notification_commands': <shinken.property.ListProp object at 0x7f587567a190>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'pack_name': <shinken.property.StringProp object at 0x7f5873dd6a90>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'macros': <shinken.property.StringProp object at 0x7f5873dd6b50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f5875fe9a10>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'realm_members': <shinken.property.ListProp object at 0x7f5875fe99d0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'realm_name': <shinken.property.StringProp object at 0x7f5875fe9990>, 'unknown_members': <shinken.property.ListProp object at 0x7f5875fe9150>, 'default': <shinken.property.BoolProp object at 0x7f5875fe9a50>, 'broker_complete_links': <shinken.property.BoolProp object at 0x7f5875fe9a90>, 'members': <shinken.property.ListProp object at 0x7f5875fe90d0>, 'id': <shinken.property.IntegerProp object at 0x7f5875fe9910>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'serialized_confs': <shinken.property.DictProp object at 0x7f5875fe9ad0>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f58756f7850>, 'resultmodulation_name': <shinken.property.StringProp object at 0x7f5875fba7d0>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'modulation_period': <shinken.property.StringProp object at 0x7f5875fbaa10>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'exit_code_modulation': <shinken.property.IntegerProp object at 0x7f5875fba9d0>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'exit_codes_match': <shinken.property.IntListProp object at 0x7f5875fba8d0>}
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 0x7f5875a0bad0>, 'business_impact_modulations': <shinken.property.ListProp object at 0x7f5875fa6490>, 'retry_interval': <shinken.property.IntegerProp object at 0x7f58760db410>, 'labels': <shinken.property.ListProp object at 0x7f5875fa65d0>, 'obsess_over_service': <shinken.property.BoolProp object at 0x7f58760db590>, 'action_url': <shinken.property.StringProp object at 0x7f5875fa6250>, 'escalations': <shinken.property.ListProp object at 0x7f5875fa64d0>, 'low_flap_threshold': <shinken.property.IntegerProp object at 0x7f58760db990>, 'process_perf_data': <shinken.property.BoolProp object at 0x7f587620ded0>, 'icon_image': <shinken.property.StringProp object at 0x7f5875fa6290>, 'snapshot_interval': <shinken.property.IntegerProp object at 0x7f5875fa6b90>, 'check_period': <shinken.property.StringProp object at 0x7f58760db550>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'display_name': <shinken.property.StringProp object at 0x7f5875902350>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f587620df90>, 'failure_prediction_enabled': <shinken.property.BoolProp object at 0x7f5875fa6350>, 'flap_detection_options': <shinken.property.ListProp object at 0x7f587620de90>, 'snapshot_enabled': <shinken.property.BoolProp object at 0x7f5875fa6a90>, 'event_handler_enabled': <shinken.property.BoolProp object at 0x7f58760db750>, 'trigger': <shinken.property.StringProp object at 0x7f5875fa6890>, 'initial_state': <shinken.property.CharProp object at 0x7f58760db310>, 'first_notification_delay': <shinken.property.IntegerProp object at 0x7f587620dfd0>, 'notification_options': <shinken.property.ListProp object at 0x7f5875fa6090>, 'host_name': <shinken.property.StringProp object at 0x7f5875a0b5d0>, 'snapshot_period': <shinken.property.StringProp object at 0x7f5875fa6b10>, 'notifications_enabled': <shinken.property.BoolProp object at 0x7f5875fa60d0>, 'event_handler': <shinken.property.StringProp object at 0x7f58760db650>, 'aggregation': <shinken.property.StringProp object at 0x7f5875fa6a50>, 'freshness_threshold': <shinken.property.IntegerProp object at 0x7f58760db610>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'time_to_orphanage': <shinken.property.IntegerProp object at 0x7f5875fa6550>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f5875fa6910>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'notes': <shinken.property.StringProp object at 0x7f5875fa61d0>, 'check_command': <shinken.property.StringProp object at 0x7f58760db2d0>, 'parallelize_check': <shinken.property.BoolProp object at 0x7f5875fa6390>, 'servicegroups': <shinken.property.ListProp object at 0x7f58760db250>, 'passive_checks_enabled': <shinken.property.BoolProp object at 0x7f58760db510>, 'check_interval': <shinken.property.IntegerProp object at 0x7f58760db390>, 'merge_host_contacts': <shinken.property.BoolProp object at 0x7f5875fa6590>, 'notes_url': <shinken.property.StringProp object at 0x7f5875fa6210>, 'custom_views': <shinken.property.ListProp object at 0x7f5875fa6a10>, 'check_freshness': <shinken.property.BoolProp object at 0x7f58760db5d0>, 'active_checks_enabled': <shinken.property.BoolProp object at 0x7f58760db490>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f5875fa62d0>, 'host_dependency_enabled': <shinken.property.BoolProp object at 0x7f5875fa6610>, 'checkmodulations': <shinken.property.ListProp object at 0x7f5875fa6990>, 'reactionner_tag': <shinken.property.StringProp object at 0x7f5875fa6410>, 'is_volatile': <shinken.property.BoolProp object at 0x7f58760db290>, 'default_value': <shinken.property.StringProp object at 0x7f5875fa6810>, 'maintenance_period': <shinken.property.StringProp object at 0x7f5875fa6510>, 'contacts': <shinken.property.ListProp object at 0x7f5875fa6110>, 'notification_period': <shinken.property.StringProp object at 0x7f5875fa6050>, 'trending_policies': <shinken.property.ListProp object at 0x7f5875fa6950>, 'resultmodulations': <shinken.property.ListProp object at 0x7f5875fa6450>, 'retain_status_information': <shinken.property.BoolProp object at 0x7f587620df10>, 'business_rule_downtime_as_ack': <shinken.property.BoolProp object at 0x7f5875fa66d0>, 'stalking_options': <shinken.property.ListProp object at 0x7f5875fa6190>, 'macromodulations': <shinken.property.ListProp object at 0x7f5875fa69d0>, 'flap_detection_enabled': <shinken.property.BoolProp object at 0x7f58760dbf50>, 'business_rule_host_notification_options': <shinken.property.ListProp object at 0x7f5875fa6710>, 'high_flap_threshold': <shinken.property.IntegerProp object at 0x7f58760dbb10>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'snapshot_criteria': <shinken.property.ListProp object at 0x7f5875fa6b50>, 'retain_nonstatus_information': <shinken.property.BoolProp object at 0x7f587620df50>, 'contact_groups': <shinken.property.ListProp object at 0x7f5875fa6150>, 'business_rule_smart_notifications': <shinken.property.BoolProp object at 0x7f5875fa6690>, 'service_description': <shinken.property.StringProp object at 0x7f5875a0bc10>, 'trigger_name': <shinken.property.StringProp object at 0x7f5875fa68d0>, 'service_dependencies': <shinken.property.ListProp object at 0x7f5875fa6790>, 'snapshot_command': <shinken.property.StringProp object at 0x7f5875fa6ad0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'duplicate_foreach': <shinken.property.StringProp object at 0x7f5875fa67d0>, 'poller_tag': <shinken.property.StringProp object at 0x7f5875fa63d0>, 'icon_set': <shinken.property.StringProp object at 0x7f5875fa6310>, 'business_impact': <shinken.property.IntegerProp object at 0x7f5875fa6850>, 'max_check_attempts': <shinken.property.IntegerProp object at 0x7f58760db350>, 'business_rule_service_notification_options': <shinken.property.ListProp object at 0x7f5875fa6750>, 'business_rule_output_template': <shinken.property.StringProp object at 0x7f5875fa6650>}
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 0x7f5875f9ff90>, 'child_dependencies': <shinken.property.StringProp object at 0x7f5875fba150>, 'last_problem_id': <shinken.property.IntegerProp object at 0x7f5875f9f7d0>, 'business_rule': <shinken.property.StringProp object at 0x7f5875fba0d0>, 'last_perf_data': <shinken.property.StringProp object at 0x7f5875f9fc10>, 'acknowledgement': <shinken.property.StringProp object at 0x7f5875f9f690>, 'actions': <shinken.property.ListProp object at 0x7f5875f9fd90>, 'current_notification_number': <shinken.property.IntegerProp object at 0x7f5875f9f950>, 'flapping_changes': <shinken.property.ListProp object at 0x7f5875f9f590>, 'last_time_critical': <shinken.property.IntegerProp object at 0x7f5875f9f110>, 's_time': <shinken.property.FloatProp object at 0x7f5875f9f8d0>, 'last_time_warning': <shinken.property.IntegerProp object at 0x7f5875f9f0d0>, 'checks_in_progress': <shinken.property.ListProp object at 0x7f5875f9f450>, 'chk_depend_of': <shinken.property.ListProp object at 0x7f5875f9f350>, 'last_notification': <shinken.property.FloatProp object at 0x7f5875f9f910>, 'chk_depend_of_me': <shinken.property.ListProp object at 0x7f5875f9f3d0>, 'check_flapping_recovery_notification': <shinken.property.BoolProp object at 0x7f5875f9f9d0>, 'last_state': <shinken.property.StringProp object at 0x7f5875fa6e90>, 'topology_change': <shinken.property.BoolProp object at 0x7f5875fba250>, 'my_own_business_impact': <shinken.property.IntegerProp object at 0x7f5875f9fe90>, 'impacts': <shinken.property.ListProp object at 0x7f5875f9ff10>, 'last_hard_state_change': <shinken.property.FloatProp object at 0x7f5875fa6f90>, 'was_in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f5875fba1d0>, 'parent_dependencies': <shinken.property.StringProp object at 0x7f5875fba110>, 'percent_state_change': <shinken.property.FloatProp object at 0x7f5875f9f610>, 'notifications_in_progress': <shinken.property.DictProp object at 0x7f5875f9f490>, 'u_time': <shinken.property.FloatProp object at 0x7f5875f9f890>, 'last_state_id': <shinken.property.IntegerProp object at 0x7f5875fa6f10>, 'has_been_checked': <shinken.property.IntegerProp object at 0x7f5875f9f750>, 'broks': <shinken.property.ListProp object at 0x7f5875f9fdd0>, 'last_time_unknown': <shinken.property.IntegerProp object at 0x7f5875f9f150>, 'last_state_update': <shinken.property.FloatProp object at 0x7f5875f9f410>, 'execution_time': <shinken.property.FloatProp object at 0x7f5875f9f850>, 'start_time': <shinken.property.IntegerProp object at 0x7f5875f9fad0>, 'state_type': <shinken.property.StringProp object at 0x7f5875f9f1d0>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'notified_contacts': <shinken.property.ListProp object at 0x7f5875f9fcd0>, 'flapping_comment_id': <shinken.property.IntegerProp object at 0x7f5875f9f5d0>, 'early_timeout': <shinken.property.IntegerProp object at 0x7f5875f9fb50>, 'in_scheduled_downtime': <shinken.property.BoolProp object at 0x7f5875f9fd10>, 'state_type_id': <shinken.property.IntegerProp object at 0x7f5875f9f210>, 'scheduled_downtime_depth': <shinken.property.IntegerProp object at 0x7f5875f9fa10>, 'in_checking': <shinken.property.BoolProp object at 0x7f5875fa6c90>, 'last_state_change': <shinken.property.FloatProp object at 0x7f5875fa6f50>, 'long_output': <shinken.property.StringProp object at 0x7f5875f9f290>, 'duration_sec': <shinken.property.IntegerProp object at 0x7f5875f9f190>, 'current_event_id': <shinken.property.IntegerProp object at 0x7f5875fa6e10>, 'end_time': <shinken.property.IntegerProp object at 0x7f5875f9fb10>, 'timeout': <shinken.property.IntegerProp object at 0x7f5875f9fa90>, 'output': <shinken.property.StringProp object at 0x7f5875f9f250>, 'perf_data': <shinken.property.StringProp object at 0x7f5875f9fbd0>, 'state_before_impact': <shinken.property.StringProp object at 0x7f5875f9ff50>, 'is_impact': <shinken.property.BoolProp object at 0x7f5875f9fe50>, 'check_type': <shinken.property.IntegerProp object at 0x7f5875f9f710>, 'in_scheduled_downtime_during_last_check': <shinken.property.BoolProp object at 0x7f5875f9fd50>, 'source_problems': <shinken.property.ListProp object at 0x7f5875f9fed0>, 'last_event_id': <shinken.property.IntegerProp object at 0x7f5875fa6e50>, 'in_hard_unknown_reach_phase': <shinken.property.BoolProp object at 0x7f5875fba190>, 'problem_has_been_acknowledged': <shinken.property.BoolProp object at 0x7f5875f9f650>, 'should_be_scheduled': <shinken.property.IntegerProp object at 0x7f5875f9f790>, 'latency': <shinken.property.FloatProp object at 0x7f5875fa6d10>, 'state_changed_since_impact': <shinken.property.BoolProp object at 0x7f5875f9ffd0>, 'pending_flex_downtime': <shinken.property.IntegerProp object at 0x7f5875f9fa50>, 'last_state_type': <shinken.property.StringProp object at 0x7f5875fa6ed0>, 'downtimes': <shinken.property.ListProp object at 0x7f5875f9f510>, 'last_hard_state': <shinken.property.StringProp object at 0x7f5875fa6fd0>, 'next_chk': <shinken.property.IntegerProp object at 0x7f5875fa6c50>, 'processed_business_rule': <shinken.property.StringProp object at 0x7f5875fba090>, 'comments': <shinken.property.ListProp object at 0x7f5875f9f550>, 'last_check_command': <shinken.property.StringProp object at 0x7f5875fba310>, 'state': <shinken.property.StringProp object at 0x7f5875fa6d90>, 'current_problem_id': <shinken.property.IntegerProp object at 0x7f5875f9f810>, 'last_chk': <shinken.property.IntegerProp object at 0x7f5875fa6c10>, 'current_notification_id': <shinken.property.IntegerProp object at 0x7f5875f9f990>, 'last_snapshot': <shinken.property.IntegerProp object at 0x7f5875fba2d0>, 'is_problem': <shinken.property.BoolProp object at 0x7f5875f9fe10>, 'last_time_ok': <shinken.property.IntegerProp object at 0x7f5875f9f090>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>, 'return_code': <shinken.property.IntegerProp object at 0x7f5875f9fb90>, 'is_flapping': <shinken.property.BoolProp object at 0x7f5875f9f2d0>, 'customs': <shinken.property.DictProp object at 0x7f5875f9fc90>, 'host': <shinken.property.StringProp object at 0x7f5875f9fc50>, 'state_before_hard_unknown_reach_phase': <shinken.property.StringProp object at 0x7f5875fba210>, 'state_id': <shinken.property.IntegerProp object at 0x7f5875fa6dd0>, 'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'act_depend_of_me': <shinken.property.ListProp object at 0x7f5875f9f390>, 'attempt': <shinken.property.IntegerProp object at 0x7f5875fa6d50>, 'act_depend_of': <shinken.property.ListProp object at 0x7f5875f9f310>, 'triggers': <shinken.property.ListProp object at 0x7f5875fba290>, 'acknowledgement_type': <shinken.property.IntegerProp object at 0x7f5875f9f6d0>, 'modified_attributes': <shinken.property.IntegerProp object at 0x7f5875fa6bd0>, 'in_maintenance': <shinken.property.IntegerProp object at 0x7f5875fa6cd0>, 'got_business_rule': <shinken.property.BoolProp object at 0x7f5875fba050>, 'last_hard_state_id': <shinken.property.IntegerProp object at 0x7f5875f9f050>}
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 0x7f587567ad10>, 'notification_failure_criteria': <shinken.property.ListProp object at 0x7f587567ad90>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'explode_hostgroup': <shinken.property.BoolProp object at 0x7f587567ae10>, 'dependent_host_name': <shinken.property.StringProp object at 0x7f587567a950>, 'service_description': <shinken.property.StringProp object at 0x7f587567acd0>, 'dependent_hostgroup_name': <shinken.property.StringProp object at 0x7f587567aad0>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'dependency_period': <shinken.property.StringProp object at 0x7f587567add0>, 'execution_failure_criteria': <shinken.property.ListProp object at 0x7f587567ad50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f587567ac90>, 'host_name': <shinken.property.StringProp object at 0x7f587567ac50>, 'dependent_service_description': <shinken.property.StringProp object at 0x7f587567ac10>}

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 0x7f58756f7b50>, 'contact_groups': <shinken.property.StringProp object at 0x7f5875fb0450>, 'escalation_period': <shinken.property.StringProp object at 0x7f5875fb0390>, 'service_description': <shinken.property.StringProp object at 0x7f5875fb0290>, 'last_notification': <shinken.property.IntegerProp object at 0x7f5875fb0310>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'use': <shinken.property.ListProp object at 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'notification_interval': <shinken.property.IntegerProp object at 0x7f5875fb0350>, 'contacts': <shinken.property.StringProp object at 0x7f5875fb0410>, 'last_notification_time': <shinken.property.IntegerProp object at 0x7f5875fb04d0>, 'escalation_options': <shinken.property.ListProp object at 0x7f5875fb03d0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'hostgroup_name': <shinken.property.StringProp object at 0x7f5875fb0250>, 'host_name': <shinken.property.StringProp object at 0x7f5875fb01d0>, 'first_notification_time': <shinken.property.IntegerProp object at 0x7f5875fb0490>, 'first_notification': <shinken.property.IntegerProp object at 0x7f5875fb02d0>}
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 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'icon_image_alt': <shinken.property.StringProp object at 0x7f5873dd6f50>, 'notes': <shinken.property.StringProp object at 0x7f5873dd62d0>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'icon_image': <shinken.property.StringProp object at 0x7f5873dd6710>, 'notes_url': <shinken.property.StringProp object at 0x7f5873dd6690>, 'host_name': <shinken.property.StringProp object at 0x7f5873dd6350>, 'service_description': <shinken.property.StringProp object at 0x7f5873dd6750>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
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 0x7f58756f7850>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'alias': <shinken.property.StringProp object at 0x7f587567a7d0>, 'notes': <shinken.property.StringProp object at 0x7f587567a810>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'unknown_members': <shinken.property.ListProp object at 0x7f5875fe9150>, 'action_url': <shinken.property.StringProp object at 0x7f587567a890>, 'notes_url': <shinken.property.StringProp object at 0x7f587567a850>, 'members': <shinken.property.ListProp object at 0x7f5875fe90d0>, 'id': <shinken.property.IntegerProp object at 0x7f587567a590>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>, 'servicegroup_name': <shinken.property.StringProp object at 0x7f587567a790>}
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 0x7f5875679590>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'register': <shinken.property.IntegerProp object at 0x7f58756795d0>, 'is_active': <shinken.property.BoolProp object at 0x7f5875679690>, 'dateranges': <shinken.property.ListProp object at 0x7f5875679610>, 'alias': <shinken.property.StringProp object at 0x7f5875679550>, 'timeperiod_name': <shinken.property.StringProp object at 0x7f58756794d0>, 'exclude': <shinken.property.ListProp object at 0x7f5875679650>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
resolve_daterange(dateranges, entry)[source]
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>}
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 0x7f58756f7850>, 'code_src': <shinken.property.StringProp object at 0x7f58759d3ed0>, 'name': <shinken.property.StringProp object at 0x7f58756f7a50>, 'definition_order': <shinken.property.IntegerProp object at 0x7f58756f7b50>, 'trigger_name': <shinken.property.StringProp object at 0x7f58759d3e50>, 'register': <shinken.property.BoolProp object at 0x7f58756f7b90>, 'imported_from': <shinken.property.StringProp object at 0x7f58756f7b10>}
running_properties = {'configuration_errors': <shinken.property.ListProp object at 0x7f58756f7c10>, 'code_bin': <shinken.property.StringProp object at 0x7f58759d3f10>, 'configuration_warnings': <shinken.property.ListProp object at 0x7f58756f7bd0>, 'tags': <shinken.property.ListProp object at 0x7f58756f7c90>, 'hash': <shinken.property.StringProp object at 0x7f58756f7c50>, 'trigger_broker_raise_enabled': <shinken.property.BoolProp object at 0x7f58759d3f50>}
class shinken.objects.trigger.Triggers(items, index_items=True)[source]

Bases: shinken.objects.item.Items

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

alias of Trigger

load_file(path)[source]
load_objects(conf)[source]
name_property = 'trigger_name'
Read the Docs v: latest
Versions
latest
stable
branch-1.4
2.4.1
2.2
2.0.3
1.4.2
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.