updated save_running_config example

Author: danielgraziano

save_running_config_to_file/README.md

@@ -1,8 +1,27 @@
+## Important Information
+Minimum version requirements:
+
+    - v20.8 pyATS
+    - v20.8 Genie
+    - v20.8.3b0 genie.libs.sdk
+    - v20.8.2b2 genie.libs.clean
+    
+If the versions of your packages do not meet the above minimums, upgrade using the steps below:
+
+    # First upgrade the pyats installation to 20.8
+    pip install --upgrade pyats[full]
+    
+    # Next upgrade genie.libs.sdk and genie.libs.clean to the beta
+    pip install --upgrade --pre genie.libs.sdk genie.libs.clean
+
+
 ## Getting Started
 1. Clone this repository into `<path/to/pyATS>/`
 
 2. Create a [testbed datafile](https://pubhub.devnetcloud.com/media/pyats/docs/topology/schema.html#production-yaml-schema) 
-that contains devices in which a backup is required.
+that contains devices in which a backup is required. 
+
+    **note:** One device must have the alias 'uut' (does not matter which one).
 
 3. Run the script which will, connect to all devices in the testbed datafile, gather the running configurations, 
 and save that to a file named `<path/to/pyATS>/solutions_examples/save_running_config_to_file/config_backup_<dev_name>.txt`
@@ -12,8 +31,10 @@ and save that to a file named `<path/to/pyATS>/solutions_examples/save_running_c
         
         # Execute the script
         pyats run job job.py --testbed-file <path/to/testbed.yaml>
+        
+    **note**: For this example only ios, iosxe, iosxr, and nxos device are supported. Any other devices will be skipped.
 
-4. If everything worked as expected the report at the end should be `PASSED` for every step:
+4. If everything worked as expected, the report at the end should be `PASSED` for every step:
 
         2020-09-03T10:25:21: %EASYPY-INFO: +------------------------------------------------------------------------------+
         2020-09-03T10:25:21: %EASYPY-INFO: |                             Task Result Details                              |
@@ -35,7 +56,31 @@ and save that to a file named `<path/to/pyATS>/solutions_examples/save_running_c
 Now we have a text file containing a backup of the running configuration from all devices defined in the testbed datafile. 
 One idea is using [pyATS Clean](https://pubhub.devnetcloud.com/media/genie-docs/docs/clean/index.html) 
 to restore our configurations on a later date. This can be helpful if your network was working one day and not another. 
-Simply replace to current configs with the backed up configs!
+Simply replace the current configs with the backed up configs!
+
+1. Edit the `clean.yaml` template provided in `<path/to/pyATS>/solutions_examples/save_running_config_to_file/datafiles` 
+to include your devices and the path to the config_backup_<dev_name>.txt file. You can add as many devices that are in your testbed file.
+
+2. Run clean to restore your configs.
+    
+        # Navigate to cloned repository
+        cd <path/to/pyATS>/solutions_examples/save_running_config_to_file
+        
+        # Run clean
+        kleenex -testbed_file <path/to/testbed.yaml> -clean_file datafiles/clean.yaml
+        
+3. If everything worked successfully the report at the end should be `Passed` for every step:
+
+        2020-09-05T08:18:10: %AETEST-INFO: +----------------------------------------------------------+
+        2020-09-05T08:18:10: %AETEST-INFO: |                       STEPS Report                       |
+        2020-09-05T08:18:10: %AETEST-INFO: +----------------------------------------------------------+
+        2020-09-05T08:18:10: %AETEST-INFO: STEP 1 - Apply configuration to device <dev> after reload    Passed
+        2020-09-05T08:18:10: %AETEST-INFO: STEP 2 - Copy running-config to startup-config on device <dev>    Passed
+        2020-09-05T08:18:10: %AETEST-INFO: STEP 3 - Allow configuration to stabilize on device <dev>    Passed
+        2020-09-05T08:18:10: %AETEST-INFO: ------------------------------------------------------------
+        2020-09-05T08:18:10: %AETEST-INFO: The result of section apply_configuration is => PASSED
+        2020-09-05T08:18:10: %KLEENEX-INFO: Finished cleaning device '<dev>' using 'DeviceClean'.
+        2020-09-05T08:18:11: %ROOT-INFO: Clean finished!
 
 [pyATS Clean](https://pubhub.devnetcloud.com/media/genie-docs/docs/clean/index.html) has many other features worth looking into.
 It can load new images onto various devices, recover devices from rommon prompt, and much much more.

save_running_config_to_file/datafiles/clean.yaml

@@ -0,0 +1,23 @@
+cleaners:
+  DeviceClean:
+    module: genie.libs.clean
+    # List of devices to clean goes here
+    devices: [<device_name>]
+
+devices:
+  # The device name
+  <device_name>:
+
+    # This is the connect stage
+    connect:
+
+    # This is the apply_configuration stage
+    apply_configuration:
+      configuration_from_file: </path/to/config_backup_<dev>.txt>
+      config_timeout: 120
+
+    # The order we want to run the stages in
+    order:    
+        - 'connect'
+        - 'apply_configuration'
+

save_running_config_to_file/triggers/triggers.py

@@ -29,12 +29,19 @@ def saving_config(self, steps, testbed, exclude_config_that_matches_regex):
                             "configuration.\nError: {}".format(str(e)))
 
             step.passed("Gathered the running configuration for: {}".format(
-                [name for name, _ in configurations]))
+                [name for name, config in configurations if isinstance(config, str)]))
 
         with steps.start("Saving all running configurations that were "
                          "gathered"):
 
             for dev, config in configurations:
+
+                # Skip any devices where the api to gather the running
+                # config does not exist
+                if isinstance(config, AttributeError):
+                    log.warning(config)
+                    continue
+
                 filename = 'config_backup_{}.txt'.format(dev)
 
                 with open(filename, 'w') as f:
@@ -54,13 +61,21 @@ def get_config(dev, exclude):
 
             Returns:
                 (device name ('str'), configuration ('str'))
+
+                if api not found:
+                (device name ('str'), exception ('exception'))
         """
 
         exclude = exclude.get(dev.os)
 
         log.info("The following regex is used to exclude lines of "
                  "configuration for '{}' devices: {}"
                  .format(dev.os, exclude))
+        try:
+            out = dev.api.get_valid_config_from_running_config(exclude=exclude)
+        except AttributeError:
+            return dev.name, AttributeError("Cannot get the config from '{}'. "
+                                            "The API is not developed for '{}'"
+                                            .format(dev.name, dev.os))
 
-        out = dev.api.get_valid_config_from_running_config(exclude=exclude)
         return dev.name, out