BugFix: netbox_device_interface - Allow modification of VC child interfaces when parent device specified (#126)

Author: FragmentedPacket

plugins/module_utils/netbox_dcim.py

@@ -93,13 +93,17 @@ def run(self):
         # This is logic to handle interfaces on a VC
         if self.endpoint == "interfaces":
             if self.nb_object:
-                if self.nb_object.device:
-                    device = self.nb.dcim.devices.get(self.nb_object.device.id)
-                    if (
-                        device["virtual_chassis"]
-                        and self.nb_object.device.id != self.data["device"]
-                    ):
-                        self.object = None
+                device = self.nb.dcim.devices.get(self.nb_object.device.id)
+                if (
+                    device["virtual_chassis"]
+                    and self.nb_object.device.id != self.data["device"]
+                ):
+                    if self.module.params.get("update_vc_child"):
+                        data["device"] = self.nb_object.device.id
+                    else:
+                        self._handle_errors(
+                            msg="Must set update_vc_child to True to allow child device interface modification"
+                        )
 
         if self.state == "present":
             self._ensure_object_exists(nb_endpoint, endpoint_name, name, data)

plugins/modules/netbox_device_interface.py

@@ -105,6 +105,13 @@
           - Any tags that the prefix may need to be associated with
         type: list
     required: true
+  update_vc_child:
+    type: boolean
+    default: False
+    description:
+      - |
+        Use when master device is specified for C(device) and the specified interface exists on a child device
+        and needs updated
   state:
     description:
       - Use C(present) or C(absent) for adding or removing.
@@ -190,6 +197,15 @@
           mgmt_only: true
           mode: Tagged
         state: present
+    - name: Update interface on child device on virtual chassis
+      netbox_device_interface:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          device: test100
+          name: GigabitEthernet2/0/1
+          enabled: false
+        update_vc_child: True
 """
 
 RETURN = r"""
@@ -220,6 +236,7 @@ def main():
     argument_spec = NETBOX_ARG_SPEC
     argument_spec.update(
         dict(
+            update_vc_child=dict(type="bool", required=False, default=False),
             data=dict(
                 type="dict",
                 required=True,
@@ -238,7 +255,7 @@ def main():
                     ),
                     untagged_vlan=dict(required=False, type="raw"),
                     tagged_vlans=dict(required=False, type="raw"),
-                    tags=dict(required=False, type=list),
+                    tags=dict(required=False, type="list"),
                 ),
             ),
         )
@@ -247,6 +264,7 @@ def main():
     required_if = [
         ("state", "present", ["device", "name"]),
         ("state", "absent", ["device", "name"]),
+        ("update_vc_child", True, ["device"]),
     ]
 
     module = NetboxAnsibleModule(

tests/integration/integration-tests.yml

@@ -438,7 +438,7 @@
         netbox_token: "0123456789abcdef0123456789abcdef01234567"
         data:
           device: Test Nexus Child One
-          name: Ethernet1/1
+          name: Ethernet2/1
           form_factor: 1000Base-T (1GE)
         state: present
       register: test_nine
@@ -447,14 +447,56 @@
       assert:
         that:
           - test_nine is changed
-          - test_nine['msg'] == "interface Ethernet1/1 created"
+          - test_nine['msg'] == "interface Ethernet2/1 created"
           - test_nine['diff']['before']['state'] == 'absent'
           - test_nine['diff']['after']['state'] == 'present'
-          - test_nine['interface']['name'] == "Ethernet1/1"
+          - test_nine['interface']['name'] == "Ethernet2/1"
           - test_nine['interface']['device'] == 5
           - test_nine['interface']['enabled'] == true
           - test_nine['interface']['form_factor'] == 1000
 
+    - name: "10 - Update interface on VC child"
+      netbox_device_interface:
+        netbox_url: "http://localhost:32768"
+        netbox_token: "0123456789abcdef0123456789abcdef01234567"
+        data:
+          device: Test Nexus One
+          name: Ethernet2/1
+          description: "Updated child interface from parent device"
+        update_vc_child: True
+        state: present
+      register: test_ten
+
+    - name: "10 - ASSERT"
+      assert:
+        that:
+          - test_ten is changed
+          - test_ten['msg'] == "interface Ethernet2/1 updated"
+          - test_ten['diff']['after']['description'] == 'Updated child interface from parent device'
+          - test_ten['interface']['name'] == "Ethernet2/1"
+          - test_ten['interface']['device'] == 5
+          - test_ten['interface']['enabled'] == true
+          - test_ten['interface']['form_factor'] == 1000
+          - test_ten['interface']['description'] == 'Updated child interface from parent device'
+
+    - name: "11 - Update interface on VC child w/o update_vc_child"
+      netbox_device_interface:
+        netbox_url: "http://localhost:32768"
+        netbox_token: "0123456789abcdef0123456789abcdef01234567"
+        data:
+          device: Test Nexus One
+          name: Ethernet2/1
+          description: "Updated child interface from parent device - test"
+        state: present
+      ignore_errors: yes
+      register: test_eleven
+
+    - name: "11 - ASSERT"
+      assert:
+        that:
+          - test_eleven is failed
+          - test_eleven['msg'] == "Must set update_vc_child to True to allow child device interface modification"
+
 ##
 ##
 ### NETBOX_IP_ADDRESS