POST Request Support and new actions for netbox 2.1.0 (#4)

* Added action to get available IPs within a prefix

* Added action for available IP POST request

* Bumped version number to 0.2.1

* changed version number as per request

* minor documentation fixes

* minor fixes for circleci

* removed extraneous whitespace

* removed more extraneous whitespace

* removed all of the extraneous whitespace

* 'fixed' email address

* removed email address

Author: whites2

CHANGES.md

@@ -1,4 +1,9 @@
 # Change Log
+## 0.2.0
+- Added action to get available IPs from a prefix
+- Refactored action.py to allow for POST requests as well as GET
+- Added POST version of get_available_ips
+
 ## 0.1.1
 - Added `limit` and `offset` parameters to all actions
 

README.md

@@ -34,3 +34,5 @@ is loaded.
 - **ipam\_get\_vlans**: Get VLAN(s) via optional parameters
 - **ipam\_get\_vrfs**: Get VRF(s) via optional parameters
 - **ipam\_get\_prefixes**: Get Prefix(es) via optional parameters
+- **ipam\_get\_available_ips**: Get available IP Address(es) within a prefix
+- **ipam\_post\_available_ips**: POST request to create an object assigned to the first available IP address within a given prefix

actions/base_post_action.py

@@ -0,0 +1,12 @@
+
+from lib.action import NetboxBaseAction
+
+
+class NetboxBasePostAction(NetboxBaseAction):
+    """Base get action"""
+
+    def run(self, endpoint_uri, **kwargs):
+        """Base get action
+        endpoint_uri is pased from metadata file
+        """
+        return self.post(endpoint_uri, **kwargs)

actions/ipam_get_available_ips.yaml

@@ -0,0 +1,23 @@
+---
+name: ipam_get_available_ips
+pack: netbox
+runner_type: "python-script"
+description: Get available IP addresses within a prefix from NetBox
+enabled: true
+entry_point: base_get_action.py
+parameters:
+  id:
+    type: integer
+    description: ID of the prefix to get.
+  endpoint_uri:
+    immutable: true
+    default: "/api/ipam/prefixes/{{ id }}/available-ips/"
+  limit:
+    type: integer
+    default: 50
+    description: Max limit of objects to return from the request.
+  offset:
+    type: integer
+    default: 0
+    description: Offset result set by X objects. Used for pagination.
+

actions/ipam_post_available_ips.yaml

@@ -0,0 +1,50 @@
+---
+name: ipam_post_available_ips
+pack: netbox
+runner_type: "python-script"
+description: Creates new object with first available IP address in the given prefix
+enabled: true
+entry_point: base_post_action.py
+parameters:
+  id:
+    type: integer
+    description: ID of the prefix to get.
+  endpoint_uri:
+    immutable: true
+    default: "/api/ipam/prefixes/{{ id }}/available-ips/"
+  limit:
+    type: integer
+    default: 50
+    description: Max limit of objects to return from the request.
+  offset:
+    type: integer
+    default: 0
+    description: Offset result set by X objects. Used for pagination.
+  status:
+    type: string
+    description: Status of the newly assigned IP address
+  description: 
+    type: string
+    description: Description of the newly assigned IP address
+  is_pool: 
+    type: boolean
+    description: IP address is a pool
+  vlan:
+    type: integer
+    description: VLAN that this IP address belongs to
+  site:
+    type: integer
+    description: Site that this IP address belongs to
+  prefix:  
+    type: string
+    description: Prefix that this IP address belongs to
+  role:
+    type: integer 
+    description: IP address role
+  vrf:
+    type: integer 
+    description: VRF the IP address is a member of
+  tenant:
+    type: integer
+    description: Tenant the IP address belongs to
+    

actions/lib/action.py

@@ -15,12 +15,10 @@ class NetboxBaseAction(Action):
     def __init__(self, config):
         super(NetboxBaseAction, self).__init__(config)
 
-    def get(self, endpoint_uri, **kwargs):
-        """Make a get request to the API URI passed in
+    def _make_request(self, endpoint_uri, http_action, **kwargs):
+        """Logic to make all types of requests
         """
 
-        self.logger.debug("Calling base get with kwargs: {}".format(kwargs))
-
         if self.config['use_https']:
             url = 'https://'
         else:
@@ -38,6 +36,24 @@ def get(self, endpoint_uri, **kwargs):
             kwargs['id__in'] = ','.join(kwargs['id__in'])
             self.logger.debug('id__in transformed to {}'.format(kwargs['id__in']))
 
-        r = requests.get(url, verify=self.config['ssl_verify'], headers=headers, params=kwargs)
+        if http_action == "GET":
+            self.logger.debug("Calling base get with kwargs: {}".format(kwargs))
+            r = requests.get(url, verify=self.config['ssl_verify'], headers=headers, params=kwargs)
+
+        elif http_action == "POST":
+            self.logger.debug("Calling base post with kwargs: {}".format(kwargs))
+            r = requests.post(url, verify=self.config['ssl_verify'], headers=headers, data=kwargs)
 
         return {'raw': r.json()}
+
+    def get(self, endpoint_uri, **kwargs):
+        """Make a get request to the API URI passed in
+        """
+
+        return self._make_request(endpoint_uri, "GET", **kwargs)
+
+    def post(self, endpoint_uri, **kwargs):
+        """Make a post request to the API URI passed in
+        """
+
+        return self._make_request(endpoint_uri, "POST", **kwargs)

pack.yaml

@@ -6,6 +6,6 @@ keywords:
     - networking
     - ipam
     - dcim
-version: 0.1.1
-author: John Anderson
+version: 0.2.0
+author: John Anderson, Jefferson White
 email: [email protected]