[Enabler][Research] Standardize module interfaces and create a guideline on designing new modules interface.

[fernandofloresg]

Is there an existing issue for this?

• There are no existing issues.

Enabler description

Modules have been developed by many people with different ideas, this resulted in many inconsistencies across the modules, which code wise translates into technical debt, but more user facing things translates into different options having different meanings in the same collection. So the idea of this task is to do a common interface for all modules and create a guideline on how to design a new modules interface.

Next, is the table of all modules and if their interface is complete or not.

Module	Interface design	Notes
zos_apf – Add or remove libraries to Authorized Program Facility (APF)	Yes
zos_archive – Archive files and data sets on z/OS.	Yes
zos_backup_restore – Backup and restore data sets and volumes	Yes
zos_blockinfile – Manage block of multi-line textual data on z/OS	Yes
zos_copy – Copy data to z/OS	Yes
zos_data_set – Manage data sets	Yes
zos_encode – Perform encoding operations.	Yes
zos_fetch – Fetch data from z/OS	Yes
zos_find – Find matching data sets	Yes
zos_gather_facts – Gather z/OS system facts.	Yes
zos_job_output – Display job output	Yes
zos_job_query – Query job status	Yes
zos_job_submit – Submit JCL	Yes
zos_lineinfile – Manage textual data on z/OS	Yes
zos_mount – Mount a z/OS file system.	Yes
zos_mvs_raw – Run a z/OS program.	Yes
zos_operator – Execute operator command	Yes
zos_operator_action_query – Display messages requiring action	Yes
zos_ping – Ping z/OS and check dependencies.	Yes
zos_script – Run scripts in z/OS	Yes
zos_stat – Retrieve facts from MVS data sets.	Yes
zos_tso_command – Execute TSO commands	Yes
zos_unarchive – Unarchive files and data sets in z/OS.	Yes
zos_volume_init – Initialize volumes or minidisks.	Yes
zos_zfs_resize	Yes	Basically keep the same interface.

Ansible module

No response

[fernandofloresg]

Updated the research to dev docs repository.