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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
firewall_shaper_peripshaper dictionary	Набор параметров верхнего уровня.
bandwidth-unit string	Устарело, переименуйте в bandwidth_unit. Единица измерения максимальной пропускной способности для этого шейпера. Варианты: `"kbps"` `"mbps"` `"gbps"`
diffserv-forward string	Устарело, переименуйте в diffserv_forward. Включить/выключить изменение Forward Варианты: `"disable"` `"enable"`
diffserv-reverse string	Устарело, переименуйте в diffserv_reverse. Включить/выключить изменение Reverse Варианты: `"disable"` `"enable"`
diffservcode-forward string	Устарело, переименуйте в diffservcode_forward. Forward
diffservcode-rev string	Устарело, переименуйте в diffservcode_rev. Reverse
max-bandwidth integer	Устарело, переименуйте в max_bandwidth. Верхний предел пропускной способности, применяемый этим шейпером.
max-concurrent-session integer	Устарело, переименуйте в max_concurrent_session. Максимальное количество одновременных сеансов, разрешенных этим шейпером.
max-concurrent-tcp-session integer	Устарело, переименуйте в max_concurrent_tcp_session. Максимальное количество одновременных TCP-сеансов, разрешенных этим шейпером.
max-concurrent-udp-session integer	Устарело, переименуйте в max_concurrent_udp_session. Максимальное количество одновременных UDP-сеансов, разрешенных этим шейпером.
name string / required	Имя шейпера трафика.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия успеха.
state string / required	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`

workspace_locking_adom строка	ADOM, который следует заблокировать для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным или другим, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `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_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 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 словарь	Результат запроса. Возвращается: всегда
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_peripshaper_module.html