Add net_id support to config_template (#42446)

- Added net_id support to config_template
- Changed integration test to use blocks to cleanup on failure

lib/ansible/modules/network/meraki/meraki_config_template.py

@@ -44,6 +44,9 @@ options:
     net_name:
         description:
         - Name of the network to bind or unbind configuration template to.
+    net_id:
+        description:
+        - ID of the network to bind or unbind configuration template to.
     auto_bind:
         description:
         - Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model.
@@ -95,9 +98,9 @@ def get_template_id(meraki, name, data):
     meraki.fail_json(msg='No configuration template named {0} found'.format(name))
 
 
-def is_network_bound(meraki, nets, net_name, template_id):
+def is_network_bound(meraki, nets, net_id, template_id):
     for net in nets:
-        if net['name'] == net_name:
+        if net['id'] == net_id:
             try:
                 if net['configTemplateId'] == template_id:
                     return True
@@ -116,12 +119,9 @@ def delete_template(meraki, org_id, name, data):
     return response
 
 
-def bind(meraki, org_name, net_name, name, data):
+def bind(meraki, org_name, net_id, nets, name, data):
     template_id = get_template_id(meraki, name, data)
-    nets = meraki.get_nets(org_name=org_name)
+    if is_network_bound(meraki, nets, net_id, template_id) is False:
-    # meraki.fail_json(msg='Nets', nets=nets)
-    if is_network_bound(meraki, nets, net_name, template_id) is False:
-        net_id = meraki.get_net_id(net_name=net_name, data=nets)
         path = meraki.construct_path('bind', function='config_template', net_id=net_id)
         payload = dict()
         payload['configTemplateId'] = template_id
@@ -134,11 +134,9 @@ def bind(meraki, org_name, net_name, name, data):
         return r
 
 
-def unbind(meraki, org_name, net_name, name, data):
+def unbind(meraki, org_name, net_id, nets, name, data):
     template_id = get_template_id(meraki, name, data)
-    nets = meraki.get_nets(org_name=org_name)
+    if is_network_bound(meraki, nets, net_id, template_id) is True:
-    net_id = meraki.get_net_id(net_name=net_name, data=nets)
-    if is_network_bound(meraki, nets, net_name, template_id) is True:
         path = meraki.construct_path('unbind', function='config_template', net_id=net_id)
         meraki.result['changed'] = True
         r = meraki.request(path, method='POST')
@@ -157,6 +155,7 @@ def main():
                          org_id=dict(type='int'),
                          config_template=dict(type='str', aliases=['name']),
                          net_name=dict(type='str'),
+                         net_id=dict(type='str'),
                          # config_template_id=dict(type='str', aliases=['id']),
                          auto_bind=dict(type='bool'),
                          )
@@ -210,9 +209,12 @@ def main():
     # manipulate or modify the state as needed (this is going to be the
     # part where your module will do what it needs to do)
     org_id = meraki.params['org_id']
-
     if meraki.params['org_name']:
         org_id = meraki.get_org_id(meraki.params['org_name'])
+    net_id = meraki.params['net_id']
+    nets = meraki.get_nets(org_id=org_id)
+    if meraki.params['net_name']:
+        net_id = meraki.get_net_id(net_name=meraki.params['net_name'], data=nets)
 
     if meraki.params['state'] == 'query':
         meraki.result['data'] = get_config_templates(meraki, org_id)
@@ -220,7 +222,8 @@ def main():
         if meraki.params['net_name']:
             template_bind = bind(meraki,
                                  meraki.params['org_name'],
-                                 meraki.params['net_name'],
+                                 net_id,
+                                 nets,
                                  meraki.params['config_template'],
                                  get_config_templates(meraki, org_id))
     elif meraki.params['state'] == 'absent':
@@ -232,7 +235,8 @@ def main():
         else:
             config_unbind = unbind(meraki,
                                    meraki.params['org_name'],
-                                   meraki.params['net_name'],
+                                   net_id,
+                                   nets,
                                    meraki.params['config_template'],
                                    get_config_templates(meraki, org_id))
 

test/integration/targets/meraki_config_template/tasks/main.yml

@@ -3,26 +3,27 @@
 
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 ---
-# - name: Test an API key is provided
+- block:
-#   fail:
+  - name: Test an API key is provided
-#     msg: Please define an API key
+    fail:
-#   when: auth_key is not defined
+      msg: Please define an API key
+    when: auth_key is not defined
     
-# - name: Use an invalid domain
+  - name: Use an invalid domain
-#   meraki_config_template:
+    meraki_config_template:
-#     auth_key: '{{ auth_key }}'
+      auth_key: '{{ auth_key }}'
-#     host: marrrraki.com
+      host: marrrraki.com
-#     state: query
+      state: query
-#     org_name: DevTestOrg
+      org_name: DevTestOrg
-#     output_level: debug
+      output_level: debug
-#   delegate_to: localhost
+    delegate_to: localhost
-#   register: invalid_domain
+    register: invalid_domain
-#   ignore_errors: yes
+    ignore_errors: yes
 
-# - name: Connection assertions
+  - name: Connection assertions
-#   assert:
+    assert:
-#     that:
+      that:
-#       - '"Failed to connect to" in invalid_domain.msg'
+        - '"Failed to connect to" in invalid_domain.msg'
 
   - name: Query all configuration templates
     meraki_config_template:
@@ -40,9 +41,6 @@
     register: deleted
     ignore_errors: yes
 
-- debug:
-    msg: '{{deleted}}'
-
   - assert:
       that:
         - '"No configuration template named" in deleted.msg'
@@ -79,9 +77,6 @@
     register: bind_invalid
     ignore_errors: yes
 
-- debug:
-    msg: '{{bind_invalid}}'
-
   - assert:
       that:
         - bind_invalid.changed == False
@@ -112,6 +107,7 @@
       that:
         unbind_invalid.changed == False
 
+  always:
   - name: Delete network
     meraki_network:
       auth_key: '{{auth_key}}'