add fail_on_nodata attribute to cmci_get

Signed-off-by: Andrew Twydell <[email protected]>

Author: AndrewTwydell

plugins/module_utils/cmci.py

@@ -418,8 +418,8 @@ def handle_response(self, response_dict):  # type: (Dict) -> None
                     feedback = errors_node[FEEDBACK]
                     self.result[FEEDBACK] = read_error_node(feedback)
 
-            # Non-OK CPSM responses fail the module
-            if cpsm_response_code != 1024:
+            # If CPSM response code not in Valid List, fail the module
+            if self.get_ok_cpsm_response_codes().count(cpsm_response_code) == 0:
                 self._fail(
                     'CMCI request failed with response "{0}" reason "{1}"'
                     .format(
@@ -436,6 +436,9 @@ def handle_response(self, response_dict):  # type: (Dict) -> None
                 'Could not parse CMCI response: missing node "{0}"'
                 .format(e.args[0])
             )
+    
+    def get_ok_cpsm_response_codes(self):
+        return [1024]
 
     def init_url(self):  # type: () -> str
         t = self._p.get(TYPE).lower()

plugins/modules/cmci_get.py

@@ -40,6 +40,15 @@
       - The count value must be an integer; a value of zero is not permitted.
     type: int
     required: false
+  fail_on_nodata:
+    description:
+      - Specifies whether the module should fail if no data is returned by the
+        query. If set to true, the module will fail if no data is returned.
+      - Default behaviour is for the module to fail if no data is returned. When 
+        set to false, the module will return OK, just with no records.
+    type: bool
+    required: false
+    default: true
 '''
 
 
@@ -87,6 +96,23 @@
           value: MYGRP
     record_count: 1
 
+- name: pass module even if bundle definition is not found
+  cmci_get:
+    cmci_host: 'winmvs2c.hursley.ibm.com'
+    cmci_port: 10080
+    cmci_cert: './sec/ansible.pem'
+    cmci_key: './sec/ansible.key'
+    context: 'iyk3z0r9'
+    type: cicsdefinitionbundle
+    resources:
+          filter:
+            name: MYBUNDLE
+          get_parameters:
+            - name: csdgroup
+              value: MYGRP
+        record_count: 1
+        fail_on_nodata: "false"
+
 - name: Using complex_filter to combine filter expressions and change operators
   cmci_get:
     cmci_host: 'winmvs2c.hursley.ibm.com'
@@ -496,6 +522,7 @@
 
 
 _RECORD_COUNT = 'record_count'
+_FAIL_ON_NODATA = 'fail_on_nodata'
 
 
 class AnsibleCMCIGetModule(AnsibleCMCIModule):
@@ -507,6 +534,10 @@ def init_argument_spec(self):  # type: () -> Dict
         argument_spec.update({
             _RECORD_COUNT: {
                 'type': 'int'
+            }, 
+            _FAIL_ON_NODATA: {
+                'type': 'bool',
+                'default': True
             }
         })
         argument_spec.update(RESOURCES_ARGUMENT)
@@ -522,6 +553,14 @@ def init_url(self):  # type: () -> str
             url = url + '//' + str(self._p.get(_RECORD_COUNT))
 
         return url
+    
+    def get_ok_cpsm_response_codes(self):
+        ok_codes = super(AnsibleCMCIGetModule, self).get_ok_cpsm_response_codes()
+
+        if not self._p.get(_FAIL_ON_NODATA):
+            ok_codes.append(1027)
+
+        return ok_codes
 
 
 def main():