ironic.objects.portgroup
Module¶ironic.objects.portgroup.
Portgroup
(context=None, **kwargs)[source]¶Bases: ironic.objects.base.IronicObject
, oslo_versionedobjects.base.VersionedObjectDictCompat
create
(context=None)[source]¶Create a Portgroup 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.: Portgroup(context) |
---|---|
Raises: | DuplicateName, MACAlreadyExists, PortgroupAlreadyExists |
destroy
(context=None)[source]¶Delete the Portgroup 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.: Portgroup(context) |
---|---|
Raises: | PortgroupNotEmpty, PortgroupNotFound |
get
(context, portgroup_ident)[source]¶Find a portgroup based on its id, uuid, name or address.
Parameters: |
|
---|---|
Returns: | A |
Raises: | InvalidIdentity |
get_by_address
(context, address)[source]¶Find a portgroup based on address and return a Portgroup
object.
Parameters: |
|
---|---|
Returns: | A |
Raises: | PortgroupNotFound |
get_by_id
(context, portgroup_id)[source]¶Find a portgroup based on its integer ID and return a Portgroup object.
Parameters: |
|
---|---|
Returns: | A |
Raises: | PortgroupNotFound |
get_by_name
(context, name)[source]¶Find a portgroup based on name and return a Portgroup
object.
Parameters: |
|
---|---|
Returns: | A |
Raises: | PortgroupNotFound |
get_by_uuid
(context, uuid)[source]¶Find a portgroup based on UUID and return a Portgroup
object.
Parameters: |
|
---|---|
Returns: | A |
Raises: | PortgroupNotFound |
list
(context, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of Portgroup objects.
Parameters: |
|
---|---|
Returns: | A list of |
Raises: | InvalidParameterValue |
list_by_node_id
(context, node_id, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of Portgroup objects associated with a given node ID.
Parameters: |
|
---|---|
Returns: | A list of |
Raises: | InvalidParameterValue |
refresh
(context=None)[source]¶Loads updates for this Portgroup.
Loads a portgroup with the same uuid from the database and checks for updated attributes. Updates are applied from the loaded portgroup column by column, if there are any updates.
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.: Portgroup(context) |
---|---|
Raises: | PortgroupNotFound |
save
(context=None)[source]¶Save updates to this Portgroup.
Updates will be made column by column based on the result of self.what_changed().
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.: Portgroup(context) |
---|---|
Raises: | PortgroupNotFound, DuplicateName, MACAlreadyExists |
ironic.objects.portgroup.
PortgroupCRUDNotification
(context=None, **kwargs)[source]¶Bases: ironic.objects.notification.NotificationBase
Notification when ironic creates, updates or deletes a portgroup.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.