Fix Ansible 2.10 sanity tests (#344)

Author: FragmentedPacket

docs/_extensions/pygments_lexer.py

@@ -219,8 +219,8 @@ def __init__(self, **options):
 
 
 def setup(app):
-    """ Initializer for Sphinx extension API.
-        See http://www.sphinx-doc.org/en/stable/extdev/index.html#dev-extensions.
+    """Initializer for Sphinx extension API.
+    See http://www.sphinx-doc.org/en/stable/extdev/index.html#dev-extensions.
     """
     for lexer in [AnsibleOutputLexer(startinline=True)]:
         app.add_lexer(lexer.name, lexer)

plugins/inventory/nb_inventory.py

@@ -274,8 +274,8 @@ def _fetch_information(self, url):
                 )
             except urllib_error.HTTPError as e:
                 """This will return the response body when we encounter an error.
-                   This is to help determine what might be the issue when encountering an error.
-                   Please check issue #294 for more info.
+                This is to help determine what might be the issue when encountering an error.
+                Please check issue #294 for more info.
                 """
                 raise AnsibleError(to_native(e.fp.read()))
 
@@ -299,8 +299,8 @@ def _fetch_information(self, url):
 
     def get_resource_list(self, api_url):
         """Retrieves resource list from netbox API.
-         Returns:
-            A list of all resource from netbox API.
+        Returns:
+           A list of all resource from netbox API.
         """
         if not api_url:
             raise AnsibleError("Please check API URL in script configuration file.")
@@ -938,10 +938,12 @@ def refresh_ipaddresses(self):
                 # We need to copy the ipaddress entry to preserve the original in case caching is used.
                 ipaddress_copy = ipaddress.copy()
 
-                if ipaddress["assigned_object_type"] == 'virtualization.vminterface':
+                if ipaddress["assigned_object_type"] == "virtualization.vminterface":
                     self.vm_ipaddresses_lookup[interface_id][ip_id] = ipaddress_copy
                 else:
-                    self.device_ipaddresses_lookup[interface_id][ip_id] = ipaddress_copy                # Remove "assigned_object_X" attributes, as that's redundant when ipaddress is added to an interface
+                    self.device_ipaddresses_lookup[interface_id][
+                        ip_id
+                    ] = ipaddress_copy  # Remove "assigned_object_X" attributes, as that's redundant when ipaddress is added to an interface
 
                 del ipaddress_copy["assigned_object_id"]
                 del ipaddress_copy["assigned_object_type"]

plugins/module_utils/netbox_ipam.py

@@ -53,8 +53,7 @@ def _handle_state_new_present(self, nb_app, nb_endpoint, endpoint_name, name, da
     def _ensure_ip_in_prefix_present_on_netif(
         self, nb_app, nb_endpoint, data, endpoint_name
     ):
-        """
-        """
+        """"""
         if not data.get("interface") or not data.get("prefix"):
             self._handle_errors("A prefix and interface are required")
 

plugins/module_utils/netbox_utils.py

@@ -412,7 +412,7 @@
     netbox_url=dict(type="str", required=True),
     netbox_token=dict(type="str", required=True, no_log=True),
     state=dict(required=False, default="present", choices=["present", "absent"]),
-    query_params=dict(required=False, type="list"),
+    query_params=dict(required=False, type="list", elements="str"),
     validate_certs=dict(type="raw", default=True),
 )
 

plugins/modules/netbox_aggregate.py

@@ -51,7 +51,7 @@
       rir:
         description:
           - "The RIR the aggregate will be assigned to"
-        required: true
+        required: false
         type: raw
       date_added:
         description:
@@ -87,6 +87,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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."

plugins/modules/netbox_cable.py

@@ -158,6 +158,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_circuit.py

@@ -52,7 +52,7 @@
       provider:
         description:
           - The provider of the circuit
-        required: true
+        required: false
         type: raw
       circuit_type:
         description:
@@ -112,6 +112,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_circuit_termination.py

@@ -100,6 +100,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_circuit_type.py

@@ -68,6 +68,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_cluster.py

@@ -52,7 +52,7 @@
       cluster_type:
         description:
           - type of the cluster
-        required: true
+        required: false
         type: raw
       cluster_group:
         description:
@@ -97,6 +97,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_cluster_group.py

@@ -68,6 +68,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_cluster_type.py

@@ -68,6 +68,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_console_port.py

@@ -97,6 +97,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_console_port_template.py

@@ -87,6 +87,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_console_server_port.py

@@ -97,6 +97,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_console_server_port_template.py

@@ -87,6 +87,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_device.py

@@ -28,7 +28,7 @@
   - David Gomez (@amb1s1)
 requirements:
   - pynetbox
-version_added: '2.8'
+version_added: '0.1.0'
 options:
   netbox_url:
     description:
@@ -174,6 +174,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_device_bay.py

@@ -45,7 +45,7 @@
       device:
         description:
           - The device the device bay will be associated to. The device type must be "parent".
-        required: true
+        required: false
         type: raw
       name:
         description:
@@ -82,6 +82,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_device_bay_template.py

@@ -68,6 +68,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_device_interface.py

@@ -27,7 +27,7 @@
   - Mikhail Yohman (@FragmentedPacket)
 requirements:
   - pynetbox
-version_added: "2.8"
+version_added: "0.1.0"
 options:
   netbox_url:
     description:
@@ -46,7 +46,7 @@
       device:
         description:
           - Name of the device the interface will be associated with (case-sensitive)
-        required: true
+        required: false
         type: raw
       name:
         description:
@@ -141,6 +141,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   validate_certs:
     description:
       - |

plugins/modules/netbox_device_interface_template.py

@@ -81,6 +81,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   validate_certs:
     description:
       - |

plugins/modules/netbox_device_role.py

@@ -50,7 +50,7 @@
       color:
         description:
           - Hexidecimal code for a color, ex. FFFFFF
-        required: true
+        required: false
         type: str
       slug:
         description:
@@ -77,6 +77,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_device_type.py

@@ -45,7 +45,7 @@
       manufacturer:
         description:
           - The manufacturer of the device type
-        required: true
+        required: false
         type: raw
       model:
         description:
@@ -114,6 +114,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_front_port.py

@@ -108,6 +108,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_front_port_template.py

@@ -73,7 +73,7 @@
           - sc
           - sc-apc
           - st
-        required: true
+        required: false
         type: str
       rear_port_template:
         description:
@@ -98,6 +98,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_interface.py

@@ -10,7 +10,7 @@
 
 ANSIBLE_METADATA = {
     "metadata_version": "1.1",
-    "status": ["preview"],
+    "status": ["deprecated"],
     "supported_by": "community",
 }
 
@@ -28,6 +28,10 @@
 requirements:
   - pynetbox
 version_added: "2.8"
+deprecated:
+  removed_in: 0.1.0
+  alternative: Use M(netbox_device_interface) or M(netbox_vm_interface) instead.
+  why: Moved to new modular structure for managing the modules.
 options:
   netbox_url:
     description:

plugins/modules/netbox_inventory_item.py

@@ -46,7 +46,7 @@
       device:
         description:
           - Name of the device the inventory item belongs to
-        required: true
+        required: false
         type: raw
       name:
         description:
@@ -102,6 +102,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   validate_certs:
     description:
       - |

plugins/modules/netbox_ip_address.py

@@ -28,7 +28,7 @@
   - Anthony Ruhier (@Anthony25)
 requirements:
   - pynetbox
-version_added: '2.8'
+version_added: '0.1.0'
 options:
   netbox_url:
     description:
@@ -151,6 +151,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   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.

plugins/modules/netbox_ipam_role.py

@@ -73,6 +73,7 @@
       - an object unique in their environment.
     required: false
     type: list
+    elements: str
   validate_certs:
     description:
       - |