@@ -26,27 +26,30 @@ class ModuleDocFragment(object):
26
26
- The user ID under which the CMCI request will run.
27
27
- Can also be specified using the environment variable CMCI_USER.
28
28
- Required if I(cmci_password) is specified.
29
- - Authentication prioritises certificate authentication if I(cmci_cert) and I(cmci_key) are provided, then
30
- basic authentication if I(cmci_user) and (cmci_password) are provided, and then unauthenticated if none is
29
+ - Authentication prioritises certificate authentication if I(cmci_cert)
30
+ and I(cmci_key) are provided, then basic authentication if I(cmci_user)
31
+ and (cmci_password) are provided, and then unauthenticated if none is
31
32
provided.
32
33
type: str
33
34
cmci_password:
34
35
description:
35
36
- The password of I(cmci_user) to pass HTTP basic authentication.
36
37
- Can also be specified using the environment variable CMCI_PASSWORD.
37
38
- Required if I(cmci_user) is specified.
38
- - Authentication prioritises certificate authentication if I(cmci_cert) and I(cmci_key) are provided, then
39
- basic authentication if I(cmci_user) and (cmci_password) are provided, and then unauthenticated if none is
40
- provided.
39
+ - Authentication prioritises certificate authentication if I(cmci_cert)
40
+ and I(cmci_key) are provided, then
41
+ basic authentication if I(cmci_user) and (cmci_password) are provided,
42
+ and then unauthenticated if none is provided.
41
43
type: str
42
44
cmci_cert:
43
45
description:
44
46
- Location of the PEM-formatted certificate chain file to be used for
45
47
HTTPS client authentication.
46
48
- Can also be specified using the environment variable CMCI_CERT.
47
49
- Required if I(cmci_key) is specified.
48
- - Authentication prioritises certificate authentication if I(cmci_cert) and I(cmci_key) are provided, then
49
- basic authentication if I(cmci_user) and (cmci_password) are provided, and then unauthenticated if none is
50
+ - Authentication prioritises certificate authentication if I(cmci_cert)
51
+ and I(cmci_key) are provided, then basic authentication if I(cmci_user)
52
+ and (cmci_password) are provided, and then unauthenticated if none is
50
53
provided.
51
54
required: false
52
55
type: str
@@ -56,8 +59,9 @@ class ModuleDocFragment(object):
56
59
for HTTPS client authentication.
57
60
- Can also be specified using the environment variable CMCI_KEY.
58
61
- Required if I(cmci_cert) is specified.
59
- - Authentication prioritises certificate authentication if I(cmci_cert) and I(cmci_key) are provided, then
60
- basic authentication if I(cmci_user) and (cmci_password) are provided, and then unauthenticated if none is
62
+ - Authentication prioritises certificate authentication if I(cmci_cert)
63
+ and I(cmci_key) are provided, then basic authentication if I(cmci_user)
64
+ and (cmci_password) are provided, and then unauthenticated if none is
61
65
provided.
62
66
required: false
63
67
type: str
@@ -66,8 +70,9 @@ class ModuleDocFragment(object):
66
70
- If CMCI is installed in a CICSPlex® SM environment, I(context) is the
67
71
name of the CICSplex or CMAS associated with the request, for example,
68
72
C(PLEX1). To determine whether a CMAS can be specified as I(context),
69
- see the B(CMAS context) entry in the CICSPlex SM resource table reference of a resource.
70
- For example, according to the L(PROGRAM resource table,
73
+ see the B(CMAS context) entry in the CICSPlex SM resource table
74
+ reference of a resource. For example, according to the
75
+ L(PROGRAM resource table,
71
76
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGRAMtab.html),
72
77
CMAS context is not supported for PROGRAM.
73
78
- If CMCI is installed in a single region (SMSS), I(context) is the
@@ -84,24 +89,28 @@ class ModuleDocFragment(object):
84
89
CICS systems or resources.
85
90
- I(scope) is optional. If it's not specified, the request is limited by
86
91
the value of I(context) alone.
87
- - The value of I(scope) must contain no spaces. I(scope) is not case-sensitive.
92
+ - The value of I(scope) must contain no spaces. I(scope) is not
93
+ case-sensitive.
88
94
type: str
89
95
type:
90
96
description:
91
- - The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type.
97
+ - The CMCI external resource name that maps to the target CICS or CICSPlex
98
+ SM resource type.
92
99
For a list of CMCI external resource names, see L(CMCI resource names,
93
100
https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/reference-system-programming/cmci/clientapi_resources.html).
94
101
type: str
95
102
required: true
96
103
scheme:
97
- description: The HTTP scheme to use when establishing a connection to the CMCI REST API.
104
+ description: The HTTP scheme to use when establishing a connection to the
105
+ CMCI REST API.
98
106
type: str
99
107
choices:
100
108
- http
101
109
- https
102
110
default: https
103
111
insecure:
104
- description: When set to C(true), disables SSL certificate trust chain verification when using HTTPS.
112
+ description: When set to C(true), disables SSL certificate trust chain
113
+ verification when using HTTPS.
105
114
type: bool
106
115
required: false
107
116
default: false
@@ -117,64 +126,80 @@ class ModuleDocFragment(object):
117
126
suboptions:
118
127
filter:
119
128
description:
120
- - A dictionary with attribute names as keys, and target values, to be used as criteria to filter the set of
121
- resources returned from CICSPlex SM.
129
+ - A dictionary with attribute names as keys, and target values, to be
130
+ used as criteria to filter the set of resources returned from
131
+ CICSPlex SM.
122
132
- Filters implicitly use the C(=) operator
123
- - Filters for C(string) type attributes can use the C(*) and C(+) wildcard operators
124
- - C(*) is a wildcard representing an unknown number of characters, and must appear at the end of the value
125
- - C(+) is a wildcard representing a single character, and can appear in any place in the value, potentially
126
- multiple times.
127
- - To use more complicated filter expressions, including a range of different filter operators, and the ability
128
- to compose filters with C(and) and C(or) operators, see the C(complex_filter) parameter.
133
+ - Filters for C(string) type attributes can use the C(*) and C(+)
134
+ wildcard operators
135
+ - C(*) is a wildcard representing an unknown number of characters, and
136
+ must appear at the end of the value
137
+ - C(+) is a wildcard representing a single character, and can appear
138
+ in any place in the value, potentially multiple times.
139
+ - To use more complicated filter expressions, including a range of
140
+ different filter operators, and the ability to compose filters with
141
+ C(and) and C(or) operators, see the C(complex_filter) parameter.
129
142
- For examples, see M(cmci_get)
130
143
- For more details, see L(How to build a filter expression,
131
144
https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/system-programming/cpsm/eyup1a0.html).
132
- - For supported attributes of different resource types, see their resource table reference,
133
- for example, L(PROGDEF resource table reference,
145
+ - For supported attributes of different resource types, see their
146
+ resource table reference, for example,
147
+ L(PROGDEF resource table reference,
134
148
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
135
149
type: dict
136
150
required: false
137
151
complex_filter:
138
152
description:
139
- - A dictionary representing a complex filter expression. Complex filters are composed of filter expressions,
140
- represented as dictionaries.
141
- Each dictionary can specify either an attribute expression, a list of filter expressions to be
142
- composed with the C(and) operator, or a list of filter expressions to be composed with the C(or) operator.
143
- - The C(attribute), C(and) and C(or) options are mutually exclusive with each other.
144
- - Can contain one or more filters. Multiple filters must be combined using C(and) or C(or) logical operators.
153
+ - A dictionary representing a complex filter expression. Complex
154
+ filters are composed of filter expressions, represented as
155
+ dictionaries. Each dictionary can specify either an attribute
156
+ expression, a list of filter expressions to be composed with the
157
+ C(and) operator, or a list of filter expressions to be composed with
158
+ the C(or) operator.
159
+ - The C(attribute), C(and) and C(or) options are mutually exclusive
160
+ with each other.
161
+ - Can contain one or more filters. Multiple filters must be combined
162
+ using C(and) or C(or) logical operators.
145
163
- Filters can be nested. At most four nesting layers are allowed.
146
- - When supplying the C(attribute) option, you must also supply a C(value) for the filter. You can also
147
- override the default operator with the C(=) option.
164
+ - When supplying the C(attribute) option, you must also supply a
165
+ C(value) for the filter. You can also override the default operator
166
+ with the C(=) option.
148
167
- For examples, see M(cmci_get)
149
168
type: dict
150
169
required: false
151
170
suboptions:
152
171
and:
153
172
description:
154
- - A list of filter expressions to be combined with an C(and) operation.
155
- - Filter expressions are nested C(complex_filter) elements. Each nested filter expression can be either
156
- an C(attribute), C(and) or C(or) complex filter expression.
173
+ - A list of filter expressions to be combined with an C(and)
174
+ operation.
175
+ - Filter expressions are nested C(complex_filter) elements. Each
176
+ nested filter expression can be either an C(attribute), C(and)
177
+ or C(or) complex filter expression.
157
178
type: list
158
179
required: false
159
180
or:
160
181
description:
161
- - A list of filter expressions to be combined with an C(or) operation.
162
- - Filter expressions are nested C(complex_filter) elements. Each nested filter expression can be either
163
- an C(attribute), C(and) or C(or) complex filter expression.
182
+ - A list of filter expressions to be combined with an C(or)
183
+ operation.
184
+ - Filter expressions are nested C(complex_filter) elements. Each
185
+ nested filter expression can be either an C(attribute), C(and)
186
+ or C(or) complex filter expression.
164
187
type: list
165
188
required: false
166
189
attribute:
167
190
description:
168
191
- The name of a resource table attribute on which to filter.
169
- - For supported attributes of different resource types, see their resource table reference,
170
- for example, L(PROGDEF resource table reference,
192
+ - For supported attributes of different resource types, see their
193
+ resource table reference, for example, L(PROGDEF resource table
194
+ reference,
171
195
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
172
196
type: str
173
197
required: false
174
198
operator:
175
199
description: >
176
- These operators are accepted: C(<) or C(LT) (less than), C(<=) or C(LE) (less than or equal to),
177
- C(=) or C(EQ) (equal to), C(>) or C(GT) (greater than), C(>=) or C(GE) (greater than or equal to),
200
+ These operators are accepted: C(<) or C(LT) (less than), C(<=) or
201
+ C(LE) (less than or equal to), C(=) or C(EQ) (equal to), C(>) or
202
+ C(GT) (greater than), C(>=) or C(GE) (greater than or equal to),
178
203
C(==) or C(IS) (is), C(¬=), C(!=), or C(NE) (not equal to).
179
204
type: str
180
205
required: false
@@ -198,17 +223,20 @@ class ModuleDocFragment(object):
198
223
value:
199
224
description:
200
225
- The value by which you are to filter the resource attributes.
201
- - The value must be a valid one for the resource table attribute as documented in the
202
- resource table reference, for example, L(PROGDEF resource table reference,
226
+ - The value must be a valid one for the resource table attribute
227
+ as documented in the resource table reference, for example,
228
+ L(PROGDEF resource table reference,
203
229
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
204
230
required: false
205
231
get_parameters:
206
232
description: >
207
- A list of one or more parameters with optional values used to identify the resources for this request.
208
- Eligible parameters for identifying the target resources can be found in the resource table reference for the
209
- target resource type, as valid parameters for the GET operation in the "Valid CPSM operations" table.
210
- For example, the valid parameters for identifying a PROGDEF resource are
211
- CICSSYS, CSDGROUP and RESGROUP, as found in the L(PROGDEF resource table reference,
233
+ A list of one or more parameters with optional values used to identify
234
+ the resources for this request. Eligible parameters for identifying
235
+ the target resources can be found in the resource table reference for
236
+ the target resource type, as valid parameters for the GET operation in
237
+ the "Valid CPSM operations" table. For example, the valid parameters
238
+ for identifying a PROGDEF resource are CICSSYS, CSDGROUP and RESGROUP,
239
+ as found in the L(PROGDEF resource table reference,
212
240
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
213
241
type: list
214
242
suboptions:
@@ -227,8 +255,8 @@ class ModuleDocFragment(object):
227
255
options:
228
256
attributes:
229
257
description:
230
- - The resource attributes to be created or updated.
231
- Available attributes can be found in the CICSPlex® SM resource table reference for the
258
+ - The resource attributes to be created or updated. Available attributes
259
+ can be found in the CICSPlex® SM resource table reference for the
232
260
target resource type, for example, L(PROGDEF resource table reference,
233
261
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
234
262
type: dict
0 commit comments