Add rescue function support

README.md

@@ -17,6 +17,7 @@ in this role.
 * get [[source]](https://github.com/ansible-network/config_manager/blob/devel/tasks/get.yaml) [[docs]](https://github.com/ansible-network/config_manager/blob/devel/docs/get.md)
 * load [[source]](https://github.com/ansible-network/config_manager/blob/devel/tasks/load.yaml) [[docs]](https://github.com/ansible-network/config_manager/blob/devel/docs/load.md)
 * save [[source]](https://github.com/ansible-network/config_manager/blob/devel/tasks/save.yaml) [[docs]](https://github.com/ansible-network/config_manager/blob/devel/docs/save.md)
+* rescue [[source]](https://github.com/ansible-network/config_manager/blob/devel/tasks/rescue.yaml) [[docs]](https://github.com/ansible-network/config_manager/blob/devel/docs/rescue.md)
 
 ## License
 

docs/load.md

@@ -10,7 +10,7 @@ section for different example of how to push configurations to network devices.
 
 ## How to use this function
 
-The examples below demonstate how to use this function in a playbook.
+The examples below demonstrate how to use this function in a playbook.
 
 ## How to load and merge a configuration
 

docs/rescue.md

@@ -0,0 +1,89 @@
+# Save and Load rescue configuration into device
+
+The `config_manager/rescue` function provides a means to save a know good running configuration
+as a rescue configuration and rollback the current device configuration to rescue configuration
+when required.
+
+The `rescue` function provides some configurable options when rescuing the
+configuration on the remote device.  See the `How to use this function`
+section for different example of how to rescue configuration on network devices.
+
+## How to use this function
+
+The examples below demonstrate how to use this function in a playbook.
+
+## How to save a rescue configuration checkpoint
+
+Below is an example of how to call the `config_manager/rescue` function to mark the
+current running configuration as rescue config.
+
+```
+- hosts: network
+
+  roles:
+    - name: ansible-network.config_manager
+      function: rescue
+      config_manager_set_rescue: True
+```
+
+### How to load the rescue configuration
+
+The `config_manager/rescue` function also provides support to rollback the current running
+configuration to a rescue configuration when required
+
+In order to load the resuce configuration, the function as before but adds the
+value `config_manager_load_rescue_config: yes` to the playbook to indicate that the configuration should
+be rollbacked to te the resuce configuration.
+
+Note: Take caution when doing rescue configuration load that you do not
+inadvertently replace your access to the device.
+
+```
+- hosts: network
+
+  roles:
+    - name: ansible-network.config_manager
+      function: rescue
+      config_manager_load_rescue_config: True
+```
+
+## How to delete a rescue configuration checkpoint
+
+Below is an example of how to call the `config_manager/rescue` function to delete the
+previously set rescue configuration.
+
+```
+- hosts: network
+
+  roles:
+    - name: ansible-network.config_manager
+      function: rescue
+      config_manager_delete_rescue: True
+```
+
+## Arguments
+
+### config_manager_set_rescue
+
+This setting indicates whether or not the to set the current running
+configuration as the rescue configuration.
+
+The default value is `False`
+
+### config_manager_load_rescue_config
+
+This setting indicates whether or not to replace the current configuration
+with the rescue configuration.
+
+The default value is `False`
+
+### config_manager_delete_rescue
+
+This setting indicates whether or not the to delete the rescue configuration
+checkpoint that is already set.
+
+The default value is `False`
+
+## Notes
+
+None

meta/rescue_spec.yaml

@@ -0,0 +1,31 @@
+---
+argument_spec:
+  ansible_network_provider:
+    description:
+      - This value is used to determine the correct role to implement the
+        load_config function.  The network device provider role is responsible
+        for performing the actual implementation of the load_config function.
+        The specified role must be installed and accesible via the configured
+        ansible_role_path setting.
+    required: True
+
+  config_manager_set_rescue:
+    descriptiion:
+      - This setting indicates whether or not the to set the current running
+        configuration as the rescue configuration.
+    type: bool
+    default: False
+
+  config_manager_delete_rescue:
+    descriptiion:
+      - This setting indicates whether or not the to delete the rescue configuration
+        checkpoint that is already set.
+    type: bool
+    default: False
+
+  config_manager_load_rescue_config:
+    descriptiion:
+      - This setting indicates whether or not to replace the current configuration
+        with the rescue configuration.
+    type: bool
+    default: False

tasks/main.yml

@@ -11,6 +11,7 @@
       - load
       - save
       - noop
+      - rescue
 
 - name: validate the requested function is supported
   fail:

tasks/rescue.yaml

@@ -0,0 +1,9 @@
+---
+- name: validate role spec
+  validate_role_spec:
+    spec: rescue_spec.yaml
+
+- name: invoke network provider
+  include_role:
+    name: "{{ ansible_network_provider }}"
+    tasks_from: config_manager/rescue