Skip to content

[Enhancement] Update zos_job_submit module interface #2149

@fernandofloresg

Description

@fernandofloresg

Is there an existing issue for this?

  • There are no existing issues.

Enabler description

As part of the standardization of module interfaces efforts we need to update zos_job_output module.

Some modules have options name changes as well as behavior changes, in this case this module will have name and behavior changes, see below.

  • Refactor option names to the new interface.
  • Update module documentation and examples.
  • Write or update tests to reflect the new interface, new return values should ALWAYS be returned in all modules.
  • Update migration guide stating the changes to be performed by users when migrating to the new 2.0 version.

The current module interface is

src
location
wait_time_s
max_rc
return_output
volume
encoding
    from
    to

And the new proposed interface should be

src
remote_src: Replaces location, we can write some logic to determine if is a data set or uss file.
wait_time: Replaces wait_time_s.
max_rc
return_output
volume
encoding
    from
    to

The current module return values are
Sample

jobs
  job_id
  job_name
  content_type
  duration
  execution_time
  ddnames
    ddname
    record_count
    id
    stepname
    procstep
    byte_count
    content
  ret_code
    msg
    msg_code
    msg_txt
    code
    steps
      step_name
      step_cc
  job_class
  svc_class
  priority
  asid
  creation_date
  creation_time
  queue_position
  program_name

And the new proposed return values should be
Sample

jobs
  job_id
  job_name
  content_type
  duration
  execution_time
  dds: Replaces ddnames.
    dd_name: Replaces ddname.
    record_count
    id
    stepname
    procstep
    byte_count
    content
  ret_code
    msg
    msg_code
    msg_txt
    code
  steps
    step_name
    step_cc
  job_class
  svc_class
  priority
  asid
  creation_date
  creation_time
  queue_position
  program_name

Ansible module

zos_job_submit

Metadata

Metadata

Assignees

Labels

EnablerEnabler taskIn PlanIssue has been accepted put into a planned release

Type

No type

Projects

Status

✅ Done

Relationships

None yet

Development

No branches or pull requests

Issue actions