diff --git a/docs/source/modules/aux_temp_storage.rst b/docs/source/modules/aux_temp_storage.rst index 92dff8d3..634a3e4a 100644 --- a/docs/source/modules/aux_temp_storage.rst +++ b/docs/source/modules/aux_temp_storage.rst @@ -20,9 +20,9 @@ aux_temp_storage -- Create and remove the CICS auxiliary temporary storage data Synopsis -------- -- Create and remove the \ `auxiliary temporary storage `__\ data set used by a CICS® region. +- Create and remove the \ `auxiliary temporary storage `__ data set used by a CICS® region. - You can use this module when provisioning or de-provisioning a CICS region. -- Use the \ :literal:`state`\ option to specify the intended state for the auxiliary temporary storage data set. For example, use \ :literal:`state=initial`\ to create an auxiliary temporary storage data set if it doesn't exist. +- Use the :literal:`state` option to specify the intended state for the auxiliary temporary storage data set. For example, use :literal:`state=initial` to create an auxiliary temporary storage data set if it doesn't exist. @@ -34,7 +34,7 @@ Parameters region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. If you want to use a data set that already exists, ensure that the data set is an auxiliary temporary storage data set. @@ -74,7 +74,7 @@ region_data_sets space_primary - The size of the primary space allocated to the auxiliary temporary storage data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the primary space allocated to the auxiliary temporary storage data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the auxiliary temporary storage data set is being created. If the data set already exists, the option has no effect. @@ -86,7 +86,7 @@ space_primary space_secondary - The size of the secondary space allocated to the auxiliary temporary storage data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the secondary space allocated to the auxiliary temporary storage data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the auxiliary temporary storage data set is being created. If the data set already exists, the option has no effect. @@ -98,7 +98,7 @@ space_secondary space_type - The unit portion of the auxiliary temporary storage 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`\ . + The unit portion of the auxiliary temporary storage 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`. This option takes effect only when the auxiliary temporary storage data set is being created. If the data set already exists, the option has no effect. @@ -115,11 +115,11 @@ space_type state The intended state for the auxiliary temporary storage data set, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the auxiliary temporary storage data set entirely, if it already exists. + Specify :literal:`absent` to remove the auxiliary temporary storage data set entirely, if it already exists. - Specify \ :literal:`initial`\ to create the auxiliary temporary storage 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 data set. + Specify :literal:`initial` to create the auxiliary temporary storage 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 data set. - Specify \ :literal:`warm`\ to retain an existing auxiliary temporary storage data set in its current state. The module checks whether the specified data set exists, and if it does, leaves the data set as is. If the data set does not exist, the operation fails. + Specify :literal:`warm` to retain an existing auxiliary temporary storage data set in its current state. The module checks whether the specified data set exists, and if it does, leaves the data set as is. If the data set does not exist, the operation fails. | **required**: True diff --git a/docs/source/modules/aux_trace.rst b/docs/source/modules/aux_trace.rst index 1f4a4084..4a9e354a 100644 --- a/docs/source/modules/aux_trace.rst +++ b/docs/source/modules/aux_trace.rst @@ -20,7 +20,7 @@ aux_trace -- Allocate auxiliary trace data sets Synopsis -------- -- Allocates the two \ `auxiliary trace `__\ data sets used by a CICS® region. When CICS auxiliary trace is activated, trace entries produced by CICS are written to the auxiliary trace data sets. These data sets can hold large amounts of trace data. +- Allocates the two \ `auxiliary trace `__ data sets used by a CICS® region. When CICS auxiliary trace is activated, trace entries produced by CICS are written to the auxiliary trace data sets. These data sets can hold large amounts of trace data. - The two data sets are referred to as auxiliary trace data set A (DFHAUXT) and auxiliary trace data set B (DFHBUXT). @@ -35,9 +35,9 @@ Parameters destination Identify which one of the auxiliary trace 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 \ :literal:`A`\ to create or delete the A data set. + Specify :literal:`A` to create or delete the A data set. - Specify \ :literal:`B`\ to create or delete the B data set. This MUST be set for the creation of the B data set. + Specify :literal:`B` to create or delete the B data set. This MUST be set for the creation of the B data set. | **required**: False @@ -48,7 +48,7 @@ destination region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. If you want to use a data set that already exists, ensure that the data set is an auxiliary trace data set. @@ -107,7 +107,7 @@ region_data_sets space_primary - The size of the primary space allocated to the auxiliary trace data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the primary space allocated to the auxiliary trace data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. 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. @@ -119,7 +119,7 @@ space_primary space_secondary - The size of the secondary space allocated to the auxiliary trace data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the secondary space allocated to the auxiliary trace data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. 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. @@ -131,7 +131,7 @@ space_secondary space_type - The unit portion of the auxiliary trace 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`\ . + The unit portion of the auxiliary trace 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`. 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. @@ -148,11 +148,11 @@ space_type state The intended state for the auxiliary trace data set, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the auxiliary trace data set data set entirely, if it exists. + Specify :literal:`absent` to remove the auxiliary trace data set data set entirely, if it exists. - Specify \ :literal:`initial`\ to create the auxiliary trace 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 :literal:`initial` to create the auxiliary trace 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 \ :literal:`warm`\ to retain an existing auxiliary trace data set in its current state. The module checks whether the specified data set exists, and if it does, leaves the data set as is. If the data set does not exist, the operation fails. + Specify :literal:`warm` to retain an existing auxiliary trace data set in its current state. The module checks whether the specified data set exists, and if it does, leaves the data set as is. If the data set does not exist, the operation fails. | **required**: True diff --git a/docs/source/modules/cmci_action.rst b/docs/source/modules/cmci_action.rst index 877481ae..2d9d41a1 100644 --- a/docs/source/modules/cmci_action.rst +++ b/docs/source/modules/cmci_action.rst @@ -20,7 +20,7 @@ cmci_action -- Perform actions on CICS and CICSPlex SM resources Synopsis -------- -- Perform actions on CICS® or CICSPlex® SM definitions and resources, by initiating PUT requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__\ . For information about how to compose PUT requests, see \ `CMCI PUT requests `__\ . +- Perform actions on CICS® or CICSPlex® SM definitions and resources, by initiating PUT requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__. For information about how to compose PUT requests, see \ `CMCI PUT requests `__. @@ -32,8 +32,7 @@ Parameters action_name - The name of the target action. To find the name of the appropriate action, consult the CICSPlex SM resource tables for the target resource type. For example, the \ `PROGRAM resource table reference `__\ lists the eligible actions for CICS programs. - + The name of the target action. To find the name of the appropriate action, consult the CICSPlex SM resource tables for the target resource type. For example, the \ `PROGRAM resource table reference `__ lists the eligible actions for CICS programs. | **required**: True @@ -42,8 +41,7 @@ action_name action_parameters - A list of one or more parameters that control the \ :emphasis:`action`\ operation. Eligible actions and corresponding parameters for the target operation can be found in the resource table reference for the target resource type, as listed in the PERFORM SET operation section of the "Valid CPSM operations" table. For example, the valid parameters for a PROGDEF CSDCOPY action are \ :literal:`AS\_RESOURCE`\ , \ :literal:`DUPACTION`\ and \ :literal:`TO\_CSDGROUP`\ , as found in the \ `PROGDEF resource table reference `__\ . - + A list of one or more parameters that control the :emphasis:`action` operation. Eligible actions and corresponding parameters for the target operation can be found in the resource table reference for the target resource type, as listed in the PERFORM SET operation section of the "Valid CPSM operations" table. For example, the valid parameters for a PROGDEF CSDCOPY action are :literal:`AS\_RESOURCE`\ , :literal:`DUPACTION` and :literal:`TO\_CSDGROUP`\ , as found in the \ `PROGDEF resource table reference `__. | **required**: False @@ -64,7 +62,6 @@ action_parameters Parameter value if any. Can be omitted if the parameter requires no value to be supplied, as shown in the resource table reference. For example, the OVERRIDE parameter for the PROGDEF INSTALL action doesn't require a value. - | **required**: False | **type**: str @@ -76,9 +73,9 @@ cmci_cert Can also be specified using the environment variable CMCI\_CERT. - Required if \ :emphasis:`cmci\_key`\ is specified. + Required if :emphasis:`cmci\_key` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -100,9 +97,9 @@ cmci_key Can also be specified using the environment variable CMCI\_KEY. - Required if \ :emphasis:`cmci\_cert`\ is specified. + Required if :emphasis:`cmci\_cert` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -111,13 +108,13 @@ cmci_key cmci_password - The password of \ :emphasis:`cmci\_user`\ to pass HTTP basic authentication. + The password of :emphasis:`cmci\_user` to pass HTTP basic authentication. Can also be specified using the environment variable CMCI\_PASSWORD. - Required if \ :emphasis:`cmci\_user`\ is specified. + Required if :emphasis:`cmci\_user` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -139,9 +136,9 @@ cmci_user Can also be specified using the environment variable CMCI\_USER. - Required if \ :emphasis:`cmci\_password`\ is specified. + Required if :emphasis:`cmci\_password` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -150,11 +147,11 @@ cmci_user context - If CMCI is installed in a CICSPlex® SM environment, \ :emphasis:`context`\ is the name of the CICSplex or CMAS associated with the request, for example, \ :literal:`PLEX1`\ . To determine whether a CMAS can be specified as \ :emphasis:`context`\ , see the \ :strong:`CMAS context`\ entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. + If CMCI is installed in a CICSPlex® SM environment, :emphasis:`context` is the name of the CICSplex or CMAS associated with the request, for example, :literal:`PLEX1`. To determine whether a CMAS can be specified as :emphasis:`context`\ , see the :strong:`CMAS context` entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. - If CMCI is installed in a single region (SMSS), \ :emphasis:`context`\ is the APPLID of the CICS region associate with the request. + If CMCI is installed in a single region (SMSS), :emphasis:`context` is the APPLID of the CICS region associate with the request. - The value of \ :emphasis:`context`\ must contain no spaces. \ :emphasis:`context`\ is not case-sensitive. + The value of :emphasis:`context` must contain no spaces. :emphasis:`context` is not case-sensitive. | **required**: True @@ -163,7 +160,7 @@ context insecure - When set to \ :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. + When set to :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. | **required**: False @@ -181,17 +178,17 @@ resources complex_filter - A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the \ :literal:`and`\ operator, or a list of filter expressions to be composed with the \ :literal:`or`\ operator. + A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the :literal:`and` operator, or a list of filter expressions to be composed with the :literal:`or` operator. - The \ :literal:`attribute`\ , \ :literal:`and`\ and \ :literal:`or`\ options are mutually exclusive with each other. + The :literal:`attribute`\ , :literal:`and` and :literal:`or` options are mutually exclusive with each other. - Can contain one or more filters. Multiple filters must be combined using \ :literal:`and`\ or \ :literal:`or`\ logical operators. + Can contain one or more filters. Multiple filters must be combined using :literal:`and` or :literal:`or` logical operators. Filters can be nested. - When supplying the \ :literal:`attribute`\ option, you must also supply a \ :literal:`value`\ for the filter. You can also override the default operator of \ :literal:`=`\ with the \ :literal:`operator`\ option. + When supplying the :literal:`attribute` option, you must also supply a :literal:`value` for the filter. You can also override the default operator of :literal:`=` with the :literal:`operator` option. - For examples, see "Examples" in \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see "Examples" in :ref:`ibm.ibm\_zos\_cics.cmci\_get `. | **required**: False @@ -200,9 +197,9 @@ resources and - A list of filter expressions to be combined with an \ :literal:`and`\ operation. + A list of filter expressions to be combined with an :literal:`and` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -213,7 +210,7 @@ resources attribute The name of a resource table attribute on which to filter. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -222,8 +219,7 @@ resources operator - These operators are accepted: \ :literal:`\<`\ or \ :literal:`LT`\ (less than), \ :literal:`\<=`\ or \ :literal:`LE`\ (less than or equal to), \ :literal:`=`\ or \ :literal:`EQ`\ (equal to), \ :literal:`\>`\ or \ :literal:`GT`\ (greater than), \ :literal:`\>=`\ or \ :literal:`GE`\ (greater than or equal to), \ :literal:`==`\ or \ :literal:`IS`\ (is), \ :literal:`¬=`\ , \ :literal:`!=`\ , or \ :literal:`NE`\ (not equal to). If not supplied when \ :literal:`attribute`\ is used, \ :literal:`EQ`\ is assumed. - + These operators are accepted: :literal:`\<` or :literal:`LT` (less than), :literal:`\<=` or :literal:`LE` (less than or equal to), :literal:`=` or :literal:`EQ` (equal to), :literal:`\>` or :literal:`GT` (greater than), :literal:`\>=` or :literal:`GE` (greater than or equal to), :literal:`==` or :literal:`IS` (is), :literal:`¬=`\ , :literal:`!=`\ , or :literal:`NE` (not equal to). If not supplied when :literal:`attribute` is used, :literal:`EQ` is assumed. | **required**: False @@ -233,9 +229,9 @@ resources or - A list of filter expressions to be combined with an \ :literal:`or`\ operation. + A list of filter expressions to be combined with an :literal:`or` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -246,7 +242,7 @@ resources value The value by which you are to filter the resource attributes. - The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__\ . + The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -258,21 +254,21 @@ resources filter A dictionary with attribute names as keys, and target values, to be used as criteria to filter the set of resources returned from CICSPlex SM. - Filters implicitly use the \ :literal:`=`\ operator. + Filters implicitly use the :literal:`=` operator. - Filters for \ :literal:`string`\ type attributes can use the \ :literal:`\*`\ and \ :literal:`+`\ wildcard operators. + Filters for :literal:`string` type attributes can use the :literal:`\*` and :literal:`+` wildcard operators. - \ :literal:`\*`\ is a wildcard representing an unknown number of characters, and must appear at the end of the value. + :literal:`\*` is a wildcard representing an unknown number of characters, and must appear at the end of the value. - \ :literal:`+`\ is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. + :literal:`+` is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. - To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with \ :literal:`and`\ and \ :literal:`or`\ operators, see the \ :literal:`complex\_filter`\ parameter. + To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with :literal:`and` and :literal:`or` operators, see the :literal:`complex\_filter` parameter. - For more details, see \ `How to build a filter expression `__\ . + For more details, see \ `How to build a filter expression `__. - For examples, see \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see :ref:`ibm.ibm\_zos\_cics.cmci\_get `. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -281,8 +277,7 @@ resources get_parameters - A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__\ . - + A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__. | **required**: False @@ -324,11 +319,11 @@ scheme scope Specifies the name of a CICSplex, CICS region group, CICS region, or logical scope that is associated with the query. - \ :emphasis:`scope`\ is a subset of \ :emphasis:`context`\ and limits the request to particular CICS systems or resources. + :emphasis:`scope` is a subset of :emphasis:`context` and limits the request to particular CICS systems or resources. - \ :emphasis:`scope`\ is optional. If it's not specified, the request is limited by the value of \ :emphasis:`context`\ alone. + :emphasis:`scope` is optional. If it's not specified, the request is limited by the value of :emphasis:`context` alone. - The value of \ :emphasis:`scope`\ must contain no spaces. \ :emphasis:`scope`\ is not case-sensitive. + The value of :emphasis:`scope` must contain no spaces. :emphasis:`scope` is not case-sensitive. | **required**: false @@ -347,7 +342,7 @@ timeout type - The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__\ . + The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__. | **required**: True @@ -364,9 +359,9 @@ Examples - name: Newcopy a program cmci_action: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 - context: "iyk3z0r9" + cmci_host: "example.com" + cmci_port: 12345 + context: "plex_or_applid" type: "CICSProgram" action_name: NEWCOPY resource: @@ -378,9 +373,9 @@ Examples - name: install a bundle in a CICS region cmci_action: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: "10080" - context: "iyk3z0r9" + cmci_host: "example.com" + cmci_port: "12345" + context: "plex_or_applid" type: CICSBundle action_name: install resource: diff --git a/docs/source/modules/cmci_create.rst b/docs/source/modules/cmci_create.rst index 6c1d4d9c..916342fe 100644 --- a/docs/source/modules/cmci_create.rst +++ b/docs/source/modules/cmci_create.rst @@ -20,7 +20,7 @@ cmci_create -- Create CICS and CICSPlex SM definitions Synopsis -------- -- Create definitional CICS® or CICSPlex® SM resources in CSD and BAS repositories, by initiating POST requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__\ . For information about how to compose POST requests, see \ `CMCI POST requests `__\ . +- Create definitional CICS® or CICSPlex® SM resources in CSD and BAS repositories, by initiating POST requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__. For information about how to compose POST requests, see \ `CMCI POST requests `__. @@ -32,7 +32,7 @@ Parameters attributes - The resource attributes to be created or updated. Available attributes can be found in the CICSPlex® SM resource table reference for the target resource type, for example, \ `PROGDEF resource table reference `__\ . + The resource attributes to be created or updated. Available attributes can be found in the CICSPlex® SM resource table reference for the target resource type, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -45,9 +45,9 @@ cmci_cert Can also be specified using the environment variable CMCI\_CERT. - Required if \ :emphasis:`cmci\_key`\ is specified. + Required if :emphasis:`cmci\_key` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -69,9 +69,9 @@ cmci_key Can also be specified using the environment variable CMCI\_KEY. - Required if \ :emphasis:`cmci\_cert`\ is specified. + Required if :emphasis:`cmci\_cert` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -80,13 +80,13 @@ cmci_key cmci_password - The password of \ :emphasis:`cmci\_user`\ to pass HTTP basic authentication. + The password of :emphasis:`cmci\_user` to pass HTTP basic authentication. Can also be specified using the environment variable CMCI\_PASSWORD. - Required if \ :emphasis:`cmci\_user`\ is specified. + Required if :emphasis:`cmci\_user` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -108,9 +108,9 @@ cmci_user Can also be specified using the environment variable CMCI\_USER. - Required if \ :emphasis:`cmci\_password`\ is specified. + Required if :emphasis:`cmci\_password` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -119,11 +119,11 @@ cmci_user context - If CMCI is installed in a CICSPlex® SM environment, \ :emphasis:`context`\ is the name of the CICSplex or CMAS associated with the request, for example, \ :literal:`PLEX1`\ . To determine whether a CMAS can be specified as \ :emphasis:`context`\ , see the \ :strong:`CMAS context`\ entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. + If CMCI is installed in a CICSPlex® SM environment, :emphasis:`context` is the name of the CICSplex or CMAS associated with the request, for example, :literal:`PLEX1`. To determine whether a CMAS can be specified as :emphasis:`context`\ , see the :strong:`CMAS context` entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. - If CMCI is installed in a single region (SMSS), \ :emphasis:`context`\ is the APPLID of the CICS region associate with the request. + If CMCI is installed in a single region (SMSS), :emphasis:`context` is the APPLID of the CICS region associate with the request. - The value of \ :emphasis:`context`\ must contain no spaces. \ :emphasis:`context`\ is not case-sensitive. + The value of :emphasis:`context` must contain no spaces. :emphasis:`context` is not case-sensitive. | **required**: True @@ -132,8 +132,7 @@ context create_parameters - A list of one or more parameters that control the \ :emphasis:`create`\ operation. Eligible parameters for the CREATE operation can be found in the resource table reference for the target resource type, as listed in the CREATE operation section of the "Valid CPSM operations" table. For example, the valid parameters for a PROGDEF CREATE operation are CSD and RESGROUP, as found in the \ `PROGDEF resource table reference `__\ . - + A list of one or more parameters that control the :emphasis:`create` operation. Eligible parameters for the CREATE operation can be found in the resource table reference for the target resource type, as listed in the CREATE operation section of the "Valid CPSM operations" table. For example, the valid parameters for a PROGDEF CREATE operation are CSD and RESGROUP, as found in the \ `PROGDEF resource table reference `__. | **required**: False @@ -161,7 +160,7 @@ create_parameters insecure - When set to \ :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. + When set to :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. | **required**: False @@ -183,11 +182,11 @@ scheme scope Specifies the name of a CICSplex, CICS region group, CICS region, or logical scope that is associated with the query. - \ :emphasis:`scope`\ is a subset of \ :emphasis:`context`\ and limits the request to particular CICS systems or resources. + :emphasis:`scope` is a subset of :emphasis:`context` and limits the request to particular CICS systems or resources. - \ :emphasis:`scope`\ is optional. If it's not specified, the request is limited by the value of \ :emphasis:`context`\ alone. + :emphasis:`scope` is optional. If it's not specified, the request is limited by the value of :emphasis:`context` alone. - The value of \ :emphasis:`scope`\ must contain no spaces. \ :emphasis:`scope`\ is not case-sensitive. + The value of :emphasis:`scope` must contain no spaces. :emphasis:`scope` is not case-sensitive. | **required**: false @@ -206,7 +205,7 @@ timeout type - The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__\ . + The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__. | **required**: True @@ -223,9 +222,9 @@ Examples - name: define a BUNDLE in a CSD cmci_create: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 - context: "iyk3z0r9" + cmci_host: "example.com" + cmci_port: 12345 + context: "plex_or_applid" type: "CICSDefinitionBundle" attributes: name: PONGALT diff --git a/docs/source/modules/cmci_delete.rst b/docs/source/modules/cmci_delete.rst index 5ba2e80f..f25a9abf 100644 --- a/docs/source/modules/cmci_delete.rst +++ b/docs/source/modules/cmci_delete.rst @@ -20,7 +20,7 @@ cmci_delete -- Delete CICS and CICSPlex SM resources Synopsis -------- -- Remove or discard definitional or installed CICS® and CICSPlex® SM resources from CICS regions, by initiating DELETE requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__\ . For information about how to compose DELETE requests, see \ `CMCI DELETE requests `__\ . +- Remove or discard definitional or installed CICS® and CICSPlex® SM resources from CICS regions, by initiating DELETE requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__. For information about how to compose DELETE requests, see \ `CMCI DELETE requests `__. @@ -36,9 +36,9 @@ cmci_cert Can also be specified using the environment variable CMCI\_CERT. - Required if \ :emphasis:`cmci\_key`\ is specified. + Required if :emphasis:`cmci\_key` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -60,9 +60,9 @@ cmci_key Can also be specified using the environment variable CMCI\_KEY. - Required if \ :emphasis:`cmci\_cert`\ is specified. + Required if :emphasis:`cmci\_cert` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -71,13 +71,13 @@ cmci_key cmci_password - The password of \ :emphasis:`cmci\_user`\ to pass HTTP basic authentication. + The password of :emphasis:`cmci\_user` to pass HTTP basic authentication. Can also be specified using the environment variable CMCI\_PASSWORD. - Required if \ :emphasis:`cmci\_user`\ is specified. + Required if :emphasis:`cmci\_user` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -99,9 +99,9 @@ cmci_user Can also be specified using the environment variable CMCI\_USER. - Required if \ :emphasis:`cmci\_password`\ is specified. + Required if :emphasis:`cmci\_password` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -110,11 +110,11 @@ cmci_user context - If CMCI is installed in a CICSPlex® SM environment, \ :emphasis:`context`\ is the name of the CICSplex or CMAS associated with the request, for example, \ :literal:`PLEX1`\ . To determine whether a CMAS can be specified as \ :emphasis:`context`\ , see the \ :strong:`CMAS context`\ entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. + If CMCI is installed in a CICSPlex® SM environment, :emphasis:`context` is the name of the CICSplex or CMAS associated with the request, for example, :literal:`PLEX1`. To determine whether a CMAS can be specified as :emphasis:`context`\ , see the :strong:`CMAS context` entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. - If CMCI is installed in a single region (SMSS), \ :emphasis:`context`\ is the APPLID of the CICS region associate with the request. + If CMCI is installed in a single region (SMSS), :emphasis:`context` is the APPLID of the CICS region associate with the request. - The value of \ :emphasis:`context`\ must contain no spaces. \ :emphasis:`context`\ is not case-sensitive. + The value of :emphasis:`context` must contain no spaces. :emphasis:`context` is not case-sensitive. | **required**: True @@ -123,7 +123,7 @@ context insecure - When set to \ :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. + When set to :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. | **required**: False @@ -141,17 +141,17 @@ resources complex_filter - A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the \ :literal:`and`\ operator, or a list of filter expressions to be composed with the \ :literal:`or`\ operator. + A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the :literal:`and` operator, or a list of filter expressions to be composed with the :literal:`or` operator. - The \ :literal:`attribute`\ , \ :literal:`and`\ and \ :literal:`or`\ options are mutually exclusive with each other. + The :literal:`attribute`\ , :literal:`and` and :literal:`or` options are mutually exclusive with each other. - Can contain one or more filters. Multiple filters must be combined using \ :literal:`and`\ or \ :literal:`or`\ logical operators. + Can contain one or more filters. Multiple filters must be combined using :literal:`and` or :literal:`or` logical operators. Filters can be nested. - When supplying the \ :literal:`attribute`\ option, you must also supply a \ :literal:`value`\ for the filter. You can also override the default operator of \ :literal:`=`\ with the \ :literal:`operator`\ option. + When supplying the :literal:`attribute` option, you must also supply a :literal:`value` for the filter. You can also override the default operator of :literal:`=` with the :literal:`operator` option. - For examples, see "Examples" in \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see "Examples" in :ref:`ibm.ibm\_zos\_cics.cmci\_get `. | **required**: False @@ -160,9 +160,9 @@ resources and - A list of filter expressions to be combined with an \ :literal:`and`\ operation. + A list of filter expressions to be combined with an :literal:`and` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -173,7 +173,7 @@ resources attribute The name of a resource table attribute on which to filter. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -182,8 +182,7 @@ resources operator - These operators are accepted: \ :literal:`\<`\ or \ :literal:`LT`\ (less than), \ :literal:`\<=`\ or \ :literal:`LE`\ (less than or equal to), \ :literal:`=`\ or \ :literal:`EQ`\ (equal to), \ :literal:`\>`\ or \ :literal:`GT`\ (greater than), \ :literal:`\>=`\ or \ :literal:`GE`\ (greater than or equal to), \ :literal:`==`\ or \ :literal:`IS`\ (is), \ :literal:`¬=`\ , \ :literal:`!=`\ , or \ :literal:`NE`\ (not equal to). If not supplied when \ :literal:`attribute`\ is used, \ :literal:`EQ`\ is assumed. - + These operators are accepted: :literal:`\<` or :literal:`LT` (less than), :literal:`\<=` or :literal:`LE` (less than or equal to), :literal:`=` or :literal:`EQ` (equal to), :literal:`\>` or :literal:`GT` (greater than), :literal:`\>=` or :literal:`GE` (greater than or equal to), :literal:`==` or :literal:`IS` (is), :literal:`¬=`\ , :literal:`!=`\ , or :literal:`NE` (not equal to). If not supplied when :literal:`attribute` is used, :literal:`EQ` is assumed. | **required**: False @@ -193,9 +192,9 @@ resources or - A list of filter expressions to be combined with an \ :literal:`or`\ operation. + A list of filter expressions to be combined with an :literal:`or` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -206,7 +205,7 @@ resources value The value by which you are to filter the resource attributes. - The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__\ . + The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -218,21 +217,21 @@ resources filter A dictionary with attribute names as keys, and target values, to be used as criteria to filter the set of resources returned from CICSPlex SM. - Filters implicitly use the \ :literal:`=`\ operator. + Filters implicitly use the :literal:`=` operator. - Filters for \ :literal:`string`\ type attributes can use the \ :literal:`\*`\ and \ :literal:`+`\ wildcard operators. + Filters for :literal:`string` type attributes can use the :literal:`\*` and :literal:`+` wildcard operators. - \ :literal:`\*`\ is a wildcard representing an unknown number of characters, and must appear at the end of the value. + :literal:`\*` is a wildcard representing an unknown number of characters, and must appear at the end of the value. - \ :literal:`+`\ is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. + :literal:`+` is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. - To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with \ :literal:`and`\ and \ :literal:`or`\ operators, see the \ :literal:`complex\_filter`\ parameter. + To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with :literal:`and` and :literal:`or` operators, see the :literal:`complex\_filter` parameter. - For more details, see \ `How to build a filter expression `__\ . + For more details, see \ `How to build a filter expression `__. - For examples, see \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see :ref:`ibm.ibm\_zos\_cics.cmci\_get `. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -241,8 +240,7 @@ resources get_parameters - A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__\ . - + A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__. | **required**: False @@ -284,11 +282,11 @@ scheme scope Specifies the name of a CICSplex, CICS region group, CICS region, or logical scope that is associated with the query. - \ :emphasis:`scope`\ is a subset of \ :emphasis:`context`\ and limits the request to particular CICS systems or resources. + :emphasis:`scope` is a subset of :emphasis:`context` and limits the request to particular CICS systems or resources. - \ :emphasis:`scope`\ is optional. If it's not specified, the request is limited by the value of \ :emphasis:`context`\ alone. + :emphasis:`scope` is optional. If it's not specified, the request is limited by the value of :emphasis:`context` alone. - The value of \ :emphasis:`scope`\ must contain no spaces. \ :emphasis:`scope`\ is not case-sensitive. + The value of :emphasis:`scope` must contain no spaces. :emphasis:`scope` is not case-sensitive. | **required**: false @@ -307,7 +305,7 @@ timeout type - The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__\ . + The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__. | **required**: True @@ -324,9 +322,9 @@ Examples - name: delete a bundle in a CICS region cmci_delete: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 - context: "iyk3z0r9" + cmci_host: "example.com" + cmci_port: 12345 + context: "plex_or_applid" type: CICSBundle resource: filter: @@ -334,9 +332,9 @@ Examples - name: delete a bundle definition in a CICS region cmci_delete: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 - context: "iyk3z0r9" + cmci_host: "example.com" + cmci_port: 12345 + context: "plex_or_applid" type: CICSDefinitionBundle resource: filter: diff --git a/docs/source/modules/cmci_get.rst b/docs/source/modules/cmci_get.rst index 3d926506..83fd343f 100644 --- a/docs/source/modules/cmci_get.rst +++ b/docs/source/modules/cmci_get.rst @@ -20,7 +20,7 @@ cmci_get -- Query CICS and CICSPlex SM resources and definitions Synopsis -------- -- Get information about installed and definitional CICS® and CICSPlex® SM resources from CICS regions, by initiating GET requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__\ . For information about how to compose GET requests, see \ `CMCI GET requests `__\ . +- Get information about installed and definitional CICS® and CICSPlex® SM resources from CICS regions, by initiating GET requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__. For information about how to compose GET requests, see \ `CMCI GET requests `__. @@ -36,9 +36,9 @@ cmci_cert Can also be specified using the environment variable CMCI\_CERT. - Required if \ :emphasis:`cmci\_key`\ is specified. + Required if :emphasis:`cmci\_key` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -60,9 +60,9 @@ cmci_key Can also be specified using the environment variable CMCI\_KEY. - Required if \ :emphasis:`cmci\_cert`\ is specified. + Required if :emphasis:`cmci\_cert` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -71,13 +71,13 @@ cmci_key cmci_password - The password of \ :emphasis:`cmci\_user`\ to pass HTTP basic authentication. + The password of :emphasis:`cmci\_user` to pass HTTP basic authentication. Can also be specified using the environment variable CMCI\_PASSWORD. - Required if \ :emphasis:`cmci\_user`\ is specified. + Required if :emphasis:`cmci\_user` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -99,9 +99,9 @@ cmci_user Can also be specified using the environment variable CMCI\_USER. - Required if \ :emphasis:`cmci\_password`\ is specified. + Required if :emphasis:`cmci\_password` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -110,11 +110,11 @@ cmci_user context - If CMCI is installed in a CICSPlex® SM environment, \ :emphasis:`context`\ is the name of the CICSplex or CMAS associated with the request, for example, \ :literal:`PLEX1`\ . To determine whether a CMAS can be specified as \ :emphasis:`context`\ , see the \ :strong:`CMAS context`\ entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. + If CMCI is installed in a CICSPlex® SM environment, :emphasis:`context` is the name of the CICSplex or CMAS associated with the request, for example, :literal:`PLEX1`. To determine whether a CMAS can be specified as :emphasis:`context`\ , see the :strong:`CMAS context` entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. - If CMCI is installed in a single region (SMSS), \ :emphasis:`context`\ is the APPLID of the CICS region associate with the request. + If CMCI is installed in a single region (SMSS), :emphasis:`context` is the APPLID of the CICS region associate with the request. - The value of \ :emphasis:`context`\ must contain no spaces. \ :emphasis:`context`\ is not case-sensitive. + The value of :emphasis:`context` must contain no spaces. :emphasis:`context` is not case-sensitive. | **required**: True @@ -135,7 +135,7 @@ fail_on_nodata insecure - When set to \ :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. + When set to :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. | **required**: False @@ -146,7 +146,7 @@ insecure record_count Identifies a subset of records in the results cache, starting either from the first record in the results cache or from the record specified by the index parameter. If not specified, all the records are returned by default. - A negative number indicates a count back from the last record; for example, \ :literal:`-1`\ means the last record, \ :literal:`-2`\ the last record but one, and so on. + A negative number indicates a count back from the last record; for example, :literal:`-1` means the last record, :literal:`-2` the last record but one, and so on. The count value must be an integer; a value of zero is not permitted. @@ -166,17 +166,17 @@ resources complex_filter - A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the \ :literal:`and`\ operator, or a list of filter expressions to be composed with the \ :literal:`or`\ operator. + A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the :literal:`and` operator, or a list of filter expressions to be composed with the :literal:`or` operator. - The \ :literal:`attribute`\ , \ :literal:`and`\ and \ :literal:`or`\ options are mutually exclusive with each other. + The :literal:`attribute`\ , :literal:`and` and :literal:`or` options are mutually exclusive with each other. - Can contain one or more filters. Multiple filters must be combined using \ :literal:`and`\ or \ :literal:`or`\ logical operators. + Can contain one or more filters. Multiple filters must be combined using :literal:`and` or :literal:`or` logical operators. Filters can be nested. - When supplying the \ :literal:`attribute`\ option, you must also supply a \ :literal:`value`\ for the filter. You can also override the default operator of \ :literal:`=`\ with the \ :literal:`operator`\ option. + When supplying the :literal:`attribute` option, you must also supply a :literal:`value` for the filter. You can also override the default operator of :literal:`=` with the :literal:`operator` option. - For examples, see "Examples" in \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see "Examples" in :ref:`ibm.ibm\_zos\_cics.cmci\_get `. | **required**: False @@ -185,9 +185,9 @@ resources and - A list of filter expressions to be combined with an \ :literal:`and`\ operation. + A list of filter expressions to be combined with an :literal:`and` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -198,7 +198,7 @@ resources attribute The name of a resource table attribute on which to filter. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -207,8 +207,7 @@ resources operator - These operators are accepted: \ :literal:`\<`\ or \ :literal:`LT`\ (less than), \ :literal:`\<=`\ or \ :literal:`LE`\ (less than or equal to), \ :literal:`=`\ or \ :literal:`EQ`\ (equal to), \ :literal:`\>`\ or \ :literal:`GT`\ (greater than), \ :literal:`\>=`\ or \ :literal:`GE`\ (greater than or equal to), \ :literal:`==`\ or \ :literal:`IS`\ (is), \ :literal:`¬=`\ , \ :literal:`!=`\ , or \ :literal:`NE`\ (not equal to). If not supplied when \ :literal:`attribute`\ is used, \ :literal:`EQ`\ is assumed. - + These operators are accepted: :literal:`\<` or :literal:`LT` (less than), :literal:`\<=` or :literal:`LE` (less than or equal to), :literal:`=` or :literal:`EQ` (equal to), :literal:`\>` or :literal:`GT` (greater than), :literal:`\>=` or :literal:`GE` (greater than or equal to), :literal:`==` or :literal:`IS` (is), :literal:`¬=`\ , :literal:`!=`\ , or :literal:`NE` (not equal to). If not supplied when :literal:`attribute` is used, :literal:`EQ` is assumed. | **required**: False @@ -218,9 +217,9 @@ resources or - A list of filter expressions to be combined with an \ :literal:`or`\ operation. + A list of filter expressions to be combined with an :literal:`or` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -231,7 +230,7 @@ resources value The value by which you are to filter the resource attributes. - The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__\ . + The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -243,21 +242,21 @@ resources filter A dictionary with attribute names as keys, and target values, to be used as criteria to filter the set of resources returned from CICSPlex SM. - Filters implicitly use the \ :literal:`=`\ operator. + Filters implicitly use the :literal:`=` operator. - Filters for \ :literal:`string`\ type attributes can use the \ :literal:`\*`\ and \ :literal:`+`\ wildcard operators. + Filters for :literal:`string` type attributes can use the :literal:`\*` and :literal:`+` wildcard operators. - \ :literal:`\*`\ is a wildcard representing an unknown number of characters, and must appear at the end of the value. + :literal:`\*` is a wildcard representing an unknown number of characters, and must appear at the end of the value. - \ :literal:`+`\ is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. + :literal:`+` is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. - To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with \ :literal:`and`\ and \ :literal:`or`\ operators, see the \ :literal:`complex\_filter`\ parameter. + To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with :literal:`and` and :literal:`or` operators, see the :literal:`complex\_filter` parameter. - For more details, see \ `How to build a filter expression `__\ . + For more details, see \ `How to build a filter expression `__. - For examples, see \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see :ref:`ibm.ibm\_zos\_cics.cmci\_get `. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -266,8 +265,7 @@ resources get_parameters - A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__\ . - + A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__. | **required**: False @@ -309,11 +307,11 @@ scheme scope Specifies the name of a CICSplex, CICS region group, CICS region, or logical scope that is associated with the query. - \ :emphasis:`scope`\ is a subset of \ :emphasis:`context`\ and limits the request to particular CICS systems or resources. + :emphasis:`scope` is a subset of :emphasis:`context` and limits the request to particular CICS systems or resources. - \ :emphasis:`scope`\ is optional. If it's not specified, the request is limited by the value of \ :emphasis:`context`\ alone. + :emphasis:`scope` is optional. If it's not specified, the request is limited by the value of :emphasis:`context` alone. - The value of \ :emphasis:`scope`\ must contain no spaces. \ :emphasis:`scope`\ is not case-sensitive. + The value of :emphasis:`scope` must contain no spaces. :emphasis:`scope` is not case-sensitive. | **required**: false @@ -332,7 +330,7 @@ timeout type - The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__\ . + The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__. | **required**: True @@ -349,11 +347,11 @@ Examples - name: get 2 LOCFILEs from a CICSplex cmci_get: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 + cmci_host: "example.com" + cmci_port: 12345 cmci_user: "ibmuser" cmci_password: "123456" - context: "iyk3z0r9" + context: "plex_or_applid" type: CICSLocalFile record_count: 2 resource: @@ -362,11 +360,11 @@ Examples - name: get a localfile in a CICS region cmci_get: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 + cmci_host: "example.com" + cmci_port: 12345 cmci_cert: "./sec/ansible.pem" cmci_key: "./sec/ansible.key" - context: "iyk3z0r9" + context: "plex_or_applid" type: "CICSLocalFile" resources: filter: @@ -376,11 +374,11 @@ Examples - name: get a progdef from a CSD cmci_get: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 + cmci_host: "example.com" + cmci_port: 12345 cmci_cert: "./sec/ansible.pem" cmci_key: "./sec/ansible.key" - context: "iyk3z0r9" + context: "plex_or_applid" type: cicsdefinitionprogram resources: filter: @@ -392,11 +390,11 @@ Examples - name: pass module even if bundle definition is not found cmci_get: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 + cmci_host: "example.com" + cmci_port: 12345 cmci_cert: "./sec/ansible.pem" cmci_key: "./sec/ansible.key" - context: "iyk3z0r9" + context: "plex_or_applid" type: cicsdefinitionbundle resources: filter: @@ -409,11 +407,11 @@ Examples - name: Using complex_filter to combine filter expressions and change operators cmci_get: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: 10080 + cmci_host: "example.com" + cmci_port: 12345 cmci_cert: "./sec/ansible.pem" cmci_key: "./sec/ansible.key" - context: "iyk3z0r9" + context: "plex_or_applid" type: "CICSRegion" resources: complex_filter: diff --git a/docs/source/modules/cmci_update.rst b/docs/source/modules/cmci_update.rst index 2aaf20d0..5851a344 100644 --- a/docs/source/modules/cmci_update.rst +++ b/docs/source/modules/cmci_update.rst @@ -20,7 +20,7 @@ cmci_update -- Update CICS and CICSPlex resources and definitions Synopsis -------- -- Make changes to CICS® and CICSPlex® SM resources in CICS regions, by initiating PUT requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__\ . For information about how to compose PUT requests, see \ `CMCI PUT requests `__\ . +- Make changes to CICS® and CICSPlex® SM resources in CICS regions, by initiating PUT requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see \ `CMCI REST API `__. For information about how to compose PUT requests, see \ `CMCI PUT requests `__. @@ -32,7 +32,7 @@ Parameters attributes - The resource attributes to be created or updated. Available attributes can be found in the CICSPlex® SM resource table reference for the target resource type, for example, \ `PROGDEF resource table reference `__\ . + The resource attributes to be created or updated. Available attributes can be found in the CICSPlex® SM resource table reference for the target resource type, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -45,9 +45,9 @@ cmci_cert Can also be specified using the environment variable CMCI\_CERT. - Required if \ :emphasis:`cmci\_key`\ is specified. + Required if :emphasis:`cmci\_key` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -69,9 +69,9 @@ cmci_key Can also be specified using the environment variable CMCI\_KEY. - Required if \ :emphasis:`cmci\_cert`\ is specified. + Required if :emphasis:`cmci\_cert` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: False @@ -80,13 +80,13 @@ cmci_key cmci_password - The password of \ :emphasis:`cmci\_user`\ to pass HTTP basic authentication. + The password of :emphasis:`cmci\_user` to pass HTTP basic authentication. Can also be specified using the environment variable CMCI\_PASSWORD. - Required if \ :emphasis:`cmci\_user`\ is specified. + Required if :emphasis:`cmci\_user` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -108,9 +108,9 @@ cmci_user Can also be specified using the environment variable CMCI\_USER. - Required if \ :emphasis:`cmci\_password`\ is specified. + Required if :emphasis:`cmci\_password` is specified. - Authentication prioritises certificate authentication if \ :emphasis:`cmci\_cert`\ and \ :emphasis:`cmci\_key`\ are provided, then basic authentication if \ :emphasis:`cmci\_user`\ and \ :emphasis:`cmci\_password`\ are provided, and then unauthenticated if none is provided. + Authentication prioritises certificate authentication if :emphasis:`cmci\_cert` and :emphasis:`cmci\_key` are provided, then basic authentication if :emphasis:`cmci\_user` and :emphasis:`cmci\_password` are provided, and then unauthenticated if none is provided. | **required**: false @@ -119,11 +119,11 @@ cmci_user context - If CMCI is installed in a CICSPlex® SM environment, \ :emphasis:`context`\ is the name of the CICSplex or CMAS associated with the request, for example, \ :literal:`PLEX1`\ . To determine whether a CMAS can be specified as \ :emphasis:`context`\ , see the \ :strong:`CMAS context`\ entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. + If CMCI is installed in a CICSPlex® SM environment, :emphasis:`context` is the name of the CICSplex or CMAS associated with the request, for example, :literal:`PLEX1`. To determine whether a CMAS can be specified as :emphasis:`context`\ , see the :strong:`CMAS context` entry in the CICSPlex SM resource table reference of a resource. For example, according to the \ `PROGRAM resource table `__\ , CMAS context is not supported for PROGRAM. - If CMCI is installed in a single region (SMSS), \ :emphasis:`context`\ is the APPLID of the CICS region associate with the request. + If CMCI is installed in a single region (SMSS), :emphasis:`context` is the APPLID of the CICS region associate with the request. - The value of \ :emphasis:`context`\ must contain no spaces. \ :emphasis:`context`\ is not case-sensitive. + The value of :emphasis:`context` must contain no spaces. :emphasis:`context` is not case-sensitive. | **required**: True @@ -132,7 +132,7 @@ context insecure - When set to \ :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. + When set to :literal:`true`\ , disables SSL certificate trust chain verification when using HTTPS. | **required**: False @@ -150,17 +150,17 @@ resources complex_filter - A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the \ :literal:`and`\ operator, or a list of filter expressions to be composed with the \ :literal:`or`\ operator. + A dictionary representing a complex filter expression. Complex filters are composed of filter expressions, represented as dictionaries. Each dictionary can specify either an attribute expression, a list of filter expressions to be composed with the :literal:`and` operator, or a list of filter expressions to be composed with the :literal:`or` operator. - The \ :literal:`attribute`\ , \ :literal:`and`\ and \ :literal:`or`\ options are mutually exclusive with each other. + The :literal:`attribute`\ , :literal:`and` and :literal:`or` options are mutually exclusive with each other. - Can contain one or more filters. Multiple filters must be combined using \ :literal:`and`\ or \ :literal:`or`\ logical operators. + Can contain one or more filters. Multiple filters must be combined using :literal:`and` or :literal:`or` logical operators. Filters can be nested. - When supplying the \ :literal:`attribute`\ option, you must also supply a \ :literal:`value`\ for the filter. You can also override the default operator of \ :literal:`=`\ with the \ :literal:`operator`\ option. + When supplying the :literal:`attribute` option, you must also supply a :literal:`value` for the filter. You can also override the default operator of :literal:`=` with the :literal:`operator` option. - For examples, see "Examples" in \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see "Examples" in :ref:`ibm.ibm\_zos\_cics.cmci\_get `. | **required**: False @@ -169,9 +169,9 @@ resources and - A list of filter expressions to be combined with an \ :literal:`and`\ operation. + A list of filter expressions to be combined with an :literal:`and` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -182,7 +182,7 @@ resources attribute The name of a resource table attribute on which to filter. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -191,8 +191,7 @@ resources operator - These operators are accepted: \ :literal:`\<`\ or \ :literal:`LT`\ (less than), \ :literal:`\<=`\ or \ :literal:`LE`\ (less than or equal to), \ :literal:`=`\ or \ :literal:`EQ`\ (equal to), \ :literal:`\>`\ or \ :literal:`GT`\ (greater than), \ :literal:`\>=`\ or \ :literal:`GE`\ (greater than or equal to), \ :literal:`==`\ or \ :literal:`IS`\ (is), \ :literal:`¬=`\ , \ :literal:`!=`\ , or \ :literal:`NE`\ (not equal to). If not supplied when \ :literal:`attribute`\ is used, \ :literal:`EQ`\ is assumed. - + These operators are accepted: :literal:`\<` or :literal:`LT` (less than), :literal:`\<=` or :literal:`LE` (less than or equal to), :literal:`=` or :literal:`EQ` (equal to), :literal:`\>` or :literal:`GT` (greater than), :literal:`\>=` or :literal:`GE` (greater than or equal to), :literal:`==` or :literal:`IS` (is), :literal:`¬=`\ , :literal:`!=`\ , or :literal:`NE` (not equal to). If not supplied when :literal:`attribute` is used, :literal:`EQ` is assumed. | **required**: False @@ -202,9 +201,9 @@ resources or - A list of filter expressions to be combined with an \ :literal:`or`\ operation. + A list of filter expressions to be combined with an :literal:`or` operation. - Filter expressions are nested \ :literal:`complex\_filter`\ elements. Each nested filter expression can be either an \ :literal:`attribute`\ , \ :literal:`and`\ or \ :literal:`or`\ complex filter expression. + Filter expressions are nested :literal:`complex\_filter` elements. Each nested filter expression can be either an :literal:`attribute`\ , :literal:`and` or :literal:`or` complex filter expression. | **required**: False @@ -215,7 +214,7 @@ resources value The value by which you are to filter the resource attributes. - The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__\ . + The value must be a valid one for the resource table attribute as documented in the resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -227,21 +226,21 @@ resources filter A dictionary with attribute names as keys, and target values, to be used as criteria to filter the set of resources returned from CICSPlex SM. - Filters implicitly use the \ :literal:`=`\ operator. + Filters implicitly use the :literal:`=` operator. - Filters for \ :literal:`string`\ type attributes can use the \ :literal:`\*`\ and \ :literal:`+`\ wildcard operators. + Filters for :literal:`string` type attributes can use the :literal:`\*` and :literal:`+` wildcard operators. - \ :literal:`\*`\ is a wildcard representing an unknown number of characters, and must appear at the end of the value. + :literal:`\*` is a wildcard representing an unknown number of characters, and must appear at the end of the value. - \ :literal:`+`\ is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. + :literal:`+` is a wildcard representing a single character, and can appear in any place in the value, potentially multiple times. - To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with \ :literal:`and`\ and \ :literal:`or`\ operators, see the \ :literal:`complex\_filter`\ parameter. + To use more complicated filter expressions, including a range of different filter operators, and the ability to compose filters with :literal:`and` and :literal:`or` operators, see the :literal:`complex\_filter` parameter. - For more details, see \ `How to build a filter expression `__\ . + For more details, see \ `How to build a filter expression `__. - For examples, see \ :ref:`ibm.ibm\_zos\_cics.cmci\_get `\ . + For examples, see :ref:`ibm.ibm\_zos\_cics.cmci\_get `. - For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__\ . + For supported attributes of different resource types, see their resource table reference, for example, \ `PROGDEF resource table reference `__. | **required**: False @@ -250,8 +249,7 @@ resources get_parameters - A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__\ . - + A list of one or more parameters with optional values used to identify the resources for this request. Eligible parameters for identifying the target resources can be found in the resource table reference for the target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table. For example, the valid parameters for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP, as found in the \ `PROGDEF resource table reference `__. | **required**: False @@ -293,11 +291,11 @@ scheme scope Specifies the name of a CICSplex, CICS region group, CICS region, or logical scope that is associated with the query. - \ :emphasis:`scope`\ is a subset of \ :emphasis:`context`\ and limits the request to particular CICS systems or resources. + :emphasis:`scope` is a subset of :emphasis:`context` and limits the request to particular CICS systems or resources. - \ :emphasis:`scope`\ is optional. If it's not specified, the request is limited by the value of \ :emphasis:`context`\ alone. + :emphasis:`scope` is optional. If it's not specified, the request is limited by the value of :emphasis:`context` alone. - The value of \ :emphasis:`scope`\ must contain no spaces. \ :emphasis:`scope`\ is not case-sensitive. + The value of :emphasis:`scope` must contain no spaces. :emphasis:`scope` is not case-sensitive. | **required**: false @@ -316,7 +314,7 @@ timeout type - The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__\ . + The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see \ `CMCI resource names `__. | **required**: True @@ -325,8 +323,7 @@ type update_parameters - A list of one or more parameters that control the \ :emphasis:`update`\ operation. Eligible parameters for the UPDATE operation can be found in the resource table reference for the target resource type, as listed in the UPDATE operation section of the "Valid CPSM operations" table. For example, the only valid parameter for a PROGDEF UPDATE operation is CSD, as found in the \ `PROGDEF resource table reference `__\ . - + A list of one or more parameters that control the :emphasis:`update` operation. Eligible parameters for the UPDATE operation can be found in the resource table reference for the target resource type, as listed in the UPDATE operation section of the "Valid CPSM operations" table. For example, the only valid parameter for a PROGDEF UPDATE operation is CSD, as found in the \ `PROGDEF resource table reference `__. | **required**: False @@ -362,9 +359,9 @@ Examples - name: update a bundle definition in a CICS region cmci_update: - cmci_host: "winmvs2c.hursley.ibm.com" - cmci_port: "10080" - context: "iyk3z0r9" + cmci_host: "example.com" + cmci_port: "12345" + context: "plex_or_applid" type: "CICSDefinitionBundle" attributes: description: "New description" diff --git a/docs/source/modules/csd.rst b/docs/source/modules/csd.rst index 20e624aa..927c7b57 100644 --- a/docs/source/modules/csd.rst +++ b/docs/source/modules/csd.rst @@ -20,9 +20,9 @@ csd -- Create, remove, and manage the CICS CSD Synopsis -------- -- Create, remove, and manage the \ `CICS system definition data set `__\ (CSD) used by a CICS® region. +- Create, remove, and manage the \ `CICS system definition data set `__ (CSD) used by a CICS® region. - You can use this module when provisioning or de-provisioning a CICS region, or when managing the state of the CSD during upgrades or restarts. -- Use the \ :literal:`state`\ option to specify the intended state for the CSD. For example, use \ :literal:`state=initial`\ to create and initialize a CSD if it doesn't exist, or empty an existing CSD of all records. +- Use the :literal:`state` option to specify the intended state for the CSD. For example, use :literal:`state=initial` to create and initialize a CSD if it doesn't exist, or empty an existing CSD of all records. @@ -34,7 +34,7 @@ Parameters cics_data_sets - The name of the \ :literal:`SDFHLOAD`\ library of the CICS installation, for example, \ :literal:`CICSTS61.CICS.SDFHLOAD`\ . + The name of the :literal:`SDFHLOAD` library of the CICS installation, for example, :literal:`CICSTS61.CICS.SDFHLOAD`. | **required**: True @@ -43,7 +43,7 @@ cics_data_sets sdfhload - The location of the \ :literal:`SDFHLOAD`\ library. If \ :literal:`cics\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SDFHLOAD` library. If :literal:`cics\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -52,7 +52,7 @@ cics_data_sets template - The templated location of the \ :literal:`SDFHLOAD`\ library. + The templated location of the :literal:`SDFHLOAD` library. | **required**: False @@ -62,7 +62,7 @@ cics_data_sets input_content - The content of the DFHCSDUP script to submit, if you are using the \ :literal:`input\_location=INLINE`\ option. + The content of the DFHCSDUP script to submit, if you are using the :literal:`input\_location=INLINE` option. | **required**: False @@ -73,13 +73,13 @@ input_content input_location The type of location from which to load the DFHCSDUP script. - Specify \ :literal:`DATA\_SET`\ to load from a PDS, PDSE, or sequential data set. + Specify :literal:`DATA\_SET` to load from a PDS, PDSE, or sequential data set. - Specify \ :literal:`USS`\ to load from a file on UNIX System Services (USS). + Specify :literal:`USS` to load from a file on UNIX System Services (USS). - Specify \ :literal:`LOCAL`\ to load from a file local to the Ansible control node. + Specify :literal:`LOCAL` to load from a file local to the Ansible control node. - Specify \ :literal:`INLINE`\ to allow a script to be passed directly through the \ :literal:`input\_content`\ parameter. + Specify :literal:`INLINE` to allow a script to be passed directly through the :literal:`input\_content` parameter. | **required**: False @@ -111,7 +111,7 @@ log Specify UNDO for a CSD that is limited to file backout only. - Specify ALL for a CSD for which you want both forward recovery and file backout. If you specify \ :literal:`log=ALL`\ , you must also specify LOGSTREAMID to identify the 26-character name of the z/OS™ log stream to be used as the forward recovery log. The CICS collection does not support defining forward recovery log streams; you must follow the instructions in \ `Defining forward recovery log streams `__\ . + Specify ALL for a CSD for which you want both forward recovery and file backout. If you specify :literal:`log=ALL`\ , you must also specify LOGSTREAMID to identify the 26-character name of the z/OS™ log stream to be used as the forward recovery log. The CICS collection does not support defining forward recovery log streams; you must follow the instructions in \ `Defining forward recovery log streams `__. | **required**: False @@ -123,7 +123,7 @@ log logstream_id The 26-character name of the z/OS™ log stream to be used as the forward recovery log. - This is required when you use \ :literal:`log=ALL`\ . + This is required when you use :literal:`log=ALL`. | **required**: False @@ -132,7 +132,7 @@ logstream_id region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. | **required**: True @@ -170,7 +170,7 @@ region_data_sets space_primary - The size of the primary space allocated to the CSD. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the primary space allocated to the CSD. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the CSD is being created. If the CSD already exists, the option has no effect. @@ -182,7 +182,7 @@ space_primary space_secondary - The size of the secondary space allocated to the CSD. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the secondary space allocated to the CSD. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the CSD is being created. If the CSD already exists, the option has no effect. @@ -194,7 +194,7 @@ space_secondary space_type - The unit portion of the CSD 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`\ . + The unit portion of the CSD 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`. This option takes effect only when the CSD is being created. If the CSD already exists, the option has no effect. @@ -211,13 +211,13 @@ space_type state The intended state for the CSD, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the CSD entirely, if it already exists. + Specify :literal:`absent` to remove the CSD entirely, if it already exists. - Specify \ :literal:`initial`\ to create the CSD if it does not already exist, and initialize it by using DFHCSDUP. + Specify :literal:`initial` to create the CSD if it does not already exist, and initialize it by using DFHCSDUP. - Specify \ :literal:`warm`\ to retain an existing CSD 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. + Specify :literal:`warm` to retain an existing CSD 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. - Specify \ :literal:`changed`\ to run a DFHCSDUP script to update an existing CSD. + Specify :literal:`changed` to run a DFHCSDUP script to update an existing CSD. | **required**: True diff --git a/docs/source/modules/global_catalog.rst b/docs/source/modules/global_catalog.rst index 0c605a17..e8d0ef58 100644 --- a/docs/source/modules/global_catalog.rst +++ b/docs/source/modules/global_catalog.rst @@ -20,9 +20,9 @@ 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. +- 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 \ :literal:`state`\ option to specify the intended state for the global catalog. For example, use \ :literal:`state=initial`\ to create and initialize a global catalog data set if it doesn't exist, or set the autostart override record of an existing global catalog to \ :literal:`AUTOINIT`\ . In either case, a CICS region that is using this global catalog and set with the \ :literal:`START=AUTO`\ system initialization parameter performs an initial start. +- Use the :literal:`state` option to specify the intended state for the global catalog. For example, use :literal:`state=initial` to create and initialize a global catalog data set if it doesn't exist, or set the autostart override record of an existing global catalog to :literal:`AUTOINIT`. In either case, a CICS region that is using this global catalog and set with the :literal:`START=AUTO` system initialization parameter performs an initial start. @@ -34,9 +34,9 @@ Parameters cics_data_sets - The name of the \ :literal:`SDFHLOAD`\ library of the CICS installation, for example, \ :literal:`CICSTS61.CICS.SDFHLOAD`\ . + The name of the :literal:`SDFHLOAD` library of the CICS installation, for example, :literal:`CICSTS61.CICS.SDFHLOAD`. - This module uses the \ :literal:`DFHRMUTL`\ utility internally, which is found in the \ :literal:`SDFHLOAD`\ library. + This module uses the :literal:`DFHRMUTL` utility internally, which is found in the :literal:`SDFHLOAD` library. | **required**: True @@ -45,7 +45,7 @@ cics_data_sets sdfhload - The location of the \ :literal:`SDFHLOAD`\ library. If \ :literal:`cics\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SDFHLOAD` library. If :literal:`cics\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -54,7 +54,7 @@ cics_data_sets template - The templated location of the \ :literal:`SDFHLOAD`\ library. + The templated location of the :literal:`SDFHLOAD` library. | **required**: False @@ -64,7 +64,7 @@ cics_data_sets region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`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. @@ -104,7 +104,7 @@ region_data_sets 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 \ :literal:`space\_type`\ . + 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 :literal:`space\_type`. This option takes effect only when the global catalog data set is being created. If the global catalog data set already exists, the option has no effect. @@ -116,7 +116,7 @@ space_primary 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 \ :literal:`space\_type`\ . + 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 :literal:`space\_type`. This option takes effect only when the global catalog data set is being created. If the global catalog data set already exists, the option has no effect. @@ -128,7 +128,7 @@ space_secondary space_type - The unit portion of the global catalog 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`\ . + The unit portion of the global catalog 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`. This option takes effect only when the global catalog data set is being created. If the global catalog data set already exists, the option has no effect. @@ -145,13 +145,13 @@ space_type state The intended state for the global catalog data set, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the global catalog data set entirely, if it exists. + Specify :literal:`absent` to remove the global catalog data set entirely, if it exists. - Specify \ :literal:`initial`\ to set the autostart override record to \ :literal:`AUTOINIT`\ . If the specified global catalog data set does not already exist, the module creates the data set. + Specify :literal:`initial` to set the autostart override record to :literal:`AUTOINIT`. If the specified global catalog data set does not already exist, the module creates the data set. - Specify \ :literal:`cold`\ to set the autostart override record of an existing global catalog to \ :literal:`AUTOCOLD`\ . If the specified global catalog data set does not already exist, the operation fails. + Specify :literal:`cold` to set the autostart override record of an existing global catalog to :literal:`AUTOCOLD`. If the specified global catalog data set does not already exist, the operation fails. - Specify \ :literal:`warm`\ to set the autostart override record of an existing global catalog to \ :literal:`AUTOASIS`\ , undoing any previous setting of \ :literal:`AUTOINIT`\ or \ :literal:`AUTOCOLD`\ . The module verifies whether the specified data set exists and whether it contains any records. If either condition is not met, the operation fails. + Specify :literal:`warm` to set the autostart override record of an existing global catalog to :literal:`AUTOASIS`\ , undoing any previous setting of :literal:`AUTOINIT` or :literal:`AUTOCOLD`. The module verifies whether the specified data set exists and whether it contains any records. If either condition is not met, the operation fails. | **required**: True diff --git a/docs/source/modules/local_catalog.rst b/docs/source/modules/local_catalog.rst index 73ae81e4..8146f468 100644 --- a/docs/source/modules/local_catalog.rst +++ b/docs/source/modules/local_catalog.rst @@ -20,9 +20,9 @@ local_catalog -- Create, remove, and manage the CICS local catalog Synopsis -------- -- Create, remove, and manage the \ `local catalog `__\ data set used by a CICS® region. CICS domains use the local catalog to save some of their information between CICS runs and to preserve this information across a cold start. +- Create, remove, and manage the \ `local catalog `__ data set used by a CICS® region. CICS domains use the local catalog to save some of their information between CICS runs and to preserve this information across a cold start. - You can use this module when provisioning or de-provisioning a CICS region, or when managing the state of the local catalog during upgrades or restarts. -- Use the \ :literal:`state`\ option to specify the intended state for the local catalog. For example, use \ :literal:`state=initial`\ to create and initialize a local catalog data set if it doesn't exist, or empty an existing local catalog of all records. +- Use the :literal:`state` option to specify the intended state for the local catalog. For example, use :literal:`state=initial` to create and initialize a local catalog data set if it doesn't exist, or empty an existing local catalog of all records. @@ -34,9 +34,9 @@ Parameters cics_data_sets - The name of the \ :literal:`SDFHLOAD`\ library of the CICS installation, for example, \ :literal:`CICSTS61.CICS.SDFHLOAD`\ . + The name of the :literal:`SDFHLOAD` library of the CICS installation, for example, :literal:`CICSTS61.CICS.SDFHLOAD`. - This module uses the \ :literal:`DFHCCUTL`\ utility internally, which is found in the \ :literal:`SDFHLOAD`\ library. + This module uses the :literal:`DFHCCUTL` utility internally, which is found in the :literal:`SDFHLOAD` library. | **required**: True @@ -45,7 +45,7 @@ cics_data_sets sdfhload - The location of the \ :literal:`SDFHLOAD`\ library. If \ :literal:`cics\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SDFHLOAD` library. If :literal:`cics\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -54,7 +54,7 @@ cics_data_sets template - The templated location of the \ :literal:`SDFHLOAD`\ library. + The templated location of the :literal:`SDFHLOAD` library. | **required**: False @@ -64,7 +64,7 @@ cics_data_sets region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. If you want to use a data set that already exists, ensure that the data set is a local catalog data set. @@ -104,7 +104,7 @@ region_data_sets space_primary - The size of the primary space allocated to the local catalog data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the primary space allocated to the local catalog data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the local catalog data set is being created. If the local catalog data set already exists, the option has no effect. @@ -116,7 +116,7 @@ space_primary space_secondary - The size of the secondary space allocated to the local catalog data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the secondary space allocated to the local catalog data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the local catalog data set is being created. If the local catalog data set already exists, the option has no effect. @@ -128,7 +128,7 @@ space_secondary space_type - The unit portion of the local catalog 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`\ . + The unit portion of the local catalog 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`. This option takes effect only when the local catalog data set is being created. If the local catalog data set already exists, the option has no effect. @@ -145,11 +145,11 @@ space_type state The intended state for the local catalog, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the local catalog data set entirely, if it already exists. + Specify :literal:`absent` to remove the local catalog data set entirely, if it already exists. - Specify \ :literal:`initial`\ to create the local catalog data set if it does not exist, or empty this existing local catalog of all records. + Specify :literal:`initial` to create the local catalog data set if it does not exist, or empty this existing local catalog of all records. - Specify \ :literal:`warm`\ to retain an existing local catalog 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. + Specify :literal:`warm` to retain an existing local catalog 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 diff --git a/docs/source/modules/local_request_queue.rst b/docs/source/modules/local_request_queue.rst index 34bf6b77..10716a96 100644 --- a/docs/source/modules/local_request_queue.rst +++ b/docs/source/modules/local_request_queue.rst @@ -20,9 +20,9 @@ local_request_queue -- Create and remove the CICS local request queue Synopsis -------- -- Create and remove the \ `local request queue `__\ data set used by a CICS® region. The local request queue data set stores pending BTS requests. It ensures that, if CICS fails, no pending requests are lost. +- Create and remove the \ `local request queue `__ data set used by a CICS® region. The local request queue data set stores pending BTS requests. It ensures that, if CICS fails, no pending requests are lost. - You can use this module when provisioning or de-provisioning a CICS region. -- Use the \ :literal:`state`\ option to specify the intended state for the local request queue. For example, use \ :literal:`state=initial`\ to create a local request queue data set if it doesn't yet exist, or empty an existing local request queue of all records. +- Use the :literal:`state` option to specify the intended state for the local request queue. For example, use :literal:`state=initial` to create a local request queue data set if it doesn't yet exist, or empty an existing local request queue of all records. @@ -34,7 +34,7 @@ Parameters region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. If you want to use a data set that already exists, ensure that the data set is a local request queue data set. @@ -74,7 +74,7 @@ region_data_sets space_primary - The size of the primary space allocated to the local request queue data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the primary space allocated to the local request queue data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect when the local request queue data set is being created. If the data set already exists, the option has no effect. @@ -86,7 +86,7 @@ space_primary space_secondary - The size of the secondary space allocated to the local request queue data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the secondary space allocated to the local request queue data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect when the local request queue data set is being created. If the data set already exists, the option has no effect. @@ -98,7 +98,7 @@ space_secondary space_type - The unit portion of the local request queue 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`\ . + The unit portion of the local request queue 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`. This option takes effect only when the local request queue data set is being created. If the data set already exists, the option has no effect. @@ -115,11 +115,11 @@ space_type state The intended state for the local request queue, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the local request queue data set entirely, if it exists. + Specify :literal:`absent` to remove the local request queue data set entirely, if it exists. - Specify \ :literal:`initial`\ to create the local request queue data set if it does not exist, or empty this existing local request queue of all records. + Specify :literal:`initial` to create the local request queue data set if it does not exist, or empty this existing local request queue of all records. - Specify \ :literal:`warm`\ to retain an existing local request queue data set in its current state. The module checks whether the specified data set exists, and if it does, leaves the data set as is. If the data set does not exist, the operation fails. + Specify :literal:`warm` to retain an existing local request queue data set in its current state. The module checks whether the specified data set exists, and if it does, leaves the data set as is. If the data set does not exist, the operation fails. | **required**: True diff --git a/docs/source/modules/region_jcl.rst b/docs/source/modules/region_jcl.rst index 8e5728b9..0630b653 100644 --- a/docs/source/modules/region_jcl.rst +++ b/docs/source/modules/region_jcl.rst @@ -21,7 +21,7 @@ region_jcl -- Create CICS startup JCL data set Synopsis -------- - Create a data set containing the JCL to start a CICS® region. -- The JCL is generated by your input of CICS system data sets and system initialization parameters for CICS startup using the \ :literal:`DFHSIP`\ program. +- The JCL is generated by your input of CICS system data sets and system initialization parameters for CICS startup using the :literal:`DFHSIP` program. @@ -42,7 +42,7 @@ applid cics_data_sets - The data set names of the \ :literal:`SDFHAUTH`\ , \ :literal:`SDFHLOAD`\ and \ :literal:`SDFHLIC`\ libraries, for example, \ :literal:`CICSTS61.CICS.SDFHAUTH`\ and \ :literal:`CICSTS61.CICS.SDFHLOAD`\ . + The data set names of the :literal:`SDFHAUTH`\ , :literal:`SDFHLOAD` and :literal:`SDFHLIC` libraries, for example, :literal:`CICSTS61.CICS.SDFHAUTH` and :literal:`CICSTS61.CICS.SDFHLOAD`. | **required**: True @@ -51,7 +51,7 @@ cics_data_sets sdfhauth - The location of the \ :literal:`SDFHAUTH`\ librarty to override the template. + The location of the :literal:`SDFHAUTH` librarty to override the template. | **required**: False @@ -60,7 +60,7 @@ cics_data_sets sdfhlic - The location of the \ :literal:`SDFHLIC`\ library. If \ :literal:`cics\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SDFHLIC` library. If :literal:`cics\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -69,7 +69,7 @@ cics_data_sets sdfhload - The location of the \ :literal:`SDFHLOAD`\ library. If \ :literal:`cics\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SDFHLOAD` library. If :literal:`cics\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -88,7 +88,7 @@ cics_data_sets cpsm_data_sets - The data set names of the \ :literal:`SEYUAUTH`\ and \ :literal:`SEYULOAD`\ libraries, for example, \ :literal:`CTS610.CPSM610.SEYUAUTH`\ . + The data set names of the :literal:`SEYUAUTH` and :literal:`SEYULOAD` libraries, for example, :literal:`CTS610.CPSM610.SEYUAUTH`. | **required**: False @@ -97,7 +97,7 @@ cpsm_data_sets seyuauth - The location of the \ :literal:`SEYUAUTH`\ library. If \ :literal:`cpsm\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SEYUAUTH` library. If :literal:`cpsm\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -106,7 +106,7 @@ cpsm_data_sets seyuload - The location of the \ :literal:`SEYULOAD`\ library. If \ :literal:`cpsm\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SEYULOAD` library. If :literal:`cpsm\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -125,7 +125,7 @@ cpsm_data_sets dfhrpl - Any locations of additional data sets other than \ :literal:`SDFHLOAD`\ , \ :literal:`SCEECICS`\ , \ :literal:`SCEERUN`\ , or \ :literal:`SCEERUN2`\ , to be added to the DFHRPL concatenation. The DFHRPL concatenation is where you specify the libraries that contain modules loaded by CICS, for example, the libraries containing your CICS application programs, your CICS control tables, and so on. You can either add data sets at the very top of the list or append them to the bottom of the list. There are other data sets in between, as determined by the defaults or other input parameters; for example, \ :literal:`SCEERUN`\ and \ :literal:`SCEERUN2`\ as specified with \ :literal:`le\_data\_sets`\ , \ :literal:`SDFHLOAD`\ as specified with \ :literal:`cics\_data\_sets`\ , and so on. + Any locations of additional data sets other than :literal:`SDFHLOAD`\ , :literal:`SCEECICS`\ , :literal:`SCEERUN`\ , or :literal:`SCEERUN2`\ , to be added to the DFHRPL concatenation. The DFHRPL concatenation is where you specify the libraries that contain modules loaded by CICS, for example, the libraries containing your CICS application programs, your CICS control tables, and so on. You can either add data sets at the very top of the list or append them to the bottom of the list. There are other data sets in between, as determined by the defaults or other input parameters; for example, :literal:`SCEERUN` and :literal:`SCEERUN2` as specified with :literal:`le\_data\_sets`\ , :literal:`SDFHLOAD` as specified with :literal:`cics\_data\_sets`\ , and so on. | **required**: False @@ -134,7 +134,7 @@ dfhrpl data_sets - The \ :literal:`DFHRPL`\ data sets to be added to the bottom of the list. + The :literal:`DFHRPL` data sets to be added to the bottom of the list. | **required**: False @@ -143,7 +143,7 @@ dfhrpl top_data_sets - The \ :literal:`DFHRPL`\ data sets to be added to the very top of the list. + The :literal:`DFHRPL` data sets to be added to the very top of the list. | **required**: False @@ -262,7 +262,7 @@ job_parameters job_name - The name of the CICS startup job. The default value is \ :literal:`APPLID`\ . + The name of the CICS startup job. The default value is :literal:`APPLID`. | **required**: False @@ -347,7 +347,7 @@ job_parameters le_data_sets - The data set names of the \ :literal:`SCEECICS`\ , \ :literal:`SCEERUN`\ and \ :literal:`SCEERUN2`\ libraries. + The data set names of the :literal:`SCEECICS`\ , :literal:`SCEERUN` and :literal:`SCEERUN2` libraries. | **required**: True @@ -356,7 +356,7 @@ le_data_sets sceecics - The location of the \ :literal:`SCEECICS`\ library. If \ :literal:`le\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SCEECICS` library. If :literal:`le\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -365,7 +365,7 @@ le_data_sets sceerun - The location of the \ :literal:`SCEERUN`\ library. If \ :literal:`le\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SCEERUN` library. If :literal:`le\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -374,7 +374,7 @@ le_data_sets sceerun2 - The location of the \ :literal:`SCEERUN2`\ library. If \ :literal:`le\_data\_sets.template`\ is provided, this value overrides the template. + The location of the :literal:`SCEERUN2` library. If :literal:`le\_data\_sets.template` is provided, this value overrides the template. | **required**: False @@ -393,7 +393,7 @@ le_data_sets output_data_sets - The system output data sets such as \ :literal:`CEEMSG`\ and \ :literal:`SYSPRINT`\ , as well as the destination class of the output. + The system output data sets such as :literal:`CEEMSG` and :literal:`SYSPRINT`\ , as well as the destination class of the output. | **required**: False @@ -402,7 +402,7 @@ output_data_sets ceemsg - Overrides the default class to use a custom class for the \ :literal:`CEEMSG`\ data set. Alternatively, omit the \ :literal:`CEEMSG`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`CEEMSG` data set. Alternatively, omit the :literal:`CEEMSG` data set from being added to the job. | **required**: False @@ -411,7 +411,7 @@ output_data_sets omit - Specifies whether \ :literal:`CEEMSG`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`CEEMSG` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -420,7 +420,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`CEEMSG`\ data set to. + Specify the output class to assign the :literal:`CEEMSG` data set to. | **required**: False @@ -430,7 +430,7 @@ output_data_sets ceeout - Overrides the default class to use a custom class for the \ :literal:`CEEOUT`\ data set. Alternatively, omit the \ :literal:`CEEOUT`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`CEEOUT` data set. Alternatively, omit the :literal:`CEEOUT` data set from being added to the job. | **required**: False @@ -439,7 +439,7 @@ output_data_sets omit - Specifies whether \ :literal:`CEEOUT`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`CEEOUT` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -448,7 +448,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`CEEOUT`\ data set to. + Specify the output class to assign the :literal:`CEEOUT` data set to. | **required**: False @@ -467,7 +467,7 @@ output_data_sets dfhcxrf - Overrides the default class to use a custom class for the \ :literal:`DFHCXRF`\ data set. Alternatively, omit the \ :literal:`DFHCXRF`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`DFHCXRF` data set. Alternatively, omit the :literal:`DFHCXRF` data set from being added to the job. | **required**: False @@ -476,7 +476,7 @@ output_data_sets omit - Specifies whether \ :literal:`DFHCXRF`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`DFHCXRF` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -485,7 +485,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`DFHCXRF`\ data set to. + Specify the output class to assign the :literal:`DFHCXRF` data set to. | **required**: False @@ -495,7 +495,7 @@ output_data_sets logusr - Overrides the default class to use a custom class for the \ :literal:`LOGUSR`\ data set. Alternatively, omit the \ :literal:`LOGUSR`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`LOGUSR` data set. Alternatively, omit the :literal:`LOGUSR` data set from being added to the job. | **required**: False @@ -504,7 +504,7 @@ output_data_sets omit - Specifies whether \ :literal:`LOGUSR`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`LOGUSR` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -513,7 +513,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`LOGUSR`\ data set to. + Specify the output class to assign the :literal:`LOGUSR` data set to. | **required**: False @@ -523,7 +523,7 @@ output_data_sets msgusr - Overrides the default class to use a custom class for the \ :literal:`MSGUSR`\ data set. Alternatively, omit the \ :literal:`MSGUSR`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`MSGUSR` data set. Alternatively, omit the :literal:`MSGUSR` data set from being added to the job. | **required**: False @@ -532,7 +532,7 @@ output_data_sets omit - Specifies whether \ :literal:`MSGUSR`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`MSGUSR` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -541,7 +541,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`MSGUSR`\ data set to. + Specify the output class to assign the :literal:`MSGUSR` data set to. | **required**: False @@ -551,7 +551,7 @@ output_data_sets sysabend - Overrides the default class to use a custom class for the \ :literal:`SYSABEND`\ data set. Alternatively, omit the \ :literal:`SYSABEND`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`SYSABEND` data set. Alternatively, omit the :literal:`SYSABEND` data set from being added to the job. | **required**: False @@ -560,7 +560,7 @@ output_data_sets omit - Specifies whether \ :literal:`SYSABEND`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`SYSABEND` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -569,7 +569,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`SYSABEND`\ data set to. + Specify the output class to assign the :literal:`SYSABEND` data set to. | **required**: False @@ -579,7 +579,7 @@ output_data_sets sysout - Overrides the default class to use a custom class for the \ :literal:`SYSOUT`\ data set. Alternatively, omit the \ :literal:`SYSOUT`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`SYSOUT` data set. Alternatively, omit the :literal:`SYSOUT` data set from being added to the job. | **required**: False @@ -588,7 +588,7 @@ output_data_sets omit - Specifies whether \ :literal:`SYSOUT`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`SYSOUT` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -597,7 +597,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`SYSOUT`\ data set to. + Specify the output class to assign the :literal:`SYSOUT` data set to. | **required**: False @@ -607,7 +607,7 @@ output_data_sets sysprint - Overrides the default class to use a custom class for the \ :literal:`SYSPRINT`\ data set. Alternatively, omit the \ :literal:`SYSPRINT`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`SYSPRINT` data set. Alternatively, omit the :literal:`SYSPRINT` data set from being added to the job. | **required**: False @@ -616,7 +616,7 @@ output_data_sets omit - Specifies whether \ :literal:`SYSPRINT`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`SYSPRINT` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -625,7 +625,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`SYSPRINT`\ data set to. + Specify the output class to assign the :literal:`SYSPRINT` data set to. | **required**: False @@ -635,7 +635,7 @@ output_data_sets sysudump - Overrides the default class to use a custom class for the \ :literal:`SYSUDUMP`\ data set. Alternatively, omit the \ :literal:`SYSUDUMP`\ data set from being added to the job. + Overrides the default class to use a custom class for the :literal:`SYSUDUMP` data set. Alternatively, omit the :literal:`SYSUDUMP` data set from being added to the job. | **required**: False @@ -644,7 +644,7 @@ output_data_sets omit - Specifies whether \ :literal:`SYSUDUMP`\ should be excluded from being added to the list of sysout data sets. + Specifies whether :literal:`SYSUDUMP` should be excluded from being added to the list of sysout data sets. | **required**: False @@ -653,7 +653,7 @@ output_data_sets sysout - Specify the output class to assign the \ :literal:`SYSUDUMP`\ data set to. + Specify the output class to assign the :literal:`SYSUDUMP` data set to. | **required**: False @@ -664,7 +664,7 @@ output_data_sets region_data_sets - The location of the region data sets, for example, \ :literal:`REGIONS.ABCD01.DFHAUXT`\ , \ :literal:`REGIONS.ABCD01.DFHCSD`\ and \ :literal:`REGIONS.ABCD01.DFHGCD`\ . + The location of the region data sets, for example, :literal:`REGIONS.ABCD01.DFHAUXT`\ , :literal:`REGIONS.ABCD01.DFHCSD` and :literal:`REGIONS.ABCD01.DFHGCD`. | **required**: True @@ -884,7 +884,7 @@ region_data_sets template - The base location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . This is not required if you provide the data set name (dsn) of all the data sets individually. + The base location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. This is not required if you provide the data set name (dsn) of all the data sets individually. | **required**: False @@ -2731,7 +2731,7 @@ sit_parameters You can provide several dictionaries to specify the level of special tracing for several components. Each component is defined by one dictionary. - For information about CICS components and their respetive two-letter code, see \ `Component names and abbreviations `__\ . + For information about CICS components and their respetive two-letter code, see \ `Component names and abbreviations `__. | **required**: False @@ -2879,7 +2879,7 @@ sit_parameters You can provide several dictionaries to specify the level of standard tracing for several components. Each component is defined by one dictionary. For components that are not defined here, their standard tracing levels are determined by STNTR. - For information about CICS components and their respective two-letter code, see \ `Component names and abbreviations `__\ . + For information about CICS components and their respective two-letter code, see \ `Component names and abbreviations `__. | **required**: False @@ -3440,7 +3440,7 @@ sit_parameters space_primary - 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`\ . + 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`. 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. @@ -3455,7 +3455,7 @@ space_primary space_secondary - 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`\ . + 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`. 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. @@ -3470,13 +3470,13 @@ space_secondary space_type - 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`\ . + 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`. 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. The size can be specified in megabytes (\ :literal:`M`\ ), kilobytes (\ :literal:`K`\ ), cylinders (\ :literal:`CYL`\ ), or tracks (\ :literal:`TRK`\ ). - If neither \ :literal:`space\_secondary`\ nor \ :literal:`space\_primary`\ is set, then this value does not have any effect. + If neither :literal:`space\_secondary` nor :literal:`space\_primary` is set, then this value does not have any effect. If the target data set is a member in a PDS or PDSE, then this value does not have any effect. @@ -3491,11 +3491,11 @@ space_type state The intended state for the CICS startup JCL data set, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the CICS startup JCL data set entirely, if it already exists. + Specify :literal:`absent` to remove the CICS startup JCL data set entirely, if it already exists. - Specify \ :literal:`initial`\ to create the CICS startup JCL data set if it does not already exist. + Specify :literal:`initial` to create the CICS startup JCL data set if it does not already exist. - 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. + 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. | **required**: True @@ -3505,7 +3505,7 @@ state steplib - Any locations of additional data sets other than \ :literal:`SDFHAUTH`\ , \ :literal:`SDFHLIC`\ , \ :literal:`SCEERUN`\ , or \ :literal:`SCEERUN2`\ , to be added to the STEPLIB concatenation. The STEPLIB concatenation is where you specify the libraries that contain the modules loaded by the z/OS operating system. You can either add data sets at the very top of the list or append them to the bottom of the list. There are other data sets in between, as determined by the defaults or other input parameters; for example, \ :literal:`SEYUAUTH`\ and \ :literal:`SEYULOAD`\ as sepcified with \ :literal:`cpsm\_data\_sets`\ , \ :literal:`SCEERUN`\ and \ :literal:`SCEERUN2`\ as specified with \ :literal:`le\_data\_sets`\ , \ :literal:`SDFHAUTH`\ and \ :literal:`SDFHLIC`\ as specified with \ :literal:`cics\_data\_sets`\ , and so on. + Any locations of additional data sets other than :literal:`SDFHAUTH`\ , :literal:`SDFHLIC`\ , :literal:`SCEERUN`\ , or :literal:`SCEERUN2`\ , to be added to the STEPLIB concatenation. The STEPLIB concatenation is where you specify the libraries that contain the modules loaded by the z/OS operating system. You can either add data sets at the very top of the list or append them to the bottom of the list. There are other data sets in between, as determined by the defaults or other input parameters; for example, :literal:`SEYUAUTH` and :literal:`SEYULOAD` as sepcified with :literal:`cpsm\_data\_sets`\ , :literal:`SCEERUN` and :literal:`SCEERUN2` as specified with :literal:`le\_data\_sets`\ , :literal:`SDFHAUTH` and :literal:`SDFHLIC` as specified with :literal:`cics\_data\_sets`\ , and so on. | **required**: False @@ -3514,7 +3514,7 @@ steplib data_sets - The \ :literal:`STEPLIB`\ data sets to be added to the bottom of the list. + The :literal:`STEPLIB` data sets to be added to the bottom of the list. | **required**: False @@ -3523,7 +3523,7 @@ steplib top_data_sets - The \ :literal:`STEPLIB`\ data sets to be added to the very top of the list. + The :literal:`STEPLIB` data sets to be added to the very top of the list. | **required**: False diff --git a/docs/source/modules/stop_region.rst b/docs/source/modules/stop_region.rst index 065132c0..79be18ca 100644 --- a/docs/source/modules/stop_region.rst +++ b/docs/source/modules/stop_region.rst @@ -20,11 +20,11 @@ stop_region -- Stop a CICS region Synopsis -------- -- Stop a CICS region by issuing a CEMT PERFORM SHUTDOWN command, or by canceling the job through the \ :literal:`jobs.cancel`\ utility provided by Z Open Automation Utilities (ZOAU). You can choose the shutdown mode from NORMAL, IMMEDIATE, or CANCEL. -- The \ :literal:`job\_id`\ , \ :literal:`job\_name`\ , or both can be used to shut down a CICS region. If mulitple jobs are running with the same name, the \ :literal:`job\_id`\ is required. +- Stop a CICS region by issuing a CEMT PERFORM SHUTDOWN command, or by canceling the job through the :literal:`jobs.cancel` utility provided by Z Open Automation Utilities (ZOAU). You can choose the shutdown mode from NORMAL, IMMEDIATE, or CANCEL. +- The :literal:`job\_id`\ , :literal:`job\_name`\ , or both can be used to shut down a CICS region. If mulitple jobs are running with the same name, the :literal:`job\_id` is required. - During a NORMAL or IMMEDIATE shutdown, a shutdown assist transaction should run to enable CICS to shut down in a controlled manner. By default, the CICS-supplied shutdown assist transaction, CESD is used. You can specify a custom shutdown assist transaction in the SDTRAN system initialization parameter. The task runs until the region has successfully shut down, or until the shutdown fails. -- You must have a console installed in the CICS region so that the stop\_region module can communicate with CICS. To define a console, you must install a terminal with the CONSNAME attribute set to your TSO user ID. For detailed instructions, see \ `Defining TSO users as console devices `__\ . Add your console definition into one of the resource lists defined on the GRPLIST system initialization parameter so that it gets installed into the CICS region. Alternatively, you can use a DFHCSDUP script to update an existing CSD. This function is provided by the csd module. -- You can specify a timeout, in seconds, for CICS shutdown processing. After a request to stop CICS is issued, if CICS shutdown processing is not completed when this timeout is reached, the module completes in a failed state. By default, the stop\_region module does not use a timeout, that is, the \ :literal:`timeout`\ parameter assumes a value of -1. +- You must have a console installed in the CICS region so that the stop\_region module can communicate with CICS. To define a console, you must install a terminal with the CONSNAME attribute set to your TSO user ID. For detailed instructions, see \ `Defining TSO users as console devices `__. Add your console definition into one of the resource lists defined on the GRPLIST system initialization parameter so that it gets installed into the CICS region. Alternatively, you can use a DFHCSDUP script to update an existing CSD. This function is provided by the csd module. +- You can specify a timeout, in seconds, for CICS shutdown processing. After a request to stop CICS is issued, if CICS shutdown processing is not completed when this timeout is reached, the module completes in a failed state. By default, the stop\_region module does not use a timeout, that is, the :literal:`timeout` parameter assumes a value of -1. @@ -51,7 +51,7 @@ job_name The stop\_region module uses this job name to identify the state of the CICS region and shut it down. - The \ :literal:`job\_name`\ must be unique; if multiple jobs with the same name are running, use \ :literal:`job\_id`\ . + The :literal:`job\_name` must be unique; if multiple jobs with the same name are running, use :literal:`job\_id`. | **required**: False @@ -62,11 +62,11 @@ job_name mode Specify the type of shutdown to be executed on the CICS region. - Specify \ :literal:`normal`\ to perform a normal shutdown. This instructs the stop\_region module to issue a CEMT PERFORM SHUTDOWN command. + Specify :literal:`normal` to perform a normal shutdown. This instructs the stop\_region module to issue a CEMT PERFORM SHUTDOWN command. - Specify \ :literal:`immediate`\ to perform an immediate shutdown. This instructs the stop\_region module to issue a CEMT PERFORM SHUTDOWN IMMEDIATE command. + Specify :literal:`immediate` to perform an immediate shutdown. This instructs the stop\_region module to issue a CEMT PERFORM SHUTDOWN IMMEDIATE command. - Specify \ :literal:`cancel`\ to cancel the CICS region. This instructs the stop\_region module to use ZOAU's \ :literal:`jobs.cancel`\ utility to process the request. + Specify :literal:`cancel` to cancel the CICS region. This instructs the stop\_region module to use ZOAU's :literal:`jobs.cancel` utility to process the request. | **required**: False diff --git a/docs/source/modules/td_intrapartition.rst b/docs/source/modules/td_intrapartition.rst index bf22970c..675bf67a 100644 --- a/docs/source/modules/td_intrapartition.rst +++ b/docs/source/modules/td_intrapartition.rst @@ -20,9 +20,9 @@ td_intrapartition -- Create and remove the CICS transient data intrapartition da Synopsis -------- -- Create and remove the \ `transient data intrapartition `__\ data set used by a CICS® region. This data set holds all the data for intrapartition queues. +- Create and remove the \ `transient data intrapartition `__ data set used by a CICS® region. This data set holds all the data for intrapartition queues. - You can use this module when provisioning or de-provisioning a CICS region. -- Use the \ :literal:`state`\ option to specify the intended state for the transient data intrapartition data set. For example, use \ :literal:`state=initial`\ to create a transient data intrapartition data set if it doesn't exist. +- Use the :literal:`state` option to specify the intended state for the transient data intrapartition data set. For example, use :literal:`state=initial` to create a transient data intrapartition data set if it doesn't exist. @@ -34,7 +34,7 @@ Parameters region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. If you want to use a data set that already exists, ensure that the data set is a transient data intrapartition data set. @@ -74,7 +74,7 @@ region_data_sets space_primary - The size of the primary space allocated to the transient data intrapartition data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the primary space allocated to the transient data intrapartition data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the transient data intrapartition data set is being created. If the data set already exists, the option has no effect. @@ -86,7 +86,7 @@ space_primary space_secondary - The size of the secondary space allocated to the transient data intrapartition data set. Note that this is just the value; the unit is specified with \ :literal:`space\_type`\ . + The size of the secondary space allocated to the transient data intrapartition data set. Note that this is just the value; the unit is specified with :literal:`space\_type`. This option takes effect only when the transient data intrapartition data set is being created. If the data set already exists, the option has no effect. @@ -98,7 +98,7 @@ space_secondary space_type - The unit portion of the transient data intrapartition 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`\ . + The unit portion of the transient data intrapartition 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`. This option takes effect only when the transient data intrapartition data set is being created. If the data set already exists, the option has no effect. @@ -115,11 +115,11 @@ space_type state The intended state for the transient data intrapartition data set, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the transient data intrapartition data set entirely, if it exists. + Specify :literal:`absent` to remove the transient data intrapartition data set entirely, if it exists. - Specify \ :literal:`initial`\ to create the transient data intrapartition 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 :literal:`initial` to create the transient data intrapartition 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 \ :literal:`warm`\ to retain an existing transient data intrapartition 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. + Specify :literal:`warm` to retain an existing transient data intrapartition 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 diff --git a/docs/source/modules/transaction_dump.rst b/docs/source/modules/transaction_dump.rst index f8bf3d49..4f3072d7 100644 --- a/docs/source/modules/transaction_dump.rst +++ b/docs/source/modules/transaction_dump.rst @@ -20,7 +20,7 @@ transaction_dump -- Allocate transaction dump data sets Synopsis -------- -- Allocates the two \ `transaction dump `__\ data sets used by a CICS® region. +- 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). @@ -35,9 +35,9 @@ 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 \ :literal:`A`\ to create or delete the A data set. + Specify :literal:`A` to create or delete the A data set. - Specify \ :literal:`B`\ to create or delete the B data set. This MUST be set for the creation of the B data set. + Specify :literal:`B` to create or delete the B data set. This MUST be set for the creation of the B data set. | **required**: False @@ -48,7 +48,7 @@ destination region_data_sets - The location of the region data sets to be created by using a template, for example, \ :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`\ . + The location of the region data sets to be created by using a template, for example, :literal:`REGIONS.ABCD0001.\<\< data\_set\_name \>\>`. | **required**: True @@ -105,7 +105,7 @@ region_data_sets 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 \ :literal:`space\_type`\ . + 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 :literal:`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. @@ -117,7 +117,7 @@ space_primary 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 \ :literal:`space\_type`\ . + 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 :literal:`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. @@ -129,7 +129,7 @@ space_secondary 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 \ :literal:`space\_primary`\ and the value for the secondary space is specified with \ :literal:`space\_secondary`\ . + 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 :literal:`space\_primary` and the value for the secondary space is specified with :literal:`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. @@ -146,11 +146,11 @@ space_type state The intended state for the transaction dump data set, which the module aims to achieve. - Specify \ :literal:`absent`\ to remove the transaction dump data set entirely, if it exists. + Specify :literal:`absent` to remove the transaction dump data set entirely, if it exists. - Specify \ :literal:`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 :literal:`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 \ :literal:`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. + Specify :literal:`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