community.general.ocapi_info 模块 – 使用开放式可组合 API (OCAPI) 管理带外控制器

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在剧本中使用它，请指定：community.general.ocapi_info。

community.general 6.3.0 中的新增功能

概要 

在本地构建 OCAPI URI 并将其发送到远程带外控制器以获取返回信息。

参数 

参数	注释
baseuri 字符串 / 必需	带外控制器的基本 URI。
category 字符串 / 必需	在带外控制器上执行的类别。
command 字符串 / 必需	在带外控制器上执行的命令。
job_name 字符串	获取状态的作业名称。
password 字符串 / 必需	用于向带外控制器进行身份验证的密码。
proxy_slot_number 整数	对于代理的带内请求，IOM 的插槽号。仅当 `baseuri` 是代理服务器时适用。
timeout 整数	对带外控制器的 URL 请求的超时时间（秒）。默认值： `10`
username 字符串 / 必需	用于向带外控制器进行身份验证的用户名。

属性 

属性	支持	描述
check_mode	支持：完全支持此操作不会修改状态。	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：N/A 此操作不会修改状态。	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- name: Get job status
  community.general.ocapi_info:
    category: Status
    command: JobStatus
    baseuri: "http://iom1.wdc.com"
    jobName: FirmwareUpdate
    username: "{{ username }}"
    password: "{{ password }}"

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
details 列表 / 元素=字符串	相关操作的详细信息。适用于 `command=JobStatus`。返回：受支持时
msg 字符串	包含操作结果或错误说明的消息。返回：始终返回示例： `"Action was successful"`
operationHealth 字符串	操作的健康状况。适用于 `command=JobStatus`。详情请参阅 OCAPI 文档。返回：受支持时示例： `"OK"`
operationHealthId 字符串	操作健康状况的整数值（对应于 `operationHealth`）。适用于 `command=JobStatus`。详情请参阅 OCAPI 文档。返回：受支持时示例： `"OK"`
operationStatus 字符串	相关操作的状态。适用于 `command=JobStatus`。详情请参阅 OCAPI 文档。返回：受支持时示例： `"Activate needed"`
operationStatusId 整数	状态的整数值（对应于 operationStatus）。适用于 `command=JobStatus`。详情请参阅 OCAPI 文档。返回：受支持时示例： `65540`
percentComplete 整数	相关操作完成的百分比。适用于 `command=JobStatus`。返回：受支持时示例： `99`
status 字典	包含状态信息的字典。详情请参阅 OCAPI 文档。返回：受支持时示例： `{"Details": ["None"], "Health": [{"ID": 5, "Name": "OK"}], "State": {"ID": 16, "Name": "In service"}}`

作者

Mike Moerk (@mikemoerk)