Virtualization endpoint actions (#8)

lampwins · web-flow · commit dfd9d5292c57 · 2018-01-11T03:40:58.000-05:00
* added limit and offset params to all actions * bump pack version * added changes file * 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 * added role to devices (#5) * first pass on storing results in keystore * updated keynames * added params to all get actions * added changelog entry and version bumb * added virtualization endpoints and id detail routes * updated readme * added put, post, patch for virtual machine interfaces * added interface connections to readme * changed status to type integer * fix clusters typo
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,4 +1,9 @@
 # Change Log
+## 0.4.0
+- Added support for virtualization enpoints
+  - GET: clusters, cluster groups, cluster types, virtual machine interfaces, virtual machines
+  - POST, PUT, PATCH: virtual machines, virtual machine interfaces
+- Added support for converting to the detail route by passing the `id` parameter on all applicable endpoints. This converts the api route to `<endpoint_uri>/<id>/` which will always return a max of one entity, instead of a list of zero or more entities.
 ## 0.3.2
 - Added new action for getting device interface connections.
 ## 0.3.0
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ is loaded.
 ### DCIM
 - **dcim\_get\_devices**: Get device(s) via optional parameters
 - **dcim\_get\_interfaces**: Get interface(s) via optional parameters
+- **dcim\_get\_interface_connections**: Get interface connection(s) via optional parameters
 - **dcim\_get\_sites**: Get site(s) via optional parameters
 
 ### IPAM
@@ -36,3 +37,16 @@ is loaded.
 - **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
+
+### Virtualization
+- **virtualization\_get\_cluster\_groups**: Get Cluster Group(s) via optional parameters
+- **virtualization\_get\_cluster\_types**: Get Cluster Type(s) via optional parameters
+- **virtualization\_get\_clusters**: Get Cluster(s) via optional parameters
+- **virtualization\_get\_interfaces**: Get Virtual Machine Interface(s) via optional parameters
+- **virtualization\_post\_interfaces**: POST request to create a new Virtual Machine Inteface
+- **virtualization\_put\_interfaces**: PUT request to replace a Virtual Machine Interface
+- **virtualization\_patch\_interfaces**: PATCH request to update a Virtual Machine Interface
+- **virtualization\_get\_virtual_machines**: Get Virtual Machine(s) via optional parameters
+- **virtualization\_post\_virtual_machines**: POST request to create a new Virtual Machine
+- **virtualization\_put\_virtual_machines**: PUT request to replace a Virtual Machine
+- **virtualization\_patch\_virtual_machines**: PATCH request to update a Virtual Machine
diff --git a/actions/base_patch_action.py b/actions/base_patch_action.py
@@ -0,0 +1,12 @@
+
+from lib.action import NetboxBaseAction
+
+
+class NetboxBasePatchAction(NetboxBaseAction):
+    """Base patch action"""
+
+    def run(self, endpoint_uri, **kwargs):
+        """Base patch action
+        endpoint_uri is pased from metadata file
+        """
+        return self.patch(endpoint_uri, **kwargs)
diff --git a/actions/base_post_action.py b/actions/base_post_action.py
@@ -3,10 +3,10 @@
 
 
 class NetboxBasePostAction(NetboxBaseAction):
-    """Base get action"""
+    """Base post action"""
 
     def run(self, endpoint_uri, **kwargs):
-        """Base get action
+        """Base post action
         endpoint_uri is pased from metadata file
         """
         return self.post(endpoint_uri, **kwargs)
diff --git a/actions/base_put_action.py b/actions/base_put_action.py
@@ -0,0 +1,12 @@
+
+from lib.action import NetboxBaseAction
+
+
+class NetboxBasePutAction(NetboxBaseAction):
+    """Base put action"""
+
+    def run(self, endpoint_uri, **kwargs):
+        """Base put action
+        endpoint_uri is pased from metadata file
+        """
+        return self.put(endpoint_uri, **kwargs)
diff --git a/actions/dcim_get_devices.yaml b/actions/dcim_get_devices.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/dcim/devices/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   name:
     type: string
     description: Name of the device
diff --git a/actions/dcim_get_interfaces.yaml b/actions/dcim_get_interfaces.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/dcim/interfaces/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   form_factor:
     type: integer
     description: Form factor value
diff --git a/actions/dcim_get_sites.yaml b/actions/dcim_get_sites.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/dcim/sites/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   name:
     type: string
     description: Name of the site
diff --git a/actions/ipam_get_ip_addresses.yaml b/actions/ipam_get_ip_addresses.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/ipam/ip-addresses/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   family:
     type: string
     description: IP Address family
diff --git a/actions/ipam_get_prefixes.yaml b/actions/ipam_get_prefixes.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/ipam/prefixes/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   family:
     type: string
     description: Prefix family
diff --git a/actions/ipam_get_vlan_groups.yaml b/actions/ipam_get_vlan_groups.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/ipam/vlan-groups/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   name:
     type: string
     description: Name of the VLAN Group(s)
diff --git a/actions/ipam_get_vlans.yaml b/actions/ipam_get_vlans.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/ipam/vlans/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   name:
     type: string
     description: Name of the VLAN(s)
diff --git a/actions/ipam_get_vrfs.yaml b/actions/ipam_get_vrfs.yaml
@@ -9,6 +9,9 @@ parameters:
   endpoint_uri:
     immutable: true
     default: /api/ipam/vrfs/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
   name:
     type: string
     description: Name of the VRF
diff --git a/actions/ipam_post_available_ips.yaml b/actions/ipam_post_available_ips.yaml
@@ -8,7 +8,7 @@ entry_point: base_post_action.py
 parameters:
   id:
     type: integer
-    description: ID of the prefix to get.
+    description: ID of the prefix.
   endpoint_uri:
     immutable: true
     default: "/api/ipam/prefixes/{{ id }}/available-ips/"
@@ -47,4 +47,3 @@ parameters:
   tenant:
     type: integer
     description: Tenant the IP address belongs to
-    
diff --git a/actions/lib/action.py b/actions/lib/action.py
@@ -1,8 +1,8 @@
-
 from st2common.runners.base_action import Action
 
 import requests
 
+
 __all__ = [
     'NetboxBaseAction'
 ]
@@ -24,6 +24,13 @@ def _make_request(self, endpoint_uri, http_action, **kwargs):
         else:
             url = 'http://'
 
+        if kwargs.get('id', False):
+            # modify the `endpoint_uri` to use the detail route
+            endpoint_uri = '{}{}/'.format(endpoint_uri, str(kwargs.pop('id')))
+            self.logger.debug(
+                'endpoint_uri transformed to {} because id was passed'.format(endpoint_uri)
+            )
+
         url = url + self.config['hostname'] + endpoint_uri
 
         headers = {
@@ -44,6 +51,14 @@ def _make_request(self, endpoint_uri, http_action, **kwargs):
             self.logger.debug("Calling base post with kwargs: {}".format(kwargs))
             r = requests.post(url, verify=self.config['ssl_verify'], headers=headers, data=kwargs)
 
+        elif http_action == "PUT":
+            self.logger.debug("Calling base put with kwargs: {}".format(kwargs))
+            r = requests.put(url, verify=self.config['ssl_verify'], headers=headers, data=kwargs)
+
+        elif http_action == "PATCH":
+            self.logger.debug("Calling base patch with kwargs: {}".format(kwargs))
+            r = requests.patch(url, verify=self.config['ssl_verify'], headers=headers, data=kwargs)
+
         return {'raw': r.json()}
 
     def get(self, endpoint_uri, **kwargs):
@@ -57,3 +72,15 @@ def post(self, endpoint_uri, **kwargs):
         """
 
         return self._make_request(endpoint_uri, "POST", **kwargs)
+
+    def put(self, endpoint_uri, **kwargs):
+        """Make a put request to the API URI passed in
+        """
+
+        return self._make_request(endpoint_uri, "PUT", **kwargs)
+
+    def patch(self, endpoint_uri, **kwargs):
+        """Make a patch request to the API URI passed in
+        """
+
+        return self._make_request(endpoint_uri, "PATCH", **kwargs)
diff --git a/actions/virtualization_get_cluster_groups.yaml b/actions/virtualization_get_cluster_groups.yaml
@@ -0,0 +1,33 @@
+---
+name: virtualization_get_cluster_groups
+pack: netbox
+runner_type: "python-script"
+description: Get cluster group(s) from NetBox
+enabled: true
+entry_point: base_get_action.py
+parameters:
+  endpoint_uri:
+    immutable: true
+    default: /api/virtualization/cluster-groups/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
+  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.
+  save_in_key_store:
+    type: boolean
+    default: false
+    description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl.
+  save_in_key_store_key_name:
+    type: string
+    description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl.
+  save_in_key_store_ttl:
+    type: integer
+    default: 60
+    description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name.
diff --git a/actions/virtualization_get_cluster_types.yaml b/actions/virtualization_get_cluster_types.yaml
@@ -0,0 +1,33 @@
+---
+name: virtualization_get_cluster_types
+pack: netbox
+runner_type: "python-script"
+description: Get cluster type(s) from NetBox
+enabled: true
+entry_point: base_get_action.py
+parameters:
+  endpoint_uri:
+    immutable: true
+    default: /api/virtualization/cluster-types/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
+  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.
+  save_in_key_store:
+    type: boolean
+    default: false
+    description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl.
+  save_in_key_store_key_name:
+    type: string
+    description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl.
+  save_in_key_store_ttl:
+    type: integer
+    default: 60
+    description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name.
diff --git a/actions/virtualization_get_clusters.yaml b/actions/virtualization_get_clusters.yaml
@@ -0,0 +1,60 @@
+---
+name: virtualization_get_clusters
+pack: netbox
+runner_type: "python-script"
+description: Get cluster(s) from NetBox
+enabled: true
+entry_point: base_get_action.py
+parameters:
+  endpoint_uri:
+    immutable: true
+    default: /api/virtualization/clusters/
+  id:
+    type: integer
+    description: "If provided, will convert to using the detail route. I.e., <endpoint_uri>/<id>/, meaning a max of one entity will be returned and all other entity query parameters will be ignored."
+  name:
+    type: string
+    description: Name of the cluster
+  id__in:
+    type: array
+    description: List of Cluster IDs
+  q:
+    type: string
+    description: Cluster query
+  site:
+    type: string
+    description: Name of the site
+  site_id:
+    type: integer
+    description: ID of the site
+  group:
+    type: string
+    description: Name of the Cluster Group
+  group_id:
+    type: integer
+    description: ID of the Cluster Group
+  type:
+    type: string
+    description: Name of the Cluster Type
+  type_id:
+    type: integer
+    description: ID of the Cluster Type
+  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.
+  save_in_key_store:
+    type: boolean
+    default: false
+    description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl.
+  save_in_key_store_key_name:
+    type: string
+    description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl.
+  save_in_key_store_ttl:
+    type: integer
+    default: 60
+    description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name.
diff --git a/actions/virtualization_get_interfaces.yaml b/actions/virtualization_get_interfaces.yaml
diff --git a/actions/virtualization_get_virtual_machines.yaml b/actions/virtualization_get_virtual_machines.yaml
diff --git a/actions/virtualization_patch_interfaces.yaml b/actions/virtualization_patch_interfaces.yaml
diff --git a/actions/virtualization_patch_virtual_machines.yaml b/actions/virtualization_patch_virtual_machines.yaml
diff --git a/actions/virtualization_post_interfaces.yaml b/actions/virtualization_post_interfaces.yaml
diff --git a/actions/virtualization_post_virtual_machines.yaml b/actions/virtualization_post_virtual_machines.yaml
diff --git a/actions/virtualization_put_interfaces.yaml b/actions/virtualization_put_interfaces.yaml
diff --git a/actions/virtualization_put_virtual_machines.yaml b/actions/virtualization_put_virtual_machines.yaml
diff --git a/pack.yaml b/pack.yaml
