fix nxos_pim module doc (ansible#36505)

* fix nxos_pim module doc Signed-off-by: Trishna Guha <[email protected]> * address review
mgu · Feb 21, 2018 · 9598978 · 9598978
1 parent 52f2057
commit 9598978
Showing 1 changed file with 17 additions and 5 deletions.
diff --git a/lib/ansible/modules/network/nxos/nxos_pim.py b/lib/ansible/modules/network/nxos/nxos_pim.py
@@ -34,21 +34,33 @@
   ssm_range:
     description:
       - Configure group ranges for Source Specific Multicast (SSM).
-        Valid values are multicast addresses or the keyword 'none'
-        or keyword 'default'
+        Valid values are multicast addresses or the keyword C(none)
+        or keyword C(default). C(none) removes all SSM group ranges.
+        C(default) will set ssm_range to the default multicast address.
+        If you set multicast address, please ensure that it is not the
+        same as the C(default), otherwise use the C(default) option.
     required: true
 '''
 EXAMPLES = '''
-- nxos_pim:
-    ssm_range: "232.0.0.0/8"
+- name: Configure ssm_range
+  nxos_pim:
+    ssm_range: "224.0.0.0/8"
+
+- name: Set to default
+  nxos_pim:
+    ssm_range: default
+
+- name: Remove all ssm group ranges
+  nxos_pim:
+    ssm_range: none
 '''
 
 RETURN = '''
 commands:
     description: commands sent to the device
     returned: always
     type: list
-    sample: ["ip pim ssm range 232.0.0.0/8"]
+    sample: ["ip pim ssm range 224.0.0.0/8"]
 '''