Checkmk's Plug-in APIs
Agent based (“Check API”)
Bakery
Dynamic configuration connector
Graphing
Rulesets
Server-side calls
Checkmk's Plug-in APIs
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
_Localizable (class in cmk.rulesets.v1._localize)
A
ActiveCheck (class in cmk.graphing.v1.translations)
(class in cmk.rulesets.v1.rule_specs)
ActiveCheckCommand (class in cmk.server_side_calls.v1)
ActiveCheckConfig (class in cmk.server_side_calls.v1)
add_element_label (List attribute)
AgentAccess (class in cmk.rulesets.v1.rule_specs)
AgentConfig (class in cmk.rulesets.v1.rule_specs)
AgentSection (class in cmk.agent_based.v2)
AIX (OS attribute)
all_of() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
any_of() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
Attributes (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
AutoPrecision (class in cmk.graphing.v1.metrics)
B
bakery_plugin() (in module cmk.base.plugins.bakery.bakery_api.v1.register)
best() (State class method)
,
[1]
Bidirectional (class in cmk.graphing.v1.graphs)
(class in cmk.graphing.v1.perfometers)
BooleanChoice (class in cmk.rulesets.v1.form_specs._basic)
bytes() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
C
CascadingSingleChoice (class in cmk.rulesets.v1.form_specs._composed)
CascadingSingleChoiceElement (class in cmk.rulesets.v1.form_specs._composed)
check_levels() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
check_levels_predictive() (in module cmk.agent_based.v1)
CheckParameters (class in cmk.rulesets.v1.rule_specs)
CheckPlugin (class in cmk.agent_based.v2)
Closed (class in cmk.graphing.v1.perfometers)
cmk.agent_based.v1
module
cmk.agent_based.v1.clusterize
module
cmk.agent_based.v1.register
module
cmk.agent_based.v1.render
module
cmk.agent_based.v1.type_defs
module
cmk.agent_based.v2
module
cmk.agent_based.v2.clusterize
module
cmk.agent_based.v2.render
module
cmk.base.plugins.bakery.bakery_api
module
cmk.base.plugins.bakery.bakery_api.v1
module
cmk.base.plugins.bakery.bakery_api.v1.register
module
cmk.cee.dcd.connector_api
module
cmk.graphing
module
cmk.graphing.v1
module
cmk.graphing.v1.graphs
module
cmk.graphing.v1.metrics
module
cmk.graphing.v1.perfometers
module
cmk.graphing.v1.translations
module
cmk.rulesets
module
cmk.rulesets.v1
module
cmk.rulesets.v1.form_specs._base
module
cmk.rulesets.v1.form_specs._basic
module
cmk.rulesets.v1.form_specs._composed
module
cmk.rulesets.v1.form_specs._levels
module
cmk.rulesets.v1.form_specs._migrations
module
cmk.rulesets.v1.form_specs._preconfigured
module
cmk.rulesets.v1.form_specs.validators
module
cmk.rulesets.v1.rule_specs
module
cmk.server_side_calls
module
cmk.server_side_calls.v1
module
Color (class in cmk.graphing.v1.metrics)
ConnectorObject (class in cmk.cee.dcd.connector_api)
Constant (class in cmk.graphing.v1.metrics)
contains() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
CriticalOf (class in cmk.graphing.v1.metrics)
custom_validate (BooleanChoice attribute)
(DataSize attribute)
(FileUpload attribute)
(FixedValue attribute)
(Float attribute)
(FormSpec attribute)
(HostState attribute)
(Integer attribute)
(Levels attribute)
(MultilineText attribute)
(Percentage attribute)
(RegularExpression attribute)
(ServiceState attribute)
(SimpleLevels attribute)
(SingleChoice attribute)
(String attribute)
(TimeSpan attribute)
CustomTopic (class in cmk.rulesets.v1.rule_specs)
D
DataSize (class in cmk.rulesets.v1.form_specs._basic)
date() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
datetime() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
DebStep (class in cmk.base.plugins.bakery.bakery_api.v1)
DecimalNotation (class in cmk.graphing.v1.metrics)
DefaultValue (class in cmk.rulesets.v1.form_specs._base)
deserialize_attributes() (ConnectorObject class method)
(FailedToContactRemoteSite class method)
(NullObject class method)
DictElement (class in cmk.rulesets.v1.form_specs._composed)
DictGroup (class in cmk.rulesets.v1.form_specs._composed)
Dictionary (class in cmk.rulesets.v1.form_specs._composed)
Difference (class in cmk.graphing.v1.metrics)
DiscoveryParameters (class in cmk.rulesets.v1.rule_specs)
disksize() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
displayed_magnitudes (DataSize attribute)
(TimeSpan attribute)
E
editable_order (List attribute)
element_template (List attribute)
elements (CascadingSingleChoice attribute)
(Dictionary attribute)
(MultipleChoice attribute)
(SingleChoice attribute)
EmailAddress (class in cmk.rulesets.v1.form_specs.validators)
endswith() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
EnforcedService (class in cmk.rulesets.v1.rule_specs)
EngineeringScientificNotation (class in cmk.graphing.v1.metrics)
entry_point_prefixes() (in module cmk.agent_based.v2)
(in module cmk.graphing.v1)
(in module cmk.rulesets.v1)
(in module cmk.server_side_calls.v1)
EnvProxy (class in cmk.server_side_calls.v1)
equals() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
EvalType (class in cmk.rulesets.v1.rule_specs)
exists() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
extensions (FileUpload attribute)
F
FailedToContactRemoteSite (class in cmk.cee.dcd.connector_api)
field_size (String attribute)
FieldSize (class in cmk.rulesets.v1.form_specs._basic)
filesize() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
FileUpload (class in cmk.rulesets.v1.form_specs._basic)
FixedValue (class in cmk.rulesets.v1.form_specs._basic)
Float (class in cmk.rulesets.v1.form_specs._basic)
FocusRange (class in cmk.graphing.v1.perfometers)
form_spec_template (Levels attribute)
(SimpleLevels attribute)
format (Secret attribute)
FormSpec (class in cmk.rulesets.v1.form_specs._base)
Fraction (class in cmk.graphing.v1.metrics)
frequency() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
frozen (SingleChoice attribute)
G
get_average() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
get_rate() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
get_value_store() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
GetRateError
,
[1]
Graph (class in cmk.graphing.v1.graphs)
group (DictElement attribute)
H
Help (class in cmk.rulesets.v1)
help_text (BooleanChoice attribute)
(DataSize attribute)
(FileUpload attribute)
(FixedValue attribute)
(Float attribute)
(FormSpec attribute)
(HostState attribute)
(Integer attribute)
(Levels attribute)
(MultilineText attribute)
(Percentage attribute)
(RegularExpression attribute)
(ServiceState attribute)
(SimpleLevels attribute)
(SingleChoice attribute)
(String attribute)
(TimeSpan attribute)
Host (class in cmk.rulesets.v1.rule_specs)
HostAddress (class in cmk.rulesets.v1.form_specs.validators)
HostAndItemCondition (class in cmk.rulesets.v1.rule_specs)
HostAndServiceCondition (class in cmk.rulesets.v1.rule_specs)
HostCheckCommand (class in cmk.graphing.v1.translations)
HostCondition (class in cmk.rulesets.v1.rule_specs)
HostConfig (class in cmk.server_side_calls.v1)
HostLabel (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
HostState (class in cmk.rulesets.v1.form_specs._basic)
I
id (Secret attribute)
IECMagnitude (class in cmk.rulesets.v1.form_specs._basic)
IECNotation (class in cmk.graphing.v1.metrics)
ignored_elements (Dictionary attribute)
(SingleChoice attribute)
IgnoreResults (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
IgnoreResultsError
,
[1]
InputHint (class in cmk.rulesets.v1.form_specs._base)
Integer (class in cmk.rulesets.v1.form_specs._basic)
invalid_element_validation (SingleChoice attribute)
InvalidElementMode (class in cmk.rulesets.v1.form_specs._basic)
InvalidElementValidator (class in cmk.rulesets.v1.form_specs._basic)
InventoryParameters (class in cmk.rulesets.v1.rule_specs)
InventoryPlugin (class in cmk.agent_based.v2)
iobandwidth() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
IPAddressFamily (class in cmk.server_side_calls.v1)
IPv4Config (class in cmk.server_side_calls.v1)
IPv6Config (class in cmk.server_side_calls.v1)
iskeyword() (in module cmk.rulesets.v1.form_specs._basic)
(in module cmk.rulesets.v1.form_specs._composed)
(in module cmk.rulesets.v1.rule_specs)
L
label (BooleanChoice attribute)
(CascadingSingleChoice attribute)
Label (class in cmk.rulesets.v1)
label (DataSize attribute)
(FixedValue attribute)
(Float attribute)
(Integer attribute)
(MultilineText attribute)
(Percentage attribute)
(RegularExpression attribute)
(SingleChoice attribute)
(String attribute)
(TimeSpan attribute)
LengthInRange (class in cmk.rulesets.v1.form_specs.validators)
level_direction (Levels attribute)
(SimpleLevels attribute)
LevelDirection (class in cmk.rulesets.v1.form_specs._levels)
Levels (class in cmk.rulesets.v1.form_specs._levels)
LevelsType (class in cmk.rulesets.v1.form_specs._levels)
LINUX (OS attribute)
List (class in cmk.rulesets.v1.form_specs._composed)
M
macro_support (MultilineText attribute)
(String attribute)
make_node_notice_results() (in module cmk.agent_based.v1.clusterize)
(in module cmk.agent_based.v2.clusterize)
matches() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
MatchingScope (class in cmk.rulesets.v1.form_specs._basic)
MatchRegex (class in cmk.rulesets.v1.form_specs.validators)
MaximumOf (class in cmk.graphing.v1.metrics)
Message (class in cmk.rulesets.v1)
Metric (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
(class in cmk.graphing.v1.metrics)
(class in cmk.rulesets.v1.form_specs._preconfigured)
migrate (BooleanChoice attribute)
(DataSize attribute)
(FileUpload attribute)
(FixedValue attribute)
(Float attribute)
(FormSpec attribute)
(HostState attribute)
(Integer attribute)
(Levels attribute)
(MultilineText attribute)
(Percentage attribute)
(RegularExpression attribute)
(ServiceState attribute)
(SimpleLevels attribute)
(SingleChoice attribute)
(String attribute)
(TimeSpan attribute)
migrate_to_float_simple_levels() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_integer_simple_levels() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_lower_float_levels() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_lower_integer_levels() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_password() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_proxy() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_time_period() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_upper_float_levels() (in module cmk.rulesets.v1.form_specs._migrations)
migrate_to_upper_integer_levels() (in module cmk.rulesets.v1.form_specs._migrations)
mime_types (FileUpload attribute)
MinimalRange (class in cmk.graphing.v1.graphs)
MinimumOf (class in cmk.graphing.v1.metrics)
module
cmk.agent_based.v1
cmk.agent_based.v1.clusterize
cmk.agent_based.v1.register
cmk.agent_based.v1.render
cmk.agent_based.v1.type_defs
cmk.agent_based.v2
cmk.agent_based.v2.clusterize
cmk.agent_based.v2.render
cmk.base.plugins.bakery.bakery_api
cmk.base.plugins.bakery.bakery_api.v1
cmk.base.plugins.bakery.bakery_api.v1.register
cmk.cee.dcd.connector_api
cmk.graphing
cmk.graphing.v1
cmk.graphing.v1.graphs
cmk.graphing.v1.metrics
cmk.graphing.v1.perfometers
cmk.graphing.v1.translations
cmk.rulesets
cmk.rulesets.v1
cmk.rulesets.v1.form_specs._base
cmk.rulesets.v1.form_specs._basic
cmk.rulesets.v1.form_specs._composed
cmk.rulesets.v1.form_specs._levels
cmk.rulesets.v1.form_specs._migrations
cmk.rulesets.v1.form_specs._preconfigured
cmk.rulesets.v1.form_specs.validators
cmk.rulesets.v1.rule_specs
cmk.server_side_calls
cmk.server_side_calls.v1
MonitoredHost (class in cmk.rulesets.v1.form_specs._preconfigured)
MonitoredService (class in cmk.rulesets.v1.form_specs._preconfigured)
monospaced (MultilineText attribute)
MultilineText (class in cmk.rulesets.v1.form_specs._basic)
MultipleChoice (class in cmk.rulesets.v1.form_specs._composed)
MultipleChoiceElement (class in cmk.rulesets.v1.form_specs._composed)
N
NagiosPlugin (class in cmk.graphing.v1.translations)
name (CascadingSingleChoiceElement attribute)
(MultipleChoiceElement attribute)
(SingleChoiceElement attribute)
networkbandwidth() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
NetworkPort (class in cmk.rulesets.v1.form_specs.validators)
nicspeed() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
no_element_label (List attribute)
no_elements_text (Dictionary attribute)
(SingleChoice attribute)
NoGroup (class in cmk.rulesets.v1.form_specs._composed)
noop_parser() (in module cmk.server_side_calls.v1)
NoProxy (class in cmk.server_side_calls.v1)
not_contains() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
not_endswith() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
not_equals() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
not_exists() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
not_matches() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
not_startswith() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
NotificationParameters (class in cmk.rulesets.v1.rule_specs)
NullObject (class in cmk.cee.dcd.connector_api)
NumberInRange (class in cmk.rulesets.v1.form_specs.validators)
O
OIDBytes (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
OIDCached (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
OIDEnd (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
Open (class in cmk.graphing.v1.perfometers)
OS (class in cmk.base.plugins.bakery.bakery_api.v1)
P
parameter_form (CascadingSingleChoiceElement attribute)
(DictElement attribute)
pass_safely (Secret attribute)
PassiveCheck (class in cmk.graphing.v1.translations)
Password (class in cmk.rulesets.v1.form_specs._preconfigured)
percent() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
Percentage (class in cmk.rulesets.v1.form_specs._basic)
Perfometer (class in cmk.graphing.v1.perfometers)
Phase1Result (class in cmk.cee.dcd.connector_api)
Plugin (class in cmk.base.plugins.bakery.bakery_api.v1)
PluginConfig (class in cmk.base.plugins.bakery.bakery_api.v1)
POST (RpmStep attribute)
POSTINST (DebStep attribute)
POSTINSTALL (SolStep attribute)
POSTREMOVE (SolStep attribute)
POSTRM (DebStep attribute)
POSTTRANS (RpmStep attribute)
POSTUN (RpmStep attribute)
PRE (RpmStep attribute)
predefined_help_text (RegularExpression attribute)
predictive (Levels attribute)
PredictiveLevels (class in cmk.rulesets.v1.form_specs._levels)
prefill (BooleanChoice attribute)
(CascadingSingleChoice attribute)
(DataSize attribute)
(Float attribute)
(HostState attribute)
(Integer attribute)
(MultilineText attribute)
(MultipleChoice attribute)
(Percentage attribute)
(RegularExpression attribute)
(ServiceState attribute)
(SingleChoice attribute)
(String attribute)
(TimeSpan attribute)
prefill_abs_diff (PredictiveLevels attribute)
prefill_fixed_levels (Levels attribute)
(SimpleLevels attribute)
prefill_levels_type (Levels attribute)
(SimpleLevels attribute)
prefill_rel_diff (PredictiveLevels attribute)
prefill_stdev_diff (PredictiveLevels attribute)
PREINST (DebStep attribute)
PREINSTALL (SolStep attribute)
PREREMOVE (SolStep attribute)
PRERM (DebStep attribute)
PRETRANS (RpmStep attribute)
PREUN (RpmStep attribute)
primary_ip_config (HostConfig property)
Product (class in cmk.graphing.v1.metrics)
Proxy (class in cmk.rulesets.v1.form_specs._preconfigured)
ProxySchema (class in cmk.rulesets.v1.form_specs._preconfigured)
Q
quote_shell_string() (in module cmk.base.plugins.bakery.bakery_api.v1)
R
reference_metric (PredictiveLevels attribute)
regex() (in module cmk.agent_based.v1)
RegexGroupsInRange (class in cmk.rulesets.v1.form_specs.validators)
RegularExpression (class in cmk.rulesets.v1.form_specs._basic)
remove_element_label (List attribute)
RenameTo (class in cmk.graphing.v1.translations)
RenameToAndScaleBy (class in cmk.graphing.v1.translations)
render_only (DictElement attribute)
replace_macros() (in module cmk.server_side_calls.v1)
required (DictElement attribute)
Result (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
RpmStep (class in cmk.base.plugins.bakery.bakery_api.v1)
RuleSetType (class in cmk.agent_based.v1.register)
(class in cmk.agent_based.v2)
S
ScaleBy (class in cmk.graphing.v1.translations)
Scriptlet (class in cmk.base.plugins.bakery.bakery_api.v1)
Secret (class in cmk.server_side_calls.v1)
Service (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
(class in cmk.rulesets.v1.rule_specs)
ServiceLabel (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
ServiceState (class in cmk.rulesets.v1.form_specs._basic)
show_toggle_all (MultipleChoice attribute)
SIMagnitude (class in cmk.rulesets.v1.form_specs._basic)
SimpleLevels (class in cmk.rulesets.v1.form_specs._levels)
SimpleSNMPSection (class in cmk.agent_based.v2)
SingleChoice (class in cmk.rulesets.v1.form_specs._basic)
SingleChoiceElement (class in cmk.rulesets.v1.form_specs._basic)
SINotation (class in cmk.graphing.v1.metrics)
SNMP (class in cmk.rulesets.v1.rule_specs)
SNMPDetectSpecification (class in cmk.agent_based.v2)
SNMPSection (class in cmk.agent_based.v2)
SNMPTree (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
SOLARIS (OS attribute)
SolStep (class in cmk.base.plugins.bakery.bakery_api.v1)
SpecialAgent (class in cmk.rulesets.v1.rule_specs)
SpecialAgentCommand (class in cmk.server_side_calls.v1)
SpecialAgentConfig (class in cmk.server_side_calls.v1)
Stacked (class in cmk.graphing.v1.perfometers)
StandardScientificNotation (class in cmk.graphing.v1.metrics)
startswith() (in module cmk.agent_based.v1)
(in module cmk.agent_based.v2)
State (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
StrictPrecision (class in cmk.graphing.v1.metrics)
String (class in cmk.rulesets.v1.form_specs._basic)
Sum (class in cmk.graphing.v1.metrics)
SystemBinary (class in cmk.base.plugins.bakery.bakery_api.v1)
SystemConfig (class in cmk.base.plugins.bakery.bakery_api.v1)
T
TableRow (class in cmk.agent_based.v1)
(class in cmk.agent_based.v2)
time_offset() (in module cmk.agent_based.v2.render)
TimeMagnitude (class in cmk.rulesets.v1.form_specs._basic)
TimeNotation (class in cmk.graphing.v1.metrics)
TimePeriod (class in cmk.rulesets.v1.form_specs._preconfigured)
TimeSpan (class in cmk.rulesets.v1.form_specs._basic)
timespan() (in module cmk.agent_based.v1.render)
(in module cmk.agent_based.v2.render)
title (BooleanChoice attribute)
(CascadingSingleChoiceElement attribute)
Title (class in cmk.graphing.v1)
(class in cmk.rulesets.v1)
title (DataSize attribute)
(FileUpload attribute)
(FixedValue attribute)
(Float attribute)
(FormSpec attribute)
(HostState attribute)
(Integer attribute)
(Levels attribute)
(MultilineText attribute)
(MultipleChoiceElement attribute)
(Percentage attribute)
(RegularExpression attribute)
(ServiceState attribute)
(SimpleLevels attribute)
(SingleChoice attribute)
(SingleChoiceElement attribute)
(String attribute)
(TimeSpan attribute)
Topic (class in cmk.rulesets.v1.rule_specs)
type (EnvProxy attribute)
(NoProxy attribute)
(URLProxy attribute)
U
Unit (class in cmk.graphing.v1.metrics)
unit_symbol (Float attribute)
(Integer attribute)
unsafe() (Secret method)
Url (class in cmk.rulesets.v1.form_specs.validators)
url (URLProxy attribute)
UrlProtocol (class in cmk.rulesets.v1.form_specs.validators)
URLProxy (class in cmk.server_side_calls.v1)
V
ValidationError
value (FixedValue attribute)
W
WarningOf (class in cmk.graphing.v1.metrics)
WINDOWS (OS attribute)
WindowsConfigEntry (class in cmk.base.plugins.bakery.bakery_api.v1)
WindowsConfigItems (class in cmk.base.plugins.bakery.bakery_api.v1)
WindowsGlobalConfigEntry (class in cmk.base.plugins.bakery.bakery_api.v1)
WindowsSystemConfigEntry (class in cmk.base.plugins.bakery.bakery_api.v1)
worst() (State class method)
,
[1]