ironic.objects.volume_target.
VolumeTarget
(context=None, **kwargs)[source]¶Bases: ironic.objects.base.IronicObject
, oslo_versionedobjects.base.VersionedObjectDictCompat
VERSION
= '1.0'¶boot_index
¶create
(context=None)[source]¶Create a VolumeTarget record in the DB.
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.: VolumeTarget(context).
VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same node ID and boot index
VolumeTargetAlreadyExists if a volume target with the same UUID exists
created_at
¶dbapi
= <oslo_db.api.DBAPI object>¶destroy
(context=None)[source]¶Delete the VolumeTarget from the DB.
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.: VolumeTarget(context).
VolumeTargetNotFound if the volume target cannot be found
extra
¶fields
= {'boot_index': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'node_id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'properties': FlexibleDict(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), 'volume_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'volume_type': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}¶get
(context, ident)[source]¶Find a volume target based on its ID or UUID.
context – security context
ident – the database primary key ID or the UUID of a volume target
a VolumeTarget
object
InvalidIdentity if ident is neither an integer ID nor a UUID
VolumeTargetNotFound if no volume target with this ident exists
get_by_id
(context, db_id)[source]¶Find a volume target based on its database ID.
cls – the VolumeTarget
context – security context
db_id – the database primary key (integer) ID of a volume target
a VolumeTarget
object
VolumeTargetNotFound if no volume target with this ID exists
get_by_uuid
(context, uuid)[source]¶Find a volume target based on its UUID.
cls – the VolumeTarget
context – security context
uuid – the UUID of a volume target
a VolumeTarget
object
VolumeTargetNotFound if no volume target with this UUID exists
id
¶list
(context, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of VolumeTarget objects.
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”.
a list of VolumeTarget
objects
InvalidParameterValue if sort_key does not exist
list_by_node_id
(context, node_id, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of VolumeTarget objects related to a given node ID.
context – security context
node_id – the integer ID of the node
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”.
a list of VolumeTarget
objects
InvalidParameterValue if sort_key does not exist
list_by_volume_id
(context, volume_id, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of VolumeTarget objects related to a given volume ID.
context – security context
volume_id – the UUID of the volume
limit – maximum number of volume targets 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”.
a list of VolumeTarget
objects
InvalidParameterValue if sort_key does not exist
node_id
¶properties
¶refresh
(context=None)[source]¶Loads updates for this VolumeTarget.
Load a volume target with the same UUID from the database and check for updated attributes. If there are any updates, they are applied from the loaded volume target, column by column.
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.: VolumeTarget(context).
VolumeTargetNotFound if the volume target cannot be found
save
(context=None)[source]¶Save updates to this VolumeTarget.
Updates will be made column by column based on the result of self.do_version_changes_for_db().
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.: VolumeTarget(context).
InvalidParameterValue if the UUID is being changed
VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same node ID and boot index values
VolumeTargetNotFound if the volume target cannot be found
updated_at
¶uuid
¶volume_id
¶volume_type
¶ironic.objects.volume_target.
VolumeTargetCRUDNotification
(context=None, **kwargs)[source]¶Bases: ironic.objects.notification.NotificationBase
Notification emitted at CRUD of a volume target.
VERSION
= '1.0'¶created_at
¶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)}¶level
¶payload
¶publisher
¶updated_at
¶ironic.objects.volume_target.
VolumeTargetCRUDPayload
(target, node_uuid)[source]¶Bases: ironic.objects.notification.NotificationPayloadBase
SCHEMA
= {'boot_index': ('target', 'boot_index'), 'created_at': ('target', 'created_at'), 'extra': ('target', 'extra'), 'properties': ('target', 'properties'), 'updated_at': ('target', 'updated_at'), 'uuid': ('target', 'uuid'), 'volume_id': ('target', 'volume_id'), 'volume_type': ('target', 'volume_type')}¶VERSION
= '1.0'¶boot_index
¶created_at
¶extra
¶fields
= {'boot_index': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'extra': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'node_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'properties': FlexibleDict(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), 'volume_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'volume_type': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}¶node_uuid
¶properties
¶updated_at
¶uuid
¶volume_id
¶volume_type
¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.