DNS, IPAM, Scripting Ingest

Added support for DNS, IPAM and Scripting Ingest
Also updated each ingest call to allow for pass of template_properties

Author: mbomb67

onefuse/admin.py

@@ -1340,7 +1340,8 @@ def get_onefuse_instance_id(self):
             return None
 
     def ingest_name(self, policy_name: str, name: str,
-                    dns_suffix: str = "", tracking_id: str = ""):
+                    dns_suffix: str = "", template_properties: dict = None,
+                    tracking_id: str = ""):
         """
         Ingest an existing name to OneFuse - the policy will not execute but
         an object will be added to the OneFuse database.
@@ -1369,7 +1370,8 @@ def ingest_name(self, policy_name: str, name: str,
             "policy": policy_url,
             "workspace": workspace_url,
             "name": name,
-            "dnsSuffix": dns_suffix
+            "dnsSuffix": dns_suffix,
+            "templateProperties": template_properties
         }
         path = "/customNames/ingest/"
         response_json = self.request(path, template, tracking_id)
@@ -1388,7 +1390,209 @@ def delete_ingested_name(self, id: str):
         path = f"/customNames/{id}/ingest/"
         response_json = self.deprovision_mo(path)
         return response_json
-    
+
+    def ingest_dns_reservation(self, policy_name: str, name: str,
+                               records: list[dict],
+                               template_properties: dict = None,
+                               tracking_id: str = ""):
+        """
+        Ingest an existing DNS Reservation to OneFuse - the policy will not
+        execute but an object will be added to the OneFuse database.
+
+        Parameters
+        ----------
+        policy_name : str
+            OneFuse DNS Policy Name
+        name : str
+            Name for the Name object, typically a hostname
+        records : list(dict
+            List of records to be included in DNS reservation.
+            Ex: [{"type": "a", "value": "10.1.0.60", "name": "test.example.com"}]
+            Valid types: a, ptr, host (infoblox only)
+        tracking_id : str - optional
+            OneFuse Tracking ID. If not passed, one will be returned from the
+            execution. Tracking IDs allow for grouping all executions for a
+            single object
+        """
+        # Get Naming Policy by Name
+        policy_path = 'dnsPolicies'
+        policy_json = self.get_policy_by_name(policy_path, policy_name)
+        links = policy_json["_links"]
+        policy_url = links["self"]["href"]
+        workspace_url = links["workspace"]["href"]
+        # Validate records
+        for record in records:
+            if record["type"] not in ["a", "ptr", "host"]:
+                raise ValueError(f"Invalid DNS record type: {record['type']}")
+        # Ingest DNS Reservation
+        template = {
+            "policy": policy_url,
+            "workspace": workspace_url,
+            "name": name,
+            "records": records,
+            "templateProperties": template_properties
+        }
+        path = "/dnsReservations/ingest/"
+        response_json = self.request(path, template, tracking_id)
+        return response_json
+
+    def delete_ingested_dns_reservation(self, id: str):
+        """
+        Delete an ingested DNS Reservation from OneFuse - The deleted object
+        will be removed from the OneFuse database without deprovisioning.
+
+        Parameters
+        ----------
+        id : str
+            ID for the Name object
+        """
+        path = f"/dnsReservations/{id}/ingest/"
+        response_json = self.deprovision_mo(path)
+        return response_json
+
+    def ingest_ip_address(self, policy_name: str, ip_address: str,
+                          hostname: str, subnet: str, primary_dns: str = None,
+                          secondary_dns: str = None, dns_suffix: str = None,
+                          dns_search_suffixes: str = None, gateway: str = None,
+                          netmask: str = None, network: str = None,
+                          template_properties: dict = None,
+                          nic_label: str = None, tracking_id: str = ""):
+        """
+        Ingest an existing IP Address to OneFuse - the policy will not
+        execute but an object will be added to the OneFuse database.
+
+        Parameters
+        ----------
+        policy_name : str
+            OneFuse IPAM Policy Name
+        ip_address : str
+            IP Address for the IP Address object. Ex: '10.1.0.25
+        hostname : str
+            Hostname for the IP Address object. Ex. 'myhost.example.com'
+        subnet : str
+            Value for the Subnet in CIDR notation. Ex: '10.1.0.0/24'
+        primary_dns : str
+            Optional Primary DNS for the IP Address object. Ex: '10.0.0.10
+        secondary_dns : str
+            Optional Secondary DNS for the IP Address object. Ex: '10.0.0.10
+        dns_suffix : str
+            Optional Value for the DNS Suffix. Ex: 'example.com'
+        dns_search_suffixes : str
+            Optional Value for the DNS Search Suffixes. Comma separated.
+            Ex: 'example.com,example2.com'
+        gateway : str
+            Optional Value for the Gateway. Ex: '10.1.0.1'
+        netmask : str
+            Optional Value for the Netmask. Ex: '255.255.255.0'
+        network : str
+            Optional Value for the Network. Ex: 'NameOfPortGroupInVcenter'
+        nic_label : str
+            Optional - Value for the NIC Label. Ex: 'eth0'
+        template_properties : dict
+            Optional - Dictionary of template properties. Ex: {'key': 'value'}
+        tracking_id : str - optional
+            OneFuse Tracking ID. If not passed, one will be returned from the
+            execution. Tracking IDs allow for grouping all executions for a
+            single object
+        """
+        # Get Naming Policy by Name
+        policy_path = 'ipamPolicies'
+        policy_json = self.get_policy_by_name(policy_path, policy_name)
+        links = policy_json["_links"]
+        policy_url = links["self"]["href"]
+        workspace_url = links["workspace"]["href"]
+        # Ingest IP Address
+        template = {
+            "policy": policy_url,
+            "workspace": workspace_url,
+            "ipAddress": ip_address,
+            "hostname": hostname,
+            "primaryDns": primary_dns,
+            "secondaryDns": secondary_dns,
+            "dnsSuffix": dns_suffix,
+            "dnsSearchSuffixes": dns_search_suffixes,
+            "nicLabel": nic_label,
+            "gateway": gateway,
+            "netmask": netmask,
+            "network": network,
+            "subnet": subnet,
+            "templateProperties": template_properties
+        }
+        path = "/ipamReservations/ingest/"
+        response_json = self.request(path, template, tracking_id)
+        return response_json
+
+    def delete_ingested_ip_address(self, id: str):
+        """
+        Delete an ingested IP Address from OneFuse - The deleted object will be
+        removed from the OneFuse database without deprovisioning.
+
+        Parameters
+        ----------
+        id : str
+            ID for the IP Address object
+        """
+        path = f"/ipamReservations/{id}/ingest/"
+        response_json = self.deprovision_mo(path)
+        return response_json
+
+    def ingest_scripting_deployment(self, policy_name: str,
+                                    provisioning_details: dict,
+                                    deprovisioning_details: dict,
+                                    template_properties: dict = None,
+                                    tracking_id: str = ""):
+        """
+        Ingest an existing Scripting Deployment to OneFuse - the policy will not
+        execute but an object will be added to the OneFuse database.
+
+        Parameters
+        ----------
+        policy_name : str
+            OneFuse Scripting Policy Name
+        provisioning_details : dict
+           Scripting provisioning details.
+           Ex. {"status": "successful", "output": []}
+        deprovisioning_details : dict
+            Scripting deprovisioning details
+        template_properties : dict
+        tracking_id : str - optional
+            OneFuse Tracking ID. If not passed, one will be returned from the
+            execution. Tracking IDs allow for grouping all executions for a
+            single object
+        """
+        # Get Naming Policy by Name
+        policy_path = 'scriptingPolicies'
+        policy_json = self.get_policy_by_name(policy_path, policy_name)
+        links = policy_json["_links"]
+        policy_url = links["self"]["href"]
+        workspace_url = links["workspace"]["href"]
+        # Ingest Scripting Deployment
+        template = {
+            "policy": policy_url,
+            "workspace": workspace_url,
+            "provisioning_details": provisioning_details,
+            "deprovisioning_details": deprovisioning_details,
+            "templateProperties": template_properties
+        }
+        path = "/scriptingDeployments/ingest/"
+        response_json = self.request(path, template, tracking_id)
+        return response_json
+
+    def delete_ingested_scripting_deployment(self, id: str):
+        """
+        Delete an ingested Scripting Deployment from OneFuse - The deleted
+        object will be removed from the OneFuse database without
+        deprovisioning.
+
+        Parameters
+        ----------
+        id : str
+            ID for the Scripting Deployment object
+        """
+        path = f"/scriptingDeployments/{id}/ingest/"
+        response_json = self.deprovision_mo(path)
+        return response_json
+
 
 if __name__ == '__main__':
     username = sys.argv[1]  # 'OneFuse Username'