Try SpotterSubmit JCL
| "added in version" 1.0.0 of ibm.ibm_zos_core"
Authors: Xiao Yuan Ma (@bjmaxy)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install ibm.ibm_zos_core:==1.3.6
collections:
- name: ibm.ibm_zos_core
version: 1.3.6Submit JCL from DATA_SET , USS, or LOCAL location.
Submit a job and optionally monitor for its execution.
Optionally wait for the job output until the job finishes.
For the uncataloged dataset, specify the volume serial number.
- name: Submit the JCL
zos_job_submit:
src: TEST.UTILs(SAMPLE)
location: DATA_SET
wait: false
register: response
- name: Submit USS job
zos_job_submit:
src: /u/tester/demo/sample.jcl
location: USS
wait: false
return_output: false
- name: Convert a local JCL file to IBM-037 and submit the job
zos_job_submit:
src: /Users/maxy/ansible-playbooks/provision/sample.jcl
location: LOCAL
wait: false
encoding:
from: ISO8859-1
to: IBM-037
- name: Submit uncatalogued PDS job
zos_job_submit:
src: TEST.UNCATLOG.JCL(SAMPLE)
location: DATA_SET
wait: false
volume: P2SS01
- name: Submit long running PDS job, and wait for the job to finish
zos_job_submit:
src: TEST.UTILs(LONGRUN)
location: DATA_SET
wait: true
wait_time_s: 30
src:
description:
- The source directory or data set containing the JCL to submit.
- It could be physical sequential data set or a partitioned data set qualified by
a member or a path. (e.g "USER.TEST","USER.JCL(TEST)")
- Or an USS file. (e.g "/u/tester/demo/sample.jcl")
- Or an LOCAL file in ansible control node. (e.g "/User/tester/ansible-playbook/sample.jcl")
required: true
type: str
wait:
default: false
description:
- Wait for the Job to finish and capture the output. Default is false.
- User can specify the wait time, see option ``wait_time_s``.
required: false
type: bool
max_rc:
description:
- Specifies the maximum return code for the submitted job that should be allowed without
failing the module.
- The ``max_rc`` is only checked when ``wait=true``, otherwise, it is ignored.
required: false
type: int
volume:
description:
- The volume serial (VOLSER) where the data set resides. The option is required only
when the data set is not cataloged on the system. Ignored for USS and LOCAL.
required: false
type: str
encoding:
description:
- Specifies which encoding the local JCL file should be converted from and to, before
submitting the job.
- If this parameter is not provided, and the z/OS systems default encoding can not
be identified, the JCL file will be converted from ISO8859-1 to IBM-1047 by default.
required: false
suboptions:
from:
default: ISO8859-1
description:
- The character set of the local JCL file; defaults to ISO8859-1.
- Supported character sets rely on the target version; the most common character
sets are supported.
required: false
type: str
to:
default: IBM-1047
description:
- The character set to convert the local JCL file to on the remote z/OS system;
defaults to IBM-1047 when z/OS systems default encoding can not be identified.
- If not provided, the module will attempt to identify and use the default encoding
on the z/OS system.
- Supported character sets rely on the target version; the most common character
sets are supported.
required: false
type: str
type: dict
location:
choices:
- DATA_SET
- USS
- LOCAL
default: DATA_SET
description:
- The JCL location. Supported options are DATA_SET, USS or LOCAL.
- DATA_SET can be a PDS, PDSE, or sequential data set.
- USS means the JCL location is located in UNIX System Services (USS).
- LOCAL means locally to the ansible control node.
required: true
type: str
wait_time_s:
default: 60
description:
- When wait is true, the module will wait for a maximum of 60 seconds by default.
- User can set the wait time manually in this option.
required: false
type: int
return_output:
default: true
description:
- Whether to print the DD output.
- If false, an empty list will be returned in ddnames field.
required: false
type: bool
jobs:
contains:
ddnames:
contains:
byte_count:
description: Byte size in a print data set.
sample: 574
type: int
content:
description: The ddname content.
sample:
- "\_\_\_\_\_\_\_\_ 1 //HELLO\_\_\_ JOB (T043JM,JM00,1,0,0,0),'HELLO WORLD\
\ - JRM',CLASS=R,\_\_\_\_\_\_ JOB00134"
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_\_\_ //\_\_\_\_\_\_\_\_\_\
\_\_\_ MSGCLASS=X"
- MSGLEVEL=1
- "NOTIFY=S0JM\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_ \_\_\_ //*\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_\_\_ //* PRINT \\\"HELLO\
\ WORLD\\\" ON JOB OUTPUT\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_\_\_ //*\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_\_\_ //* NOTE THAT THE EXCLAMATION\
\ POINT IS INVALID EBCDIC FOR JCL\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_\_\_ //*\_\_ AND WILL CAUSE\
\ A JCL ERROR\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_\_\_ //*\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_ 2 //STEP0001 EXEC PGM=IEBGENER\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_ 3 //SYSIN\_\_\_ DD DUMMY\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_ 4 //SYSPRINT DD SYSOUT=*\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_ 5 //SYSUT1\_\_ DD *\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_ 6 //SYSUT2\_\_ DD SYSOUT=*\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \""
- "\_\_\_\_\_\_\_\_\_\_\_ \"\_\_\_\_\_\_\_\_ 7 //\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ \" \_\
\_\_\_\_\_\_\_\_"
type: list[str]
ddname:
description: Data definition name.
sample: JESMSGLG
type: str
id:
description: The file ID.
sample: 2
type: str
procstep:
description: Identifies the set of statements inside JCL grouped together
to perform a particular function.
sample: PROC1
type: str
record_count:
description: Count of the number of lines in a print data set.
sample: 17
type: int
stepname:
description: A step name is name that identifies the job step so that other
JCL statements or the operating system can refer to it.
sample: JES2
type: str
description: Data definition names.
elements: dict
type: list
duration:
description: The total lapsed time the JCL ran for.
sample: 0
type: int
job_id:
description: The z/OS job ID of the job containing the spool file.
sample: JOB00134
type: str
job_name:
description: The name of the batch job.
sample: HELLO
type: str
ret_code:
contains:
code:
description: Return code converted to integer value (when possible).
sample: 0
type: int
msg:
description: Return code or abend resulting from the job submission.
sample: CC 0000
type: str
msg_code:
description: Return code extracted from the `msg` so that it can better
evaluated. For example, ABEND(S0C4) would yield ""S0C4".
sample: S0C4
type: str
msg_txt:
description: Returns additional information related to the job.
sample: 'No job can be located with this job name: HELLO'
type: str
description: Return code output collected from job log.
sample:
- code: 0
- msg: CC 0000
- msg_code: '0000'
- msg_txt: ''
type: dict
description: List of jobs output.
elements: dict
returned: success
sample:
- class: K
content_type: JOB
ddnames:
- byte_count: '677'
content:
- '1 J E S 2 J O B L O G -- S Y S T E M S T L 1 -- N
O D E S T L 1 '
- '0 '
- ' 12.50.08 JOB00361 ---- FRIDAY, 13 MAR 2020 ----'
- ' 12.50.08 JOB00361 IRR010I USERID OMVSADM IS ASSIGNED TO THIS JOB.'
- ' 12.50.08 JOB00361 ICH70001I OMVSADM LAST ACCESS AT 12:50:03 ON FRIDAY,
MARCH 13, 2020'
- ' 12.50.08 JOB00361 $HASP373 DBDGEN00 STARTED - INIT 15 - CLASS K -
SYS STL1'
- ' 12.50.08 JOB00361 SMF000I DBDGEN00 C ASMA90 0000'
- ' 12.50.09 JOB00361 SMF000I DBDGEN00 L IEWL 0000'
- ' 12.50.09 JOB00361 $HASP395 DBDGEN00 ENDED - RC=0000'
- 0------ JES2 JOB STATISTICS ------
- '- 13 MAR 2020 JOB EXECUTION DATE'
- '- 28 CARDS READ'
- '- 158 SYSOUT PRINT RECORDS'
- '- 0 SYSOUT PUNCH RECORDS'
- '- 12 SYSOUT SPOOL KBYTES'
- '- 0.00 MINUTES EXECUTION TIME'
ddname: JESMSGLG
id: '2'
procstep: ''
record_count: '16'
stepname: JES2
- byte_count: '2136'
content:
- ' 1 //DBDGEN00 JOB MSGLEVEL=1,MSGCLASS=E,CLASS=K, JOB00361'
- ' // LINES=999999,TIME=1440,REGION=0M, '
- ' // MEMLIMIT=NOLIMIT '
- ' 2 /*JOBPARM SYSAFF=* '
- ' //* '
- ' 3 //DBDGEN PROC MBR=TEMPNAME '
- ' //C EXEC PGM=ASMA90, '
- ' // PARM=''OBJECT,NODECK,NOLIST'' '
- ' //SYSLIB DD DISP=SHR, '
- ' // DSN=IMSBLD.I15RTSMM.SDFSMAC '
- ' //SYSLIN DD DISP=(NEW,PASS),RECFM=F,LRECL=80,BLKSIZE=80, '
- ' // UNIT=SYSDA,SPACE=(CYL,(10,5),RLSE,,) '
- ' //SYSUT1 DD DISP=(NEW,DELETE),UNIT=SYSDA,SPACE=(CYL, '
- ' // (10,5),,,) '
- ' //SYSPRINT DD SYSOUT=* '
- ' //L EXEC PGM=IEWL, '
- ' // PARM=''XREF,NOLIST'', '
- ' // COND=(0,LT,C) '
- ' //SYSLMOD DD DISP=SHR, '
- ' // DSN=IMSTESTL.IMS1.DBDLIB(&MBR) '
- ' //SYSLIN DD DSN=*.C.SYSLIN,DISP=(OLD,DELETE) '
- ' //SYSPRINT DD SYSOUT=* '
- ' //* '
- ' // PEND '
- ' 4 //DLORD6 EXEC DBDGEN, '
- ' // MBR=DLORD6 '
- ' 5 ++DBDGEN PROC MBR=TEMPNAME '
- ' 6 ++C EXEC PGM=ASMA90, '
- ' ++ PARM=''OBJECT,NODECK,NOLIST'' '
- ' 7 ++SYSLIB DD DISP=SHR, '
- ' ++ DSN=IMSBLD.I15RTSMM.SDFSMAC '
- ' 8 ++SYSLIN DD DISP=(NEW,PASS),RECFM=F,LRECL=80,BLKSIZE=80, '
- ' ++ UNIT=SYSDA,SPACE=(CYL,(10,5),RLSE,,) '
- ' 9 ++SYSUT1 DD DISP=(NEW,DELETE),UNIT=SYSDA,SPACE=(CYL, '
- ' ++ (10,5),,,) '
- ' 10 ++SYSPRINT DD SYSOUT=* '
- ' 11 //SYSIN DD DISP=SHR, '
- ' // DSN=IMSTESTL.IMS1.DBDSRC(DLORD6) '
- ' 12 ++L EXEC PGM=IEWL, '
- ' ++ PARM=''XREF,NOLIST'', '
- ' ++ COND=(0,LT,C) '
- ' 13 ++SYSLMOD DD DISP=SHR, '
- ' ++ DSN=IMSTESTL.IMS1.DBDLIB(&MBR) '
- ' IEFC653I SUBSTITUTION JCL - DISP=SHR,DSN=IMSTESTL.IMS1.DBDLIB(DLORD6)'
- ' 14 ++SYSLIN DD DSN=*.C.SYSLIN,DISP=(OLD,DELETE) '
- ' 15 ++SYSPRINT DD SYSOUT=* '
- ' ++* '
ddname: JESJCL
id: '3'
procstep: ''
record_count: '47'
stepname: JES2
- byte_count: '2414'
content:
- ' STMT NO. MESSAGE'
- ' 4 IEFC001I PROCEDURE DBDGEN WAS EXPANDED USING INSTREAM PROCEDURE
DEFINITION'
- ' ICH70001I OMVSADM LAST ACCESS AT 12:50:03 ON FRIDAY, MARCH 13, 2020'
- ' IEF236I ALLOC. FOR DBDGEN00 C DLORD6'
- ' IEF237I 083C ALLOCATED TO SYSLIB'
- ' IGD100I 0940 ALLOCATED TO DDNAME SYSLIN DATACLAS ( )'
- ' IGD100I 0942 ALLOCATED TO DDNAME SYSUT1 DATACLAS ( )'
- ' IEF237I JES2 ALLOCATED TO SYSPRINT'
- ' IEF237I 01A0 ALLOCATED TO SYSIN'
- ' IEF142I DBDGEN00 C DLORD6 - STEP WAS EXECUTED - COND CODE 0000'
- ' IEF285I IMSBLD.I15RTSMM.SDFSMAC KEPT '
- ' IEF285I VOL SER NOS= IMSBG2. '
- ' IEF285I SYS20073.T125008.RA000.DBDGEN00.R0101894 PASSED '
- ' IEF285I VOL SER NOS= 000000. '
- ' IEF285I SYS20073.T125008.RA000.DBDGEN00.R0101895 DELETED '
- ' IEF285I VOL SER NOS= 333333. '
- ' IEF285I OMVSADM.DBDGEN00.JOB00361.D0000101.? SYSOUT '
- ' IEF285I IMSTESTL.IMS1.DBDSRC KEPT '
- ' IEF285I VOL SER NOS= USER03. '
- ' IEF373I STEP/C /START 2020073.1250'
- ' IEF032I STEP/C /STOP 2020073.1250 '
- ' CPU: 0 HR 00 MIN 00.03 SEC SRB: 0 HR 00 MIN 00.00
SEC '
- ' VIRT: 252K SYS: 240K EXT: 1876480K SYS: 11896K'
- ' ATB- REAL: 1048K SLOTS: 0K'
- ' VIRT- ALLOC: 14M SHRD: 0M'
- ' IEF236I ALLOC. FOR DBDGEN00 L DLORD6'
- ' IEF237I 01A0 ALLOCATED TO SYSLMOD'
- ' IEF237I 0940 ALLOCATED TO SYSLIN'
- ' IEF237I JES2 ALLOCATED TO SYSPRINT'
- ' IEF142I DBDGEN00 L DLORD6 - STEP WAS EXECUTED - COND CODE 0000'
- ' IEF285I IMSTESTL.IMS1.DBDLIB KEPT '
- ' IEF285I VOL SER NOS= USER03. '
- ' IEF285I SYS20073.T125008.RA000.DBDGEN00.R0101894 DELETED '
- ' IEF285I VOL SER NOS= 000000. '
- ' IEF285I OMVSADM.DBDGEN00.JOB00361.D0000102.? SYSOUT '
- ' IEF373I STEP/L /START 2020073.1250'
- ' IEF032I STEP/L /STOP 2020073.1250 '
- ' CPU: 0 HR 00 MIN 00.00 SEC SRB: 0 HR 00 MIN 00.00
SEC '
- ' VIRT: 92K SYS: 256K EXT: 1768K SYS: 11740K'
- ' ATB- REAL: 1036K SLOTS: 0K'
- ' VIRT- ALLOC: 11M SHRD: 0M'
- ' IEF375I JOB/DBDGEN00/START 2020073.1250'
- ' IEF033I JOB/DBDGEN00/STOP 2020073.1250 '
- ' CPU: 0 HR 00 MIN 00.03 SEC SRB: 0 HR 00 MIN 00.00
SEC '
ddname: JESYSMSG
id: '4'
procstep: ''
record_count: '44'
stepname: JES2
- byte_count: '1896'
content:
- '1z/OS V2 R2 BINDER 12:50:08 FRIDAY MARCH 13, 2020 '
- ' BATCH EMULATOR JOB(DBDGEN00) STEP(DLORD6 ) PGM= IEWL PROCEDURE(L ) '
- ' IEW2278I B352 INVOCATION PARAMETERS - XREF,NOLIST '
- ' IEW2650I 5102 MODULE ENTRY NOT PROVIDED. ENTRY DEFAULTS TO SECTION DLORD6. '
- ' '
- ' '
- '1 C R O S S - R E F E R E N C E T
A B L E '
- ' _________________________________________ '
- ' '
- ' TEXT CLASS = B_TEXT '
- ' '
- ' --------------- R E F E R E N C E -------------------------- T A R G
E T -------------------------------------------'
- ' CLASS ELEMENT | ELEMENT |'
- ' OFFSET SECT/PART(ABBREV) OFFSET TYPE | SYMBOL(ABBREV) SECTION
(ABBREV) OFFSET CLASS NAME |'
- ' | |'
- ' *** E N D O F C R O S S R E F
E R E N C E *** '
- '1z/OS V2 R2 BINDER 12:50:08 FRIDAY MARCH 13, 2020 '
- ' BATCH EMULATOR JOB(DBDGEN00) STEP(DLORD6 ) PGM= IEWL PROCEDURE(L ) '
- ' IEW2850I F920 DLORD6 HAS BEEN SAVED WITH AMODE 24 AND RMODE 24. ENTRY
POINT NAME IS DLORD6. '
- ' IEW2231I 0481 END OF SAVE PROCESSING. '
- ' IEW2008I 0F03 PROCESSING COMPLETED. RETURN CODE = 0. '
- ' '
- ' '
- ' '
- '1---------------------- '
- ' MESSAGE SUMMARY REPORT '
- ' ---------------------- '
- ' TERMINAL MESSAGES (SEVERITY = 16) '
- ' NONE '
- ' '
- ' SEVERE MESSAGES (SEVERITY = 12) '
- ' NONE '
- ' '
- ' ERROR MESSAGES (SEVERITY = 08) '
- ' NONE '
- ' '
- ' WARNING MESSAGES (SEVERITY = 04) '
- ' NONE '
- ' '
- ' INFORMATIONAL MESSAGES (SEVERITY = 00) '
- ' 2008 2231 2278 2650 2850 '
- ' '
- ' '
- ' **** END OF MESSAGE SUMMARY REPORT **** '
- ' '
ddname: SYSPRINT
id: '102'
procstep: L
record_count: '45'
stepname: DLORD6
job_id: JOB00361
job_name: DBDGEN00
owner: OMVSADM
ret_code:
code: 0
msg: CC 0000
msg_code: '0000'
msg_txt: ''
subsystem: STL1
type: list
message:
description: The output message that the sample module generates.
returned: success
sample: Submit JCL operation succeeded.
type: str