README.md
1# Ansible Role: enos_facts - Displays switch inforamtion
2---
3<add role description below>
4
5 Collects a base set of device facts from a remote Lenovo device
6 running on ENOS. This module prepends all of the
7 base network fact keys with C(ansible_net_<fact>). The facts
8 module will always collect a base set of facts from the device
9 and can enable or disable collection of additional facts.
10
11## Requirements
12---
13<add role requirements information below>
14
15- Ansible version 2.4 or later ([Ansible installation documentation](http://docs.ansible.com/ansible/intro_installation.html))
16- Lenovo switches running ENOS version 8.4.1.0 or later
17- an SSH connection to the Lenovo switch (SSH must be enabled on the network device)
18
19
20## Role Variables
21---
22<add role variables information below>
23Available variables are listed below, along with description.
24
25The following are mandatory inventory variables:
26
27Variable | Description
28--- | ---
29`ansible_connection` | Has to be `network_cli`
30`ansible_network_os` | Has to be `enos`
31`ansible_ssh_user` | Specifies the username used to log into the switch
32`ansible_ssh_pass` | Specifies the password used to log into the switch
33
34To gather subsets you will specify the following variables to get appropriate
35data retrived from the devices
36
37Variable | Description
38--- | ---
39`gather_subset` | When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, and interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial C(M(!)) to specify that a specific subset should not be collected.
40
41Need to specify these variables in vars/main.yml under variable `cli`
42
43Variable | Description
44--- | ---
45`host` | Has to be "{{ inventory_hostname }}"
46`port` | Has to be`22`
47`username` | User Name of switch
48`password` | Password of switch
49`timeout` | time out value for CLI
50`authorixe` | Whether u have to enter enable mode for data collection.
51`auth_pass`| Enable Password if required
52
53
54## Dependencies
55---
56<add dependencies information below>
57
58- username.iptables - Configures the firewall and blocks all ports except those needed for web server and SSH access.
59- username.common - Performs common server configuration.
60- enos_facts.py - This module file will be located at lib/ansible/modules/network/enos/ of Ansible installation.
61- enos.py - This module util file will be located at lib/ansible/module_utils/network/enos of Ansible installation.
62- enos.py - This module plugin file will be located at lib/ansible/plugins/action of Ansible installation.
63- enos.py - This module plugin file will be located at lib/ansible/plugins/cliconf of Ansible installation.
64- enos.py - This module plugin file will be located at lib/ansible/plugins/cliconf of Ansible installation.
65- /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 *enos_command_sample_hosts* for a sample configuration.
66
67Ansible 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.
68
69Open 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.
70
71```
72[enos_facts]
7310.241.105.24 ansible_connection=network_cli ansible_network_os=enos ansible_ssh_user=<username> ansible_ssh_pass=<password>
74```
75
76**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.
77
78
79## Example Playbook
80---
81<add playbook samples below>
82
83To execute an Ansible playbook, use the following command:
84
85```
86ansible-playbook enos_facts_sample.yml -vvv
87```
88
89`-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.
90
91```
92 - name: Module to do some CLI Command configurations
93 hosts: enos_facts
94 gather_facts: no
95 connection: network_cli
96 roles:
97 - enos_facts
98```
99
100## License
101---
102<add license information below>
103Copyright (C) 2017 Lenovo, Inc.
104
105This file is part of Ansible
106
107Ansible 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.
108
109Ansible 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.
110
111You should have received a copy of the GNU General Public License along with Ansible. If not, see <http://www.gnu.org/licenses/>.
112