transaction_dump – Allocate transaction dump data sets
Synopsis
Allocates the two transaction dump data sets used by a CICS® region.
Parameters
- destination
The transaction dump data set to create. If the value is left blank, A is implied, but you can specify A or B.
A
will create or delete the A transaction dump data set.B
will create or delete the B transaction dump data set. This MUST be set for the creation of the B data set.required: Falsetype: strdefault: Achoices: A, B- region_data_sets
The location of the region data sets to be created using a template, for example,
REGIONS.ABCD0001.<< data_set_name >>
.required: Truetype: dict- dfhdmpa
Overrides the templated location for the DFHDMPA data set.
required: Falsetype: dict- dsn
The data set name of DFHDMPA to override the template.
required: Falsetype: str
- dfhdmpb
Overrides the templated location for the DFHDMPB data set.
required: Falsetype: dict- dsn
The data set name of DFHDMPB to override the template.
required: Falsetype: str
- template
The base location of the region data sets with a template.
required: Falsetype: str
- space_primary
The size of the primary space allocated to the transaction dump data set. Note that this is just the value; the unit is specified with
space_type
.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.
required: Falsetype: intdefault: 20- space_secondary
The size of the secondary space allocated to the transaction dump data set. Note that this is just the value; the unit is specified with
space_type
.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.
required: Falsetype: intdefault: 4- space_type
The unit portion of the transaction dump data set size. Note that this is just the unit; the value is specified with
space_primary
.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.
The size can be specified in megabytes (
M
), kilobytes (K
), records (REC
), cylinders (CYL
), or tracks (TRK
).required: Falsetype: strdefault: Mchoices: M, K, REC, CYL, TRK- state
The intended state for the transaction dump data set, which the module will aim to achieve.
absent
will remove the transaction dump data set data set entirely, if it already exists.initial
will create the transaction dump data set if it does not already exist.warm
will retain an existing transaction dump data set in its current state.required: Truetype: strchoices: initial, absent, warm
Examples
- name: Allocate transaction dump data set A (implicit)
ibm.ibm_zos_cics.transaction_dump:
state: initial
- name: Allocate transaction dump data set A
ibm.ibm_zos_cics.transaction_dump:
state: initial
destination: A
- name: Allocate transaction dump data set B
ibm.ibm_zos_cics.transaction_dump:
state: initial
destination: B
- name: Delete transaction dump data set A (implicit)
ibm.ibm_zos_cics.transaction_dump:
state: absent
- name: Delete transaction dump data set B
ibm.ibm_zos_cics.transaction_dump:
state: absent
destination: B
Return Values
- changed
True if the state was changed, otherwise False.returned: alwaystype: bool- failed
True if the Ansible task failed, otherwise False.returned: alwaystype: bool- start_state
The state of the transaction dump data set before the Ansible task runs.returned: alwaystype: dict
- data_set_organization
The organization of the data set at the start of the Ansible task.returned: alwaystype: strsample: Sequential- exists
True if the transaction dump data set exists.returned: alwaystype: bool- end_state
The state of the transaction dump data set at the end of the Ansible task.returned: alwaystype: dict
- data_set_organization
The organization of the data set at the end of the Ansible task.returned: alwaystype: strsample: Sequential- exists
True if the transaction dump data set exists.returned: alwaystype: bool- executions
A list of program executions performed during the Ansible task.returned: alwaystype: list
- name
A human-readable name for the program execution.returned: alwaystype: str- rc
The return code for the program execution.returned: alwaystype: int- stdout
The standard out stream returned by the program execution.returned: alwaystype: str- stderr
The standard error stream returned from the program execution.returned: alwaystype: str