dellemc.openmanage.ome_device_power_settings module – Configure chassis power settings on OpenManage Enterprise Modular
Note
This module is part of the dellemc.openmanage collection (version 9.8.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.
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_device_power_settings.
New in dellemc.openmanage 4.2.0
Synopsis
This module allows to configure the chassis power settings on OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The ID of the chassis for which the settings need to be updated. If the device ID is not specified, this module updates the power settings for the hostname. device_id is mutually exclusive with device_service_tag. |
|
The service tag of the chassis for which the setting needs to be updated. If the device service tag is not specified, this module updates the power settings for the hostname. device_service_tag is mutually exclusive with device_id. |
|
OpenManage Enterprise Modular IP address or hostname. |
|
The settings for Hot Spare configuration. |
|
Enables or disables Hot Spare configuration to facilitate voltage regulation when power utilized by the Power Supply Unit (PSU) is low. Choices:
|
|
The choices for PSU grid.
Choices:
|
|
OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise Modular HTTPS port. Default: |
|
The settings for Power configuration. |
|
Enables or disables the Power Cap Settings. Choices:
|
|
The maximum power consumption limit of the device. Specify the consumption limit in Watts. This is required if enable_power_cap is set to true. |
|
The settings for Redundancy configuration. |
|
The choices to configure the redundancy policy.
Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise Modular.
This module supports
check_mode.
Examples
---
- name: Update power configuration settings of a chassis using the device ID.
dellemc.openmanage.ome_device_power_settings:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_id: 25011
power_configuration:
enable_power_cap: true
power_cap: 3424
- name: Update redundancy configuration settings of a chassis using the device service tag.
dellemc.openmanage.ome_device_power_settings:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_service_tag: GHRT2RL
redundancy_configuration:
redundancy_policy: GRID_REDUNDANCY
- name: Update hot spare configuration settings of a chassis using device ID.
dellemc.openmanage.ome_device_power_settings:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_id: 25012
hot_spare_configuration:
enable_hot_spare: true
primary_grid: GRID_1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the device power settings. Returned: always Sample: |
|
returned when power settings are updated successfully. Returned: success Sample: |