ironic.api.controllers.v1.port.
Port
(**kwargs)[source]¶Bases: ironic.api.controllers.base.APIBase
API representation of a port.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a port.
address
¶MAC Address for this port
created_at
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
extra
¶This port’s meta data
internal_info
¶This port’s internal information maintained by ironic
is_smartnic
¶Indicates whether this port is a Smart NIC port.
links
¶A list containing a self link and associated port links
local_link_connection
¶The port binding profile for the port
node_uuid
¶The UUID of the node this port belongs to
physical_network
¶The name of the physical network to which this port is connected.
portgroup_uuid
¶The UUID of the portgroup this port belongs to
pxe_enabled
¶Indicates whether pxe is enabled or disabled on the node.
sanitize
(fields=None)[source]¶Removes sensitive and unrequested data.
Will only keep the fields specified in the fields
parameter.
fields (list of str) – list of fields to preserve, or None
to preserve them all
updated_at
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
uuid
¶Unique UUID for this port
ironic.api.controllers.v1.port.
PortCollection
(**kwargs)[source]¶Bases: ironic.api.controllers.v1.collection.Collection
API representation of a collection of ports.
next
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
ports
¶A list containing ports objects
ironic.api.controllers.v1.port.
PortPatchType
(**kw)[source]¶Bases: ironic.api.controllers.v1.types.JsonPatchType
internal_attrs
()[source]¶Returns a list of internal attributes.
Internal attributes can’t be added, replaced or removed. This method may be overwritten by derived class.
op
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
path
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
value
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
ironic.api.controllers.v1.port.
PortsController
(node_ident=None, portgroup_ident=None)[source]¶Bases: pecan.rest.RestController
REST controller for Ports.
advanced_net_fields
= ['pxe_enabled', 'local_link_connection']¶delete
(port_uuid)[source]¶Delete a port.
port_uuid – UUID of a port.
OperationNotPermitted, HTTPNotFound
detail
(node=None, node_uuid=None, address=None, marker=None, limit=None, sort_key='id', sort_dir='asc', portgroup=None)[source]¶Retrieve a list of ports with detail.
Note that the ‘node_uuid’ interface is deprecated in favour of the ‘node’ interface
node – UUID or name of a node, to get only ports for that node.
node_uuid – UUID of a node, to get only ports for that node.
address – MAC address of a port, to get the port which has this MAC address.
portgroup – UUID or name of a portgroup, to get only ports for that portgroup.
marker – pagination marker for large data sets.
limit – maximum number of resources to return in a single result. This value cannot be larger than the value of max_limit in the [api] section of the ironic configuration, or only max_limit resources will be returned.
sort_key – column to sort results by. Default: id.
sort_dir – direction to sort. “asc” or “desc”. Default: asc.
NotAcceptable, HTTPNotFound
get_all
(node=None, node_uuid=None, address=None, marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, portgroup=None, detail=None)[source]¶Retrieve a list of ports.
Note that the ‘node_uuid’ interface is deprecated in favour of the ‘node’ interface
node – UUID or name of a node, to get only ports for that node.
node_uuid – UUID of a node, to get only ports for that node.
address – MAC address of a port, to get the port which has this MAC address.
marker – pagination marker for large data sets.
limit – maximum number of resources to return in a single result. This value cannot be larger than the value of max_limit in the [api] section of the ironic configuration, or only max_limit resources will be returned.
sort_key – column to sort results by. Default: id.
sort_dir – direction to sort. “asc” or “desc”. Default: asc.
fields – Optional, a list with a specified set of fields of the resource to be returned.
portgroup – UUID or name of a portgroup, to get only ports for that portgroup.
NotAcceptable, HTTPNotFound
get_one
(port_uuid, fields=None)[source]¶Retrieve information about the given port.
port_uuid – UUID of a port.
fields – Optional, a list with a specified set of fields of the resource to be returned.
NotAcceptable, HTTPNotFound
invalid_sort_key_list
= ['extra', 'internal_info', 'local_link_connection']¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.