ironic_inspector.plugins.rules module

Standard plugins for rules API.

class ironic_inspector.plugins.rules.AddTraitAction

Bases: ironic_inspector.plugins.base.RuleActionPlugin

REQUIRED_PARAMS = {'name'}

apply(node_info, params, **kwargs)

Run action on successful rule match.

Parameters

• node_info – NodeInfo object

• params – parameters as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

utils.Error on failure

class ironic_inspector.plugins.rules.ContainsCondition

Bases: ironic_inspector.plugins.rules.ReCondition

check(node_info, field, params, **kwargs)

Check if condition holds for a given field.

Parameters

• 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

Raises

ValueError – on unacceptable field value

Returns

True if check succeeded, otherwise False

class ironic_inspector.plugins.rules.EmptyCondition

Bases: ironic_inspector.plugins.base.RuleConditionPlugin

ALLOW_NONE = True

REQUIRED_PARAMS = {}

check(node_info, field, params, **kwargs)

Check if condition holds for a given field.

Parameters

• 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

Raises

ValueError – on unacceptable field value

Returns

True if check succeeded, otherwise False

class ironic_inspector.plugins.rules.EqCondition

Bases: ironic_inspector.plugins.rules.SimpleCondition

op(b, /)

Same as a == b.

class ironic_inspector.plugins.rules.ExtendAttributeAction

Bases: ironic_inspector.plugins.base.RuleActionPlugin

FORMATTED_PARAMS = ['value']

OPTIONAL_PARAMS = {'unique'}

REQUIRED_PARAMS = {'path', 'value'}

apply(node_info, params, **kwargs)

Run action on successful rule match.

Parameters

• node_info – NodeInfo object

• params – parameters as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

utils.Error on failure

class ironic_inspector.plugins.rules.FailAction

Bases: ironic_inspector.plugins.base.RuleActionPlugin

REQUIRED_PARAMS = {'message'}

apply(node_info, params, **kwargs)

Run action on successful rule match.

Parameters

• node_info – NodeInfo object

• params – parameters as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

utils.Error on failure

class ironic_inspector.plugins.rules.GeCondition

Bases: ironic_inspector.plugins.rules.SimpleCondition

op(b, /)

Same as a >= b.

class ironic_inspector.plugins.rules.GtCondition

Bases: ironic_inspector.plugins.rules.SimpleCondition

op(b, /)

Same as a > b.

class ironic_inspector.plugins.rules.LeCondition

Bases: ironic_inspector.plugins.rules.SimpleCondition

op(b, /)

Same as a <= b.

class ironic_inspector.plugins.rules.LtCondition

Bases: ironic_inspector.plugins.rules.SimpleCondition

op(b, /)

Same as a < b.

class ironic_inspector.plugins.rules.MatchesCondition

Bases: ironic_inspector.plugins.rules.ReCondition

check(node_info, field, params, **kwargs)

Check if condition holds for a given field.

Parameters

• 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

Raises

ValueError – on unacceptable field value

Returns

True if check succeeded, otherwise False

class ironic_inspector.plugins.rules.NeCondition

Bases: ironic_inspector.plugins.rules.SimpleCondition

op(b, /)

Same as a != b.

class ironic_inspector.plugins.rules.NetCondition

Bases: ironic_inspector.plugins.base.RuleConditionPlugin

check(node_info, field, params, **kwargs)

Check if condition holds for a given field.

Parameters

• 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

Raises

ValueError – on unacceptable field value

Returns

True if check succeeded, otherwise False

validate(params, **kwargs)

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).

Parameters

• params – params as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

ValueError on validation failure

class ironic_inspector.plugins.rules.ReCondition

Bases: ironic_inspector.plugins.base.RuleConditionPlugin

validate(params, **kwargs)

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).

Parameters

• params – params as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

ValueError on validation failure

class ironic_inspector.plugins.rules.RemoveTraitAction

Bases: ironic_inspector.plugins.base.RuleActionPlugin

REQUIRED_PARAMS = {'name'}

apply(node_info, params, **kwargs)

Run action on successful rule match.

Parameters

• node_info – NodeInfo object

• params – parameters as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

utils.Error on failure

class ironic_inspector.plugins.rules.SetAttributeAction

Bases: ironic_inspector.plugins.base.RuleActionPlugin

FORMATTED_PARAMS = ['value']

OPTIONAL_PARAMS = {'reset_interfaces', 'value'}

REQUIRED_PARAMS = {'path'}

apply(node_info, params, **kwargs)

Run action on successful rule match.

Parameters

• node_info – NodeInfo object

• params – parameters as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

utils.Error on failure

validate(params, **kwargs)

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).

Parameters

• params – params as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

ValueError on validation failure

class ironic_inspector.plugins.rules.SetCapabilityAction

Bases: ironic_inspector.plugins.base.RuleActionPlugin

FORMATTED_PARAMS = ['value']

OPTIONAL_PARAMS = {'value'}

REQUIRED_PARAMS = {'name'}

apply(node_info, params, **kwargs)

Run action on successful rule match.

Parameters

• node_info – NodeInfo object

• params – parameters as a dictionary

• kwargs – used for extensibility without breaking existing plugins

Raises

utils.Error on failure

class ironic_inspector.plugins.rules.SimpleCondition

Bases: ironic_inspector.plugins.base.RuleConditionPlugin

check(node_info, field, params, **kwargs)

Check if condition holds for a given field.

Parameters

• 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

Raises

ValueError – on unacceptable field value

Returns

True if check succeeded, otherwise False

op = None

ironic_inspector.plugins.rules.coerce(value, expected)