ironicclient.v1.allocation 模块

class ironicclient.v1.allocation.Allocation(manager, info, loaded=False)[源]

基类: Resource

class ironicclient.v1.allocation.AllocationManager(api)[源]

基类: CreateManager

delete(allocation_id, os_ironic_api_version=None, global_request_id=None)[源]

删除分配。

参数：

  • allocation_id – 分配的 UUID 或名称。

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

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

get(allocation_id, fields=None, os_ironic_api_version=None, global_request_id=None)[源]

获取指定标识符的分配。

参数：

  • allocation_id – 分配的 UUID 或名称。

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

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

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

返回值:

一个 Allocation 对象。

list(resource_class=None, state=None, node=None, limit=None, marker=None, sort_key=None, sort_dir=None, fields=None, owner=None, os_ironic_api_version=None, global_request_id=None)[源]

检索分配列表。

参数：

  • resource_class – 可选，获取具有此资源类的分配。

  • state – 可选，获取此状态下的分配。值为 allocating、active 或 error 之一。

  • node – 分配节点的 UUID 或名称。

  • 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 – 可选，布尔值，表示是否返回操作的详细信息。

  • fields – 可选，一个列表，其中包含要返回的资源的指定字段集。

  • owner – 可选，拥有分配的项目。

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

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

返回值:

分配列表。

引发:

如果请求的字段子集设置了 detail 选项，则会引发 InvalidAttribute。

resource_class

别名 Allocation

update(allocation_id, patch, os_ironic_api_version=None, global_request_id=None)[源]

更新分配。只允许 ‘name’ 和 ‘extra’ 字段。

参数：

  • allocation_id – 分配的 UUID 或名称。

  • patch – 要应用于此分配的 json PATCH 文档。

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

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

wait(allocation_id, timeout=0, poll_interval=1, poll_delay_function=None, os_ironic_api_version=None, global_request_id=None)[源]

等待分配变为 active。

参数：

  • timeout – 超时时间（秒），0 表示无超时。

  • poll_interval – 轮询间隔（秒）。

  • poll_delay_function – 轮询之间的等待函数（默认为 time.sleep）。它应该接受一个参数——等待时间（秒）。其中引发的任何异常都将中止等待。

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

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

返回值:

更新的 Allocation 对象。

引发:

如果分配进入 error 状态，则引发 StateTransitionFailed。

引发:

发生超时时引发 StateTransitionTimeout。