Enhancement: Add tags and ipaddresses to netbox_service (#161)

Author: FragmentedPacket

plugins/module_utils/netbox_utils.py

@@ -49,7 +49,6 @@
         "aggregates",
         "ip_addresses",
         "prefixes",
-        "services",
         "rirs",
         "roles",
         "vlans",
@@ -117,6 +116,7 @@
     installed_device="devices",
     interface="interfaces",
     ip_addresses="ip_addresses",
+    ipaddresses="ip_addresses",
     lag="interfaces",
     manufacturer="manufacturers",
     nat_inside="ip_addresses",
@@ -199,6 +199,7 @@
     "inventory_item": set(["name", "device"]),
     "ip_address": set(["address", "vrf"]),
     "ip_addresses": set(["address", "vrf", "device"]),
+    "ipaddresses": set(["address", "vrf", "device"]),
     "lag": set(["name"]),
     "manufacturer": set(["slug"]),
     "nat_inside": set(["vrf", "address"]),
@@ -214,7 +215,7 @@
     "region": set(["slug"]),
     "rir": set(["slug"]),
     "role": set(["slug"]),
-    "services": set(["device", "virtual_machine", "name"]),
+    "services": set(["device", "virtual_machine", "name", "port"]),
     "site": set(["slug"]),
     "tagged_vlans": set(["name", "site", "vlan_group", "tenant"]),
     "tenant": set(["slug"]),

plugins/modules/netbox_service.py

@@ -55,18 +55,21 @@
       protocol:
         description:
           - Specifies which protocol used by service
-        type: int
+        type: str
         choices:
-            - 6 TCP
-            - 17 UDP
-      ipaddress:
+            - TCP
+            - UDP
+      ipaddresses:
         description:
-          - VRF that prefix is associated with
-        type: str
+          - Specifies which IPaddresses to associate with service.
+        type: dict
       description:
         description:
           - Service description
         type: str
+      tags:
+        description:
+          - What tags to add/update 
       custom_fields:
         description:
           - Must exist in Netbox and in key/value format
@@ -99,7 +102,11 @@
           device: Test666
           name: node-exporter
           port: 9100
-          protocol: 6
+          protocol: TCP
+          ipaddresses:
+            - address: 127.0.0.1
+          tags:
+            - prometheus
         state: present
 
 - name: "Delete netbox service"
@@ -116,7 +123,7 @@
           device: Test666
           name: node-exporter
           port: 9100
-          protocol: 6
+          protocol: TCP
         state: absent
 """
 
@@ -149,6 +156,7 @@ def main():
                     ipaddresses=dict(required=False, type="raw"),
                     description=dict(required=False, type="str"),
                     custom_fields=dict(required=False, type=dict),
+                    tags=dict(required=False, type=list),
                 ),
             ),
         )

tests/integration/v2.7/tasks/netbox_service.yml

@@ -58,6 +58,7 @@
       - test_service_idempotence['services']['port'] == 9100
       - test_service_idempotence['services']['protocol'] == "tcp"
       - test_service_idempotence['msg'] == "services node-exporter already exists"
+
 - name: "NETBOX_SERVICE: Test update"
   netbox_service:
     netbox_url: "http://localhost:32768"
@@ -67,6 +68,8 @@
       name: "node-exporter"
       port: 9100
       protocol: UDP
+      tags:
+        - "Schnozzberry"
     state: present
   register: test_service_update
 
@@ -76,6 +79,7 @@
       - test_service_update is changed
       - test_service_update['diff']['before']['protocol'] == "tcp"
       - test_service_update['diff']['after']['protocol'] == "udp"
+      - test_service_update['diff']['after']['tags'][0] == "Schnozzberry"
       - test_service_update['msg'] == "services node-exporter updated"
 
 - name: "NETBOX_SERVICE: Test service deletion"
@@ -97,3 +101,29 @@
       - test_service_delete['diff']['after']['state'] == "absent"
       - test_service_delete['diff']['before']['state'] == "present"
       - test_service_delete['msg'] == "services node-exporter deleted"
+
+- name: "NETBOX_SERVICE: Test service IP addresses"
+  netbox_service:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device: "test100"
+      name: "node-exporter"
+      port: 9100
+      protocol: UDP
+      ipaddresses:
+        - address: "172.16.180.1/24"
+    state: present
+  register: test_service_ip_addresses
+
+- name: "NETBOX_SERVICE ASSERT - Service has been created with IP address"
+  assert:
+    that:
+      - test_service_ip_addresses is changed
+      - test_service_ip_addresses['diff']['after']['state'] == "present"
+      - test_service_ip_addresses['diff']['before']['state'] == "absent"
+      - test_service_ip_addresses['services']['name'] == "node-exporter"
+      - test_service_ip_addresses['services']['port'] == 9100
+      - test_service_ip_addresses['services']['protocol'] == "udp"
+      - test_service_ip_addresses['services']['ipaddresses'] is defined
+      - test_service_ip_addresses['msg'] == "services node-exporter created"