Try SpotterConfigure console preferences on OpenManage Enterprise.
| "added in version" 5.2.0 of dellemc.openmanage"
Authors: Sachin Apagundi(@sachin-apa), Husniya Hameed (@husniya-hameed), ShivamSh3 (@ShivamSh3)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows user to configure the console preferences on OpenManage Enterprise.
---
- 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: "admin@dell.com"
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: "admin@dell.com"
trap_forwarding_format: Original
metrics_collection_settings: 365
port:
default: 443
description: OpenManage Enterprise or 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 or OpenManage Enterprise Modular IP address or
hostname.
required: true
type: str
password:
description:
- OpenManage Enterprise or 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 or 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_health:
description: The time after which the health of the devices must be automatically
monitored and updated on the OpenManage Enterprise dashboard.
suboptions:
health_and_power_state_on_connection_lost:
choices:
- last_known
- unknown
description:
- The latest recorded device health.
- C(last_known) to display the latest recorded device health when the power connection
was lost.
- C(unknown) to display the latest recorded device health when the device status
moved to unknown.
type: str
health_check_interval:
description: The frequency at which the device health must be recorded and data
stored.
type: int
health_check_interval_unit:
choices:
- Hourly
- Minutes
description:
- The time unit of the frequency at which the device health must be recorded and
data stored.
- C(Hourly) to set the frequency in hours.
- C(Minutes) to set the frequency in minutes.
type: str
type: dict
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
report_row_limit:
description: The maximum number of rows that you can view on OpenManage Enterprise
reports.
type: int
discovery_settings:
description: The device naming to be used by the OpenManage Enterprise to identify
the discovered iDRACs and other devices.
suboptions:
common_mac_addresses:
description: The common MAC addresses separated by a comma.
type: str
general_device_naming:
choices:
- DNS
- NETBIOS
default: DNS
description:
- Applicable to all the discovered devices other than the iDRACs.
- C(DNS) to use the DNS name.
- C(NETBIOS) to use the NetBIOS name.
type: str
invalid_device_hostname:
description: The invalid hostnames separated by a comma.
type: str
server_device_naming:
choices:
- IDRAC_HOSTNAME
- IDRAC_SYSTEM_HOSTNAME
default: IDRAC_SYSTEM_HOSTNAME
description:
- Applicable to iDRACs only.
- C(IDRAC_HOSTNAME) to use the iDRAC hostname.
- C(IDRAC_SYSTEM_HOSTNAME) to use the system hostname.
type: str
type: dict
email_sender_settings:
description: The email address of the user who is sending an email message.
type: str
trap_forwarding_format:
choices:
- Original
- Normalized
description:
- The trap forwarding format.
- C(Original) to retain the trap data as is.
- C(Normalized) to normalize the trap data.
type: str
builtin_appliance_share:
description: The external network share that the appliance must access to complete
operations.
suboptions:
cifs_options:
choices:
- V1
- V2
description:
- The SMB protocol version.
- I(cifs_options) is required I(share_options) is C(CIFS).
- C(V1) to enable SMBv1.
- C(V2) to enable SMBv2
type: str
share_options:
choices:
- CIFS
- HTTPS
description:
- The share options.
- C(CIFS) to select CIFS share type.
- C(HTTPS) to select HTTPS share type.
type: str
type: dict
server_initiated_discovery:
description: Server initiated discovery settings.
suboptions:
device_discovery_approval_policy:
choices:
- Automatic
- Manual
description:
- Discovery approval policies.
- C(Automatic) allows servers with iDRAC Firmware version 4.00.00.00, which are
on the same network as the console, to be discovered automatically by the console.
- C(Manual) for the servers to be discovered by the user manually.
type: str
set_trap_destination:
description: Trap destination settings.
type: bool
type: dict
metrics_collection_settings:
description: The frequency of the PowerManager extension data maintenance and purging.
type: int
mx7000_onboarding_preferences:
choices:
- all
- chassis
description:
- Alert-forwarding behavior on chassis when they are onboarded.
- C(all) to receive all alert.
- C(chassis) to receive chassis category alerts only.
type: str
console_preferences:
description: Details of the console preferences.
returned: on success
sample:
- DataType: java.lang.String
DefaultValue: SLOT_NAME
GroupName: DISCOVERY_SETTING
Name: DEVICE_PREFERRED_NAME
Value: PREFER_DNS,PREFER_IDRAC_SYSTEM_HOSTNAME
- DataType: java.lang.String
DefaultValue: ''
GroupName: DISCOVERY_SETTING
Name: INVALID_DEVICE_HOSTNAME
Value: localhost,localhost.localdomain,not defined,pv132t,pv136t,default,dell,idrac-
- DataType: java.lang.String
DefaultValue: ''
GroupName: DISCOVERY_SETTING
Name: COMMON_MAC_ADDRESSES
Value: 00:53:45:00:00:00,33:50:6F:45:30:30,50:50:54:50:30:30,00:00:FF:FF:FF:FF,20:41:53:59:4E:FF,00:00:00:00:00:00,20:41:53:59:4e:ff,00:00:00:00:00:00
- DataType: java.lang.String
DefaultValue: CIFS
GroupName: BUILT_IN_APPLIANCE_SHARE_SETTINGS
Name: SHARE_TYPE
Value: CIFS
- DataType: java.lang.String
DefaultValue: AsIs
GroupName: ''
Name: TRAP_FORWARDING_SETTING
Value: Normalized
- DataType: java.lang.Integer
DefaultValue: '365'
GroupName: ''
Name: DATA_PURGE_INTERVAL
Value: '3650000'
- DataType: java.lang.String
DefaultValue: last_known
GroupName: CONSOLE_CONNECTION_SETTING
Name: CONSOLE_CONNECTION_SETTING
Value: last_known
- DataType: java.lang.String
DefaultValue: V2
GroupName: CIFS_PROTOCOL_SETTINGS
Name: MIN_PROTOCOL_VERSION
Value: V1
- DataType: java.lang.Integer
DefaultValue: '2000'
GroupName: ''
Name: ALERT_ACKNOWLEDGEMENT_VIEW
Value: '2000'
- DataType: java.lang.Boolean
DefaultValue: 'false'
GroupName: CONSOLE_UPDATE_SETTING_GROUP
Name: AUTO_CONSOLE_UPDATE_AFTER_DOWNLOAD
Value: 'false'
- DataType: java.lang.Boolean
DefaultValue: 'false'
GroupName: ''
Name: NODE_INITIATED_DISCOVERY_SET_TRAP_DESTINATION
Value: 'false'
- DataType: java.lang.Integer
DefaultValue: '0'
GroupName: ''
Name: REPORTS_MAX_RESULTS_LIMIT
Value: '2000000000000000000000000'
- DataType: java.lang.String
DefaultValue: omcadmin@dell.com
GroupName: ''
Name: EMAIL_SENDER
Value: admin1@dell.com@dell.com@dell.com
- DataType: java.lang.String
DefaultValue: all
GroupName: ''
Name: MX7000_ONBOARDING_PREF
Value: test_chassis
- DataType: java.lang.String
DefaultValue: Automatic
GroupName: ''
Name: DISCOVERY_APPROVAL_POLICY
Value: Automatic_test
type: list
error_info:
description: Details of the HTTP error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to complete the request because the resource URI does not
exist or is not implemented.
MessageArgs: []
MessageId: CGEN1006
RelatedProperties: []
Resolution: Enter a valid URI and retry the operation.
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 console preferences.
returned: always
sample: Successfully update the console preferences.
type: str