1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: wireless_accespoint_configuration
short_description: Resource module for Wireless Accespoint Configuration
description:
- Manage operation create of the resource Wireless Accespoint Configuration.
- >
User can configure multiple access points with required options using this intent API. This API does not support
configuration of CleanAir or SI for IOS-XE devices with version greater than or equal to 17.9.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
adminStatus:
description: Configure the access point's admin status. Set this parameter's value
to "true" to enable it and "false" to disable it.
type: bool
apList:
description: Wireless Accespoint Configuration's apList.
elements: dict
suboptions:
apName:
description: The current host name of the access point.
type: str
apNameNew:
description: The modified hostname of the access point.
type: str
macAddress:
description: The ethernet MAC address of the access point.
type: str
type: list
apMode:
description: Configure the access point's mode for local/flexconnect mode, set "0";
for monitor mode, set "1"; for sniffer mode, set "4"; and for bridge/flex+bridge
mode, set "5".
type: int
configureAdminStatus:
description: To change the access point's admin status, set this parameter's value
to "true".
type: bool
configureApMode:
description: To change the access point's mode, set this parameter's value to "true".
type: bool
configureFailoverPriority:
description: To change the access point's failover priority, set this parameter's
value to "true".
type: bool
configureHAController:
description: To change the access point's HA controller, set this parameter's value
to "true".
type: bool
configureLedBrightnessLevel:
description: To change the access point's LED brightness level, set this parameter's
value to "true".
type: bool
configureLedStatus:
description: To change the access point's LED status, set this parameter's value
to "true".
type: bool
configureLocation:
description: To change the access point's location, set this parameter's value to
"true".
type: bool
failoverPriority:
description: Configure the acess point's failover priority for low, set "1"; for
medium, set "2"; for high, set "3"; and for critical, set "4".
type: int
isAssignedSiteAsLocation:
description: If AP is assigned to a site, then to assign AP location as the site
name, set this parameter's value to "true".
type: bool
ledBrightnessLevel:
description: Configure the access point's LED brightness level by setting a value
between 1 and 8.
type: int
ledStatus:
description: Configure the access point's LED status. Set "true" to enable its status
and "false" to disable it.
type: bool
location:
description: Configure the access point's location.
type: str
primaryControllerName:
description: Configure the hostname for an access point's primary controller.
type: str
primaryIpAddress:
description: Wireless Accespoint Configuration's primaryIpAddress.
suboptions:
address:
description: Configure the IP address for an access point's primary controller.
type: str
type: dict
radioConfigurations:
description: Wireless Accespoint Configuration's radioConfigurations.
elements: dict
suboptions:
adminStatus:
description: Configure the admin status on the specified radio for an access
point. Set this parameter's value to "true" to enable it and "false" to disable
it.
type: bool
antennaCableName:
description: Configure the antenna cable name on the specified radio for an
access point. If cable loss needs to be configured, set this parameter's value
to "other".
type: str
antennaGain:
description: Configure the antenna gain on the specified radio for an access
point by setting a decimal value (in dBi). To configure "antennaGain", set
"antennaPatternName" value to "other".
type: int
antennaPatternName:
description: Specify the antenna name on the specified radio for an access point.
The antenna name is used to calculate the gain on the radio slot.
type: str
cableLoss:
description: Configure the cable loss on the specified radio for an access point
by setting a decimal value (in dBi).
type: float
channelAssignmentMode:
description: Configure the channel assignment mode on the specified radio for
an access point for global mode, set "1"; and for custom mode, set "2".
type: int
channelNumber:
description: Configure the channel number on the specified radio for an access
point.
type: int
channelWidth:
description: Configure the channel width on the specified radio for an access
point for 20 MHz, set "3"; for 40 MHz, set "4"; for 80 MHz, set "5"; and for
160 MHz, set "6".
type: int
cleanAirSI:
description: Configure CleanAir or Spectrum Intelligence on the specified radio
for an access point. Set this parameter's value to "0" to disable the feature
or "1" to enable it.
type: int
configureAdminStatus:
description: To change the admin status on the specified radio for an access
point, set this parameter's value to "true".
type: bool
configureAntennaCable:
description: To change the antenna cable name on the specified radio for an
access point, set this parameter's value to "true".
type: bool
configureAntennaPatternName:
description: To change the antenna gain on the specified radio for an access
point, set the value for this parameter to "true".
type: bool
configureChannel:
description: To change the channel on the specified radio for an access point,
set this parameter's value to "true".
type: bool
configureChannelWidth:
description: To change the channel width on the specified radio for an access
point, set this parameter's value to "true".
type: bool
configureCleanAirSI:
description: To enable or disable either CleanAir or Spectrum Intelligence on
the specified radio for an access point, set this parameter's value to "true".
type: bool
configurePower:
description: To change the power assignment mode on the specified radio for
an access point, set this parameter's value to "true".
type: bool
configureRadioRoleAssignment:
description: To change the radio role on the specified radio for an access point,
set this parameter's value to "true".
type: bool
powerAssignmentMode:
description: Configure the power assignment mode on the specified radio for
an access point for global mode, set "1"; and for custom mode, set "2".
type: int
powerlevel:
description: Configure the power level on the specified radio for an access
point by setting a value between 1 and 8.
type: int
radioBand:
description: Configure the band on the specified radio for an access point for
2.4 GHz, set "RADIO24"; for 5 GHz, set "RADIO5". Any other string is invalid,
including empty string.
type: str
radioRoleAssignment:
description: Configure only one of the following roles on the specified radio
for an access point as "AUTO", "SERVING", or "MONITOR". Any other string is
invalid, including empty string.
type: str
radioType:
description: Configure an access point's radio band for 2.4 GHz, set "1"; for
5 GHz, set "2"; for XOR, set "3"; and for 6 GHz, set "6".
type: int
type: list
secondaryControllerName:
description: Configure the hostname for an access point's secondary controller.
type: str
secondaryIpAddress:
description: Wireless Accespoint Configuration's secondaryIpAddress.
suboptions:
address:
description: Configure the IP address for an access point's secondary controller.
type: str
type: dict
tertiaryControllerName:
description: Configure the hostname for an access point's tertiary controller.
type: str
tertiaryIpAddress:
description: Wireless Accespoint Configuration's tertiaryIpAddress.
suboptions:
address:
description: Configure the IP address for an access point's tertiary controller.
type: str
type: dict
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Wireless ConfigureAccessPointsV1
description: Complete reference of the ConfigureAccessPointsV1 API.
link: https://developer.cisco.com/docs/dna-center/#!configure-access-points-v-1
notes:
- SDK Method used are
wireless.Wireless.configure_access_points_v1,
- Paths used are
post /dna/intent/api/v1/wireless/accesspoint-configuration,
"""
EXAMPLES = r"""
- 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
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"response": {
"taskId": "string",
"url": "string"
},
"version": "string"
}
"""
|
