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

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 1.0.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательный	Параметр (devprof) в запрашиваемом URL.
devprof_system_emailserver dictionary	Параметры верхнего уровня.
authenticate string	Включить или отключить аутентификацию. Варианты: `"disable"` `"enable"`
interface string	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
password any	(список) Пароль пользователя SMTP-сервера для аутентификации.
port integer	Порт SMTP-сервера.
reply_to псевдонимы: reply-to string	Адрес электронной почты для ответа (Reply-To).
security string	Защита соединения, используемая почтовым сервером. Варианты: `"none"` `"starttls"` `"smtps"`
server string	IP-адрес или имя хоста SMTP-сервера.
source_ip псевдонимы: source-ip string	Исходный IPv4-адрес SMTP-сервера.
source_ip6 псевдонимы: source-ip6 string	Исходный IPv6-адрес SMTP-сервера.
ssl_min_proto_version псевдонимы: ssl-min-proto-version string	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений Варианты: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
type string	Использовать службу FortiGuard Message или пользовательский почтовый сервер. Варианты: `"custom"`
username string	Имя пользователя SMTP-сервера для аутентификации.
validate_server псевдонимы: validate-server string	Включить или отключить проверку сертификата сервера. Варианты: `"disable"` `"enable"`
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия возникновения ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global, а также другие значения, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure the email server used by the FortiGate various things.
      fortinet.fortimanager.fmgr_devprof_system_emailserver:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_system_emailserver:
          # authenticate: <value in [disable, enable]>
          # password: <list or string>
          # port: <integer>
          # reply_to: <string>
          # security: <value in [none, starttls, smtps]>
          # server: <string>
          # source_ip: <string>
          # source_ip6: <string>
          # ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]>
          # type: <value in [custom]>
          # username: <string>
          # validate_server: <value in [disable, enable]>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # vrf_select: <integer>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_devprof_system_emailserver_module.html