Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_wireless_controller_arrp_profile — настройка профилей автоматического распределения радиоресурсов Wi-Fi (ARRP) в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_wireless_controller_arrp_profile.

Добавлено в fortinet.fortios 2.0.0

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию wireless_controller и категорию arrp_profile. В примерах приведены все параметры и значения, которые перед использованием необходимо скорректировать с учетом источников данных. Проверено на FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

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

Варианты:

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

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются косой чертой.

Параметр с пометкой member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

wireless_controller_arrp_profile

dictionary

Настройка профилей автоматического распределения радиоресурсов Wi-Fi (ARRP).

comment

string

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

darrp_optimize

integer

Период запуска оптимизации распределенного автоматического распределения радиоресурсов (DARRP) (0–86400 с).

darrp_optimize_schedules

list / elements=dictionary

Расписания брандмауэра для времени запуска DARRP. DARRP будет запускаться периодически согласно параметру darrp-optimize в рамках указанных расписаний. Несколько имен расписаний разделяются пробелом.

name

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

Имя расписания. Источник: firewall.schedule.group.name, firewall.schedule.recurring.name, firewall.schedule.onetime.name.

include_dfs_channel

string

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

Варианты:

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

include_weather_channel

string

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

Варианты:

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

monitor_period

integer

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

name

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

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

override_darrp_optimize

string

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

Варианты:

  • "enable"
  • "disable"

selection_period

integer

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

threshold_ap

integer

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

threshold_channel_load

integer

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

threshold_noise_floor

string

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

threshold_rx_errors

integer

Порог ошибок приема в процентах, при превышении которого на этапе мониторинга DARRP запускается повторный выбор канала (0–100).

threshold_spectral_rssi

string

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

threshold_tx_retries

integer

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

weight_channel_load

integer

Вес загрузки канала при расчете оценки канала DARRP (0–2000).

weight_dfs_channel

integer

Вес канала DFS при расчете оценки канала DARRP (0–2000).

weight_managed_ap

integer

Вес управляемых точек доступа при расчете оценки канала DARRP (0–2000).

weight_noise_floor

integer

Вес уровня шума при расчете оценки канала DARRP (0–2000).

weight_rogue_ap

integer

Вес несанкционированных точек доступа при расчете оценки канала DARRP (0–2000).

weight_spectral_rssi

integer

Вес спектрального RSSI при расчете оценки канала DARRP (0–2000).

weight_weather_channel

integer

Вес погодного канала при расчете оценки канала DARRP (0–2000).

Примечания

Примечание

  • Поддержка устаревшего fortiosapi прекращена; для запуска плейбуков рекомендуется использовать httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles.
  fortinet.fortios.fortios_wireless_controller_arrp_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_arrp_profile:
          comment: "Comment."
          darrp_optimize: "86400"
          darrp_optimize_schedules:
              -
                  name: "default_name_6 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
          include_dfs_channel: "enable"
          include_weather_channel: "enable"
          monitor_period: "300"
          name: "default_name_10"
          override_darrp_optimize: "enable"
          selection_period: "3600"
          threshold_ap: "250"
          threshold_channel_load: "60"
          threshold_noise_floor: "<your_own_value>"
          threshold_rx_errors: "50"
          threshold_spectral_rssi: "<your_own_value>"
          threshold_tx_retries: "300"
          weight_channel_load: "20"
          weight_dfs_channel: "500"
          weight_managed_ap: "50"
          weight_noise_floor: "40"
          weight_rogue_ap: "10"
          weight_spectral_rssi: "40"
          weight_weather_channel: "1000"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate при выполнении последней операции

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

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

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

Пример: "success"

vdom

string

Использованный виртуальный домен

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

Пример: "root"

version

string

Версия FortiGate

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

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_wireless_controller_arrp_profile_module.html

Spec-Zone.ru

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