cisco.dnac.wireless_accespoint_configuration_v1 模块 – 无线接入点配置 V1 的资源模块

注意

此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：cisco.dnac.wireless_accespoint_configuration_v1。

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源无线接入点配置 V1 的创建操作。
用户可以使用此意图 API 配置具有所需选项的多个接入点。此 API 不支持配置版本大于或等于 17.9 的 IOS-XE 设备的 CleanAir 或 SI。

注意

此模块具有相应的动作插件。

要求 

在执行此模块的主机上需要以下要求。

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
adminStatus 布尔值	配置接入点的管理状态。将此参数的值设置为“true”以启用它，设置为“false”以禁用它。选择 `false` `true`
apList 列表 / 元素=字典	无线接入点配置的 apList。
apName 字符串	接入点的当前主机名。
apNameNew 字符串	接入点的修改后的主机名。
macAddress 字符串	接入点的以太网 MAC 地址。
apMode 整数	配置接入点在本地/FlexConnect 模式下的模式，设置为“0”；对于监控模式，设置为“1”；对于嗅探器模式，设置为“4”；对于桥接/Flex+桥接模式，设置为“5”。
configureAdminStatus 布尔值	要更改接入点的管理状态，请将此参数的值设置为“true”。选择 `false` `true`
configureApMode 布尔值	要更改接入点的模式，请将此参数的值设置为“true”。选择 `false` `true`
configureFailoverPriority 布尔值	要更改接入点的故障转移优先级，请将此参数的值设置为“true”。选择 `false` `true`
configureHAController 布尔值	要更改接入点的 HA 控制器，请将此参数的值设置为“true”。选择 `false` `true`
configureLedBrightnessLevel 布尔值	要更改接入点的 LED 亮度级别，请将此参数的值设置为“true”。选择 `false` `true`
configureLedStatus 布尔值	要更改接入点的 LED 状态，请将此参数的值设置为“true”。选择 `false` `true`
configureLocation 布尔值	要更改接入点的位置，请将此参数的值设置为“true”。选择 `false` `true`
dnac_debug 布尔值	用于 Cisco DNA Center SDK 启用调试的标志。选择 `false` ← (默认) `true`
dnac_host 字符串 / 必需	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。默认值: `443`
dnac_username 别名: user 字符串	用于身份验证的 Cisco DNA Center 用户名。默认值: `"admin"`
dnac_verify 布尔值	启用或禁用 SSL 证书验证的标志。选择 `false` `true` ← (默认)
dnac_version 字符串	通知 SDK 要使用的 Cisco DNA Center 版本。默认值: `"2.3.7.6"`
failoverPriority 整数	配置接入点的故障转移优先级，低优先级设置为“1”；中优先级设置为“2”；高优先级设置为“3”；关键优先级设置为“4”。
isAssignedSiteAsLocation 布尔值	如果 AP 分配给站点，则要将 AP 位置分配为站点名称，请将此参数的值设置为“true”。选择 `false` `true`
ledBrightnessLevel 整数	通过设置 1 到 8 之间的值来配置接入点的 LED 亮度级别。
ledStatus 布尔值	配置接入点的 LED 状态。设置为“true”以启用其状态，设置为“false”以禁用它。选择 `false` `true`
location 字符串	配置接入点的位置。
primaryControllerName 字符串	为接入点的主控制器配置主机名。
primaryIpAddress 字典	无线接入点配置的 primaryIpAddress。
address 字符串	为接入点的主控制器配置 IP 地址。
radioConfigurations 列表 / 元素=字典	无线接入点配置的 radioConfigurations。
adminStatus 布尔值	在接入点的指定无线电上配置管理状态。将此参数的值设置为“true”以启用它，设置为“false”以禁用它。选择 `false` `true`
antennaCableName 字符串	在接入点的指定无线电上配置天线电缆名称。如果需要配置电缆损耗，请将此参数的值设置为“other”。
antennaGain 整数	通过设置十进制值（以 dBi 为单位）来配置接入点的指定无线电上的天线增益。要配置“antennaGain”，请将“antennaPatternName”值设置为“other”。
antennaPatternName 字符串	指定接入点的指定无线电上的天线名称。天线名称用于计算无线电插槽上的增益。
cableLoss 浮点数	通过设置十进制值（以 dBi 为单位）来配置接入点的指定无线电上的电缆损耗。
channelAssignmentMode 整数	在接入点的指定无线电上配置信道分配模式，全局模式设置为“1”；自定义模式设置为“2”。
channelNumber 整数	在接入点的指定无线电上配置信道号。
channelWidth 整数	在接入点的指定无线电上配置信道宽度，对于 20 MHz，设置为“3”；对于 40 MHz，设置为“4”；对于 80 MHz，设置为“5”；对于 160 MHz，设置为“6”，对于 320 MHz，设置为“7”。
cleanAirSI 整数	配置接入点指定无线电上的 CleanAir 或频谱智能。将此参数的值设置为“0”以禁用该功能，或设置为“1”以启用该功能。
configureAdminStatus 布尔值	要更改接入点指定无线电上的管理状态，请将此参数的值设置为“true”。选择 `false` `true`
configureAntennaCable 布尔值	要更改接入点指定无线电上的天线电缆名称，请将此参数的值设置为“true”。选择 `false` `true`
configureAntennaPatternName 布尔值	要更改接入点指定无线电上的天线增益，请将此参数的值设置为“true”。选择 `false` `true`
configureChannel 布尔值	要更改接入点指定无线电上的信道，请将此参数的值设置为“true”。选择 `false` `true`
configureChannelWidth 布尔值	要更改接入点指定无线电上的信道宽度，请将此参数的值设置为“true”。选择 `false` `true`
configureCleanAirSI 布尔值	要在接入点的指定无线电上启用或禁用 CleanAir 或频谱智能，请将此参数的值设置为“true”。选择 `false` `true`
configurePower 布尔值	要更改接入点指定无线电上的功率分配模式，请将此参数的值设置为“true”。选择 `false` `true`
configureRadioRoleAssignment 布尔值	要更改接入点指定无线电上的无线电角色，请将此参数的值设置为“true”。选择 `false` `true`
powerAssignmentMode 整数	配置接入点指定无线电上的功率分配模式。全局模式设置为“1”；自定义模式设置为“2”。
powerlevel 整数	通过设置 1 到 8 之间的值，配置接入点指定无线电上的功率级别。
radioBand 字符串	配置接入点指定无线电上的频段。对于 2.4 GHz，设置为“RADIO24”；对于 5 GHz，设置为“RADIO5”。任何其他字符串无效，包括空字符串。
radioRoleAssignment 字符串	在接入点指定的无线电上配置以下角色之一：“AUTO”、“SERVING”或“MONITOR”。任何其他字符串无效，包括空字符串。
radioType 整数	配置接入点的无线电频段。对于 2.4 GHz，设置为“1”；对于 5 GHz，设置为“2”；对于 XOR，设置为“3”；对于 6 GHz，设置为“6”。
secondaryControllerName 字符串	配置接入点辅助控制器的主机名。
secondaryIpAddress 字典	无线接入点配置的 secondaryIpAddress。
address 字符串	配置接入点辅助控制器的 IP 地址。
tertiaryControllerName 字符串	配置接入点三级控制器的主机名。
tertiaryIpAddress 字典	无线接入点配置的 tertiaryIpAddress。
address 字符串	配置接入点三级控制器的 IP 地址。
validate_response_schema 布尔值	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 的文档: ConfigureAccessPointsV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.wireless_accespoint_configuration_v1:
    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)