transaction_dump – Allocate transaction dump data sets

Synopsis

  • Allocates the two transaction dump data sets used by a CICS® region.

  • The two data sets are referred to as transaction dump data set A (DFHDMPA) and transaction dump data set B (DFHDMPB).

Parameters

destination

Identifies which one of the transaction dump data sets is the target of the operation. If the value is left blank, A is implied, but you can specify A or B.

Specify A to create or delete the A data set.

Specify B to create or delete the B data set. This MUST be set for the creation of the B data set.

required: False
type: str
default: A
choices: A, B
region_data_sets

The location of the region data sets to be created by using a template, for example, REGIONS.ABCD0001.<< data_set_name >>.

required: True
type: dict
dfhdmpa

Overrides the templated location for the DFHDMPA data set.

required: False
type: dict
dsn

The data set name of DFHDMPA to override the template.

required: False
type: str
dfhdmpb

Overrides the templated location for the DFHDMPB data set.

required: False
type: dict
dsn

The data set name of DFHDMPB to override the template.

required: False
type: str
template

The base location of the region data sets with a template.

required: False
type: 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: False
type: int
default: 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: False
type: int
default: 4
space_type

The unit portion of the transaction dump data set size. Note that this is just the unit; the value for the primary space is specified with space_primary and the value for the secondary space is specified with space_secondary.

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), cylinders (CYL), or tracks (TRK).

required: False
type: str
default: M
choices: M, K, CYL, TRK
state

The intended state for the transaction dump data set, which the module aims to achieve.

Specify absent to remove the transaction dump data set entirely, if it exists.

Specify initial to create the transaction dump data set if it does not exist. If the specified data set exists but is empty, the module leaves the data set as is. If the specified data set exists and has contents, the module deletes the data set and then creates a new, empty one.

Specify warm to retain an existing transaction dump data set in its current state. The module verifies whether the specified data set exists and whether it contains any records. If both conditions are met, the module leaves the data set as is. If the data set does not exist or if it is empty, the operation fails.

required: True
type: str
choices: initial, absent, warm
volumes

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.

required: False
type: raw

Examples

- name: Allocate transaction dump data set A (implicit) by using the templated location
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    state: initial

- name: Allocate a user specified data set as transaction dump data set A (implicit)
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      dfhdmpa:
        dsn: "REGIONS.ABCD0001.DFHDMPA"
    state: initial

- name: Allocate transaction dump data set A by using the templated location
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    state: initial
    destination: A

- name: Allocate a user specified data set as transaction dump data set A
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      dfhdmpa:
        dsn: "REGIONS.ABCD0001.DFHDMPA"
    state: initial
    destination: A

- name: Allocate transaction dump data set B by using the templated location
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    state: initial
    destination: B

- name: Allocate a user specified data set as transaction dump data set B
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      dfhdmpb:
        dsn: "REGIONS.ABCD0001.DFHDMPB"
    state: initial
    destination: B

- name: Retain the existing state of transaction dump data set A (implicit) defined by the template
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    state: "warm"

- name: Retain the existing state of a user specified transaction dump data set A (implicit)
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      dfhdmpa:
        dsn: "REGIONS.ABCD0001.DFHDMPA"
    state: "warm"

- name: Retain the existing state of transaction dump data set B defined by the template
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    state: "warm"
    destination: B

- name: Retain the existing state of a user specified transaction dump data set B
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      dfhdmpb:
        dsn: "REGIONS.ABCD0001.DFHDMPB"
    state: "warm"
    destination: B

- name: Delete transaction dump data set A (implicit) defined by the template
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    state: absent

- name: Delete a user specified transaction dump data set A (implicit)
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      dfhdmpa:
        dsn: "REGIONS.ABCD0001.DFHDMPA"
    state: absent

- name: Delete transaction dump data set B defined by the template
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    state: absent
    destination: B

- name: Delete a user specified transaction dump data set B
  ibm.ibm_zos_cics.transaction_dump:
    region_data_sets:
      dfhdmpb:
        dsn: "REGIONS.ABCD0001.DFHDMPB"
    state: absent
    destination: B

Return Values

changed
True if the state was changed, otherwise False.
returned: always
type: bool
failed
True if the Ansible task failed, otherwise False.
returned: always
type: bool
start_state
The state of the transaction dump data set before the Ansible task runs.
returned: always
type: dict
data_set_organization
The organization of the data set at the start of the Ansible task.
returned: always
type: str
sample: Sequential
exists
True if the specified transaction dump data set exists.
returned: always
type: bool
end_state
The state of the transaction dump data set at the end of the Ansible task.
returned: always
type: dict
data_set_organization
The organization of the data set at the end of the Ansible task.
returned: always
type: str
sample: Sequential
exists
True if the specified transaction dump data set exists.
returned: always
type: bool
executions
A list of program executions performed during the Ansible task.
returned: always
type: list
name
A human-readable name for the program execution.
returned: always
type: str
rc
The return code for the program execution.
returned: always
type: int
stdout
The standard output stream returned from the program execution.
returned: always
type: str
stderr
The standard error stream returned from the program execution.
returned: always
type: str
msg
A string containing an error message if applicable
returned: always
type: str