snmp: T4124: migrate to get_config_dict()

6 files changed, 127 insertions, 57 deletions

diff --git a/data/configd-include.json b/data/configd-include.json
index ee4cb0d42..9090cb201 100644
--- a/data/configd-include.json
+++ b/data/configd-include.json
@@ -54,6 +54,7 @@
 "service_mdns-repeater.py",
 "service_pppoe-server.py",
 "service_router-advert.py",
+"snmp.py",
 "ssh.py",
 "system-ip.py",
 "system-ipv6.py",
diff --git a/data/templates/snmp/etc.snmp.conf.tmpl b/data/templates/snmp/etc.snmp.conf.tmpl
index 6e4c6f063..f7d9a3c17 100644
--- a/data/templates/snmp/etc.snmp.conf.tmpl
+++ b/data/templates/snmp/etc.snmp.conf.tmpl
@@ -1,4 +1,4 @@
 ### Autogenerated by snmp.py ###
-{% if trap_source %}
+{% if trap_source is defined and trap_source is not none %}
 clientaddr {{ trap_source }}
 {% endif %}
diff --git a/data/templates/snmp/etc.snmpd.conf.tmpl b/data/templates/snmp/etc.snmpd.conf.tmpl
index 30806ce8a..befea0122 100644
--- a/data/templates/snmp/etc.snmpd.conf.tmpl
+++ b/data/templates/snmp/etc.snmpd.conf.tmpl
@@ -33,87 +33,152 @@ interface_replace_old yes
 # Default system description is VyOS version
 sysDescr VyOS {{ version }}
 
-{% if description %}
+{% if description is defined and description is not none %}
 # Description
 SysDescr {{ description }}
 {% endif %}
 
 # Listen
-agentaddress unix:/run/snmpd.socket{% if listen_on %}{% for li in listen_on %},{{ li }}{% endfor %}{% else %},{{protocol}}:161{% if ipv6_enabled %},{{protocol}}6:161{% endif %}{% endif %}
+{% set options = [] %}
+{% if listen_address is defined and listen_address is not none  %}
+{%   for address, address_options in listen_address.items() %}
+{%     if address | is_ipv6 %}
+{%       set protocol = protocol ~ '6' %}
+{%     endif %}
+{%     set _ = options.append(protocol ~ ':' ~ address | bracketize_ipv6 ~ ':' ~ address_options.port) %}
+{%   endfor %}
+{% else %}
+{%   set _ = options.append(protocol ~ ':161') %}
+{%   if ipv6_disabled is not defined %}
+{%     set _ = options.append(protocol ~ '6:161') %}
+{%   endif %}
+{% endif %}
+agentaddress unix:/run/snmpd.socket{{ ',' ~ options | join(',') if options is defined and options is not none }}
 
 # SNMP communities
-{% for c in communities %}
-{%   if c.network_v4 %}
-{%     for network in c.network_v4 %}
-{{ c.authorization }}community {{ c.name }} {{ network }}
-{%     endfor %}
-{%   elif not c.has_source %}
-{{ c.authorization }}community {{ c.name }}
-{%   endif %}
-{%   if c.network_v6 %}
-{%     for network in c.network_v6 %}
-{{ c.authorization }}community6 {{ c.name }} {{ network }}
-{%     endfor %}
-{%   elif not c.has_source %}
-{{ c.authorization }}community6 {{ c.name }}
-{%   endif %}
-{% endfor %}
+{% if community is defined and community is not none %}
+{%   for comm, comm_config in community.items() %}
+{%     if comm_config.client is defined and comm_config.client is not none %}
+{%       for client in comm_config.client %}
+{%         if client | is_ipv4 %}
+{{ comm_config.authorization }}community {{ comm }} {{ client }}
+{%         elif client | is_ipv6 %}
+{{ comm_config.authorization }}community6 {{ comm }} {{ client }}
+{%         endif %}
+{%       endfor %}
+{%     endif %}
+{%     if comm_config.network is defined and comm_config.network is not none %}
+{%       for network in comm_config.network %}
+{%         if network | is_ipv4 %}
+{{ comm_config.authorization }}community {{ comm }} {{ network }}
+{%         elif client | is_ipv6 %}
+{{ comm_config.authorization }}community6 {{ comm }} {{ network }}
+{%         endif %}
+{%       endfor %}
+{%     endif %}
+{%     if comm_config.client is not defined and comm_config.network is not defined %}
+{{ comm_config.authorization }}community {{ comm }}
+{%     endif %}
+{%   endfor %}
+{% endif %}
 
-{% if contact %}
+{% if contact is defined and contact is not none %}
 # system contact information
 SysContact {{ contact }}
 {% endif %}
 
-{% if location %}
+{% if location is defined and location is not none %}
 # system location information
 SysLocation {{ location }}
 {% endif %}
 
-{% if smux_peers %}
+{% if smux_peer is defined and smux_peer is not none %}
 # additional smux peers
-{%   for sp in smux_peers %}
-smuxpeer {{ sp }}
+{%   for peer in smux_peer %}
+smuxpeer {{ peer }}
 {%   endfor %}
 {% endif %}
 
-{% if trap_targets %}
+{% if trap_target is defined and trap_target is not none %}
 # if there is a problem - tell someone!
-{%   for trap in trap_targets %}
-trap2sink {{ trap.target }}{{ ":" + trap.port if trap.port is defined }} {{ trap.community }}
+{%   for trap, trap_config in trap_target.items() %}
+trap2sink {{ trap }}:{{ trap_config.port }} {{ trap_config.community }}
 {%   endfor %}
 {% endif %}
 
-{% if v3_enabled %}
+{% if v3 is defined and v3 is not none %}
 #
 # SNMPv3 stuff goes here
 #
+{%   if v3.view is defined and v3.view is not none %}
 # views
-{%   for view in v3_views %}
-{%     for oid in view.oids %}
-view {{ view.name }} included .{{ oid.oid }}
+{%     for view, view_config in v3.view.items() %}
+{%       if view_config.oid is defined and view_config.oid is not none %}
+{%         for oid in view_config.oid %}
+view {{ view }} included .{{ oid }}
+{%         endfor %}
+{%       endif %}
 {%     endfor %}
-{%   endfor %}
+{%   endif %}
 
 # access
+{%   if v3.group is defined and v3.group is not none %}
 #             context sec.model sec.level match  read    write  notif
-{%   for group in v3_groups %}
-access {{ group.name }} "" usm {{ group.seclevel }} exact {{ group.view }} {% if group.mode == 'ro' %}none{% else %}{{ group.view }}{% endif %} none
-{%   endfor %}
+{%     for group, group_config in v3.group.items() %}
+access {{ group }} "" usm {{ group_config.seclevel }} exact {{ group_config.view }} {% if group_config.mode == 'ro' %}none{% else %}{{ group_config.view }}{% endif %} none
+{%     endfor %}
+{%   endif %}
 
 # trap-target
-{%   for t in v3_traps %}
-trapsess -v 3 {{ '-Ci' if t.type == 'inform' }} -e {{ v3_engineid }} -u {{ t.secName }} -l {{ t.secLevel }} -a {{ t.authProtocol }} {% if t.authPassword %}-A {{ t.authPassword }}{% elif t.authMasterKey %}-3m {{ t.authMasterKey }}{% endif %} -x {{ t.privProtocol }} {% if t.privPassword %}-X {{ t.privPassword }}{% elif t.privMasterKey %}-3M {{ t.privMasterKey }}{% endif %} {{ t.ipProto }}:{{ t.ipAddr }}:{{ t.ipPort }}
-{%   endfor %}
+{%   if v3.trap_target is defined and v3.trap_target is not none %}
+{%     for trap, trap_config in v3.trap_target.items() %}
+{%       set options = '' %}
+{%       if trap_config.type == 'inform' %}
+{%         set options = options ~ ' -Ci' %}
+{%       endif %}
+{%       if v3.engineid is defined and v3.engineid is not none %}
+{%         set options = options ~ ' -e "' ~ v3.engineid ~ '"' %}
+{%       endif %}
+{%       if trap_config.user is defined and trap_config.user is not none %}
+{%         set options = options ~ ' -u ' ~ trap_config.user %}
+{%       endif %}
+{%       if trap_config.auth is defined and trap_config.auth.plaintext_password is defined or trap_config.auth.encrypted_password is defined %}
+{%         set options = options ~ ' -a ' ~ trap_config.auth.type %}
+{%         if trap_config.auth.plaintext_password is defined and trap_config.auth.plaintext_password is not none %}
+{%           set options = options ~ ' -A ' ~ trap_config.auth.plaintext_password %}
+{%         elif trap_config.auth.encrypted_password is defined and trap_config.auth.encrypted_password is not none %}
+{%           set options = options ~ ' -3m ' ~ trap_config.auth.encrypted_password %}
+{%         endif %}
+{%         if trap_config.privacy is defined and trap_config.privacy.plaintext_password is defined or trap_config.privacy.encrypted_password is defined %}
+{%           set options = options ~ ' -x ' ~ trap_config.privacy.type %}
+{%           if trap_config.privacy.plaintext_password is defined and trap_config.privacy.plaintext_password is not none %}
+{%             set options = options ~ ' -X ' ~ trap_config.privacy.plaintext_password %}
+{%           elif trap_config.privacy.encrypted_password is defined and trap_config.privacy.encrypted_password is not none %}
+{%             set options = options ~ ' -3M ' ~ trap_config.privacy.encrypted_password %}
+{%           endif %}
+{%           set options = options ~ ' -l authPriv' %}
+{%         else %}
+{%           set options = options ~ ' -l authNoPriv' %}
+{%         endif %}
+{%       else %}
+{%         set options = options ~ ' -l noAuthNoPriv' %}
+{%       endif %}
+trapsess -v 3 {{ options }} {{ trap }}:{{ trap_config.protocol }}:{{ trap_config.port }}
+{%     endfor %}
+{%   endif %}
 
 # group
-{%   for u in v3_users %}
-group {{ u.group }} usm {{ u.name }}
-{%   endfor %}
+{%   if v3.user is defined and v3.user is not none %}
+{%     for user, user_config in v3.user.items() %}
+group {{ user_config.group }} usm {{ user }}
+{%     endfor %}
+{%   endif %}
+{# SNMPv3 end #}
 {% endif %}
 
-{% if script_ext %}
+{% if script_extensions is defined and script_extensions.extension_name is defined and script_extensions.extension_name is not none %}
 # extension scripts
-{%   for ext in script_ext|sort(attribute='name') %}
-extend {{ ext.name }} {{ ext.script }}
+{%   for script, script_config in script_extensions.extension_name.items() | sort(attribute=script) %}
+extend {{ script }} {{ script_config.script }}
 {%   endfor %}
 {% endif %}
diff --git a/data/templates/snmp/override.conf.tmpl b/data/templates/snmp/override.conf.tmpl
index 2ac45a89f..3b00aab83 100644
--- a/data/templates/snmp/override.conf.tmpl
+++ b/data/templates/snmp/override.conf.tmpl
@@ -1,5 +1,5 @@
 {% set vrf_command = 'ip vrf exec ' + vrf + ' ' if vrf is defined else '' %}
-{% set oid_route_table = ' ' if route_table is sameas true else '-I -ipCidrRouteTable,inetCidrRouteTable' %}
+{% set oid_route_table = ' ' if oid_enable is defined and oid_enable == 'route-table' else '-I -ipCidrRouteTable,inetCidrRouteTable' %}
 [Unit]
 StartLimitIntervalSec=0
 After=vyos-router.service
diff --git a/data/templates/snmp/usr.snmpd.conf.tmpl b/data/templates/snmp/usr.snmpd.conf.tmpl
index e2c5ec102..1c688a61e 100644
--- a/data/templates/snmp/usr.snmpd.conf.tmpl
+++ b/data/templates/snmp/usr.snmpd.conf.tmpl
@@ -1,6 +1,8 @@
 ### Autogenerated by snmp.py ###
-{% for u in v3_users %}
-{{ u.mode }}user {{ u.name }}
-{% endfor %}
+{%   if v3 is defined and v3.user is defined and v3.user is not none %}
+{%     for user, user_config in v3.user.items() %}
+{{ user_config.mode }}user {{ user }}
+{%     endfor %}
+{%   endif %}
 
 rwuser {{ vyos_user }}
diff --git a/data/templates/snmp/var.snmpd.conf.tmpl b/data/templates/snmp/var.snmpd.conf.tmpl
index c779587df..5871a8234 100644
--- a/data/templates/snmp/var.snmpd.conf.tmpl
+++ b/data/templates/snmp/var.snmpd.conf.tmpl
@@ -1,14 +1,16 @@
 ### Autogenerated by snmp.py ###
 # user
-{% for u in v3_users %}
-{% if u.authOID == 'none' %}
-createUser {{ u.name }}
-{% else %}
-usmUser 1 3 0x{{ v3_engineid }} "{{ u.name }}" "{{ u.name }}" NULL {{ u.authOID }} 0x{{ u.authMasterKey }} {{ u.privOID }} 0x{{ u.privMasterKey }} 0x
-{% endif %}
-{% endfor %}
+{% if v3 is defined and v3 is not none %}
+{%   if v3.user is defined and v3.user is not none %}
+{%     for user, user_config in v3.user.items() %}
+usmUser 1 3 0x{{ v3.engineid }} "{{ user }}" "{{ user }}" NULL {{ user_config.auth.type | snmp_auth_oid }} 0x{{ user_config.auth.encrypted_password }} {{ user_config.privacy.type | snmp_auth_oid }} 0x{{ user_config.privacy.encrypted_password }} 0x
+{%     endfor %}
+{%   endif %}
 
+# VyOS default user
 createUser {{ vyos_user }} MD5 "{{ vyos_user_pass }}" DES
-{% if v3_engineid %}
-oldEngineID 0x{{ v3_engineid }}
+
+{%   if v3.engineid is defined and v3.engineid is not none %}
+oldEngineID 0x{{ v3.engineid }}
+{%   endif %}
 {% endif %}