The ironicclient.v1.port Module

class ironicclient.v1.port.Port(manager, info, loaded=False)[source]

Bases: ironicclient.common.base.Resource

class ironicclient.v1.port.PortManager(api)[source]

Bases: ironicclient.common.base.CreateManager

delete(port_id)[source]
get(port_id, fields=None)[source]
get_by_address(address, fields=None)[source]
list(address=None, limit=None, marker=None, sort_key=None, sort_dir=None, detail=False, fields=None, node=None, portgroup=None)[source]

Retrieve a list of ports.

Parameters:
  • address – Optional, MAC address of a port, to get the port which has this MAC address
  • marker – Optional, the UUID of a port, eg the last port from a previous result set. Return the next result set.
  • limit –
    The maximum number of results to return per
    request, if:
    1. limit > 0, the maximum number of ports to return.
    2. limit == 0, return the entire list of ports.
    3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic’s api.max_limit option).
  • sort_key – Optional, field used for sorting.
  • sort_dir – Optional, direction of sorting, either ‘asc’ (the default) or ‘desc’.
  • detail – Optional, boolean whether to return detailed information about ports.
  • fields – Optional, a list with a specified set of fields of the resource to be returned. Can not be used when ‘detail’ is set.
  • node – Optional, name or UUID of a node. Used to get ports of this node.
  • portgroup – Optional, name or UUID of a portgroup. Used to get ports of this portgroup.
Returns:

A list of ports.
resource_class

alias of Port

update(port_id, patch)[source]