jacklotusho.zosgalaxy.zos_jes_job_submit (1.0.2) — module

Install collection

Install with ansible-galaxy collection install jacklotusho.zosgalaxy:==1.0.2

Add to requirements.yml

  collections:
    - name: jacklotusho.zosgalaxy
      version: 1.0.2

Description

This module will submit JCL from PD/PDS , USS, or LOCAL location.

User can set wait for the job output until the job finishes.

For the uncatalogued dataset , please specify the volume id.

Requirements

• Z Open Automation Utilities
• Python 3.6 or higher
• Set the following environment variables for the playbook: `_BPXK_AUTOCVT=ON` `ZOAU_ROOT=/usr/lpp/IBM/zoautil` `PYTHONPATH=${ZOAU_ROOT}/lib/`

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: Submit the JCL 
    zos_jes_job_submit:
       src: TEST.UTILs(SAMPLE)
       location: PDS
       wait: false
       volume:
    register: response

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
  - name: Submit USS job
    zos_jes_job_submit:
        src: /u/tester/demo/sample.jcl
        location: USS
        wait: false
        volume:

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
  - name: Submit LOCAL job
    zos_jes_job_submit:
      src: /Users/maxy/ansible-playbooks/provision/sample.jcl
      location: LOCAL
      wait: false
      volume:

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
  - name: Submit uncatalogued PDS job
    zos_jes_job_submit:
       src: TEST.UNCATLOG.JCL(SAMPLE)
       location: PDS
       wait: false
       volume: P2SS01

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
  - name: Submit long running PDS job, and wait for the job to finish
    zos_jes_job_submit:
       src: TEST.UTILs(LONGRUN)
       location: PDS
       wait: true       

Inputs

    
src:
    description:
    - "The z/OS data set containing the JCL to submit. Physical sequential data set or\
      \ a partitioned data set qualified by a member or a path. (e.g \u201CUSER.TEST\u201D\
      ,\"USER.JCL(TEST)\")"
    required: true

wait:
    choices:
    - true
    - false
    description:
    - Wait for the Job to finish and capture the output. Default is false.
    required: false

volume:
    description:
    - The volume serial (VOLSER) where the data set resides. The option is required only
      when the data set is not catalogued on the system. Ignored for USS and LOCAL.
    required: false

location:
    choices:
    - PDS
    - USS
    - LOCAL
    default: PDS
    description:
    - The JCL location. Usually it's PDS or USS or LOCAL, Default PDS.
    - LOCAL means locally to the managed node.
    required: true

Outputs

changed:
  description: Indicates if any changes were made during module operation.
  type: bool
duration:
  description:
  - The job elapsed time when user choose to wait(true)
  - If user set wait to false, 0 is returned.
  returned: success
  sample: 0 , 50
  type: int
  unit: seconds
jobID:
  description: The submitted job id
  returned: success
  sample: JOB12345
  type: str
jobName:
  description: The submitted job name
  returned: success
  sample: TESTNAME
  type: str
jobOutput:
  contains:
    DDName: DD cards. e.g JESMSGLG
    DDoutput: The output of every DD cards.
    StepName: Job steps name. e.g JES2
  description: All the job output.
  returned: success
  type: List
jobStatus:
  description: The submitted job status
  returned: success
  sample: AC,  CC
  type: str
message:
  description: The output message that the sample module generates
  returned: success
  sample:
    stderr: ''
    stdout: Submit JCL operation succeeded.
  type: complex
returnCode:
  description: The job return code
  returned: success
  sample: 00 , 12
  type: int