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

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

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

Новое в версии 2.8: of fortinet.fortios

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

Обзор

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

Требования

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

ansible>=2.9.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
access_token строка				Аутентификация на основе токена. Сгенерирован из графического интерфейса Fortigate.
firewall_service_custom словарь				Настройка пользовательских служб.
	app_category список / элементы=строка			Идентификатор категории приложений.
		id целое число / обязательно		Идентификатор категории приложения.
	app_service_type строка		Варианты: disable app-id app-category	Тип службы приложения.
	application список / элементы=строка			Идентификатор приложения.
		id целое число / обязательно		Идентификатор приложения.
	category строка			Категория сервиса. Источник firewall.service.category.name.
	check_reset_range строка		Варианты: disable strict default	Настройка типа проверки сообщений об ошибках ICMP.
	color целое число			Цвет значка в графическом интерфейсе.
	comment строка			Комментарий.
	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	Имя помощника.
	icmpcode целое число			Код ICMP.
	icmptype целое число			Тип ICMP.
	iprange строка			Начало и конец диапазона IP, связанного с сервисом.
	name строка / обязательно			Имя пользовательской службы.
	protocol строка		Варианты: TCP/UDP/SCTP ICMP ICMP6 IP HTTP FTP CONNECT SOCKS-TCP SOCKS-UDP ALL	Тип протокола на основе номеров IANA.
	protocol_number целое число			Номер IP-протокола.
	proxy строка		Варианты: enable disable	Включить/выключить службу веб-прокси.
	sctp_portrange строка			Несколько диапазонов портов SCTP.
	session_ttl целое число			Время жизни сеанса (300 - 604800, 0 = значение по умолчанию).
	state строка добавлен в 2.9 fortinet.fortios		Варианты: present absent	Устарело Начиная с 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 строка		Варианты: enable disable	Включить/выключить видимость сервиса в графическом интерфейсе.
state строка добавлен в 2.9 of fortinet.fortios			Варианты: present absent	Указывает, нужно ли создавать или удалять объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перемещен на этот внешний уровень.
vdom строка			По умолчанию: "root"	Виртуальный домен из ранее определенных. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный блок.

Примечания

Примечание

Устаревший модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure custom services.
    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: "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

Авторы

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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_firewall_service_custom_module.html