added update methods

Author: Thomas v.d. Jagt

netbox/dcim.py

@@ -35,6 +35,16 @@ def delete_site(self, site_name):
         site_id = self.get_site(name=site_name)[0]['id']
         return self.netbox_con.delete('/dcim/sites/', site_id)
 
+    def update_site(self, site_name, **kwargs):
+        """
+
+        :param site_name: device-type name to update
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        site_id = self.get_site(name=site_name)[0]['id']
+        return self.netbox_con.patch('/dcim/sites/', site_id, **kwargs)
+
     def get_racks(self):
         """Returns the available racks"""
         return self.netbox_con.get('/dcim/racks/')
@@ -68,6 +78,16 @@ def delete_rack(self, rack_name):
         rack_id = self.get_rack(facility_id=rack_name)[0]['id']
         return self.netbox_con.delete('/dcim/racks/', rack_id)
 
+    def update_rack(self, rack_name, **kwargs):
+        """
+
+        :param rack_name: rack_name name to update
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        rack_id = self.get_rack(facility_id=rack_name)[0]['id']
+        return self.netbox_con.patch('/dcim/racks/', rack_id, **kwargs)
+
     def get_devices(self):
         """Get all devices"""
         return self.netbox_con.get('/dcim/devices/')
@@ -80,14 +100,14 @@ def get_device(self, **kwargs):
         """
         return self.netbox_con.get('/dcim/devices/', **kwargs)
 
-    def get_devices_per_rack(self, rack_name):
+    def get_devices_per_rack(self, rack_name, **kwargs):
         """Get devices which belongs to the given rack
 
         :param rack_name: Name of the rack
         :return: list of devices otherwise an empty list
         """
         rack_id = self.get_rack(facility_id=rack_name)[0]['id']
-        return self.netbox_con.get('/dcim/devices', rack_id=rack_id)
+        return self.netbox_con.get('/dcim/devices', rack_id=rack_id, **kwargs)
 
     def create_device(self, name, device_role, site_name, device_type, **kwargs):
         """Create a new device
@@ -168,7 +188,7 @@ def create_device_type(self, model, slug, manufacturer, **kwargs):
         return self.netbox_con.post('/dcim/device-types/', required_fields, **kwargs)
 
     def update_device_type(self, device_type, **kwargs):
-        """
+        """Update device type
 
         :param device_type: device-type name to update
         :param kwargs: requests body dict
@@ -211,7 +231,7 @@ def create_device_role(self, name, color, slug, **kwargs):
         return self.netbox_con.post('/dcim/device-roles/', required_fields, **kwargs)
 
     def update_device_role(self, device_role, **kwargs):
-        """
+        """Update device role
 
         :param device_type: device-type name to update
         :param kwargs: requests body dict
@@ -253,7 +273,7 @@ def create_manufacturer(self, name, slug, **kwargs):
         return self.netbox_con.post('/dcim/manufacturers/', required_fields, **kwargs)
 
     def update_manufacturer(self, manufacturer, **kwargs):
-        """
+        """Update manufacturer
 
         :param manufacturer: manufacturer name to update
         :param kwargs: requests body dict
@@ -295,7 +315,7 @@ def create_platform(self, name, slug, **kwargs):
         return self.netbox_con.post('/dcim/platforms/', required_fields, **kwargs)
 
     def update_platform(self, platform, **kwargs):
-        """
+        """Update platform
 
         :param platform: device name to update
         :param kwargs: requests body dict
@@ -347,7 +367,7 @@ def create_interface(self, name, form_facter, device, **kwargs):
         return self.netbox_con.post('/dcim/interfaces/', required_fields, **kwargs)
 
     def update_interface(self, interface, **kwargs):
-        """
+        """Update interface
 
         :param interface: interface to update
         :param kwargs: requests body dict

netbox/ipam.py

@@ -33,26 +33,25 @@ def create_ip_address(self, address, **kwargs):
         required_fields = {"address": address}
         return self.netbox_con.post('/ipam/ip-addresses/', required_fields, **kwargs)
 
+    def update_ip(self, ip_address, **kwargs):
+        """Update ip address
+
+        :param ip_address: ip address with prefix. Format: 1.1.1.1/32
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        ip_id = self.get_ip(q=ip_address)[0]['id']
+        return self.netbox_con.patch('/ipam/ip-addresses/', ip_id, **kwargs)
+
     def delete_ip_address(self, address):
         """Delete IP address
 
         :param address: IP address to delete
         :return: bool True if successful otherwise raise DeleteException
         """
-        ip_address_id = self.get_ip(address)
+        ip_address_id = self.get_ip(q=address)[0]['id']
         return self.netbox_con.delete('/ipam/ip-addresses/', ip_address_id)
 
-    def __convert_ip_address(self, ip_address):
-        """Convert IP address to id
-
-        :param ip_address: The IP address
-        :return: ip address id if found otherwise bool False
-        """
-        for item in self.get_ip_addresses()['results']:
-            if item['address'] == ip_address:
-                return item['id']
-        return False
-
     def get_ip_prefixes(self):
         """Return all ip prefixes"""
         return self.netbox_con.get('/ipam/prefixes/')
@@ -86,6 +85,16 @@ def delete_ip_prefix(self, **kwargs):
         ip_prefix_id = self.get_ip_prefix(**kwargs)[0]['id']
         return self.netbox_con.delete('/ipam/prefixes/', ip_prefix_id)
 
+    def update_ip_prefix(self, ip_prefix, **kwargs):
+        """Update ip address
+
+        :param ip_prefix: ip prefix to update
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        ip_prefix_id = self.get_ip_prefix(q=ip_prefix)[0]['id']
+        return self.netbox_con.patch('/ipam/prefixes/', ip_prefix_id, **kwargs)
+
     def get_next_available_ip(self, **kwargs):
         """Return next available ip in prefix
 
@@ -128,10 +137,27 @@ def delete_vrf(self, vrf):
         vrf_id = self.get_vrf(name=vrf)[0]['id']
         return self.netbox_con.delete('/ipam/vrfs/', vrf_id)
 
+    def update_vrf(self, vrf_name, **kwargs):
+        """Update vrf
+
+        :param vrf_name: name of the vrf to update
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        vrf_id = self.get_vrf(name=vrf_name)[0]['id']
+        return self.netbox_con.patch('/ipam/vrfs/', vrf_id, **kwargs)
+
     def get_aggregates(self):
         """Return all aggregates"""
         return self.netbox_con.get('/ipam/aggregates/')
 
+    def get_aggregate(self, **kwargs):
+        """Return aggregate
+
+        :param kwargs: arguments
+        :return: aggregate
+        """
+
     def create_aggregate(self, prefix, rir, **kwargs):
         """Creates a new aggregate
 
@@ -146,6 +172,16 @@ def create_aggregate(self, prefix, rir, **kwargs):
         if ipaddress.ip_network(prefix, strict=True):
             return self.netbox_con.post('/ipam/aggregates/', required_fields, **kwargs)
 
+    def update_aggregate(self, prefix, **kwargs):
+        """Update aggregate
+
+        :param prefix: Prefix of the aggregate
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        aggregate_id = self.get_aggregate(prefix=prefix)[0]['id']
+        return self.netbox_con.patch('/ipam/aggregates/', aggregate_id, **kwargs)
+
     def get_rirs(self):
         """Return all rirs"""
         return self.netbox_con.get('/ipam/rirs/')
@@ -177,6 +213,16 @@ def delete_rir(self, rir_name):
         rir_id = self.get_rir(name=rir_name)[0]['id']
         return self.netbox_con.delete('/ipam/rirs/', rir_id)
 
+    def update_rir(self, name, **kwargs):
+        """Update rir
+
+        :param name: Name of the rir
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        rir_id = self.get_rir(name=name)[0]['id']
+        return self.netbox_con.patch('/ipam/rirs/', rir_id, **kwargs)
+
     def get_prefix_roles(self):
         """Return all roles"""
         return self.netbox_con.get('/ipam/roles/')
@@ -208,7 +254,15 @@ def delete_prefix_role(self, prefix_role):
         prefix_role_id = self.get_prefix_role(name=prefix_role)[0]['id']
         return self.netbox_con.delete('/ipam/role/', prefix_role_id)
 
+    def update_prefix_role(self, name, **kwargs):
+        """Update prefix role
 
+        :param name: Name of the prefix role
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        prefix_role_id = self.get_prefix_role(name=name)[0]['id']
+        return self.netbox_con.patch('/ipam/roles/', prefix_role_id, **kwargs)
 
     def get_vlans(self):
         """Return all vlans"""
@@ -241,4 +295,14 @@ def delete_vlan(self, vid):
         vid_id = self.get_vlan(vid=vid)[0]['id']
         return self.netbox_con.delete('/ipam/vlans/', vid_id)
 
+    def update_vlan(self, name, **kwargs):
+        """Update vlan
+
+        :param name: Name of the vlan
+        :param kwargs: requests body dict
+        :return: bool True if successful otherwise raise UpdateException
+        """
+        vlan_id = self.get_vlan(name=name)[0]['id']
+        return self.netbox_con.patch('/ipam/vlans/', vlan_id, **kwargs)
+