Ansible.Netcommon

Collection version 7.1.0

Description

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

Author:

• Ansible Network Community (ansible-network)

Supported ansible-core versions:

• 2.15.0 or newer

• Issue Tracker
• Repository (Sources)

Plugin Index

These are the plugins in the ansible.netcommon collection:

Modules

• cli_backup module – Back up device configuration from network devices over network_cli

• cli_command module – Run a cli command on cli-based network devices

• cli_config module – Push text based configuration to network devices over network_cli

• cli_restore module – Restore device configuration to network devices over network_cli

• grpc_config module – Fetch configuration/state data from gRPC enabled target hosts.

• grpc_get module – Fetch configuration/state data from gRPC enabled target hosts.

• net_get module – Copy a file from a network device to Ansible Controller

• net_ping module – Tests reachability using ping from a network device

• net_put module – Copy a file from Ansible Controller to a network device

• netconf_config module – netconf device configuration

• netconf_get module – Fetch configuration/state data from NETCONF enabled network devices.

• netconf_rpc module – Execute operations on NETCONF enabled network devices.

• network_resource module – Manage resource modules

• restconf_config module – Handles create, update, read and delete of configuration data on RESTCONF enabled devices.

• restconf_get module – Fetch configuration/state data from RESTCONF enabled devices.

• telnet module – Executes a low-down and dirty telnet command

Become Plugins

• enable become – Switch to elevated permissions on a network device

Cache Plugins

• memory cache – RAM backed, non persistent cache.

Cliconf Plugins

• default cliconf – General purpose cliconf plugin for new platforms

Connection Plugins

• grpc connection – Provides a persistent connection using the gRPC protocol

• httpapi connection – Use httpapi to run command on network appliances

• libssh connection – Run tasks using libssh for ssh connection

• netconf connection – Provides a persistent connection using the netconf protocol

• network_cli connection – Use network_cli to run command on network appliances

• persistent connection – Use a persistent unix socket for connection

Filter Plugins

• comp_type5 filter – The comp_type5 filter plugin.

• hash_salt filter – The hash_salt filter plugin.

• parse_cli filter – parse_cli filter plugin.

• parse_cli_textfsm filter – parse_cli_textfsm filter plugin.

• parse_xml filter – The parse_xml filter plugin.

• pop_ace filter – Remove ace entries from a acl source of truth.

• type5_pw filter – The type5_pw filter plugin.

• vlan_expander filter – The vlan_expander filter plugin.

• vlan_parser filter – The vlan_parser filter plugin.

Httpapi Plugins

• restconf httpapi – HttpApi Plugin for devices supporting Restconf API

Netconf Plugins

• default netconf – Use default netconf plugin to run standard netconf commands as per RFC

See also

List of collections with docs hosted here.