ironicclient.v1.chassis 模块¶
- class ironicclient.v1.chassis.ChassisManager(api)[source]¶
基类:
CreateManager- list(marker=None, limit=None, sort_key=None, sort_dir=None, detail=False, fields=None, os_ironic_api_version=None, global_request_id=None)[source]¶
检索机箱列表。
- 参数:
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>”)。
- 返回值:
机箱列表。
- list_nodes(chassis_id, marker=None, limit=None, sort_key=None, sort_dir=None, detail=False, fields=None, associated=None, maintenance=None, provision_state=None, os_ironic_api_version=None, global_request_id=None)[source]¶
列出给定机箱的所有节点。
- 参数:
chassis_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”时,无法使用。
associated – 可选。布尔值或布尔值的字符串表示形式,指示是返回关联节点(True 或 “True”)还是未关联节点(False 或 “False”)。
maintenance – 可选。布尔值或布尔值的字符串表示形式,指示是返回处于维护模式下的节点(True 或 “True”),还是未处于维护模式下的节点(False 或 “False”)。
provision_state – 可选。字符串值,用于仅获取处于该置备状态的节点。
os_ironic_api_version – 用于请求的版本字符串(例如“1.35”)。如果未指定,则使用客户端的默认值。
global_request_id – 用于请求的全局请求 ID 标头值的字符串(格式为“req-<UUID>”)。
- 返回值:
节点列表。