summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_snmp_server.py
blob: 3b40344f7a9cc9d562f16622851418f1b3027e33 (plain)
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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
#!/usr/bin/python
# -*- coding: utf-8 -*-
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function


__metaclass__ = type

DOCUMENTATION = r"""
---
module: vyos_snmp_server
short_description: Manage SNMP server configuration on VyOS devices using REST API
description:
  - Manages SNMP server configuration on VyOS devices via the REST API.
  - Supports communities, listen addresses, contact/location/description,
    trap target, and SNMPv3 (engine ID, groups, users, views).
  - Uses REST API (C(connection=httpapi)) instead of CLI.
version_added: "1.0.0"
author: your_name (@yourhandle)
options:
  config:
    description: SNMP server configuration.
    type: dict
    suboptions:
      communities:
        description: SNMP community configuration.
        type: list
        elements: dict
        suboptions:
          name:
            description: Community name.
            type: str
            required: true
          clients:
            description: IP addresses of SNMP clients allowed to contact the system.
            type: list
            elements: str
          networks:
            description: Subnets of SNMP clients allowed to contact the system.
            type: list
            elements: str
          authorization_type:
            description: Authorization type (ro=read-only, rw=read-write).
            type: str
            choices: ['ro', 'rw']
      contact:
        description: Contact person for the system.
        type: str
      description:
        description: System description.
        type: str
      location:
        description: System location.
        type: str
      smux_peer:
        description: Register a subtree for SMUX-based processing.
        type: str
      trap_source:
        description: SNMP trap source address.
        type: str
      listen_addresses:
        description: IP addresses to listen for incoming SNMP requests.
        type: list
        elements: dict
        suboptions:
          address:
            description: IP address to listen on.
            type: str
            required: true
          port:
            description: UDP port (default 161).
            type: int
      trap_target:
        description: SNMP trap target.
        type: dict
        suboptions:
          address:
            description: IP address of the trap target host.
            type: str
          community:
            description: Community name to use for traps.
            type: str
          port:
            description: UDP port on the trap target host.
            type: int
      snmp_v3:
        description: SNMPv3 configuration.
        type: dict
        suboptions:
          engine_id:
            description: EngineID as a hex string.
            type: str
          groups:
            description: SNMPv3 group configuration.
            type: list
            elements: dict
            suboptions:
              group:
                description: Group name.
                type: str
                required: true
              mode:
                description: Access mode (ro=read-only, rw=read-write).
                type: str
                choices: ['ro', 'rw']
              seclevel:
                description: Minimum security level required for group members.
                type: str
                choices: ['auth', 'priv']
              view:
                description: View name the group has access to.
                type: str
          users:
            description: SNMPv3 user configuration.
            type: list
            elements: dict
            suboptions:
              user:
                description: Username.
                type: str
                required: true
              authentication:
                description: Authentication parameters for this user.
                type: dict
                suboptions:
                  type:
                    description: Authentication algorithm.
                    type: str
                  encrypted_key:
                    description: Encrypted authentication key (stored as encrypted-password on device).
                    type: str
                  plaintext_key:
                    description: Plaintext authentication key (device encrypts it).
                    type: str
              privacy:
                description: Privacy (encryption) parameters for this user.
                type: dict
                suboptions:
                  type:
                    description: Privacy algorithm.
                    type: str
                  encrypted_key:
                    description: Encrypted privacy key.
                    type: str
                  plaintext_key:
                    description: Plaintext privacy key (device encrypts it).
                    type: str
              group:
                description: Group this user belongs to.
                type: str
              mode:
                description: Access mode for this user.
                type: str
                choices: ['ro', 'rw']
              tsm_key:
                description: TSM fingerprint of the certificate mapped to this user.
                type: str
          trap_targets:
            description: SNMPv3 trap target configuration.
            type: list
            elements: dict
            suboptions:
              address:
                description: IP address of the SNMPv3 trap target.
                type: str
              port:
                description: UDP port on the trap target host.
                type: int
              protocol:
                description: Transport protocol for traps.
                type: str
                choices: ['tcp', 'udp']
              type:
                description: Trap type.
                type: str
                choices: ['inform', 'trap']
              authentication:
                description: Authentication parameters for trap target.
                type: dict
                suboptions:
                  type:
                    description: Authentication algorithm.
                    type: str
                  encrypted_key:
                    description: Encrypted authentication key.
                    type: str
                  plaintext_key:
                    description: Plaintext authentication key.
                    type: str
              privacy:
                description: Privacy parameters for trap target.
                type: dict
                suboptions:
                  type:
                    description: Privacy algorithm.
                    type: str
                  encrypted_key:
                    description: Encrypted privacy key.
                    type: str
                  plaintext_key:
                    description: Plaintext privacy key.
                    type: str
          views:
            description: SNMPv3 view configuration.
            type: list
            elements: dict
            suboptions:
              view:
                description: View name.
                type: str
                required: true
              oid:
                description: OID subtree included in this view.
                type: str
              exclude:
                description: OID subtree excluded from this view.
                type: str
              mask:
                description: OID mask for the view.
                type: str
  state:
    description:
      - Desired state of SNMP configuration.
    type: str
    default: merged
    choices:
      - merged
      - replaced
      - overridden
      - deleted
      - gathered
"""

EXAMPLES = r"""
- name: Merge SNMP configuration
  vyos.rest.vyos_snmp_server:
    config:
      communities:
        - name: switches
          authorization_type: rw
        - name: bridges
          clients:
            - 1.1.1.1
            - 12.1.1.10
      contact: admin2@ex.com
      listen_addresses:
        - address: 20.1.1.1
        - address: 100.1.2.1
          port: 33
      snmp_v3:
        users:
          - user: admin_user
            authentication:
              plaintext_key: abc1234567
              type: sha
            privacy:
              plaintext_key: abc1234567
              type: aes
    state: merged

- name: Delete all SNMP configuration
  vyos.rest.vyos_snmp_server:
    state: deleted

- name: Gather current SNMP configuration
  vyos.rest.vyos_snmp_server:
    state: gathered
"""

RETURN = r"""
before:
  description: SNMP configuration before this module ran.
  returned: when state is merged, replaced, overridden or deleted
  type: dict
after:
  description: SNMP configuration after this module ran.
  returned: when changed
  type: dict
commands:
  description: List of API command dicts sent to the device.
  returned: always
  type: list
gathered:
  description: Current SNMP configuration as structured data.
  returned: when state is gathered
  type: dict
saved:
  description: Whether the config was saved after changes.
  returned: when changes are applied
  type: bool
"""

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.vyos.rest.plugins.module_utils.vyos import VyOSModule


SNMP_BASE = ["service", "snmp"]

SCALAR_FIELDS = {
    "contact": "contact",
    "description": "description",
    "location": "location",
    "smux_peer": "smux-peer",
    "trap_source": "trap-source",
}


def to_list(value):
    if value is None:
        return []
    if isinstance(value, list):
        return value
    if isinstance(value, str):
        return [value]
    if isinstance(value, dict):
        return list(value.keys())
    return [str(value)]


def _cmd(op, path):
    return {"op": op, "path": path}


def _set(path):
    return _cmd("set", path)


def _delete(path):
    return _cmd("delete", path)


def _parse_communities(raw):
    if not raw or not isinstance(raw, dict):
        return []
    result = []
    for name, data in sorted(raw.items()):
        entry = {"name": name}
        if not isinstance(data, dict):
            result.append(entry)
            continue
        if "authorization" in data:
            entry["authorization_type"] = data["authorization"]
        if "client" in data:
            entry["clients"] = sorted(to_list(data["client"]))
        if "network" in data:
            entry["networks"] = sorted(to_list(data["network"]))
        result.append(entry)
    return result


def _parse_listen_addresses(raw):
    if not raw or not isinstance(raw, dict):
        return []
    result = []
    for addr, data in sorted(raw.items()):
        entry = {"address": addr}
        if isinstance(data, dict) and "port" in data:
            entry["port"] = int(data["port"])
        result.append(entry)
    return result


def _parse_trap_target(raw):
    if not raw:
        return None
    if isinstance(raw, str):
        return {"address": raw}
    entry = {}
    if "address" in raw:
        entry["address"] = raw["address"]
    if "community" in raw:
        entry["community"] = raw["community"]
    if "port" in raw:
        entry["port"] = int(raw["port"])
    return entry if entry else None


def _parse_v3_auth_privacy(raw, key):
    block = raw.get(key) if isinstance(raw, dict) else None
    if not block:
        return None
    result = {}
    if "type" in block:
        result["type"] = block["type"]
    if "encrypted-password" in block:
        result["encrypted_key"] = block["encrypted-password"]
    if "plaintext-key" in block:
        result["plaintext_key"] = block["plaintext-key"]
    return result if result else None


def _parse_v3_users(raw):
    if not raw or not isinstance(raw, dict):
        return []
    result = []
    for username, data in sorted(raw.items()):
        entry = {"user": username}
        auth = _parse_v3_auth_privacy(data, "auth")
        if auth:
            entry["authentication"] = auth
        priv = _parse_v3_auth_privacy(data, "privacy")
        if priv:
            entry["privacy"] = priv
        if isinstance(data, dict):
            if "group" in data:
                entry["group"] = data["group"]
            if "mode" in data:
                entry["mode"] = data["mode"]
            if "tsm-key" in data:
                entry["tsm_key"] = data["tsm-key"]
        result.append(entry)
    return result


def _parse_v3_groups(raw):
    if not raw or not isinstance(raw, dict):
        return []
    result = []
    for name, data in sorted(raw.items()):
        entry = {"group": name}
        if isinstance(data, dict):
            for key in ("mode", "seclevel", "view"):
                if key in data:
                    entry[key] = data[key]
        result.append(entry)
    return result


def _parse_v3_views(raw):
    if not raw or not isinstance(raw, dict):
        return []
    result = []
    for name, data in sorted(raw.items()):
        entry = {"view": name}
        if isinstance(data, dict) and "oid" in data:
            oid_data = data["oid"]
            if isinstance(oid_data, dict) and oid_data:
                entry["oid"] = str(list(oid_data.keys())[0])
            elif isinstance(oid_data, str):
                entry["oid"] = oid_data
        if isinstance(data, dict):
            if "exclude" in data:
                entry["exclude"] = data["exclude"]
            if "mask" in data:
                entry["mask"] = data["mask"]
        result.append(entry)
    return result


def _parse_v3_trap_targets(raw):
    if not raw or not isinstance(raw, dict):
        return []
    result = []
    for addr, data in sorted(raw.items()):
        entry = {"address": addr}
        if isinstance(data, dict):
            if "port" in data:
                entry["port"] = int(data["port"])
            if "protocol" in data:
                entry["protocol"] = data["protocol"]
            if "type" in data:
                entry["type"] = data["type"]
            auth = _parse_v3_auth_privacy(data, "auth")
            if auth:
                entry["authentication"] = auth
            priv = _parse_v3_auth_privacy(data, "privacy")
            if priv:
                entry["privacy"] = priv
        result.append(entry)
    return result


def parse_snmp_config(raw):
    if not raw or not isinstance(raw, dict):
        return {}
    result = {}
    for argspec_key, api_key in SCALAR_FIELDS.items():
        if api_key in raw:
            result[argspec_key] = raw[api_key]
    communities = _parse_communities(raw.get("community"))
    if communities:
        result["communities"] = communities
    listen = _parse_listen_addresses(raw.get("listen-address"))
    if listen:
        result["listen_addresses"] = listen
    trap = _parse_trap_target(raw.get("trap-target"))
    if trap:
        result["trap_target"] = trap
    v3_raw = raw.get("v3")
    if v3_raw and isinstance(v3_raw, dict):
        v3 = {}
        if "engineid" in v3_raw:
            v3["engine_id"] = v3_raw["engineid"]
        groups = _parse_v3_groups(v3_raw.get("group"))
        if groups:
            v3["groups"] = groups
        users = _parse_v3_users(v3_raw.get("user"))
        if users:
            v3["users"] = users
        views = _parse_v3_views(v3_raw.get("view"))
        if views:
            v3["views"] = views
        trap_targets = _parse_v3_trap_targets(v3_raw.get("trap-target"))
        if trap_targets:
            v3["trap_targets"] = trap_targets
        if v3:
            result["snmp_v3"] = v3
    return result


def get_running_config(vyos):
    try:
        raw = vyos.get_config(SNMP_BASE)
    except Exception as e:
        if "Configuration under specified path is empty" in str(e):
            return {}
        raise
    return parse_snmp_config(raw)


def _build_scalar_commands(want, have, state):
    cmds = []
    for argspec_key, api_key in SCALAR_FIELDS.items():
        want_val = want.get(argspec_key)
        have_val = have.get(argspec_key)
        path = SNMP_BASE + [api_key]
        if state in ("merged", "replaced", "overridden"):
            if want_val and want_val != have_val:
                cmds.append(_set(path + [want_val]))
        if state in ("replaced", "overridden"):
            if have_val and want_val != have_val:
                cmds.append(_delete(path))
    return cmds


def _build_community_commands(want_list, have_list, state):
    cmds = []
    want_map = {c["name"]: c for c in (want_list or [])}
    have_map = {c["name"]: c for c in (have_list or [])}
    if state in ("replaced", "overridden"):
        for name in have_map:
            if name not in want_map:
                cmds.append(_delete(SNMP_BASE + ["community", name]))
    for name, want_comm in want_map.items():
        have_comm = have_map.get(name, {})
        base = SNMP_BASE + ["community", name]
        want_auth = want_comm.get("authorization_type")
        have_auth = have_comm.get("authorization_type")
        if want_auth and want_auth != have_auth:
            cmds.append(_set(base + ["authorization", want_auth]))
        if state in ("replaced", "overridden") and have_auth and want_auth != have_auth:
            cmds.append(_delete(base + ["authorization"]))
        want_clients = set(want_comm.get("clients") or [])
        have_clients = set(have_comm.get("clients") or [])
        for c in want_clients - have_clients:
            cmds.append(_set(base + ["client", c]))
        if state in ("replaced", "overridden"):
            for c in have_clients - want_clients:
                cmds.append(_delete(base + ["client", c]))
        want_nets = set(want_comm.get("networks") or [])
        have_nets = set(have_comm.get("networks") or [])
        for n in want_nets - have_nets:
            cmds.append(_set(base + ["network", n]))
        if state in ("replaced", "overridden"):
            for n in have_nets - want_nets:
                cmds.append(_delete(base + ["network", n]))
    return cmds


def _build_listen_address_commands(want_list, have_list, state):
    cmds = []
    want_map = {e["address"]: e for e in (want_list or [])}
    have_map = {e["address"]: e for e in (have_list or [])}
    base = SNMP_BASE + ["listen-address"]
    if state in ("replaced", "overridden"):
        for addr in have_map:
            if addr not in want_map:
                cmds.append(_delete(base + [addr]))
    for addr, want_entry in want_map.items():
        have_entry = have_map.get(addr, {})
        want_port = want_entry.get("port")
        have_port = have_entry.get("port")
        if addr not in have_map:
            if want_port:
                cmds.append(_set(base + [addr, "port", str(want_port)]))
            else:
                cmds.append(_set(base + [addr]))
        elif want_port != have_port:
            cmds.append(_delete(base + [addr]))
            if want_port:
                cmds.append(_set(base + [addr, "port", str(want_port)]))
            else:
                cmds.append(_set(base + [addr]))
    return cmds


def _build_trap_target_commands(want, have, state):
    cmds = []
    base = SNMP_BASE + ["trap-target"]
    if state in ("merged", "replaced", "overridden"):
        if want:
            want_addr = want.get("address")
            have_addr = have.get("address") if have else None
            if want_addr and want_addr != have_addr:
                cmds.append(_set(base + [want_addr]))
            if want.get("community"):
                cmds.append(_set(base + [want_addr, "community", want["community"]]))
            if want.get("port"):
                cmds.append(_set(base + [want_addr, "port", str(want["port"])]))
    if state in ("replaced", "overridden"):
        if have and (not want or have.get("address") != (want or {}).get("address")):
            cmds.append(_delete(base))
    return cmds


def _build_v3_auth_privacy_commands(base, want_block, have_block, api_key):
    cmds = []
    if not want_block:
        return cmds
    block_base = base + [api_key]
    have_block = have_block or {}
    if want_block.get("type") and want_block["type"] != have_block.get("type"):
        cmds.append(_set(block_base + ["type", want_block["type"]]))
    if want_block.get("encrypted_key") and want_block["encrypted_key"] != have_block.get(
        "encrypted_key",
    ):
        cmds.append(_set(block_base + ["encrypted-password", want_block["encrypted_key"]]))
    if want_block.get("plaintext_key"):
        cmds.append(_set(block_base + ["plaintext-key", want_block["plaintext_key"]]))
    return cmds


def _build_v3_user_commands(want_list, have_list, state):
    cmds = []
    want_map = {u["user"]: u for u in (want_list or [])}
    have_map = {u["user"]: u for u in (have_list or [])}
    base = SNMP_BASE + ["v3", "user"]
    if state in ("replaced", "overridden"):
        for username in have_map:
            if username not in want_map:
                cmds.append(_delete(base + [username]))
    for username, want_user in want_map.items():
        have_user = have_map.get(username, {})
        user_base = base + [username]
        cmds += _build_v3_auth_privacy_commands(
            user_base,
            want_user.get("authentication"),
            have_user.get("authentication"),
            "auth",
        )
        cmds += _build_v3_auth_privacy_commands(
            user_base,
            want_user.get("privacy"),
            have_user.get("privacy"),
            "privacy",
        )
        if want_user.get("group") and want_user["group"] != have_user.get("group"):
            cmds.append(_set(user_base + ["group", want_user["group"]]))
        if want_user.get("mode") and want_user["mode"] != have_user.get("mode"):
            cmds.append(_set(user_base + ["mode", want_user["mode"]]))
        if want_user.get("tsm_key") and want_user["tsm_key"] != have_user.get("tsm_key"):
            cmds.append(_set(user_base + ["tsm-key", want_user["tsm_key"]]))
    return cmds


def _build_v3_group_commands(want_list, have_list, state):
    cmds = []
    want_map = {g["group"]: g for g in (want_list or [])}
    have_map = {g["group"]: g for g in (have_list or [])}
    base = SNMP_BASE + ["v3", "group"]
    if state in ("replaced", "overridden"):
        for name in have_map:
            if name not in want_map:
                cmds.append(_delete(base + [name]))
    for name, want_group in want_map.items():
        have_group = have_map.get(name, {})
        group_base = base + [name]
        for key, api_key in [("mode", "mode"), ("seclevel", "seclevel"), ("view", "view")]:
            want_val = want_group.get(key)
            have_val = have_group.get(key)
            if want_val and want_val != have_val:
                cmds.append(_set(group_base + [api_key, want_val]))
            if state in ("replaced", "overridden") and have_val and want_val != have_val:
                cmds.append(_delete(group_base + [api_key]))
    return cmds


def _build_v3_view_commands(want_list, have_list, state):
    cmds = []
    want_map = {v["view"]: v for v in (want_list or [])}
    have_map = {v["view"]: v for v in (have_list or [])}
    base = SNMP_BASE + ["v3", "view"]
    if state in ("replaced", "overridden"):
        for name in have_map:
            if name not in want_map:
                cmds.append(_delete(base + [name]))
    for name, want_view in want_map.items():
        have_view = have_map.get(name, {})
        view_base = base + [name]
        want_oid = str(want_view["oid"]) if want_view.get("oid") else None
        have_oid = str(have_view.get("oid")) if have_view.get("oid") else None
        if want_oid and want_oid != have_oid:
            cmds.append(_set(view_base + ["oid", want_oid]))
        if state in ("replaced", "overridden") and have_oid and want_oid != have_oid:
            cmds.append(_delete(view_base + ["oid", have_oid]))
        for key in ("exclude", "mask"):
            want_val = want_view.get(key)
            have_val = have_view.get(key)
            if want_val and want_val != have_val:
                cmds.append(_set(view_base + [key, want_val]))
    return cmds


def _build_v3_commands(want_v3, have_v3, state):
    cmds = []
    want_v3 = want_v3 or {}
    have_v3 = have_v3 or {}
    want_eid = want_v3.get("engine_id")
    have_eid = have_v3.get("engine_id")
    if want_eid and want_eid != have_eid:
        cmds.append(_set(SNMP_BASE + ["v3", "engineid", want_eid]))
    if state in ("replaced", "overridden") and have_eid and want_eid != have_eid:
        cmds.append(_delete(SNMP_BASE + ["v3", "engineid"]))
    cmds += _build_v3_group_commands(want_v3.get("groups"), have_v3.get("groups"), state)
    cmds += _build_v3_user_commands(want_v3.get("users"), have_v3.get("users"), state)
    cmds += _build_v3_view_commands(want_v3.get("views"), have_v3.get("views"), state)
    return cmds


def build_commands(want, have, state):
    if state == "deleted":
        if have:
            return [_delete(SNMP_BASE)]
        return []
    cmds = []
    cmds += _build_scalar_commands(want, have, state)
    cmds += _build_community_commands(want.get("communities"), have.get("communities"), state)
    cmds += _build_listen_address_commands(
        want.get("listen_addresses"),
        have.get("listen_addresses"),
        state,
    )
    cmds += _build_trap_target_commands(want.get("trap_target"), have.get("trap_target"), state)
    cmds += _build_v3_commands(want.get("snmp_v3"), have.get("snmp_v3"), state)
    return cmds


def _auth_privacy_spec():
    return dict(
        type=dict(type="str"),
        encrypted_key=dict(type="str", no_log=False),
        plaintext_key=dict(type="str", no_log=True),
    )


ARGUMENT_SPEC = dict(
    config=dict(
        type="dict",
        options=dict(
            communities=dict(
                type="list",
                elements="dict",
                options=dict(
                    name=dict(type="str", required=True),
                    clients=dict(type="list", elements="str"),
                    networks=dict(type="list", elements="str"),
                    authorization_type=dict(type="str", choices=["ro", "rw"]),
                ),
            ),
            contact=dict(type="str"),
            description=dict(type="str"),
            location=dict(type="str"),
            smux_peer=dict(type="str"),
            trap_source=dict(type="str"),
            listen_addresses=dict(
                type="list",
                elements="dict",
                options=dict(
                    address=dict(type="str", required=True),
                    port=dict(type="int"),
                ),
            ),
            trap_target=dict(
                type="dict",
                options=dict(
                    address=dict(type="str"),
                    community=dict(type="str"),
                    port=dict(type="int"),
                ),
            ),
            snmp_v3=dict(
                type="dict",
                options=dict(
                    engine_id=dict(type="str"),
                    groups=dict(
                        type="list",
                        elements="dict",
                        options=dict(
                            group=dict(type="str", required=True),
                            mode=dict(type="str", choices=["ro", "rw"]),
                            seclevel=dict(type="str", choices=["auth", "priv"]),
                            view=dict(type="str"),
                        ),
                    ),
                    users=dict(
                        type="list",
                        elements="dict",
                        options=dict(
                            user=dict(type="str", required=True),
                            authentication=dict(type="dict", options=_auth_privacy_spec()),
                            privacy=dict(type="dict", options=_auth_privacy_spec()),
                            group=dict(type="str"),
                            mode=dict(type="str", choices=["ro", "rw"]),
                            tsm_key=dict(type="str", no_log=True),
                        ),
                    ),
                    trap_targets=dict(
                        type="list",
                        elements="dict",
                        options=dict(
                            address=dict(type="str"),
                            port=dict(type="int"),
                            protocol=dict(type="str", choices=["tcp", "udp"]),
                            type=dict(type="str", choices=["inform", "trap"]),
                            authentication=dict(type="dict", options=_auth_privacy_spec()),
                            privacy=dict(type="dict", options=_auth_privacy_spec()),
                        ),
                    ),
                    views=dict(
                        type="list",
                        elements="dict",
                        options=dict(
                            view=dict(type="str", required=True),
                            oid=dict(type="str"),
                            exclude=dict(type="str"),
                            mask=dict(type="str"),
                        ),
                    ),
                ),
            ),
        ),
    ),
    state=dict(
        type="str",
        default="merged",
        choices=["merged", "replaced", "overridden", "deleted", "gathered"],
    ),
)


def main():
    module = AnsibleModule(argument_spec=ARGUMENT_SPEC, supports_check_mode=True)
    vyos = VyOSModule(module)
    state = module.params["state"]
    config = module.params.get("config") or {}

    have = get_running_config(vyos)

    if state == "gathered":
        module.exit_json(changed=False, gathered=have)

    want = config
    commands = build_commands(want, have, state)

    if module.check_mode:
        module.exit_json(changed=bool(commands), commands=commands, before=have)

    if commands:
        response = vyos.apply_commands(commands)
        saved = vyos.save_config()
        module.exit_json(
            changed=True,
            before=have,
            after=want,
            commands=commands,
            saved=saved,
            response=response,
        )

    module.exit_json(changed=False, before=have, after=have, commands=[])


if __name__ == "__main__":
    main()