community.general.ipmi_power 模块 – 机器电源管理

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定： community.general.ipmi_power。

概要 

使用此模块进行电源管理

要求 

执行此模块的主机需要以下要求。

pyghmi

参数 

参数	注释
key 字符串在 community.general 4.1.0 中添加	以十六进制格式连接到 BMC 的加密密钥。
machine 列表 / 元素=字典在 community.general 4.3.0 中添加	提供桥接 IPMI 请求的远程目标地址和电源状态的列表。此选项或 `state` 是必需的。
state 字符串	是否确保由 `machine[].targetAddress` 指定的机器处于所需状态。如果未设置此选项，则电源状态由 `state` 设置。如果同时设置此选项和 `state`，则此选项优先于 `state`。选项 `"on"` `"off"` `"shutdown"` `"reset"` `"boot"`
targetAddress 整数 / 必需	桥接 IPMI 请求的远程目标地址。
name 字符串 / 必需	BMC 的主机名或 IP 地址。
password 字符串 / 必需	连接到 BMC 的密码。
port 整数	远程 RMCP 端口。默认值： `623`
state 字符串	是否确保机器处于所需状态。 state 的选项为：- on – 请求系统启动 - off – 请求系统关闭，无需等待操作系统关闭 - shutdown – 让系统请求操作系统正常关闭 - reset – 请求系统重置，无需等待操作系统 - boot – 如果系统关闭，则为“on”，否则为“reset” 此选项或 `machine` 是必需的。选项 `"on"` `"off"` `"shutdown"` `"reset"` `"boot"`
timeout 整数	中断请求之前的最大秒数。默认值： `300`
user 字符串 / 必需	用于连接到 BMC 的用户名。

属性 

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

示例 

- name: Ensure machine is powered on
  community.general.ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    state: 'on'

- name: Ensure machines of which remote target address is 48 and 50 are powered off
  community.general.ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    state: 'off'
    machine:
      - targetAddress: 48
      - targetAddress: 50

- name: Ensure machine of which remote target address is 48 is powered on, and 50 is powered off
  community.general.ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    machine:
      - targetAddress: 48
        state: 'on'
      - targetAddress: 50
        state: 'off'

返回值 

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

键	描述
powerstate 字符串	机器的当前电源状态。返回：成功，并且未提供`machine` 示例：`"on"`
状态列表 / 元素=字典在 community.general 4.3.0 中添加	设置machine选项时，机器的当前电源状态。返回：成功，并且已提供`machine` 示例：`[{"powerstate": "on", "targetAddress": 48}, {"powerstate": "on", "targetAddress": 50}]`
powerstate 字符串	由`status[].targetAddress`指定的机器的当前电源状态。返回：成功
targetAddress 整数	远程目标地址。返回：成功

作者

Bulat Gaifullin (@bgaifullin)