Модуль fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper – Настройка общего формирователя трафика.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_shaper_trafficshaper словарь	Установленные параметры верхнего уровня.
bandwidth_unit строка	Устаревшее, пожалуйста, переименуйте на bandwidth_unit. Единица измерения гарантированной и максимальной пропускной способности для этого формирователя. Варианты: `"kbps"` `"mbps"` `"gbps"`
cos строка	Пометка VLAN CoS.
cos_marking строка	Устаревшее, пожалуйста, переименуйте на cos_marking. Включение/выключение маркировки VLAN CoS. Варианты: `"disable"` `"enable"`
cos_marking_method строка	Устаревшее, пожалуйста, переименуйте на cos_marking_method. Выбор метода маркировки VLAN CoS. Варианты: `"multi-stage"` `"static"`
diffserv строка	Включение/выключение изменения настройки DiffServ, применяемой к трафику, принятому этим формирователем. Варианты: `"disable"` `"enable"`
diffservcode строка	Настройка DiffServ, которая должна применяться к трафику, принятому этим формирователем.
dscp_marking_method строка	Устаревшее, пожалуйста, переименуйте на dscp_marking_method. Выбор метода маркировки DSCP. Варианты: `"multi-stage"` `"static"`
exceed_bandwidth целое число	Устаревшее, пожалуйста, переименуйте на exceed_bandwidth. Пропускная способность превышения, используемая для маркировки DSCP с несколькими этапами.
exceed_class_id целое число	Устаревшее, пожалуйста, переименуйте на exceed_class_id. Идентификатор класса для трафика в [guaranteed-bandwidth, maximum-bandwidth].
exceed_cos строка	Устаревшее, пожалуйста, переименуйте на exceed_cos. Пометка VLAN CoS для трафика в [guaranteed-bandwidth, exceed-bandwidth].
exceed_dscp строка	Устаревшее, пожалуйста, переименуйте на exceed_dscp. Пометка DSCP для трафика в [guaranteed-bandwidth, exceed-bandwidth].
guaranteed_bandwidth целое число	Устаревшее, пожалуйста, переименуйте на guaranteed_bandwidth. Количество пропускной способности, гарантированное для этого формирователя.
maximum_bandwidth целое число	Устаревшее, пожалуйста, переименуйте на maximum_bandwidth. Максимальное ограничение пропускной способности, накладываемое этим формирователем.
maximum_cos строка	Устаревшее, пожалуйста, переименуйте на maximum_cos. Пометка VLAN CoS для трафика в [exceed-bandwidth, maximum-bandwidth].
maximum_dscp строка	Устаревшее, пожалуйста, переименуйте на maximum_dscp. Пометка DSCP для трафика в [exceed-bandwidth, maximum-bandwidth].

END_OF_DOCUMENT_MARKER

имя строка / обязательно	Имя формирователя трафика.
overhead целое число	Дополнительный размер пакета, используемый в расчетах скорости.
per-policy строка	Устаревшее, пожалуйста, переименуйте на per_policy. Включение/выключение применения отдельного формирователя для каждой политики. Варианты: `"disable"` `"enable"`
приоритет строка	Трафик с более высоким приоритетом с большей вероятностью будет пересылаться без задержек и без нарушения гарантированной пропускной способности. Варианты: `"high"` `"medium"` `"low"`
токен_доступа_forticloud строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
предложенный_метод строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут игнорироваться.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут выполняться.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
блокировка_рабочей_области_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корневой.
таймаут_блокировки_рабочей_области целое число	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_shaper_trafficshaper_module.html