Модуль fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper — настройка общего ограничителя трафика.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в 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_trafficshaper dictionary	Набор параметров верхнего уровня.
bandwidth_unit псевдонимы: bandwidth-unit string	Единица измерения гарантированной и максимальной пропускной способности этого ограничителя Варианты: `"kbps"` `"mbps"` `"gbps"`
cos string	Метка CoS VLAN.
cos_marking псевдонимы: cos-marking string	Включить или отключить маркировку CoS VLAN. Варианты: `"disable"` `"enable"`
cos_marking_method псевдонимы: cos-marking-method string	Выберите метод маркировки CoS VLAN. Варианты: `"multi-stage"` `"static"`
diffserv string	Включить или отключить изменение настройки DiffServ, применяемой к трафику, пропускаемому этим ограничителем. Варианты: `"disable"` `"enable"`
diffservcode string	Настройка DiffServ, применяемая к трафику, пропускаемому этим ограничителем.
dscp_marking_method псевдонимы: dscp-marking-method string	Выберите метод маркировки DSCP. Варианты: `"multi-stage"` `"static"`
exceed_bandwidth псевдонимы: exceed-bandwidth integer	Пропускная способность превышения, используемая для многоэтапной маркировки DSCP.
exceed_class_id псевдонимы: exceed-class-id integer	Идентификатор класса для трафика в диапазоне [guaranteed-bandwidth, maximum-bandwidth].
exceed_cos псевдонимы: exceed-cos string	Метка CoS VLAN для трафика в диапазоне [guaranteed-bandwidth, exceed-bandwidth].
exceed_dscp псевдонимы: exceed-dscp string	Метка DSCP для трафика в диапазоне [guaranteed-bandwidth, exceed-bandwidth].
guaranteed_bandwidth псевдонимы: guaranteed-bandwidth integer	Объём пропускной способности, гарантированный для этого ограничителя
maximum_bandwidth псевдонимы: maximum-bandwidth integer	Верхний предел пропускной способности, установленный этим ограничителем
maximum_cos псевдонимы: maximum-cos string	Метка CoS VLAN для трафика в диапазоне [exceed-bandwidth, maximum-bandwidth].
maximum_dscp псевдонимы: maximum-dscp string	Метка DSCP для трафика в диапазоне [exceed-bandwidth, maximum-bandwidth].
name string / обязательный	Имя ограничителя трафика.
overhead integer	Размер накладных данных на пакет, используемый при вычислении скорости.
per_policy псевдонимы: per-policy string	Включить или отключить применение отдельного ограничителя для каждой политики. Варианты: `"disable"` `"enable"`
priority string	Трафик с более высоким приоритетом с большей вероятностью будет пересылаться без задержек и без ущерба для гарантированной пропускной способности. Варианты: `"high"` `"medium"` `"low"`
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 shared traffic shaper.
      fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shaper_trafficshaper:
          bandwidth_unit: mbps # <value in [kbps, mbps, gbps]>
          diffserv: disable
          name: "ansible"
          per_policy: disable
          priority: medium # <value in [high, medium, low]>

- 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 shared traffic shapers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shaper_trafficshaper"
          params:
            adom: "ansible"
            traffic_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_trafficshaper_module.html