The ironic.objects.volume_connector Module

The ironic.objects.volume_connector Module

class ironic.objects.volume_connector.VolumeConnector(context=None, **kwargs)[source]

Bases: ironic.objects.base.IronicObject, oslo_versionedobjects.base.VersionedObjectDictCompat

create(context=None)[source]

Create a VolumeConnector 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.: VolumeConnector(context).
Raises:VolumeConnectorTypeAndIdAlreadyExists if a volume connector already exists with the same type and connector_id
Raises:VolumeConnectorAlreadyExists if a volume connector with the same UUID already exists
destroy(context=None)[source]

Delete the VolumeConnector 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.: VolumeConnector(context).
Raises:VolumeConnectorNotFound if the volume connector cannot be found
classmethod get(context, ident)[source]

Find a volume connector based on its ID or UUID.

Parameters:
  • context – security context
  • ident – the database primary key ID or the UUID of a volume connector
Returns:

a VolumeConnector object

Raises:

InvalidIdentity if ident is neither an integer ID nor a UUID

Raises:

VolumeConnectorNotFound if no volume connector exists with the specified ident

classmethod get_by_id(context, db_id)[source]

Find a volume connector based on its integer ID.

Parameters:
  • cls – the VolumeConnector
  • context – Security context.
  • db_id – The integer (database primary key) ID of a volume connector.
Returns:

A VolumeConnector object.

Raises:

VolumeConnectorNotFound if no volume connector exists with the specified ID.

classmethod get_by_uuid(context, uuid)[source]

Find a volume connector based on its UUID.

Parameters:
  • cls – the VolumeConnector
  • context – security context
  • uuid – the UUID of a volume connector
Returns:

a VolumeConnector object

Raises:

VolumeConnectorNotFound if no volume connector exists with the specified UUID

classmethod list(context, limit=None, marker=None, sort_key=None, sort_dir=None)[source]

Return a list of VolumeConnector objects.

Parameters:
  • 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”.
Returns:

a list of VolumeConnector objects

Raises:

InvalidParameterValue if sort_key does not exist

classmethod list_by_node_id(context, node_id, limit=None, marker=None, sort_key=None, sort_dir=None)[source]

Return a list of VolumeConnector objects related to a given node ID.

Parameters:
  • 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”.
Returns:

a list of VolumeConnector objects

Raises:

InvalidParameterValue if sort_key does not exist

refresh(context=None)[source]

Load updates for this VolumeConnector.

Load a volume connector with the same UUID from the database and check for updated attributes. If there are any updates, they are applied from the loaded volume connector, 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.: VolumeConnector(context).
save(context=None)[source]

Save updates to this VolumeConnector.

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.: VolumeConnector(context).
Raises:VolumeConnectorNotFound if the volume connector cannot be found
Raises:VolumeConnectorTypeAndIdAlreadyExists if another connector already exists with the same values for type and connector_id fields
Raises:InvalidParameterValue when the UUID is being changed
class ironic.objects.volume_connector.VolumeConnectorCRUDNotification(context=None, **kwargs)[source]

Bases: ironic.objects.notification.NotificationBase

Notification emitted at CRUD of a volume connector.

class ironic.objects.volume_connector.VolumeConnectorCRUDPayload(connector, node_uuid)[source]

Bases: ironic.objects.notification.NotificationPayloadBase

Payload schema for CRUD of a volume connector.

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.