[minor_change] Add loopback interface profile as a child class for ac…

plugins/modules/aci_l3out_logical_node.py

@@ -49,6 +49,12 @@
     type: str
     choices: [ 'yes', 'no' ]
     default: 'yes'
+  loopback_address:
+    description:
+    - The loopback IP address.
+    - an empty string removes a configured loopback.
+    type: str
+    aliases: [ loopback ]
   state:
     description:
     - Use C(present) or C(absent) for adding or removing.
@@ -243,6 +249,7 @@ def main():
         node_id=dict(type="int"),
         router_id=dict(type="str"),
         router_id_as_loopback=dict(type="str", default="yes", choices=["yes", "no"]),
+        loopback_address=dict(type="str", aliases=["loopback"]),
         state=dict(type="str", default="present", choices=["absent", "present", "query"]),
     )
 
@@ -262,6 +269,7 @@ def main():
     node_id = module.params.get("node_id")
     router_id = module.params.get("router_id")
     router_id_as_loopback = module.params.get("router_id_as_loopback")
+    loopback_address = module.params.get("loopback_address")
     state = module.params.get("state")
 
     tdn = None
@@ -270,6 +278,10 @@ def main():
 
     aci = ACIModule(module)
 
+    child_classes = ["l3extLoopBackIfP"]
+
+    child_configs = []
+
     aci.construct_url(
         root_class=dict(
             aci_class="fvTenant",
@@ -295,12 +307,25 @@ def main():
             module_object=tdn,
             target_filter={"name": tdn},
         ),
+        child_classes=child_classes,
     )
 
     aci.get_existing()
 
+    if loopback_address is not None:
+        if loopback_address == "" and isinstance(aci.existing, list) and len(aci.existing) > 0:
+            for child in aci.existing[0].get("l3extRsNodeL3OutAtt", {}).get("children", []):
+                previous_loopback_address = child.get("l3extLoopBackIfP", {}).get("attributes", {}).get("addr")
+                child_configs.extend([dict(l3extLoopBackIfP=dict(attributes=dict(addr=previous_loopback_address, status="deleted")))])
+        elif loopback_address:
+            child_configs.extend([dict(l3extLoopBackIfP=dict(attributes=dict(addr=loopback_address)))])
+
     if state == "present":
-        aci.payload(aci_class="l3extRsNodeL3OutAtt", class_config=dict(rtrId=router_id, rtrIdLoopBack=router_id_as_loopback, tDn=tdn))
+        aci.payload(
+            aci_class="l3extRsNodeL3OutAtt",
+            class_config=dict(rtrId=router_id, rtrIdLoopBack=router_id_as_loopback, tDn=tdn),
+            child_configs=child_configs,
+        )
 
         aci.get_diff(aci_class="l3extRsNodeL3OutAtt")
 

tests/integration/targets/aci_l3out_logical_node/tasks/main.yml

@@ -1,6 +1,11 @@
 # Author: Marcel Zehnder (@maercu)
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
+- name: Test that we have an ACI APIC host, ACI username and ACI password
+  fail:
+    msg: 'Please define the following variables: aci_hostname, aci_username and aci_password.'
+  when: aci_hostname is not defined or aci_username is not defined or aci_password is not defined
+
 # SET VARS
 - name: Set vars
   set_fact:
@@ -15,7 +20,7 @@
 
 # CLEAN ENVIRONMENT
 - name: Remove test tenant before we kickoff
-  cisco.aci.aci_tenant: &tenant_absent
+  aci_tenant: &tenant_absent
     <<: *aci_info
     tenant: ansible_test
     state: absent
@@ -28,38 +33,38 @@
   block:  # block specifies execution of tasks within, based on conditions
   # SETUP ENVIRONMENT
   - name: Create domain
-    cisco.aci.aci_domain: &domain_present
+    aci_domain: &domain_present
       <<: *aci_info
       domain: l3outtest
       domain_type: l3dom
       state: present
 
   - name: Create tenant
-    cisco.aci.aci_tenant: &tenant_present
+    aci_tenant: &tenant_present
       <<: *tenant_absent
       state: present
 
   - name: Configure VRF
-    cisco.aci.aci_vrf: &vrf_present
+    aci_vrf: &vrf_present
       <<: *tenant_present
       vrf: l3outtest
 
   - name: Create L3Out
-    cisco.aci.aci_l3out:
+    aci_l3out:
       <<: *vrf_present
       l3out: l3outtest
       domain: l3outtest
       route_control: export 
 
   - name: Crete node profile
-    cisco.aci.aci_l3out_logical_node_profile: &np_present
+    aci_l3out_logical_node_profile: &np_present
       <<: *tenant_present
       l3out: l3outtest
       node_profile: NODES
 
   # BEGIN WITH TESTS
   - name: Add node (check_mode)
-    cisco.aci.aci_l3out_logical_node: &node_present
+    aci_l3out_logical_node: &node_present
       <<: *np_present
       pod_id: 1
       node_id: 111
@@ -69,7 +74,7 @@
     register: cm_add_node
 
   - name: Add node (normal mode)
-    cisco.aci.aci_l3out_logical_node: 
+    aci_l3out_logical_node: 
       <<: *node_present
     register: nm_add_node
 
@@ -79,13 +84,13 @@
       - cm_add_node is changed
       - nm_add_node is changed
       - cm_add_node.previous == nm_add_node.previous == []
-      - cm_add_node.sent.l3extRsNodeL3OutAtt.attributes.rtrId == nm_add_node.sent.l3extRsNodeL3OutAtt.attributes.rtrId == '111.111.111.111'
-      - cm_add_node.sent.l3extRsNodeL3OutAtt.attributes.rtrIdLoopBack == nm_add_node.sent.l3extRsNodeL3OutAtt.attributes.rtrIdLoopBack == 'no'
-      - cm_add_node.sent.l3extRsNodeL3OutAtt.attributes.tDn == nm_add_node.sent.l3extRsNodeL3OutAtt.attributes.tDn == 'topology/pod-1/node-111'
+      - cm_add_node.sent.l3extRsNodeL3OutAtt.attributes.rtrId == nm_add_node.current.0.l3extRsNodeL3OutAtt.attributes.rtrId == '111.111.111.111'
+      - cm_add_node.sent.l3extRsNodeL3OutAtt.attributes.rtrIdLoopBack == nm_add_node.current.0.l3extRsNodeL3OutAtt.attributes.rtrIdLoopBack == 'no'
+      - cm_add_node.sent.l3extRsNodeL3OutAtt.attributes.tDn == nm_add_node.current.0.l3extRsNodeL3OutAtt.attributes.tDn == 'topology/pod-1/node-111'
       - nm_add_node.current.0.l3extRsNodeL3OutAtt.attributes.annotation == 'orchestrator:ansible'
 
   - name: Add node  again, check if idempotency works
-    cisco.aci.aci_l3out_logical_node: 
+    aci_l3out_logical_node: 
       <<: *node_present
     register: add_node_again
 
@@ -96,28 +101,46 @@
 
   # UPDATE NODE
   - name: Change roouter id
-    cisco.aci.aci_l3out_logical_node: &node_update
+    aci_l3out_logical_node: &node_update
       <<: *node_present
       router_id: 11.11.11.11
     register: update_node
 
+  - name: Add loopback address
+    aci_l3out_logical_node: &node_add_loopback
+      <<: *node_update
+      loopback_address: 11.11.11.12
+    register: add_loopback_ip
+
+  - name: Remove loopback address
+    aci_l3out_logical_node: &node_remove_loopback
+      <<: *node_add_loopback
+      loopback_address: ""
+    register: remove_loopback_ip
+
   - name: Verify update_node
     assert:
       that:
       - update_node is changed
       - update_node.previous != []
-      - update_node.sent.l3extRsNodeL3OutAtt.attributes.rtrId == '11.11.11.11'
+      - update_node.current.0.l3extRsNodeL3OutAtt.attributes.rtrId == '11.11.11.11'
+      - add_loopback_ip is changed
+      - add_loopback_ip.previous != []
+      - add_loopback_ip.current.0.l3extRsNodeL3OutAtt.children.0.l3extLoopBackIfP.attributes.addr == '11.11.11.12'
+      - remove_loopback_ip is changed
+      - remove_loopback_ip.previous != []
 
   # ADD ANOTHER NODE
   - name: Add another node
-    cisco.aci.aci_l3out_logical_node: 
+    aci_l3out_logical_node: &second_node_present
       <<: *node_present
       node_id: 112
       router_id: 12.12.12.12
+      loopback_address: 12.12.12.13
 
   # QUERY ALL NODES
   - name: Query all nodes
-    cisco.aci.aci_l3out_logical_node: 
+    aci_l3out_logical_node: 
       <<: *aci_info
       state: query
     register: query_all_nodes
@@ -130,8 +153,8 @@
 
   # QUERY A SPECIFIC NODE
   - name: Query a specific node
-    cisco.aci.aci_l3out_logical_node:
-      <<: *node_update
+    aci_l3out_logical_node:
+      <<: *second_node_present
       state: query
     register: query_spec_node
 
@@ -140,11 +163,13 @@
       that:
       - query_spec_node is not changed
       - query_spec_node.current|length == 1
+      - query_spec_node.current.0.l3extRsNodeL3OutAtt.attributes.rtrId == '12.12.12.12'
+      - query_spec_node.current.0.l3extRsNodeL3OutAtt.children.0.l3extLoopBackIfP.attributes.addr == '12.12.12.13'
 
   # REMOVE NODE
   - name: Remove node
-    cisco.aci.aci_l3out_logical_node:
-      <<: *node_update
+    aci_l3out_logical_node:
+      <<: *node_remove_loopback
       state: absent
     register: remove_node
 
@@ -153,3 +178,9 @@
       that:
       - remove_node is changed
       - remove_node.current == []
+
+  - name: Remove test tenant - clean-up the environment 
+    aci_tenant:
+      <<: *aci_info
+      tenant: ansible_test
+      state: absent