Community Network Collection

This repository contains the community.network Ansible Collection. The collection is a part of the ansible package and includes many network modules and plugins supported by Ansible community which are not part of more specialized community collections.

You can find documentation for this collection on the Ansible docs site.

Code of Conduct

We follow Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior violating the Ansible Code of Conduct, please refer to the policy violations section of the Code of Conduct for information on how to raise a complaint.

Contributing to this collection

The content of this collection is made by good people like you, a community of individuals collaborating on making the world better through developing automation software.

All types of contributions are very welcome.

You don't know how to start? Refer to our contribution guide!

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

If you're interested in becoming a maintainer of this collection, refer to the Maintainer guidelines for details.

Communication

We announce important development changes and releases through Ansible's The Bullhorn newsletter. If you are a contributor, be sure you are subscribed.

Join us on:

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

Contributors to this collection take part in the global quarterly Ansible Contributor Summit virtually or in-person. Track The Bullhorn newsletter and join us.

For more information about communication, refer to the Ansible communication guide.

Tested with Ansible

Tested with the Ansible 2.9, 2.10, 2.11 releases, and the current development version of Ansible. Ansible versions before 2.9.10 are not supported.

Supported connections

The community network collection supports network_cli and httpapi connections.

Included content

Click the Content button to see the list of content included in this collection, or check the documentation on the Ansible docs site.

Installing this collection

This collection is shipped with the ansible package. So if you have it installed, no more action is required.

If you have a minimal installation (only Ansible Core installed) or you want to use the latest version of the collection along with the whole ansible package, you need to install the collection from Ansible Galaxy manually with the ansible-galaxy command-line tool:

ansible-galaxy collection install community.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: community.network
    # If you need a specific version of the collection, you can specify like this:
    # version: ...

Note that if you install the collection manually, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install community.network --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where X.Y.Z can be any available version:

ansible-galaxy collection install community.network:==X.Y.Z

See Ansible Using collections for more details.

Using this collection

You can call modules by their Fully Qualified Collection Name (FQCN), such as community.network.routeros_command. The following example task replaces configuration changes in the existing configuration on a network device, using the FQCN:

---
  - name: run command on remote devices
    community.network.routeros_command:
      commands: /system routerboard print

Alternately, you can call modules by their short name if you list the community.network collection in the playbook's collections, as follows:

---
- hosts: routeros01
  gather_facts: false
  connection: network_cli

  collections:
    - community.network

  tasks:
    - name: Gather facts from the device.
      routeros_facts:
         gather_subset: all

Changelogs

See here.

Roadmap

More information

Licensing

GNU General Public License v3.0 or later.

See COPYING to see the full text.

amolopcito/community.network