added better description on how aggregate functions (ansible#61069)

adharshsrivatsr · Sep 3, 2019 · 893ffb0 · 893ffb0
1 parent a527032
commit 893ffb0
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/lib/ansible/modules/network/f5/bigip_gtm_pool_member.py b/lib/ansible/modules/network/f5/bigip_gtm_pool_member.py
@@ -91,6 +91,11 @@
   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

diff --git a/lib/ansible/modules/network/f5/bigip_pool.py b/lib/ansible/modules/network/f5/bigip_pool.py
@@ -162,6 +162,11 @@
   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

diff --git a/lib/ansible/modules/network/f5/bigip_pool_member.py b/lib/ansible/modules/network/f5/bigip_pool_member.py
@@ -188,6 +188,11 @@
   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 @@
     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 @@ def fqdn(self):
             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 @@ def address(self):
         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