Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_qosprofile модуль – Настройка качества Wi-Fi-сервиса

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Новая функция в fortinet.fortimanager 2.0.0

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль может настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

строка / обязательно

Параметр (adom) в запрошенном URL.

bypass_validation

булево

Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

булево

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.

proposed_method

строка

Переопределенный метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

qosprofile

словарь

Настройка параметров верхнего уровня.

bandwidth_admission_control

строка

Включить/выключить контроль приема пропускной способности WMM.

Варианты:

  • "disable"
  • "enable"

bandwidth_capacity

целое число

Максимальная разрешенная пропускная способность.

burst

строка

Включить/выключить пакетный режим клиента.

Варианты:

  • "disable"
  • "enable"

call_admission_control

строка

Включить/выключить контроль приема вызовов WMM.

Варианты:

  • "disable"
  • "enable"

call_capacity

целое число

Максимальное количество голосовой связи по Wi-Fi.

comment

строка

Комментарий.

downlink

целое число

Максимальная пропускная способность для нисходящего канала для виртуальных точек доступа.

downlink_sta

целое число

Максимальная пропускная способность для нисходящего канала для клиентов.

dscp_wmm_be

любое

Карта DSCP для доступа в режиме наилучшей эффективности.

dscp_wmm_bk

любое

Карта DSCP для фонового доступа.

dscp_wmm_mapping

строка

Включить/выключить механизм дифференцированных служб кодов точек.

Варианты:

  • "disable"
  • "enable"

dscp_wmm_vi

любое

Карта DSCP для доступа видео.

dscp_wmm_vo

любое

Карта DSCP для доступа голоса.

name

строка / обязательно

Имя профиля QoS Wi-Fi.

uplink

целое число

Максимальная пропускная способность для восходящего канала для виртуальных точек доступа.
END_OF_DOCUMENT_MARKER

uplink-sta

integer

Устаревшее, пожалуйста, переименуйте его на uplink_sta. Максимальная пропускная способность восходящего канала для клиентов

wmm

string

Включить/выключить WiFi мультимедиа

Варианты:

  • "disable"
  • "enable"

wmm-be-dscp

integer

Устаревшее, пожалуйста, переименуйте его на wmm_be_dscp. Маркировка DSCP для доступа с наилучшими усилиями

wmm-bk-dscp

integer

Устаревшее, пожалуйста, переименуйте его на wmm_bk_dscp. Маркировка DSCP для фонового доступа

wmm-dscp-marking

string

Устаревшее, пожалуйста, переименуйте его на wmm_dscp_marking. Включить/выключить WMM Код разграничения услуг

Варианты:

  • "disable"
  • "enable"

wmm-uapsd

string

Устаревшее, пожалуйста, переименуйте его на wmm_uapsd. Включить/выключить WMM Незапланированная автоматическая доставка экономии энергии

Варианты:

  • "disable"
  • "enable"

wmm-vi-dscp

integer

Устаревшее, пожалуйста, переименуйте его на wmm_vi_dscp. Маркировка DSCP для доступа видео

wmm-vo-dscp

integer

Устаревшее, пожалуйста, переименуйте его на wmm_vo_dscp. Маркировка DSCP для доступа голоса

rc_failed

list / elements=integer

Список rc кодов, с которыми будут переопределены условия для завершения неудачей.

rc_succeeded

list / elements=integer

Список rc кодов, с которыми будут переопределены условия для успешного завершения.

state

string / обязательно

Направление для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 помогают в этом.
  • Для создания или обновления объекта используйте параметр state present.
  • Для удаления объекта используйте параметр state absent.
  • Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой rc. Вы также можете переопределить условия завершения неудачей или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure WiFi quality of service
      fortinet.fortimanager.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: present # <value in [present, absent]>
        qosprofile:
          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>
          name: <string>
          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

словарь

Результат запроса.

Возвращается: всегда

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_qosprofile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API