dellemc.openmanage.ome_application_console_preferences module – Configure console preferences on OpenManage Enterprise.
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_application_console_preferences.
New in dellemc.openmanage 5.2.0
Synopsis
This module allows user to configure the console preferences on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The external network share that the appliance must access to complete operations. |
|
The SMB protocol version. cifs_options is required share_options is
Choices:
|
|
The share options.
Choices:
|
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The time after which the health of the devices must be automatically monitored and updated on the OpenManage Enterprise dashboard. |
|
The latest recorded device health.
Choices:
|
|
The frequency at which the device health must be recorded and data stored. |
|
The time unit of the frequency at which the device health must be recorded and data stored.
Choices:
|
|
The device naming to be used by the OpenManage Enterprise to identify the discovered iDRACs and other devices. |
|
The common MAC addresses separated by a comma. |
|
Applicable to all the discovered devices other than the iDRACs.
Choices:
|
|
The invalid hostnames separated by a comma. |
|
Applicable to iDRACs only.
Choices:
|
|
The email address of the user who is sending an email message. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
The frequency of the PowerManager extension data maintenance and purging. |
|
Alert-forwarding behavior on chassis when they are onboarded.
Choices:
|
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
The maximum number of rows that you can view on OpenManage Enterprise reports. |
|
Server initiated discovery settings. |
|
Discovery approval policies.
Choices:
|
|
Trap destination settings. Choices:
|
|
The socket level timeout in seconds. Default: |
|
The trap forwarding format.
Choices:
|
|
OpenManage Enterprise or 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
This module supports
check_mode.
Examples
---
- name: Update Console preferences with all the settings.
dellemc.openmanage.ome_application_console_preferences:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
report_row_limit: 123
device_health:
health_check_interval: 1
health_check_interval_unit: Hourly
health_and_power_state_on_connection_lost: last_known
discovery_settings:
general_device_naming: DNS
server_device_naming: IDRAC_HOSTNAME
invalid_device_hostname: "localhost"
common_mac_addresses: "::"
server_initiated_discovery:
device_discovery_approval_policy: Automatic
set_trap_destination: true
mx7000_onboarding_preferences: all
builtin_appliance_share:
share_options: CIFS
cifs_options: V1
email_sender_settings: "[email protected]"
trap_forwarding_format: Normalized
metrics_collection_settings: 31
- name: Update Console preferences with report and device health settings.
dellemc.openmanage.ome_application_console_preferences:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
report_row_limit: 236
device_health:
health_check_interval: 10
health_check_interval_unit: Hourly
health_and_power_state_on_connection_lost: last_known
- name: Update Console preferences with invalid device health settings.
dellemc.openmanage.ome_application_console_preferences:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_health:
health_check_interval: 65
health_check_interval_unit: Minutes
- name: Update Console preferences with discovery and built in appliance share settings.
dellemc.openmanage.ome_application_console_preferences:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
discovery_settings:
general_device_naming: DNS
server_device_naming: IDRAC_SYSTEM_HOSTNAME
invalid_device_hostname: "localhost"
common_mac_addresses: "00:53:45:00:00:00"
builtin_appliance_share:
share_options: CIFS
cifs_options: V1
- name: Update Console preferences with server initiated discovery, mx7000 onboarding preferences, email sender,
trap forwarding format, and metrics collection settings.
dellemc.openmanage.ome_application_console_preferences:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
server_initiated_discovery:
device_discovery_approval_policy: Automatic
set_trap_destination: true
mx7000_onboarding_preferences: chassis
email_sender_settings: "[email protected]"
trap_forwarding_format: Original
metrics_collection_settings: 365
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the console preferences. Returned: on success Sample: |
|
Details of the HTTP error. Returned: on HTTP error Sample: |
|
Overall status of the console preferences. Returned: always Sample: |