ironicclient.v1.portgroup 模块¶
- class ironicclient.v1.portgroup.PortgroupManager(api)[源代码]¶
基类:
CreateManager- delete(portgroup_id, os_ironic_api_version=None, global_request_id=None)[源代码]¶
从数据库中删除 Portgroup。
- 参数：
portgroup_id – portgroup 的 UUID 或名称。
os_ironic_api_version – 用于请求的版本字符串（例如“1.35”）。如果未指定，则使用客户端的默认值。
global_request_id – 用于请求的全局请求 ID 标头值的字符串（格式为“req-<UUID>”）。
- get(portgroup_id, fields=None, os_ironic_api_version=None, global_request_id=None)[源代码]¶
获取具有指定标识符的端口组。
- 参数：
portgroup_id – portgroup 的 UUID 或名称。
fields – 可选，包含要返回的资源指定字段列表。当设置“detail”时，无法使用。
os_ironic_api_version – 用于请求的版本字符串（例如“1.35”）。如果未指定，则使用客户端的默认值。
global_request_id – 用于请求的全局请求 ID 标头值的字符串（格式为“req-<UUID>”）。
- 返回值:
一个
Portgroup对象。
- get_by_address(address, fields=None, os_ironic_api_version=None, global_request_id=None)[源代码]¶
获取具有指定 MAC 地址的端口组。
- 参数：
address – portgroup 的 MAC 地址。
fields – 可选，包含要返回的资源指定字段列表。当设置“detail”时，无法使用。
os_ironic_api_version – 用于请求的版本字符串（例如“1.35”）。如果未指定，则使用客户端的默认值。
global_request_id – 用于请求的全局请求 ID 标头值的字符串（格式为“req-<UUID>”）。
- 返回值:
一个
Portgroup对象。
- list(node=None, address=None, limit=None, marker=None, sort_key=None, sort_dir=None, detail=False, fields=None, os_ironic_api_version=None, global_request_id=None)[源代码]¶
检索端口组列表。
- 参数：
node – 可选，节点（UUID 或名称），用于获取该节点的端口组。
address – 可选，端口组的 MAC 地址，用于获取具有该 MAC 地址的端口组。
marker – 可选，端口组的 UUID，例如前一个结果集中的最后一个端口组。返回下一个结果集。
limit –
- 每次请求返回的最大结果数，如果
limit > 0，返回操作的最大数量。
limit > 0，要返回的端口组的最大数量。
limit == 0，返回所有端口组。
limit == None，返回的项目数量遵守 Ironic API 施加的最大限制（请参阅 Ironic 的 api.max_limit 选项）。
sort_dir – 可选，排序方向，可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选，布尔值，表示是否返回操作的详细信息。
detail – 可选，一个布尔值，指示是否返回有关端口组的详细信息。
fields – 可选，包含要返回的资源指定字段列表。当设置“detail”时，无法使用。
os_ironic_api_version – 用于请求的版本字符串（例如“1.35”）。如果未指定，则使用客户端的默认值。
global_request_id – 用于请求的全局请求 ID 标头值的字符串（格式为“req-<UUID>”）。
- 返回值:
端口组列表。
- 引发:
当请求字段子集且 detail 选项设置为 True 时，将引发 InvalidAttribute 错误。
- list_ports(portgroup_id, marker=None, limit=None, sort_key=None, sort_dir=None, detail=False, fields=None, os_ironic_api_version=None, global_request_id=None)[源代码]¶
列出给定端口组的所有端口。
- 参数：
portgroup_id – 端口组的名称或 UUID。
marker – 可选，端口的 UUID，例如前一个结果集中的最后一个端口。返回下一个结果集。
limit –
- 每次请求返回的最大结果数，如果
limit > 0，返回操作的最大数量。
limit > 0，返回的最大端口数。
limit == 0，返回整个端口列表。
limit 参数未指定 (None)，返回的项目数量受 Ironic API 施加的最大限制影响（请参阅 Ironic 的 api.max_limit 选项）。
sort_dir – 可选，排序方向，可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选，布尔值，表示是否返回操作的详细信息。
detail – 可选，一个布尔值，指示是否返回有关端口的详细信息。
fields – 可选，包含要返回的资源指定字段列表。当设置“detail”时，无法使用。
os_ironic_api_version – 用于请求的版本字符串（例如“1.35”）。如果未指定，则使用客户端的默认值。
global_request_id – 用于请求的全局请求 ID 标头值的字符串（格式为“req-<UUID>”）。
- 返回值:
端口列表。
