dellemc.openmanage.ome_powerstate – Performs the power management operations on OpenManage Enterprise
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.openmanage.
To use it in a playbook, specify: dellemc.openmanage.ome_powerstate.
New in version 2.1.0: of dellemc.openmanage
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 >= 2.7.5
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| device_id
integer
|
Targeted device id.
device_id is mutually exclusive with device_service_tag.
|
|
| device_service_tag
string
|
Targeted device service tag.
device_service_tag is mutually exclusive with device_id.
|
|
| hostname
string / required
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
|
|
| password
string / required
|
OpenManage Enterprise or OpenManage Enterprise Modular password.
|
|
| port
integer
|
Default:
443
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
|
| power_state
string / required
|
|
Desired end power state.
|
| username
string / required
|
OpenManage Enterprise or OpenManage Enterprise Modular username.
|
Notes
Note
- Run this module from a system that has direct access to DellEMC 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"
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"
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"
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"
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 | Returned | Description |
|---|---|---|
| job_status
dictionary
|
success |
Power state operation job and progress details from the OME.
Sample:
{'Builtin': False, 'CreatedBy': 'user', 'Editable': True, 'EndTime': None, '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': None, 'Params': [{'JobId': 11111, 'Key': 'powerState', 'Value': '2'}, {'JobId': 11111, 'Key': 'operationName', 'Value': 'POWER_CONTROL'}], 'Schedule': '', 'StartTime': None, 'State': 'Enabled', 'Targets': [{'Data': '', 'Id': 11112, 'JobId': 11111, 'TargetType': {'Id': 1000, 'Name': 'DEVICE'}}], 'UpdatedBy': None, 'Visible': True}
|
| msg
string
|
always |
Overall power state operation job status.
Sample:
Power State operation job submitted successfully.
|
Authors
- Felix Stephen (@felixs88)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_powerstate_module.html