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

Примечание

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

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

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

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

Этот модуль позволяет настраивать устройство FortiManager, позволяя пользователю [ получить установить обновить ] следующие API:
/pm/config/adom/{adom}/devprof/{devprof}/system/email-server
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров в свободном режиме
method string / обязательно	Варианты: get set update	Метод запроса
params list / элементы=строка		Параметры для каждого метода Полный список параметров см. на странице https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params словарь		Параметры для каждого URL-адреса API-запроса Полный список параметров URL также см. на странице https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom строка		Имя домена для блокировки в случае работы FortiManager в режиме рабочего пространства Может быть глобальным или любым другим именем пользовательского домена
workspace_locking_timeout целое число	Значение по умолчанию: 300	Максимальное время ожидания, в секундах, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Существует только три параметра верхнего уровня, где «method» всегда обязателен, а остальные два «params» и «url_params» могут быть необязательными
Из-за сложности схемы API fortimanager валидация выполняется за пределами стандартной процедуры валидации параметров Ansible.
Синтаксис OPTIONS не соответствует стандартному спецификации аргументов Ansible, но для структуры схемы API fortimanager требуется тривиальное преобразование при заполнении книги задач ansible.

Примеры

- 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: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/EMAIL-SERVER
     fmgr_devprof_system_emailserver:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/EMAIL-SERVER
     fmgr_devprof_system_emailserver:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
        params:
           -
              data:
                 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]>

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

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

Ключ	Возвращаемое значение	Описание
data словарь	всегда	Полезная нагрузка, возвращаемая в запросе
status словарь	всегда	Статус запроса к API
url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user

Авторы

Frank Shen (@fshen01)
Link Zheng (@zhengl)

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