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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_system_emailserver словарь	Настройка верхнего уровня параметров.
authenticate строка	Включить/выключить аутентификацию. Варианты: `"disable"` `"enable"`
interface строка	Указать исходящий интерфейс для достижения сервера.
interface_select_method строка	Устарело, переименуйте на interface_select_method. Укажите способ выбора исходящего интерфейса для достижения сервера. Варианты: `"auto"` `"sdwan"` `"specify"`
password любой тип	(список) Пароль пользователя SMTP-сервера для аутентификации.
port целое число	Порт SMTP-сервера.
reply_to строка	Устарело, переименуйте на reply_to. Адрес электронной почты ответа.
security строка	Безопасность соединения, используемая SMTP-сервером. Варианты: `"none"` `"starttls"` `"smtps"`
server строка	IP-адрес или имя хоста SMTP-сервера.
source_ip строка	SMTP-сервер IPv4-адрес источника.
source_ip6 строка	SMTP-сервер IPv6-адрес источника.
ssl_min_proto_version строка	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений. Варианты: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
type строка	Использование сервиса FortiGuard Message или пользовательского SMTP-сервера. Варианты: `"custom"`
username строка	Имя пользователя SMTP-сервера для аутентификации.
validate_server строка	Включить/выключить проверку сертификата сервера. Варианты: `"disable"` `"enable"`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`

forticloud_access_token строка	Авторизовать Ansible-клиент с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на ошибку.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на успех.
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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
  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.
      fortinet.fortimanager.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: <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]>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_system_emailserver_module.html