dellemc.openmanage.ome_application_console_preferences 模块 – 配置 OpenManage Enterprise 上的控制台首选项。

注意

此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅要求以了解详情。

要在剧本中使用它，请指定：dellemc.openmanage.ome_application_console_preferences。

dellemc.openmanage 5.2.0 中的新增功能

概要 

此模块允许用户配置 OpenManage Enterprise 上的控制台首选项。

要求 

执行此模块的主机需要以下要求。

python >= 3.9.6

参数 

参数	注释
builtin_appliance_share 字典	设备必须访问的外部网络共享，才能完成操作。
cifs_options 字符串	SMB 协议版本。如果 share_options 为 `CIFS`，则需要 cifs_options。 `V1` 用于启用 SMBv1。 `V2` 用于启用 SMBv2 选项 `"V1"` `"V2"`
share_options 字符串	共享选项。 `CIFS` 用于选择 CIFS 共享类型。 `HTTPS` 用于选择 HTTPS 共享类型。选项 `"CIFS"` `"HTTPS"`
ca_path 路径 dellemc.openmanage 5.0.0 中新增	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
device_health 字典	必须自动监控和更新 OpenManage Enterprise 仪表板上的设备运行状况的时间。
health_and_power_state_on_connection_lost 字符串	最近记录的设备运行状况。 `last_known` 用于在电源连接丢失时显示最近记录的设备运行状况。 `unknown` 用于在设备状态变为未知时显示最近记录的设备运行状况。选项 `"last_known"` `"unknown"`
health_check_interval 整数	必须记录和存储设备运行状况数据的频率。
health_check_interval_unit 字符串	必须记录和存储设备运行状况数据的频率的时间单位。 `Hourly` 用于以小时为单位设置频率。 `Minutes` 用于以分钟为单位设置频率。选项 `"Hourly"` `"Minutes"`
discovery_settings 字典	OpenManage Enterprise 用于识别已发现的 iDRAC 和其他设备的设备命名。
common_mac_addresses 字符串	用逗号分隔的常用 MAC 地址。
general_device_naming 字符串	适用于除 iDRAC 之外的所有已发现设备。 `DNS` 用于使用 DNS 名称。 `NETBIOS` 用于使用 NetBIOS 名称。选项 `"DNS"` ← (默认) `"NETBIOS"`
invalid_device_hostname 字符串	用逗号分隔的无效主机名。
server_device_naming 字符串	仅适用于 iDRAC。 `IDRAC_HOSTNAME` 用于使用 iDRAC 主机名。 `IDRAC_SYSTEM_HOSTNAME` 用于使用系统主机名。选项 `"IDRAC_HOSTNAME"` `"IDRAC_SYSTEM_HOSTNAME"` ← (默认)
email_sender_settings 字符串	发送电子邮件的用户邮箱地址。
hostname 字符串 / 必填	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。
metrics_collection_settings 整数	PowerManager 扩展数据维护和清除的频率。
mx7000_onboarding_preferences 字符串	机箱上线时的警报转发行为。 `all` 用于接收所有警报。 `chassis` 用于仅接收机箱类别警报。选项 `"all"` `"chassis"`
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。默认值： `443`
report_row_limit 整数	您可以在 OpenManage Enterprise 报告中查看的最大行数。
server_initiated_discovery 字典	服务器启动的发现设置。
device_discovery_approval_policy 字符串	发现审批策略。 `Automatic` 允许自动发现与控制台位于同一网络上且 iDRAC 固件版本为 4.00.00.00 的服务器。 `Manual` 用于用户手动发现服务器。选项 `"Automatic"` `"Manual"`
set_trap_destination 布尔值	陷阱目标设置。选项 `false` `true`
timeout 整数 dellemc.openmanage 5.0.0 中新增	套接字级别超时（秒）。默认值： `30`
trap_forwarding_format 字符串	陷阱转发格式。 `Original` 用于按原样保留陷阱数据。使用`Normalized`标准化陷阱数据。选项 `“原始”` `“标准化”`
用户名字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。如果未提供用户名，则使用环境变量`OME_USERNAME`。示例：export OME_USERNAME=用户名
validate_certs 布尔值 dellemc.openmanage 5.0.0 中新增	如果为`false`，则不会验证SSL证书。仅在使用自签名证书的个人控制站点上配置`false`。在收集版本`5.0.0`之前，validate_certs 默认值为`false`。选项 `false` `true` ← (默认)
x_auth_token 字符串在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。如果未提供 x_auth_token，则使用环境变量`OME_X_AUTH_TOKEN`。示例：export OME_X_AUTH_TOKEN=x_auth_token

注释 

注意

此模块支持check_mode。

示例 

---
- 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

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
console_preferences 列表 / 元素=字符串	控制台首选项的详细信息。返回：成功时示例：[{"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": "[email protected]", "GroupName": "", "Name": "EMAIL_SENDER", "Value": "[email protected]@[email protected]"}, {"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"}]
error_info 字典	HTTP 错误的详细信息。返回：HTTP 错误时示例：`{"error": {"@Message.ExtendedInfo": [{"Message": "由于资源URI不存在或未实现，因此无法完成请求。", "MessageArgs": [], "MessageId": "CGEN1006", "RelatedProperties": [], "Resolution": "输入有效的URI并重试操作。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。有关更多信息，请参见ExtendedInfo。"} }`
msg 字符串	控制台首选项的总体状态。返回：始终示例：`"已成功更新控制台首选项。"`

作者

Sachin Apagundi(@sachin-apa)
Husniya Hameed (@husniya-hameed)
ShivamSh3 (@ShivamSh3)