Merge pull request #4 from ansible-network/bt_example_n_return_to_doc

Bt example n return to doc

Author: Bradley A. Thornton

models/myos/interfaces/deleted_example_01.txt

@@ -0,0 +1,10 @@
+
+# Using deleted
+
+<placeholder for the configuration example prior to module invocation>
+
+- name: Configure interfaces
+  myos_interfaces:
+    operation: deleted
+
+<placeholder for the configuration example after module invocation>

models/myos/interfaces/merge_example_01.yml

@@ -0,0 +1,17 @@
+
+# Using merged
+
+<placeholder for the configuration example prior to module invocation>
+
+- name: Configure interfaces
+  nxos_interfaces:
+    config:
+      - name: Ethernet1/1
+        description: 'Configured by Ansible'
+        enable: True
+      - name: Ethernet1/2
+        description: 'Configured by Ansible'
+        enable: False
+    operation: merged
+
+<placeholder for the configuration example after module invocation>

models/myos/interfaces/merged_example_01.txt

@@ -17,7 +17,6 @@ info:
   extends_documentation_fragment: myos
   notes:
     - Tested against <network_os> <version>
-
 schema:
   type: object
   description: The schema used for the argspec and docstring
@@ -83,10 +82,11 @@ definitions:
     enum:
     - merged
     - replaced
-    - overriden
+    - overridden
     - deleted
     default: merged
-
-
-  examples:
-  - merge_example_01.yml
+examples:
+- merged_example_01.txt
+- replaced_example_01.txt
+- overridden_example_01.txt
+- deleted_example_01.txt

models/myos/interfaces/myos_interfaces.yml

@@ -0,0 +1,17 @@
+
+# Using overridden
+
+<placeholder for the configuration example prior to module invocation>
+
+- name: Configure interfaces
+  myos_interfaces:
+    config:
+      - name: Ethernet1/1
+        description: 'Configured by Ansible'
+        enable: True
+      - name: Ethernet1/2
+        description: 'Configured by Ansible'
+        enable: False
+    operation: overridden
+
+<placeholder for the configuration example after module invocation>

models/myos/interfaces/overridden_example_01.txt

@@ -0,0 +1,17 @@
+
+# Using replaced
+
+<placeholder for the configuration example prior to module invocation>
+
+- name: Configure interfaces
+  nxos_interfaces:
+    config:
+      - name: Ethernet1/1
+        description: 'Configured by Ansible'
+        enable: True
+      - name: Ethernet1/2
+        description: 'Configured by Ansible'
+        enable: False
+    operation: replaced
+
+<placeholder for the configuration example after module invocation>

models/myos/interfaces/replaced_example_01.txt

@@ -27,20 +27,26 @@ author: {{ rm['info']['authors'] }}
 """
 
 EXAMPLES = """
-- name: Configure interfaces
-  nxos_interfaces:
-    config:
-      - name: Ethernet1/1
-        description: 'Configured by Ansible'
-        enable: True
-      - name: Ethernet1/2
-        description: 'Configured by Ansible'
-        enable: False
-    operation: merge
-
+---
+{% for example in rm['examples'] %}
+{{ lookup('file', model|dirname + '/' +example) }}
+{% endfor %}
 """
 
 RETURN = """
+before:
+  description: The configuration prior to the model invocation
+  returned: always
+  sample: The configuration returned will alwys be in the same format of the paramters above.
+after:
+  description: The resulting configuration model invocation
+  returned: when changed
+  sample: The configuration returned will alwys be in the same format of the paramters above.
+commands:
+  description: The set of commands pushed to the remote device
+  returned: always
+  type: list
+  sample: ['command 1', 'command 2', 'command 3']
 """