[zos backup restore]Added Return Values in documentation (#2049)

* added  documenttaion for return in successfull cases

* added return in documentation for failure case

* added fragments #2037

* typo error

* remoded failure case

* updated doc

* Update 2049-zos_backup_restore-added-return-values-in-doc.yml

---------

Co-authored-by: Fernando Flores <[email protected]>

Author: mayankmani-sde

changelogs/fragments/2049-zos_backup_restore-added-return-values-in-doc.yml

@@ -0,0 +1,4 @@
+trivial:
+  - zos_backup_restore - Updated documentation on zos_backup_restore to notify about return
+    values of Backup and restore operation.
+     (https://github.com/ansible-collections/ibm_zos_core/pull/2049).

plugins/modules/zos_backup_restore.py

@@ -227,8 +227,6 @@
       documentation to configure the required security classes.
 """
 
-RETURN = r""""""
-
 EXAMPLES = r"""
 - name: Backup all data sets matching the pattern USER.** to data set MY.BACKUP.DZP
   zos_backup_restore:
@@ -351,6 +349,28 @@
     sms_storage_class: DB2SMS10
     sms_management_class: DB2SMS10
 """
+RETURN = r"""
+changed:
+  description:
+    - Indicates if the operation made changes.
+    - C(true) when backup/restore was successful, C(false) otherwise.
+  returned: always
+  type: bool
+  sample: true
+backup_name:
+  description:
+    - The USS file name or data set name that was used as a backup.
+    - Matches the I(backup_name) parameter provided as input.
+  returned: always
+  type: str
+  sample: "/u/oeusr03/my_backup.dzp"
+message:
+  description:
+    - Returns any important messages about the modules execution, if any.
+  returned: always
+  type: str
+  sample: ""
+"""
 
 import traceback
 from os import path