Add all virtualization modules (#36)

Author: FragmentedPacket

.travis.yml

@@ -26,7 +26,7 @@ matrix:
         - docker-compose up -d
         - cd ..
         - pip install -U pip
-        - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.3b0
+        - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.10b0
         - pip install pynetbox==4.0.6 cryptography codecov jmespath ansible==$ANSIBLE_VER
 
     - name: "Python 3.6 - Netbox Latest - Ansible Devel"
@@ -41,7 +41,7 @@ matrix:
         - docker-compose up -d
         - cd ..
         - pip install -U pip
-        - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.3b0
+        - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.10b0
         - pip install pynetbox==4.0.6 cryptography jmespath
         # This is due to ansible-test only being available within devel branch
         - git clone https://github.com/ansible/ansible.git

README.md

@@ -1,20 +1,6 @@
 [![Build Status](https://travis-ci.org/FragmentedPacket/netbox_modules.svg?branch=master)](https://travis-ci.org/FragmentedPacket/netbox_modules)
 # Netbox modules for Ansible using Ansible Collections
 
-**THIS IS A WIP DUE TO COLLECTIONS BEING IN TECH REVIEW CURRENTLY (Ansible 2.8) BUT WILL BE UPDATED AS NECESSARY AS COLLECTIONS MATURES**
-
-## Todo
-
-- ~~initial build and changes to properly import module_utils~~
-- Add testing to Travis CI
-  - ~~Initial unit tests~~
-  - ~~Test different Python versions (3.6/3.7)~~
-  - ~~Integration testing against at least two versions of Netbox~~
-  - Local testing using Tox
-  - ~~Test currently supported versions of Ansible~~
-- ~~Add documentation on how to use to README~~
-- ~~Add documentation on how to contribute to collection~~
-
 ## Requirements
 
 - Netbox 2.5+
@@ -26,6 +12,9 @@
 ## Existing Modules
 
 - netbox_aggregate
+- netbox_cluster
+- netbox_cluster_group
+- netbox_cluster_type
 - netbox_device_bay
 - netbox_device_interface
 - netbox_device_role
@@ -45,6 +34,8 @@
 - netbox_site
 - netbox_tenant_group
 - netbox_tenant
+- netbox_virtual_machine
+- netbox_vm_interface
 - netbox_vlan_group
 - netbox_vlan
 - netbox_vrf

plugins/module_utils/netbox_utils.py

@@ -56,12 +56,14 @@
     ],
     secrets=[],
     tenancy=["tenants", "tenant_groups"],
-    virtualization=["clusters"],
+    virtualization=["cluster_groups", "cluster_types", "clusters", "virtual_machines"],
 )
 
 # Used to normalize data for the respective query types used to find endpoints
 QUERY_TYPES = dict(
     cluster="name",
+    cluster_group="slug",
+    cluster_type="slug",
     device="name",
     device_role="slug",
     device_type="slug",
@@ -96,6 +98,8 @@
 # Specifies keys within data that need to be converted to ID and the endpoint to be used when queried
 CONVERT_TO_ID = dict(
     cluster="clusters",
+    cluster_group="cluster_groups",
+    cluster_type="cluster_types",
     device="devices",
     device_role="device_roles",
     device_type="device_types",
@@ -125,6 +129,7 @@
     tenant_group="tenant_groups",
     untagged_vlan="vlans",
     virtual_machine="virtual_machines",
+    virtual_machine_role="device_roles",
     vlan="vlans",
     vlan_group="vlan_groups",
     vlan_role="roles",
@@ -133,6 +138,9 @@
 
 ENDPOINT_NAME_MAPPING = {
     "aggregates": "aggregate",
+    "clusters": "cluster",
+    "cluster_groups": "cluster_group",
+    "cluster_types": "cluster_type",
     "device_bays": "device_bay",
     "devices": "device",
     "device_roles": "device_role",
@@ -153,6 +161,7 @@
     "sites": "site",
     "tenants": "tenant",
     "tenant_groups": "tenant_group",
+    "virtual_machines": "virtual_machine",
     "vlans": "vlan",
     "vlan_groups": "vlan_group",
     "vrfs": "vrf",
@@ -256,8 +265,14 @@
 
 INTF_MODE = {"access": 100, "tagged": 200, "tagged all": 300}
 
+VIRTUAL_MACHINE_STATUS = dict(offline=0, active=1, staged=3)
+
+# This is used when attempting to search for existing endpoints
 ALLOWED_QUERY_PARAMS = {
     "aggregate": set(["prefix", "rir"]),
+    "cluster": set(["name", "type"]),
+    "cluster_group": set(["slug"]),
+    "cluster_type": set(["slug"]),
     "device_bay": set(["name", "device"]),
     "device": set(["name"]),
     "device_role": set(["slug"]),
@@ -287,13 +302,14 @@
     "tenant": set(["name"]),
     "tenant_group": set(["name"]),
     "untagged_vlan": set(["name", "site", "vlan_group", "tenant"]),
+    "virtual_machine": set(["name", "cluster"]),
     "vlan": set(["name", "site", "tenant"]),
     "vlan_group": set(["slug", "site"]),
     "vrf": set(["name", "tenant"]),
 }
 
 QUERY_PARAMS_IDS = set(
-    ["device", "group", "rir", "vrf", "site", "vlan_group", "tenant"]
+    ["cluster", "device", "group", "rir", "vrf", "site", "vlan_group", "tenant", "type"]
 )
 
 # This is used when converting static choices to an ID value acceptable to Netbox API
@@ -306,22 +322,28 @@
     "racks": [{"status": RACK_STATUS, "outer_unit": RACK_UNIT, "type": RACK_TYPE}],
     "services": [{"protocol": SERVICE_PROTOCOL}],
     "sites": [{"status": SITE_STATUS}],
+    "virtual_machines": [{"status": VIRTUAL_MACHINE_STATUS, "face": FACE_ID}],
     "vlans": [{"status": VLAN_STATUS}],
 }
 
 # This is used to map non-clashing keys to Netbox API compliant keys to prevent bad logic in code for similar keys but different modules
 CONVERT_KEYS = {
+    "cluster_type": "type",
+    "cluster_group": "group",
     "parent_region": "parent",
     "prefix_role": "role",
     "rack_group": "group",
     "rack_role": "role",
     "tenant_group": "group",
+    "virtual_machine_role": "role",
     "vlan_role": "role",
     "vlan_group": "group",
 }
 
 # This is used to dynamically conver name to slug on endpoints requiring a slug
 SLUG_REQUIRED = {
+    "cluster_groups",
+    "cluster_types",
     "device_roles",
     "ipam_roles",
     "rack_groups",

plugins/module_utils/netbox_virtualization.py

@@ -10,6 +10,7 @@
     from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
         NetboxModule,
         ENDPOINT_NAME_MAPPING,
+        SLUG_REQUIRED,
     )
 except ImportError:
     import sys
@@ -18,6 +19,13 @@
     from netbox_utils import NetboxModule, ENDPOINT_NAME_MAPPING
 
 
+NB_VIRTUAL_MACHINES = "virtual_machines"
+NB_CLUSTERS = "clusters"
+NB_CLUSTER_GROUP = "cluster_groups"
+NB_CLUSTER_TYPE = "cluster_types"
+NB_VM_INTERFACES = "interfaces"
+
+
 class NetboxVirtualizationModule(NetboxModule):
     def __init__(self, module, endpoint):
         super().__init__(module, endpoint)
@@ -27,22 +35,36 @@ def run(self):
         This function should have all necessary code for endpoints within the application
         to create/update/delete the endpoint objects
         Supported endpoints:
+          - clusters
+          - cluster_groups
+          - cluster_types
+          - interfaces
+          - virtual_machines
+          - netbox_cluster
         """
         # Used to dynamically set key when returning results
         endpoint_name = ENDPOINT_NAME_MAPPING[self.endpoint]
 
         self.result = {"changed": False}
 
-        application = self._find_app(self.endpoint)
+        if self.endpoint == "interfaces":
+            application = "virtualization"
+        else:
+            application = self._find_app(self.endpoint)
         nb_app = getattr(self.nb, application)
         nb_endpoint = getattr(nb_app, self.endpoint)
 
         data = self.data
 
         # Used for msg output
-        name = data.get("name")
-
-        data["slug"] = self._to_slug(name)
+        if data.get("name"):
+            name = data["name"]
+        elif data.get("slug"):
+            name = data["slug"]
+
+        if self.endpoint in SLUG_REQUIRED:
+            if not data.get("slug"):
+                data["slug"] = self._to_slug(name)
 
         object_query_params = self._build_query_params(endpoint_name, data)
         try: