Added Arg Specs (data key) for all modules (#68)

Author: FragmentedPacket

.travis.yml

@@ -9,7 +9,7 @@ env:
   global:
     - COLLECTION_NAMESPACE: netbox_community
     - COLLECTION_NAME: ansible_modules
-    - COLLECTION_VERSION: 0.1.4
+    - COLLECTION_VERSION: 0.1.5
 
 matrix:
   include:
@@ -60,4 +60,4 @@ script:
   - black . --check
   - timeout 300 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:32768)" != "200" ]]; do echo "waiting for Netbox"; sleep 5; done' || false
   - python tests/integration/netbox-deploy.py
-  - ansible-playbook tests/integration/integration-tests.yml -v
+  - ansible-playbook tests/integration/integration-tests.yml -vvvv

README.md

@@ -48,6 +48,7 @@
 ## Netbox Plugins
 
 - netbox lookup plugin
+- netbox inventory plugin (0.1.5)
 
 ## How to Use
 

galaxy.yml

@@ -9,7 +9,7 @@ namespace: netbox_community
 name: ansible_modules
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 0.1.4
+version: 0.1.5
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

plugins/module_utils/netbox_utils.py

@@ -392,6 +392,13 @@
     "vlan_groups",
 }
 
+NETBOX_ARG_SPEC = dict(
+    netbox_url=dict(type="str", required=True),
+    netbox_token=dict(type="str", required=True, no_log=True),
+    state=dict(required=False, default="present", choices=["present", "absent"]),
+    validate_certs=dict(type="bool", default=True),
+)
+
 
 class NetboxModule(object):
     """
@@ -424,7 +431,8 @@ def __init__(self, module, endpoint, nb_client=None):
             self.nb = nb_client
 
         # These methods will normalize the regular data
-        norm_data = self._normalize_data(module.params["data"])
+        cleaned_data = self._remove_arg_spec_default(module.params["data"])
+        norm_data = self._normalize_data(cleaned_data)
         choices_data = self._change_choices_id(self.endpoint, norm_data)
         data = self._find_ids(choices_data)
         self.data = self._convert_identical_keys(data)
@@ -463,6 +471,17 @@ def _convert_identical_keys(self, data):
 
         return data
 
+    def _remove_arg_spec_default(self, data):
+        """Used to remove any data keys that were not provided by user, but has the arg spec
+        default values
+        """
+        new_dict = dict()
+        for k, v in data.items():
+            if v is not None:
+                new_dict[k] = v
+
+        return new_dict
+
     def _get_query_param_id(self, match, data):
         """Used to find IDs of necessary searches when required under _build_query_params
         :returns id (int) or data (dict): Either returns the ID or original data passed in
@@ -623,7 +642,11 @@ def _to_slug(self, value):
         :returns slug (str): Slugified value
         :params value (str): Value that needs to be changed to slug format
         """
-        if " " in value:
+        if value is None:
+            return value
+        elif isinstance(value, int):
+            return value
+        elif " " in value:
             slug = value.replace(" ", "-").lower()
         else:
             slug = value.lower()
@@ -777,7 +800,6 @@ def __init__(
         argument_spec,
         bypass_checks=False,
         no_log=False,
-        check_invalid_arguments=None,
         mutually_exclusive=None,
         required_together=None,
         required_one_of=None,
@@ -788,22 +810,22 @@ def __init__(
     ):
         super().__init__(
             argument_spec,
-            bypass_checks,
-            no_log,
-            check_invalid_arguments,
-            mutually_exclusive,
-            required_together,
-            required_one_of,
-            add_file_common_args,
-            supports_check_mode,
-            required_if,
-            required_by,
+            bypass_checks=False,
+            no_log=False,
+            mutually_exclusive=None,
+            required_together=None,
+            required_one_of=None,
+            add_file_common_args=False,
+            supports_check_mode=supports_check_mode,
+            required_if=required_if,
+            required_by=None,
         )
 
     def _check_required_if(self, spec, param=None):
         """ ensure that parameters which conditionally required are present """
         if spec is None:
             return
+
         if param is None:
             param = self.params
 

plugins/modules/netbox_aggregate.py

@@ -124,6 +124,7 @@
 
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
     NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
 )
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_ipam import (
     NetboxIpamModule,
@@ -135,12 +136,22 @@ def main():
     """
     Main entry point for module execution
     """
-    argument_spec = dict(
-        netbox_url=dict(type="str", required=True),
-        netbox_token=dict(type="str", required=True, no_log=True),
-        data=dict(type="dict", required=True),
-        state=dict(required=False, default="present", choices=["present", "absent"]),
-        validate_certs=dict(type="bool", default=True),
+    argument_spec = NETBOX_ARG_SPEC
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    prefix=dict(required=True, type="raw"),
+                    rir=dict(required=False, type="raw"),
+                    date_added=dict(required=False, type="str"),
+                    description=dict(required=False, type="str"),
+                    tags=dict(required=False, type=list),
+                    custom_fields=dict(required=False, type=dict),
+                ),
+            ),
+        )
     )
 
     required_if = [("state", "present", ["prefix"]), ("state", "absent", ["prefix"])]

plugins/modules/netbox_circuit.py

@@ -149,6 +149,7 @@
 
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
     NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
 )
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_circuits import (
     NetboxCircuitsModule,
@@ -160,12 +161,39 @@ def main():
     """
     Main entry point for module execution
     """
-    argument_spec = dict(
-        netbox_url=dict(type="str", required=True),
-        netbox_token=dict(type="str", required=True, no_log=True),
-        data=dict(type="dict", required=True),
-        state=dict(required=False, default="present", choices=["present", "absent"]),
-        validate_certs=dict(type="bool", default=True),
+    argument_spec = NETBOX_ARG_SPEC
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    cid=dict(required=True, type="str"),
+                    provider=dict(required=False, type="raw"),
+                    circuit_type=dict(required=False, type="raw"),
+                    # Will uncomment other status dict once slugs are the only option (Netbox 2.8)
+                    status=dict(required=False, type="raw"),
+                    # status=dict(
+                    #    required=False,
+                    #    choices=[
+                    #        "Active",
+                    #        "Offline",
+                    #        "Planned",
+                    #        "Provisioning",
+                    #        "Deprovisioning",
+                    #        "Decommissioned",
+                    #    ],
+                    # ),
+                    tenant=dict(required=False, type="raw"),
+                    install_date=dict(required=False, type="str"),
+                    commit_rate=dict(required=False, type="int"),
+                    description=dict(required=False, type="str"),
+                    comments=dict(required=False, type="str"),
+                    tags=dict(required=False, type=list),
+                    custom_fields=dict(required=False, type=dict),
+                ),
+            ),
+        )
     )
 
     required_if = [("state", "present", ["cid"]), ("state", "absent", ["cid"])]

plugins/modules/netbox_circuit_termination.py

@@ -137,6 +137,7 @@
 
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
     NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
 )
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_circuits import (
     NetboxCircuitsModule,
@@ -148,13 +149,26 @@ def main():
     """
     Main entry point for module execution
     """
-    argument_spec = dict(
-        netbox_url=dict(type="str", required=True),
-        netbox_token=dict(type="str", required=True, no_log=True),
-        data=dict(type="dict", required=True),
-        state=dict(required=False, default="present", choices=["present", "absent"]),
-        validate_certs=dict(type="bool", default=True),
+    argument_spec = NETBOX_ARG_SPEC
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    circuit=dict(required=True, type="raw"),
+                    term_side=dict(required=True, choices=["A", "Z"]),
+                    site=dict(required=False, type="raw"),
+                    port_speed=dict(required=False, type="int"),
+                    upstream_speed=dict(required=False, type="int"),
+                    xconnect_id=dict(required=False, type="str"),
+                    pp_info=dict(required=False, type="str"),
+                    description=dict(required=False, type="str"),
+                ),
+            ),
+        )
     )
+
     required_if = [
         ("state", "present", ["circuit", "term_side"]),
         ("state", "absent", ["circuit", "term_side"]),

plugins/modules/netbox_circuit_type.py

@@ -93,6 +93,7 @@
 
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
     NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
 )
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_circuits import (
     NetboxCircuitsModule,
@@ -104,12 +105,18 @@ def main():
     """
     Main entry point for module execution
     """
-    argument_spec = dict(
-        netbox_url=dict(type="str", required=True),
-        netbox_token=dict(type="str", required=True, no_log=True),
-        data=dict(type="dict", required=True),
-        state=dict(required=False, default="present", choices=["present", "absent"]),
-        validate_certs=dict(type="bool", default=True),
+    argument_spec = NETBOX_ARG_SPEC
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    name=dict(required=True, type="str"),
+                    slug=dict(required=False, type="str"),
+                ),
+            ),
+        )
     )
 
     required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]

plugins/modules/netbox_cluster.py

@@ -136,6 +136,7 @@
 
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
     NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
 )
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_virtualization import (
     NetboxVirtualizationModule,
@@ -147,12 +148,23 @@ def main():
     """
     Main entry point for module execution
     """
-    argument_spec = dict(
-        netbox_url=dict(type="str", required=True),
-        netbox_token=dict(type="str", required=True, no_log=True),
-        data=dict(type="dict", required=True),
-        state=dict(required=False, default="present", choices=["present", "absent"]),
-        validate_certs=dict(type="bool", default=True),
+    argument_spec = NETBOX_ARG_SPEC
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    name=dict(required=True, type="str"),
+                    cluster_type=dict(required=False, type="raw"),
+                    cluster_group=dict(required=False, type="raw"),
+                    site=dict(required=False, type="raw"),
+                    comments=dict(required=False, type="str"),
+                    tags=dict(required=False, type=list),
+                    custom_fields=dict(required=False, type=dict),
+                ),
+            ),
+        )
     )
 
     required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]

plugins/modules/netbox_cluster_group.py

@@ -93,6 +93,7 @@
 
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
     NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
 )
 from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_virtualization import (
     NetboxVirtualizationModule,
@@ -104,12 +105,18 @@ def main():
     """
     Main entry point for module execution
     """
-    argument_spec = dict(
-        netbox_url=dict(type="str", required=True),
-        netbox_token=dict(type="str", required=True, no_log=True),
-        data=dict(type="dict", required=True),
-        state=dict(required=False, default="present", choices=["present", "absent"]),
-        validate_certs=dict(type="bool", default=True),
+    argument_spec = NETBOX_ARG_SPEC
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    name=dict(required=True, type="str"),
+                    slug=dict(required=False, type="str"),
+                ),
+            ),
+        )
     )
 
     required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]