DCNM_REST: Add support for Encoding Type 'x-www-form-urlencoded'

plugins/httpapi/dcnm.py

@@ -61,6 +61,7 @@ def __init__(self, *args, **kwargs):
         self.version = None
         # Retry count for send API
         self.retrycount = 5
+        self.token = None
 
     def get_version(self):
         return self.version

plugins/module_utils/network/dcnm/dcnm.py

@@ -803,22 +803,43 @@ def dcnm_get_protocol_and_address(module):
     return [split_url[0], split_url[1]]
 
 
+def dcnm_login_retrieve_token(module):
+    # Login to DCNM and retrieve the authentication token
+    conn = Connection(module._socket_path)
+    # If the connection has a token, we will use it.
+    token = conn.get_token()
+    if token is not None:
+        return token
+    # If the connection does not have a token, we will login
+    # using username and password and return the new token.
+    conn.login(conn.get_option("remote_user"), conn.get_option("password"))
+    return conn.get_token()
+
+
 def dcnm_get_auth_token(module):
 
     conn = Connection(module._socket_path)
     return conn.get_token()
 
 
-def dcnm_post_request(path, hdrs, verify_flag, upload_files):
+def dcnm_post_request(path, hdrs, **kwargs):
+    # Keyword Arguments
+    verify_flag = kwargs.get("verify")
+    upload_files = kwargs.get("files")
+    data = kwargs.get("data")
 
-    resp = requests.post(path, headers=hdrs, verify=verify_flag, files=upload_files)
-    json_resp = resp.json()
-    if json_resp:
-        json_resp["RETURN_CODE"] = resp.status_code
-        json_resp["DATA"] = json_resp["message"]
-        json_resp["METHOD"] = "POST"
-        json_resp["REQUEST_PATH"] = path
-        json_resp.pop("message")
+    resp = requests.post(path, data, headers=hdrs, verify=verify_flag, files=upload_files)
+    json_resp = {}
+    json_resp["RETURN_CODE"] = resp.status_code
+    json_resp["METHOD"] = "POST"
+    json_resp["REQUEST_PATH"] = path
+    try:
+        json_resp = resp.json()
+        if json_resp:
+            json_resp["DATA"] = json_resp["message"]
+            json_resp.pop("message")
+    except ValueError:
+        json_resp["DATA"] = resp.text
     return json_resp
 
 

plugins/modules/dcnm_image_upload.py

@@ -636,7 +636,7 @@ def dcnm_image_upload_handle_local_file_transfer(self, elem):
         if file_path:
             upload_files = {"file": open(file_path, "rb")}
 
-            resp = dcnm_post_request(path, headers, False, upload_files)
+            resp = dcnm_post_request(path, headers, verify=False, files=upload_files)
 
             self.result["response"].append(resp)
 

plugins/modules/dcnm_rest.py

@@ -44,6 +44,12 @@
     - json_data
     required: no
     type: raw
+  encoding:
+    description:
+    - 'Type of body encoding to use for the request'
+    choices: ['json', 'text', 'urlencoded']
+    default: json
+    type: str
 author:
     - Mike Wiebe (@mikewiebe)
 """
@@ -91,8 +97,7 @@
 import json
 from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import (
-    dcnm_send,
-)
+    dcnm_send, dcnm_post_request, dcnm_login_retrieve_token)
 
 
 def main():
@@ -101,6 +106,7 @@ def main():
         method=dict(required=True, choices=["GET", "POST", "PUT", "DELETE"]),
         path=dict(required=True, type="str"),
         data=dict(type="raw", required=False, default=None, aliases=["json_data"]),
+        encoding=dict(type="str", default="json", choices=["json", "text", "urlencoded"]),
     )
 
     # seed the result dict
@@ -116,14 +122,30 @@ def main():
             break
     if data is None:
         data = "{}"
+    encoding = module.params["encoding"]
 
     # Determine if this is valid JSON or not
     try:
         json.loads(data)
-        result["response"] = dcnm_send(module, method, path, data)
+        if encoding == "urlencoded":
+            headers = {}
+            auth_token = dcnm_login_retrieve_token(module)
+            headers.update(auth_token)
+            headers.update({'Content-Type': 'application/x-www-form-urlencoded'})
+            resp = dcnm_post_request(path, headers, data=data, verify=False)
+            result["response"] = resp
+        elif encoding == "json":
+            result["response"] = dcnm_send(module, method, path, data)
+        else:
+            msg = "Encoding type '{}' is not supported for input data".format(encoding)
+            module.fail_json(msg=msg)
     except json.JSONDecodeError:
         # Resend data as text since it's not valid JSON
-        result["response"] = dcnm_send(module, method, path, data, "text")
+        if encoding == "text":
+            result["response"] = dcnm_send(module, method, path, data, "text")
+        else:
+            msg = "Encoding type '{}' is not supported for input data".format(encoding)
+            module.fail_json(msg=msg)
 
     if result["response"]["RETURN_CODE"] >= 400:
         module.fail_json(msg=result["response"])