added better description on how aggregate functions (#61069)

This commit is contained in:
Wojciech Wypior 2019-08-23 16:05:19 +01:00 committed by Tim Rupp
parent 11ba2a965d
commit a275bf1625
3 changed files with 20 additions and 2 deletions

View file

@ -91,6 +91,11 @@ options:
aggregate:
description:
- List of GTM pool member definitions to be created, modified or removed.
- When using C(aggregates) if one of the aggregate definitions is invalid, the aggregate run will fail,
indicating the error it last encountered.
- The module will C(NOT) rollback any changes it has made prior to encountering the error.
- The module also will not indicate what changes were made prior to failure, therefore it is strongly advised
to run the module in check mode to make basic validation, prior to module execution.
type: list
aliases:
- members

View file

@ -162,6 +162,11 @@ options:
aggregate:
description:
- List of pool definitions to be created, modified or removed.
- When using C(aggregates) if one of the aggregate definitions is invalid, the aggregate run will fail,
indicating the error it last encountered.
- The module will C(NOT) rollback any changes it has made prior to encountering the error.
- The module also will not indicate what changes were made prior to failure, therefore it is strongly advised
to run the module in check mode to make basic validation, prior to module execution.
type: list
aliases:
- pools

View file

@ -188,6 +188,11 @@ options:
aggregate:
description:
- List of pool member definitions to be created, modified or removed.
- When using C(aggregates) if one of the aggregate definitions is invalid, the aggregate run will fail,
indicating the error it last encountered.
- The module will C(NOT) rollback any changes it has made prior to encountering the error.
- The module also will not indicate what changes were made prior to failure, therefore it is strongly advised
to run the module in check mode to make basic validation, prior to module execution.
type: list
aliases:
- members
@ -202,6 +207,9 @@ options:
aliases:
- purge
version_added: 2.8
notes:
- In previous versions of this module, which used the SDK, the C(name) parameter would act as C(fqdn) if C(address) or
C(fqdn) were not provided.
extends_documentation_fragment: f5
author:
- Tim Rupp (@caphrim007)
@ -548,7 +556,7 @@ class ModuleParameters(Parameters):
return result
if not is_valid_hostname(self._values['fqdn']):
raise F5ModuleError(
"The specified 'fqdn' is not a valid hostname."
"The specified 'fqdn' value of: {0} is not a valid hostname.".format(self._values['fqdn'])
)
result['tmName'] = self._values['fqdn']
return result
@ -579,7 +587,7 @@ class ModuleParameters(Parameters):
if is_valid_ip(address):
return self._values['address']
raise F5ModuleError(
"The specified 'address' value is not a valid IP address."
"The specified 'address' value of: {0} is not a valid IP address.".format(address)
)
@property