ironic.objects.volume_target.
VolumeTarget
(context=None, **kwargs)[source]¶Bases: ironic.objects.base.IronicObject
, oslo_versionedobjects.base.VersionedObjectDictCompat
create
(context=None)[source]¶Create a VolumeTarget 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.: VolumeTarget(context). |
---|---|
Raises: | VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same node ID and boot index |
Raises: | VolumeTargetAlreadyExists if a volume target with the same UUID exists |
destroy
(context=None)[source]¶Delete the VolumeTarget 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.: VolumeTarget(context). |
---|---|
Raises: | VolumeTargetNotFound if the volume target cannot be found |
get
(context, ident)[source]¶Find a volume target based on its ID or UUID.
Parameters: |
|
---|---|
Returns: | a |
Raises: | InvalidIdentity if ident is neither an integer ID nor a UUID |
Raises: | 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.
Parameters: |
|
---|---|
Returns: | a |
Raises: | VolumeTargetNotFound if no volume target with this ID exists |
get_by_uuid
(context, uuid)[source]¶Find a volume target based on its UUID.
Parameters: |
|
---|---|
Returns: | a |
Raises: | VolumeTargetNotFound if no volume target with this UUID exists |
list
(context, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of VolumeTarget objects.
Parameters: |
|
---|---|
Returns: | a list of |
Raises: | 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.
Parameters: |
|
---|---|
Returns: | a list of |
Raises: | 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.
Parameters: |
|
---|---|
Returns: | a list of |
Raises: | InvalidParameterValue if sort_key does not exist |
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.
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.: VolumeTarget(context). |
---|---|
Raises: | 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().
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.: VolumeTarget(context). |
---|---|
Raises: | InvalidParameterValue if the UUID is being changed |
Raises: | VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same node ID and boot index values |
Raises: | VolumeTargetNotFound if the volume target cannot be found |
ironic.objects.volume_target.
VolumeTargetCRUDNotification
(context=None, **kwargs)[source]¶Bases: ironic.objects.notification.NotificationBase
Notification emitted at CRUD of a volume target.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.