Skip to content

Commit 9782358

Browse files
Missed a few long lines
Signed-off-by: Stew Francis <[email protected]>
1 parent deb112b commit 9782358

File tree

1 file changed

+80
-52
lines changed

1 file changed

+80
-52
lines changed

plugins/doc_fragments/cmci.py

Lines changed: 80 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -26,27 +26,30 @@ class ModuleDocFragment(object):
2626
- The user ID under which the CMCI request will run.
2727
- Can also be specified using the environment variable CMCI_USER.
2828
- 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
3132
provided.
3233
type: str
3334
cmci_password:
3435
description:
3536
- The password of I(cmci_user) to pass HTTP basic authentication.
3637
- Can also be specified using the environment variable CMCI_PASSWORD.
3738
- 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.
4143
type: str
4244
cmci_cert:
4345
description:
4446
- Location of the PEM-formatted certificate chain file to be used for
4547
HTTPS client authentication.
4648
- Can also be specified using the environment variable CMCI_CERT.
4749
- 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
5053
provided.
5154
required: false
5255
type: str
@@ -56,8 +59,9 @@ class ModuleDocFragment(object):
5659
for HTTPS client authentication.
5760
- Can also be specified using the environment variable CMCI_KEY.
5861
- 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
6165
provided.
6266
required: false
6367
type: str
@@ -66,8 +70,9 @@ class ModuleDocFragment(object):
6670
- If CMCI is installed in a CICSPlex® SM environment, I(context) is the
6771
name of the CICSplex or CMAS associated with the request, for example,
6872
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,
7176
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGRAMtab.html),
7277
CMAS context is not supported for PROGRAM.
7378
- If CMCI is installed in a single region (SMSS), I(context) is the
@@ -84,24 +89,28 @@ class ModuleDocFragment(object):
8489
CICS systems or resources.
8590
- I(scope) is optional. If it's not specified, the request is limited by
8691
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.
8894
type: str
8995
type:
9096
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.
9299
For a list of CMCI external resource names, see L(CMCI resource names,
93100
https://www.ibm.com/support/knowledgecenter/SSGMCP_5.6.0/reference-system-programming/cmci/clientapi_resources.html).
94101
type: str
95102
required: true
96103
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.
98106
type: str
99107
choices:
100108
- http
101109
- https
102110
default: https
103111
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.
105114
type: bool
106115
required: false
107116
default: false
@@ -117,64 +126,80 @@ class ModuleDocFragment(object):
117126
suboptions:
118127
filter:
119128
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.
122132
- 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.
129142
- For examples, see M(cmci_get)
130143
- For more details, see L(How to build a filter expression,
131144
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,
134148
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
135149
type: dict
136150
required: false
137151
complex_filter:
138152
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.
145163
- 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.
148167
- For examples, see M(cmci_get)
149168
type: dict
150169
required: false
151170
suboptions:
152171
and:
153172
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.
157178
type: list
158179
required: false
159180
or:
160181
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.
164187
type: list
165188
required: false
166189
attribute:
167190
description:
168191
- 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,
171195
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
172196
type: str
173197
required: false
174198
operator:
175199
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),
178203
C(==) or C(IS) (is), C(¬=), C(!=), or C(NE) (not equal to).
179204
type: str
180205
required: false
@@ -198,17 +223,20 @@ class ModuleDocFragment(object):
198223
value:
199224
description:
200225
- 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,
203229
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
204230
required: false
205231
get_parameters:
206232
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,
212240
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
213241
type: list
214242
suboptions:
@@ -227,8 +255,8 @@ class ModuleDocFragment(object):
227255
options:
228256
attributes:
229257
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
232260
target resource type, for example, L(PROGDEF resource table reference,
233261
https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.6.0/reference-cpsm-restables/cpsm-restables/PROGDEFtab.html).
234262
type: dict

0 commit comments

Comments
 (0)