# ironicclient.v1.port module

class ironicclient.v1.port.Port(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)

  Bases: `Resource`

class ironicclient.v1.port.PortManager(api: SessionClient)

  Bases: `CreateManager`[`Port`]

  delete(port_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) → None
  get(port_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) → Port | None
  get_by_address(address: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) → Port
  list(address: str | None = None, limit: int | None = None, marker: str | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, node: str | None = None, portgroup: str | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) → list[Port]

    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.

      - os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.

      - global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.

    Returns:

      A list of ports.

  resource_class

    alias of `Port`

  update(port_id: str, patch: list[dict[str, Any]], os_ironic_api_version: str | None = None, global_request_id: str | None = None) → Port

this page last updated: 2026-07-16 03:09:15

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug