netcommon

16Modules49Plugins1Dependency

Overview

Description

Ansible Collection with common content to help automate the management of network, security, and cloud devices.

Readme

Ansible Network Collection for Common Code (netcommon)

CI Codecov CI

The Ansible ansible.netcommon collection includes common content to help automate the management of network, security, and cloud devices. This includes connection plugins, such as network_cli, httpapi, and netconf.

Support

As a Red Hat Ansible Certified Content, this collection is entitled to support through Ansible Automation Platform (AAP).

If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there is community support available at no charge.

You can join us on #network:ansible.com room or the Ansible Forum Network Working Group.

For more information you can check the communication section below.

Communication

For more information about communication, see the Ansible communication guide.

Ansible version compatibility

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

For collections that support Ansible 2.9, please ensure you update your network_os to use the fully qualified collection name (for example, cisco.ios.ios). 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.

Included content

Become plugins

NameDescription
ansible.netcommon.enableSwitch to elevated permissions on a network device

Cliconf plugins

NameDescription
ansible.netcommon.defaultGeneral purpose cliconf plugin for new platforms

Connection plugins

NameDescription
ansible.netcommon.grpcProvides a persistent connection using the gRPC protocol
ansible.netcommon.httpapiUse httpapi to run command on network appliances
ansible.netcommon.libsshRun tasks using libssh for ssh connection
ansible.netcommon.netconfProvides a persistent connection using the netconf protocol
ansible.netcommon.network_cliUse network_cli to run command on network appliances
ansible.netcommon.persistentUse a persistent unix socket for connection

Filter plugins

NameDescription
ansible.netcommon.comp_type5The comp_type5 filter plugin.
ansible.netcommon.hash_saltThe hash_salt filter plugin.
ansible.netcommon.parse_cliparse_cli filter plugin.
ansible.netcommon.parse_cli_textfsmparse_cli_textfsm filter plugin.
ansible.netcommon.parse_xmlThe parse_xml filter plugin.
ansible.netcommon.pop_aceRemove ace entries from a acl source of truth.
ansible.netcommon.type5_pwThe type5_pw filter plugin.
ansible.netcommon.vlan_expanderThe vlan_expander filter plugin.
ansible.netcommon.vlan_parserThe vlan_parser filter plugin.

Httpapi plugins

NameDescription
ansible.netcommon.restconfHttpApi Plugin for devices supporting Restconf API

Netconf plugins

NameDescription
ansible.netcommon.defaultUse default netconf plugin to run standard netconf commands as per RFC

Modules

NameDescription
ansible.netcommon.cli_backupBack up device configuration from network devices over network_cli
ansible.netcommon.cli_commandRun a cli command on cli-based network devices
ansible.netcommon.cli_configPush text based configuration to network devices over network_cli
ansible.netcommon.cli_restoreRestore device configuration to network devices over network_cli
ansible.netcommon.grpc_configFetch configuration/state data from gRPC enabled target hosts.
ansible.netcommon.grpc_getFetch configuration/state data from gRPC enabled target hosts.
ansible.netcommon.net_getCopy a file from a network device to Ansible Controller
ansible.netcommon.net_pingTests reachability using ping from a network device
ansible.netcommon.net_putCopy a file from Ansible Controller to a network device
ansible.netcommon.netconf_confignetconf device configuration
ansible.netcommon.netconf_getFetch configuration/state data from NETCONF enabled network devices.
ansible.netcommon.netconf_rpcExecute operations on NETCONF enabled network devices.
ansible.netcommon.network_resourceManage resource modules
ansible.netcommon.restconf_configHandles create, update, read and delete of configuration data on RESTCONF enabled devices.
ansible.netcommon.restconf_getFetch configuration/state data from RESTCONF enabled devices.
ansible.netcommon.telnetExecutes a low-down and dirty telnet command

Installing this collection

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

ansible-galaxy collection install ansible.netcommon

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.netcommon

Using this collection

The most common use case for this collection is to include it as a dependency in a network device-specific collection. Use the Fully Qualified Collection Name (FQCN) when referring to content in this collection (for example, ansible.netcommon.network_cli).

See the Vyos collection for an example of this.

See Also:

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.netcommon collection repository. See Contributing to Ansible-maintained collections for complete details.

You can also join us on:

  • IRC - #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

Release notes are available here

Roadmap

More information

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.

Certification

Product
Red Hat Ansible Automation Platform 2.5
DocumentationDependencies

This collection requires the following collections for use:

NameSummary

This collection is used by the following collections:

1 - 10 of 99 items
NameSummaryVersionType
View in Automation Hub
Red Hat logoLinkedInYouTubeFacebookTwitter

Platforms

Products & services

Try, buy, sell

Help

About Red Hat Ecosystem Catalog

The Red Hat Ecosystem Catalog is the official source for discovering and learning more about the Red Hat Ecosystem of both Red Hat and certified third-party products and services.

We’re the world’s leading provider of enterprise open source solutions—including Linux, cloud, container, and Kubernetes. We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2025 Red Hat