dellemc.openmanage.ome_powerstate module – Performs the power management operations on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_powerstate
.
New in dellemc.openmanage 2.1.0
Synopsis
This module performs the supported power management operations on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Targeted device id. device_id is mutually exclusive with device_service_tag. |
|
Targeted device service tag. device_service_tag is mutually exclusive with device_id. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Desired end power state. Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode
.
Examples
---
- 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" }
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Power state operation job and progress details from the OME. Returned: success Sample: |
|
Overall power state operation job status. Returned: always Sample: |