Try SpotterSubmit JCL
| "added in version" 1.0.0 of ibm.ibm_zos_core"
Authors: Xiao Yuan Ma (@bjmaxy), Rich Parker (@richp405), Demetrios Dimatos (@ddimatos)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install ibm.ibm_zos_core:==1.9.0
collections:
- name: ibm.ibm_zos_core
version: 1.9.0Submit JCL in a data set, USS file, or file on the controller.
Submit a job and monitor for completion.
For an uncataloged dataset, specify the volume serial number.
- name: Submit JCL in a PDSE member
zos_job_submit:
src: HLQ.DATA.LLQ(SAMPLE)
location: DATA_SET
register: response
- name: Submit JCL in USS with no DDs in the output.
zos_job_submit:
src: /u/tester/demo/sample.jcl
location: USS
return_output: false
- name: Convert local JCL to IBM-037 and submit the job.
zos_job_submit:
src: /Users/maxy/ansible-playbooks/provision/sample.jcl
location: LOCAL
encoding:
from: ISO8859-1
to: IBM-037
- name: Submit JCL in an uncataloged PDSE on volume P2SS01.
zos_job_submit:
src: HLQ.DATA.LLQ(SAMPLE)
location: DATA_SET
volume: P2SS01
- name: Submit a long running PDS job and wait up to 30 seconds for completion.
zos_job_submit:
src: HLQ.DATA.LLQ(LONGRUN)
location: DATA_SET
wait_time_s: 30
- name: Submit a long running PDS job and wait up to 30 seconds for completion.
zos_job_submit:
src: HLQ.DATA.LLQ(LONGRUN)
location: DATA_SET
wait_time_s: 30
- name: Submit JCL and set the max return code the module should fail on to 16.
zos_job_submit:
src: HLQ.DATA.LLQ
location: DATA_SET
max_rc: 16
src:
description:
- The source file or data set containing the JCL to submit.
- It could be a physical sequential data set, a partitioned data set qualified by
a member or a path. (e.g "USER.TEST","USER.JCL(TEST)")
- Or a USS file. (e.g "/u/tester/demo/sample.jcl")
- Or a LOCAL file in ansible control node. (e.g "/User/tester/ansible-playbook/sample.jcl")
required: true
type: str
wait:
default: false
description:
- Setting this option will yield no change, it is disabled. There is no need to set
I(wait); setting I(wait_times_s) is the correct way to configure the amount of time
to wait for a job to execute.
- This option will be removed in ibm.ibm_zos_core collection version 1.10.0
- See option I(wait_time_s).
required: false
type: bool
max_rc:
description:
- Specifies the maximum return code allowed for any job step for the submitted job.
required: false
type: int
volume:
description:
- The volume serial (VOLSER)is where the data set resides. The option is required
only when the data set is not cataloged on the system.
- When configured, the L(zos_job_submit,./zos_job_submit.html) will try to catalog
the data set for the volume serial. If it is not able to, the module will fail.
- Ignored for I(location=USS) and I(location=LOCAL).
required: false
type: str
encoding:
description:
- Specifies which encoding the local JCL file should be converted from and to, before
submitting the job.
- This option is only supported for when I(location=LOCAL).
- If this parameter is not provided, and the z/OS systems default encoding can not
be identified, the JCL file will be converted from UTF-8 to IBM-1047 by default,
otherwise the module will detect the z/OS system encoding.
required: false
suboptions:
from:
default: UTF-8
description:
- The character set of the local JCL file; defaults to UTF-8.
- Supported character sets rely on the target platform; 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 choices 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: false
type: str
wait_time_s:
default: 10
description:
- Option I(wait_time_s) is the total time that module L(zos_job_submit,./zos_job_submit.html)
will wait for a submitted job to complete. The time begins when the module is executed
on the managed node.
- I(wait_time_s) is measured in seconds and must be a value greater than 0 and less
than 86400.
required: false
type: int
use_template:
default: false
description:
- Whether the module should treat C(src) as a Jinja2 template and render it before
continuing with the rest of the module.
- Only valid when C(src) is a local file or directory.
- All variables defined in inventory files, vars files and the playbook will be passed
to the template engine, as well as L(Ansible special variables,https://docs.ansible.com/ansible/latest/reference_appendices/special_variables.html#special-variables),
such as C(playbook_dir), C(ansible_version), etc.
- If variables defined in different scopes share the same name, Ansible will apply
variable precedence to them. You can see the complete precedence order L(in Ansible's
documentation,https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#understanding-variable-precedence)
type: bool
return_output:
default: true
description:
- Whether to print the DD output.
- If false, an empty list will be returned in the ddnames field.
required: false
type: bool
template_parameters:
description:
- Options to set the way Jinja2 will process templates.
- Jinja2 already sets defaults for the markers it uses, you can find more information
at its L(official documentation,https://jinja.palletsprojects.com/en/latest/templates/).
- These options are ignored unless C(use_template) is true.
required: false
suboptions:
auto_reload:
default: false
description:
- Whether to reload a template file when it has changed after the task has started.
type: bool
block_end_string:
default: '%}'
description:
- Marker for the end of a block in Jinja2.
type: str
block_start_string:
default: '{%'
description:
- Marker for the beginning of a block in Jinja2.
type: str
comment_end_string:
default: '#}'
description:
- Marker for the end of a comment in Jinja2.
type: str
comment_start_string:
default: '{#'
description:
- Marker for the beginning of a comment in Jinja2.
type: str
keep_trailing_newline:
default: false
description:
- Whether Jinja2 should keep the first trailing newline at the end of a template
after rendering.
type: bool
line_comment_prefix:
description:
- Prefix used by Jinja2 to identify comment lines.
required: false
type: str
line_statement_prefix:
description:
- Prefix used by Jinja2 to identify line-based statements.
required: false
type: str
lstrip_blocks:
default: false
description:
- Whether Jinja2 should strip leading spaces from the start of a line to a block.
type: bool
newline_sequence:
choices:
- '
'
- "\r"
- "\r\n"
default: '
'
description:
- Sequence that starts a newline in a template.
type: str
trim_blocks:
default: true
description:
- Whether Jinja2 should remove the first newline after a block is removed.
- Setting this option to C(False) will result in newlines being added to the rendered
template. This could create invalid code when working with JCL templates or
empty records in destination data sets.
type: bool
variable_end_string:
default: '}}'
description:
- Marker for the end of a statement to print a variable in Jinja2.
type: str
variable_start_string:
default: '{{'
description:
- Marker for the beginning of a statement to print a variable in Jinja2.
type: str
type: dict
jobs:
contains:
asid:
description: The address Space Identifier (ASID) that is a unique descriptor
for the job address space. Zero if not active.
sample: 0
type: int
creation_date:
description: Date, local to the target system, when the job was created.
sample: '2023-05-04'
type: str
creation_time:
description: Time, local to the target system, when the job was created.
sample: '14:15:00'
type: str
ddnames:
contains:
byte_count:
description: Byte size in a print data set.
sample: 574
type: int
content:
description: The ddname content.
elements: str
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
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_class:
description: Job class for this job.
sample: A
type: str
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
priority:
description: A numeric indicator of the job priority assigned through JES.
sample: 4
type: int
program_name:
description: The name of the program found in the job's last completed step
found in the PGM parameter. Returned when Z Open Automation Utilities (ZOAU)
is 1.2.4 or later.
sample: IEBGENER
type: str
queue_position:
description: The position within the job queue where the jobs resides.
sample: 3
type: int
ret_code:
contains:
code:
description:
- The return code converted to an integer value when available.
- Jobs which have no return code will return NULL, such is the case of a
job that errors or is active.
sample: 0
type: int
msg:
description:
- Job status resulting from the job submission.
- Job status `ABEND` indicates the job ended abnormally.
- Job status `AC` indicates the job is active, often a started task or job
taking long.
- Job status `CAB` indicates a converter abend.
- Job status `CANCELED` indicates the job was canceled.
- Job status `CNV` indicates a converter error.
- Job status `FLU` indicates the job was flushed.
- Job status `JCLERR` or `JCL ERROR` indicates the JCL has an error.
- Job status `SEC` or `SEC ERROR` indicates the job as encountered a security
error.
- Job status `SYS` indicates a system failure.
- Job status `?` indicates status can not be determined.
sample: AC
type: str
msg_code:
description:
- The return code from the submitted job as a string.
sample: 0
type: str
msg_txt:
description: Returns additional information related to the submitted job.
sample: The job JOB00551 was run with special job processing TYPRUN=SCAN.
This will result in no completion, return code or job steps and changed
will be false.
type: str
steps:
contains:
step_cc:
description: The CC returned for this step in the DD section.
sample: 0
type: int
step_name:
description: Name of the step shown as "was executed" in the DD section.
sample: STEP0001
type: str
description: Series of JCL steps that were executed and their return codes.
elements: dict
type: list
description: Return code output collected from the job log.
sample:
ret_code:
code: 0
msg: CC 0000
msg_code: '0000'
msg_txt: ''
steps:
- step_cc: 0
step_name: STEP0001
type: dict
svc_class:
description: Service class for this job.
sample: C
type: str
description: List of jobs output. If no job status is found, this will return an
empty ret_code with msg_txt explanation.
elements: dict
returned: success
sample:
- asid: 0
class: K
content_type: JOB
creation_date: '2023-05-03'
creation_time: '12:13:00'
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_class: K
job_id: JOB00361
job_name: DBDGEN00
owner: OMVSADM
priority: 1
program_name: IEBGENER
queue_position: 3
ret_code:
code: 0
msg: CC 0000
msg_code: '0000'
msg_txt: ''
steps:
- step_cc: 0
step_name: DLORD6
subsystem: STL1
svc_class: '?'
system: STL1
type: list
message:
description: This option is being deprecated
returned: success
sample: Submit JCL operation succeeded.
type: str