Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Допустимые значения:

  • false ← (по умолчанию)
  • true

firewall_service_custom

dictionary

Настройка пользовательских служб.

app_category

list / elements=dictionary

Идентификатор категории приложения.

id

integer / обязательный

Идентификатор категории приложения. см. <a href=’#notes’>Примечания</a>.

app_service_type

string

Тип службы приложения.

Допустимые значения:

  • "disable"
  • "app-id"
  • "app-category"

application

list / elements=dictionary

Идентификатор приложения.

id

integer / обязательный

Идентификатор приложения. см. <a href=’#notes’>Примечания</a>.

category

string

Категория службы. Источник — firewall.service.category.name.

check_reset_range

string

Настройка типа проверки сообщений об ошибках ICMP.

Допустимые значения:

  • "disable"
  • "strict"
  • "default"

color

integer

Цвет значка в графическом интерфейсе.

comment

string

Комментарий.

fabric_object

string

Глобальная настройка объекта Security Fabric.

Допустимые значения:

  • "enable"
  • "disable"

fqdn

string

Полное доменное имя.

helper

string

Имя помощника.

Допустимые значения:

  • "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

integer

Код ICMP.

icmptype

integer

Тип ICMP.

iprange

string

Начало и конец диапазона IP-адресов, связанного со службой.

name

string / обязательный

Имя пользовательской службы.

protocol

string

Тип протокола согласно номерам IANA.

Допустимые значения:

  • "TCP/UDP/UDP-Lite/SCTP"
  • "ICMP"
  • "ICMP6"
  • "IP"
  • "HTTP"
  • "FTP"
  • "CONNECT"
  • "SOCKS-TCP"
  • "SOCKS-UDP"
  • "ALL"
  • "TCP/UDP/SCTP"

protocol_number

integer

Номер 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/UDP-Lite (0–86400 с, 0 = значение по умолчанию).

udp_portrange

string

Несколько диапазонов портов UDP.

udplite_portrange

string

Несколько диапазонов портов UDP-Lite.

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 — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска сценариев рекомендуется использовать httpapi
  • Модуль поддерживает 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/UDP-Lite/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>"
          udplite_portrange: "<your_own_value>"
          uuid: "<your_own_value>"
          visibility: "enable"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_firewall_service_custom_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API