Модуль fortinet.fortimanager.fmgr_qosprofile — настройка качества обслуживания WiFi

Примечание

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

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

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

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

Добавлено в 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`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
qosprofile dictionary	Набор параметров верхнего уровня.
bandwidth_admission_control псевдонимы: bandwidth-admission-control string	Включить/отключить управление допуском по полосе пропускания WMM. Варианты: `"disable"` `"enable"`
bandwidth_capacity псевдонимы: bandwidth-capacity integer	Максимально допустимая пропускная способность
burst string	Включить/отключить пакетную передачу данных с заданной скоростью для клиента. Варианты: `"disable"` `"enable"`
call_admission_control псевдонимы: call-admission-control string	Включить/отключить управление допуском вызовов WMM. Варианты: `"disable"` `"enable"`
call_capacity псевдонимы: call-capacity integer	Максимальное количество голосовых подключений по WLAN
comment string	Комментарий.
downlink integer	Максимальная пропускная способность нисходящего канала для виртуальных точек доступа
downlink_sta псевдонимы: downlink-sta integer	Максимальная пропускная способность нисходящего канала для клиентов
dscp_wmm_be псевдонимы: dscp-wmm-be any	(список) Сопоставление DSCP для доступа с наилучшим усилием
dscp_wmm_bk псевдонимы: dscp-wmm-bk any	(список) Сопоставление DSCP для фонового доступа
dscp_wmm_mapping псевдонимы: dscp-wmm-mapping string	Включить/отключить кодовую точку дифференцированного обслуживания Варианты: `"disable"` `"enable"`
dscp_wmm_vi псевдонимы: dscp-wmm-vi any	(список) Сопоставление DSCP для доступа к видео
dscp_wmm_vo псевдонимы: dscp-wmm-vo any	(список) Сопоставление DSCP для голосового доступа
name string / обязательный	Имя профиля QoS WiFi.
uplink integer	Максимальная пропускная способность восходящего канала для виртуальных точек доступа
uplink_sta псевдонимы: uplink-sta integer	Максимальная пропускная способность восходящего канала для клиентов
wmm string	Включить/отключить мультимедиа WiFi Варианты: `"disable"` `"enable"`
wmm_be_dscp псевдонимы: wmm-be-dscp integer	Маркировка DSCP для доступа с наилучшим усилием
wmm_bk_dscp псевдонимы: wmm-bk-dscp integer	Маркировка DSCP для фонового доступа
wmm_dscp_marking псевдонимы: wmm-dscp-marking string	Включить/отключить кодовую точку дифференцированного обслуживания WMM Варианты: `"disable"` `"enable"`
wmm_uapsd псевдонимы: wmm-uapsd string	Включить/отключить незапланированную автоматическую доставку данных для энергосбережения WMM Варианты: `"disable"` `"enable"`
wmm_vi_dscp псевдонимы: wmm-vi-dscp integer	Маркировка DSCP для доступа к видео
wmm_vo_dscp псевдонимы: wmm-vo-dscp integer	Маркировка DSCP для голосового доступа
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Инструкция для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие варианты, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure WiFi quality of service
      fortinet.fortimanager.fmgr_qosprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        qosprofile:
          name: "your value" # Required variable, string
          # bandwidth_admission_control: <value in [disable, enable]>
          # bandwidth_capacity: <integer>
          # burst: <value in [disable, enable]>
          # call_admission_control: <value in [disable, enable]>
          # call_capacity: <integer>
          # comment: <string>
          # downlink: <integer>
          # downlink_sta: <integer>
          # dscp_wmm_be: <list or integer>
          # dscp_wmm_bk: <list or integer>
          # dscp_wmm_mapping: <value in [disable, enable]>
          # dscp_wmm_vi: <list or integer>
          # dscp_wmm_vo: <list or integer>
          # uplink: <integer>
          # uplink_sta: <integer>
          # wmm: <value in [disable, enable]>
          # wmm_uapsd: <value in [disable, enable]>
          # wmm_be_dscp: <integer>
          # wmm_bk_dscp: <integer>
          # wmm_dscp_marking: <value in [disable, enable]>
          # wmm_vi_dscp: <integer>
          # wmm_vo_dscp: <integer>

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

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

Ключ	Описание
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_qosprofile_module.html