Merge pull request #4798 from gundalow/docs_backup

Document `backup` option in eos_config and nxos_config

network/eos/eos_config.py

@@ -111,6 +111,17 @@ options:
     required: false
     default: false
     choices: ['yes', 'no']
+  backup:
+    description:
+      - This argument will cause the module to create a full backup of
+        the current C(running-config) from the remote device before any
+        changes are made.  The backup file is written to the C(backup)
+        folder in the playbook root directory.  If the directory does not
+        exist, it is created.
+    required: false
+    default: no
+    choices: ['yes', 'no']
+    version_added: "2.2"
   config:
     description:
       - The module, by default, will connect to the remote device and
@@ -273,11 +284,11 @@ def main():
     """ main entry point for module execution
     """
     argument_spec = dict(
+        src=dict(type='path'),
+
         lines=dict(aliases=['commands'], type='list'),
         parents=dict(type='list'),
 
-        src=dict(type='path'),
-
         before=dict(type='list'),
         after=dict(type='list'),
 
@@ -288,11 +299,10 @@ def main():
         # it will be removed in a future version
         force=dict(default=False, type='bool'),
 
-        backup=dict(type='bool', default=False),
-
         config=dict(),
         defaults=dict(type='bool', default=False),
 
+        backup=dict(type='bool', default=False),
         save=dict(default=False, type='bool'),
     )
 

network/ios/ios_config.py

@@ -322,8 +322,8 @@ def main():
         config=dict(),
         defaults=dict(type='bool', default=False),
 
-        save=dict(type='bool', default=False),
         backup=dict(type='bool', default=False),
+        save=dict(default=False, type='bool'),
     )
 
     mutually_exclusive = [('lines', 'src')]

network/nxos/nxos_config.py

@@ -111,6 +111,17 @@ options:
     required: false
     default: false
     choices: [ "true", "false" ]
+  backup:
+    description:
+      - This argument will cause the module to create a full backup of
+        the current C(running-config) from the remote device before any
+        changes are made.  The backup file is written to the C(backup)
+        folder in the playbook root directory.  If the directory does not
+        exist, it is created.
+    required: false
+    default: no
+    choices: ['yes', 'no']
+    version_added: "2.2"
   config:
     description:
       - The module, by default, will connect to the remote device and
@@ -145,7 +156,6 @@ options:
     version_added: "2.2"
 """
 
-
 EXAMPLES = """
 # Note: examples below use the following provider dict to handle
 #       transport and authentication to the node.