Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_arrpprofile — настройка автоматического распределения радиоресурсов WiFi

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.1.0

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

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

arrpprofile

dictionary

Параметры верхнего уровня.

comment

string

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

darrp_optimize

псевдонимы: darrp-optimize

integer

Время выполнения динамического автоматического распределения радиоресурсов

darrp_optimize_schedules

псевдонимы: darrp-optimize-schedules

any

(список) Расписания брандмауэра для запуска DARRP.

include_dfs_channel

псевдонимы: include-dfs-channel

string

Включить или отключить использование канала DFS на этапе 1 выбора канала DARRP

Варианты:

  • "no"
  • "disable"
  • "yes"
  • "enable"

include_weather_channel

псевдонимы: include-weather-channel

string

Включить или отключить использование погодного канала на этапе 1 выбора канала DARRP

Варианты:

  • "no"
  • "disable"
  • "yes"
  • "enable"

monitor_period

псевдонимы: monitor-period

integer

Период в секундах для измерения среднего числа повторных передач и ошибок приёма

name

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

Имя профиля WiFi ARRP.

override_darrp_optimize

псевдонимы: override-darrp-optimize

string

Включить переопределение параметров darrp-optimize и darrp-optimize-schedules

Варианты:

  • "disable"
  • "enable"

selection_period

псевдонимы: selection-period

integer

Период в секундах для измерения средней загрузки канала, уровня шума и спектрального RSSI

threshold_ap

псевдонимы: threshold-ap

integer

Порог отклонения канала на этапе 1 выбора канала DARRP из-за окружающих точек доступа

threshold_channel_load

псевдонимы: threshold-channel-load

integer

Порог в процентах для отклонения канала на этапе 1 выбора канала DARRP из-за загрузки канала

threshold_noise_floor

псевдонимы: threshold-noise-floor

string

Порог в дБм для отклонения канала на этапе 1 выбора канала DARRP из-за уровня шума

threshold_rx_errors

псевдонимы: threshold-rx-errors

integer

Порог ошибок приёма в процентах, при превышении которого на этапе мониторинга DARRP запускается повторный выбор канала

threshold_spectral_rssi

псевдонимы: threshold-spectral-rssi

string

Порог в дБм для отклонения канала на этапе 1 выбора канала DARRP из-за спектрального RSSI

threshold_tx_retries

псевдонимы: threshold-tx-retries

integer

Порог повторных передач в процентах, при превышении которого на этапе мониторинга DARRP запускается повторный выбор канала

weight_channel_load

псевдонимы: weight-channel-load

integer

Вес загрузки канала при расчёте оценки канала DARRP

weight_dfs_channel

псевдонимы: weight-dfs-channel

integer

Вес канала DFS при расчёте оценки канала DARRP

weight_managed_ap

псевдонимы: weight-managed-ap

integer

Вес управляемых точек доступа при расчёте оценки канала DARRP

weight_noise_floor

псевдонимы: weight-noise-floor

integer

Вес уровня шума при расчёте оценки канала DARRP

weight_rogue_ap

псевдонимы: weight-rogue-ap

integer

Вес несанкционированных точек доступа при расчёте оценки канала DARRP

weight_spectral_rssi

псевдонимы: weight-spectral-rssi

integer

Вес спектрального RSSI при расчёте оценки канала DARRP

weight_weather_channel

псевдонимы: weight-weather-channel

integer

Вес погодного канала при расчёте оценки канала DARRP

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"

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 Automatic Radio Resource Provisioning
      fortinet.fortimanager.fmgr_arrpprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        arrpprofile:
          name: "your value" # Required variable, string
          # comment: <string>
          # darrp_optimize: <integer>
          # darrp_optimize_schedules: <list or string>
          # include_dfs_channel: <value in [no, disable, yes, ...]>
          # include_weather_channel: <value in [no, disable, yes, ...]>
          # monitor_period: <integer>
          # override_darrp_optimize: <value in [disable, enable]>
          # selection_period: <integer>
          # threshold_ap: <integer>
          # threshold_channel_load: <integer>
          # threshold_noise_floor: <string>
          # threshold_rx_errors: <integer>
          # threshold_spectral_rssi: <string>
          # threshold_tx_retries: <integer>
          # weight_channel_load: <integer>
          # weight_dfs_channel: <integer>
          # weight_managed_ap: <integer>
          # weight_noise_floor: <integer>
          # weight_rogue_ap: <integer>
          # weight_spectral_rssi: <integer>
          # weight_weather_channel: <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_arrpprofile_module.html

Spec-Zone.ru

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