{"id":13586645,"url":"https://github.com/ansible-collections/ansible.netcommon","last_synced_at":"2026-02-04T08:16:41.160Z","repository":{"id":37950664,"uuid":"240330999","full_name":"ansible-collections/ansible.netcommon","owner":"ansible-collections","description":"Ansible Network Collection for Common Code","archived":false,"fork":false,"pushed_at":"2024-05-22T11:34:00.000Z","size":1362,"stargazers_count":136,"open_issues_count":103,"forks_count":101,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-05-23T06:45:55.867Z","etag":null,"topics":["ansible-collection","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ansible-collections.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-13T18:22:52.000Z","updated_at":"2024-06-12T15:20:38.326Z","dependencies_parsed_at":"2023-12-06T14:29:02.181Z","dependency_job_id":"40959c8f-3f5b-461e-b0dc-93c640df8303","html_url":"https://github.com/ansible-collections/ansible.netcommon","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fansible.netcommon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fansible.netcommon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fansible.netcommon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fansible.netcommon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ansible-collections","download_url":"https://codeload.github.com/ansible-collections/ansible.netcommon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248119294,"owners_count":21050755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible-collection","hacktoberfest"],"created_at":"2024-08-01T15:05:42.471Z","updated_at":"2026-02-04T08:16:41.153Z","avatar_url":"https://github.com/ansible-collections.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\n\n# Ansible Network Collection for Common Code (netcommon)\n\n[![Integration tests 💻](https://github.com/ansible-collections/ansible.netcommon/actions/workflows/integration-cml.yml/badge.svg?branch=main)](https://github.com/ansible-collections/ansible.netcommon/actions/workflows/integration-cml.yml)\n[![CI](https://github.com/ansible-collections/ansible.netcommon/actions/workflows/tests.yml/badge.svg?branch=main\u0026event=schedule)](https://github.com/ansible-collections/ansible.netcommon/actions/workflows/tests.yml)\n\nThe Ansible ``ansible.netcommon`` collection includes common content to help automate the management of network, security, and cloud devices.\nThis includes connection plugins, such as ``network_cli``, ``httpapi``, and ``netconf``.\n\n## Support\n\nAs Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the **Create issue** button on the top right corner. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there may community help available on the [Ansible Forum](https://forum.ansible.com/).\n\nAdditionally, you can join us on [#network:ansible.com](https://matrix.to/#/#network:ansible.com) room or the [Ansible Forum Network Working Group](https://forum.ansible.com/g/network-wg).\n\nFor more information you can check the communication section below.\n\n## Communication\n\n* Join the Ansible forum:\n  * [Get Help](https://forum.ansible.com/c/help/6): get help or help others.\n  * [Posts tagged with 'network'](https://forum.ansible.com/tag/network): subscribe to participate in collection-related conversations.\n  * [Ansible Network Automation Working Group](https://forum.ansible.com/g/network-wg/): by joining the team you will automatically get subscribed to the posts tagged with [network](https://forum.ansible.com/tags/network).\n  * [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.\n  * [News \u0026 Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.\n\n* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.\n\nFor more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).\n\n\u003c!--start requires_ansible--\u003e\n## Ansible version compatibility\n\nThis collection has been tested against the following Ansible versions: **\u003e=2.16.0**.\n\nPlugins and modules within a collection may be tested with only specific Ansible versions.\nA collection may contain metadata that identifies these versions.\nPEP440 is the schema used to describe the versions of Ansible.\n\u003c!--end requires_ansible--\u003e\n\n## Included content\n\n\u003c!--start collection content--\u003e\n### Become plugins\nName | Description\n--- | ---\n[ansible.netcommon.enable](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.enable_become.rst)|Switch to elevated permissions on a network device\n\n### Cliconf plugins\nName | Description\n--- | ---\n[ansible.netcommon.default](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.default_cliconf.rst)|General purpose cliconf plugin for new platforms\n\n### Connection plugins\nName | Description\n--- | ---\n[ansible.netcommon.grpc](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.grpc_connection.rst)|Provides a persistent connection using the gRPC protocol\n[ansible.netcommon.httpapi](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.httpapi_connection.rst)|Use httpapi to run command on network appliances\n[ansible.netcommon.libssh](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.libssh_connection.rst)|Run tasks using libssh for ssh connection\n[ansible.netcommon.netconf](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.netconf_connection.rst)|Provides a persistent connection using the netconf protocol\n[ansible.netcommon.network_cli](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.network_cli_connection.rst)|Use network_cli to run command on network appliances\n[ansible.netcommon.persistent](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.persistent_connection.rst)|Use a persistent unix socket for connection\n\n### Filter plugins\nName | Description\n--- | ---\n[ansible.netcommon.comp_type5](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.comp_type5_filter.rst)|The comp_type5 filter plugin.\n[ansible.netcommon.hash_salt](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.hash_salt_filter.rst)|The hash_salt filter plugin.\n[ansible.netcommon.parse_cli](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.parse_cli_filter.rst)|parse_cli filter plugin.\n[ansible.netcommon.parse_cli_textfsm](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.parse_cli_textfsm_filter.rst)|parse_cli_textfsm filter plugin.\n[ansible.netcommon.parse_xml](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.parse_xml_filter.rst)|The parse_xml filter plugin.\n[ansible.netcommon.pop_ace](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.pop_ace_filter.rst)|Remove ace entries from a acl source of truth.\n[ansible.netcommon.type5_pw](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.type5_pw_filter.rst)|The type5_pw filter plugin.\n[ansible.netcommon.vlan_expander](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.vlan_expander_filter.rst)|The vlan_expander filter plugin.\n[ansible.netcommon.vlan_parser](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.vlan_parser_filter.rst)|The vlan_parser filter plugin.\n\n### Httpapi plugins\nName | Description\n--- | ---\n[ansible.netcommon.restconf](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.restconf_httpapi.rst)|HttpApi Plugin for devices supporting Restconf API\n\n### Netconf plugins\nName | Description\n--- | ---\n[ansible.netcommon.default](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.default_netconf.rst)|Use default netconf plugin to run standard netconf commands as per RFC\n\n### Modules\nName | Description\n--- | ---\n[ansible.netcommon.cli_backup](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.cli_backup_module.rst)|Back up device configuration from network devices over network_cli\n[ansible.netcommon.cli_command](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.cli_command_module.rst)|Run a cli command on cli-based network devices\n[ansible.netcommon.cli_config](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.cli_config_module.rst)|Push text based configuration to network devices over network_cli\n[ansible.netcommon.cli_restore](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.cli_restore_module.rst)|Restore device configuration to network devices over network_cli\n[ansible.netcommon.grpc_config](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.grpc_config_module.rst)|Fetch configuration/state data from gRPC enabled target hosts.\n[ansible.netcommon.grpc_get](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.grpc_get_module.rst)|Fetch configuration/state data from gRPC enabled target hosts.\n[ansible.netcommon.net_get](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.net_get_module.rst)|Copy a file from a network device to Ansible Controller\n[ansible.netcommon.net_ping](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.net_ping_module.rst)|Tests reachability using ping from a network device\n[ansible.netcommon.net_put](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.net_put_module.rst)|Copy a file from Ansible Controller to a network device\n[ansible.netcommon.netconf_config](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.netconf_config_module.rst)|netconf device configuration\n[ansible.netcommon.netconf_get](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.netconf_get_module.rst)|Fetch configuration/state data from NETCONF enabled network devices.\n[ansible.netcommon.netconf_rpc](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.netconf_rpc_module.rst)|Execute operations on NETCONF enabled network devices.\n[ansible.netcommon.network_resource](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.network_resource_module.rst)|Manage resource modules\n[ansible.netcommon.restconf_config](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.restconf_config_module.rst)|Handles create, update, read and delete of configuration data on RESTCONF enabled devices.\n[ansible.netcommon.restconf_get](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.restconf_get_module.rst)|Fetch configuration/state data from RESTCONF enabled devices.\n[ansible.netcommon.telnet](https://github.com/ansible-collections/ansible.netcommon/blob/main/docs/ansible.netcommon.telnet_module.rst)|Executes a low-down and dirty telnet command\n\n\u003c!--end collection content--\u003e\n\n\n## Installing this collection\n\nYou can install the ``ansible.netcommon`` collection with the Ansible Galaxy CLI:\n\n    ansible-galaxy collection install ansible.netcommon\n\nYou can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:\n\n```yaml\n---\ncollections:\n  - name: ansible.netcommon\n```\n## Using this collection\n\nThe 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`).\n\nSee the [Vyos collection](https://github.com/ansible-collections/vyos.vyos) for an example of this.\n\n### See Also:\n\n* [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.\n\n## Contributing to this collection\n\nWe welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [ansible.netcommon collection repository](https://github.com/ansible-collections/ansible.netcommon). See [Contributing to Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html#contributing-maintained-collections) for complete details.\n\nYou can also join us on:\n\n- IRC - ``#ansible-network`` [irc.libera.chat](https://libera.chat/) channel\n- Slack - https://ansiblenetwork.slack.com\n\nSee the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for details on contributing to Ansible.\n\n### Code of Conduct\nThis collection follows the Ansible project's\n[Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).\nPlease read and familiarize yourself with this document.\n\n\n## Release notes\n\u003c!--Add a link to a changelog.md file or an external docsite to cover this information. --\u003e\nRelease notes are available [here](https://github.com/ansible-collections/ansible.netcommon/blob/main/CHANGELOG.rst)\n\n## Roadmap\n\n\u003c!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. --\u003e\n\n## More information\n\n- [Developing network resource modules](https://docs.ansible.com/ansible/latest/network/dev_guide/developing_resource_modules_network.html#developing-resource-modules)\n- [Ansible network resources](https://docs.ansible.com/ansible/latest/network/getting_started/network_resources.html)\n- [Ansible Collection overview](https://github.com/ansible-collections/overview)\n- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)\n- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)\n- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)\n\n## Licensing\n\nGNU General Public License v3.0 or later.\n\nSee [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansible-collections%2Fansible.netcommon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fansible-collections%2Fansible.netcommon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansible-collections%2Fansible.netcommon/lists"}