Skip to content

Commit 2a439ba

Browse files
andrewhughes101andrewhughes101
committed
regen rsts
1 parent 4b89edf commit 2a439ba

File tree

3 files changed

+147
-29
lines changed

3 files changed

+147
-29
lines changed

‎docs/source/modules/aux_trace.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,13 +135,13 @@ space_type
135135

136136
This option takes effect only when the auxiliary trace data set is being created. If the data set already exists, the option has no effect.
137137

138-
The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), records (\ :literal:`REC`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ).
138+
The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ).
139139

140140

141141
| **required**: False
142142
| **type**: str
143143
| **default**: M
144-
| **choices**: M, K, REC, CYL, TRK
144+
| **choices**: M, K, CYL, TRK
145145
146146

147147

‎docs/source/modules/start_cics.rst‎ renamed to ‎docs/source/modules/region_jcl.rst‎

Lines changed: 143 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
.. Apache License, Version 2.0 (see https://opensource.org/licenses/Apache-2.0) .
44
.. ...............................................................................
55
6-
:github_url: https://github.com/ansible-collections/ibm_zos_cics/blob/main/plugins/modules/start_cics.py
6+
:github_url: https://github.com/ansible-collections/ibm_zos_cics/blob/main/plugins/modules/region_jcl.py
77

8-
.. _start_cics_module:
8+
.. _region_jcl_module:
99

1010

11-
start_cics -- Start a CICS region
12-
=================================
11+
region_jcl -- Create CICS region JCL data set
12+
=============================================
1313

1414

1515

@@ -20,7 +20,7 @@ start_cics -- Start a CICS region
2020

2121
Synopsis
2222
--------
23-
- Start a CICS® region by providing CICS system data sets and system initialization parameters for CICS startup using the \ :literal:`DFHSIP`\ program.
23+
- Create a data set containing JCL to start a CICS® region by providing CICS system data sets and system initialization parameters for CICS startup using the \ :literal:`DFHSIP`\ program.
2424

2525

2626

@@ -842,6 +842,25 @@ region_data_sets
842842

843843

844844

845+
dfhstart
846+
Overrides the templated location for the JCL data set.
847+
848+
849+
| **required**: False
850+
| **type**: dict
851+
852+
853+
854+
dsn
855+
The data set name of the JCL data set to override the template.
856+
857+
858+
| **required**: False
859+
| **type**: str
860+
861+
862+
863+
845864
dfhtemp
846865
Overrides the templated location for the temporary storage data set.
847866

@@ -3352,6 +3371,65 @@ sit_parameters
33523371

33533372

33543373

3374+
space_primary
3375+
The size of the primary space allocated to the CICS startup JCL data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ .
3376+
3377+
This option takes effect only when the CICS startup JCL data set is being created. If the CICS startup JCL data set already exists, the option has no effect.
3378+
3379+
If this option is not set the primary space is dynamically calculated based on the size of the generated CICS startup JCL
3380+
3381+
3382+
| **required**: False
3383+
| **type**: int
3384+
3385+
3386+
3387+
space_secondary
3388+
The size of the secondary space allocated to the CICS startup JCL data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ .
3389+
3390+
This option takes effect only when the CICS startup JCL data set is being created. If the CICS startup JCL data set already exists, the option has no effect.
3391+
3392+
If this option is not set the primary space is dynamically calculated as 10% of the total size of the generated CICS startup JCL
3393+
3394+
3395+
| **required**: False
3396+
| **type**: int
3397+
3398+
3399+
3400+
space_type
3401+
The unit portion of the CICS startup JCL data set size. Note that this is just the unit; the value for the primary space is specified with \ :literal:`space\_primary`\ and the value for the secondary space is specified with \ :literal:`space\_secondary`\ .
3402+
3403+
This option takes effect only when the CICS startup JCL data set is being created. If the CICS startup JCL data set already exists, the option has no effect.
3404+
3405+
The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ).
3406+
3407+
If neither \ :literal:`space\_secondary`\ or \ :literal:`space\_primary`\ are set, then this value will not have any effect
3408+
3409+
3410+
| **required**: False
3411+
| **type**: str
3412+
| **default**: M
3413+
| **choices**: M, K, CYL, TRK
3414+
3415+
3416+
3417+
state
3418+
The intended state for the CICS startup JCL data set, which the module aims to achieve.
3419+
3420+
Specify \ :literal:`absent`\ to remove the CICS startup JCL data set entirely, if it already exists.
3421+
3422+
Specify \ :literal:`initial`\ to create the CICS startup JCL data set if it does not already exist.
3423+
3424+
Specify \ :literal:`warm`\ to retain an existing CICS startup JCL data set in its current state. The module verifies whether the specified data set exists and whether it matches the generated startup JCL. If both conditions are met, the module leaves the data set as is. If the data set does not exist or does not match, the operation fails.
3425+
3426+
3427+
| **required**: True
3428+
| **type**: str
3429+
| **choices**: initial, absent, warm
3430+
3431+
3432+
33553433
steplib
33563434
Any locations of additional \ :literal:`STEPLIB`\ libraries to add, that are not \ :literal:`SDFHAUTH`\ , \ :literal:`SDFHLIC`\ , \ :literal:`SCEERUN`\ , or \ :literal:`SCEERUN2`\ .
33573435

@@ -3380,12 +3458,12 @@ steplib
33803458

33813459

33823460

3383-
submit_jcl
3384-
Specify whether or not you want the CICS startup job to be submitted.
3461+
volumes
3462+
The volume(s) where the data set is created. Use a string to define a singular volume or a list of strings for multiple volumes.
33853463

33863464

33873465
| **required**: False
3388-
| **type**: bool
3466+
| **type**: raw
33893467
33903468

33913469

@@ -3396,9 +3474,8 @@ Examples
33963474
.. code-block:: yaml+jinja
33973475

33983476

3399-
- name: Start CICS
3400-
ibm.ibm_zos_cics.start_cics:
3401-
submit_jcl: True
3477+
- name: Create CICS region JCL data set
3478+
ibm.ibm_zos_cics.region_jcl:
34023479
applid: ABC9ABC1
34033480
cics_data_sets:
34043481
template: 'CICSTS61.CICS.<< lib_name >>'
@@ -3431,9 +3508,8 @@ Examples
34313508
wrkarea: 2048
34323509
sysidnt: ZPY1
34333510

3434-
- name: Start CICS with more customization
3435-
ibm.ibm_zos_cics.start_cics:
3436-
submit_jcl: True
3511+
- name: Create CICS region JCL data set with more customization
3512+
ibm.ibm_zos_cics.region_jcl:
34373513
applid: ABC9ABC1
34383514
job_parameters:
34393515
class: A
@@ -3506,7 +3582,7 @@ Return Values
35063582

35073583

35083584
changed
3509-
| True if the CICS startup JCL was submitted, otherwise False.
3585+
| True if the CICS startup JCL data set was created, otherwise False.
35103586
35113587
| **returned**: always
35123588
| **type**: bool
@@ -3521,27 +3597,69 @@ Return Values
35213597
35223598

35233599

3524-
jcl
3525-
| The CICS startup JCL that is built during module execution.
3600+
start_state
3601+
| The state of the CICS startup JCL data set before the Ansible task runs.
35263602
35273603
| **returned**: always
3528-
| **type**: list
3604+
| **type**: dict
3605+
3606+
3607+
3608+
data_set_organization
3609+
| The organization of the data set at the start of the Ansible task.
3610+
3611+
| **returned**: always
3612+
| **type**: str
3613+
| **sample**: Sequential
3614+
3615+
35293616

35303617

35313618

3532-
job_id
3533-
| The job ID of the CICS startup job.
3619+
exists
3620+
| True if the CICS startup JCL data set exists.
35343621
3535-
| **returned**: If the CICS startup JCL has been submitted.
3536-
| **type**: str
3622+
| **returned**: always
3623+
| **type**: bool
3624+
3625+
35373626

35383627

35393628

3540-
err
3541-
| The error message returned when building the JCL.
3629+
end_state
3630+
| The state of the CICS startup JCL data set at the end of the Ansible task.
35423631
35433632
| **returned**: always
3544-
| **type**: str
3633+
| **type**: dict
3634+
3635+
3636+
3637+
data_set_organization
3638+
| The organization of the data set at the end of the Ansible task.
3639+
3640+
| **returned**: always
3641+
| **type**: str
3642+
| **sample**: Sequential
3643+
3644+
3645+
3646+
3647+
3648+
exists
3649+
| True if the CICS startup JCL data set exists.
3650+
3651+
| **returned**: always
3652+
| **type**: bool
3653+
3654+
3655+
3656+
3657+
3658+
jcl
3659+
| The CICS startup JCL that is built during module execution.
3660+
3661+
| **returned**: always
3662+
| **type**: list
35453663
35463664

35473665

‎docs/source/modules/transaction_dump.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,13 +133,13 @@ space_type
133133

134134
This option takes effect only when the transaction dump data set is being created. If the data set already exists, the option has no effect.
135135

136-
The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), records (\ :literal:`REC`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ).
136+
The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ).
137137

138138

139139
| **required**: False
140140
| **type**: str
141141
| **default**: M
142-
| **choices**: M, K, REC, CYL, TRK
142+
| **choices**: M, K, CYL, TRK
143143
144144

145145

0 commit comments

Comments
 (0)