ironic_inspector.plugins.rules
Module¶Standard plugins for rules API.
ironic_inspector.plugins.rules.
AddTraitAction
[source]¶Bases: ironic_inspector.plugins.base.RuleActionPlugin
REQUIRED_PARAMS
= {'name'}¶ironic_inspector.plugins.rules.
ContainsCondition
[source]¶Bases: ironic_inspector.plugins.rules.ReCondition
check
(node_info, field, params, **kwargs)[source]¶Check if condition holds for a given field.
node_info – NodeInfo object
field – field value
params – parameters as a dictionary, changing it here will change what will be stored in database
kwargs – used for extensibility without breaking existing plugins
ValueError – on unacceptable field value
True if check succeeded, otherwise False
ironic_inspector.plugins.rules.
EmptyCondition
[source]¶Bases: ironic_inspector.plugins.base.RuleConditionPlugin
ALLOW_NONE
= True¶REQUIRED_PARAMS
= {}¶check
(node_info, field, params, **kwargs)[source]¶Check if condition holds for a given field.
node_info – NodeInfo object
field – field value
params – parameters as a dictionary, changing it here will change what will be stored in database
kwargs – used for extensibility without breaking existing plugins
ValueError – on unacceptable field value
True if check succeeded, otherwise False
ironic_inspector.plugins.rules.
EqCondition
[source]¶Bases: ironic_inspector.plugins.rules.SimpleCondition
op
()¶eq(a, b) – Same as a==b.
ironic_inspector.plugins.rules.
ExtendAttributeAction
[source]¶Bases: ironic_inspector.plugins.base.RuleActionPlugin
FORMATTED_PARAMS
= ['value']¶OPTIONAL_PARAMS
= {'unique'}¶REQUIRED_PARAMS
= {'path', 'value'}¶ironic_inspector.plugins.rules.
FailAction
[source]¶Bases: ironic_inspector.plugins.base.RuleActionPlugin
REQUIRED_PARAMS
= {'message'}¶ironic_inspector.plugins.rules.
GeCondition
[source]¶Bases: ironic_inspector.plugins.rules.SimpleCondition
op
()¶ge(a, b) – Same as a>=b.
ironic_inspector.plugins.rules.
GtCondition
[source]¶Bases: ironic_inspector.plugins.rules.SimpleCondition
op
()¶gt(a, b) – Same as a>b.
ironic_inspector.plugins.rules.
LeCondition
[source]¶Bases: ironic_inspector.plugins.rules.SimpleCondition
op
()¶le(a, b) – Same as a<=b.
ironic_inspector.plugins.rules.
LtCondition
[source]¶Bases: ironic_inspector.plugins.rules.SimpleCondition
op
()¶lt(a, b) – Same as a<b.
ironic_inspector.plugins.rules.
MatchesCondition
[source]¶Bases: ironic_inspector.plugins.rules.ReCondition
check
(node_info, field, params, **kwargs)[source]¶Check if condition holds for a given field.
node_info – NodeInfo object
field – field value
params – parameters as a dictionary, changing it here will change what will be stored in database
kwargs – used for extensibility without breaking existing plugins
ValueError – on unacceptable field value
True if check succeeded, otherwise False
ironic_inspector.plugins.rules.
NeCondition
[source]¶Bases: ironic_inspector.plugins.rules.SimpleCondition
op
()¶ne(a, b) – Same as a!=b.
ironic_inspector.plugins.rules.
NetCondition
[source]¶Bases: ironic_inspector.plugins.base.RuleConditionPlugin
check
(node_info, field, params, **kwargs)[source]¶Check if condition holds for a given field.
node_info – NodeInfo object
field – field value
params – parameters as a dictionary, changing it here will change what will be stored in database
kwargs – used for extensibility without breaking existing plugins
ValueError – on unacceptable field value
True if check succeeded, otherwise False
validate
(params, **kwargs)[source]¶Validate params passed during creation.
Default implementation checks for presence of fields from REQUIRED_PARAMS and fails for unexpected fields (not from REQUIRED_PARAMS + OPTIONAL_PARAMS).
params – params as a dictionary
kwargs – used for extensibility without breaking existing plugins
ValueError on validation failure
ironic_inspector.plugins.rules.
ReCondition
[source]¶Bases: ironic_inspector.plugins.base.RuleConditionPlugin
validate
(params, **kwargs)[source]¶Validate params passed during creation.
Default implementation checks for presence of fields from REQUIRED_PARAMS and fails for unexpected fields (not from REQUIRED_PARAMS + OPTIONAL_PARAMS).
params – params as a dictionary
kwargs – used for extensibility without breaking existing plugins
ValueError on validation failure
ironic_inspector.plugins.rules.
RemoveTraitAction
[source]¶Bases: ironic_inspector.plugins.base.RuleActionPlugin
REQUIRED_PARAMS
= {'name'}¶ironic_inspector.plugins.rules.
SetAttributeAction
[source]¶Bases: ironic_inspector.plugins.base.RuleActionPlugin
FORMATTED_PARAMS
= ['value']¶OPTIONAL_PARAMS
= {'reset_interfaces', 'value'}¶REQUIRED_PARAMS
= {'path'}¶apply
(node_info, params, **kwargs)[source]¶Run action on successful rule match.
node_info – NodeInfo object
params – parameters as a dictionary
kwargs – used for extensibility without breaking existing plugins
utils.Error on failure
validate
(params, **kwargs)[source]¶Validate params passed during creation.
Default implementation checks for presence of fields from REQUIRED_PARAMS and fails for unexpected fields (not from REQUIRED_PARAMS + OPTIONAL_PARAMS).
params – params as a dictionary
kwargs – used for extensibility without breaking existing plugins
ValueError on validation failure
ironic_inspector.plugins.rules.
SetCapabilityAction
[source]¶Bases: ironic_inspector.plugins.base.RuleActionPlugin
FORMATTED_PARAMS
= ['value']¶OPTIONAL_PARAMS
= {'value'}¶REQUIRED_PARAMS
= {'name'}¶ironic_inspector.plugins.rules.
SimpleCondition
[source]¶Bases: ironic_inspector.plugins.base.RuleConditionPlugin
check
(node_info, field, params, **kwargs)[source]¶Check if condition holds for a given field.
node_info – NodeInfo object
field – field value
params – parameters as a dictionary, changing it here will change what will be stored in database
kwargs – used for extensibility without breaking existing plugins
ValueError – on unacceptable field value
True if check succeeded, otherwise False
op
= None¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.