Модуль fortinet.fortios.fortios_firewall_shaper_per_ip_shaper — настройка ограничителя трафика для каждого IP-адреса в 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_shaper_per_ip_shaper.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию firewall_shaper и категорию per_ip_shaper. В примерах представлены все параметры и значения; перед использованием их необходимо адаптировать к источникам данных. Проверено на FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены перечисленные ниже компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Допустимые значения:
|
firewall_shaper_per_ip_shaper dictionary | Настройка ограничителя трафика для каждого IP-адреса. |
|
bandwidth_unit string |
Единица измерения максимальной пропускной способности этого ограничителя (Kbps, Mbps или Gbps). Допустимые значения:
|
|
diffserv_forward string |
Включить или отключить изменение настройки DiffServ для исходящего направления (оригинального пакета), применяемой к трафику, принятому этим ограничителем. Допустимые значения:
|
|
diffserv_reverse string |
Включить или отключить изменение настройки DiffServ для обратного направления (ответного пакета), применяемой к трафику, принятому этим ограничителем. Допустимые значения:
|
|
diffservcode_forward string |
Настройка DiffServ для исходящего направления (оригинального пакета), применяемая к трафику, принятому этим ограничителем. |
|
diffservcode_rev string |
Настройка DiffServ для обратного направления (ответного пакета), применяемая к трафику, принятому этим ограничителем. |
|
max_bandwidth integer |
Верхний предел пропускной способности, устанавливаемый этим ограничителем (0–80000000). Значение 0 означает отсутствие ограничения. Единицы измерения зависят от параметра bandwidth-unit. |
|
max_concurrent_session integer |
Максимальное количество одновременных сеансов, разрешенное этим ограничителем (0–2097000). Значение 0 означает отсутствие ограничения. |
|
max_concurrent_tcp_session integer |
Максимальное количество одновременных сеансов TCP, разрешенное этим ограничителем (0–2097000). Значение 0 означает отсутствие ограничения. |
|
max_concurrent_udp_session integer |
Максимальное количество одновременных сеансов UDP, разрешенное этим ограничителем (0–2097000). Значение 0 означает отсутствие ограничения. |
|
name string / обязательный |
Имя ограничителя трафика. |
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются косой чертой. Параметр с указанным member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Допустимые значения:
|
state string / обязательный | Указывает, нужно ли создать или удалить объект. Допустимые значения:
|
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure per-IP traffic shaper.
fortinet.fortios.fortios_firewall_shaper_per_ip_shaper:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaper_per_ip_shaper:
bandwidth_unit: "kbps"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
max_bandwidth: "0"
max_concurrent_session: "0"
max_concurrent_tcp_session: "0"
max_concurrent_udp_session: "0"
name: "default_name_12"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_shaper_per_ip_shaper_module.html
