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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
arrpprofile словарь	Набор параметров верхнего уровня.
comment строка	Комментарий.
darrp-optimize целое число	Устаревшее, пожалуйста, переименуйте на darrp_optimize. Время выполнения динамического автоматического распределения радиоресурсов
darrp-optimize-schedules любой	(список) Устаревшее, пожалуйста, переименуйте на darrp_optimize_schedules. Расписание брандмауэра для времени выполнения DARRP.
include-dfs-channel строка	Устаревшее, пожалуйста, переименуйте на include_dfs_channel. Включение/выключение использования канала DFS на стадии выбора канала DARRP 1 Варианты: `"no"` `"disable"` `"yes"` `"enable"`
include-weather-channel строка	Устаревшее, пожалуйста, переименуйте на include_weather_channel. Включение/выключение использования канала погоды в процессе выбора канала DARRP... Варианты: `"no"` `"disable"` `"yes"` `"enable"`
monitor-period целое число	Устаревшее, пожалуйста, переименуйте на monitor_period. Период в секундах для измерения среднего числа повторных передач и ошибок при приеме
name строка / обязательно	Имя профиля WiFi ARRP.
override-darrp-optimize строка	Устаревшее, пожалуйста, переименуйте на override_darrp_optimize. Включение для переопределения настроек darrp-optimize и darrp-optimize-sche... Варианты: `"disable"` `"enable"`
selection-period целое число	Устаревшее, пожалуйста, переименуйте на selection_period. Период в секундах для измерения средней загрузки канала, уровня шума, спектра...
threshold-ap целое число	Устаревшее, пожалуйста, переименуйте на threshold_ap. Порог для отклонения канала на стадии выбора канала DARRP 1 из-за окружа...
threshold-channel-load целое число	Устаревшее, пожалуйста, переименуйте на threshold_channel_load. Порог в процентах для отклонения канала на стадии выбора канала DARRP...
threshold-noise-floor строка	Устаревшее, пожалуйста, переименуйте на threshold_noise_floor. Порог в дБм для отклонения канала на стадии выбора канала DARRP...
threshold-rx-errors целое число	Устаревшее, пожалуйста, переименуйте на threshold_rx_errors. Порог в процентах для ошибок при приеме для перевыбора канала...
threshold-spectral-rssi строка	Устаревшее, пожалуйста, переименуйте на threshold_spectral_rssi. Порог в дБм для отклонения канала на стадии выбора канала DARRP...
threshold-tx-retries целое число	Устаревшее, пожалуйста, переименуйте на threshold_tx_retries. Порог в процентах для повторных передач для перевыбора канала...
weight-channel-load целое число	Устаревшее, пожалуйста, переименуйте на weight_channel_load. Вес в расчете оценки канала DARRP для загрузки канала
weight-dfs-channel целое число	Устаревшее, пожалуйста, переименуйте на weight_dfs_channel. Вес в расчете оценки канала DARRP для канала DFS
weight-managed-ap целое число	Устаревшее, пожалуйста, переименуйте на weight_managed_ap. Вес в расчете оценки канала DARRP для управляемых точек доступа
weight-noise-floor целое число	Устаревшее, пожалуйста, переименуйте на weight_noise_floor. Вес в расчете оценки канала DARRP для уровня шума

END_OF_DOCUMENT_MARKER

weight-rogue-ap integer	Устаревшее, пожалуйста, переименуйте на weight_rogue_ap. Вес в расчете оценки канала DARRP для вредоносных точек доступа
weight-spectral-rssi integer	Устаревшее, пожалуйста, переименуйте на weight_spectral_rssi. Вес в расчете оценки канала DARRP для спектрального RSSI
weight-weather-channel integer	Устаревшее, пожалуйста, переименуйте на weight_weather_channel. Вес в расчете оценки канала 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 / elements=integer	Список кодов rc, с которыми будут переопределены условия отказа.
rc_succeeded list / elements=integer	Список кодов rc, с которыми будут переопределены условия успеха.
state string / обязательный	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager в режиме работы в рабочей области, значение может быть глобальным и другими, включая корневой.
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 Automatic Radio Resource Provisioning
      fortinet.fortimanager.fmgr_arrpprofile:
        # 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]>
        arrpprofile:
          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>
          name: <string>
          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 словарь	Результат запроса. Возвращается: всегда
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_arrpprofile_module.html