dellemc.openmanage.ome_application_alerts_smtp модуль — Этот модуль позволяет настроить SMTP или email-конфигурации

Примечание

Этот модуль является частью коллекции dellemc.openmanage (версия 9.7.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Для использования в книге задач укажите: dellemc.openmanage.ome_application_alerts_smtp.

Добавлен в dellemc.openmanage 4.3.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать SMTP или email-конфигурации в OpenManage Enterprise и OpenManage Enterprise Modular.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для проверки.
credentials словарь	Учетные данные для SMTP-сервера
password строка / обязательно	Пароль для доступа к SMTP-серверу.
username строка / обязательно	Имя пользователя для доступа к SMTP-серверу.
destination_address строка / обязательно	IP-адрес или FQDN SMTP-сервера назначения.
enable_authentication булево / обязательно	Включить или отключить аутентификацию для доступа к SMTP-серверу. credentials обязательны, если enable_authentication `true`. Модуль всегда будет сообщать об изменении, если это `true`. Выбираемые значения: `false` `true`
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная окружения `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
port_number целое число	Порт SMTP-сервера назначения.
timeout целое число добавлен в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
use_ssl булево	Использовать SSL для подключения к SMTP-серверу. Выбираемые значения: `false` `true`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная окружения `OME_USERNAME`. Пример: export OME_USERNAME=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

Примечания

Примечание

Модуль всегда будет сообщать об изменении, если enable_authentication true.
Выполняйте этот модуль с системы, имеющей прямой доступ к Dell OpenManage Enterprise или OpenManage Enterprise Modular.
Этот модуль поддерживает check_mode.

Примеры

---
- name: Update SMTP destination server configuration with authentication
  dellemc.openmanage.ome_application_alerts_smtp:
    hostname: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    destination_address: "localhost"
    port_number: 25
    use_ssl: true
    enable_authentication: true
    credentials:
      username: "username"
      password: "password"
- name: Update SMTP destination server configuration without authentication
  dellemc.openmanage.ome_application_alerts_smtp:
    hostname: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    destination_address: "localhost"
    port_number: 25
    use_ssl: false
    enable_authentication: false

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

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

Ключ	Описание
error_info словарь	Подробности HTTP ошибки. Возвращается: при HTTP ошибке Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to update the SMTP settings because the entered credential is invalid or empty.", "MessageArgs": [], "MessageId": "CAPP1106", "RelatedProperties": [], "Resolution": "Either enter valid credentials or disable the Use Credentials option and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
msg строка	Общий статус обновления настроек SMTP. Возвращается: всегда Пример: `"Successfully updated the SMTP settings."`
smtp_details словарь	Возвращается при успешном обновлении настроек SMTP. Возвращается: при успехе Пример: `{"Credential": {"Password": null, "User": "admin"}, "DestinationAddress": "localhost", "PortNumber": 25, "UseCredentials": true, "UseSSL": false}`

Авторы

Sachin Apagundi(@sachin-apa)

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

© 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_alerts_smtp_module.html