fortinet.fortimanager.fmgr_devprof_system_emailserver – Настройка почтового сервера, используемого FortiGate для различных задач. Например, для отправки электронных писем пользователям для поддержки аутентификации пользователей…

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_devprof_system_emailserver.

Введено в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation булево		Варианты: нет ← да	устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
devprof строка / обязательно			параметр (devprof) в запрошенном URL
devprof_system_emailserver словарь			устанавливаемые параметры верхнего уровня
	authenticate строка	Варианты: выключить включить	Включить/выключить аутентификацию.
	password строка		нет описания
	port целое число		Порт SMTP-сервера.
	reply-to строка		Адрес электронной почты ответа.
	security строка	Варианты: нет starttls smtps	Безопасность соединения, используемая почтовым сервером.
	server строка		IP-адрес или имя хоста SMTP-сервера.
	source-ip строка		Исходный IP-адрес IPv4 SMTP-сервера.
	source-ip6 строка		Исходный IP-адрес IPv6 SMTP-сервера.
	ssl-min-proto-version строка	Варианты: по умолчанию TLSv1 TLSv1-1 TLSv1-2 SSLv3	Минимально поддерживаемая версия протокола для SSL/TLS-соединений (по умолчанию используется глобальное системное значение).
	type строка	Варианты: настраиваемый	Использовать сервис FortiGuard Message или настраиваемый почтовый сервер.
	username строка		Имя пользователя SMTP-сервера для аутентификации.
	validate-server строка	Варианты: выключить включить	Включить/выключить проверку сертификата сервера.
rc_failed список / элементы=строка			список кодов rc, при которых условия будут игнорироваться
rc_succeeded список / элементы=строка			список кодов rc, при которых условия будут игнорироваться
state строка / обязательно		Варианты: present absent	директива создания, обновления или удаления объекта
workspace_locking_adom строка			adom для блокировки в режиме работы в пространстве FortiManager. Значение может быть глобальным или другим, включая root.
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область

Примечания

Примечание

Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Также вы можете переопределить условия для завершения ошибкой или успешным завершением с параметрами rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authen...
     fmgr_devprof_system_emailserver:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_system_emailserver:
           authenticate: <value in [disable, enable]>
           password: <value of string>
           port: <value of integer>
           reply-to: <value of string>
           security: <value in [none, starttls, smtps]>
           server: <value of string>
           source-ip: <value of string>
           source-ip6: <value of string>
           ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
           type: <value in [custom]>
           username: <value of string>
           validate-server: <value in [disable, enable]>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Детальное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_devprof_system_emailserver_module.html