Skip to content

Installation

Ansible Galaxy

Run the following command to install the networktocode.nautobot collection: ansible-galaxy collection install networktocode.nautobot

Note

Installing Ansible Collections using Git within a requirements.yml is only supported from Ansible 2.10 onwards.

Follow the official docs to learn more about other installation methods.

Build From Source

Follow these steps to install from source:

  1. git clone git@github.com:nautobot/nautobot-ansible.git
  2. cd nautobot-ansible
  3. ansible-galaxy collection build .
  4. ansible-galaxy collection install networktocode-nautobot*.tar.gz

Build From Source (Pull Request)

This is useful to test code within PRs.

  1. git clone git@github.com:nautobot/nautobot-ansible.git
  2. cd nautobot-ansible
  3. git fetch origin pull/<pr #>/head:<whatever-name-you-want>
  4. git checkout <whatever-name-you-want>
  5. ansible-galaxy collection build .
  6. ansible-galaxy collection install networktocode-nautobot*.tar.gz

Note

The following link provides detailed information on checking out pull requests locally: GitHub.