fortinet.fortimanager.fmgr_system_log_maildomain – Настройка домена FortiMail.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_log_maildomain.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| Устанавливать в True только при различиях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | Список кодов rc, при которых условия будут считаться неудовлетворёнными | ||
| rc_succeeded список / элементы=строка | Список кодов rc, при которых условия будут считаться удовлетворёнными | ||
| state строка / обязательный |
| Директива для создания, обновления или удаления объекта | |
| system_log_maildomain словарь | Параметры верхнего уровня | ||
| devices строка | Значение по умолчанию: "All_FortiMail" | Устройства для сопоставления домена с vdom | |
| domain строка | Домен FortiMail | ||
| id целое число | Значение по умолчанию: 0 | Идентификатор домена FortiMail. | |
| vdom строка | Имя виртуального домена для сопоставления с доменём FortiMail | ||
| 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: FortiMail domain setting.
fmgr_system_log_maildomain:
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, ...]
state: <value in [present, absent]>
system_log_maildomain:
devices: <value of string>
domain: <value of string>
id: <value of integer>
vdom: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_system_log_maildomain_module.html
