fortinet.fortimanager.fmgr_qosprofile – Настройка профилей качества обслуживания Wi-Fi (QoS).
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_qosprofile.
Новое в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL-адресе | ||
| bypass_validation логический |
| устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров | |
| qosprofile словарь | установленные параметры верхнего уровня | ||
| bandwidth-admission-control строка |
| Включение/выключение управления допуском пропускной способности WMM. | |
| bandwidth-capacity целое число | Максимальная пропускная способность (1–600000 Кбит/с, по умолчанию = 2000). | ||
| burst строка |
| Включение/выключение кратковременного повышения скорости клиента. | |
| call-admission-control строка |
| Включение/выключение управления допуском вызова WMM. | |
| call-capacity целое число | Максимальное количество телефонов VoIP (VoWLAN), разрешённых (0–60, по умолчанию = 10). | ||
| comment строка | Комментарий. | ||
| downlink целое число | Максимальная пропускная способность нисходящего канала для виртуальных точек доступа (VAP) (0–2097152 Кбит/с, по умолчанию = 0, 0 означает отсутствие ограничения). | ||
| downlink-sta целое число | Максимальная пропускная способность нисходящего канала для клиентов (0–2097152 Кбит/с, по умолчанию = 0, 0 означает отсутствие ограничения). | ||
| dscp-wmm-be целое число | без описания | ||
| dscp-wmm-bk целое число | без описания | ||
| dscp-wmm-mapping строка |
| Включение/выключение сопоставления кода точки обслуживания дифференцированных сервисов (DSCP). | |
| dscp-wmm-vi целое число | без описания | ||
| dscp-wmm-vo целое число | без описания | ||
| name строка | Имя профиля QoS Wi-Fi. | ||
| uplink целое число | Максимальная пропускная способность восходящего канала для виртуальных точек доступа (VAP) (0–2097152 Кбит/с, по умолчанию = 0, 0 означает отсутствие ограничения). | ||
| uplink-sta целое число | Максимальная пропускная способность восходящего канала для клиентов (0–2097152 Кбит/с, по умолчанию = 0, 0 означает отсутствие ограничения). | ||
| wmm строка |
| Включение/выключение управления Wi-Fi мультимедиа (WMM). | |
| wmm-uapsd строка |
| Включение/выключение режима энергосбережения WMM Unscheduled Automatic Power Save Delivery (U-APSD). | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||
| state строка / обязательный |
| директива для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | adom, который нужно заблокировать для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочую область | |
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочей области в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure WiFi quality of service (QoS) profiles.
fmgr_qosprofile:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
qosprofile:
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
burst: <value in [disable, enable]>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
comment: <value of string>
downlink: <value of integer>
downlink-sta: <value of integer>
dscp-wmm-be: <value of integer>
dscp-wmm-bk: <value of integer>
dscp-wmm-mapping: <value in [disable, enable]>
dscp-wmm-vi: <value of integer>
dscp-wmm-vo: <value of integer>
name: <value of string>
uplink: <value of integer>
uplink-sta: <value of integer>
wmm: <value in [disable, enable]>
wmm-uapsd: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL-адрес Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_qosprofile_module.html
