cisco.meraki.meraki_mr_radio модуль – Управление настройками радио для устройств Meraki беспроводных сетей

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.2).

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

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

Чтобы использовать его в книге задач, укажите: cisco.meraki.meraki_mr_radio.

УСТАРЕВШИЙ
Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕВШИЙ

Удалено в:: версии 3.0.0
Почему:: Обновлённые модули выпущены с расширенными возможностями
Альтернатива:: cisco.meraki.devices_wireless_radio_settings

Обзор

Позволяет настроить параметры радио в беспроводных сетях Meraki MR.

Параметры

Параметр	Комментарии
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
five_ghz_settings словарь	Ручные настройки радио для 5 ГГц. Значение по умолчанию: `{}`
channel целое число	Устанавливает ручной канал для 5 ГГц. Возможные значения: `36` `40` `44` `48` `52` `56` `60` `64` `100` `104` `108` `112` `116` `120` `124` `128` `132` `136` `140` `144` `149` `153` `157` `161` `165`
channel_width строка	Устанавливает ручной канал для 5 ГГц. Может быть '0', '20', '40', '80' или null для использования автоматической ширины канала. Возможные значения: `"auto"` `"20"` `"40"` `"80"`
target_power целое число	Устанавливает ручную целевую мощность для 5 ГГц. Может быть от '8' до '30' или null для использования автоматического диапазона мощности.
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. Значение по умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части. Значение по умолчанию: `60`
net_id строка	Идентификатор сети.
net_name псевдонимы: network строка	Имя сети.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, нужно ли использовать ключи ответа в формате snake_case (например, `net_id`) или camelCase (например, `netId`). Возможные значения: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установите объем отладочного вывода во время выполнения модуля. Возможные значения: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд для повторной попытки, если срабатывает ограничитель скорости. Значение по умолчанию: `165`
rf_profile_id строка	Идентификатор профиля RF для назначения устройству. Если значение этого параметра равно null, соответствующий базовый профиль RF (в помещении или на улице) будет назначен устройству. Назначение профиля RF очистит ВСЕ вручную настроенные переопределения на устройстве (ширина канала, канал, мощность).
rf_profile_name строка	Имя профиля RF для назначения устройству. Аналогично ``rf_profile_id``, но требует ``net_id`` (предпочтительно) или ``net_name``.
serial строка	Серийный номер устройства для запроса.
state строка	Запрос или изменение настроек радио на устройстве. Возможные значения: `"present"` ← (по умолчанию) `"query"`
timeout целое число	Время ожидания для HTTP-запросов. Значение по умолчанию: `30`

two_four_ghz_settings dictionary	Ручные настройки радио для 2,4 ГГц. По умолчанию: `{}`
channel integer	Устанавливает ручной канал для 2,4 ГГц. Может быть ‘1’, ‘2’, ‘3’, ‘4’, ‘5’, ‘6’, ‘7’, ‘8’, ‘9’, ‘10’, ‘11’, ‘12’, ‘13’ или ‘14’, или null для использования автоматического канала. Допустимые значения: `1` `2` `3` `4` `5` `6` `7` `8` `9` `10` `11` `12` `13` `14`
target_power integer	Установка ручного целевого уровня мощности для 2,4 ГГц. Может быть от ‘5’ до ‘30’ или null для использования автоматического диапазона мощности.
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае — HTTPS. Полезно только для внутренних разработчиков Meraki. Допустимые значения: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси не будет использоваться, даже если она определена в переменной среды на целевых хостах. Допустимые значения: `false` ← (по умолчанию) `true`
validate_certs boolean	Подтверждать ли сертификаты HTTP. Допустимые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Более подробную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Для использования camel case, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki в Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Пожалуйста, обновите свои playbook'ы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если конфигурации отличаются, но не отправляет изменения в API для проверки изменений.

Примеры

- name: Query a device's radio configuration
  meraki_mr_radio:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: YourSerialNumber
    state: query
  delegate_to: localhost
- name: Configure a device's radios
  meraki_mr_radio:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: YourSerialNumber
    state: present
    five_ghz_settings:
      channel: 56
      channel_width: 20
      target_power: 10
    two_four_ghz_settings:
      channel: 6
      target_power: 12
    rf_profile_name: Test Profile
  delegate_to: localhost

Значения возврата

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

Ключ	Описание
data сложное	Настроенные параметры РФ на конкретном устройстве. Возвращаемое значение: success
five_ghz_settings словарь	Настроенные параметры радиочастотного модуля для 5 ГГц. Возвращаемое значение: success
channel строка	Настроенный вручную канал для 5 ГГц. Значение null указывает на автоматический выбор канала. Возвращаемое значение: success Пример: `"56"`
channel_width строка	Настроенный вручную канал для 5 ГГц. Значение null указывает на автоматическую ширину канала. Возвращаемое значение: success Пример: `"40"`
target_power целое число	Настроенная вручную целевая мощность для 5 ГГц. Значение null указывает на автоматическую мощность. Возвращаемое значение: success Пример: `25`
rf_profile_id строка	Идентификатор профиля RF, назначенного устройству. Значение null указывает, что устройству назначен соответствующий базовый профиль RF (в помещении или на открытом воздухе). Возвращаемое значение: success
serial строка	Серийный номер устройства, которое было настроено. Возвращаемое значение: success Пример: `"xyz"`
two_four_ghz_settings словарь	Настроенные параметры радиочастотного модуля для 2,4 ГГц. Возвращаемое значение: success
channel строка	Настроенный вручную канал для 2,4 ГГц. Значение null указывает на автоматический выбор канала. Возвращаемое значение: success Пример: `"11"`
target_power целое число	Настроенная вручную целевая мощность для 2,4 ГГц. Значение null указывает на автоматическую мощность. Возвращаемое значение: success Пример: `15`

Статус

Этот модуль будет удален в версии 3.0.0. [устаревший]
Дополнительную информацию см. в разделе УСТАРЕВШИЙ.

Авторы

Tyler Christiansen (@supertylerc)

Ссылки на сборку

© 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/cisco/meraki/meraki_mr_radio_module.html