Skip to content

Commit

Permalink
Automated commit to update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ddimatos
ddimatos committed Aug 8, 2024
1 parent 3afabdd commit ddcf29b
Show file tree
Hide file tree
Showing 127 changed files with 7,462 additions and 3,034 deletions.
114 changes: 16 additions & 98 deletions _sources/ibm_zos_cics/docs/source/release_notes.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,24 @@ What's New
**New modules**

**General Availability of CICS provisioning modules.** You can use these Ansible modules to create automation tasks that provision or deprovision, and start or stop
a CICS region. Sample playbooks show you how to do this with the latest version of the Ansible IBM z/OS CICS collection. All modules were initially released
with Version 1.1.0-beta as noted below. Subsequent Version 1.1.0-beta releases may include enhancements and bugfixes for these modules. Refer to the What's new
of Version 1.1.0-beta releases for details.

You can use the following modules for provisioning and managing CICS TS data sets:

* ``aux_temp_storage`` for the CICS auxiliary temporary storage data set. This module was initially
released as ``auxiliary_temp`` with Version 1.1.0-beta.4. The module is changed to ``aux_temp_storage`` in Version 2.1.0.
* ``aux_trace`` for the CICS auxiliary trace data sets. This module was initially released as ``trace`` with Version 1.1.0-beta.4.
The module is changed to ``aux_trace`` in Version 2.1.0.
* ``csd`` for the CICS system definition data set. This module was initially released with Version 1.1.0-beta.4.
* ``global_catalog`` for the CICS global catalog data set. This module was initially released with Version 1.1.0-beta.4.
* ``local_request_queue`` for the CICS local request queue data set. This module was initially released with Version 1.1.0-beta.3.
* ``td_intrapartition`` for the CICS transient data intrapartition data set. This module was initially released as ``intrapartition`` with
Version 1.1.0-beta.4. The module is changed to ``td_intrapartition`` in Version 2.1.0.
* ``transaction_dump`` for the CICS transaction dump data sets. This module was initially released with Version 1.1.0-beta.4.
a CICS region. Sample playbooks show you how to do this with the latest version of the Ansible IBM z/OS CICS collection.

You can use the following modules to provision and manage CICS TS data sets:

* ``aux_temp_storage`` can be used to create or remove the CICS auxiliary temporary storage data set.
* ``aux_trace`` can be used to allocate the CICS auxiliary trace data sets.
* ``csd`` can be used to create, manage, or remove the CICS system definition data set.
* ``global_catalog`` can be used to create, manage, or remove the CICS global catalog data set.
* ``local_request_queue`` can be used to create, manage, or remove the CICS local request queue data set.
* ``td_intrapartition`` can be used to create or remove the CICS transient data intrapartition data set.
* ``transaction_dump`` can be used to allocate the CICS transaction dump data sets.

You can use the following modules for CICS startup and shutdown operations:

* ``region_jcl`` - Create a CICS startup JCL data set. This module replaces ``start_cics``, which was released with Version 1.1.0-beta.5.
``region_jcl`` is significantly different from ``start_cics`` in function. ``region_jcl`` creates a data set that contains the startup JCL, but
doesn't perform the actual startup processing. ``region_jcl`` also supports definition and allocation of user data sets with the ``user_data_sets`` parameter.
* ``stop_region`` - Stop a CICS region. This module was initially released as ``stop_cics`` with Version 1.1.0-beta.5. The module is changed to ``stop_region``
in Version 2.1.0. In Version 2.1.0, ``stop_region`` supports a new input parameter, ``job_name`` so that you can use the job name, which is typically the CICS's
APPLID, to identify a running CICS region.
* ``region_jcl`` can be used to create a CICS startup JCL data set.
* ``stop_region`` can be used to stop a CICS region.

The group name for the CICS provisioning modules is ``region``. However, in the Version 1.1.0-beta releases, the group name was ``region_group``.
The group name for the CICS provisioning modules is ``region``.

CICS provisioning modules provide support for all in-service CICS TS releases including the latest CICS TS 6.2.

Expand All @@ -62,84 +53,11 @@ What's New

* **Removed support for Python 2.7.** Python 2.7 is no longer supported as the managed node runtime.

Version 1.1.0-beta.5
=============
What's New
-------------------

**New modules**

* ``start_cics`` - Start a CICS region.
* ``stop_cics`` - Stop a CICS region.

**Changed modules**

* ``csd`` - A new ``state`` option, ``script`` is introduced so that you can now supply a script that contains ``CSDUP`` commands to update an existing CSD. The script can be either a data set or a z/OS UNIX file.
* All modules for CICS region data sets - New option ``space_secondary`` is introduced so that you can specify the size of the secondary extent.
* All modules for CICS region data sets - Return values now use ``data_set_organization`` to indicate the organization of the data set. The ``vsam`` field has been removed from the return structure.


Version 1.1.0-beta.4
Version 1.0.6
=============
What's New
-------------------

**New modules**

* ``auxiliary_temp`` - Create and remove the CICS auxiliary temporary storage data set.
* ``csd`` - Create, remove, and manage the CICS system definition data set.
* ``intrapartition`` - Create and remove the CICS transient data intrapartition data set.
* ``trace`` - Allocate the CICS auxiliary trace data sets.
* ``transaction_dump`` - Allocate the CICS transaction dump data sets.

**Changed modules**

* ``local_request_queue`` - New option ``warm`` added to the ``state`` input parameter.

**Bugfixes**

* ``local_request_queue`` and ``local_request_queue`` - The behavior of these modules with ``state`` set to ``initial`` is updated to match documentation.

Version 1.1.0-beta.3
=============
What's New
-------------------

**New modules**

* ``local_request_queue`` - Create and remove the CICS local request queue data set.

**Changed modules**

* ``global_catalog`` and ``local_catalog`` - Added support for the ``region_data_sets`` and ``cics_data_sets`` defaults groups. This enhancement changes the way you specify the data set location for these modules.

Version 1.1.0-beta.2
=============
What's New
-------------------

**New modules**

* ``local_catalog`` - Create, initialize, and manage the CICS local catalog data set.

**Changed modules**

* ``global_catalog`` - Added return values ``start_state``, ``end_state``, and ``executions``.

**Bugfixes**

* ``global_catalog`` - Fixed an issue that when input parameters were lowercase, the module failed. Now these input parameters are not case sensitive.
* ``global_catalog`` - Fixed an issue that was found in the ``changed`` flag. Now the ``changed`` flag corresponds with the actions taken during the ``global_catalog`` execution.


Version 1.1.0-beta.1
=============
What's New
-------------------

**New modules**

* ``global_catalog`` - Create, initialize, and manage the CICS global catalog data set.
* Bug fix that allows the CICSPlex SM Scope and Context to contain special characters '$', '@', and '#'.


Version 1.0.5
Expand Down
68 changes: 34 additions & 34 deletions _sources/ibm_zos_core/docs/source/modules/zos_apf.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ library

state
Ensure that the library is added \ :literal:`state=present`\ or removed \ :literal:`state=absent`\ .
Ensure that the library is added ``state=present`` or removed ``state=absent``.

The APF list format has to be "DYNAMIC".

Expand All @@ -58,38 +58,38 @@ force_dynamic

volume
The identifier for the volume containing the library specified in the \ :literal:`library`\ parameter. The values must be one the following.
The identifier for the volume containing the library specified in the ``library`` parameter. The values must be one the following.

1. The volume serial number.

2. Six asterisks \ :literal:`\*\*\*\*\*\*`\ , indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
2. Six asterisks ``******``, indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.

3. \*MCAT\*, indicating that the system must use the volume serial number of the volume containing the master catalog.
3. *MCAT*, indicating that the system must use the volume serial number of the volume containing the master catalog.

If \ :literal:`volume`\ is not specified, \ :literal:`library`\ has to be cataloged.
If ``volume`` is not specified, ``library`` has to be cataloged.

| **required**: False
| **type**: str

sms
Indicates that the library specified in the \ :literal:`library`\ parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.
Indicates that the library specified in the ``library`` parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.

If \ :literal:`sms=True`\ , \ :literal:`volume`\ value will be ignored.
If ``sms=True``, ``volume`` value will be ignored.

| **required**: False
| **type**: bool
| **default**: False

operation
Change APF list format to "DYNAMIC" \ :literal:`operation=set\_dynamic`\ or "STATIC" \ :literal:`operation=set\_static`\
Change APF list format to "DYNAMIC" ``operation=set_dynamic`` or "STATIC" ``operation=set_static``

Display APF list current format \ :literal:`operation=check\_format`\
Display APF list current format ``operation=check_format``

Display APF list entries when \ :literal:`operation=list`\ \ :literal:`library`\ , \ :literal:`volume`\ and \ :literal:`sms`\ will be used as filters.
Display APF list entries when ``operation=list`` ``library``, ``volume`` and ``sms`` will be used as filters.

If \ :literal:`operation`\ is not set, add or remove operation will be ignored.
If ``operation`` is not set, add or remove operation will be ignored.

| **required**: False
| **type**: str
Expand All @@ -99,23 +99,23 @@ operation
tmp_hlq
Override the default high level qualifier (HLQ) for temporary and backup datasets.

The default HLQ is the Ansible user used to execute the module and if that is not available, then the value \ :literal:`TMPHLQ`\ is used.
The default HLQ is the Ansible user used to execute the module and if that is not available, then the value ``TMPHLQ`` is used.

| **required**: False
| **type**: str

persistent
Add/remove persistent entries to or from \ :emphasis:`data\_set\_name`\
Add/remove persistent entries to or from *data_set_name*

\ :literal:`library`\ will not be persisted or removed if \ :literal:`persistent=None`\
``library`` will not be persisted or removed if ``persistent=None``

| **required**: False
| **type**: dict

data_set_name
The data set name used for persisting or removing a \ :literal:`library`\ from the APF list.
The data set name used for persisting or removing a ``library`` from the APF list.

| **required**: True
| **type**: str
Expand All @@ -124,23 +124,23 @@ persistent
marker
The marker line template.

\ :literal:`{mark}`\ will be replaced with "BEGIN" and "END".
``{mark}`` will be replaced with "BEGIN" and "END".

Using a custom marker without the \ :literal:`{mark}`\ variable may result in the block being repeatedly inserted on subsequent playbook runs.
Using a custom marker without the ``{mark}`` variable may result in the block being repeatedly inserted on subsequent playbook runs.

\ :literal:`{mark}`\ length may not exceed 72 characters.
``{mark}`` length may not exceed 72 characters.

The timestamp (\<timestamp\>) used in the default marker follows the '+%Y%m%d-%H%M%S' date format
The timestamp (<timestamp>) used in the default marker follows the '+%Y%m%d-%H%M%S' date format

| **required**: False
| **type**: str
| **default**: /* {mark} ANSIBLE MANAGED BLOCK <timestamp> \*/

backup
Creates a backup file or backup data set for \ :emphasis:`data\_set\_name`\ , including the timestamp information to ensure that you retrieve the original APF list defined in \ :emphasis:`data\_set\_name`\ ".
Creates a backup file or backup data set for *data_set_name*, including the timestamp information to ensure that you retrieve the original APF list defined in *data_set_name*".

\ :emphasis:`backup\_name`\ can be used to specify a backup file name if \ :emphasis:`backup=true`\ .
*backup_name* can be used to specify a backup file name if *backup=true*.

The backup file name will be return on either success or failure of module execution such that data can be retrieved.

Expand All @@ -152,11 +152,11 @@ persistent
backup_name
Specify the USS file name or data set name for the destination backup.

If the source \ :emphasis:`data\_set\_name`\ is a USS file or path, the backup\_name name must be a file or path name, and the USS file or path must be an absolute path name.
If the source *data_set_name* is a USS file or path, the backup_name name must be a file or path name, and the USS file or path must be an absolute path name.

If the source is an MVS data set, the backup\_name must be an MVS data set name.
If the source is an MVS data set, the backup_name must be an MVS data set name.

If the backup\_name is not provided, the default backup\_name will be used. If the source is a USS file or path, the name of the backup file will be the source file or path name appended with a timestamp. For example, \ :literal:`/path/file\_name.2020-04-23-08-32-29-bak.tar`\ .
If the backup_name is not provided, the default backup_name will be used. If the source is a USS file or path, the name of the backup file will be the source file or path name appended with a timestamp. For example, ``/path/file_name.2020-04-23-08-32-29-bak.tar``.

If the source is an MVS data set, it will be a data set with a random name generated by calling the ZOAU API. The MVS backup data set recovery can be done by renaming it.

Expand All @@ -168,9 +168,9 @@ persistent
batch
A list of dictionaries for adding or removing libraries.

This is mutually exclusive with \ :literal:`library`\ , \ :literal:`volume`\ , \ :literal:`sms`\
This is mutually exclusive with ``library``, ``volume``, ``sms``

Can be used with \ :literal:`persistent`\
Can be used with ``persistent``

| **required**: False
| **type**: list
Expand All @@ -185,24 +185,24 @@ batch

volume
The identifier for the volume containing the library specified on the \ :literal:`library`\ parameter. The values must be one of the following.
The identifier for the volume containing the library specified on the ``library`` parameter. The values must be one of the following.

1. The volume serial number

2. Six asterisks \ :literal:`\*\*\*\*\*\*`\ , indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
2. Six asterisks ``******``, indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.

3. \*MCAT\*, indicating that the system must use the volume serial number of the volume containing the master catalog.
3. *MCAT*, indicating that the system must use the volume serial number of the volume containing the master catalog.

If \ :literal:`volume`\ is not specified, \ :literal:`library`\ has to be cataloged.
If ``volume`` is not specified, ``library`` has to be cataloged.

| **required**: False
| **type**: str

sms
Indicates that the library specified in the \ :literal:`library`\ parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.
Indicates that the library specified in the ``library`` parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.

If true \ :literal:`volume`\ will be ignored.
If true ``volume`` will be ignored.

| **required**: False
| **type**: bool
Expand Down Expand Up @@ -283,9 +283,9 @@ Return Values
stdout
The stdout from ZOAU command apfadm. Output varies based on the type of operation.

state\> stdout of the executed operator command (opercmd), "SETPROG" from ZOAU command apfadm
state> stdout of the executed operator command (opercmd), "SETPROG" from ZOAU command apfadm

operation\> stdout of operation options list\> Returns a list of dictionaries of APF list entries [{'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFHAUTH'}, {'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFJAUTH'}, ...] set\_dynamic\> Set to DYNAMIC set\_static\> Set to STATIC check\_format\> DYNAMIC or STATIC
operation> stdout of operation options list> Returns a list of dictionaries of APF list entries [{'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFHAUTH'}, {'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFJAUTH'}, ...] set_dynamic> Set to DYNAMIC set_static> Set to STATIC check_format> DYNAMIC or STATIC

| **returned**: always
| **type**: str
Expand Down
Loading

0 comments on commit ddcf29b

Please sign in to comment.