Add out of band IP option

Add oob_ip documentation

Author: Shourai

plugins/inventory/nb_inventory.py

@@ -237,6 +237,10 @@
             type: boolean
             default: True
             version_added: "3.6.0"
+        oob_ip:
+            description: Use out of band IP as `ansible host`
+            type: boolean
+            default: False
 """
 
 EXAMPLES = """
@@ -812,6 +816,13 @@ def extract_primary_ip6(self, host):
         except Exception:
             return
 
+    def extract_oob_ip(self, host):
+        try:
+            address = host["oob_ip"]["address"]
+            return str(ip_interface(address).ip)
+        except Exception:
+            return
+
     def extract_tags(self, host):
         try:
             tag_zero = host["tags"][0]
@@ -1844,6 +1855,10 @@ def _fill_host_variables(self, host, hostname):
         if extracted_primary_ip6:
             self.inventory.set_variable(hostname, "primary_ip6", extracted_primary_ip6)
 
+        extracted_oob_ip = self.extract_oob_ip(host=host)
+        if extracted_oob_ip and self.oob_ip:
+            self.inventory.set_variable(hostname, "ansible_host", extracted_oob_ip)
+
         for attribute, extractor in self.group_extractors.items():
             extracted_value = extractor(host)
 
@@ -2034,6 +2049,7 @@ def parse(self, inventory, loader, path, cache=True):
         self.cert = self.get_option("cert")
         self.key = self.get_option("key")
         self.ca_path = self.get_option("ca_path")
+        self.oob_ip = self.get_option("oob_ip")
 
         self._set_authorization()
 

plugins/module_utils/netbox_utils.py

@@ -161,6 +161,7 @@
     primary_ip="address",
     primary_ip4="address",
     primary_ip6="address",
+    oob_ip="address",
     provider="slug",
     provider_network="name",
     rack="name",
@@ -253,6 +254,7 @@
     "primary_ip": "ip_addresses",
     "primary_ip4": "ip_addresses",
     "primary_ip6": "ip_addresses",
+    "oob_ip": "ip_addresses",
     "provider": "providers",
     "provider_network": "provider_networks",
     "rack": "racks",
@@ -472,6 +474,7 @@
     "prefix": set(["prefix", "vrf"]),
     "primary_ip4": set(["address", "vrf"]),
     "primary_ip6": set(["address", "vrf"]),
+    "oob_ip": set(["address", "vrf"]),
     "provider": set(["slug"]),
     "provider_network": set(["name"]),
     "rack": set(["name", "site", "location"]),

plugins/modules/netbox_device.py

@@ -100,13 +100,13 @@
         description:
           - Airflow of the device
         choices:
-          - front-to-rear 
-          - rear-to-front 
-          - left-to-right 
-          - right-to-left 
+          - front-to-rear
+          - rear-to-front
+          - left-to-right
+          - right-to-left
           - side-to-rear
           - passive
-          - mixed                    
+          - mixed
         required: false
         type: str
         version_added: "3.10.0"
@@ -125,6 +125,11 @@
           - Primary IPv6 address assigned to the device
         required: false
         type: raw
+      oob_ip:
+        description:
+          - Out of band IP address assigned to the device
+        required: false
+        type: raw
       cluster:
         description:
           - Cluster that the device will be assigned to
@@ -306,6 +311,7 @@ def main():
                     status=dict(required=False, type="raw"),
                     primary_ip4=dict(required=False, type="raw"),
                     primary_ip6=dict(required=False, type="raw"),
+                    oob_ip=dict(required=False, type="raw"),
                     cluster=dict(required=False, type="raw"),
                     virtual_chassis=dict(required=False, type="raw"),
                     vc_position=dict(required=False, type="int"),