None
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.
Port.
convert_with_links
(rpc_port, fields=None)¶Port.
sample
(expand=True)¶None
Bases: ironic.api.controllers.v1.collection.Collection
API representation of a collection of ports.
PortCollection.
convert_with_links
(rpc_ports, limit, url=None, fields=None, **kwargs)¶PortCollection.
sample
()¶None
Bases: ironic.api.controllers.v1.types.JsonPatchType
PortPatchType.
internal_attrs
()¶Returns a list of internal attributes.
Internal attributes can’t be added, replaced or removed. This method may be overwritten by derived class.
None
Bases: pecan.rest.RestController
REST controller for Ports.
PortsController.
delete
(port_uuid)[source]¶Delete a port.
Parameters: | port_uuid – UUID of a port. |
---|---|
Raises: | OperationNotPermitted, HTTPNotFound |
PortsController.
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
Parameters: |
|
---|---|
Raises: | NotAcceptable, HTTPNotFound |
PortsController.
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
Parameters: |
|
---|---|
Raises: | NotAcceptable, HTTPNotFound |
PortsController.
get_one
(port_uuid, fields=None)[source]¶Retrieve information about the given port.
Parameters: |
|
---|---|
Raises: | NotAcceptable, HTTPNotFound |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.