dellemc.openmanage.ome_powerstate 模块 – 在 OpenManage Enterprise 上执行电源管理操作

注意

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

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

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

要在剧本中使用它，请指定： dellemc.openmanage.ome_powerstate。

dellemc.openmanage 2.1.0 中的新增功能

概要

• 此模块在 OpenManage Enterprise 上执行受支持的电源管理操作。

要求

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

• python >= 3.9.6

参数

参数	注释
ca_path 路径 在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
device_id 整数	目标设备 ID。 device_id 与 device_service_tag 互斥。
device_service_tag 字符串	目标设备服务标签。 device_service_tag 与 device_id 互斥。
hostname 字符串 / 必需	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。 如果未提供密码，则使用环境变量 OME_PASSWORD。 示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。 默认值： 443
power_state 字符串 / 必需	所需的最终电源状态。 选项 "on" "off" "coldboot" "warmboot" "shutdown"
timeout 整数 在 dellemc.openmanage 5.0.0 中添加	以秒为单位的套接字级别超时。 默认值： 30
username 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。 如果未提供用户名，则使用环境变量 OME_USERNAME。 示例：export OME_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，则使用环境变量 OME_X_AUTH_TOKEN。 示例：export OME_X_AUTH_TOKEN=x_auth_token

注释

注意

• 从此模块可以直接访问 Dell OpenManage Enterprise 的系统运行此模块。

• 此模块支持 check_mode。

示例

---
- name: Power state operation based on device id
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 11111
    power_state: "off"

- name: Power state operation based on device service tag
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: "KLBR111"
    power_state: "on"

- name: Power state operation based on list of device ids
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: "{{ item.device_id }}"
    power_state: "{{ item.state }}"
  with_items:
    - { "device_id": 11111, "state": "on" }
    - { "device_id": 22222, "state": "off" }

- name: Power state operation based on list of device service tags
  dellemc.openmanage.ome_powerstate:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: "{{ item.service_tag }}"
    power_state: "{{ item.state }}"
  with_items:
    - { "service_tag": "KLBR111", "state": "on" }
    - { "service_tag": "KLBR222", "state": "off" }

返回值

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

键	描述
job_status 字典	来自 OME 的电源状态操作作业和进度详细信息。 返回：成功 示例： {"Builtin": false, "CreatedBy": "user", "Editable": true, "EndTime": null, "Id": 11111, "JobDescription": "DeviceAction_Task", "JobName": "DeviceAction_Task_PowerState", "JobStatus": {"Id": 1111, "Name": "New"}, "JobType": {"Id": 1, "Internal": false, "Name": "DeviceAction_Task"}, "LastRun": "2019-04-01 06:39:02.69", "LastRunStatus": {"Id": 1112, "Name": "Running"}, "NextRun": null, "Params": [{"JobId": 11111, "Key": "powerState", "Value": "2"}, {"JobId": 11111, "Key": "operationName", "Value": "POWER_CONTROL"}], "Schedule": "", "StartTime": null, "State": "Enabled", "Targets": [{"Data": "", "Id": 11112, "JobId": 11111, "TargetType": {"Id": 1000, "Name": "DEVICE"}}], "UpdatedBy": null, "Visible": true}
msg 字符串	整体电源状态操作作业状态。 返回值：始终 示例： "电源 状态 操作 作业 已成功提交。

作者

• Felix Stephen (@felixs88)

资源链接

• 问题追踪器
• 主页
• 代码仓库