dellemc.openmanage.ome_application_console_preferences модуль — Настройка параметров консоли в OpenManage Enterprise.

Примечание

Этот модуль входит в состав коллекции dellemc.openmanage (версия 9.7.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. cifs_options требуется, share_options `CIFS`. `V1` для включения SMBv1. `V2` для включения SMBv2 Варианты: `"V1"` `"V2"`
share_options строка	Параметры папки. `CIFS` для выбора типа папки CIFS. `HTTPS` для выбора типа папки HTTPS. Варианты: `"CIFS"` `"HTTPS"`
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для проверки.
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 строка / требуется	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
metrics_collection_settings целое число	Частота обслуживания и очистки данных расширения PowerManager.
mx7000_onboarding_preferences строка	Поведение переадресации оповещений на шасси при их включении. `all` для получения всех оповещений. `chassis` для получения только оповещений по категориям шасси. Варианты: `"all"` `"chassis"`
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не предоставлен, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=пароль

port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
report_row_limit целое число	Максимальное количество строк, которые можно просмотреть в отчетах OpenManage Enterprise.
server_initiated_discovery словарь	Настройки обнаружения, инициируемого сервером.
device_discovery_approval_policy строка	Политики утверждения обнаружения. `Automatic` позволяет серверам с версией iDRAC Firmware 4.00.00.00, которые находятся в одной сети с консолью, автоматически обнаруживаться консолью. `Manual` для обнаружения серверов пользователем вручную. Варианты: `"Automatic"` `"Manual"`
set_trap_destination булево	Настройки назначения ловушек. Варианты: `false` `true`
timeout целое число добавлен в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
trap_forwarding_format строка	Формат переадресации ловушек. `Original` для сохранения данных ловушки как есть. `Normalized` для нормализации данных ловушки. Варианты: `"Original"` `"Normalized"`
username строка	Имя пользователя 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: "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

Значения возврата

Общие значения возврата описаны здесь, ниже представлены поля, уникальные для данного модуля:

Ключ	Описание
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": "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"}]
error_info словарь	Подробности HTTP ошибки. Возвращается: при HTTP ошибке Пример: `{"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."}}`
msg строка	Общий статус настроек консоли. Возвращается: всегда Пример: `"Successfully update the console preferences."`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_application_console_preferences_module.html