Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_appliance_rf_profiles – Модуль ресурсов для networks_appliance_rfprofiles

Примечание

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

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

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

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

Новое в cisco.meraki 2.18.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Управление операциями создания, обновления и удаления ресурсов networks_appliance_rfprofiles.
  • Создаёт новый профиль беспроводной сети (RF) для этой сети.

Примечание

Для этого модуля существует соответствующий плагин действия.

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

fiveGhzSettings

dictionary

Настройки, связанные с диапазоном 5 ГГц.

axEnabled

boolean

Определяет, включен или выключен радиомодуль ax в диапазоне 5 ГГц. Может быть true или false. Если false, настоятельно рекомендуется отключить переключение диапазонов. По умолчанию true.

Варианты:

  • false
  • true

minBitrate

integer

Задает минимальную скорость передачи данных (Мбит/с) в диапазоне 5 ГГц. Может быть одним из значений: ‘6’, ‘9’, ‘12’, ‘18’, ‘24’, ‘36’, ‘48’ или ‘54’. По умолчанию 12.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий

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

meraki_api_key

string / required

meraki_api_key (string), API ключ, сгенерированный на панели управления; может быть также установлен как переменная окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), предшествует всем конечным точкам ресурсов

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

meraki_be_geo_id

string

meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может быть также установлен как переменная окружения BE_GEO_ID

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

meraki_caller

string

meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER

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

meraki_certificate_path

string

meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер

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

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), наследует собственный экземпляр регистратора

Варианты:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), имя файла журнала с добавленной датой и временем

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

meraki_log_path

string

log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан

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

meraki_maximum_retries

integer

meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

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

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки при ошибке Nginx 429

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

meraki_output_log

boolean

meraki_output_log (boolean), создать файл выходного журнала?

Варианты:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), выводить сообщения журнала на консоль?

Варианты:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS

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

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Варианты:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания повтора других ошибок 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя отвечаете!

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429?

Choices:

  • false
  • true ← (default)

name

string

Имя нового профиля. Должно быть уникальным. Этот параметр обязателен при создании.

networkId

string

NetworkId параметр пути. Идентификатор сети.

perSsidSettings

dictionary

Настройки радио по каждому SSID по номеру.

1

dictionary

Настройки для SSID 1.

bandOperationMode

string

Выбор между ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ или ‘multi’.

bandSteeringEnabled

boolean

Переключает клиента на наиболее свободный диапазон между 2,4 ГГц и 5 ГГц. Может быть true или false.

Choices:

  • false
  • true

2

dictionary

Настройки для SSID 2.

bandOperationMode

string

Выбор между ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ или ‘multi’.

bandSteeringEnabled

boolean

Переключает клиента на наиболее свободный диапазон между 2,4 ГГц и 5 ГГц. Может быть true или false.

Choices:

  • false
  • true

3

dictionary

Настройки для SSID 3.

bandOperationMode

string

Выбор между ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ или ‘multi’.

bandSteeringEnabled

boolean

Переключает клиента на наиболее свободный диапазон между 2,4 ГГц и 5 ГГц. Может быть true или false.

Choices:

  • false
  • true

4

dictionary

Настройки для SSID 4.

bandOperationMode

string

Выбор между ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ или ‘multi’.

bandSteeringEnabled

boolean

Переключает клиента на наиболее свободный диапазон между 2,4 ГГц и 5 ГГц. Может быть true или false.

Choices:

  • false
  • true

twoFourGhzSettings

dictionary

Настройки, относящиеся к диапазону 2.4 ГГц.

axEnabled

boolean

Определяет, включен или выключен радиомодуль ax в диапазоне 2.4 ГГц. Может принимать значения true или false. Если false, настоятельно рекомендуется отключить направленное управление полосами. По умолчанию значение true.

Допустимые значения:

  • false
  • true

minBitrate

float

Устанавливает минимальную скорость передачи данных (Мбит/с) для диапазона 2.4 ГГц. Может принимать значения ‘1’, ‘2’, ‘5.5’, ‘6’, ‘9’, ‘11’, ‘12’, ‘18’, ‘24’, ‘36’, ‘48’ или ‘54’. По умолчанию значение 11.

Примечания

Примечание

  • Используемые методы SDK: appliance.Appliance.create_network_appliance_rf_profile,
  • Используемые пути: post /networks/{networkId}/appliance/rfProfiles,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

Документация Cisco Meraki по созданию профиля беспроводного устройства

Полная справка по API createNetworkApplianceRfProfile.

Примеры

- name: Create
  cisco.meraki.networks_appliance_rf_profiles:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    fiveGhzSettings:
      axEnabled: true
      minBitrate: 48
    name: MX RF Profile
    networkId: string
    perSsidSettings:
      '1':
        bandOperationMode: dual
        bandSteeringEnabled: true
      '2':
        bandOperationMode: dual
        bandSteeringEnabled: true
      '3':
        bandOperationMode: dual
        bandSteeringEnabled: true
      '4':
        bandOperationMode: dual
        bandSteeringEnabled: true
    twoFourGhzSettings:
      axEnabled: true
      minBitrate: 12.0

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

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

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращенным Cisco Meraki Python SDK

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

Пример: {"fiveGhzSettings": {"axEnabled": true, "minBitrate": 0}, "id": "string", "name": "string", "networkId": "string", "perSsidSettings": {"1": {"bandOperationMode": "string", "bandSteeringEnabled": true}, "2": {"bandOperationMode": "string", "bandSteeringEnabled": true}, "3": {"bandOperationMode": "string", "bandSteeringEnabled": true}, "4": {"bandOperationMode": "string", "bandSteeringEnabled": true}}, "twoFourGhzSettings": {"axEnabled": true, "minBitrate": 0}}

Авторы

  • Francisco Munoz (@fmunoz)

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

  • Система отслеживания задач
  • Репозиторий (исходники)

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

Spec-Zone.ru

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