Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_firewall_internet_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_internet_service_custom.

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

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

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры брандмауэра и категории internet_service_custom. В примерах приведены все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием. Проверено с FOS v6.0.0

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

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

firewall_internet_service_custom

dictionary

Настройка пользовательских интернет-сервисов.

comment

string

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

disable_entry

list / elements=dictionary

Отключение записей в базе данных интернет-сервисов.

id

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

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

ip_range

list / elements=dictionary

Диапазоны IP-адресов в отключаемой записи.

end_ip

string

Конечный IP-адрес.

id

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

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

start_ip

string

Начальный IP-адрес.

port

integer

Целочисленное значение TCP/IP-порта (0–65535).

protocol

integer

Целочисленное значение типа протокола согласно определению IANA (0–255).

entry

list / elements=dictionary

Записи, добавляемые в базу данных интернет-сервисов и пользовательскую базу данных.

addr_mode

string

Режим адресации (IPv4 или IPv6).

Варианты:

  • "ipv4"
  • "ipv6"

dst

list / elements=dictionary

Адрес назначения или имя группы адресов.

name

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

Выберите адрес назначения или объект группы адресов из доступных вариантов. Источник: firewall.address.name, firewall .addrgrp.name.

dst6

list / elements=dictionary

Адрес назначения IPv6 или имя группы адресов IPv6.

name

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

Выберите адрес назначения IPv6 или объект группы адресов из доступных вариантов. Источник: firewall.address6.name, firewall .addrgrp6.name.

id

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

Идентификатор записи (1–255). См. <a href=’#notes’>примечания</a>.

port_range

list / elements=dictionary

Диапазоны портов в пользовательской записи.

end_port

integer

Целочисленное значение конечного порта назначения TCP/UDP/SCTP в диапазоне (от 0 до 65535).

id

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

Идентификатор диапазона портов пользовательской записи. См. <a href=’#notes’>примечания</a>.

start_port

integer

Целочисленное значение начального порта назначения TCP/UDP/SCTP в диапазоне (от 0 до 65535).

protocol

integer

Целочисленное значение типа протокола согласно определению IANA (0–255).

master_service_id

integer

Идентификатор интернет-сервиса в базе данных интернет-сервисов. Источник: firewall.internet-service.id.

name

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

Имя интернет-сервиса.

reputation

integer

Уровень репутации пользовательского интернет-сервиса. Источник: firewall.internet-service-reputation.id.

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 Internet Services.
  fortinet.fortios.fortios_firewall_internet_service_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_internet_service_custom:
          comment: "Comment."
          disable_entry:
              -
                  id: "5"
                  ip_range:
                      -
                          end_ip: "<your_own_value>"
                          id: "8"
                          start_ip: "<your_own_value>"
                  port: "32767"
                  protocol: "127"
          entry:
              -
                  addr_mode: "ipv4"
                  dst:
                      -
                          name: "default_name_15 (source firewall.address.name firewall.addrgrp.name)"
                  dst6:
                      -
                          name: "default_name_17 (source firewall.address6.name firewall.addrgrp6.name)"
                  id: "18"
                  port_range:
                      -
                          end_port: "65535"
                          id: "21"
                          start_port: "1"
                  protocol: "0"
          master_service_id: "2147483647"
          name: "default_name_25"
          reputation: "3"

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

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

Ключ

Описание

build

string

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

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

Пример: "1547"

http_method

string

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

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

Пример: "PUT"

http_status

string

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

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

Пример: "200"

mkey

string

Главный ключ (id), использованный при последнем обращении к 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_internet_service_custom_module.html

Spec-Zone.ru

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