global_catalog – Create, remove, and manage the CICS global catalog

Synopsis

  • Create, remove, and manage the global catalog data set used by a CICS® region. The global catalog is used to store start type information, location of the CICS system log, installed resource definitions, terminal control information and profiles. It contains information that CICS requires on a restart.

  • You can use this module when provisioning or de-provisioning a CICS region, or when managing the state of the global catalog during upgrades or restarts.

  • Use the state option to specify the intended state for the global catalog. For example, state=initial will create and initialize a global catalog data set if it doesn’t yet exist, or it will take an existing global catalog and set its autostart override record to AUTOINIT. In either case, a CICS region using this global catalog and the START=AUTO system initialization parameter will perform an initial start.

Parameters

cics_data_sets

The name of the SDFHLOAD library of the CICS installation, for example, CICSTS61.CICS.SDFHLOAD.

This module uses the DFHRMUTL utility internally, which is found in the SDFHLOAD library.

required: True
type: dict
sdfhload

The location of the SDFHLOAD library to override the template.

required: False
type: str
template

The templated location of the SDFHLOAD library.

required: False
type: str
region_data_sets

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

If you want to use a data set that already exists, ensure that the data set is a global catalog data set.

required: True
type: dict
dfhgcd

Overrides the templated location for the global catalog data set.

required: False
type: dict
dsn

The data set name of the global catalog 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 global catalog data set. Note that this is just the value; the unit is specified with space_type.

This option takes effect only when the global catalog is being created. If the global catalog already exists, the option has no effect.

required: False
type: int
default: 5
space_secondary

The size of the secondary space allocated to the global catalog data set. Note that this is just the value; the unit is specified with space_type.

This option takes effect only when the global catalog is being created. If the global catalog already exists, the option has no effect.

required: False
type: int
default: 1
space_type

The unit portion of the global catalog data set size. Note that this is just the unit; the value is specified with space_primary.

This option takes effect only when the global catalog is being created. If the global catalog 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: False
type: str
default: M
choices: M, K, REC, CYL, TRK
state

The intended state for the global catalog, which the module will aim to achieve.

absent will remove the global catalog data set entirely, if it already exists.

initial will set the autostart override record to AUTOINIT. The module will create the global catalog data set if it does not already exist.

cold will set an existing global catalog’s autostart override record to AUTOCOLD.

warm will set an existing global catalog’s autostart override record to AUTOASIS, undoing any previous setting of AUTOINIT or AUTOCOLD.

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

Examples

- name: Initialize a global catalog
  ibm.ibm_zos_cics.global_catalog:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    cics_data_sets:
      template: "CICSTS61.CICS.<< lib_name >>"
    state: "initial"

- name: Initialize a large catalog
  ibm.ibm_zos_cics.global_catalog:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    cics_data_sets:
      template: "CICSTS61.CICS.<< lib_name >>"
    space_primary: 100
    space_type: "M"
    state: "initial"

- name: Set autostart override record to AUTOASIS
  ibm.ibm_zos_cics.global_catalog:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    cics_data_sets:
      template: "CICSTS61.CICS.<< lib_name >>"
    state: "warm"

- name: Set autostart override record to AUTOCOLD
  ibm.ibm_zos_cics.global_catalog:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    cics_data_sets:
      template: "CICSTS61.CICS.<< lib_name >>"
    state: "cold"

- name: Delete global catalog
  ibm.ibm_zos_cics.global_catalog:
    region_data_sets:
      template: "REGIONS.ABCD0001.<< data_set_name >>"
    cics_data_sets:
      template: "CICSTS61.CICS.<< lib_name >>"
    state: "absent"

See Also

See also

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 global catalog before the Ansible task runs.
returned: always
type: dict
autostart_override
The current autostart override record.
returned: always
type: str
next_start
The next start type listed in the global catalog.
returned: always
type: str
exists
True if the global catalog data set exists.
returned: always
type: bool
data_set_organization
The organization of the data set at the start of the Ansible task.
returned: always
type: str
sample: VSAM
end_state
The state of the global catalog at the end of the Ansible task.
returned: always
type: dict
autostart_override
The current autostart override record.
returned: always
type: str
next_start
The next start type listed in the global catalog
returned: always
type: str
exists
True if the global catalog data set exists.
returned: always
type: bool
data_set_organization
The organization of the data set at the end of the Ansible task.
returned: always
type: str
sample: VSAM
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 out stream returned by the program execution.
returned: always
type: str
stderr
The standard error stream returned from the program execution.
returned: always
type: str