Custom Header Support

changelogs/fragments/1327-add-custom-headers.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - Add support for custom headers

plugins/inventory/nb_inventory.py

@@ -264,6 +264,11 @@
                 - By default, the inventory hostname is the netbox device name
                 - If set, sets the inventory hostname from this field in custom_fields instead
             default: False
+        headers:
+            description: Dictionary of headers to be passed to the NetBox API.
+            default: {}
+            env:
+                - name: NETBOX_HEADERS
 """
 
 EXAMPLES = """
@@ -281,6 +286,8 @@
 device_query_filters:
   - has_primary_ip: 'true'
   - tenant__n: internal
+headers:
+  Cookie: "{{ auth_cookie }}"
 
 # has_primary_ip is a useful way to filter out patch panels and other passive devices
 # Adding '__n' to a field searches for the negation of the value.
@@ -2115,6 +2122,12 @@ def _set_authorization(self):
                 )
             else:
                 self.headers.update({"Authorization": "Token %s" % token})
+        headers = self.get_option("headers")
+        if headers:
+            if isinstance(headers, str):
+                headers = json.loads(headers)
+            if isinstance(headers, dict):
+                self.headers.update(headers)
 
     def parse(self, inventory, loader, path, cache=True):
         super(InventoryModule, self).parse(inventory, loader, path)

plugins/lookup/nb_lookup.py

@@ -51,6 +51,11 @@
                 - name: NETBOX_TOKEN
                 - name: NETBOX_API_TOKEN
             required: false
+        headers:
+            description: Dictionary of headers to be passed to the NetBox API.
+            default: {}
+            env:
+                - name: NETBOX_HEADERS
         validate_certs:
             description:
                 - Whether or not to validate SSL of the NetBox instance
@@ -108,6 +113,7 @@
 
 import os
 import functools
+import json
 from pprint import pformat
 
 from ansible.errors import AnsibleError
@@ -411,6 +417,7 @@ def run(self, terms, variables=None, **kwargs):
             or os.getenv("NETBOX_API")
             or os.getenv("NETBOX_URL")
         )
+        netbox_headers = kwargs.get("headers") or os.getenv("NETBOX_HEADERS") or {}
         netbox_ssl_verify = kwargs.get("validate_certs", True)
         netbox_private_key = kwargs.get("private_key")
         netbox_private_key_file = kwargs.get("key_file")
@@ -421,8 +428,12 @@ def run(self, terms, variables=None, **kwargs):
         if not isinstance(terms, list):
             terms = [terms]
 
+        if isinstance(netbox_headers, str):
+            netbox_headers = json.loads(netbox_headers)
+
         try:
             session = requests.Session()
+            session.headers = netbox_headers
             session.verify = netbox_ssl_verify
 
             if Version(version("pynetbox")) < Version("7.0.0"):