fortios_firewall_shaping_policy – Настройка политик формирования трафика в Fortinet FortiOS и FortiGate
Новая версия 2.8.
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), предоставляя пользователю возможность устанавливать и изменять параметры и категорию правил брандмауэра, в том числе формирование трафика. Перед использованием необходимо скорректировать все параметры и значения в источниках данных. Тестировалось с FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| firewall_shaping_policy словарь | По умолчанию: null | Настройка правил формирования трафика. | ||
| 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 список | Один или несколько исходящих (egress) интерфейсов. | |||
| name строка / обязательно | Имя интерфейса. Источник system.interface.name system.zone.name. | |||
| groups список | Применить это правило формирования трафика к группам пользователей, которые авторизовались на FortiGate. | |||
| name строка / обязательно | Имя группы. Источник user.group.name. | |||
| id целое число / обязательно | Идентификатор правила формирования трафика. | |||
| internet_service строка |
| Включить/выключить использование интернет-служб для этого правила. Если включено, адрес назначения и служба не используются. | ||
| internet_service_custom список | Настраиваемое имя интернет-службы. | |||
| name строка / обязательно | Настраиваемое имя интернет-службы. Источник firewall.internet-service-custom.name. | |||
| internet_service_id список | Идентификатор интернет-службы. | |||
| id целое число / обязательно | Идентификатор интернет-службы. Источник firewall.internet-service.id. | |||
| internet_service_src строка |
| Включить/выключить использование интернет-служб в источнике для этого правила. Если включено, исходный адрес не используется. | ||
| internet_service_src_custom список | Настраиваемое имя источника интернет-службы. | |||
| name строка / обязательно | Настраиваемое имя интернет-службы. Источник firewall.internet-service-custom.name. | |||
| internet_service_src_id список | Идентификатор интернет-службы источника. | |||
| id целое число / обязательно | Идентификатор интернет-службы. Источник firewall.internet-service.id. | |||
| ip_version строка |
| Применить это правило формирования трафика к трафику 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 строка |
| Устарело Начиная с Ansible 2.9 рекомендуется использовать параметр 'state' на верхнем уровне. Указывает, создавать или удалять объект. | ||
| status строка |
| Включить/выключить это правило формирования трафика. | ||
| traffic_shaper строка | Формирователь трафика для применения к трафику, перенаправленному политикой брандмауэра. Источник firewall.shaper.traffic-shaper.name. | |||
| traffic_shaper_reverse строка | Формирователь трафика для применения к трафику ответа, полученному политикой брандмауэра. Источник firewall.shaper.traffic-shaper.name. | |||
| url_category список | Идентификаторы одной или нескольких категорий FortiGuard Web Filtering, к которым этот шапер применяет формирование трафика. | |||
| id целое число / обязательно | Идентификатор категории URL. | |||
| users список | Применить эту политику формирования трафика к отдельным пользователям, которые авторизовались на FortiGate. | |||
| name строка / обязательно | Имя пользователя. Источник user.local.name. | |||
| host строка | IP-адрес FortiOS или FortiGate. | |||
| https булево |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | ||
| password строка | По умолчанию: "" | Пароль FortiOS или FortiGate. | ||
| ssl_verify булево добавлено в 2.9 |
| Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации. | ||
| state строка добавлено в 2.9 |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перенесен на этот внешний уровень. | ||
| username строка | Имя пользователя FortiOS или FortiGate. | |||
| vdom строка | По умолчанию: "root" | Виртуальная область, среди тех, что определены ранее. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. | ||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Выполняется как local_action в вашем playbook
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure shaping policies.
fortios_firewall_shaping_policy:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
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 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете редактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_firewall_shaping_policy_module.html