fortinet.fortios.fortios_firewall_service_custom модуль – Настройка пользовательских служб в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: fortinet.fortios.fortios_firewall_service_custom.

Добавлена в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию firewall_service и пользовательскую категорию. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate.
enable_log логическое	Включить/выключить ведение журнала для задачи. Вызовы: `false` ← (по умолчанию) `true`
firewall_service_custom словарь	Настройка пользовательских служб.
app_category список / элементы=словарь	Идентификатор категории приложений.
id целое число / требуется	Идентификатор категории приложений. См. <a href=’#notes’>Примечания</a>.
app_service_type строка	Тип службы приложения. Вызовы: `"disable"` `"app-id"` `"app-category"`
application список / элементы=словарь	Идентификатор приложения.
id целое число / требуется	Идентификатор приложения. См. <a href=’#notes’>Примечания</a>.
category строка	Категория службы. Источник firewall.service.category.name.
check_reset_range строка	Настройка типа проверки сообщений об ошибках ICMP. Вызовы: `"disable"` `"strict"` `"default"`
color целое число	Цвет значка в графическом интерфейсе.
comment строка	Комментарий.
fabric_object строка	Настройка глобального объекта Security Fabric. Вызовы: `"enable"` `"disable"`
fqdn строка	Полное доменное имя.
helper строка	Имя помощника. Вызовы: `"auto"` `"disable"` `"ftp"` `"tftp"` `"ras"` `"h323"` `"tns"` `"mms"` `"sip"` `"pptp"` `"rtsp"` `"dns-udp"` `"dns-tcp"` `"pmap"` `"rsh"` `"dcerpc"` `"mgcp"` `"gtp-c"` `"gtp-u"` `"gtp-b"` `"pfcp"`
icmpcode целое число	Код ICMP.
icmptype целое число	Тип ICMP.
iprange строка	Начало и конец диапазона IP-адресов, связанных со службой.
name строка / требуется	Имя пользовательской службы.
protocol строка	Тип протокола на основе номеров IANA. Вызовы: `"TCP/UDP/SCTP"` `"ICMP"` `"ICMP6"` `"IP"` `"HTTP"` `"FTP"` `"CONNECT"` `"SOCKS-TCP"` `"SOCKS-UDP"` `"ALL"`
protocol_number целое число	Номер IP-протокола.

proxy string	Включить/отключить веб-прокси-сервис. Выбор: `"enable"` `"disable"`
sctp_portrange string	Несколько диапазонов портов SCTP.
session_ttl string	Время жизни сессии (300 - 2764800, 0 = значение по умолчанию).
tcp_halfclose_timer integer	Время ожидания закрытия TCP-сессии в ожидании ответа пакета FIN (1 - 86400 сек, 0 = значение по умолчанию).
tcp_halfopen_timer integer	Время ожидания закрытия TCP-сессии в ожидании ответа пакета открытия сессии (1 - 86400 сек, 0 = значение по умолчанию).
tcp_portrange string	Несколько диапазонов портов TCP.
tcp_rst_timer integer	Установите длительность состояния TCP CLOSE в секундах (5 - 300 сек, 0 = значение по умолчанию).
tcp_timewait_timer integer	Установите длительность состояния TCP TIME-WAIT в секундах (1 - 300 сек, 0 = значение по умолчанию).
udp_idle_timer integer	Количество секунд до истечения времени ожидания для неактивного UDP-соединения (0 - 86400 сек, 0 = значение по умолчанию).
udp_portrange string	Несколько диапазонов портов UDP.
uuid string	Универсальный уникальный идентификатор (UUID; автоматически назначается, но может быть вручную сброшен).
visibility string	Включить/отключить видимость службы в пользовательском интерфейсе. Выбор: `"enable"` `"disable"`
member_path string	Путь к атрибуту члена для обработки. Разделяется с помощью символа косой черты, если атрибутов более одного. Параметр, помеченный как member_path, допустим для выполнения операции с членом.
member_state string	Добавить или удалить члена по указанному пути к атрибуту. Когда member_state указан, опция state игнорируется. Выбор: `"present"` `"absent"`
state string / обязательно	Указывает, нужно ли создать или удалить объект. Выбор: `"present"` `"absent"`
vdom string	Виртуальная область (vdom) из тех, которые были определены ранее. Vdom — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, httpapi — предпочтительный способ выполнения playbook.
Модуль поддерживает режим check_mode.

Примеры

- name: Configure custom services.
  fortinet.fortios.fortios_firewall_service_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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: "0"
          comment: "Comment."
          fabric_object: "enable"
          fqdn: "<your_own_value>"
          helper: "auto"
          icmpcode: ""
          icmptype: ""
          iprange: "<your_own_value>"
          name: "default_name_18"
          protocol: "TCP/UDP/SCTP"
          protocol_number: "0"
          proxy: "enable"
          sctp_portrange: "<your_own_value>"
          session_ttl: "<your_own_value>"
          tcp_halfclose_timer: "0"
          tcp_halfopen_timer: "0"
          tcp_portrange: "<your_own_value>"
          tcp_rst_timer: "0"
          tcp_timewait_timer: "0"
          udp_idle_timer: "0"
          udp_portrange: "<your_own_value>"
          uuid: "<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 строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_firewall_service_custom_module.html