README.md
1# Ansible Role: cnos_rollback_sample - Rolls back the configuration of a switch from a remote server
2---
3<add role description below>
4
5This role is an example of using the *cnos_rollback.py* Lenovo module in the context of CNOS switch configuration.This module allows you to work with switch configurations. It provides a way to roll back configurations of a switch from a remote server. This is achieved by using startup or running configurations of the target device that were previously backed up to a remote server using FTP, SFTP, TFTP, or SCP.
6
7The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the backup configurations location. Authentication details required by the remote server must be provided as well.
8
9By default, this method overwrites the switch's configuration file with the newly downloaded file.
10
11The results of the operation can be viewed in *results* directory.
12
13For more details, see [Lenovo modules for Ansible: cnos_rollback](http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_rollback.html&cp=0_3_1_0_4_5).
14
15
16## Requirements
17---
18<add role requirements information below>
19
20- Ansible version 2.2 or later ([Ansible installation documentation](http://docs.ansible.com/ansible/intro_installation.html))
21- Lenovo switches running CNOS version 10.2.1.0 or later
22- an SSH connection to the Lenovo switch (SSH must be enabled on the network device)
23
24
25## Role Variables
26---
27<add role variables information below>
28
29Available variables are listed below, along with description.
30
31The following are mandatory inventory variables:
32
33Variable | Description
34--- | ---
35`ansible_connection` | Has to be `network_cli`
36`ansible_network_os` | Has to be `cnos`
37`ansible_ssh_user` | Specifies the username used to log into the switch
38`ansible_ssh_pass` | Specifies the password used to log into the switch
39`enablePassword` | Configures the password used to enter Global Configuration command mode on the switch (this is an optional parameter)
40`hostname` | Searches the hosts file at */usr/local/etc/ansible/hosts* and identifies the IP address of the switch on which the role is going to be applied
41`deviceType` | Specifies the type of device from where the configuration will be backed up (**g8272_cnos** - G8272, **g8296_cnos** - G8296, **g8332_cnos** - G8332, **NE10032** - NE10032, **NE1072T** - NE1072T, **NE1032** - NE1032, **NE1032T** - NE1032T, **NE2572** - NE2572, **NE0152T** - NE0152T)
42
43The values of the variables used need to be modified to fit the specific scenario in which you are deploying the solution. To change the values of the variables, you need to visits the *vars* directory of each role and edit the *main.yml* file located there. The values stored in this file will be used by Ansible when the template is executed.
44
45The syntax of *main.yml* file for variables is the following:
46
47```
48<template variable>:<value>
49```
50
51You will need to replace the `<value>` field with the value that suits your topology. The `<template variable>` fields are taken from the template and it is recommended that you leave them unchanged.
52
53Variable | Description
54--- | ---
55`configType` | Specifies the type of configuration which will be used for the rolling back process (**running-config** - running configuration, **startup-config** - startup configuration)
56`protocol` | Specifies the protocol used by the network device to interact with the remote server from where to download the backup configuration (**ftp** - FTP, **sftp** - SFTP, **tftp** - TFTP, **scp** - SCP)
57`serverip` | Specifies the IP Address of the remote server from where the backup configuration will be downloaded
58`rcpath` | Specifies the full file path where the configuration file located on the remote server (in case the relative path is used as the variable value, the root folder for the user of the server needs to be specified)
59`serverusername` | Configures the username for the server relating to the protocol used
60`serverpassword` | Configures the password for the server relating to the protocol used
61
62
63## Dependencies
64---
65<add dependencies information below>
66
67- username.iptables - Configures the firewall and blocks all ports except those needed for web server and SSH access.
68- username.common - Performs common server configuration.
69- cnos_rollback.py - This modules needs to be present in the *library* directory of the role.
70- cnos.py - This module needs to be present in the PYTHONPATH environment variable set in the Ansible system.
71- /usr/local/etc/ansible/hosts - You must edit the */usr/local/etc/ansible/hosts* file with the device information of the switches designated as leaf switches. You may refer to *cnos_rollback_sample_hosts* for a sample configuration.
72
73Ansible keeps track of all network elements that it manages through a hosts file. Before the execution of a playbook, the hosts file must be set up.
74
75Open the */usr/local/etc/ansible/hosts* file with root privileges. Most of the file is commented out by using **#**. You can also comment out the entries you will be adding by using **#**. You need to copy the content of the hosts file for the role into the */usr/local/etc/ansible/hosts* file. The sample hosts file for the role is located in the main directory.
76
77```
78[cnos_rollback_sample]
7910.241.107.39 ansible_network_os=cnos ansible_ssh_user=<username> ansible_ssh_pass=<password> deviceType=g8272_cnos
8010.241.107.40 ansible_network_os=cnos ansible_ssh_user=<username> ansible_ssh_pass=<password> deviceType=g8272_cnos
81```
82
83**Note:** You need to change the IP addresses to fit your specific topology. You also need to change the `<username>` and `<password>` to the appropriate values used to log into the specific Lenovo network devices.
84
85
86## Example Playbook
87---
88<add playbook samples below>
89
90To execute an Ansible playbook, use the following command:
91
92```
93ansible-playbook cnos_rollback_sample.yml -vvv
94```
95
96`-vvv` is an optional verbos command that helps identify what is happening during playbook execution. The playbook for each role is located in the main directory of the solution.
97
98```
99 - name: Module to do rollback of configurations
100 hosts: cnos_rollback_sample
101 gather_facts: no
102 connection: local
103 roles:
104 - cnos_rollback_sample
105```
106
107
108## License
109---
110<add license information below>
111Copyright (C) 2017 Lenovo, Inc.
112
113This file is part of Ansible
114
115Ansible is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
116
117Ansible is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
118
119You should have received a copy of the GNU General Public License along with Ansible. If not, see <http://www.gnu.org/licenses/>.