Spec-Zone.ru › Ansible 2.10

cisco.meraki.meraki_mr_rf_profile – Управление профилями RF для беспроводных сетей Meraki

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.1.3).

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

Для использования в плейбуке укажите: cisco.meraki.meraki_mr_rf_profile.

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

Обзор

  • Позволяет настроить профили радиочастот (RF) в беспроводных сетях Meraki MR.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ap_band_settings
словарь
Настройки, которые будут включены, если selectionType установлен в 'ap'.
band_steering_enabled
логический тип
    Варианты:
  • no
  • yes
Направляет клиента на полосу с наибольшим открытым каналом.
mode
строка
    Варианты:
  • 2.4ghz
  • 5ghz
  • dual
Устанавливает полосу RF, которую поддержит точка доступа.

псевдонимы: band_operation_mode
auth_key
строка / обязательно
Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не установлена.
band_selection_type
строка
    Варианты:
  • ssid
  • ap
Устанавливает, назначается ли выбор полосы доступа по точке доступа или по SSID.
Этот параметр необходим при создании.
client_balancing_enabled
логический тип
    Варианты:
  • no
  • yes
Направляет клиента на лучшую доступную точку доступа.
five_ghz_settings
словарь
Настройки, связанные с полосой 5 ГГц.
channel_width
строка
    Варианты:
  • auto
  • 20
  • 40
  • 80
Устанавливает ширину канала (МГц) для полосы 5 ГГц.
max_power
целое число
Устанавливает максимальную мощность (дБм) полосы 5 ГГц.
Может быть целым числом от 8 до 30.
min_bitrate
целое число
    Варианты:
  • 6
  • 9
  • 12
  • 18
  • 24
  • 36
  • 48
  • 54
Устанавливает минимальную скорость передачи данных (Мбит/с) для полосы 5 ГГц.
min_power
целое число
Устанавливает минимальную мощность (дБм) полосы 5 ГГц.
Может быть целым числом от 8 до 30.
rxsop
целое число
Уровень RX-SOP управляет чувствительностью радио.
Сильно рекомендуется использовать RX-SOP только после консультации с экспертом по беспроводным сетям.
RX-SOP можно настроить в диапазоне от -65 до -95 (дБм).
valid_auto_channels
список / элементы=целое число
    Варианты:
  • 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
Устанавливает допустимые автоматические каналы для полосы 5 ГГц.
host
строка
По умолчанию:
"api.meraki.com"
Имя хоста для панели управления Meraki.
Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time
целое число
По умолчанию:
60
Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
min_bitrate_type
строка
    Варианты:
  • band
  • ssid
Тип минимальной скорости передачи данных.
name
строка
Уникальное имя нового профиля.
Этот параметр необходим при создании.
net_id
строка
Идентификатор сети.
net_name
строка
Имя сети.
org_id
строка
Идентификатор организации.
org_name
строка
Имя организации.

псевдонимы: organization
output_format
строка
    Варианты:
  • snakecase ←
  • camelcase
Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId).
output_level
строка
    Варианты:
  • debug
  • normal ←
Устанавливает количество вывода отладки во время выполнения модуля.
profile_id
строка
Уникальный идентификатор существующего профиля RF.

псевдонимы: id
rate_limit_retry_time
целое число
По умолчанию:
165
Количество секунд для повторной попытки, если срабатывает ограничение скорости.
state
строка
    Варианты:
  • present ←
  • query
  • absent
Запрос, редактирование или удаление настроек беспроводного профиля RF.
timeout
целое число
По умолчанию:
30
Время ожидания для HTTP-запросов.
two_four_ghz_settings
словарь
Настройки, связанные с полосой 2.4 ГГц.
ax_enabled
логический тип
    Варианты:
  • no
  • yes
Определяет, включена ли беспроводная технология ax на полосе 2.4 ГГц.
max_power
целое число
Устанавливает максимальную мощность (дБм) полосы 2.4 ГГц.
Может быть целым числом от 5 до 30.
min_bitrate
вещественное число
    Варианты:
  • 1
  • 2
  • 5.5
  • 6
  • 9
  • 11
  • 12
  • 18
  • 24
  • 36
  • 48
  • 54
Устанавливает минимальную скорость передачи данных (Мбит/с) для полосы 2.4 ГГц.
min_power
целое число
Устанавливает минимальную мощность (дБм) полосы 2.4 ГГц.
Может быть целым числом от 5 до 30.
rxsop
целое число
Уровень RX-SOP управляет чувствительностью радио.
Сильно рекомендуется использовать RX-SOP только после консультации с экспертом по беспроводным сетям.
RX-SOP можно настроить в диапазоне от -65 до -95 (дБм).
valid_auto_channels
список / элементы=целое число
    Варианты:
  • 1
  • 6
  • 11
Устанавливает допустимые автоматические каналы для полосы 2.4 ГГц.
use_https
логический тип
    Варианты:
  • no
  • yes ←
Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.
Полезно только для внутренних разработчиков Meraki.
use_proxy
логический тип
    Варианты:
  • no ←
  • yes
Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
validate_certs
логический тип
    Варианты:
  • no
  • yes ←
Подтверждать ли сертификаты HTTP.

Примечания

Примечание

  • Дополнительную информацию об 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. Пожалуйста, обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о изменениях, если есть различия в конфигурациях, но не отправляет изменения в API для проверки изменений.

Примеры

- name: Create RF profile in check mode
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    name: Test Profile
    band_selection_type: ap
    client_balancing_enabled: True
    ap_band_settings:
        mode: dual
        band_steering_enabled: true
    five_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      channel_width: 20
      valid_auto_channels:
        - 36
        - 40
        - 44
    two_four_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      ax_enabled: false
      valid_auto_channels:
        - 1
  delegate_to: localhost

- name: Query all RF profiles
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query one RF profile by ID
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    profile_id: '{{ profile_id }}'
  delegate_to: localhost

- name: Update profile
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    profile_id: 12345
    band_selection_type: ap
    client_balancing_enabled: True
    ap_band_settings:
        mode: dual
        band_steering_enabled: true
    five_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      channel_width: 20
      valid_auto_channels:
        - 36
        - 44
    two_four_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -75
      ax_enabled: false
      valid_auto_channels:
        - 1
  delegate_to: localhost

- name: Delete RF profile
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: absent
    profile_id: 12345
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
data
complex
success
Список настроек профилей беспроводного радиочастотного диапазона.
ap_band_settings
complex
success
Настройки, которые будут включены, если selectionType задан как 'ap'.
band_steering_enabled
boolean
success
Направляет клиента на наиболее открытый диапазон.

Пример:
True
mode
string
success
Устанавливает радиочастотный диапазон, который будет поддерживаться точкой доступа.

Пример:
dual
band_selection_type
string
success
Устанавливает, назначается ли выбор диапазона по точке доступа или по SSID.
Этот параметр обязателен при создании.

Пример:
ap
client_balancing_enabled
boolean
success
Направляет клиента к лучшей доступной точке доступа.

Пример:
True
five_ghz_settings
complex
success
Настройки, относящиеся к диапазону 5 ГГц.
channel_width
string
success
Устанавливает ширину канала (МГц) для диапазона 5 ГГц.

Пример:
auto
max_power
integer
success
Устанавливает максимальную мощность (дБм) для диапазона 5 ГГц.
Может быть целым числом от 8 до 30.

Пример:
12
min_bitrate
integer
success
Устанавливает минимальную скорость передачи данных (Мбит/с) для диапазона 5 ГГц.

Пример:
6
min_power
integer
success
Устанавливает минимальную мощность (дБм) для диапазона 5 ГГц.
Может быть целым числом от 8 до 30.

Пример:
12
rxsop
integer
success
Уровень RX-SOP регулирует чувствительность радио.

Пример:
-70
valid_auto_channels
list / elements=string
success
Устанавливает допустимые автоматические каналы для диапазона 5 ГГц.
id
string
success
Уникальный идентификатор существующего профиля RF.

Пример:
12345
min_bitrate_type
string
success
Тип минимальной скорости передачи данных.

Пример:
ssid
name
string
success
Уникальное имя нового профиля.
Этот параметр обязателен при создании.

Пример:
Гостевой профиль RF
two_four_ghz_settings
complex
success
Настройки, относящиеся к диапазону 2,4 ГГц.
ax_enabled
boolean
success
Определяет, включено или выключено радио ax в диапазоне 2,4 ГГц.

Пример:
True
max_power
integer
success
Устанавливает максимальную мощность (дБм) для диапазона 2,4 ГГц.

Пример:
12
min_bitrate
float
success
Устанавливает минимальную скорость передачи данных (Мбит/с) для диапазона 2,4 ГГц.

Пример:
5.5
min_power
integer
success
Устанавливает минимальную мощность (дБм) для диапазона 2,4 ГГц.

Пример:
12
rxsop
integer
success
Уровень RX-SOP регулирует чувствительность радио.

Пример:
-70
valid_auto_channels
list / elements=string
success
Устанавливает допустимые автоматические каналы для диапазона 2,4 ГГц.

Пример:
6


Авторы

  • Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/meraki/meraki_mr_rf_profile_module.html

Spec-Zone.ru

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