Spec-Zone.ru › Ansible

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

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

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

Описание

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

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Создаётся в GUI Fortigate.

action

string

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

Варианты:

  • "move"

after

string

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

before

string

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

enable_log

boolean

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

Варианты:

  • false ← (default)
  • true

firewall_shaping_policy

dictionary

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

app_category

list / elements=dictionary

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

id

integer / required

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

app_group

list / elements=dictionary

Одно или несколько имён групп приложений.

name

string / required

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

application

list / elements=dictionary

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

id

integer / required

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

class_id

integer

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

comment

string

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

cos

string

Битовая маска VLAN CoS.

cos_mask

string

Вычисляемые биты VLAN CoS.

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 / elements=dictionary

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

name

string / required

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

dstaddr6

list / elements=dictionary

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

name

string / required

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

dstintf

list / elements=dictionary

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

name

string / required

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

groups

list / elements=dictionary

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

name

string / required

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

id

integer / required

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

internet_service

string

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

Варианты:

  • "enable"
  • "disable"

internet_service_custom

list / elements=dictionary

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

name

string / required

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

internet_service_custom_group

list / elements=dictionary

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

name

string / required

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

internet_service_group

list / elements=dictionary

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

name

string / required

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

internet_service_id

list / elements=dictionary

ID интернет-сервиса.

id

integer / required

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

internet_service_name

list / elements=dictionary

ID интернет-сервиса.

name

string / required

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

internet_service_src

string

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

Варианты:

  • "enable"
  • "disable"

internet_service_src_custom

list / elements=dictionary

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

name

string / required

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

internet_service_src_custom_group

list / elements=dictionary

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

name

строка / обязательно

Имя настраиваемой группы интернет-служб. Источник firewall.internet-service-custom-group.name.

internet_service_src_group

список / элементы=словарь

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

name

строка / обязательно

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

internet_service_src_id

список / элементы=словарь

Идентификатор источника интернет-службы.

id

целое число / обязательно

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

internet_service_src_name

список / элементы=словарь

Название источника интернет-службы.

name

строка / обязательно

Имя интернет-службы. Источник firewall.internet-service-name.name.

ip_version

строка

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

Выбооры:

  • "4"
  • "6"

name

строка

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

per_ip_shaper

строка

Формирователь трафика на основе IP адреса для применения с данной политикой. Источник firewall.shaper.per-ip-shaper.name.

schedule

строка

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

service

список / элементы=словарь

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

name

строка / обязательно

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

srcaddr

список / элементы=словарь

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

name

строка / обязательно

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

srcaddr6

список / элементы=словарь

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

name

строка / обязательно

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

srcintf

список / элементы=словарь

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

name

строка / обязательно

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

status

строка

Включить/выключить данную политику формирования трафика.

Выбооры:

  • "enable"
  • "disable"

tos

строка

Значение ToS (Type of Service) используемое для сравнения.

tos_mask

строка

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

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 Web Filtering, к которым применяется формирование трафика.

id

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

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

users

list / elements=dictionary

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

name

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

Имя пользователя. Источник 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), из ранее определённых. Vdom — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельный блок.

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

Примечания

Примечание

  • Мы настоятельно рекомендуем использовать собственное значение в качестве id вместо 0. Хотя «0» — это специальный маркер, позволяющий бэкенду назначить последнее доступное число для объекта, у него есть ограничения. Подробнее см. в разделе ВП.
  • Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks.
  • Измените порядок объектов, переместив 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_group:
              -
                  name: "default_name_32 (source firewall.internet-service-group.name)"
          internet_service_id:
              -
                  id: "34 (source firewall.internet-service.id)"
          internet_service_name:
              -
                  name: "default_name_36 (source firewall.internet-service-name.name)"
          internet_service_src: "enable"
          internet_service_src_custom:
              -
                  name: "default_name_39 (source firewall.internet-service-custom.name)"
          internet_service_src_custom_group:
              -
                  name: "default_name_41 (source firewall.internet-service-custom-group.name)"
          internet_service_src_group:
              -
                  name: "default_name_43 (source firewall.internet-service-group.name)"
          internet_service_src_id:
              -
                  id: "45 (source firewall.internet-service.id)"
          internet_service_src_name:
              -
                  name: "default_name_47 (source firewall.internet-service-name.name)"
          ip_version: "4"
          name: "default_name_49"
          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_53 (source firewall.service.custom.name firewall.service.group.name)"
          srcaddr:
              -
                  name: "default_name_55 (source firewall.address.name firewall.addrgrp.name)"
          srcaddr6:
              -
                  name: "default_name_57 (source firewall.address6.name firewall.addrgrp6.name)"
          srcintf:
              -
                  name: "default_name_59 (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: "68"
          users:
              -
                  name: "default_name_70 (source user.local.name)"
          uuid: "<your_own_value>"

Значения возврата

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

Ключ

Описание

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

Spec-Zone.ru

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