fortinet.fortimanager.fmgr_system_fortiguard – Настройка сервисов FortiGuard.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_fortiguard.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливать только в случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых будут игнорироваться условия для завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут игнорироваться условия для успешного завершения | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| system_fortiguard словарь | параметры верхнего уровня | ||
| antispam-cache строка |
| Включение/выключение кэширования запросов FortiGuard антиспам. Использует небольшое количество памяти, но повышает производительность. | |
| antispam-cache-mpercent целое число | Максимальный процент памяти FortiGate, который может использовать кэш антиспама (1 - 15%). | ||
| antispam-cache-ttl целое число | Время жизни записей в кэше антиспама в секундах (300 - 86400). Более низкие значения уменьшают размер кэша. Более высокие значения могут улучшить ... | ||
| antispam-expiration целое число | нет описания | ||
| antispam-force-off строка |
| Включение/выключение отключения службы FortiGuard антиспам. | |
| antispam-license целое число | нет описания | ||
| antispam-timeout целое число | Таймаут запросов антиспама (1 - 30 сек, по умолчанию = 7). | ||
| auto-join-forticloud строка |
| Автоматическое подключение и вход в FortiCloud. | |
| ddns-server-ip строка | IP-адрес сервера FortiDDNS. | ||
| ddns-server-port целое число | Порт для связи с серверами FortiDDNS. | ||
| load-balance-servers целое число | Количество серверов, между которыми будет производиться чередование, в качестве первого варианта FortiGuard. | ||
| outbreak-prevention-cache строка |
| Включение/выключение кэша FortiGuard для предотвращения вспышек вирусов. | |
| outbreak-prevention-cache-mpercent целое число | Максимальный процент памяти, которую может использовать кэш FortiGuard для предотвращения вспышек вирусов (1 - 15%, по умолчанию = 2). | ||
| outbreak-prevention-cache-ttl целое число | Время жизни записей в кэше FortiGuard для предотвращения вспышек вирусов (300 - 86400 сек, по умолчанию = 300). | ||
| outbreak-prevention-expiration целое число | нет описания | ||
| outbreak-prevention-force-off строка |
| Отключение службы FortiGuard для предотвращения вспышек вирусов. | |
| outbreak-prevention-license целое число | нет описания | ||
| outbreak-prevention-timeout целое число | Таймаут запросов FortiGuard для предотвращения вспышек вирусов (1 - 30 сек, по умолчанию = 7). | ||
| port строка |
| Порт для связи с серверами FortiGuard. | |
| sdns-server-ip строка | нет описания | ||
| sdns-server-port целое число | Порт для связи с серверами FortiDNS. | ||
| service-account-id строка | Идентификатор учетной записи службы. | ||
| source-ip строка | Используемый источник IPv4-адреса для связи с FortiGuard. | ||
| source-ip6 строка | Используемый источник IPv6-адреса для связи с FortiGuard. | ||
| update-server-location строка |
| Расположение сервера обновлений сигнатур. | |
| webfilter-cache строка |
| Включение/выключение кэширования FortiGuard веб-фильтра. | |
| webfilter-cache-ttl целое число | Время жизни записей в кэше веб-фильтра в секундах (300 - 86400). | ||
| webfilter-expiration целое число | нет описания | ||
| webfilter-force-off строка |
| Включение/выключение отключения службы веб-фильтра FortiGuard. | |
| webfilter-license целое число | нет описания | ||
| webfilter-timeout целое число | Таймаут запросов веб-фильтра (1 - 30 сек, по умолчанию = 7). | ||
| 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 FortiGuard services.
fmgr_system_fortiguard:
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>
system_fortiguard:
antispam-cache: <value in [disable, enable]>
antispam-cache-mpercent: <value of integer>
antispam-cache-ttl: <value of integer>
antispam-expiration: <value of integer>
antispam-force-off: <value in [disable, enable]>
antispam-license: <value of integer>
antispam-timeout: <value of integer>
auto-join-forticloud: <value in [disable, enable]>
ddns-server-ip: <value of string>
ddns-server-port: <value of integer>
load-balance-servers: <value of integer>
outbreak-prevention-cache: <value in [disable, enable]>
outbreak-prevention-cache-mpercent: <value of integer>
outbreak-prevention-cache-ttl: <value of integer>
outbreak-prevention-expiration: <value of integer>
outbreak-prevention-force-off: <value in [disable, enable]>
outbreak-prevention-license: <value of integer>
outbreak-prevention-timeout: <value of integer>
port: <value in [53, 80, 8888]>
sdns-server-ip: <value of string>
sdns-server-port: <value of integer>
service-account-id: <value of string>
source-ip: <value of string>
source-ip6: <value of string>
update-server-location: <value in [any, usa]>
webfilter-cache: <value in [disable, enable]>
webfilter-cache-ttl: <value of integer>
webfilter-expiration: <value of integer>
webfilter-force-off: <value in [disable, enable]>
webfilter-license: <value of integer>
webfilter-timeout: <value of integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный URL запроса Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Дескриптивное сообщение ответа 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_fortiguard_module.html
