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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
|
#!/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: network_device
short_description: Resource module for Network Device
description:
- Manage operations create, update and delete of the resource Network Device.
- This API creates a network device.
- This API deletes a network device by ID.
- This API deletes a network device by name.
- This API allows the client to update a network device by ID.
- This API allows the client to update a network device by name.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
NetworkDeviceGroupList:
description: List of Network Device Group names for this node.
elements: str
type: list
NetworkDeviceIPList:
description: List of IP Subnets for this node.
elements: dict
suboptions:
getIpaddressExclude:
description: It can be either single IP address or IP range address.
type: str
ipaddress:
description: Network Device's ipaddress.
type: str
mask:
description: Network Device's mask.
type: int
type: list
authenticationSettings:
description: Network Device's authenticationSettings.
suboptions:
dtlsRequired:
description: This value enforces use of dtls.
type: bool
enableKeyWrap:
description: EnableKeyWrap flag.
type: bool
enableMultiSecret:
description: Network Device's enableMultiSecret.
type: str
enabled:
description: Enabled flag.
type: bool
keyEncryptionKey:
description: Network Device's keyEncryptionKey.
type: str
keyInputFormat:
description: Allowed values - ASCII, - HEXADECIMAL.
type: str
messageAuthenticatorCodeKey:
description: Network Device's messageAuthenticatorCodeKey.
type: str
networkProtocol:
description: Allowed values - RADIUS, - TACACS_PLUS.
type: str
radiusSharedSecret:
description: Network Device's radiusSharedSecret.
type: str
secondRADIUSSharedSecret:
description: Network Device's secondRADIUSSharedSecret.
type: str
type: dict
coaPort:
description: Network Device's coaPort.
type: int
description:
description: Network Device's description.
type: str
dtlsDnsName:
description: This value is used to verify the client identity contained in the X.509
RADIUS/DTLS client certificate.
type: str
id:
description: Network Device's id.
type: str
modelName:
description: Network Device's modelName.
type: str
name:
description: Network Device's name.
type: str
profileName:
description: Network Device's profileName.
type: str
snmpsettings:
description: Network Device's snmpsettings.
suboptions:
linkTrapQuery:
description: LinkTrapQuery flag.
type: bool
macTrapQuery:
description: MacTrapQuery flag.
type: bool
originatingPolicyServicesNode:
description: Network Device's originatingPolicyServicesNode.
type: str
pollingInterval:
description: Network Device's pollingInterval.
type: int
roCommunity:
description: Network Device's roCommunity.
type: str
version:
description: Network Device's version.
type: str
type: dict
softwareVersion:
description: Network Device's softwareVersion.
type: str
tacacsSettings:
description: Network Device's tacacsSettings.
suboptions:
connectModeOptions:
description: Allowed values - OFF, - ON_LEGACY, - ON_DRAFT_COMPLIANT.
type: str
sharedSecret:
description: Network Device's sharedSecret.
type: str
type: dict
trustsecsettings:
description: Network Device's trustsecsettings.
suboptions:
deviceAuthenticationSettings:
description: Network Device's deviceAuthenticationSettings.
suboptions:
sgaDeviceId:
description: Network Device's sgaDeviceId.
type: str
sgaDevicePassword:
description: Network Device's sgaDevicePassword.
type: str
type: dict
deviceConfigurationDeployment:
description: Network Device's deviceConfigurationDeployment.
suboptions:
enableModePassword:
description: Network Device's enableModePassword.
type: str
execModePassword:
description: Network Device's execModePassword.
type: str
execModeUsername:
description: Network Device's execModeUsername.
type: str
includeWhenDeployingSGTUpdates:
description: IncludeWhenDeployingSGTUpdates flag.
type: bool
type: dict
pushIdSupport:
description: PushIdSupport flag.
type: bool
sgaNotificationAndUpdates:
description: Network Device's sgaNotificationAndUpdates.
suboptions:
coaSourceHost:
description: Network Device's coaSourceHost.
type: str
downlaodEnvironmentDataEveryXSeconds:
description: Network Device's downlaodEnvironmentDataEveryXSeconds.
type: int
downlaodPeerAuthorizationPolicyEveryXSeconds:
description: Network Device's downlaodPeerAuthorizationPolicyEveryXSeconds.
type: int
downloadSGACLListsEveryXSeconds:
description: Network Device's downloadSGACLListsEveryXSeconds.
type: int
otherSGADevicesToTrustThisDevice:
description: OtherSGADevicesToTrustThisDevice flag.
type: bool
reAuthenticationEveryXSeconds:
description: Network Device's reAuthenticationEveryXSeconds.
type: int
sendConfigurationToDevice:
description: SendConfigurationToDevice flag.
type: bool
sendConfigurationToDeviceUsing:
description: Allowed values - ENABLE_USING_COA, - ENABLE_USING_CLI, - DISABLE_ALL.
type: str
type: dict
type: dict
requirements:
- ciscoisesdk >= 2.2.1
- python >= 3.5
notes:
- SDK Method used are
network_device.NetworkDevice.create_network_device,
network_device.NetworkDevice.delete_network_device_by_id,
network_device.NetworkDevice.delete_network_device_by_name,
network_device.NetworkDevice.update_network_device_by_id,
network_device.NetworkDevice.update_network_device_by_name,
- Paths used are
post /ers/config/networkdevice,
delete /ers/config/networkdevice/name/{name},
delete /ers/config/networkdevice/{id},
put /ers/config/networkdevice/name/{name},
put /ers/config/networkdevice/{id},
"""
EXAMPLES = r"""
- name: Update by name
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
NetworkDeviceGroupList:
- string
NetworkDeviceIPList:
- getIpaddressExclude: string
ipaddress: string
mask: 0
authenticationSettings:
dtlsRequired: true
enableKeyWrap: true
enableMultiSecret: string
enabled: true
keyEncryptionKey: string
keyInputFormat: string
messageAuthenticatorCodeKey: string
networkProtocol: string
radiusSharedSecret: string
secondRadiusSharedSecret: string
coaPort: 0
description: string
dtlsDnsName: string
id: string
modelName: string
name: string
profileName: string
snmpsettings:
linkTrapQuery: true
macTrapQuery: true
originatingPolicyServicesNode: string
pollingInterval: 0
roCommunity: string
version: string
softwareVersion: string
tacacsSettings:
connectModeOptions: string
sharedSecret: string
trustsecsettings:
deviceAuthenticationSettings:
sgaDeviceId: string
sgaDevicePassword: string
deviceConfigurationDeployment:
enableModePassword: string
execModePassword: string
execModeUsername: string
includeWhenDeployingSGTUpdates: true
pushIdSupport: true
sgaNotificationAndUpdates:
coaSourceHost: string
downlaodEnvironmentDataEveryXSeconds: 0
downlaodPeerAuthorizationPolicyEveryXSeconds: 0
downloadSGACLListsEveryXSeconds: 0
otherSGADevicesToTrustThisDevice: true
reAuthenticationEveryXSeconds: 0
sendConfigurationToDevice: true
sendConfigurationToDeviceUsing: string
- name: Delete by name
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
name: string
- name: Update by id
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
NetworkDeviceGroupList:
- string
NetworkDeviceIPList:
- getIpaddressExclude: string
ipaddress: string
mask: 0
authenticationSettings:
dtlsRequired: true
enableKeyWrap: true
enableMultiSecret: string
enabled: true
keyEncryptionKey: string
keyInputFormat: string
messageAuthenticatorCodeKey: string
networkProtocol: string
radiusSharedSecret: string
secondRadiusSharedSecret: string
coaPort: 0
description: string
dtlsDnsName: string
id: string
modelName: string
name: string
profileName: string
snmpsettings:
linkTrapQuery: true
macTrapQuery: true
originatingPolicyServicesNode: string
pollingInterval: 0
roCommunity: string
version: string
softwareVersion: string
tacacsSettings:
connectModeOptions: string
sharedSecret: string
trustsecsettings:
deviceAuthenticationSettings:
sgaDeviceId: string
sgaDevicePassword: string
deviceConfigurationDeployment:
enableModePassword: string
execModePassword: string
execModeUsername: string
includeWhenDeployingSGTUpdates: true
pushIdSupport: true
sgaNotificationAndUpdates:
coaSourceHost: string
downlaodEnvironmentDataEveryXSeconds: 0
downlaodPeerAuthorizationPolicyEveryXSeconds: 0
downloadSGACLListsEveryXSeconds: 0
otherSGADevicesToTrustThisDevice: true
reAuthenticationEveryXSeconds: 0
sendConfigurationToDevice: true
sendConfigurationToDeviceUsing: string
- name: Delete by id
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.network_device:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
NetworkDeviceGroupList:
- string
NetworkDeviceIPList:
- getIpaddressExclude: string
ipaddress: string
mask: 0
authenticationSettings:
dtlsRequired: true
enableKeyWrap: true
enableMultiSecret: string
enabled: true
keyEncryptionKey: string
keyInputFormat: string
messageAuthenticatorCodeKey: string
networkProtocol: string
radiusSharedSecret: string
secondRadiusSharedSecret: string
coaPort: 0
description: string
dtlsDnsName: string
modelName: string
name: string
profileName: string
snmpsettings:
linkTrapQuery: true
macTrapQuery: true
originatingPolicyServicesNode: string
pollingInterval: 0
roCommunity: string
version: string
softwareVersion: string
tacacsSettings:
connectModeOptions: string
sharedSecret: string
trustsecsettings:
deviceAuthenticationSettings:
sgaDeviceId: string
sgaDevicePassword: string
deviceConfigurationDeployment:
enableModePassword: string
execModePassword: string
execModeUsername: string
includeWhenDeployingSGTUpdates: true
pushIdSupport: true
sgaNotificationAndUpdates:
coaSourceHost: string
downlaodEnvironmentDataEveryXSeconds: 0
downlaodPeerAuthorizationPolicyEveryXSeconds: 0
downloadSGACLListsEveryXSeconds: 0
otherSGADevicesToTrustThisDevice: true
reAuthenticationEveryXSeconds: 0
sendConfigurationToDevice: true
sendConfigurationToDeviceUsing: string
"""
RETURN = r"""
ise_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{
"id": "string",
"name": "string",
"description": "string",
"authenticationSettings": {
"networkProtocol": "string",
"secondRadiusSharedSecret": "string",
"radiusSharedSecret": "string",
"enableKeyWrap": true,
"enabled": true,
"dtlsRequired": true,
"enableMultiSecret": "string",
"keyEncryptionKey": "string",
"messageAuthenticatorCodeKey": "string",
"keyInputFormat": "string"
},
"snmpsettings": {
"version": "string",
"roCommunity": "string",
"pollingInterval": 0,
"linkTrapQuery": true,
"macTrapQuery": true,
"originatingPolicyServicesNode": "string"
},
"trustsecsettings": {
"deviceAuthenticationSettings": {
"sgaDeviceId": "string",
"sgaDevicePassword": "string"
},
"sgaNotificationAndUpdates": {
"downlaodEnvironmentDataEveryXSeconds": 0,
"downlaodPeerAuthorizationPolicyEveryXSeconds": 0,
"reAuthenticationEveryXSeconds": 0,
"downloadSGACLListsEveryXSeconds": 0,
"otherSGADevicesToTrustThisDevice": true,
"sendConfigurationToDevice": true,
"sendConfigurationToDeviceUsing": "string",
"coaSourceHost": "string"
},
"deviceConfigurationDeployment": {
"includeWhenDeployingSGTUpdates": true,
"enableModePassword": "string",
"execModePassword": "string",
"execModeUsername": "string"
},
"pushIdSupport": true
},
"tacacsSettings": {
"sharedSecret": "string",
"connectModeOptions": "string"
},
"profileName": "string",
"coaPort": 0,
"dtlsDnsName": "string",
"modelName": "string",
"softwareVersion": "string",
"NetworkDeviceIPList": [
{
"ipaddress": "string",
"mask": 0,
"getIpaddressExclude": "string"
}
],
"NetworkDeviceGroupList": [
"string"
],
"link": {
"rel": "string",
"href": "string",
"type": "string"
}
}
ise_update_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
version_added: '1.1.0'
type: dict
sample: >
{
"UpdatedFieldsList": {
"updatedField": [
{
"field": "string",
"oldValue": "string",
"newValue": "string"
}
],
"field": "string",
"oldValue": "string",
"newValue": "string"
}
}
"""
|
