ansible-netmiko-stdlib

An Ansible module for using Netmiko to configure network devices via SSHv2.

Prerequisites

• Ansible - A simple IT automation platform
• Netmiko - A multi-vendor Python library used to simplify Paramiko SSH connections to network devices
• [Paramiko] (https://github.com/paramiko/paramiko) - A native Python SSHv2 protocol library

Usage

Clone the repository from GitHub to a suitable location on your host (a new git directory is created within the user's home directory in this example):

mkdir ~/git
cd ~/git
git clone https://github.com/supertylerc/ansible-netmiko-stdlib

The ansible-netmiko-stdlib directory will be automatically created.

Add the following line to your ~/.bashrc, ~/.zshrc, or the rc file of whatever shell you're using:

source "~/git/ansible-netmiko-stdlib/env-setup"

This assumes you cloned the repository to ~/git/ansible-netmiko-stdlib as detailed earlier.

In order to use this module, you must set the connection to local within Ansible. You can do this with the connection: local setting on plays/playbooks, or you can set the ansible_connection=local connection type in the hosts file.

Check out this blog post for an example of how this module be used.

Roadmap

See the milestones for details on the roadmap. Issues get assigned to milestones as they are opened or investigated. Milestones have target release days (generally every 2 weeks until v1.0.0).

Support

Open GitHub issues and pull requests.

Please note:

• Bugs will be backported starting with v0.1.0.
• Bug fixes will not be assigned to normal versioned milestones. Instead, they will be assigned to the Bug Free milestone for ensuring a bug free project.
• All features and design docs will be assigned to a versioned milestone.
• Documentation will not be assigned to a milestone (unless it is also a design doc).

Author

Tyler Christiansen

License

MIT. See LICENSE.