Spec-Zone.ru › Ansible 2.11

fortinet.fortios.fortios_firewall_shaping_policy – Настройка политик формирования трафика в FortiOS и FortiGate Fortinet.

Примечание

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

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

Для использования в playbook укажите: fortinet.fortios.fortios_firewall_shaping_policy.

Добавлена в версии 2.8: плагин fortinet.fortios

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

Обзор

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

Требования

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

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токена. Создается в интерфейсе Fortigate.
firewall_shaping_policy
словарь
Настройка политик формирования трафика.
app_category
список / элементы=строка
Идентификаторы одной или нескольких категорий приложений, к которым применяется формирование трафика для управления приложениями.
id
целое число / обязательно
Идентификаторы категорий.
application
список / элементы=строка
Идентификаторы одного или нескольких приложений, к которым применяется формирование трафика для управления приложениями.
id
целое число / обязательно
Идентификаторы приложений.
class_id
целое число
Идентификатор класса трафика.
comment
строка
Комментарии.
dstaddr
список / элементы=строка
IPv4 адрес назначения и имена групп адресов.
name
строка / обязательно
Имя адреса. Источник firewall.address.name firewall.addrgrp.name.
dstaddr6
список / элементы=строка
IPv6 адрес назначения и имена групп адресов.
name
строка / обязательно
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name.
dstintf
список / элементы=строка
Один или несколько исходящих интерфейсов.
name
строка / обязательно
Имя интерфейса. Источник system.interface.name system.zone.name.
groups
список / элементы=строка
Применение этой политики формирования трафика к группам пользователей, авторизованным на FortiGate.
name
строка / обязательно
Имя группы. Источник user.group.name.
id
целое число / обязательно
Идентификатор политики формирования трафика.
internet_service
строка
    Варианты:
  • enable
  • disable
Включить/выключить использование интернет-услуг для этой политики. Если включено, адрес назначения и услуга не используются.
internet_service_custom
список / элементы=строка
Настраиваемое имя интернет-услуги.
name
строка / обязательно
Настраиваемое имя интернет-услуги. Источник firewall.internet-service-custom.name.
internet_service_id
список / элементы=строка
Идентификатор интернет-услуги.
id
целое число / обязательно
Идентификатор интернет-услуги. Источник firewall.internet-service.id.
internet_service_src
строка
    Варианты:
  • enable
  • disable
Включить/выключить использование интернет-услуг в источнике для этой политики. Если включено, исходный адрес не используется.
internet_service_src_custom
список / элементы=строка
Настраиваемое имя источника интернет-услуги.
name
строка / обязательно
Настраиваемое имя интернет-услуги. Источник firewall.internet-service-custom.name.
internet_service_src_id
список / элементы=строка
Идентификатор источника интернет-услуги.
id
целое число / обязательно
Идентификатор интернет-услуги. Источник firewall.internet-service.id.
ip_version
строка
    Варианты:
  • 4
  • 6
Применение этой политики формирования трафика к трафику IPv4 или IPv6.
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.
state
строка
    Варианты:
  • present
  • absent
Устарело
Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
status
строка
    Варианты:
  • enable
  • disable
Включить/выключить эту политику формирования трафика.
traffic_shaper
строка
Формирователь трафика для применения к трафику, пересылаемому политикой брандмауэра. Источник firewall.shaper.traffic-shaper.name.
traffic_shaper_reverse
строка
Формирователь трафика для применения к ответному трафику, полученному политикой брандмауэра. Источник firewall.shaper.traffic-shaper.name.
url_category
список / элементы=строка
Идентификаторы одной или нескольких категорий веб-фильтрации FortiGuard, к которым применяется формирование трафика этим формирователем.
id
целое число / обязательно
Идентификатор категории URL.
users
список / элементы=строка
Применение этой политики формирования трафика к отдельным пользователям, авторизованным на FortiGate.
name
строка / обязательно
Имя пользователя. Источник user.local.name.
state
строка
добавлен в 2.9 fortinet.fortios
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перемещен на этот внешний уровень.
vdom
строка
По умолчанию:
"root"
Виртуальный домен, из ранее определенных. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

  • Модуль fortiosapi устарел, предпочтительным способом выполнения плейбуков является httpapi

Примеры

- 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 shaping policies.
    fortios_firewall_shaping_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_shaping_policy:
        app_category:
         -
            id:  "4"
        application:
         -
            id:  "6"
        class_id: "7"
        comment: "Comments."
        dstaddr:
         -
            name: "default_name_10 (source firewall.address.name firewall.addrgrp.name)"
        dstaddr6:
         -
            name: "default_name_12 (source firewall.address6.name firewall.addrgrp6.name)"
        dstintf:
         -
            name: "default_name_14 (source system.interface.name system.zone.name)"
        groups:
         -
            name: "default_name_16 (source user.group.name)"
        id:  "17"
        internet_service: "enable"
        internet_service_custom:
         -
            name: "default_name_20 (source firewall.internet-service-custom.name)"
        internet_service_id:
         -
            id:  "22 (source firewall.internet-service.id)"
        internet_service_src: "enable"
        internet_service_src_custom:
         -
            name: "default_name_25 (source firewall.internet-service-custom.name)"
        internet_service_src_id:
         -
            id:  "27 (source firewall.internet-service.id)"
        ip_version: "4"
        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_32 (source firewall.service.custom.name firewall.service.group.name)"
        srcaddr:
         -
            name: "default_name_34 (source firewall.address.name firewall.addrgrp.name)"
        srcaddr6:
         -
            name: "default_name_36 (source firewall.address6.name firewall.addrgrp6.name)"
        status: "enable"
        traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        url_category:
         -
            id:  "41"
        users:
         -
            name: "default_name_43 (source user.local.name)"

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

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

Ключ Возвращается Описание
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_shaping_policy_module.html

Spec-Zone.ru

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