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
|
#!/usr/bin/python
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = '''
---
module: ce_netstream_template
version_added: "2.4"
short_description: Manages NetStream template configuration on HUAWEI CloudEngine switches.
description:
- Manages NetStream template configuration on HUAWEI CloudEngine switches.
author:
- wangdezhuang (@QijunPan)
options:
state:
description:
- Specify desired state of the resource.
default: present
choices: ['present', 'absent']
type:
description:
- Configure the type of netstream record.
required: true
choices: ['ip', 'vxlan']
record_name:
description:
- Configure the name of netstream record.
The value is a string of 1 to 32 case-insensitive characters.
match:
description:
- Configure flexible flow statistics template keywords.
choices: ['destination-address', 'destination-port', 'tos', 'protocol', 'source-address', 'source-port']
collect_counter:
description:
- Configure the number of packets and bytes that are included in the flexible flow statistics sent to NSC.
choices: ['bytes', 'packets']
collect_interface:
description:
- Configure the input or output interface that are included in the flexible flow statistics sent to NSC.
choices: ['input', 'output']
description:
description:
- Configure the description of netstream record.
The value is a string of 1 to 80 case-insensitive characters.
'''
EXAMPLES = '''
- name: netstream template module test
hosts: cloudengine
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: Config ipv4 netstream record
ce_netstream_template:
state: present
type: ip
record_name: test
provider: "{{ cli }}"
- name: Undo ipv4 netstream record
ce_netstream_template:
state: absent
type: ip
record_name: test
provider: "{{ cli }}"
- name: Config ipv4 netstream record collect_counter
ce_netstream_template:
state: present
type: ip
record_name: test
collect_counter: bytes
provider: "{{ cli }}"
- name: Undo ipv4 netstream record collect_counter
ce_netstream_template:
state: absent
type: ip
record_name: test
collect_counter: bytes
provider: "{{ cli }}"
'''
RETURN = '''
changed:
description: check to see if a change was made on the device
returned: always
type: bool
sample: true
proposed:
description: k/v pairs of parameters passed into module
returned: always
type: dict
sample: {"record_name": "test",
"type": "ip",
"state": "present"}
existing:
description: k/v pairs of existing aaa server
returned: always
type: dict
sample: {}
end_state:
description: k/v pairs of aaa params after module execution
returned: always
type: dict
sample: {"record_name": "test",
"type": "ip"}
updates:
description: command sent to the device
returned: always
type: list
sample: ["netstream record test ip"]
'''
import re
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.network.cloudengine.ce import load_config
from ansible.module_utils.network.cloudengine.ce import get_connection, rm_config_prefix
from ansible.module_utils.network.cloudengine.ce import ce_argument_spec
def get_config(module, flags):
"""Retrieves the current config from the device or cache
"""
flags = [] if flags is None else flags
if isinstance(flags, str):
flags = [flags]
elif not isinstance(flags, list):
flags = []
cmd = 'display current-configuration '
cmd += ' '.join(flags)
cmd = cmd.strip()
conn = get_connection(module)
rc, out, err = conn.exec_command(cmd)
if rc != 0:
module.fail_json(msg=err)
cfg = str(out).strip()
# remove default configuration prefix '~'
for flag in flags:
if "include-default" in flag:
cfg = rm_config_prefix(cfg)
break
if cfg.startswith('display'):
lines = cfg.split('\n')
if len(lines) > 1:
return '\n'.join(lines[1:])
else:
return ''
return cfg
class NetstreamTemplate(object):
""" Manages netstream template configuration """
def __init__(self, **kwargs):
""" Netstream template module init """
# module
argument_spec = kwargs["argument_spec"]
self.spec = argument_spec
self.module = AnsibleModule(argument_spec=self.spec, supports_check_mode=True)
# netstream config
self.netstream_cfg = None
# module args
self.state = self.module.params['state'] or None
self.type = self.module.params['type'] or None
self.record_name = self.module.params['record_name'] or None
self.match = self.module.params['match'] or None
self.collect_counter = self.module.params['collect_counter'] or None
self.collect_interface = self.module.params['collect_interface'] or None
self.description = self.module.params['description'] or None
# state
self.changed = False
self.updates_cmd = list()
self.results = dict()
self.proposed = dict()
self.existing = dict()
self.end_state = dict()
def cli_load_config(self, commands):
""" Cli load configuration """
if not self.module.check_mode:
load_config(self.module, commands)
def cli_get_netstream_config(self):
""" Cli get netstream configuration """
if self.type == "ip":
cmd = "netstream record %s ip" % self.record_name
else:
cmd = "netstream record %s vxlan inner-ip" % self.record_name
flags = list()
regular = "| section include %s" % cmd
flags.append(regular)
self.netstream_cfg = get_config(self.module, flags)
def check_args(self):
""" Check module args """
if not self.type or not self.record_name:
self.module.fail_json(
msg='Error: Please input type and record_name.')
if self.record_name:
if len(self.record_name) < 1 or len(self.record_name) > 32:
self.module.fail_json(
msg='Error: The len of record_name is out of [1 - 32].')
if self.description:
if len(self.description) < 1 or len(self.description) > 80:
self.module.fail_json(
msg='Error: The len of description is out of [1 - 80].')
def get_proposed(self):
""" Get module proposed """
self.proposed["state"] = self.state
if self.type:
self.proposed["type"] = self.type
if self.record_name:
self.proposed["record_name"] = self.record_name
if self.match:
self.proposed["match"] = self.match
if self.collect_counter:
self.proposed["collect_counter"] = self.collect_counter
if self.collect_interface:
self.proposed["collect_interface"] = self.collect_interface
if self.description:
self.proposed["description"] = self.description
def get_existing(self):
""" Get existing configuration """
self.cli_get_netstream_config()
if self.netstream_cfg:
self.existing["type"] = self.type
self.existing["record_name"] = self.record_name
if self.description:
tmp_value = re.findall(r'description (.*)', self.netstream_cfg)
if tmp_value:
self.existing["description"] = tmp_value[0]
if self.match:
if self.type == "ip":
tmp_value = re.findall(r'match ip (.*)', self.netstream_cfg)
else:
tmp_value = re.findall(r'match inner-ip (.*)', self.netstream_cfg)
if tmp_value:
self.existing["match"] = tmp_value
if self.collect_counter:
tmp_value = re.findall(r'collect counter (.*)', self.netstream_cfg)
if tmp_value:
self.existing["collect_counter"] = tmp_value
if self.collect_interface:
tmp_value = re.findall(r'collect interface (.*)', self.netstream_cfg)
if tmp_value:
self.existing["collect_interface"] = tmp_value
def get_end_state(self):
""" Get end state """
self.cli_get_netstream_config()
if self.netstream_cfg:
self.end_state["type"] = self.type
self.end_state["record_name"] = self.record_name
if self.description:
tmp_value = re.findall(r'description (.*)', self.netstream_cfg)
if tmp_value:
self.end_state["description"] = tmp_value[0]
if self.match:
if self.type == "ip":
tmp_value = re.findall(r'match ip (.*)', self.netstream_cfg)
else:
tmp_value = re.findall(r'match inner-ip (.*)', self.netstream_cfg)
if tmp_value:
self.end_state["match"] = tmp_value
if self.collect_counter:
tmp_value = re.findall(r'collect counter (.*)', self.netstream_cfg)
if tmp_value:
self.end_state["collect_counter"] = tmp_value
if self.collect_interface:
tmp_value = re.findall(r'collect interface (.*)', self.netstream_cfg)
if tmp_value:
self.end_state["collect_interface"] = tmp_value
if self.end_state == self.existing:
self.changed = False
self.updates_cmd = list()
def present_netstream(self):
""" Present netstream configuration """
cmds = list()
need_create_record = False
if self.type == "ip":
cmd = "netstream record %s ip" % self.record_name
else:
cmd = "netstream record %s vxlan inner-ip" % self.record_name
cmds.append(cmd)
if not self.netstream_cfg:
self.updates_cmd.append(cmd)
need_create_record = True
if self.description:
cmd = "description %s" % self.description.strip()
if not self.netstream_cfg or cmd not in self.netstream_cfg:
cmds.append(cmd)
self.updates_cmd.append(cmd)
if self.match:
if self.type == "ip":
cmd = "match ip %s" % self.match
cfg = "match ip"
else:
cmd = "match inner-ip %s" % self.match
cfg = "match inner-ip"
if not self.netstream_cfg or cfg not in self.netstream_cfg or self.match != self.existing["match"][0]:
cmds.append(cmd)
self.updates_cmd.append(cmd)
if self.collect_counter:
cmd = "collect counter %s" % self.collect_counter
if not self.netstream_cfg or cmd not in self.netstream_cfg:
cmds.append(cmd)
self.updates_cmd.append(cmd)
if self.collect_interface:
cmd = "collect interface %s" % self.collect_interface
if not self.netstream_cfg or cmd not in self.netstream_cfg:
cmds.append(cmd)
self.updates_cmd.append(cmd)
if not need_create_record and len(cmds) == 1:
if self.type == "ip":
cmd = "netstream record %s ip" % self.record_name
else:
cmd = "netstream record %s vxlan inner-ip" % self.record_name
cmds.remove(cmd)
if cmds:
self.cli_load_config(cmds)
self.changed = True
def absent_netstream(self):
""" Absent netstream configuration """
cmds = list()
absent_netstream_attr = False
if not self.netstream_cfg:
return
if self.description or self.match or self.collect_counter or self.collect_interface:
absent_netstream_attr = True
if absent_netstream_attr:
if self.type == "ip":
cmd = "netstream record %s ip" % self.record_name
else:
cmd = "netstream record %s vxlan inner-ip" % self.record_name
cmds.append(cmd)
if self.description:
cfg = "description %s" % self.description
if self.netstream_cfg and cfg in self.netstream_cfg:
cmd = "undo description %s" % self.description
cmds.append(cmd)
self.updates_cmd.append(cmd)
if self.match:
if self.type == "ip":
cfg = "match ip %s" % self.match
else:
cfg = "match inner-ip %s" % self.match
if self.netstream_cfg and cfg in self.netstream_cfg:
if self.type == "ip":
cmd = "undo match ip %s" % self.match
else:
cmd = "undo match inner-ip %s" % self.match
cmds.append(cmd)
self.updates_cmd.append(cmd)
if self.collect_counter:
cfg = "collect counter %s" % self.collect_counter
if self.netstream_cfg and cfg in self.netstream_cfg:
cmd = "undo collect counter %s" % self.collect_counter
cmds.append(cmd)
self.updates_cmd.append(cmd)
if self.collect_interface:
cfg = "collect interface %s" % self.collect_interface
if self.netstream_cfg and cfg in self.netstream_cfg:
cmd = "undo collect interface %s" % self.collect_interface
cmds.append(cmd)
self.updates_cmd.append(cmd)
if len(cmds) > 1:
self.cli_load_config(cmds)
self.changed = True
else:
if self.type == "ip":
cmd = "undo netstream record %s ip" % self.record_name
else:
cmd = "undo netstream record %s vxlan inner-ip" % self.record_name
cmds.append(cmd)
self.updates_cmd.append(cmd)
self.cli_load_config(cmds)
self.changed = True
def work(self):
""" Work function """
self.check_args()
self.get_proposed()
self.get_existing()
if self.state == "present":
self.present_netstream()
else:
self.absent_netstream()
self.get_end_state()
self.results['changed'] = self.changed
self.results['proposed'] = self.proposed
self.results['existing'] = self.existing
self.results['end_state'] = self.end_state
self.results['updates'] = self.updates_cmd
self.module.exit_json(**self.results)
def main():
""" Module main """
argument_spec = dict(
state=dict(choices=['present', 'absent'], default='present'),
type=dict(choices=['ip', 'vxlan'], required=True),
record_name=dict(type='str'),
match=dict(choices=['destination-address', 'destination-port',
'tos', 'protocol', 'source-address', 'source-port']),
collect_counter=dict(choices=['bytes', 'packets']),
collect_interface=dict(choices=['input', 'output']),
description=dict(type='str')
)
argument_spec.update(ce_argument_spec)
module = NetstreamTemplate(argument_spec=argument_spec)
module.work()
if __name__ == '__main__':
main()
|