fortinet.fortios.fortios_firewall_shaper_per_ip_shaper модуль — Настройка формирователя трафика по IP-адресу в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в playbook, укажите: 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.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в GUI Fortigate.
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
firewall_shaper_per_ip_shaper dictionary	Настроить ограничитель трафика на основе IP-адреса.
bandwidth_unit string	Единица измерения максимальной пропускной способности для этого ограничителя (Kbps, Mbps или Gbps). Варианты: `"kbps"` `"mbps"` `"gbps"`
diffserv_forward string	Включить/выключить изменение параметра DiffServ Forward (исходный) применяемого к трафику, принимаемому этим ограничителем. Варианты: `"enable"` `"disable"`
diffserv_reverse string	Включить/выключить изменение параметра DiffServ Reverse (ответ) применяемого к трафику, принимаемому этим ограничителем. Варианты: `"enable"` `"disable"`
diffservcode_forward string	Параметр DiffServ Forward (исходный), который будет применен к трафику, принимаемому этим ограничителем.
diffservcode_rev string	Параметр DiffServ Reverse (ответ), который будет применен к трафику, принимаемому этим ограничителем.
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 / required	Имя ограничителя трафика.
member_path string	Путь к атрибуту элемента для выполнения операции. Разделяется символом слеша, если атрибутов больше одного. Параметр, отмеченный member_path, является допустимым для выполнения операции с элементом.
member_state string	Добавить или удалить элемент под указанным путем к атрибуту. При указании member_state параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / required	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен, среди тех, которые были определены ранее. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный модуль. Значение по умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi был снят с поддержки, httpapi — предпочтительный способ запуска playbook'ов
Модуль поддерживает 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 строка	Номер сборки образа 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_shaper_per_ip_shaper_module.html