rulesets.v1.rule_specs

iskeyword(): x.__contains__(y) <==> y in x.

class Topic(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

class CustomTopic(title)

Parameters:: title (Title) – human-readable title of this group

class EvalType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

class HostCondition: Creates a condition that allows users to match the rule based on the host.

class HostAndServiceCondition: Creates a condition that allows users to match the rule based on the host and the service description.

class HostAndItemCondition(item_title, item_form=String(title=None, help_text=None, migrate=None, custom_validate=(<cmk.rulesets.v1.form_specs.validators.LengthInRange object>, ), label=None, macro_support=False, prefill=InputHint(value=''), field_size=<FieldSize.MEDIUM: 2>))

Creates a condition that allows users to match the rule based on the host and the item of the service.

Parameters:

item_title (Title) – Title for the item of the service
item_form (FormSpec[str]) – Configuration specification for the item of the check. By default, a text input field that disallows empty strings will be created.

class Host(title, topic, parameter_form, eval_type, name, is_deprecated=False, help_text=None)

Specifies rule configurations for hosts

Instances of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
eval_type (EvalType) – How the rules of this RuleSpec are meant to be evaluated in respect to each other
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class Service(title, topic, parameter_form, eval_type, name, condition, is_deprecated=False, help_text=None)

Specifies rule configurations for services

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
eval_type (EvalType) – How the rules of this RuleSpec are meant to be evaluated in respect to each other
name (str) – Identifier of the rule spec
condition (HostCondition | HostAndServiceCondition) – Which targets should be configurable in the rule condition
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class CheckParameters(title, topic, parameter_form, name, condition, is_deprecated=False, help_text=None, create_enforced_service=True)

Specifies rule configurations for checks

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
name (str) – Identifier of the rule spec
condition (HostCondition | HostAndItemCondition) – Which targets should be configurable in the rule condition
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration
create_enforced_service (bool) – Whether to automatically create an enforced service for any service created with this rule spec

class EnforcedService(title, topic, parameter_form, name, condition, is_deprecated=False, help_text=None)

Specifies rule configurations for checks whose creation is enforced

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary] | None) – Configuration specification
name (str) – Identifier of the rule spec
condition (HostCondition | HostAndItemCondition) – Which targets should be configurable in the rule condition
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class DiscoveryParameters(title, topic, parameter_form, name, is_deprecated=False, help_text=None)

Specifies configurations for the discovery of services

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class ActiveCheck(title, topic, parameter_form, name, is_deprecated=False, help_text=None)

Specifies rule configurations for active checks

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class AgentConfig(title, topic, parameter_form, name, is_deprecated=False, help_text=None)

Specifies rule configurations for agents

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class SpecialAgent(title, topic, parameter_form, name, is_deprecated=False, help_text=None)

Specifies rule configurations for special agents

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class AgentAccess(title, topic, parameter_form, eval_type, name, is_deprecated=False, help_text=None)

Specifies configurations for the connection to the Checkmk and SNMP agents

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
eval_type (EvalType) – How the rules of this RuleSpec are meant to be evaluated in respect to each other
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class NotificationParameters(title, topic, parameter_form, name, is_deprecated=False, help_text=None)

Specifies rule configurations for notifications

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
name (str) – Identifier of the rule spec. Has to match the name of the notifications script
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class SNMP(title, topic, parameter_form, eval_type, name, is_deprecated=False, help_text=None)

Specifies configurations for SNMP services

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
eval_type (EvalType) – How the rules of this RuleSpec are meant to be evaluated in respect to each other
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration

class InventoryParameters(title, topic, parameter_form, name, is_deprecated=False, help_text=None)

Specifies rule configurations for inventory services

Instance of this class will only be picked up by Checkmk if their names start with rule_spec_.

Parameters:

title (Title) – Human readable title
topic (Topic | CustomTopic) – Categorization of the rule
parameter_form (Callable[[], Dictionary]) – Configuration specification
name (str) – Identifier of the rule spec
is_deprecated (bool) – Flag to indicate whether this rule is deprecated and should no longer be used
help_text (Help | None) – Description to help the user with the configuration