ironicclient.v1.port 模块

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

基类: Resource

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

基类: CreateManager

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

检索端口列表。

参数：

  • address – 可选，端口的 MAC 地址，用于获取具有此 MAC 地址的端口

  • marker – 可选，端口的 UUID，例如前一个结果集中的最后一个端口。返回下一个结果集。

  • limit –

    每次请求返回的最大结果数，如果

    limit > 0，返回操作的最大数量。

    1. limit > 0，返回的最大端口数。

    2. limit == 0，返回整个端口列表。

    3. limit 参数未指定 (None)，返回的项目数量受 Ironic API 施加的最大限制影响（请参阅 Ironic 的 api.max_limit 选项）。

  • sort_dir – 可选，排序方向，可以是 ‘asc’ (默认) 或 ‘desc’。

  • detail – 可选，布尔值，表示是否返回操作的详细信息。

  • detail – 可选，一个布尔值，指示是否返回有关端口的详细信息。

  • fields – 可选，包含要返回的资源指定字段列表。当设置“detail”时，无法使用。

  • node – 可选，节点的名称或 UUID。用于获取此节点的端口。

  • portgroup – 可选，端口组的名称或 UUID。用于获取此端口组的端口。

  • os_ironic_api_version – 用于请求的版本字符串（例如“1.35”）。如果未指定，则使用客户端的默认值。

  • global_request_id – 用于请求的全局请求 ID 标头值的字符串（格式为“req-<UUID>”）。

返回值:

端口列表。

resource_class

别名：Port

update(port_id, patch, os_ironic_api_version=None, global_request_id=None)[source]