What is Ansible?
Ansible is a Network Automation tool, it works with YAML to push or get configs from a network device or group of devices or hosts.
Ansible works with SSH, which means you need to have NETMIKO or PARAMIKO installed along with your Python in order for Ansible codes to work.
how to Install Ansible?
simply by typing this command into your terminal (linux or MAC) $pip install ansible
you can then check your installed version using the command $ansible --version
like below:
Since we already mentioned that Ansible work with YAML as data modeling language, then this means we need to install YAML as well, you can install by:
$pip install PyYAML
below link shows more documents about YAML:
https://pypi.org/project/PyYAML/
NOTE: you might face problem while trying to run an Ansible code because of SSH keys between your Computer and the Network/host you are trying to connect to and this will cause an error similar to the following screen:
there is a workaround for this by adding some part in the configuration into the ansible.cfg file as below:
you can open a file and name it as ansible.cfg with nano
$nano ansible.cfg
then add
[defaults]
host_key_checking = false
save the file and run your ansible code again.
Ok, now onto writing a simple Ansible code to get_facts from a Cisco IOS device.
1. in order to do that, you need to have a list of hosts/host configured and that will be created in the same directory that I will be creating my ansible code from, which will be:
samer@Samers-MacBook-Pro ansibleproject % pwd
/Users/samer/Documents/ansibleproject
[cisco] is the group of devices/hosts, so it means you can list your hosts below just like Im listing (10.211.10.36) here for my testing.
[cisco:vars] as you can see is the other information like the OS and username and password of the device/host listed in group Cisco above.
Ok now let us create the Ansible code, which will be by creating a file that I named as test.yml (YAML) format file.
as you can see the file starts with (---)
then (-) name, group of hosts, connection type (SSH), then the tasks that ansible will be doing on the host (tasks:)
NOTE: white-spaces are really important and you will face problem in running the codes if you did not have the correct spacing.
example of error caused by missing space:
Ok, so our ansible task will be to get the software version of the host (10.211.10.36) and this is done with the last task named "VIEW OS VERSION" which has the var: ansible_net_version
how to run the code now?
$ansible-playbook -i hosts testing.yml
Of course my terminal is already inside the same directory, if your path was not in same directory then you need to add the full path for the files.
(-i) here means inventory which means play ansible against the inventory in the path hosts and the ansible file is testing.yml
ansible will check the hosts/groups in the file called hosts and use the login information in the [var] to login to the host using SSH (NETMIKO/PARAMIKO).
once you fix all of the white-spaces issues and run the code, you should get the following screen of output:
The green screen! OK=1 and failed=0.
Note, you can use ad-hoc command for ansible to push fast commands and do things quickly on one host using the following format:
$ansible 10.211.10.36 -m raw -a "show version" -u samer -k
where k is prompt for password.
this is my introduction into Ansible for Network Automation.
good resources can be found here:
https://developer.cisco.com/startnow/
https://docs.ansible.com/ansible/latest/collections/cisco/ios/ios_command_module.html#examples
I hope this was useful.
Samer R. Saleem
No comments:
Post a Comment