Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/source/modules/cmci_action.rst
Original file line number Diff line number Diff line change
Expand Up @@ -361,27 +361,27 @@ Examples
cmci_action:
cmci_host: "example.com"
cmci_port: 12345
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: "CICSProgram"
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: CICSProgram
action_name: NEWCOPY
resource:
resources:
filter:
name: "PONGALT"
get_parameters:
- name: "csdgroup"
value: "JVMGRP"
name: PONGALT

- name: install a bundle in a CICS region
- name: Install a bundle definition from CSD in a CICS region
cmci_action:
cmci_host: "example.com"
cmci_port: 1234
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
scope: "IJKLMNOP" # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
type: "CICSBundle"
action_name: DISABLE
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
scope: IJKLMNOP # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
type: CICSBundle
action_name: CSDINSTALL
resources:
filter:
name: "bundle"
name: mybund
get_parameters:
- name: csdgroup
value: mygrp



Expand Down Expand Up @@ -422,31 +422,31 @@ Return Values


cpsm_reason
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-alphabetical-order.
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_xnl_yky_51c.

| **returned**: success
| **type**: str



cpsm_reason_code
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-numerical-order.
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_lqj_lky_51c.

| **returned**: success
| **type**: int



cpsm_response
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-alphabetical-order.
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_o33_fky_51c.

| **returned**: success
| **type**: str



cpsm_response_code
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-numerical-order.
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_mzv_4jy_51c.

| **returned**: success
| **type**: str
Expand Down
18 changes: 9 additions & 9 deletions docs/source/modules/cmci_create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,19 +220,19 @@ Examples
.. code-block:: yaml+jinja


- name: define a BUNDLE in a CSD
- name: Define a BUNDLE in CSD
cmci_create:
cmci_host: "example.com"
cmci_port: 12345
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: "CICSDefinitionBundle"
scope: "IJKLMNOP" # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: CICSDefinitionBundle
scope: IJKLMNOP # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
attributes:
name: PONGALT
bundledir: /u/ibmuser/bundle/pong/pongbundle_1.0.0
csdgroup: JVMGRP
create_parameters:
- name: "csd"
- name: csd



Expand Down Expand Up @@ -273,31 +273,31 @@ Return Values


cpsm_reason
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-alphabetical-order.
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_xnl_yky_51c.

| **returned**: success
| **type**: str



cpsm_reason_code
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-numerical-order.
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_lqj_lky_51c.

| **returned**: success
| **type**: int



cpsm_response
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-alphabetical-order.
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_o33_fky_51c.

| **returned**: success
| **type**: str



cpsm_response_code
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-numerical-order.
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_mzv_4jy_51c.

| **returned**: success
| **type**: str
Expand Down
24 changes: 12 additions & 12 deletions docs/source/modules/cmci_delete.rst
Original file line number Diff line number Diff line change
Expand Up @@ -324,25 +324,25 @@ Examples
cmci_delete:
cmci_host: "example.com"
cmci_port: 12345
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: CICSBundle
resources:
filter:
name: "PONGALT"
name: PONGALT

- name: delete a bundle definition in a CICS region
cmci_delete:
cmci_host: "example.com"
cmci_port: 12345
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: CICSDefinitionBundle
scope: "IJKLMNOP" # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
resource:
scope: IJKLMNOP # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
resources:
filter:
name: "PONGALT"
name: PONGALT
get_parameters:
- name: "csdgroup"
value: "JVMGRP"
- name: csdgroup
value: JVMGRP



Expand Down Expand Up @@ -383,31 +383,31 @@ Return Values


cpsm_reason
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-alphabetical-order.
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_xnl_yky_51c.

| **returned**: success
| **type**: str



cpsm_reason_code
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-numerical-order.
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_lqj_lky_51c.

| **returned**: success
| **type**: int



cpsm_response
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-alphabetical-order.
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_o33_fky_51c.

| **returned**: success
| **type**: str



cpsm_response_code
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-numerical-order.
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_mzv_4jy_51c.

| **returned**: success
| **type**: str
Expand Down
38 changes: 19 additions & 19 deletions docs/source/modules/cmci_get.rst
Original file line number Diff line number Diff line change
Expand Up @@ -345,40 +345,40 @@ Examples
.. code-block:: yaml+jinja


- name: get 2 LOCFILEs from a CICSplex
- name: Get 2 LOCFILEs from a CICSplex
cmci_get:
cmci_host: "example.com"
cmci_port: 12345
cmci_user: "ibmuser"
cmci_user: ibmuser
cmci_password: "123456"
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: CICSLocalFile
record_count: 2
resource:
resources:
filter:
dsname: "CTS*"

- name: get a localfile in a CICS region
- name: Get a localfile in a CICS region
cmci_get:
cmci_host: "example.com"
cmci_port: 12345
cmci_cert: "./sec/ansible.pem"
cmci_key: "./sec/ansible.key"
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: "CICSLocalFile"
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: CICSLocalFile
resources:
filter:
dsname: "XIAOPIN*"
file: "DFH*"
record_count: 1

- name: get a progdef from a CSD
- name: Get a progdef from CSD
cmci_get:
cmci_host: "example.com"
cmci_port: 12345
cmci_cert: "./sec/ansible.pem"
cmci_key: "./sec/ansible.key"
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: cicsdefinitionprogram
resources:
filter:
Expand All @@ -388,14 +388,14 @@ Examples
value: MYGRP
record_count: 1

- name: pass module even if bundle definition is not found
- name: Ignore errors when bundle definition is not found
cmci_get:
cmci_host: "example.com"
cmci_port: 12345
cmci_cert: "./sec/ansible.pem"
cmci_key: "./sec/ansible.key"
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
scope: "IJKLMNOP" # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
scope: IJKLMNOP # scope only applies if you're in a CPSM environment and is either the name of a CICS system definition (CSYSDEF) or CICS system group (CSYSGRP)
type: cicsdefinitionbundle
resources:
filter:
Expand All @@ -404,16 +404,16 @@ Examples
- name: csdgroup
value: MYGRP
record_count: 1
fail_on_nodata: "false"
fail_on_nodata: false

- name: Using complex_filter to combine filter expressions and change operators
cmci_get:
cmci_host: "example.com"
cmci_port: 12345
cmci_cert: "./sec/ansible.pem"
cmci_key: "./sec/ansible.key"
context: "ABCDEFGH" # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: "CICSRegion"
context: ABCDEFGH # context is the name of your CICSplex in a CPSM environment or the applid of your region in an SMSS environment
type: CICSRegion
resources:
complex_filter:
or:
Expand Down Expand Up @@ -462,31 +462,31 @@ Return Values


cpsm_reason
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-alphabetical-order.
| The character value of the REASON code returned by each CICSPlex SM API command. For a list of REASON character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_xnl_yky_51c.

| **returned**: success
| **type**: str



cpsm_reason_code
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-reason-in-numerical-order.
| The numeric value of the REASON code returned by each CICSPlex SM API command. For a list of REASON numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_lqj_lky_51c.

| **returned**: success
| **type**: int



cpsm_response
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-alphabetical-order.
| The character value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE character values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_o33_fky_51c.

| **returned**: success
| **type**: str



cpsm_response_code
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/latest?topic=values-eyuda-response-in-numerical-order.
| The numeric value of the RESPONSE code returned by each CICSPlex SM API command. For a list of RESPONSE numeric values, see https://www.ibm.com/docs/en/cics-ts/6.x?topic=commands-eyuda-values#eyup2ks__table_mzv_4jy_51c.

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