модуль dellemc.openmanage.ome_application_alerts_smtp — этот модуль позволяет настраивать SMTP или параметры электронной почты

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 или параметры электронной почты в OpenManage Enterprise и OpenManage Enterprise Modular.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path path добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации, который будет использоваться для проверки.
credentials dictionary	Учетные данные для SMTP-сервера
password string / обязательный	Пароль для доступа к SMTP-серверу.
username string / обязательный	Имя пользователя для доступа к SMTP-серверу.
destination_address string / обязательный	IP-адрес или полное доменное имя (FQDN) целевого SMTP-сервера.
enable_authentication boolean / обязательный	Включить или отключить аутентификацию для доступа к SMTP-серверу. Если для enable_authentication задано значение `true`, параметр credentials является обязательным. Если задано значение `true`, модуль всегда будет сообщать об изменении. Варианты: `false` `true`
hostname string / обязательный	IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.
password string	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная окружения `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port integer	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
port_number integer	Номер порта целевого SMTP-сервера.
timeout integer добавлено в dellemc.openmanage 5.0.0	Тайм-аут сокета в секундах. По умолчанию: `30`
use_ssl boolean	Использовать SSL для подключения к SMTP-серверу. Варианты: `false` `true`
username string	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная окружения `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs boolean добавлено в dellemc.openmanage 5.0.0	Если задано значение `false`, SSL-сертификаты проверяться не будут. Задавайте `false` только на контролируемых лично сайтах, где используются самозаверяющие сертификаты. В версиях коллекции до `5.0.0` для validate_certs по умолчанию задается значение `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token string добавлено в 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 dictionary	Сведения об ошибке 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 string	Общий статус обновления настроек SMTP. Возвращается: всегда Пример: `"Successfully updated the SMTP settings."`
smtp_details dictionary	Возвращается, если настройки SMTP успешно обновлены. Возвращается: при успешном выполнении Пример: `{"Credential": {"Password": null, "User": "admin"}, "DestinationAddress": "localhost", "PortNumber": 25, "UseCredentials": true, "UseSSL": false}`

Авторы

Sachin Apagundi(@sachin-apa)
Bhavneet Sharma (@Bhavneet-Sharma)

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

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