Модуль fortinet.fortimanager.fmgr_firewall_shaper_peripshaper — настройка формирователя трафика для каждого IP-адреса.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_shaper_peripshaper.

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

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

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит работу без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_shaper_peripshaper dictionary	Параметры верхнего уровня.
bandwidth_unit псевдонимы: bandwidth-unit string	Единица измерения максимальной пропускной способности для этого формирователя трафика Варианты: `"kbps"` `"mbps"` `"gbps"`
diffserv_forward псевдонимы: diffserv-forward string	Включить или отключить изменение значения для прямого направления Варианты: `"disable"` `"enable"`
diffserv_reverse псевдонимы: diffserv-reverse string	Включить или отключить изменение значения для обратного направления Варианты: `"disable"` `"enable"`
diffservcode_forward псевдонимы: diffservcode-forward string	Прямое направление
diffservcode_rev псевдонимы: diffservcode-rev string	Обратное направление
max_bandwidth псевдонимы: max-bandwidth integer	Верхний предел пропускной способности, устанавливаемый этим формирователем трафика
max_concurrent_session псевдонимы: max-concurrent-session integer	Максимальное количество одновременных сеансов, разрешенное этим формирователем трафика
max_concurrent_tcp_session псевдонимы: max-concurrent-tcp-session integer	Максимальное количество одновременных сеансов TCP, разрешенное этим формирователем трафика
max_concurrent_udp_session псевдонимы: max-concurrent-udp-session integer	Максимальное количество одновременных сеансов UDP, разрешенное этим формирователем трафика
name string / обязательный	Имя формирователя трафика.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов должны соответствовать соглашению об использовании подчеркиваний (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают управлять этим режимом.
Обычно выполнение модуля может завершиться ошибкой, если возвращен ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure per-IP traffic shaper.
      fortinet.fortimanager.fmgr_firewall_shaper_peripshaper:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shaper_peripshaper:
          bandwidth_unit: mbps # <value in [kbps, mbps, gbps]>
          diffserv_forward: enable
          diffserv_reverse: disable
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the per-IP traffic shapers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shaper_peripshaper"
          params:
            adom: "ansible"
            per_ip_shaper: "your_value"

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: при определенных условиях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_firewall_shaper_peripshaper_module.html