ironic.objects.port module
updated: 2022-09-20 12:35
ironic.objects.port module
-
class ironic.objects.port.Port(context=None, **kwargs)[source]
Bases: ironic.objects.base.IronicObject
, oslo_versionedobjects.base.VersionedObjectDictCompat
-
VERSION = '1.10'
-
property address
-
create(context=None)[source]
Create a Port 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.: Port(context)
- Raises
MACAlreadyExists if ‘address’ column is not unique
- Raises
PortAlreadyExists if ‘uuid’ column is not unique
-
property created_at
-
dbapi = <oslo_db.api.DBAPI object>
-
destroy(context=None)[source]
Delete the Port 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.: Port(context)
- Raises
PortNotFound
-
fields = {'address': MACAddress(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), 'internal_info': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'is_smartnic': Boolean(default=False,nullable=True), 'local_link_connection': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'node_id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'physical_network': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'portgroup_id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'pxe_enabled': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}
-
classmethod get(context, port_id)[source]
Find a port.
Find a port based on its id or uuid or name or MAC address and return
a Port object.
- Parameters
-
- Returns
a Port
object.
- Raises
InvalidIdentity
-
classmethod get_by_address(context, address, owner=None, project=None)[source]
Find a port based on address and return a Port
object.
- Parameters
cls – the Port
context – Security context
address – the address of a port.
owner – DEPRECATED a node owner to match against
project – a node owner or lessee to match against
- Returns
a Port
object.
- Raises
PortNotFound
-
classmethod get_by_id(context, port_id)[source]
Find a port based on its integer ID and return a Port object.
- Parameters
-
- Returns
a Port
object.
- Raises
PortNotFound
-
classmethod get_by_name(context, name)[source]
Find a port based on name and return a Port
object.
- Parameters
-
- Returns
a Port
object.
- Raises
PortNotFound
-
classmethod get_by_uuid(context, uuid)[source]
Find a port based on UUID and return a Port
object.
- Parameters
-
- Returns
a Port
object.
- Raises
PortNotFound
-
property id
-
property internal_info
-
property is_smartnic
-
classmethod list(context, limit=None, marker=None, sort_key=None, sort_dir=None, owner=None, project=None)[source]
Return a list of Port 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”.
owner – DEPRECATED a node owner to match against
project – a node owner or lessee to match against
- Returns
a list of Port
object.
- Raises
InvalidParameterValue
-
classmethod list_by_node_id(context, node_id, limit=None, marker=None, sort_key=None, sort_dir=None, owner=None, project=None)[source]
Return a list of Port objects associated with a given node ID.
- Parameters
context – Security context.
node_id – the 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”.
owner – DEPRECATED a node owner to match against
project – a node owner or lessee to match against
- Returns
a list of Port
object.
-
classmethod list_by_portgroup_id(context, portgroup_id, limit=None, marker=None, sort_key=None, sort_dir=None, owner=None, project=None)[source]
Return a list of Port objects associated with a given portgroup ID.
- Parameters
context – Security context.
portgroup_id – the ID of the portgroup.
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”.
owner – DEPRECATED a node owner to match against
project – a node owner or lessee to match against
- Returns
a list of Port
object.
-
property local_link_connection
-
property name
-
property node_id
-
property physical_network
-
property portgroup_id
-
property pxe_enabled
-
refresh(context=None)[source]
Loads updates for this Port.
Loads a port with the same uuid from the database and
checks for updated attributes. Updates are applied from
the loaded port 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.: Port(context)
- Raises
PortNotFound
-
save(context=None)[source]
Save updates to this Port.
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.: Port(context)
- Raises
PortNotFound
- Raises
MACAlreadyExists if ‘address’ column is not unique
-
classmethod supports_is_smartnic()[source]
Return whether is_smartnic field is supported.
- Returns
Whether is_smartnic field is supported
- Raises
ovo_exception.IncompatibleObjectVersion
-
classmethod supports_physical_network()[source]
Return whether the physical_network field is supported.
- Returns
Whether the physical_network field is supported
- Raises
ovo_exception.IncompatibleObjectVersion
-
property updated_at
-
property uuid
-
class ironic.objects.port.PortCRUDNotification(context=None, **kwargs)[source]
Bases: ironic.objects.notification.NotificationBase
Notification emitted when ironic creates, updates or deletes a port.
-
VERSION = '1.0'
-
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)}
-
property level
-
property payload
-
property publisher
-
property updated_at
-
class ironic.objects.port.PortCRUDPayload(port, node_uuid, portgroup_uuid)[source]
Bases: ironic.objects.notification.NotificationPayloadBase
-
SCHEMA = {'address': ('port', 'address'), 'created_at': ('port', 'created_at'), 'extra': ('port', 'extra'), 'is_smartnic': ('port', 'is_smartnic'), 'local_link_connection': ('port', 'local_link_connection'), 'name': ('port', 'name'), 'physical_network': ('port', 'physical_network'), 'pxe_enabled': ('port', 'pxe_enabled'), 'updated_at': ('port', 'updated_at'), 'uuid': ('port', 'uuid')}
-
VERSION = '1.4'
-
property address
-
property created_at
-
fields = {'address': MACAddress(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), 'is_smartnic': Boolean(default=False,nullable=True), 'local_link_connection': FlexibleDict(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'node_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'physical_network': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'portgroup_uuid': UUID(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'pxe_enabled': Boolean(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)}
-
property is_smartnic
-
property local_link_connection
-
property name
-
property node_uuid
-
property physical_network
-
property portgroup_uuid
-
property pxe_enabled
-
property updated_at
-
property uuid
updated: 2022-09-20 12:35