модуль fortinet.fortimanager.fmgr_system_mail – уведомления по электронной почте.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_mail.

Новый в fortinet.fortimanager 2.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiManager.
В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
system_mail dictionary	Параметры верхнего уровня.
auth string	Включить аутентификацию. disable — отключить аутентификацию. enable — включить аутентификацию. Варианты: `"disable"` `"enable"`
auth_type псевдонимы: auth-type string	Тип аутентификации SMTP. psk — использовать для аутентификации имя пользователя и пароль. certificate — использовать для аутентификации локальный сертификат. Варианты: `"psk"` `"certificate"`
from string	Имя пользователя для MAIL FROM.
id string / обязательный	Идентификатор почтовой службы.
local_cert псевдонимы: local-cert string	Локальный сертификат SMTP.
passwd any	(список) Пароль учётной записи SMTP.
port integer	Порт SMTP-сервера.
secure_option псевдонимы: secure-option string	Параметр безопасности соединения. default — попытаться использовать STARTTLS, а в противном случае продолжить обмен данными в открытом виде. none — обмен данными будет выполняться в открытом виде. smtps — обмен данными будет защищён с помощью SMTPS. starttls — обмен данными будет защищён с помощью STARTTLS. Варианты: `"default"` `"none"` `"smtps"` `"starttls"`
server string	SMTP-сервер.
ssl_protocol псевдонимы: ssl-protocol string	Задать минимальную версию протокола SSL для подключения к почтовому серверу. follow-global-ssl-protocol — следовать системным настройкам. sslv3 — задать SSLv3 в качестве минимальной версии. tlsv1. tlsv1. tlsv1. tlsv1. Варианты: `"follow-global-ssl-protocol"` `"sslv3"` `"tlsv1.0"` `"tlsv1.1"` `"tlsv1.2"` `"tlsv1.3"`
user string	Имя пользователя учётной записи SMTP.
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают управлять этим режимом.
Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия сбоя и успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Alert emails.
      fortinet.fortimanager.fmgr_system_mail:
        bypass_validation: false
        state: present
        system_mail:
          auth: enable
          id: 1
          passwd: fortinet
          port: 1
          secure_option: none # <value in [default, none, smtps, ...]>
          server: ALL
          user: ansible

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the alert emails
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_mail"
          params:
            mail: "your_value"

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_system_mail_module.html