fortinet.fortimanager.fmgr_firewall_service_custom – Настройка пользовательских служб.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_service_custom.
Новое в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | |
| firewall_service_custom словарь | настроенные параметры верхнего уровня | ||
| app-category целое число | нет описания | ||
| app-service-type строка |
| Тип службы приложения. | |
| application целое число | нет описания | ||
| category строка | Категория службы. | ||
| check-reset-range строка |
| Настройка типа проверки сообщений об ошибках ICMP. | |
| color целое число | Цвет значка в графическом интерфейсе. | ||
| comment строка | нет описания | ||
| fqdn строка | Полное доменное имя. | ||
| helper строка |
| Название помощника. | |
| icmpcode целое число | Код ICMP. | ||
| icmptype целое число | Тип ICMP. | ||
| iprange строка | Начальный и конечный IP-адрес диапазона, связанного со службой. | ||
| name строка | Имя пользовательской службы. | ||
| protocol строка |
| Тип протокола на основе номеров IANA. | |
| protocol-number целое число | Номер IP-протокола. | ||
| proxy строка |
| Включить/выключить веб-прокси-службу. | |
| sctp-portrange строка | Несколько диапазонов портов SCTP. | ||
| session-ttl целое число | TTL сессии (300 - 604800, 0 = значение по умолчанию). | ||
| tcp-halfclose-timer целое число | Время ожидания закрытия TCP-сессии в ожидании ответа пакета FIN (1 - 86400 сек, 0 = значение по умолчанию). | ||
| tcp-halfopen-timer целое число | Время ожидания закрытия TCP-сессии в ожидании ответа пакета открытия сессии (1 - 86400 сек, 0 = значение по умолчанию). | ||
| tcp-portrange строка | Несколько диапазонов портов TCP. | ||
| tcp-timewait-timer целое число | Установите длительность состояния TCP TIME-WAIT в секундах (1 - 300 сек, 0 = значение по умолчанию). | ||
| udp-idle-timer целое число | Таймаут закрытия UDP-соединения (0 - 86400 сек, 0 = значение по умолчанию). | ||
| udp-portrange строка | Несколько диапазонов портов UDP. | ||
| visibility строка |
| Включить/выключить видимость службы в графическом интерфейсе. | |
| rc_failed список / элементы=строка | список rc-кодов, при которых условие неудачи будет переопределено | ||
| rc_succeeded список / элементы=строка | список rc-кодов, при которых условие успеха будет переопределено | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | adom для блокировки в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая корневой | ||
| 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 custom services.
fmgr_firewall_service_custom:
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>
state: <value in [present, absent]>
firewall_service_custom:
app-category: <value of integer>
app-service-type: <value in [disable, app-id, app-category]>
application: <value of integer>
category: <value of string>
check-reset-range: <value in [disable, default, strict]>
color: <value of integer>
comment: <value of string>
fqdn: <value of string>
helper: <value in [disable, auto, ftp, ...]>
icmpcode: <value of integer>
icmptype: <value of integer>
iprange: <value of string>
name: <value of string>
protocol: <value in [ICMP, IP, TCP/UDP/SCTP, ...]>
protocol-number: <value of integer>
proxy: <value in [disable, enable]>
sctp-portrange: <value of string>
session-ttl: <value of integer>
tcp-halfclose-timer: <value of integer>
tcp-halfopen-timer: <value of integer>
tcp-portrange: <value of string>
tcp-timewait-timer: <value of integer>
udp-idle-timer: <value of integer>
udp-portrange: <value of string>
visibility: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_firewall_service_custom_module.html
