Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: cisco.meraki.meraki_mr_rf_profile.

  • УСТАРЕЛО
  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛО

Удалён в:

версии 3.0.0

Причина:

Выпущены обновлённые модули с расширенными возможностями

Альтернатива:

cisco.meraki.networks_wireless_rf_profiles

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

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

Параметры

Параметр

Комментарии

ap_band_settings

dictionary

Параметры, которые будут включены, если для selectionType задано значение ‘ap’.

band_steering_enabled

boolean

Переключает клиента на наименее загруженный диапазон.

Варианты:

  • false
  • true

mode

псевдонимы: band_operation_mode

string

Задаёт радиочастотный диапазон, который будет поддерживать точка доступа.

Варианты:

  • "2.4ghz"
  • "5ghz"
  • "dual"

auth_key

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

Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная среды MERAKI_KEY.

band_selection_type

string

Задаёт, назначается ли выбор диапазона для каждой точки доступа или для каждого SSID.

Этот параметр обязателен при создании.

Варианты:

  • "ssid"
  • "ap"

client_balancing_enabled

boolean

Переключает клиента на оптимальную доступную точку доступа.

Варианты:

  • false
  • true

five_ghz_settings

dictionary

Параметры диапазона 5 ГГц.

channel_width

string

Задаёт ширину канала (МГц) для диапазона 5 ГГц.

Варианты:

  • "auto"
  • "20"
  • "40"
  • "80"

max_power

integer

Задаёт максимальную мощность (дБм) для диапазона 5 ГГц.

Целое число от 8 до 30.

min_bitrate

integer

Задаёт минимальную скорость передачи данных (Мбит/с) для диапазона 5 ГГц.

Варианты:

  • 6
  • 9
  • 12
  • 18
  • 24
  • 36
  • 48
  • 54

min_power

integer

Задаёт минимальную мощность (дБм) для диапазона 5 ГГц.

Целое число от 8 до 30.

rxsop

integer

Уровень RX-SOP определяет чувствительность радиомодуля.

Настоятельно рекомендуется настраивать RX-SOP только после консультации со специалистом по беспроводным сетям.

Для RX-SOP можно задать значение в диапазоне от -65 до -95 (дБм).

valid_auto_channels

list / элементы=integer

Задаёт допустимые автоматические каналы для диапазона 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

host

string

Имя хоста панели управления Meraki.

Можно использовать для доступа к региональным средам Meraki, например в Китае.

По умолчанию: "api.meraki.com"

internal_error_retry_time

integer

Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку сервера.

По умолчанию: 60

min_bitrate_type

string

Тип минимальной скорости передачи данных.

Варианты:

  • "band"
  • "ssid"

name

string

Уникальное имя нового профиля.

Этот параметр обязателен при создании.

net_id

string

Идентификатор сети.

net_name

string

Имя сети.

org_id

string

Идентификатор организации.

org_name

псевдонимы: organization

string

Имя организации.

output_format

string

Указывает модулю, следует ли возвращать ключи в формате snake case (например, net_id) или camel case (например, netId).

Варианты:

  • "snakecase" ← (по умолчанию)
  • "camelcase"

output_level

string

Задаёт объём отладочного вывода во время выполнения модуля.

Варианты:

  • "debug"
  • "normal" ← (по умолчанию)

profile_id

псевдонимы: id

string

Уникальный идентификатор существующего RF-профиля.

rate_limit_retry_time

integer

Количество секунд до повторной попытки, если сработало ограничение частоты запросов.

По умолчанию: 165

state

string

Запрос, редактирование или удаление параметров беспроводного RF-профиля.

Варианты:

  • "present" ← (по умолчанию)
  • "query"
  • "absent"

timeout

integer

Время ожидания для HTTP-запросов.

По умолчанию: 30

two_four_ghz_settings

dictionary

Параметры диапазона 2,4 ГГц

ax_enabled

boolean

Определяет, включён или выключен радиомодуль ax в диапазоне 2,4 ГГц.

Варианты:

  • false
  • true

max_power

integer

Задаёт максимальную мощность (дБм) для диапазона 2,4 ГГц.

Целое число от 5 до 30.

min_bitrate

float

Задаёт минимальную скорость передачи данных (Мбит/с) для диапазона 2,4 ГГц.

Варианты:

  • 1.0
  • 2.0
  • 5.5
  • 6.0
  • 9.0
  • 11.0
  • 12.0
  • 18.0
  • 24.0
  • 36.0
  • 48.0
  • 54.0

min_power

integer

Задаёт минимальную мощность (дБм) для диапазона 2,4 ГГц.

Целое число от 5 до 30.

rxsop

integer

Уровень RX-SOP определяет чувствительность радиомодуля.

Настоятельно рекомендуется настраивать RX-SOP только после консультации со специалистом по беспроводным сетям.

Для RX-SOP можно задать значение в диапазоне от -65 до -95 (дБм).

valid_auto_channels

list / элементы=integer

Задаёт допустимые автоматические каналы для диапазона 2,4 ГГц.

Варианты:

  • 1
  • 6
  • 11

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.
  • В Ansible 2.13 модули Meraki в Ansible перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. В режиме проверки будет указано, что конфигурация изменена, если найдены различия, однако изменения не отправляются в 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

Список настроек беспроводного RF-профиля.

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

ap_band_settings

complex

Настройки, которые будут включены, если для selectionType задано значение ‘ap’.

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

band_steering_enabled

boolean

Переключает клиента на наименее загруженный диапазон.

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

Пример: true

mode

string

Задает поддерживаемый точкой доступа диапазон RF.

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

Пример: "dual"

band_selection_type

string

Задает, назначается ли выбор диапазона для каждой точки доступа или SSID.

Этот параметр обязателен при создании.

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

Пример: "ap"

client_balancing_enabled

boolean

Переключает клиента на наиболее подходящую доступную точку доступа.

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

Пример: true

five_ghz_settings

complex

Настройки диапазона 5 ГГц.

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

channel_width

string

Задает ширину канала (МГц) для диапазона 5 ГГц.

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

Пример: "auto"

max_power

integer

Задает максимальную мощность (дБм) диапазона 5 ГГц.

Целое число от 8 до 30.

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

Пример: 12

min_bitrate

integer

Задает минимальную скорость передачи данных (Мбит/с) для диапазона 5 ГГц.

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

Пример: 6

min_power

integer

Задает минимальную мощность (дБм) диапазона 5 ГГц.

Целое число от 8 до 30.

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

Пример: 12

rxsop

integer

Уровень RX-SOP управляет чувствительностью радиомодуля.

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

Пример: -70

valid_auto_channels

list / elements=string

Задает допустимые автоматические каналы для диапазона 5 ГГц.

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

id

string

Уникальный идентификатор существующего RF-профиля.

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

Пример: "12345"

min_bitrate_type

string

Тип минимальной скорости передачи данных.

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

Пример: "ssid"

name

string

Уникальное имя нового профиля.

Этот параметр обязателен при создании.

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

Пример: "Guest RF profile"

two_four_ghz_settings

complex

Настройки диапазона 2,4 ГГц.

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

ax_enabled

boolean

Определяет, включен или выключен радиомодуль ax в диапазоне 2,4 ГГц.

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

Пример: true

max_power

integer

Задает максимальную мощность (дБм) диапазона 2,4 ГГц.

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

Пример: 12

min_bitrate

float

Задает минимальную скорость передачи данных (Мбит/с) для диапазона 2,4 ГГц.

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

Пример: 5.5

min_power

integer

Задает минимальную мощность (дБм) диапазона 2,4 ГГц.

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

Пример: 12

rxsop

integer

Уровень RX-SOP управляет чувствительностью радиомодуля.

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

Пример: -70

valid_auto_channels

list / elements=string

Задает допустимые автоматические каналы для диапазона 2,4 ГГц.

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

Пример: ["6"]

Статус

  • Этот модуль будет удален в версии 3.0.0. [устарел]
  • Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

  • Kevin Breit (@kbreit)

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

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

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

Spec-Zone.ru

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