ansible-collections / ansible.network

Ansible Network Collection for network and IP utilities that are not specific to any platform or OS.

Ansible Network Meta Collection.

The Ansible ansible.network collection is a meta collection that install all the following network supported content collections.

- ansible.netcommon
- ansible.network
- ansible.utils
- arista.eos
- cisco.ios
- cisco.iosxr
- cisco.nxos
- frr.frr
- junipernetworks.junos
- openvswitch.openvswitch
- vyos.vyos

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.14.0.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Installing this collection

You can install the ansible.network collection with the Ansible Galaxy CLI:

ansible-galaxy collection install ansible.network

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: ansible.network

Using this collection

NOTE: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.

Using ansible.network meta collection to install supported network content collections with latest available release.

    (python37) [root@fedora]$ ansible-galaxy collection install ansible.network
    Process install dependency map
    Starting collection install process
    Installing 'ansible.network:1.0.0' to '/home/root/.ansible/collections/ansible_collections/ansible/network'
    Installing 'frr.frr:1.0.3' to '/home/root/.ansible/collections/ansible_collections/frr/frr'
    Installing 'cisco.ios:2.2.0' to '/home/root/.ansible/collections/ansible_collections/cisco/ios'
    Installing 'vyos.vyos:2.3.0' to '/home/root/.ansible/collections/ansible_collections/vyos/vyos'
    Installing 'arista.eos:2.1.2' to '/home/root/.ansible/collections/ansible_collections/arista/eos'
    Installing 'cisco.nxos:2.3.0' to '/home/root/.ansible/collections/ansible_collections/cisco/nxos'
    Installing 'cisco.iosxr:2.2.0' to '/home/root/.ansible/collections/ansible_collections/cisco/iosxr'
    Installing 'ansible.utils:2.2.0' to '/home/root/.ansible/collections/ansible_collections/ansible/utils'
    Installing 'ansible.netcommon:2.1.0' to '/home/root/.ansible/collections/ansible_collections/ansible/netcommon'
    Installing 'junipernetworks.junos:2.2.0' to '/home/root/.ansible/collections/ansible_collections/junipernetworks/junos'
    Installing 'openvswitch.openvswitch:2.0.0' to '/home/root/.ansible/collections/ansible_collections/openvswitch/openvswitch'

List of installed network content collections.

    (python37) [root@fedora]$ ansible-galaxy collection list
    /home/root/.ansible/collections/ansible_collections
    Collection              Version
    ----------------------- -------
    ansible.netcommon       2.1.0
    ansible.network         1.0.0
    ansible.utils           2.2.0
    arista.eos              2.1.2
    cisco.ios               2.2.0
    cisco.iosxr             2.2.0
    cisco.nxos              2.3.0
    frr.frr                 1.0.3
    junipernetworks.junos   2.2.0
    openvswitch.openvswitch 2.0.0
    vyos.vyos               2.3.0

See Also:

• Ansible Using collections for more details.

Advantage of Using this collection

The Ansible ansible.network meta collection gives a single command to install all those network content collection dependencies rather than individually listing them.

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the ansible.network collection repository. See Contributing to Ansible-maintained collections for complete details.

You can also join us on:

• IRC - the #ansible-network irc.libera.chat channel
• Slack - https://ansiblenetwork.slack.com

See the Ansible Community Guide for details on contributing to Ansible.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

Release notes

Roadmap

More information

• Developing network resource modules
• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.