Add netbox_user module (#1303)

* Add netbox_user module

* Add netbox_user_group module

* Add netbox_permission module

* Fix sanity checks in netbox_user.py

* Fix netbox_permission test indentation

* Apply black fixes for netbox_permission.py

* Add netbox_token module

* Run make-docs.sh

* Fix ansible-lint

* Update examples for netbox_token

* Rename all permission test cases correctly

* Fix permission filtering

* Correctly generate query parameters for lists of groups and permissions

* Remove unused import

* Restore group='slug' to QUERY_TYPES

* Always update user password if specified

* Set username as user id in QUERY_TYPES

Author: dchiquito

docs/plugins/index.rst

@@ -98,6 +98,7 @@ Modules
 * :ansplugin:`netbox_module module <netbox.netbox.netbox_module#module>` -- Create, update or delete module within NetBox
 * :ansplugin:`netbox_module_bay module <netbox.netbox.netbox_module_bay#module>` -- Create, update or delete module bay within NetBox
 * :ansplugin:`netbox_module_type module <netbox.netbox.netbox_module_type#module>` -- Create, update or delete module types within NetBox
+* :ansplugin:`netbox_permission module <netbox.netbox.netbox_permission#module>` -- Creates or removes permissions from NetBox
 * :ansplugin:`netbox_platform module <netbox.netbox.netbox_platform#module>` -- Create or delete platforms within NetBox
 * :ansplugin:`netbox_power_feed module <netbox.netbox.netbox_power_feed#module>` -- Create, update or delete power feeds within NetBox
 * :ansplugin:`netbox_power_outlet module <netbox.netbox.netbox_power_outlet#module>` -- Create, update or delete power outlets within NetBox
@@ -123,6 +124,11 @@ Modules
 * :ansplugin:`netbox_tag module <netbox.netbox.netbox_tag#module>` -- Creates or removes tags from NetBox
 * :ansplugin:`netbox_tenant module <netbox.netbox.netbox_tenant#module>` -- Creates or removes tenants from NetBox
 * :ansplugin:`netbox_tenant_group module <netbox.netbox.netbox_tenant_group#module>` -- Creates or removes tenant groups from NetBox
+* :ansplugin:`netbox_token module <netbox.netbox.netbox_token#module>` -- Creates or removes tokens from NetBox
+* :ansplugin:`netbox_tunnel module <netbox.netbox.netbox_tunnel#module>` -- Create, update or delete tunnels within NetBox
+* :ansplugin:`netbox_tunnel_group module <netbox.netbox.netbox_tunnel_group#module>` -- Create, update or delete tunnel groups within NetBox
+* :ansplugin:`netbox_user module <netbox.netbox.netbox_user#module>` -- Creates or removes users from NetBox
+* :ansplugin:`netbox_user_group module <netbox.netbox.netbox_user_group#module>` -- Creates or removes user groups from NetBox
 * :ansplugin:`netbox_virtual_chassis module <netbox.netbox.netbox_virtual_chassis#module>` -- Create, update or delete virtual chassis within NetBox
 * :ansplugin:`netbox_virtual_disk module <netbox.netbox.netbox_virtual_disk#module>` -- Creates or removes disks from virtual machines in NetBox
 * :ansplugin:`netbox_virtual_machine module <netbox.netbox.netbox_virtual_machine#module>` -- Create, update or delete virtual\_machines within NetBox
@@ -184,6 +190,7 @@ Modules
     netbox_module_module
     netbox_module_bay_module
     netbox_module_type_module
+    netbox_permission_module
     netbox_platform_module
     netbox_power_feed_module
     netbox_power_outlet_module
@@ -209,6 +216,11 @@ Modules
     netbox_tag_module
     netbox_tenant_module
     netbox_tenant_group_module
+    netbox_token_module
+    netbox_tunnel_module
+    netbox_tunnel_group_module
+    netbox_user_module
+    netbox_user_group_module
     netbox_virtual_chassis_module
     netbox_virtual_disk_module
     netbox_virtual_machine_module

docs/plugins/nb_inventory_inventory.rst

@@ -1993,6 +1993,55 @@ Parameters
       - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-rename_variables"></div>
+
+      .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-rename_variables:
+
+      .. rst-class:: ansible-option-title
+
+      **rename_variables**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-rename_variables" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      Rename variables evaluated by nb\_inventory, before writing them.
+
+      Each list entry contains a dict with a 'pattern' and a 'repl'.
+
+      Both 'pattern' and 'repl' are regular expressions.
+
+      The first matching expression is used, subsequent matches are ignored.
+
+      Internally \`re.sub\` is used.
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-default-bold:`Default:` :ansible-option-default:`[]`
+
       .. raw:: html
 
         </div>

docs/plugins/netbox_cluster_group_module.rst

@@ -198,6 +198,51 @@ Parameters
       Must exist in NetBox
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-data/description"></div>
+
+      .. raw:: latex
+
+        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
+
+      .. _ansible_collections.netbox.netbox.netbox_cluster_group_module__parameter-data/description:
+
+      .. rst-class:: ansible-option-title
+
+      **description**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-data/description" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`string`
+
+      :ansible-option-versionadded:`added in netbox.netbox 3.20.0`
+
+
+      .. raw:: html
+
+        </div>
+
+      .. raw:: latex
+
+        \end{minipage}
+
+    - .. raw:: html
+
+        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
+
+      The description of the cluster group
+
+
       .. raw:: html
 
         </div>

docs/plugins/netbox_cluster_module.rst

@@ -450,6 +450,51 @@ Parameters
       Required if \ :emphasis:`state=present`\  and the cluster does not exist yet
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-data/status"></div>
+
+      .. raw:: latex
+
+        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
+
+      .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/status:
+
+      .. rst-class:: ansible-option-title
+
+      **status**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-data/status" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`any`
+
+      :ansible-option-versionadded:`added in netbox.netbox 3.20.0`
+
+
+      .. raw:: html
+
+        </div>
+
+      .. raw:: latex
+
+        \end{minipage}
+
+    - .. raw:: html
+
+        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
+
+      Status of the cluster
+
+
       .. raw:: html
 
         </div>
@@ -787,7 +832,7 @@ Examples
                 - Schnozzberry
             state: present
 
-        - name: Update the group and site of an existing cluster
+        - name: Update the group, site and status of an existing cluster
           netbox.netbox.netbox_cluster:
             netbox_url: http://netbox.local
             netbox_token: thisIsMyToken
@@ -796,6 +841,7 @@ Examples
               cluster_type: qemu
               cluster_group: GROUP
               site: SITE
+              status: planned
             state: present
 
 

docs/plugins/netbox_custom_field_module.rst

@@ -582,6 +582,51 @@ Parameters
       The content type(s) to apply this custom field to (NetBox 4.0+)
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-data/related_object_type"></div>
+
+      .. raw:: latex
+
+        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
+
+      .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/related_object_type:
+
+      .. rst-class:: ansible-option-title
+
+      **related_object_type**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-data/related_object_type" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`string`
+
+      :ansible-option-versionadded:`added in netbox.netbox 3.20.0`
+
+
+      .. raw:: html
+
+        </div>
+
+      .. raw:: latex
+
+        \end{minipage}
+
+    - .. raw:: html
+
+        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
+
+      The object type of the custom field (if any) (NetBox 4.0+)
+
+
       .. raw:: html
 
         </div>

docs/plugins/netbox_location_module.rst

@@ -240,6 +240,51 @@ Parameters
       The description of the location
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-data/facility"></div>
+
+      .. raw:: latex
+
+        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
+
+      .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/facility:
+
+      .. rst-class:: ansible-option-title
+
+      **facility**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-data/facility" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`string`
+
+      :ansible-option-versionadded:`added in netbox.netbox 3.20.0`
+
+
+      .. raw:: html
+
+        </div>
+
+      .. raw:: latex
+
+        \end{minipage}
+
+    - .. raw:: html
+
+        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
+
+      Data center provider or facility, ex. Equinix NY7
+
+
       .. raw:: html
 
         </div>
@@ -410,6 +455,51 @@ Parameters
       This is auto-generated following NetBox rules if not provided
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-data/status"></div>
+
+      .. raw:: latex
+
+        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
+
+      .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/status:
+
+      .. rst-class:: ansible-option-title
+
+      **status**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-data/status" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`any`
+
+      :ansible-option-versionadded:`added in netbox.netbox 3.20.0`
+
+
+      .. raw:: html
+
+        </div>
+
+      .. raw:: latex
+
+        \end{minipage}
+
+    - .. raw:: html
+
+        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
+
+      Status of the location
+
+
       .. raw:: html
 
         </div>
@@ -734,14 +824,16 @@ Examples
               site: Test Site
             state: present
 
-        - name: Create location within NetBox with a parent location
+        - name: Create location within NetBox with a parent location, status and facility
           netbox.netbox.netbox_location:
             netbox_url: http://netbox.local
             netbox_token: thisIsMyToken
             data:
               name: Child location
               site: Test Site
               parent_location: Test location
+              status: planned
+              facility: Test Facility
             state: present
 
         - name: Delete location within NetBox