new_module: netbox_rir

Author: FragmentedPacket

README.md

@@ -37,6 +37,7 @@
 - netbox_rack_group
 - netbox_rack_role
 - netbox_rack
+- netbox_rir
 - netbox_site
 - netbox_tenant
 - netbox_tenant_group

plugins/module_utils/netbox_ipam.py

@@ -27,6 +27,7 @@
 NB_IP_ADDRESSES = "ip_addresses"
 NB_PREFIXES = "prefixes"
 NB_IPAM_ROLES = "roles"
+NB_RIRS = "rirs"
 NB_VLANS = "vlans"
 NB_VLAN_GROUPS = "vlan_groups"
 NB_VRFS = "vrfs"
@@ -126,6 +127,7 @@ def run(self):
         - ipam_roles
         - ip_addresses
         - prefixes
+        - rirs
         - vlans
         - vlan_groups
         - vrfs

plugins/module_utils/netbox_utils.py

@@ -37,7 +37,7 @@
         "sites",
     ],
     extras=[],
-    ipam=["ip_addresses", "prefixes", "roles", "vlans", "vlan_groups", "vrfs"],
+    ipam=["ip_addresses", "prefixes", "rirs", "roles", "vlans", "vlan_groups", "vrfs"],
     secrets=[],
     tenancy=["tenants", "tenant_groups"],
     virtualization=["clusters"],
@@ -62,6 +62,7 @@
     rack_group="slug",
     rack_role="slug",
     region="slug",
+    rir="slug",
     slug="slug",
     site="slug",
     tenant="name",
@@ -94,6 +95,7 @@
     rack_group="rack_groups",
     rack_role="rack_roles",
     region="regions",
+    rir="rirs",
     site="sites",
     tagged_vlans="vlans",
     tenant="tenants",
@@ -117,6 +119,7 @@
     "racks": "rack",
     "rack_groups": "rack_group",
     "rack_roles": "rack_role",
+    "rirs": "rir",
     "roles": "role",
     "sites": "site",
     "tenants": "tenant",
@@ -236,6 +239,7 @@
     "rack": set(["name", "site"]),
     "rack_group": set(["slug"]),
     "rack_role": set(["slug"]),
+    "rir": set(["slug"]),
     "role": set(["slug"]),
     "site": set(["slug"]),
     "tagged_vlans": set(["name", "site", "vlan_group", "tenant"]),
@@ -277,6 +281,7 @@
     "ipam_roles",
     "rack_groups",
     "rack_roles",
+    "rirs",
     "roles",
     "manufacturers",
     "platforms",

plugins/modules/netbox_rir.py

@@ -0,0 +1,138 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2018, Mikhail Yohman (@FragmentedPacket) <mikhail.yohman@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {
+    "metadata_version": "1.1",
+    "status": ["preview"],
+    "supported_by": "community",
+}
+
+DOCUMENTATION = r"""
+---
+module: netbox_rir
+short_description: Create, update or delete RIRs within Netbox
+description:
+  - Creates, updates or removes RIRs from Netbox
+notes:
+  - Tags should be defined as a YAML list
+  - This should be ran with connection C(local) and hosts C(localhost)
+author:
+  - Mikhail Yohman (@FragmentedPacket)
+requirements:
+  - pynetbox
+version_added: '0.1.0'
+options:
+  netbox_url:
+    description:
+      - URL of the Netbox instance resolvable by Ansible control host
+    required: true
+  netbox_token:
+    description:
+      - The token created within Netbox to authorize API access
+    required: true
+  data:
+    description:
+      - Defines the RIR configuration
+    suboptions:
+      name:
+        description:
+          - The name of the RIR
+        required: true
+      is_private:
+        description:
+          - IP space managed by this RIR is considered private
+        type: bool
+    required: true
+  state:
+    description:
+      - Use C(present) or C(absent) for adding or removing.
+    choices: [ absent, present ]
+    default: present
+  validate_certs:
+    description:
+      - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
+    default: 'yes'
+    type: bool
+"""
+
+EXAMPLES = r"""
+- name: "Test Netbox modules"
+  connection: local
+  hosts: localhost
+  gather_facts: False
+
+  tasks:
+    - name: Create RIR within Netbox with only required information
+      netbox_rir:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Test RIR One
+        state: present
+
+    - name: Update Test RIR One
+      netbox_rir:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Test RIR One
+          is_private: True
+        state: present
+
+    - name: Delete RIR within netbox
+      netbox_rir:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Test RIR One
+        state: absent
+"""
+
+RETURN = r"""
+rir:
+  description: Serialized object as created or already existent within Netbox
+  returned: success (when I(state=present))
+  type: dict
+msg:
+  description: Message indicating failure or info about what has been achieved
+  returned: always
+  type: str
+"""
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_ipam import (
+    NetboxIpamModule,
+    NB_RIRS,
+)
+
+
+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),
+    )
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+
+    # Fail if name is not given
+    if not module.params["data"].get("name"):
+        module.fail_json(msg="missing name")
+
+    netbox_rir = NetboxIpamModule(module, NB_RIRS)
+    netbox_rir.run()
+
+
+if __name__ == "__main__":
+    main()

tests/integration/integration-tests.yml

@@ -2191,7 +2191,6 @@
           - test_six['vlan_group'] == None
           - test_six['msg'] == "vlan_group VLAN Group One already absent"
 
-
 ##
 ##
 ### NETBOX_VLAN
@@ -2476,3 +2475,90 @@
           - test_six['vrf']['description'] == "Updated description"
           - test_six['vrf']['tags'][0] == "Schnozzberry"
           - test_six['msg'] == "vrf Test VRF One deleted"
+
+##
+##
+### NETBOX_RIR
+##
+##
+- name: "TEST NETBOX_RIR"
+  connection: local
+  hosts: localhost
+  gather_facts: False
+  collections:
+    - fragmentedpacket.netbox_modules
+
+  tasks:
+    - name: "RIR 1: Necessary info creation"
+      netbox_rir:
+        netbox_url: http://localhost:32768
+        netbox_token: 0123456789abcdef0123456789abcdef01234567
+        data:
+          name: Test RIR One
+        state: present
+      register: test_one
+
+    - name: "RIR 1: ASSERT - Necessary info creation"
+      assert:
+        that:
+          - test_one is changed
+          - test_one['diff']['before']['state'] == "absent"
+          - test_one['diff']['after']['state'] == "present"
+          - test_one['rir']['name'] == "Test RIR One"
+          - test_one['rir']['slug'] == "test-rir-one"
+          - test_one['msg'] == "rir Test RIR One created"
+
+    - name: "RIR 2: Create duplicate"
+      netbox_rir:
+        netbox_url: http://localhost:32768
+        netbox_token: 0123456789abcdef0123456789abcdef01234567
+        data:
+          name: Test RIR One
+        state: present
+      register: test_two
+
+    - name: "RIR 2: ASSERT - Create duplicate"
+      assert:
+        that:
+          - not test_two['changed']
+          - test_two['rir']['name'] == "Test RIR One"
+          - test_two['rir']['slug'] == "test-rir-one"
+          - test_two['msg'] == "rir Test RIR One already exists"
+
+    - name: "RIR 3: ASSERT - Update"
+      netbox_rir:
+        netbox_url: http://localhost:32768
+        netbox_token: 0123456789abcdef0123456789abcdef01234567
+        data:
+          name: "Test RIR One"
+          is_private: true
+        state: present
+      register: test_three
+
+    - name: "RIR 3: ASSERT - Updated"
+      assert:
+        that:
+          - test_three is changed
+          - test_three['diff']['after']['is_private'] == true
+          - test_three['rir']['name'] == "Test RIR One"
+          - test_three['rir']['slug'] == "test-rir-one"
+          - test_three['rir']['is_private'] == true
+          - test_three['msg'] == "rir Test RIR One updated"
+
+    - name: "RIR 4: ASSERT - Delete"
+      netbox_rir:
+        netbox_url: http://localhost:32768
+        netbox_token: 0123456789abcdef0123456789abcdef01234567
+        data:
+          name: "Test RIR One"
+        state: absent
+      register: test_four
+
+    - name: "RIR 4: ASSERT - Delete"
+      assert:
+        that:
+          - test_four is changed
+          - test_four['rir']['name'] == "Test RIR One"
+          - test_four['rir']['slug'] == "test-rir-one"
+          - test_four['rir']['is_private'] == true
+          - test_four['msg'] == "rir Test RIR One deleted"

tests/unit/module_utils/test_netbox_base_class.py

@@ -161,6 +161,7 @@ def test_normalize_data_returns_correct_data(mock_netbox_module):
         "rack_group": "RacK_group",
         "rack_role": "Test Rack Role",
         "region": "Test Region_1",
+        "rir": "Test RIR_One",
         "prefix_role": "TEst Role-1",
         "slug": "Test to_slug",
         "site": "Test Site",
@@ -189,6 +190,7 @@ def test_normalize_data_returns_correct_data(mock_netbox_module):
         "rack_group": "rack_group",
         "rack_role": "test-rack-role",
         "region": "test-region_1",
+        "rir": "test-rir_one",
         "prefix_role": "test-role-1",
         "slug": "test-to_slug",
         "site": "test-site",
@@ -230,6 +232,7 @@ def test_to_slug_returns_valid_slug(mock_netbox_module):
         ("ip_addresses", "ipam"),
         ("prefixes", "ipam"),
         ("roles", "ipam"),
+        ("rirs", "ipam"),
         ("vlans", "ipam"),
         ("vlan_groups", "ipam"),
         ("vrfs", "ipam"),
@@ -524,6 +527,11 @@ def test_change_choices_id(mock_netbox_module, endpoint, data, expected):
             {"name": "Test Rack Role", "slug": "test-rack-role"},
             {"slug": "test-rack-role"},
         ),
+        (
+            "rir",
+            {"name": "Test RIR One", "slug": "test-rir-one"},
+            {"slug": "test-rir-one"},
+        ),
         (
             "site",
             {