Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_firewall_shaping_policy — настройка политик управления трафиком в 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_shaping_policy.

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

action

string

индикатор действия для перемещения объекта в списке

Варианты:

  • "move"

after

string

mkey целевого идентификатора

before

string

mkey целевого идентификатора

enable_log

boolean

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

Варианты:

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

firewall_shaping_policy

dictionary

Настройка политик управления трафиком.

app_category

list / элементы=dictionary

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

id

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

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

app_group

list / элементы=dictionary

Имя одной или нескольких групп приложений.

name

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

Имя группы приложений. Источник: application.group.name.

application

list / элементы=dictionary

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

id

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

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

class_id

integer

Идентификатор класса трафика. Источник: firewall.traffic-class.class-id.

comment

string

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

cos

string

Шаблон битов CoS VLAN.

cos_mask

string

Проверяемые биты CoS VLAN.

diffserv_forward

string

Включить изменение значений DiffServ пакета на указанное значение diffservcode-forward.

Варианты:

  • "enable"
  • "disable"

diffserv_reverse

string

Включить изменение обратных значений DiffServ пакета (ответа) на указанное значение diffservcode-rev.

Варианты:

  • "enable"
  • "disable"

diffservcode_forward

string

Изменить значение DiffServ пакета на это значение.

diffservcode_rev

string

Изменить обратное значение DiffServ пакета (ответа) на это значение.

dstaddr

list / элементы=dictionary

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

name

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

Имя адреса. Источник: firewall.address.name firewall.addrgrp.name.

dstaddr6

list / элементы=dictionary

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

name

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

Имя адреса. Источник: firewall.address6.name firewall.addrgrp6.name.

dstintf

list / элементы=dictionary

Один или несколько исходящих интерфейсов.

name

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

Имя интерфейса. Источник: system.interface.name system.zone.name system.sdwan.zone.name.

groups

list / элементы=dictionary

Применить эту политику управления трафиком к группам пользователей, прошедших аутентификацию на FortiGate.

name

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

Имя группы. Источник: user.group.name.

id

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

Идентификатор политики управления трафиком (0–4294967295). см. <a href=’#notes’>Примечания</a>.

internet_service

string

Включить/отключить использование интернет-сервисов для этой политики. Если параметр включён, адрес назначения и сервис не используются.

Варианты:

  • "enable"
  • "disable"

internet_service_custom

list / элементы=dictionary

Имя пользовательского интернет-сервиса.

name

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

Имя пользовательского интернет-сервиса. Источник: firewall.internet-service-custom.name.

internet_service_custom_group

list / элементы=dictionary

Имя группы пользовательских интернет-сервисов.

name

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

Имя группы пользовательских интернет-сервисов. Источник: firewall.internet-service-custom-group.name.

internet_service_fortiguard

list / элементы=dictionary

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

name

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

Имя интернет-сервиса FortiGuard. Источник: firewall.internet-service-fortiguard.name.

internet_service_group

list / элементы=dictionary

Имя группы интернет-сервисов.

name

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

Имя группы интернет-сервисов. Источник: firewall.internet-service-group.name.

internet_service_id

list / элементы=dictionary

Идентификатор интернет-сервиса.

id

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

Идентификатор интернет-сервиса. см. <a href=’#notes’>Примечания</a>. Источник: firewall.internet-service.id.

internet_service_name

list / элементы=dictionary

Идентификатор интернет-сервиса.

name

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

Имя интернет-сервиса. Источник: firewall.internet-service-name.name.

internet_service_src

string

Включить/отключить использование интернет-сервисов в качестве источника для этой политики. Если параметр включён, исходный адрес не используется.

Варианты:

  • "enable"
  • "disable"

internet_service_src_custom

list / элементы=dictionary

Имя пользовательского интернет-сервиса в качестве источника.

name

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

Имя пользовательского интернет-сервиса. Источник: firewall.internet-service-custom.name.

internet_service_src_custom_group

list / элементы=dictionary

Имя группы пользовательских интернет-сервисов в качестве источника.

name

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

Имя группы пользовательских интернет-сервисов. Источник: firewall.internet-service-custom-group.name.

internet_service_src_fortiguard

list / элементы=dictionary

Имя интернет-сервиса FortiGuard в качестве источника.

name

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

Имя интернет-сервиса FortiGuard. Источник: firewall.internet-service-fortiguard.name.

internet_service_src_group

list / элементы=dictionary

Имя группы интернет-сервисов в качестве источника.

name

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

Имя группы интернет-сервисов. Источник: firewall.internet-service-group.name.

internet_service_src_id

list / элементы=dictionary

Идентификатор интернет-сервиса в качестве источника.

id

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

Идентификатор интернет-сервиса. см. <a href=’#notes’>Примечания</a>. Источник: firewall.internet-service.id.

internet_service_src_name

list / элементы=dictionary

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

name

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

Имя интернет-сервиса. Источник: firewall.internet-service-name.name.

ip_version

string

Применить эту политику управления трафиком к трафику IPv4 или IPv6.

Варианты:

  • "4"
  • "6"

name

string

Имя политики управления трафиком.

per_ip_shaper

string

Политика управления трафиком для каждого IP-адреса, применяемая этой политикой. Источник: firewall.shaper.per-ip-shaper.name.

schedule

string

Имя расписания. Источник: firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name.

service

list / elements=dictionary

Имена служб и групп служб.

name

string / required

Имя службы. Источник: firewall.service.custom.name firewall.service.group.name.

srcaddr

list / elements=dictionary

Адрес источника IPv4 и имена групп адресов.

name

string / required

Имя адреса. Источник: firewall.address.name firewall.addrgrp.name.

srcaddr6

list / elements=dictionary

Адрес источника IPv6 и имена групп адресов.

name

string / required

Имя адреса. Источник: firewall.address6.name firewall.addrgrp6.name.

srcintf

list / elements=dictionary

Один или несколько входящих интерфейсов (ingress).

name

string / required

Имя интерфейса. Источник: system.interface.name system.zone.name system.sdwan.zone.name.

status

string

Включить или отключить эту политику управления трафиком.

Варианты:

  • "enable"
  • "disable"

tos

string

Значение ToS (тип обслуживания), используемое для сравнения.

tos_mask

string

Позиции ненулевых битов используются для сравнения, а позиции нулевых битов игнорируются.

tos_negate

string

Включить инвертированное сопоставление TOS.

Варианты:

  • "enable"
  • "disable"

traffic_shaper

string

Формирователь трафика, применяемый к трафику, перенаправляемому политикой межсетевого экрана. Источник: firewall.shaper.traffic-shaper.name.

traffic_shaper_reverse

string

Формирователь трафика, применяемый к ответному трафику, получаемому политикой межсетевого экрана. Источник: firewall.shaper.traffic-shaper.name.

traffic_type

string

Тип трафика.

Варианты:

  • "forwarding"
  • "local-in"
  • "local-out"

url_category

list / elements=dictionary

Идентификаторы одной или нескольких категорий веб-фильтрации FortiGuard, для которых этот формирователь применяет управление трафиком.

id

integer / required

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

users

list / elements=dictionary

Применить эту политику управления трафиком к отдельным пользователям, прошедшим аутентификацию на FortiGate.

name

string / required

Имя пользователя. Источник: user.local.name.

uuid

string

Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную).

member_path

string

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

Если атрибутов несколько, они разделяются косой чертой.

Параметр с пометкой member_path поддерживает выполнение операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если указан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

self

string

mkey идентификатора self

state

string

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

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

Примечания

Примечание

  • Настоятельно рекомендуем использовать собственное значение для id вместо 0. Значение «0» — это специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, однако у этого варианта есть ограничения. Подробности см. в разделе «Вопросы и ответы».
  • Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi.
  • Изменяйте порядок объектов, перемещая self после (перед) другого объекта.
  • При перемещении объекта необходимо указать только один из параметров [after, before].
  • Модуль поддерживает check_mode.

Примеры

- name: Configure shaping policies.
  fortinet.fortios.fortios_firewall_shaping_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_shaping_policy:
          app_category:
              -
                  id: "4"
          app_group:
              -
                  name: "default_name_6 (source application.group.name)"
          application:
              -
                  id: "8"
          class_id: "0"
          comment: "Comments."
          cos: "<your_own_value>"
          cos_mask: "<your_own_value>"
          diffserv_forward: "enable"
          diffserv_reverse: "enable"
          diffservcode_forward: "<your_own_value>"
          diffservcode_rev: "<your_own_value>"
          dstaddr:
              -
                  name: "default_name_18 (source firewall.address.name firewall.addrgrp.name)"
          dstaddr6:
              -
                  name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name)"
          dstintf:
              -
                  name: "default_name_22 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          groups:
              -
                  name: "default_name_24 (source user.group.name)"
          id: "25"
          internet_service: "enable"
          internet_service_custom:
              -
                  name: "default_name_28 (source firewall.internet-service-custom.name)"
          internet_service_custom_group:
              -
                  name: "default_name_30 (source firewall.internet-service-custom-group.name)"
          internet_service_fortiguard:
              -
                  name: "default_name_32 (source firewall.internet-service-fortiguard.name)"
          internet_service_group:
              -
                  name: "default_name_34 (source firewall.internet-service-group.name)"
          internet_service_id:
              -
                  id: "36 (source firewall.internet-service.id)"
          internet_service_name:
              -
                  name: "default_name_38 (source firewall.internet-service-name.name)"
          internet_service_src: "enable"
          internet_service_src_custom:
              -
                  name: "default_name_41 (source firewall.internet-service-custom.name)"
          internet_service_src_custom_group:
              -
                  name: "default_name_43 (source firewall.internet-service-custom-group.name)"
          internet_service_src_fortiguard:
              -
                  name: "default_name_45 (source firewall.internet-service-fortiguard.name)"
          internet_service_src_group:
              -
                  name: "default_name_47 (source firewall.internet-service-group.name)"
          internet_service_src_id:
              -
                  id: "49 (source firewall.internet-service.id)"
          internet_service_src_name:
              -
                  name: "default_name_51 (source firewall.internet-service-name.name)"
          ip_version: "4"
          name: "default_name_53"
          per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
          schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
          service:
              -
                  name: "default_name_57 (source firewall.service.custom.name firewall.service.group.name)"
          srcaddr:
              -
                  name: "default_name_59 (source firewall.address.name firewall.addrgrp.name)"
          srcaddr6:
              -
                  name: "default_name_61 (source firewall.address6.name firewall.addrgrp6.name)"
          srcintf:
              -
                  name: "default_name_63 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          status: "enable"
          tos: "<your_own_value>"
          tos_mask: "<your_own_value>"
          tos_negate: "enable"
          traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
          traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
          traffic_type: "forwarding"
          url_category:
              -
                  id: "72"
          users:
              -
                  name: "default_name_74 (source user.local.name)"
          uuid: "<your_own_value>"

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

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

Ключ

Описание

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_shaping_policy_module.html

Spec-Zone.ru

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