Try SpotterConfigure chassis power settings on OpenManage Enterprise Modular
| "added in version" 4.2.0 of dellemc.openmanage"
Authors: Felix Stephen (@felixs88)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to configure the chassis power settings on OpenManage Enterprise Modular.
---
- 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
port:
default: 443
description: OpenManage Enterprise Modular HTTPS port.
type: int
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise Modular IP address or hostname.
required: true
type: str
password:
description:
- OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
device_id:
description:
- 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
I(hostname).
- I(device_id) is mutually exclusive with I(device_service_tag).
type: int
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
device_service_tag:
description:
- 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 I(hostname).
- I(device_service_tag) is mutually exclusive with I(device_id).
type: str
power_configuration:
description: The settings for Power configuration.
suboptions:
enable_power_cap:
description: Enables or disables the Power Cap Settings.
required: true
type: bool
power_cap:
description:
- The maximum power consumption limit of the device. Specify the consumption limit
in Watts.
- This is required if I(enable_power_cap) is set to true.
type: int
type: dict
hot_spare_configuration:
description: The settings for Hot Spare configuration.
suboptions:
enable_hot_spare:
description: Enables or disables Hot Spare configuration to facilitate voltage
regulation when power utilized by the Power Supply Unit (PSU) is low.
required: true
type: bool
primary_grid:
choices:
- GRID_1
- GRID_2
default: GRID_1
description:
- The choices for PSU grid.
- C(GRID_1) Hot Spare on Grid 1.
- C(GRID_2) Hot Spare on Grid 2.
type: str
type: dict
redundancy_configuration:
description: The settings for Redundancy configuration.
suboptions:
redundancy_policy:
choices:
- NO_REDUNDANCY
- GRID_REDUNDANCY
- PSU_REDUNDANCY
default: NO_REDUNDANCY
description:
- The choices to configure the redundancy policy.
- C(NO_REDUNDANCY) no redundancy policy is used.
- C(GRID_REDUNDANCY) to distributes power by dividing the PSUs into two grids.
- C(PSU_REDUNDANCY) to distribute power between all the PSUs.
type: str
type: dict
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to process the request because an error occurred.
MessageArgs: []
MessageId: GEN1234
RelatedProperties: []
Resolution: Retry the operation. If the issue persists, contact your system
administrator.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
msg:
description: Overall status of the device power settings.
returned: always
sample: Successfully updated the power settings.
type: str
power_details:
description: returned when power settings are updated successfully.
returned: success
sample:
EnableHotSpare: true
EnablePowerCapSettings: true
MaxPowerCap: '3424'
MinPowerCap: '3291'
PowerCap: '3425'
PrimaryGrid: GRID_1
RedundancyPolicy: NO_REDUNDANCY
SettingType: Power
type: dict