Spec-Zone.ru › Ansible

Модуль cisco.dnac.wireless_accespoint_configuration — Модуль ресурсов для настройки беспроводных точек доступа

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.wireless_accespoint_configuration.

Новинка в cisco.dnac 3.1.0

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

Обзор

  • Управление операцией создания ресурса «Настройка беспроводной точки доступа».
  • Пользователь может настроить несколько точек доступа с необходимыми параметрами, используя этот API. Данный API не поддерживает настройку CleanAir или SI для устройств IOS-XE с версией 17.9 и выше.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.5

Параметры

Параметр

Комментарии

adminStatus

boolean

Настройка состояния администратора точки доступа. Установите значение этого параметра равным «true», чтобы включить его, и «false», чтобы отключить.

Варианты:

  • false
  • true

apList

list / elements=dictionary

apList конфигурации беспроводной точки доступа.

apName

string

Текущее имя хоста точки доступа.

apNameNew

string

Измененное имя хоста точки доступа.

macAddress

string

MAC-адрес Ethernet точки доступа.

apMode

integer

Настройка режима точки доступа для локального/flexconnect режима, установите «0»; для режима монитора, установите «1»; для режима sniffer, установите «4»; и для режима bridge/flex+bridge, установите «5».

configureAdminStatus

boolean

Чтобы изменить состояние администратора точки доступа, установите значение этого параметра равным «true».

Варианты:

  • false
  • true

configureApMode

boolean

Чтобы изменить режим точки доступа, установите значение этого параметра равным «true».

Варианты:

  • false
  • true

configureFailoverPriority

boolean

Чтобы изменить приоритет отработки отказа точки доступа, установите значение этого параметра равным «true».

Варианты:

  • false
  • true

configureHAController

boolean

Чтобы изменить контроллер HA точки доступа, установите значение этого параметра равным «true».

Варианты:

  • false
  • true

configureLedBrightnessLevel

boolean

Чтобы изменить уровень яркости светодиода точки доступа, установите значение этого параметра равным «true».

Варианты:

  • false
  • true

configureLedStatus

boolean

Чтобы изменить состояние светодиода точки доступа, установите значение этого параметра равным «true».

Варианты:

  • false
  • true

configureLocation

boolean

Чтобы изменить местоположение точки доступа, установите значение этого параметра равным «true».

Варианты:

  • false
  • true

dnac_debug

boolean

Флаг для Cisco DNA Center SDK для включения отладки.

Варианты:

  • false ← (default)
  • true

dnac_host

string / required

Имя хоста Cisco DNA Center.

dnac_password

string

Пароль Cisco DNA Center для аутентификации.

dnac_port

integer

Порт Cisco DNA Center.

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

dnac_username

aliases: user

string

Имя пользователя Cisco DNA Center для аутентификации.

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

dnac_verify

boolean

Флаг для включения или отключения проверки SSL-сертификата.

Варианты:

  • false
  • true ← (default)

dnac_version

string

Информирует SDK о том, какая версия Cisco DNA Center используется.

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

failoverPriority

integer

Настройте приоритет резервного копирования точки доступа: низкий — «1»; средний — «2»; высокий — «3»; критический — «4».

isAssignedSiteAsLocation

boolean

Если точка доступа назначена на сайт, то для назначения местоположения точки доступа как имени сайта, установите значение этого параметра в «true».

Варианты:

  • false
  • true

ledBrightnessLevel

integer

Настройте уровень яркости светодиода точки доступа, установив значение от 1 до 8.

ledStatus

boolean

Настройте состояние светодиода точки доступа. Установите «true», чтобы включить его, и «false», чтобы отключить.

Варианты:

  • false
  • true

location

string

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

primaryControllerName

string

Настройте имя хоста для основного контроллера точки доступа.

primaryIpAddress

dictionary

Основной IP-адрес конфигурации точки беспроводного доступа.

address

string

Настройте IP-адрес основного контроллера точки доступа.

radioConfigurations

list / elements=dictionary

Конфигурация радиочастот точки беспроводного доступа.

adminStatus

boolean

Настройте административный статус указанного радиоканала точки доступа. Установите значение параметра «true», чтобы включить, и «false», чтобы отключить.

Варианты:

  • false
  • true

antennaCableName

string

Настройте имя кабеля антенны для указанного радиоканала точки доступа. Если необходимо настроить потерю сигнала в кабеле, установите значение этого параметра в «other».

antennaGain

integer

Настройте усиление антенны для указанного радиоканала точки доступа, установив десятичное значение (в дБ). Чтобы настроить «antennaGain», установите значение «antennaPatternName» в «other».

antennaPatternName

string

Укажите имя антенны для указанного радиоканала точки доступа. Имя антенны используется для расчёта усиления в радиоканале.

cableLoss

float

Настройте потери сигнала в кабеле для указанного радиоканала точки доступа, установив десятичное значение (в дБ).

channelAssignmentMode

integer

Настройте режим назначения канала для указанного радиоканала точки доступа: глобальный — «1»; пользовательский — «2».

channelNumber

integer

Настройте номер канала для указанного радиоканала точки доступа.

channelWidth

integer

Настройте ширину канала для указанного радиоканала точки доступа: 20 МГц — «3»; 40 МГц — «4»; 80 МГц — «5»; 160 МГц — «6».

cleanAirSI

integer

Настройте функцию CleanAir или Spectrum Intelligence для указанного радиоканала точки доступа. Установите значение параметра «0», чтобы отключить, или «1», чтобы включить.

configureAdminStatus

boolean

Для изменения административного статуса указанного радиоканала точки доступа установите значение параметра в «true».

Варианты:

  • false
  • true

configureAntennaCable

boolean

Для изменения имени кабеля антенны для указанного радиоканала точки доступа установите значение параметра в «true».

Варианты:

  • false
  • true

configureAntennaPatternName

boolean

Для изменения усиления антенны на указанном радиоканале для точки доступа установите значение этого параметра в «true».

Варианты:

  • false
  • true

configureChannel

boolean

Для изменения канала на указанном радиоканале для точки доступа установите значение этого параметра в «true».

Варианты:

  • false
  • true

configureChannelWidth

boolean

Для изменения ширины канала на указанном радиоканале для точки доступа установите значение этого параметра в «true».

Варианты:

  • false
  • true

configureCleanAirSI

boolean

Для включения или выключения CleanAir или Spectrum Intelligence на указанном радиоканале для точки доступа установите значение этого параметра в «true».

Варианты:

  • false
  • true

configurePower

boolean

Для изменения режима распределения мощности на указанном радиоканале для точки доступа установите значение этого параметра в «true».

Варианты:

  • false
  • true

configureRadioRoleAssignment

boolean

Для изменения роли радио на указанном радиоканале для точки доступа установите значение этого параметра в «true».

Варианты:

  • false
  • true

powerAssignmentMode

integer

Настройка режима распределения мощности на указанном радиоканале для точки доступа: для глобального режима установите «1», для пользовательского режима — «2».

powerlevel

integer

Настройте уровень мощности на указанном радиоканале для точки доступа, задав значение от 1 до 8.

radioBand

string

Настройка диапазона на указанном радиоканале для точки доступа: для 2,4 ГГц — «RADIO24», для 5 ГГц — «RADIO5». Любой другой строковый параметр, включая пустую строку, недопустим.

radioRoleAssignment

string

Настройте только одну из следующих ролей на указанном радиоканале для точки доступа: «AUTO», «SERVING» или «MONITOR». Любой другой строковый параметр, включая пустую строку, недопустим.

radioType

integer

Настройте диапазон радио точки доступа: для 2,4 ГГц — «1», для 5 ГГц — «2», для XOR — «3», для 6 ГГц — «6».

secondaryControllerName

string

Настройка имени хоста для вторичного контроллера точки доступа.

secondaryIpAddress

dictionary

Вторичный адрес IP для конфигурации точки беспроводного доступа.

address

string

Настройка IP-адреса вторичного контроллера точки доступа.

tertiaryControllerName

string

Настройка имени хоста для третичного контроллера точки доступа.

tertiaryIpAddress

dictionary

Третичный адрес IP для конфигурации точки беспроводного доступа.

address

string

Настройка IP-адреса третичного контроллера точки доступа.

validate_response_schema

boolean

Флаг для Cisco DNA Center SDK для включения проверки заголовков запросов по JSON-схеме.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Используемые методы SDK: wireless.Wireless.configure_access_points_v1,
  • Используемые пути: post /dna/intent/api/v1/wireless/accesspoint-configuration,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco DNA Center по Wireless ConfigureAccessPointsV1

Полное описание API ConfigureAccessPointsV1.

Примеры

- name: Create
  cisco.dnac.wireless_accespoint_configuration:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    adminStatus: true
    apList:
    - apName: string
      apNameNew: string
      macAddress: string
    apMode: 0
    configureAdminStatus: true
    configureApMode: true
    configureFailoverPriority: true
    configureHAController: true
    configureLedBrightnessLevel: true
    configureLedStatus: true
    configureLocation: true
    failoverPriority: 0
    isAssignedSiteAsLocation: true
    ledBrightnessLevel: 0
    ledStatus: true
    location: string
    primaryControllerName: string
    primaryIpAddress:
      address: string
    radioConfigurations:
    - adminStatus: true
      antennaCableName: string
      antennaGain: 0
      antennaPatternName: string
      cableLoss: 0
      channelAssignmentMode: 0
      channelNumber: 0
      channelWidth: 0
      cleanAirSI: 0
      configureAdminStatus: true
      configureAntennaCable: true
      configureAntennaPatternName: true
      configureChannel: true
      configureChannelWidth: true
      configureCleanAirSI: true
      configurePower: true
      configureRadioRoleAssignment: true
      powerAssignmentMode: 0
      powerlevel: 0
      radioBand: string
      radioRoleAssignment: string
      radioType: 0
    secondaryControllerName: string
    secondaryIpAddress:
      address: string
    tertiaryControllerName: string
    tertiaryIpAddress:
      address: string

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

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

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Авторы

  • Rafael Campos (@racampos)

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

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

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

Spec-Zone.ru

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