Adding netbox_region, netbox_device_bay, and netbox_inventory_item (#20)

Author: FragmentedPacket

README.md

@@ -26,10 +26,12 @@
 ## Existing Modules
 
 - netbox_aggregate
-- netbox_device
+- netbox_device_bay
 - netbox_device_interface
 - netbox_device_role
 - netbox_device_type
+- netbox_device
+- netbox_inventory_item
 - netbox_ip_address
 - netbox_ipam_role
 - netbox_manufacturer
@@ -38,10 +40,11 @@
 - netbox_rack_group
 - netbox_rack_role
 - netbox_rack
+- netbox_region
 - netbox_rir
 - netbox_site
-- netbox_tenant
 - netbox_tenant_group
+- netbox_tenant
 - netbox_vlan_group
 - netbox_vlan
 - netbox_vrf

plugins/module_utils/netbox_dcim.py

@@ -22,15 +22,18 @@
     from netbox_utils import NetboxModule, ENDPOINT_NAME_MAPPING, SLUG_REQUIRED
 
 
+NB_DEVICE_BAYS = "device_bays"
 NB_DEVICES = "devices"
 NB_DEVICE_ROLES = "device_roles"
 NB_DEVICE_TYPES = "device_types"
 NB_INTERFACES = "interfaces"
+NB_INVENTORY_ITEMS = "inventory_items"
 NB_MANUFACTURERS = "manufacturers"
 NB_PLATFORMS = "platforms"
 NB_RACKS = "racks"
 NB_RACK_ROLES = "rack_roles"
 NB_RACK_GROUPS = "rack_groups"
+NB_REGIONS = "regions"
 NB_SITES = "sites"
 
 
@@ -43,16 +46,19 @@ def run(self):
         This function should have all necessary code for endpoints within the application
         to create/update/delete the endpoint objects
         Supported endpoints:
+        - device_bays
         - devices
         - device_roles
         - device_types
         - interfaces
+        - inventory_items
         - manufacturers
         - platforms
         - sites
         - racks
         - rack_roles
         - rack_groups
+        - regions
         """
         # Used to dynamically set key when returning results
         endpoint_name = ENDPOINT_NAME_MAPPING[self.endpoint]

plugins/module_utils/netbox_utils.py

@@ -24,10 +24,12 @@
 API_APPS_ENDPOINTS = dict(
     circuits=[],
     dcim=[
+        "device_bays",
         "devices",
         "device_roles",
         "device_types",
         "interfaces",
+        "inventory_items",
         "manufacturers",
         "platforms",
         "racks",
@@ -60,9 +62,11 @@
     device_role="slug",
     device_type="slug",
     group="slug",
+    installed_device="name",
     manufacturer="slug",
     nat_inside="address",
     nat_outside="address",
+    parent_region="slug",
     platform="slug",
     prefix_role="slug",
     primary_ip="address",
@@ -92,13 +96,15 @@
     device_role="device_roles",
     device_type="device_types",
     group="tenant_groups",
+    installed_device="devices",
     interface="interfaces",
     ip_addresses="ip_addresses",
     lag="interfaces",
     manufacturer="manufacturers",
     nat_inside="ip_addresses",
     nat_outside="ip_addresses",
     platform="platforms",
+    parent_region="regions",
     prefix_role="roles",
     primary_ip="ip_addresses",
     primary_ip4="ip_addresses",
@@ -123,17 +129,20 @@
 
 ENDPOINT_NAME_MAPPING = {
     "aggregates": "aggregate",
+    "device_bays": "device_bay",
     "devices": "device",
     "device_roles": "device_role",
     "device_types": "device_type",
     "interfaces": "interface",
+    "inventory_items": "inventory_item",
     "ip_addresses": "ip_address",
     "manufacturers": "manufacturer",
     "platforms": "platform",
     "prefixes": "prefix",
     "racks": "rack",
     "rack_groups": "rack_group",
     "rack_roles": "rack_role",
+    "regions": "region",
     "rirs": "rir",
     "roles": "role",
     "services": "services",
@@ -245,20 +254,25 @@
 
 ALLOWED_QUERY_PARAMS = {
     "aggregate": set(["prefix", "rir"]),
+    "device_bay": set(["name", "device"]),
     "device": set(["name"]),
     "device_role": set(["slug"]),
     "device_type": set(["slug"]),
+    "installed_device": set(["name"]),
     "interface": set(["name", "device"]),
+    "inventory_item": set(["name", "device"]),
     "ip_address": set(["address", "vrf"]),
     "ip_addresses": set(["address", "vrf", "device"]),
     "lag": set(["name"]),
     "manufacturer": set(["name", "slug"]),
     "nat_inside": set(["vrf", "address"]),
+    "parent_region": set(["slug"]),
     "platform": set(["slug"]),
     "prefix": set(["prefix", "vrf"]),
     "rack": set(["name", "site"]),
     "rack_group": set(["slug"]),
     "rack_role": set(["slug"]),
+    "region": set(["slug"]),
     "rir": set(["slug"]),
     "role": set(["slug"]),
     "services": set(["device", "virtual_machine", "name"]),
@@ -291,6 +305,7 @@
 
 # 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 = {
+    "parent_region": "parent",
     "prefix_role": "role",
     "rack_group": "group",
     "rack_role": "role",
@@ -305,6 +320,7 @@
     "ipam_roles",
     "rack_groups",
     "rack_roles",
+    "regions",
     "rirs",
     "roles",
     "manufacturers",

plugins/modules/netbox_device_bay.py

@@ -0,0 +1,151 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2019, 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_device_bay
+short_description: Create, update or delete device bays within Netbox
+description:
+  - Creates, updates or removes device bays 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 device bay configuration
+    suboptions:
+      device:
+        description:
+          - The device the device bay will be associated to. The device type must be "parent".
+        required: true
+      name:
+        description:
+          - The name of the device bay
+        required: true
+      description:
+        description:
+          - The description of the device bay. This is supported on v2.6+ of Netbox
+      installed_device:
+        description:
+          - The ddevice that will be installed into the bay. The device type must be "child".
+      tags:
+        description:
+          - Any tags that the device bay may need to be associated with
+    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 device bay within Netbox with only required information
+      netbox_device_bay:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          device: Test Nexus One
+          name: "Device Bay One"
+        state: present
+
+    - name: Add device into device bay
+      netbox_device_bay:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          device: Test Nexus One
+          name: "Device Bay One"
+          description: "First child"
+          installed_device: Test Nexus Child One
+        state: absent
+
+    - name: Delete device bay within netbox
+      netbox_device_bay:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Device Bay One
+        state: absent
+
+"""
+
+RETURN = r"""
+device_bay:
+  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_dcim import (
+    NetboxDcimModule,
+    NB_DEVICE_BAYS,
+)
+
+
+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 device_bay name is not given
+    if not module.params["data"].get("name"):
+        module.fail_json(msg="missing name")
+
+    netbox_device_bay = NetboxDcimModule(module, NB_DEVICE_BAYS)
+    netbox_device_bay.run()
+
+
+if __name__ == "__main__":
+    main()