Allow adding power port templates to modules (#1105)

k-304 · Kenneth Joss · web-flow · commit 9449f88ed9ec · 2023-11-02T19:40:50.000+01:00
* Allow adding power port templates to modules
---------

Co-authored-by: Kenneth Joss &lt;kenneth@cloudscale.ch&gt;
diff --git a/plugins/lookup/nb_lookup.py b/plugins/lookup/nb_lookup.py
@@ -212,6 +212,7 @@ def get_endpoint(netbox, term):
         "module-bays": {"endpoint": netbox.dcim.module_bays},
         "module-bay-templates": {"endpoint": netbox.dcim.module_bay_templates},
         "module-bay-types": {"endpoint": netbox.dcim.module_bay_types},
+        "module-types": {"endpoint": netbox.dcim.module_types},
         "modules": {"endpoint": netbox.dcim.modules},
         "object-changes": {"endpoint": netbox.extras.object_changes},
         "permissions": {"endpoint": netbox.users.permissions},
diff --git a/plugins/module_utils/netbox_utils.py b/plugins/module_utils/netbox_utils.py
@@ -239,6 +239,7 @@
     "lag": "interfaces",
     "manufacturer": "manufacturers",
     "master": "devices",
+    "module_type": "module_types",
     "nat_inside": "ip_addresses",
     "nat_outside": "ip_addresses",
     "platform": "platforms",
diff --git a/plugins/modules/netbox_power_port_template.py b/plugins/modules/netbox_power_port_template.py
@@ -34,7 +34,12 @@
       device_type:
         description:
           - The device type the power port is attached to
-        required: true
+          - Either I(device_type) or I(module_type) are required
+        type: raw
+      module_type:
+        description:
+          - The module type the power port is attached to
+          - Either I(device_type) or I(module_type) are required
         type: raw
       name:
         description:
@@ -175,6 +180,17 @@
           device_type: Test Device Type
         state: present
 
+    - name: Create power port for a module type within NetBox
+      netbox.netbox.netbox_power_port_template:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Test Power Port Template
+          module_type: Test Module Type
+          type: iec-60320-c6
+          maximum_draw: 750
+        state: present
+
     - name: Update power port with other fields
       netbox.netbox.netbox_power_port_template:
         netbox_url: http://netbox.local
@@ -230,7 +246,8 @@ def main():
                 type="dict",
                 required=True,
                 options=dict(
-                    device_type=dict(required=True, type="raw"),
+                    device_type=dict(required=False, type="raw"),
+                    module_type=dict(required=False, type="raw"),
                     name=dict(required=True, type="str"),
                     type=dict(
                         required=False,
@@ -346,12 +363,19 @@ def main():
     )
 
     required_if = [
-        ("state", "present", ["device_type", "name"]),
-        ("state", "absent", ["device_type", "name"]),
+        ("state", "present", ["name"]),
+        ("state", "absent", ["name"]),
+    ]
+
+    required_one_of = [
+        ("device_type", "module_type"),
     ]
 
     module = NetboxAnsibleModule(
-        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=required_if,
+        required_one_of=required_one_of,
     )
 
     netbox_power_port_template = NetboxDcimModule(module, NB_POWER_PORT_TEMPLATES)
diff --git a/tests/integration/targets/v3.5/tasks/netbox_power_port_template.yml b/tests/integration/targets/v3.5/tasks/netbox_power_port_template.yml
@@ -7,7 +7,7 @@
 ### NETBOX_POWER_PORT_TEMPLATE
 ##
 ##
-- name: "POWER_PORT_TEMPLATE 0: Create device type for testing power ports"
+- name: "POWER_PORT_TEMPLATE 0.1: Create device type for testing power ports on device types"
   netbox.netbox.netbox_device_type:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -16,6 +16,15 @@
       manufacturer: Test Manufacturer
     state: present
 
+- name: "POWER_PORT_TEMPLATE 0.2: Create module type for testing power ports on module types"
+  netbox.netbox.netbox_module_type:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      model: Module Type Power Tests
+      manufacturer: Test Manufacturer
+    state: present
+
 - name: "POWER_PORT_TEMPLATE 1: Necessary info creation"
   netbox.netbox.netbox_power_port_template:
     netbox_url: http://localhost:32768
@@ -118,3 +127,86 @@
       - test_five['diff']['before']['state'] == "present"
       - test_five['diff']['after']['state'] == "absent"
       - test_five['msg'] == "power_port_template Power Port Template 2 deleted"
+
+- name: "POWER_PORT_TEMPLATE 6: Necessary info creation"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+    state: present
+  register: test_six
+
+- name: "POWER_PORT_TEMPLATE 6: ASSERT - Necessary info creation"
+  assert:
+    that:
+      - test_six is changed
+      - test_six['diff']['before']['state'] == "absent"
+      - test_six['diff']['after']['state'] == "present"
+      - test_six['power_port_template']['name'] == "Module Power Port Template"
+      - test_six['power_port_template']['module_type'] == 1
+      - test_six['msg'] == "power_port_template Module Power Port Template created"
+
+- name: "POWER_PORT_TEMPLATE 7: Create duplicate"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+    state: present
+  register: test_seven
+
+- name: "POWER_PORT_TEMPLATE 7: ASSERT - Create duplicate"
+  assert:
+    that:
+      - not test_seven['changed']
+      - test_seven['power_port_template']['name'] == "Module Power Port Template"
+      - test_seven['power_port_template']['module_type'] == 1
+      - test_seven['msg'] == "power_port_template Module Power Port Template already exists"
+
+- name: "POWER_PORT_TEMPLATE 8: Update power_port_template with other fields"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+      type: ita-e
+      allocated_draw: 10
+      maximum_draw: 20
+    state: present
+  register: test_eight
+
+- name: "POWER_PORT_TEMPLATE 8: ASSERT - Update power_port_template with other fields"
+  assert:
+    that:
+      - test_eight is changed
+      - test_eight['diff']['after']['type'] == "ita-e"
+      - test_eight['diff']['after']['allocated_draw'] == 10
+      - test_eight['diff']['after']['maximum_draw'] == 20
+      - test_eight['power_port_template']['name'] == "Module Power Port Template"
+      - test_eight['power_port_template']['module_type'] == 1
+      - test_eight['power_port_template']['type'] == "ita-e"
+      - test_eight['power_port_template']['allocated_draw'] == 10
+      - test_eight['power_port_template']['maximum_draw'] == 20
+      - test_eight['msg'] == "power_port_template Module Power Port Template updated"
+
+- name: "POWER_PORT_TEMPLATE 9: Delete Power Port Template"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+    state: absent
+  register: test_nine
+
+- name: "POWER_PORT_TEMPLATE 9: ASSERT - Delete Power Port Template"
+  assert:
+    that:
+      - test_nine is changed
+      - test_nine['diff']['before']['state'] == "present"
+      - test_nine['diff']['after']['state'] == "absent"
+      - test_nine['msg'] == "power_port_template Module Power Port Template deleted"
diff --git a/tests/integration/targets/v3.6/tasks/netbox_power_port_template.yml b/tests/integration/targets/v3.6/tasks/netbox_power_port_template.yml
@@ -7,7 +7,7 @@
 ### NETBOX_POWER_PORT_TEMPLATE
 ##
 ##
-- name: "POWER_PORT_TEMPLATE 0: Create device type for testing power ports"
+- name: "POWER_PORT_TEMPLATE 0.1: Create device type for testing power ports on device types"
   netbox.netbox.netbox_device_type:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -16,6 +16,15 @@
       manufacturer: Test Manufacturer
     state: present
 
+- name: "POWER_PORT_TEMPLATE 0.2: Create module type for testing power ports on module types"
+  netbox.netbox.netbox_module_type:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      model: Module Type Power Tests
+      manufacturer: Test Manufacturer
+    state: present
+
 - name: "POWER_PORT_TEMPLATE 1: Necessary info creation"
   netbox.netbox.netbox_power_port_template:
     netbox_url: http://localhost:32768
@@ -118,3 +127,86 @@
       - test_five['diff']['before']['state'] == "present"
       - test_five['diff']['after']['state'] == "absent"
       - test_five['msg'] == "power_port_template Power Port Template 2 deleted"
+
+- name: "POWER_PORT_TEMPLATE 6: Necessary info creation"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+    state: present
+  register: test_six
+
+- name: "POWER_PORT_TEMPLATE 6: ASSERT - Necessary info creation"
+  assert:
+    that:
+      - test_six is changed
+      - test_six['diff']['before']['state'] == "absent"
+      - test_six['diff']['after']['state'] == "present"
+      - test_six['power_port_template']['name'] == "Module Power Port Template"
+      - test_six['power_port_template']['module_type'] == 1
+      - test_six['msg'] == "power_port_template Module Power Port Template created"
+
+- name: "POWER_PORT_TEMPLATE 7: Create duplicate"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+    state: present
+  register: test_seven
+
+- name: "POWER_PORT_TEMPLATE 7: ASSERT - Create duplicate"
+  assert:
+    that:
+      - not test_seven['changed']
+      - test_seven['power_port_template']['name'] == "Module Power Port Template"
+      - test_seven['power_port_template']['module_type'] == 1
+      - test_seven['msg'] == "power_port_template Module Power Port Template already exists"
+
+- name: "POWER_PORT_TEMPLATE 8: Update power_port_template with other fields"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+      type: ita-e
+      allocated_draw: 10
+      maximum_draw: 20
+    state: present
+  register: test_eight
+
+- name: "POWER_PORT_TEMPLATE 8: ASSERT - Update power_port_template with other fields"
+  assert:
+    that:
+      - test_eight is changed
+      - test_eight['diff']['after']['type'] == "ita-e"
+      - test_eight['diff']['after']['allocated_draw'] == 10
+      - test_eight['diff']['after']['maximum_draw'] == 20
+      - test_eight['power_port_template']['name'] == "Module Power Port Template"
+      - test_eight['power_port_template']['module_type'] == 1
+      - test_eight['power_port_template']['type'] == "ita-e"
+      - test_eight['power_port_template']['allocated_draw'] == 10
+      - test_eight['power_port_template']['maximum_draw'] == 20
+      - test_eight['msg'] == "power_port_template Module Power Port Template updated"
+
+- name: "POWER_PORT_TEMPLATE 9: Delete Power Port Template"
+  netbox.netbox.netbox_power_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Module Power Port Template
+      module_type: Module Type Power Tests
+    state: absent
+  register: test_nine
+
+- name: "POWER_PORT_TEMPLATE 9: ASSERT - Delete Power Port Template"
+  assert:
+    that:
+      - test_nine is changed
+      - test_nine['diff']['before']['state'] == "present"
+      - test_nine['diff']['after']['state'] == "absent"
+      - test_nine['msg'] == "power_port_template Module Power Port Template deleted"
