Agent based (“Check API”)

Version 1

This API provides tools for the implementation of

• section definitions parsing the raw data and discovering host labels

• check plug-ins subscribing to sections and creating services

• inventory plug-ins subscribing to sections and creating entries for the HW/SW inventory

• agent_based_api.v1
  • all_of()
  • any_of()
  • exists()
  • equals()
  • startswith()
  • endswith()
  • contains()
  • matches()
  • not_exists()
  • not_equals()
  • not_contains()
  • not_endswith()
  • not_matches()
  • not_startswith()
  • Attributes
  • check_levels()
  • check_levels_predictive()
  • get_average()
  • get_rate()
  • get_value_store()
  • HostLabel
  • IgnoreResults
  • IgnoreResultsError
  • Metric
  • OIDBytes
  • OIDCached
  • OIDEnd
  • regex()
  • Result
  • Service
  • ServiceLabel
  • SNMPTree
  • State
    • State.best()
    • State.worst()
  • TableRow
  • GetRateError
• agent_based_api.v1.clusterize
  • make_node_notice_results()
• agent_based_api.v1.register
  • RuleSetType
  • agent_section()
  • check_plugin()
  • inventory_plugin()
  • snmp_section()
• agent_based_api.v1.render
  • bytes()
  • date()
  • datetime()
  • disksize()
  • filesize()
  • frequency()
  • iobandwidth()
  • networkbandwidth()
  • nicspeed()
  • percent()
  • timespan()
• agent_based_api.v1.type_defs

Version 2

• cmk.agent_based.v2
  • New in this version
    • type_defs module is dissolved
    • check_levels signature changed
    • Registration is replaced by a discovery approach
    • Changed arguments and validation for Agent and SNMP sections
    • Removed wrapper for regex creation regex()
    • Added rendering function time_offset()
  • entry_point_prefixes()
  • AgentSection
  • CheckPlugin
  • SNMPSection
  • SimpleSNMPSection
  • SNMPDetectSpecification
  • InventoryPlugin
  • all_of()
  • any_of()
  • exists()
  • equals()
  • startswith()
  • endswith()
  • contains()
  • matches()
  • not_exists()
  • not_equals()
  • not_contains()
  • not_endswith()
  • not_matches()
  • not_startswith()
  • Attributes
  • check_levels()
  • get_average()
  • get_rate()
  • get_value_store()
  • HostLabel
  • IgnoreResults
  • IgnoreResultsError
  • Metric
  • OIDBytes
  • OIDCached
  • OIDEnd
  • Result
  • RuleSetType
  • Service
  • ServiceLabel
  • SNMPTree
  • State
    • State.best()
    • State.worst()
  • TableRow
  • GetRateError
• cmk.agent_based.v2.clusterize
  • make_node_notice_results()
• cmk.agent_based.v2.render
  • bytes()
  • date()
  • datetime()
  • disksize()
  • filesize()
  • frequency()
  • iobandwidth()
  • networkbandwidth()
  • nicspeed()
  • percent()
  • timespan()
  • time_offset()