The ironic.objects.trait Module

The ironic.objects.trait Module

class ironic.objects.trait.Trait(context=None, **kwargs)[source]

Bases: ironic.objects.base.IronicObject

create(context=None)[source]

Create a Trait record in the DB.

Parameters:context – security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: Trait(context).
Raises:InvalidParameterValue if adding the trait would exceed the per-node traits limit.
Raises:NodeNotFound if the node no longer appears in the database.
classmethod destroy(context, node_id, trait)[source]

Delete the Trait from the DB.

Parameters:
  • context – security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: Trait(context).
  • node_id – The id of a node.
  • trait – A trait string.
Raises:

NodeNotFound if the node no longer appears in the database.

Raises:

NodeTraitNotFound if the trait is not found.

classmethod exists(context, node_id, trait)[source]

Check whether a Trait exists in the DB.

Parameters:
  • context – security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: Trait(context).
  • node_id – The id of a node.
  • trait – A trait string.
Returns:

True if the trait exists otherwise False.

Raises:

NodeNotFound if the node no longer appears in the database.

class ironic.objects.trait.TraitList(*args, **kwargs)[source]

Bases: ironic.objects.base.IronicObjectListBase, ironic.objects.base.IronicObject

classmethod create(context, node_id, traits)[source]

Replace all existing traits with the specified list.

Parameters:
  • context – security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: Trait(context).
  • node_id – The id of a node.
  • traits – List of Strings; traits to set.
Raises:

InvalidParameterValue if adding the trait would exceed the per-node traits limit.

Raises:

NodeNotFound if the node no longer appears in the database.

classmethod destroy(context, node_id)[source]

Delete all traits for the specified node.

Parameters:
  • context – security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: Trait(context).
  • node_id – The id of a node.
Raises:

NodeNotFound if the node no longer appears in the database.

classmethod get_by_node_id(context, node_id)[source]

Return all traits for the specified node.

Parameters:
  • context – security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don’t use it. A context should be set when instantiating the object, e.g.: Trait(context).
  • node_id – The id of a node.
Raises:

NodeNotFound if the node no longer appears in the database.

get_trait_names()[source]

Return a list of names of the traits in this list.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.