ironic.objects.node module

class ironic.objects.node.Node(context=None, **kwargs)[source]

Bases: IronicObject, VersionedObjectDictCompat

VERSION = '1.44'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property allocation_id
as_dict(secure=False, mask_configdrive=True)[source]

Return the object represented as a dict.

The returned object is JSON-serialisable.

property automated_clean
property bios_interface
property boot_interface
property boot_mode
property chassis_id
property clean_step
property conductor_affinity
property conductor_group
property console_enabled
property console_interface
create(context=None)[source]

Create a Node record in the DB.

Column-wise updates will be made based on the result of self.what_changed(). If target_power_state is provided, it will be checked against the in-database copy of the node before updates are made.

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.: Node(context)

Raises:

InvalidParameterValue if some property values are invalid.

property created_at
dbapi = <oslo_db.api.DBAPI object>
del_driver_internal_info(key, default_value=None)[source]

Pop a value from the driver_internal_info.

Removing a driver_internal_info dict value via this method ensures that this field will be flagged for saving.

Parameters:

  • key – Key of item to pop off the driver_internal_info dict

  • default_value – Value to return if the key doesn’t exist

Returns:

The removed value, or default_value

property deploy_interface
property deploy_step
property description
destroy(context=None)[source]

Delete the Node 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.: Node(context)

property disable_power_off
property driver
property driver_info
property driver_internal_info
property extra
property fault
fields = {'allocation_id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'automated_clean': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'bios_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_mode': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'chassis_id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'clean_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'conductor_affinity': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'conductor_group': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_enabled': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'console_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'description': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disable_power_off': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver_internal_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'fault': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'firmware_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'health': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'inspect_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_finished_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_started_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'last_error': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'lessee': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'maintenance_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'management_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'network_data': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'network_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'owner': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'parent_node': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'properties': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'protected_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'raid_config': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'raid_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'rescue_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'reservation': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'resource_class': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'secure_boot': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'service_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'shard': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'storage_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_raid_config': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'traits': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'vendor_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property firmware_interface
classmethod get(context, node_id)[source]

Find a node based on its id or uuid and return a Node object.

Parameters:

  • context – Security context

  • node_id – the id or uuid of a node.

Returns:

a Node object.

classmethod get_by_id(context, node_id)[source]

Find a node based on its integer ID and return a Node object.

Parameters:

  • cls – the Node

  • context – Security context

  • node_id – the ID of a node.

Returns:

a Node object.

classmethod get_by_instance_uuid(context, instance_uuid)[source]

Find a node based on the instance UUID and return a Node object.

Parameters:

  • cls – the Node

  • context – Security context

  • uuid – the UUID of the instance.

Returns:

a Node object.

classmethod get_by_name(context, name)[source]

Find a node based on name and return a Node object.

Parameters:

  • cls – the Node

  • context – Security context

  • name – the logical name of a node.

Returns:

a Node object.

classmethod get_by_port_addresses(context, addresses)[source]

Get a node by associated port addresses.

Parameters:

  • cls – the Node

  • context – Security context.

  • addresses – A list of port addresses.

Raises:

NodeNotFound if the node is not found.

Returns:

a Node object.

classmethod get_by_uuid(context, uuid)[source]

Find a node based on UUID and return a Node object.

Parameters:

  • cls – the Node

  • context – Security context

  • uuid – the UUID of a node.

Returns:

a Node object.

get_interface(iface)[source]
property health
property id
property inspect_interface
property inspection_finished_at
property inspection_started_at
property instance_info
property instance_name
property instance_uuid
property last_error
property lessee
classmethod list(context, limit=None, marker=None, sort_key=None, sort_dir=None, filters=None, fields=None)[source]

Return a list of Node objects.

Parameters:

  • cls – the Node

  • context – Security context.

  • limit – maximum number of resources to return in a single result.

  • marker – pagination marker for large data sets.

  • sort_key – column to sort results by.

  • sort_dir – direction to sort. “asc” or “desc”.

  • filters – Filters to apply.

  • fields – Requested fields to be returned. Please note, some fields are mandatory for the data model and are automatically included. These are: id, version, updated_at, created_at, owner, and lessee.

Returns:

a list of Node object.

list_child_node_ids(exclude_dedicated_power=False)[source]

Returns a list of node IDs for child nodes, if any.

Parameters:

exclude_dedicated_power – Boolean, Default False, if the list should exclude nodes which are independently powered.

Returns:

A list of any node_id values discovered in the database.

property maintenance
property maintenance_reason
property management_interface
property name
property network_data
property network_interface
property owner
property parent_node
property power_interface
property power_state
property properties
property protected
property protected_reason
property provision_state
property provision_updated_at
property raid_config
property raid_interface
refresh(context=None)[source]

Refresh the object by re-fetching 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.: Node(context)

classmethod release(context, tag, node_id)[source]

Release the reservation on a node.

Parameters:

  • context – Security context.

  • tag – A string uniquely identifying the reservation holder.

  • node_id – A node id or uuid.

Raises:

NodeNotFound if the node is not found.

property rescue_interface
property reservation
classmethod reserve(context, tag, node_id)[source]

Get and reserve a node.

To prevent other ManagerServices from manipulating the given Node while a Task is performed, mark it reserved by this host.

Parameters:

  • cls – the Node

  • context – Security context.

  • tag – A string uniquely identifying the reservation holder.

  • node_id – A node ID or UUID.

Raises:

NodeNotFound if the node is not found.

Returns:

a Node object.

property resource_class
property retired
property retired_reason
save(context=None)[source]

Save updates to this Node.

Column-wise updates will be made based on the result of self.what_changed(). If target_power_state is provided, it will be checked against the in-database copy of the node before updates are made.

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.: Node(context)

Raises:

InvalidParameterValue if some property values are invalid.

property secure_boot
property service_step
set_driver_internal_info(key, value)[source]

Set a driver_internal_info value.

Setting a driver_internal_info dict value via this method ensures that this field will be flagged for saving.

Parameters:

  • key – Key of item to set

  • value – Value of item to set

set_instance_info(key, value)[source]

Set an instance_info value.

Setting a instance_info dict value via this method ensures that this field will be flagged for saving.

Parameters:

  • key – Key of item to set

  • value – Value of item to set

set_property(key, value)[source]

Set a properties value.

Setting a properties dict value via this method ensures that this field will be flagged for saving.

Parameters:

  • key – Key of item to set

  • value – Value of item to set

property shard
property storage_interface
property target_power_state
property target_provision_state
property target_raid_config
timestamp_driver_internal_info(key)[source]

Set a driver_internal_info value with the current timestamp.

Setting a driver_internal_info timestamp value via this method ensures that this field will be flagged for saving.

Parameters:

key – Key of item to set the timestamp on

touch_provisioning(context=None)[source]

Touch the database record to mark the provisioning as alive.

property traits
property updated_at
property uuid
property vendor_interface
class ironic.objects.node.NodeCRUDNotification(context=None, **kwargs)[source]

Bases: NotificationBase

Notification emitted when ironic creates, updates or deletes a node.

VERSION = '1.0'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property created_at
property event_type
fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'event_type': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'level': NotificationLevel(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False,valid_values=('debug', 'info', 'warning', 'error', 'critical')), 'payload': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'publisher': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property level
property payload
property publisher
property updated_at
class ironic.objects.node.NodeCRUDPayload(node, chassis_uuid=None)[source]

Bases: NodePayload

Payload schema for when ironic creates, updates or deletes a node.

SCHEMA = {'bios_interface': ('node', 'bios_interface'), 'boot_interface': ('node', 'boot_interface'), 'boot_mode': ('node', 'boot_mode'), 'clean_step': ('node', 'clean_step'), 'conductor_group': ('node', 'conductor_group'), 'console_enabled': ('node', 'console_enabled'), 'console_interface': ('node', 'console_interface'), 'created_at': ('node', 'created_at'), 'deploy_interface': ('node', 'deploy_interface'), 'deploy_step': ('node', 'deploy_step'), 'description': ('node', 'description'), 'disable_power_off': ('node', 'disable_power_off'), 'driver': ('node', 'driver'), 'driver_info': ('node', 'driver_info'), 'extra': ('node', 'extra'), 'fault': ('node', 'fault'), 'inspect_interface': ('node', 'inspect_interface'), 'inspection_finished_at': ('node', 'inspection_finished_at'), 'inspection_started_at': ('node', 'inspection_started_at'), 'instance_info': ('node', 'instance_info'), 'instance_uuid': ('node', 'instance_uuid'), 'last_error': ('node', 'last_error'), 'lessee': ('node', 'lessee'), 'maintenance': ('node', 'maintenance'), 'maintenance_reason': ('node', 'maintenance_reason'), 'management_interface': ('node', 'management_interface'), 'name': ('node', 'name'), 'network_interface': ('node', 'network_interface'), 'owner': ('node', 'owner'), 'power_interface': ('node', 'power_interface'), 'power_state': ('node', 'power_state'), 'properties': ('node', 'properties'), 'protected': ('node', 'protected'), 'protected_reason': ('node', 'protected_reason'), 'provision_state': ('node', 'provision_state'), 'provision_updated_at': ('node', 'provision_updated_at'), 'raid_interface': ('node', 'raid_interface'), 'rescue_interface': ('node', 'rescue_interface'), 'resource_class': ('node', 'resource_class'), 'retired': ('node', 'retired'), 'retired_reason': ('node', 'retired_reason'), 'secure_boot': ('node', 'secure_boot'), 'storage_interface': ('node', 'storage_interface'), 'target_power_state': ('node', 'target_power_state'), 'target_provision_state': ('node', 'target_provision_state'), 'updated_at': ('node', 'updated_at'), 'uuid': ('node', 'uuid'), 'vendor_interface': ('node', 'vendor_interface')}
VERSION = '1.15'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property bios_interface
property boot_interface
property boot_mode
property chassis_uuid
property clean_step
property conductor_group
property console_enabled
property console_interface
property created_at
property deploy_interface
property deploy_step
property description
property disable_power_off
property driver
property driver_info
property extra
property fault
fields = {'bios_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_mode': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'chassis_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'clean_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'conductor_group': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_enabled': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'description': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disable_power_off': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'fault': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspect_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_finished_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_started_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'last_error': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'lessee': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'management_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'network_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'owner': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'properties': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'raid_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'rescue_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'resource_class': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'secure_boot': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'storage_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'traits': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'vendor_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property inspect_interface
property inspection_finished_at
property inspection_started_at
property instance_info
property instance_uuid
property last_error
property lessee
property maintenance
property maintenance_reason
property management_interface
property name
property network_interface
property owner
property power_interface
property power_state
property properties
property protected
property protected_reason
property provision_state
property provision_updated_at
property raid_interface
property rescue_interface
property resource_class
property retired
property retired_reason
property secure_boot
property storage_interface
property target_power_state
property target_provision_state
property traits
property updated_at
property uuid
property vendor_interface
class ironic.objects.node.NodeConsoleNotification(context=None, **kwargs)[source]

Bases: NotificationBase

Notification emitted when node console state changed.

VERSION = '1.0'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property created_at
property event_type
fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'event_type': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'level': NotificationLevel(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False,valid_values=('debug', 'info', 'warning', 'error', 'critical')), 'payload': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'publisher': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property level
property payload
property publisher
property updated_at
class ironic.objects.node.NodeCorrectedPowerStateNotification(context=None, **kwargs)[source]

Bases: NotificationBase

Notification for when a node’s power state is corrected in the database.

This notification is emitted when ironic detects that the actual power state on a bare metal hardware is different from the power state on an ironic node (DB). This notification is emitted after the database is updated to reflect this correction.

VERSION = '1.0'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property created_at
property event_type
fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'event_type': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'level': NotificationLevel(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False,valid_values=('debug', 'info', 'warning', 'error', 'critical')), 'payload': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'publisher': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property level
property payload
property publisher
property updated_at
class ironic.objects.node.NodeCorrectedPowerStatePayload(node, from_power)[source]

Bases: NodePayload

Notification payload schema for when a node’s power state is corrected.

“from_power” indicates the previous power state on the ironic node before the node was updated.

VERSION = '1.17'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property bios_interface
property boot_interface
property boot_mode
property clean_step
property conductor_group
property console_enabled
property console_interface
property created_at
property deploy_interface
property deploy_step
property description
property disable_power_off
property driver
property extra
property fault
fields = {'bios_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_mode': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'clean_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'conductor_group': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_enabled': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'description': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disable_power_off': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'fault': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'from_power': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspect_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_finished_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_started_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'last_error': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'lessee': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'management_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'network_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'owner': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'properties': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'raid_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'rescue_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'resource_class': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'secure_boot': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'storage_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'traits': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'vendor_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property from_power
property inspect_interface
property inspection_finished_at
property inspection_started_at
property instance_uuid
property last_error
property lessee
property maintenance
property maintenance_reason
property management_interface
property name
property network_interface
property owner
property power_interface
property power_state
property properties
property protected
property protected_reason
property provision_state
property provision_updated_at
property raid_interface
property rescue_interface
property resource_class
property retired
property retired_reason
property secure_boot
property storage_interface
property target_power_state
property target_provision_state
property traits
property updated_at
property uuid
property vendor_interface
class ironic.objects.node.NodeMaintenanceNotification(context=None, **kwargs)[source]

Bases: NotificationBase

Notification emitted when maintenance state changed via API.

VERSION = '1.0'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property created_at
property event_type
fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'event_type': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'level': NotificationLevel(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False,valid_values=('debug', 'info', 'warning', 'error', 'critical')), 'payload': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'publisher': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property level
property payload
property publisher
property updated_at
class ironic.objects.node.NodePayload(node, **kwargs)[source]

Bases: NotificationPayloadBase

Base class used for all notification payloads about a Node object.

SCHEMA = {'bios_interface': ('node', 'bios_interface'), 'boot_interface': ('node', 'boot_interface'), 'boot_mode': ('node', 'boot_mode'), 'clean_step': ('node', 'clean_step'), 'conductor_group': ('node', 'conductor_group'), 'console_enabled': ('node', 'console_enabled'), 'console_interface': ('node', 'console_interface'), 'created_at': ('node', 'created_at'), 'deploy_interface': ('node', 'deploy_interface'), 'deploy_step': ('node', 'deploy_step'), 'description': ('node', 'description'), 'disable_power_off': ('node', 'disable_power_off'), 'driver': ('node', 'driver'), 'extra': ('node', 'extra'), 'fault': ('node', 'fault'), 'inspect_interface': ('node', 'inspect_interface'), 'inspection_finished_at': ('node', 'inspection_finished_at'), 'inspection_started_at': ('node', 'inspection_started_at'), 'instance_uuid': ('node', 'instance_uuid'), 'last_error': ('node', 'last_error'), 'lessee': ('node', 'lessee'), 'maintenance': ('node', 'maintenance'), 'maintenance_reason': ('node', 'maintenance_reason'), 'management_interface': ('node', 'management_interface'), 'name': ('node', 'name'), 'network_interface': ('node', 'network_interface'), 'owner': ('node', 'owner'), 'power_interface': ('node', 'power_interface'), 'power_state': ('node', 'power_state'), 'properties': ('node', 'properties'), 'protected': ('node', 'protected'), 'protected_reason': ('node', 'protected_reason'), 'provision_state': ('node', 'provision_state'), 'provision_updated_at': ('node', 'provision_updated_at'), 'raid_interface': ('node', 'raid_interface'), 'rescue_interface': ('node', 'rescue_interface'), 'resource_class': ('node', 'resource_class'), 'retired': ('node', 'retired'), 'retired_reason': ('node', 'retired_reason'), 'secure_boot': ('node', 'secure_boot'), 'storage_interface': ('node', 'storage_interface'), 'target_power_state': ('node', 'target_power_state'), 'target_provision_state': ('node', 'target_provision_state'), 'updated_at': ('node', 'updated_at'), 'uuid': ('node', 'uuid'), 'vendor_interface': ('node', 'vendor_interface')}
VERSION = '1.17'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property bios_interface
property boot_interface
property boot_mode
property clean_step
property conductor_group
property console_enabled
property console_interface
property created_at
property deploy_interface
property deploy_step
property description
property disable_power_off
property driver
property extra
property fault
fields = {'bios_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_mode': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'clean_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'conductor_group': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_enabled': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'description': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disable_power_off': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'fault': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspect_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_finished_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_started_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'last_error': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'lessee': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'management_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'network_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'owner': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'properties': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'raid_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'rescue_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'resource_class': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'secure_boot': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'storage_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'traits': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'vendor_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property inspect_interface
property inspection_finished_at
property inspection_started_at
property instance_uuid
property last_error
property lessee
property maintenance
property maintenance_reason
property management_interface
property name
property network_interface
property owner
property power_interface
property power_state
property properties
property protected
property protected_reason
property provision_state
property provision_updated_at
property raid_interface
property rescue_interface
property resource_class
property retired
property retired_reason
property secure_boot
property storage_interface
property target_power_state
property target_provision_state
property traits
property updated_at
property uuid
property vendor_interface
class ironic.objects.node.NodeSetPowerStateNotification(context=None, **kwargs)[source]

Bases: NotificationBase

Notification emitted when ironic changes a node’s power state.

VERSION = '1.0'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property created_at
property event_type
fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'event_type': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'level': NotificationLevel(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False,valid_values=('debug', 'info', 'warning', 'error', 'critical')), 'payload': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'publisher': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property level
property payload
property publisher
property updated_at
class ironic.objects.node.NodeSetPowerStatePayload(node, to_power)[source]

Bases: NodePayload

Payload schema for when ironic changes a node’s power state.

VERSION = '1.17'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property bios_interface
property boot_interface
property boot_mode
property clean_step
property conductor_group
property console_enabled
property console_interface
property created_at
property deploy_interface
property deploy_step
property description
property disable_power_off
property driver
property extra
property fault
fields = {'bios_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_mode': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'clean_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'conductor_group': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_enabled': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'description': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disable_power_off': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'fault': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspect_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_finished_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_started_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'last_error': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'lessee': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'management_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'network_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'owner': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'properties': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'raid_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'rescue_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'resource_class': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'secure_boot': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'storage_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'to_power': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'traits': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'vendor_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property inspect_interface
property inspection_finished_at
property inspection_started_at
property instance_uuid
property last_error
property lessee
property maintenance
property maintenance_reason
property management_interface
property name
property network_interface
property owner
property power_interface
property power_state
property properties
property protected
property protected_reason
property provision_state
property provision_updated_at
property raid_interface
property rescue_interface
property resource_class
property retired
property retired_reason
property secure_boot
property storage_interface
property target_power_state
property target_provision_state
property to_power
property traits
property updated_at
property uuid
property vendor_interface
class ironic.objects.node.NodeSetProvisionStateNotification(context=None, **kwargs)[source]

Bases: NotificationBase

Notification emitted when ironic changes a node provision state.

VERSION = '1.0'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property created_at
property event_type
fields = {'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'event_type': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'level': NotificationLevel(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False,valid_values=('debug', 'info', 'warning', 'error', 'critical')), 'payload': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'publisher': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property level
property payload
property publisher
property updated_at
class ironic.objects.node.NodeSetProvisionStatePayload(node, prev_state, prev_target, event)[source]

Bases: NodePayload

Payload schema for when ironic changes a node provision state.

SCHEMA = {'bios_interface': ('node', 'bios_interface'), 'boot_interface': ('node', 'boot_interface'), 'boot_mode': ('node', 'boot_mode'), 'clean_step': ('node', 'clean_step'), 'conductor_group': ('node', 'conductor_group'), 'console_enabled': ('node', 'console_enabled'), 'console_interface': ('node', 'console_interface'), 'created_at': ('node', 'created_at'), 'deploy_interface': ('node', 'deploy_interface'), 'deploy_step': ('node', 'deploy_step'), 'description': ('node', 'description'), 'disable_power_off': ('node', 'disable_power_off'), 'driver': ('node', 'driver'), 'driver_internal_info': ('node', 'driver_internal_info'), 'extra': ('node', 'extra'), 'fault': ('node', 'fault'), 'inspect_interface': ('node', 'inspect_interface'), 'inspection_finished_at': ('node', 'inspection_finished_at'), 'inspection_started_at': ('node', 'inspection_started_at'), 'instance_info': ('node', 'instance_info'), 'instance_uuid': ('node', 'instance_uuid'), 'last_error': ('node', 'last_error'), 'lessee': ('node', 'lessee'), 'maintenance': ('node', 'maintenance'), 'maintenance_reason': ('node', 'maintenance_reason'), 'management_interface': ('node', 'management_interface'), 'name': ('node', 'name'), 'network_interface': ('node', 'network_interface'), 'owner': ('node', 'owner'), 'power_interface': ('node', 'power_interface'), 'power_state': ('node', 'power_state'), 'properties': ('node', 'properties'), 'protected': ('node', 'protected'), 'protected_reason': ('node', 'protected_reason'), 'provision_state': ('node', 'provision_state'), 'provision_updated_at': ('node', 'provision_updated_at'), 'raid_interface': ('node', 'raid_interface'), 'rescue_interface': ('node', 'rescue_interface'), 'resource_class': ('node', 'resource_class'), 'retired': ('node', 'retired'), 'retired_reason': ('node', 'retired_reason'), 'secure_boot': ('node', 'secure_boot'), 'storage_interface': ('node', 'storage_interface'), 'target_power_state': ('node', 'target_power_state'), 'target_provision_state': ('node', 'target_provision_state'), 'updated_at': ('node', 'updated_at'), 'uuid': ('node', 'uuid'), 'vendor_interface': ('node', 'vendor_interface')}
VERSION = '1.18'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

property bios_interface
property boot_interface
property boot_mode
property clean_step
property conductor_group
property console_enabled
property console_interface
property created_at
property deploy_interface
property deploy_step
property description
property disable_power_off
property driver
property driver_internal_info
property event
property extra
property fault
fields = {'bios_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'boot_mode': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'clean_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'conductor_group': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_enabled': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'console_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deploy_step': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'description': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disable_power_off': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'driver_internal_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'event': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'fault': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspect_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_finished_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'inspection_started_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'instance_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'last_error': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'lessee': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'maintenance_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'management_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'network_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'owner': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'previous_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'previous_target_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'properties': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'protected_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'provision_updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'raid_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'rescue_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'resource_class': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'retired_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'secure_boot': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'storage_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_power_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'target_provision_state': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'traits': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'vendor_interface': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

The fields present in this object as key:field pairs.

For example:

fields = {
    'foo': obj_fields.IntegerField(),
    'bar': obj_fields.StringField(),
}
property inspect_interface
property inspection_finished_at
property inspection_started_at
property instance_info
property instance_uuid
property last_error
property lessee
property maintenance
property maintenance_reason
property management_interface
property name
property network_interface
property owner
property power_interface
property power_state
property previous_provision_state
property previous_target_provision_state
property properties
property protected
property protected_reason
property provision_state
property provision_updated_at
property raid_interface
property rescue_interface
property resource_class
property retired
property retired_reason
property secure_boot
property storage_interface
property target_power_state
property target_provision_state
property traits
property updated_at
property uuid
property vendor_interface