Modules Maintained by the Ansible Network Team

Network

Check_Point

• checkpoint_access_layer_facts – Get access layer facts on Check Point over Web Services API
• checkpoint_access_rule – Manages access rules on Check Point over Web Services API
• checkpoint_access_rule_facts – Get access rules objects facts on Check Point over Web Services API
• checkpoint_host – Manages host objects on Check Point over Web Services API
• checkpoint_host_facts – Get host objects facts on Check Point over Web Services API
• checkpoint_object_facts – Get object facts on Check Point over Web Services API
• checkpoint_run_script – Run scripts on Check Point devices over Web Services API
• checkpoint_session – Manages session objects on Check Point over Web Services API
• checkpoint_task_facts – Get task objects facts on Check Point over Web Services API

Cli

• cli_command – Run a cli command on cli-based network devices
• cli_config – Push text based configuration to network devices over network_cli

Eos

• eos_banner – Manage multiline banners on Arista EOS devices
• eos_bgp – Configure global BGP protocol settings on Arista EOS
• eos_command – Run arbitrary commands on an Arista EOS device
• eos_config – Manage Arista EOS configuration sections
• eos_eapi – Manage and configure Arista EOS eAPI
• eos_facts – Collect facts from remote devices running Arista EOS
• eos_interface – Manage Interface on Arista EOS network devices (D)
• eos_interfaces – Manages interface attributes of Arista EOS interfaces
• eos_l2_interface – Manage L2 interfaces on Arista EOS network devices (D)
• eos_l2_interfaces – Manages Layer-2 interface attributes of Arista EOS devices
• eos_l3_interface – Manage L3 interfaces on Arista EOS network devices (D)
• eos_l3_interfaces – Manages L3 interface attributes of Arista EOS devices
• eos_lacp – Manage Global Link Aggregation Control Protocol (LACP) on Arista EOS devices
• eos_lacp_interfaces – Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on Arista EOS devices
• eos_lag_interfaces – Manages link aggregation groups on Arista EOS devices
• eos_linkagg – Manage link aggregation groups on Arista EOS network devices (D)
• eos_lldp – Manage LLDP configuration on Arista EOS network devices
• eos_lldp_global – Manage Global Link Layer Discovery Protocol (LLDP) settings on Arista EOS devices
• eos_lldp_interfaces – Manage Link Layer Discovery Protocol (LLDP) attributes of interfaces on Arista EOS devices
• eos_logging – Manage logging on network devices
• eos_static_route – Manage static IP routes on Arista EOS network devices
• eos_system – Manage the system attributes on Arista EOS devices
• eos_user – Manage the collection of local users on EOS devices
• eos_vlan – Manage VLANs on Arista EOS network devices (D)
• eos_vlans – Manage VLANs on Arista EOS devices
• eos_vrf – Manage VRFs on Arista EOS network devices

Files

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

Frr

• frr_bgp – Configure global BGP settings on Free Range Routing(FRR)
• frr_facts – Collect facts from remote devices running Free Range Routing (FRR)

Interface

• net_interface – Manage Interface on network devices (D)
• net_linkagg – Manage link aggregation groups on network devices (D)
• net_lldp_interface – Manage LLDP interfaces configuration on network devices (D)

Ios

• ios_banner – Manage multiline banners on Cisco IOS devices
• ios_bgp – Configure global BGP protocol settings on Cisco IOS
• ios_command – Run commands on remote devices running Cisco IOS
• ios_config – Manage Cisco IOS configuration sections
• ios_facts – Collect facts from remote devices running Cisco IOS
• ios_interface – Manage Interface on Cisco IOS network devices (D)
• ios_interfaces – Manages interface attributes of Cisco IOS network devices
• ios_l2_interface – Manage Layer-2 interface on Cisco IOS devices (D)
• ios_l2_interfaces – Manage Layer-2 interface on Cisco IOS devices
• ios_l3_interface – Manage Layer-3 interfaces on Cisco IOS network devices (D)
• ios_l3_interfaces – Manage Layer-3 interface on Cisco IOS devices
• ios_lacp – Manage Global Link Aggregation Control Protocol (LACP) on Cisco IOS devices
• ios_lacp_interfaces – Manage Link Aggregation Control Protocol (LACP) on Cisco IOS devices interface
• ios_lag_interfaces – Manage Link Aggregation on Cisco IOS devices
• ios_linkagg – Manage link aggregation groups on Cisco IOS network devices
• ios_lldp – Manage LLDP configuration on Cisco IOS network devices
• ios_lldp_global – Configure and manage Link Layer Discovery Protocol(LLDP) attributes on IOS platforms
• ios_lldp_interfaces – Manage link layer discovery protocol (LLDP) attributes of interfaces on Cisco IOS devices
• ios_logging – Manage logging on network devices
• ios_ntp – Manages core NTP configuration
• ios_static_route – Manage static IP routes on Cisco IOS network devices
• ios_system – Manage the system attributes on Cisco IOS devices
• ios_user – Manage the aggregate of local users on Cisco IOS device
• ios_vlan – Manage VLANs on IOS network devices (D)
• ios_vlans – Manage VLANs on Cisco IOS devices
• ios_vrf – Manage the collection of VRF definitions on Cisco IOS devices

Iosxr

• iosxr_banner – Manage multiline banners on Cisco IOS XR devices
• iosxr_bgp – Configure global BGP protocol settings on Cisco IOS-XR
• iosxr_command – Run commands on remote devices running Cisco IOS XR
• iosxr_config – Manage Cisco IOS XR configuration sections
• iosxr_facts – Get facts about iosxr devices
• iosxr_interface – Manage Interface on Cisco IOS XR network devices (D)
• iosxr_interfaces – Manage interface attributes on Cisco IOS-XR network devices
• iosxr_l2_interfaces – Manage Layer-2 interface on Cisco IOS-XR devices
• iosxr_l3_interfaces – Manage Layer-3 interface on Cisco IOS-XR devices
• iosxr_lacp – Manage Global Link Aggregation Control Protocol (LACP) on IOS-XR devices
• iosxr_lacp_interfaces – Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on IOS-XR devices
• iosxr_lag_interfaces – Manages attributes of LAG/Ether-Bundle interfaces on IOS-XR devices
• iosxr_lldp_global – Manage Global Link Layer Discovery Protocol (LLDP) settings on IOS-XR devices
• iosxr_lldp_interfaces – Manage Link Layer Discovery Protocol (LLDP) attributes of interfaces on IOS-XR devices
• iosxr_logging – Configuration management of system logging services on network devices
• iosxr_netconf – Configures NetConf sub-system service on Cisco IOS-XR devices
• iosxr_system – Manage the system attributes on Cisco IOS XR devices
• iosxr_user – Manage the aggregate of local users on Cisco IOS XR device

Junos

• junos_banner – Manage multiline banners on Juniper JUNOS devices
• junos_command – Run arbitrary commands on an Juniper JUNOS device
• junos_config – Manage configuration on devices running Juniper JUNOS
• junos_facts – Collect facts from remote devices running Juniper Junos
• junos_interface – Manage Interface on Juniper JUNOS network devices (D)
• junos_interfaces – Manages interface attributes of Juniper Junos OS network devices
• junos_l2_interface – Manage Layer-2 interface on Juniper JUNOS network devices (D)
• junos_l2_interfaces – Manage Layer-2 interface on Juniper JUNOS devices
• junos_l3_interface – Manage L3 interfaces on Juniper JUNOS network devices (D)
• junos_l3_interfaces – Manage Layer 3 interface on Juniper JUNOS devices
• junos_lacp – Manage Global Link Aggregation Control Protocol (LACP) on Juniper Junos devices
• junos_lacp_interfaces – Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on Juniper JUNOS devices
• junos_lag_interfaces – Manage Link Aggregation on Juniper JUNOS devices
• junos_linkagg – Manage link aggregation groups on Juniper JUNOS network devices (D)
• junos_lldp – Manage LLDP configuration on Juniper JUNOS network devices (D)
• junos_lldp_global – Manage link layer discovery protocol (LLDP) attributes on Juniper JUNOS devices
• junos_lldp_interface – Manage LLDP interfaces configuration on Juniper JUNOS network devices (D)
• junos_lldp_interfaces – Manage link layer discovery protocol (LLDP) attributes of interfaces on Juniper JUNOS devices
• junos_logging – Manage logging on network devices
• junos_netconf – Configures the Junos Netconf system service
• junos_package – Installs packages on remote devices running Junos
• junos_ping – Tests reachability using ping from devices running Juniper JUNOS
• junos_rpc – Runs an arbitrary RPC over NetConf on an Juniper JUNOS device
• junos_scp – Transfer files from or to remote devices running Junos
• junos_static_route – Manage static IP routes on Juniper JUNOS network devices
• junos_system – Manage the system attributes on Juniper JUNOS devices
• junos_user – Manage local user accounts on Juniper JUNOS devices
• junos_vlan – Manage VLANs on Juniper JUNOS network devices (D)
• junos_vlans – Create and manage VLAN configurations on Junos OS
• junos_vrf – Manage the VRF definitions on Juniper JUNOS devices

Layer2

• net_l2_interface – Manage Layer-2 interface on network devices (D)
• net_vlan – Manage VLANs on network devices (D)

Layer3

• net_l3_interface – Manage L3 interfaces on network devices (D)
• net_vrf – Manage VRFs on network devices (D)

Netconf

• netconf_config – netconf device configuration
• netconf_get – Fetch configuration/state data from NETCONF enabled network devices
• netconf_rpc – Execute operations on NETCONF enabled network devices

Nxos

• nxos_aaa_server – Manages AAA server global configuration
• nxos_aaa_server_host – Manages AAA server host-specific configuration
• nxos_acl – Manages access list entries for ACLs
• nxos_acl_interface – Manages applying ACLs to interfaces
• nxos_banner – Manage multiline banners on Cisco NXOS devices
• nxos_bfd_global – Bidirectional Forwarding Detection (BFD) global-level configuration
• nxos_bfd_interfaces – Manages BFD attributes of nxos interfaces
• nxos_bgp – Manages BGP configuration
• nxos_bgp_af – Manages BGP Address-family configuration
• nxos_bgp_neighbor – Manages BGP neighbors configurations
• nxos_bgp_neighbor_af – Manages BGP address-family’s neighbors configuration
• nxos_command – Run arbitrary command on Cisco NXOS devices
• nxos_config – Manage Cisco NXOS configuration sections
• nxos_evpn_global – Handles the EVPN control plane for VXLAN
• nxos_evpn_vni – Manages Cisco EVPN VXLAN Network Identifier (VNI)
• nxos_facts – Gets facts about NX-OS switches
• nxos_feature – Manage features in NX-OS switches
• nxos_file_copy – Copy a file to a remote NXOS device
• nxos_gir – Trigger a graceful removal or insertion (GIR) of the switch
• nxos_gir_profile_management – Create a maintenance-mode or normal-mode profile for GIR
• nxos_hsrp – Manages HSRP configuration on NX-OS switches
• nxos_igmp – Manages IGMP global configuration
• nxos_igmp_interface – Manages IGMP interface configuration
• nxos_igmp_snooping – Manages IGMP snooping global configuration
• nxos_install_os – Set boot options like boot, kickstart image and issu
• nxos_interface – Manages physical attributes of interfaces (D)
• nxos_interface_ospf – Manages configuration of an OSPF interface instance
• nxos_interfaces – Manages interface attributes of NX-OS Interfaces
• nxos_l2_interface – Manage Layer-2 interface on Cisco NXOS devices (D)
• nxos_l2_interfaces – Manages Layer-2 Interfaces attributes of NX-OS Interfaces
• nxos_l3_interface – Manage L3 interfaces on Cisco NXOS network devices (D)
• nxos_l3_interfaces – Manages Layer-3 Interfaces attributes of NX-OS Interfaces
• nxos_lacp – Manage Global Link Aggregation Control Protocol (LACP) on Cisco NX-OS devices
• nxos_lacp_interfaces – Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on Cisco NX-OS devices
• nxos_lag_interfaces – Manages link aggregation groups of NX-OS Interfaces
• nxos_linkagg – Manage link aggregation groups on Cisco NXOS devices (D)
• nxos_lldp – Manage LLDP configuration on Cisco NXOS network devices
• nxos_lldp_global – Configure and manage Link Layer Discovery Protocol(LLDP) attributes on NX-OS platforms
• nxos_logging – Manage logging on network devices
• nxos_ntp – Manages core NTP configuration
• nxos_ntp_auth – Manages NTP authentication
• nxos_ntp_options – Manages NTP options
• nxos_nxapi – Manage NXAPI configuration on an NXOS device
• nxos_ospf – Manages configuration of an ospf instance
• nxos_ospf_vrf – Manages a VRF for an OSPF router
• nxos_overlay_global – Configures anycast gateway MAC of the switch
• nxos_pim – Manages configuration of a PIM instance
• nxos_pim_interface – Manages PIM interface configuration
• nxos_pim_rp_address – Manages configuration of an PIM static RP address instance
• nxos_reboot – Reboot a network device
• nxos_rollback – Set a checkpoint or rollback to a checkpoint
• nxos_rpm – Install patch or feature rpms on Cisco NX-OS devices
• nxos_smu – Perform SMUs on Cisco NX-OS devices
• nxos_snapshot – Manage snapshots of the running states of selected features
• nxos_snmp_community – Manages SNMP community configs
• nxos_snmp_contact – Manages SNMP contact info
• nxos_snmp_host – Manages SNMP host configuration
• nxos_snmp_location – Manages SNMP location information
• nxos_snmp_traps – Manages SNMP traps
• nxos_snmp_user – Manages SNMP users for monitoring
• nxos_static_route – Manages static route configuration
• nxos_system – Manage the system attributes on Cisco NXOS devices
• nxos_telemetry – Telemetry Monitoring Service (TMS) configuration
• nxos_udld – Manages UDLD global configuration params
• nxos_udld_interface – Manages UDLD interface configuration params
• nxos_user – Manage the collection of local users on Nexus devices
• nxos_vlan – Manages VLAN resources and attributes (D)
• nxos_vlans – Create VLAN and manage VLAN configurations on NX-OS Interfaces
• nxos_vpc – Manages global VPC configuration
• nxos_vpc_interface – Manages interface VPC configuration
• nxos_vrf – Manages global VRF configuration
• nxos_vrf_af – Manages VRF AF
• nxos_vrf_interface – Manages interface specific VRF configuration
• nxos_vrrp – Manages VRRP configuration on NX-OS switches
• nxos_vtp_domain – Manages VTP domain configuration
• nxos_vtp_password – Manages VTP password configuration
• nxos_vtp_version – Manages VTP version configuration
• nxos_vxlan_vtep – Manages VXLAN Network Virtualization Endpoint (NVE)
• nxos_vxlan_vtep_vni – Creates a Virtual Network Identifier member (VNI)

Ovs

• openvswitch_bridge – Manage Open vSwitch bridges
• openvswitch_db – Configure open vswitch database
• openvswitch_port – Manage Open vSwitch ports

Protocol

• net_lldp – Manage LLDP service configuration on network devices (D)

Restconf

• restconf_config – Handles create, update, read and delete of configuration data on RESTCONF enabled devices
• restconf_get – Fetch configuration/state data from RESTCONF enabled devices

Routing

• net_static_route – Manage static IP routes on network appliances (routers, switches et. al.) (D)

Skydive

• skydive_capture – Module which manages flow capture on interfaces
• skydive_edge – Module to add edges to Skydive topology
• skydive_node – Module which add nodes to Skydive topology

System

• net_banner – Manage multiline banners on network devices (D)
• net_logging – Manage logging on network devices (D)
• net_system – Manage the system attributes on network devices (D)
• net_user – Manage the aggregate of local users on network device (D)

Vyos

• vyos_banner – Manage multiline banners on VyOS devices
• vyos_command – Run one or more commands on VyOS devices
• vyos_config – Manage VyOS configuration on remote device
• vyos_facts – Get facts about vyos devices
• vyos_interface – Manage Interface on VyOS network devices (D)
• vyos_interfaces – Manages interface attributes of VyOS network devices
• vyos_l3_interface – Manage L3 interfaces on VyOS network devices (D)
• vyos_l3_interfaces – Manages L3 interface attributes of VyOS network devices
• vyos_lag_interfaces – Manages attributes of link aggregation groups on VyOS network devices
• vyos_linkagg – Manage link aggregation groups on VyOS network devices (D)
• vyos_lldp – Manage LLDP configuration on VyOS network devices (D)
• vyos_lldp_global – Manage link layer discovery protocol (LLDP) attributes on VyOS devices
• vyos_lldp_interface – Manage LLDP interfaces configuration on VyOS network devices (D)
• vyos_lldp_interfaces – Manages attributes of lldp interfaces on VyOS devices
• vyos_logging – Manage logging on network devices
• vyos_static_route – Manage static IP routes on Vyatta VyOS network devices
• vyos_system – Run set system commands on VyOS devices
• vyos_user – Manage the collection of local users on VyOS device
• vyos_vlan – Manage VLANs on VyOS network devices

Note

• (D): This marks a module as deprecated, which means a module is kept for backwards compatibility but usage is discouraged. The module documentation details page may explain more about this rationale.