Merge pull request #1518 from netbox-community/feature/add-tenant-to-vlan-group

Add tenant field support to netbox_vlan_group

Author: sc68cal

changelogs/fragments/add-tenant-to-vlan-group.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - "netbox_vlan_group - Add tenant field support (https://github.com/netbox-community/ansible_modules/issues/1446)"

plugins/modules/netbox_vlan_group.py

@@ -91,6 +91,12 @@
         type: list
         elements: raw
         version_added: "3.20.0"
+      tenant:
+        description:
+          - The tenant that the VLAN group will be assigned to
+        required: false
+        type: raw
+        version_added: "3.23.0"
       tags:
         description:
           - The tags to add/update
@@ -145,6 +151,17 @@
           ]
         state: present
 
+    - name: Create vlan group with tenant assignment
+      netbox_vlan_group:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Test vlan group
+          scope_type: "dcim.site"
+          scope: Test Site
+          tenant: Test Tenant
+        state: present
+
     - name: Delete vlan group within netbox
       netbox_vlan_group:
         netbox_url: http://netbox.local
@@ -212,6 +229,7 @@ def main():
                     min_vid=dict(required=False, type="int"),
                     max_vid=dict(required=False, type="int"),
                     vid_ranges=dict(required=False, type="list", elements="raw"),
+                    tenant=dict(required=False, type="raw"),
                     description=dict(required=False, type="str"),
                     tags=dict(required=False, type="list", elements="raw"),
                     custom_fields=dict(required=False, type="dict"),

tests/integration/netbox-deploy.py

@@ -60,7 +60,10 @@ def make_netbox_calls(endpoint, payload):
 # ORDER OF OPERATIONS FOR THE MOST PART
 
 # Create TENANTS
-tenants = [{"name": "Test Tenant", "slug": "test-tenant"}]
+tenants = [
+    {"name": "Test Tenant", "slug": "test-tenant"},
+    {"name": "Test Tenant 2", "slug": "test-tenant-2"},
+]
 created_tenants = make_netbox_calls(nb.tenancy.tenants, tenants)
 # Test Tenant to be used later on
 test_tenant = nb.tenancy.tenants.get(slug="test-tenant")

tests/integration/targets/v4.3/tasks/netbox_vlan_group.yml

@@ -312,3 +312,89 @@
       - results['vlan_group']['scope_id'] == 1
       - results['vlan_group']['description'] == "Ansible updated description"
       - results['msg'] == "vlan_group VLAN Group Location already exists"
+
+- name: "VLAN_GROUP 13: Create VLAN group with tenant"
+  netbox.netbox.netbox_vlan_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      name: VLAN Group Tenant Test
+      scope_type: dcim.site
+      scope: Test Site
+      tenant: Test Tenant
+    state: present
+  register: results
+
+- name: "VLAN_GROUP 13: ASSERT - Create VLAN group with tenant"
+  ansible.builtin.assert:
+    that:
+      - results is changed
+      - results['diff']['before']['state'] == "absent"
+      - results['diff']['after']['state'] == "present"
+      - results['vlan_group']['name'] == "VLAN Group Tenant Test"
+      - results['vlan_group']['slug'] == "vlan-group-tenant-test"
+      - results['vlan_group']['scope_type'] == "dcim.site"
+      - results['vlan_group']['scope_id'] == 1
+      - results['vlan_group']['tenant'] == 1
+      - results['msg'] == "vlan_group VLAN Group Tenant Test created"
+
+- name: "VLAN_GROUP 14: Create duplicate VLAN group with tenant (idempotency)"
+  netbox.netbox.netbox_vlan_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      name: VLAN Group Tenant Test
+      scope_type: dcim.site
+      scope: Test Site
+      tenant: Test Tenant
+    state: present
+  register: results
+
+- name: "VLAN_GROUP 14: ASSERT - Create duplicate VLAN group with tenant (idempotency)"
+  ansible.builtin.assert:
+    that:
+      - results is not changed
+      - results['vlan_group']['name'] == "VLAN Group Tenant Test"
+      - results['vlan_group']['tenant'] == 1
+      - results['msg'] == "vlan_group VLAN Group Tenant Test already exists"
+
+- name: "VLAN_GROUP 15: Update VLAN group tenant"
+  netbox.netbox.netbox_vlan_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      name: VLAN Group Tenant Test
+      scope_type: dcim.site
+      scope: Test Site
+      tenant: Test Tenant 2
+    state: present
+  register: results
+
+- name: "VLAN_GROUP 15: ASSERT - Update VLAN group tenant"
+  ansible.builtin.assert:
+    that:
+      - results is changed
+      - results['diff']['before']['tenant'] == 1
+      - results['diff']['after']['tenant'] == 2
+      - results['vlan_group']['name'] == "VLAN Group Tenant Test"
+      - results['vlan_group']['tenant'] == 2
+      - results['msg'] == "vlan_group VLAN Group Tenant Test updated"
+
+- name: "VLAN_GROUP 16: Delete VLAN group with tenant"
+  netbox.netbox.netbox_vlan_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      name: VLAN Group Tenant Test
+      scope_type: dcim.site
+      scope: Test Site
+    state: absent
+  register: results
+
+- name: "VLAN_GROUP 16: ASSERT - Delete VLAN group with tenant"
+  ansible.builtin.assert:
+    that:
+      - results is changed
+      - results['diff']['before']['state'] == "present"
+      - results['diff']['after']['state'] == "absent"
+      - results['msg'] == "vlan_group VLAN Group Tenant Test deleted"