fortios_firewall_service_custom – Настройка пользовательских служб в FortiOS и FortiGate Fortinet
Новая в версии 2.8.
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию firewall_service и пользовательскую категорию. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировано с FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| firewall_service_custom словарь | По умолчанию: null | Настройка пользовательских служб. | ||
| app_category список | Идентификатор категории приложения. | |||
| id целое число / обязательно | Идентификатор категории приложения. | |||
| app_service_type строка |
| Тип службы приложения. | ||
| application список | Идентификатор приложения. | |||
| id целое число / обязательно | Идентификатор приложения. | |||
| category строка | Категория службы. Источник firewall.service.category.name. | |||
| 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 целое число | Session TTL (300 - 604800, 0 = значение по умолчанию). | |||
| state строка |
| Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' на верхнем уровне. Указывает, нужно ли создать или удалить объект. | ||
| 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 строка |
| Включение/выключение видимости службы в графическом интерфейсе. | ||
| host строка | IP-адрес FortiOS или FortiGate. | |||
| https булево |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | ||
| password строка | По умолчанию: "" | Пароль FortiOS или FortiGate. | ||
| ssl_verify булево добавлено в 2.9 |
| Обеспечивает проверку сертификата FortiGate у надлежащего центра сертификации. | ||
| state строка добавлено в 2.9 |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже был присутствующим в предыдущей версии на более глубоком уровне. Он был перемещен на этот внешний уровень. | ||
| username строка | Имя пользователя FortiOS или FortiGate. | |||
| vdom строка | По умолчанию: "root" | Виртуальный домен, среди тех, которые были определены ранее. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. | ||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Запуск как local_action в вашем playbook
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure custom services.
fortios_firewall_service_custom:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
firewall_service_custom:
app_category:
-
id: "4"
app_service_type: "disable"
application:
-
id: "7"
category: "<your_own_value> (source firewall.service.category.name)"
check_reset_range: "disable"
color: "10"
comment: "Comment."
fqdn: "<your_own_value>"
helper: "auto"
icmpcode: "14"
icmptype: "15"
iprange: "<your_own_value>"
name: "default_name_17"
protocol: "TCP/UDP/SCTP"
protocol_number: "19"
proxy: "enable"
sctp_portrange: "<your_own_value>"
session_ttl: "22"
tcp_halfclose_timer: "23"
tcp_halfopen_timer: "24"
tcp_portrange: "<your_own_value>"
tcp_timewait_timer: "26"
udp_idle_timer: "27"
udp_portrange: "<your_own_value>"
visibility: "enable"
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки образа fortigate Пример: 1547 |
| http_method строка | всегда | Последний метод, используемый для предоставления контента в FortiGate Пример: PUT |
| http_status строка | всегда | Последний результат, предоставленный FortiGate при последней операции Пример: 200 |
| mkey строка | успех | Главный ключ (id), используемый в последнем вызове FortiGate Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса Пример: urlfilter |
| path строка | всегда | Путь таблицы, используемой для выполнения запроса Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции Пример: успех |
| vdom строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_firewall_service_custom_module.html