ec2_group: update documentation for specifying port ranges (#436)

ec2_group: update documentation for specifying port ranges Depends-on: #429 SUMMARY Added missing part of documentation for specifying port ranges as -1 value in parameter from_port and to_port is only supported for proto:icmp. Fixes #397 ISSUE TYPE Docs Pull Request COMPONENT NAME ec2_group Reviewed-by: Jill R <None> Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None> Reviewed-by: Mark Chappell <None> Reviewed-by: None <None>
ansible-collections · Aug 9, 2021 · c060264 · c060264
1 parent 6cf75c3
commit c060264
Showing 1 changed file with 17 additions and 5 deletions.
diff --git a/plugins/modules/ec2_group.py b/plugins/modules/ec2_group.py
@@ -95,10 +95,16 @@
             - The IP protocol name (C(tcp), C(udp), C(icmp), C(icmpv6)) or number (U(https://en.wikipedia.org/wiki/List_of_IP_protocol_numbers))
         from_port:
             type: int
-            description: The start of the range of ports that traffic is coming from.  A value of C(-1) indicates all ports.
+            description:
+            - The start of the range of ports that traffic is coming from.
+            - A value can be between C(0) to C(65535).
+            - A value of C(-1) indicates all ports (only supported when I(proto=icmp)).
         to_port:
             type: int
-            description: The end of the range of ports that traffic is coming from.  A value of C(-1) indicates all ports.
+            description:
+            - The end of the range of ports that traffic is coming from.
+            - A value can be between C(0) to C(65535).
+            - A value of C(-1) indicates all ports (only supported when I(proto=icmp)).
         rule_desc:
             type: str
             description: A description for the rule.
@@ -156,10 +162,16 @@
             - The IP protocol name (C(tcp), C(udp), C(icmp), C(icmpv6)) or number (U(https://en.wikipedia.org/wiki/List_of_IP_protocol_numbers))
         from_port:
             type: int
-            description: The start of the range of ports that traffic is going to.  A value of C(-1) indicates all ports.
+            description:
+            - The start of the range of ports that traffic is going to.
+            - A value can be between C(0) to C(65535).
+            - A value of C(-1) indicates all ports (only supported when I(proto=icmp)).
         to_port:
             type: int
-            description: The end of the range of ports that traffic is going to.  A value of C(-1) indicates all ports.
+            description:
+            - The end of the range of ports that traffic is going to.
+            - A value can be between C(0) to C(65535).
+            - A value of C(-1) indicates all ports (only supported when I(proto=icmp)).
         rule_desc:
             type: str
             description: A description for the rule.
@@ -269,7 +281,7 @@
         # the containing group name may be specified here
         group_name: example
       - proto: all
-        # in the 'proto' attribute, if you specify -1, all, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6),
+        # in the 'proto' attribute, if you specify -1 (only supported when I(proto=icmp)), all, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6),
         # traffic on all ports is allowed, regardless of any ports you specify
         from_port: 10050 # this value is ignored
         to_port: 10050 # this value is ignored