Added missing attributes to examples. (#148)

* Added missing attributes to examples.

* Updated scope and context with the comments

* updated the scope with 8 character long name

* Fix cmci_action examples

Signed-off-by: Stewart Francis <[email protected]>

* Fix some other example errors, standardize bare words, title case in descriptions

Signed-off-by: Stewart Francis <[email protected]>

---------

Signed-off-by: Stewart Francis <[email protected]>
Co-authored-by: Pavan Satwik <>
Co-authored-by: Stewart Francis <[email protected]>

Author: Strange-Satwik

docs/source/modules/cmci_action.rst

@@ -361,7 +361,7 @@ Examples
      cmci_action:
        cmci_host: "example.com"
        cmci_port: 12345
-       context: "plex_or_applid"
+       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:
@@ -374,16 +374,14 @@ Examples
    - name: install a bundle in a CICS region
      cmci_action:
        cmci_host: "example.com"
-       cmci_port: "12345"
-       context: "plex_or_applid"
-       type: CICSBundle
-       action_name: install
-       resource:
+       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
+       resources:
          filter:
-           name: "PONGALT"
-       action_parameters:
-         - name: "usage"
-           value: "local"
+           name: "bundle"
 
 
 

docs/source/modules/cmci_create.rst

@@ -224,8 +224,9 @@ Examples
      cmci_create:
        cmci_host: "example.com"
        cmci_port: 12345
-       context: "plex_or_applid"
+       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

docs/source/modules/cmci_delete.rst

@@ -324,18 +324,19 @@ Examples
      cmci_delete:
        cmci_host: "example.com"
        cmci_port: 12345
-       context: "plex_or_applid"
+       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
-       resource:
+       resources:
          filter:
            name: "PONGALT"
 
    - name: delete a bundle definition in a CICS region
      cmci_delete:
        cmci_host: "example.com"
        cmci_port: 12345
-       context: "plex_or_applid"
+       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:
          filter:
            name: "PONGALT"

docs/source/modules/cmci_get.rst

@@ -351,7 +351,7 @@ Examples
        cmci_port: 12345
        cmci_user: "ibmuser"
        cmci_password: "123456"
-       context: "plex_or_applid"
+       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:
@@ -364,7 +364,7 @@ Examples
        cmci_port: 12345
        cmci_cert: "./sec/ansible.pem"
        cmci_key: "./sec/ansible.key"
-       context: "plex_or_applid"
+       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:
@@ -378,7 +378,7 @@ Examples
        cmci_port: 12345
        cmci_cert: "./sec/ansible.pem"
        cmci_key: "./sec/ansible.key"
-       context: "plex_or_applid"
+       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:
@@ -394,7 +394,8 @@ Examples
        cmci_port: 12345
        cmci_cert: "./sec/ansible.pem"
        cmci_key: "./sec/ansible.key"
-       context: "plex_or_applid"
+       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:
@@ -411,7 +412,7 @@ Examples
        cmci_port: 12345
        cmci_cert: "./sec/ansible.pem"
        cmci_key: "./sec/ansible.key"
-       context: "plex_or_applid"
+       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:

docs/source/modules/cmci_update.rst

@@ -361,13 +361,14 @@ Examples
      cmci_update:
        cmci_host: "example.com"
        cmci_port: "12345"
-       context: "plex_or_applid"
+       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"
        attributes:
          description: "New description"
        update_parameters:
          - name: csd
-       resource:
+       resources:
          filter:
            name: "PONGALT"
          get_parameters:

plugins/modules/cmci_action.py

@@ -71,29 +71,27 @@
   cmci_action:
     cmci_host: "example.com"
     cmci_port: 12345
-    context: "plex_or_applid"
-    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: "12345"
-    context: "plex_or_applid"
+    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: install
-    resource:
+    action_name: CSDINSTALL
+    resources:
       filter:
-        name: "PONGALT"
-    action_parameters:
-      - name: "usage"
-        value: "local"
+        name: mybund
+      get_parameters:
+        - name: csdgroup
+          value: mygrp
 """
 
 

plugins/modules/cmci_create.py

@@ -57,18 +57,19 @@
 
 
 EXAMPLES = r"""
-- name: define a BUNDLE in a CSD
+- name: Define a BUNDLE in CSD
   cmci_create:
     cmci_host: "example.com"
     cmci_port: 12345
-    context: "plex_or_applid"
-    type: "CICSDefinitionBundle"
+    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
 """
 
 

plugins/modules/cmci_delete.py

@@ -36,24 +36,25 @@
   cmci_delete:
     cmci_host: "example.com"
     cmci_port: 12345
-    context: "plex_or_applid"
+    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
-    resource:
+    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: "plex_or_applid"
+    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
-    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
 """
 
 

plugins/modules/cmci_get.py

@@ -54,40 +54,40 @@
 
 
 EXAMPLES = r"""
-- 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: "plex_or_applid"
+    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: "plex_or_applid"
-    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: "plex_or_applid"
+    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:
@@ -97,13 +97,14 @@
           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: "plex_or_applid"
+    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:
@@ -112,16 +113,16 @@
         - 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: "plex_or_applid"
-    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:

plugins/modules/cmci_update.py

@@ -58,19 +58,20 @@
 
 
 EXAMPLES = r"""
-- name: update a bundle definition in a CICS region
+- name: Update the description of a bundle definition in CSD
   cmci_update:
     cmci_host: "example.com"
-    cmci_port: "12345"
-    context: "plex_or_applid"
-    type: "CICSDefinitionBundle"
+    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
+    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
     attributes:
-      description: "New description"
+      description: New description
     update_parameters:
       - name: csd
-    resource:
+    resources:
       filter:
-        name: "PONGALT"
+        name: PONGALT
       get_parameters:
         - name: csdgroup
           value: JVMGRP