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
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2023 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
"""
The module file for ios_vxlan_vtep
"""
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
module: ios_vxlan_vtep
short_description: Resource module to configure VXLAN VTEP interface.
description: This module provides declarative management of VXLAN VTEP interface on Cisco IOS network
devices.
version_added: 5.3.0
author: Padmini Priyadarshini Sivaraj (@PadminiSivaraj)
notes:
- Tested against Cisco IOS device with Version 17.13.01 on Cat9k on CML.
- This module works with connection C(network_cli).
See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html)
options:
config:
description: A dictionary of VXLAN VTEP interface option
type: list
elements: dict
suboptions:
interface:
description:
- VXLAN VTEP interface
type: str
required: true
source_interface:
description:
- Source interface for the VXLAN VTEP interface
type: str
host_reachability_bgp:
description:
- Host reachability using EVPN protocol
type: bool
member:
description:
- Configure VNI member
type: dict
suboptions:
vni:
description:
- Configure VNI information
type: dict
suboptions:
l2vni:
description:
- Associates L2VNI with the VXLAN VTEP interface
type: list
elements: dict
suboptions:
vni:
description: VNI number
type: int
replication:
description: Replication type for the L2VNI
type: dict
suboptions:
type:
description: Replication type
type: str
choices: ['ingress', 'static']
mcast_group:
description: Configure multicast group for VNI(s)
type: dict
suboptions:
ipv4:
description: IPv4 multicast group
type: str
ipv6:
description: IPv6 multicast group
type: str
l3vni:
description:
- Associates L3VNI with the VXLAN VTEP interface
type: list
elements: dict
suboptions:
vni:
description: VNI number
type: int
vrf:
description: VRF name of the L3VNI
type: str
running_config:
description:
- This option is used only with state I(parsed).
- The value of this option should be the output received from the IOS device by
executing the command B(show running-config | section ^interface nve).
- The state I(parsed) reads the configuration from C(running_config) option and
transforms it into Ansible structured data as per the resource module's argspec
and the value is then returned in the I(parsed) key within the result.
type: str
state:
description:
- The state the configuration should be left in
type: str
choices:
- merged
- replaced
- overridden
- deleted
- rendered
- gathered
- parsed
default: merged
"""
EXAMPLES = """
# Using state merged
# Before state:
# -------------
# interface nve1
# no ip address
# source-interface Loopback1
# host-reachability protocol bgp
# member vni 10101 mcast-group 225.0.0.101
# member vni 10102 ingress-replication
# member vni 50901 vrf green
# member vni 10201 mcast-group 225.0.0.101
# member vni 10202 ingress-replication
# member vni 50902 vrf blue
# - name: Merge the provided configuration with the device configuration
# cisco.ios.ios_vxlan_vtep:
# config:
# - interface: nve1
# source_interface: loopback2
# member:
# vni:
# l2vni:
# - vni: 10101
# replication:
# type: ingress
# - vni: 10201
# replication:
# type: static
# mcast_group:
# ipv4: 225.0.0.101
# ipv6: FF0E:225::101
# l3vni:
# - vni: 50901
# vrf: blue
# state: merged
# Commands Fired:
# ---------------
# "commands": [
# "interface nve1",
# "source-interface loopback2",
# "no member vni 10101 mcast-group 225.0.0.101",
# "member vni 10101 ingress-replication",
# "no member vni 10201 mcast-group 225.0.0.101",
# "member vni 10201 mcast-group 225.0.0.101 FF0E:225::101",
# "no member vni 50901 vrf green",
# "no member vni 50902 vrf blue",
# "member vni 50901 vrf blue"
# ],
# After state:
# ------------
# interface nve1
# no ip address
# source-interface Loopback2
# host-reachability protocol bgp
# member vni 10102 ingress-replication
# member vni 10202 ingress-replication
# member vni 10101 ingress-replication
# member vni 10201 mcast-group 225.0.0.101 FF0E:225::101
# member vni 50901 vrf blue
# Using state replaced
# Before state:
# -------------
# interface nve1
# no ip address
# source-interface Loopback2
# host-reachability protocol bgp
# member vni 10102 ingress-replication
# member vni 10202 ingress-replication
# member vni 10101 ingress-replication
# member vni 10201 mcast-group 225.0.0.101 FF0E:225::101
# member vni 50901 vrf blue
# - name: Replaces the device configuration with the provided configuration
# cisco.ios.ios_vxlan_vtep:
# config:
# - interface: nve1
# source_interface: Loopback2
# member:
# vni:
# l2vni:
# - vni: 10101
# replication:
# type: static
# mcast_group:
# ipv6: FF0E:225::101
# - vni: 10201
# replication:
# type: static
# mcast_group:
# ipv6: FF0E:225::102
# state: replaced
# Commands Fired:
# ---------------
# "commands": [
# "interface nve1",
# "no member vni 10101 ingress-replication",
# "member vni 10101 mcast-group FF0E:225::101",
# "no member vni 10201 mcast-group 225.0.0.101 FF0E:225::101",
# "member vni 10201 mcast-group FF0E:225::102",
# "no member vni 10102 ingress-replication",
# "no member vni 10202 ingress-replication",
# "no member vni 50901 vrf blue"
# ],
# After state:
# ------------
# interface nve1
# no ip address
# source-interface Loopback2
# host-reachability protocol bgp
# member vni 10101 mcast-group FF0E:225::101
# member vni 10201 mcast-group FF0E:225::102
# Using state Deleted
# Before state:
# -------------
# interface nve1
# no ip address
# source-interface Loopback2
# host-reachability protocol bgp
# member vni 10101 mcast-group FF0E:225::101
# member vni 10201 mcast-group FF0E:225::102
# - name: "Delete VXLAN VTEP interface"
# cisco.ios.ios_vxlan_vtep:
# config:
# - interface: nve1
# state: deleted
# Commands Fired:
# ---------------
# "commands": [
# "interface nve1",
# "no source-interface Loopback2",
# "no host-reachability protocol bgp",
# "no member vni 10101 mcast-group FF0E:225::101",
# "no member vni 10201 mcast-group FF0E:225::102"
# ],
# After state:
# -------------
# interface nve1
# no ip address
# Using state Deleted with member VNIs
# Before state:
# -------------
# interface nve1
# no ip address
# source-interface Loopback2
# host-reachability protocol bgp
# member vni 10101 mcast-group FF0E:225::101
# member vni 10102 mcast-group 225.0.0.101
# member vni 10201 mcast-group 225.0.0.101 FF0E:225::101
# - name: "Delete VXLAN VTEP interface with member VNIs"
# cisco.ios.ios_vxlan_vtep:
# config:
# - interface: nve1
# source_interface: Loopback2
# member:
# vni:
# l2vni:
# - vni: 10101
# - vni: 10102
# state: deleted
# Commands Fired:
# ---------------
# "commands": [
# "interface nve1",
# "no member vni 10101 mcast-group FF0E:225::101",
# "no member vni 10102 mcast-group 225.0.0.101"
# ],
# After state:
# -------------
# interface nve1
# no ip address
# source-interface Loopback2
# host-reachability protocol bgp
# member vni 10201 mcast-group 225.0.0.101 FF0E:225::101
# Using state Deleted with no config
# Before state:
# -------------
# interface nve1
# no ip address
# source-interface Loopback2
# host-reachability protocol bgp
# member vni 10101 mcast-group FF0E:225::101
# member vni 10201 mcast-group FF0E:225::102
# - name: "Delete VXLAN VTEP interface with no config"
# cisco.ios.ios_vxlan_vtep:
# state: deleted
# Commands Fired:
# ---------------
# "commands": [
# "interface nve1",
# "no source-interface Loopback2",
# "no host-reachability protocol bgp",
# "no member vni 10101 mcast-group FF0E:225::101",
# "no member vni 10201 mcast-group FF0E:225::102"
# ],
# After state:
# -------------
# interface nve1
# no ip address
"""
RETURN = """
before:
description: The configuration prior to the module execution.
returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged)
type: dict
sample: >
This output will always be in the same format as the
module argspec.
after:
description: The resulting configuration after module execution.
returned: when changed
type: dict
sample: >
This output will always be in the same format as the
module argspec.
commands:
description: The set of commands pushed to the remote device.
returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged)
type: list
sample:
- 'interface nve1'
- 'source-interface Loopback1'
- 'host-reachability protocol bgp'
- 'member vni 10101 ingress-replication'
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.cisco.ios.plugins.module_utils.network.ios.argspec.vxlan_vtep.vxlan_vtep import (
Vxlan_vtepArgs,
)
from ansible_collections.cisco.ios.plugins.module_utils.network.ios.config.vxlan_vtep.vxlan_vtep import (
Vxlan_vtep,
)
def main():
"""
Main entry point for module execution
:returns: the result form module invocation
"""
module = AnsibleModule(
argument_spec=Vxlan_vtepArgs.argument_spec,
mutually_exclusive=[["config", "running_config"]],
required_if=[
["state", "merged", ["config"]],
["state", "replaced", ["config"]],
["state", "overridden", ["config"]],
["state", "rendered", ["config"]],
["state", "parsed", ["running_config"]],
],
supports_check_mode=True,
)
result = Vxlan_vtep(module).execute_module()
module.exit_json(**result)
if __name__ == "__main__":
main()
|
