dellemc.openmanage.redfish_powerstate 模块 – 管理设备电源状态

注意

此模块是 dellemc.openmanage 集合（版本 9.9.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要进一步的要求才能使用此模块，请参阅 要求 了解详情。

要在 playbook 中使用它，请指定：dellemc.openmanage.redfish_powerstate。

dellemc.openmanage 2.1.0 中的新增功能

概要

• 此模块允许管理指定设备的不同电源状态。

要求

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

• python >= 3.9.6

参数

参数	注释
baseuri 字符串 / 必需	目标带外控制器的 IP 地址。例如 - <ipaddress>:<port>。
ca_path 路径 在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
oem_reset_type 字典 在 dellemc.openmanage 9.5.0 中添加	此参数使用 OEM API 启动服务器的完整交流 (AC) 电源循环，这相当于断开电源线。 oem_reset_type 与 reset_type 互斥。 如果未提供“final_power_state”的值，则默认值为“Off”。
password 字符串	目标带外控制器的密码。 如果未提供密码，则使用环境变量 IDRAC_PASSWORD。 示例：export IDRAC_PASSWORD=password
reset_type 字符串	此选项重置设备。 ForceOff 立即关闭设备。 ForceOn 立即打开设备。 ForceRestart 立即关闭设备，然后重新启动服务器。 GracefulRestart 执行设备的正常关闭，然后重新启动设备。 GracefulShutdown 执行设备的正常关闭，然后关闭设备。 Nmi 向设备发送诊断中断。此选项通常是 x86 系统上的非屏蔽中断 (NMI)。 On 打开设备。 PowerCycle 对设备执行电源循环。 PushPowerButton 模拟按下设备上的物理电源按钮。 reset_type 与 oem_reset_type 互斥。 当执行设备不支持的电源控制操作时，将显示一条错误消息，其中包含可以执行的操作列表。 选择 "ForceOff" "ForceOn" "ForceRestart" "GracefulRestart" "GracefulShutdown" "Nmi" "On" "PowerCycle" "PushPowerButton"
resource_id 字符串	此选项是被管理设备的唯一标识符。例如，https://<I(baseuri>/redfish/v1/Systems/<resource_id>)。 对于具有多个设备的 base_uri，此选项是必需的。 要获取设备详细信息，请使用 API https://<I(baseuri>/redfish/v1/Systems) 进行 reset_type 操作，并使用 https://<I(baseuri>/redfish/v1/Chassis) 进行 oem_reset_type 操作。
timeout 整数 在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时时间（以秒为单位）。 默认值： 30
username 字符串	目标带外控制器的用户名。 如果未提供用户名，则使用环境变量 IDRAC_USERNAME。 示例：export IDRAC_USERNAME=username
validate_certs 布尔值 在 dellemc.openmanage 5.0.0 中添加	如果 false，则不会验证 SSL 证书。 仅在个人控制的站点上使用自签名证书时配置 false。 在集合版本 5.0.0 之前，validate_certs 默认值为 false。 选择 false true ← （默认）
x_auth_token 字符串 在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。 如果未提供 x_auth_token，则使用环境变量 IDRAC_X_AUTH_TOKEN。 示例：export IDRAC_X_AUTH_TOKEN=x_auth_token

注释

注意

• 从可以直接访问 Redfish API 的系统运行此模块。

• 此模块支持 check_mode。

示例

---
- name: Manage power state of the first device
  dellemc.openmanage.redfish_powerstate:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    reset_type: "On"

- name: Manage power state of a specified device
  dellemc.openmanage.redfish_powerstate:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    reset_type: "ForceOff"
    resource_id: "System.Embedded.1"

- name: Perform AC Power Cycle with final power state On
  dellemc.openmanage.redfish_powerstate:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    oem_reset_type:
      dell:
        final_power_state: "On"
        reset_type: "PowerCycle"

- name: Perform AC Power Cycle  with final power state Off
  dellemc.openmanage.redfish_powerstate:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    oem_reset_type:
      dell:
        final_power_state: "Off"
        reset_type: "PowerCycle"

返回值

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

键	描述
error_info 字典	HTTP 错误的详细信息。 返回: 在 HTTP 错误时返回 示例: {"error": {"@Message.ExtendedInfo": [{"Message": "由于资源 /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset 未找到，无法完成操作。", "MessageArgs": ["/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset"], "MessageArgs@odata.count": 1, "MessageId": "IDRAC.2.1.SYS403", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "输入正确的资源并重试操作。有关有效资源的信息，请参阅支持站点上提供的Redfish用户指南。", "Severity": "Critical"}], "code": "Base.1.5.GeneralError", "message": "发生一般错误。请参阅ExtendedInfo了解更多信息"}}
msg 字符串	重置操作的总体状态。 返回: 总是返回 示例: "成功执行了重置类型操作 'On'。"

作者

• Sajna Shetty(@Sajna-Shetty)

• Lovepreet Singh (@singh-lovepreet1)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）