AnsibleFest
Products
Community
Webinars & Training
Blog
Documentation
Ansible
v2.4
For previous versions, see the
documentation archive.
Introduction
Installation
Getting Started
Inventory
Dynamic Inventory
Patterns
Introduction To Ad-Hoc Commands
Configuration file
BSD Support
Windows Support
Networking Support
Quickstart Video
Playbooks
Intro to Playbooks
Creating Reusable Playbooks
Variables
Templating (Jinja2)
Conditionals
Loops
Blocks
Strategies
Best Practices
Playbooks: Special Topics
Become (Privilege Escalation)
Accelerated Mode
Asynchronous Actions and Polling
Check Mode (“Dry Run”)
Playbook Debugger
Delegation, Rolling Updates, and Local Actions
Setting the Environment (and Working With Proxies)
Working With Language-Specific Version Managers
Error Handling In Playbooks
Advanced Syntax
Lookups
Examples
Prompts
Tags
Using Vault in playbooks
Start and Step
Directives Glossary
About Modules
Introduction
Return Values
Module Maintenance & Support
Module Index
All Modules
Cloud Modules
Clustering Modules
Commands Modules
Crypto Modules
Database Modules
Files Modules
Identity Modules
Inventory Modules
Messaging Modules
Monitoring Modules
Net Tools Modules
Network Modules
Notification Modules
Packaging Modules
Remote Management Modules
Source Control Modules
Storage Modules
System Modules
Utilities Modules
Web Infrastructure Modules
Windows Modules
Ansible Vault
What Can Be Encrypted With Vault
Creating Encrypted Files
Editing Encrypted Files
Rekeying Encrypted Files
Encrypting Unencrypted Files
Decrypting Encrypted Files
Viewing Encrypted Files
Use encrypt_string to create encrypted variables to embed in yaml
Vault Ids and Multiple Vault Passwords
Providing Vault Passwords
Speeding Up Vault Operations
Vault Format
Vault Payload Format 1.1
Command Line Tools
ansible
ansible-playbook
ansible-vault
ansible-galaxy
ansible-console
ansible-config
ansible-doc
ansible-inventory
ansible-pull
Detailed Guides
Amazon Web Services Guide
Getting Started with Azure
Rackspace Cloud Guide
Google Cloud Platform Guide
CloudStack Cloud Guide
Using Vagrant and Ansible
Continuous Delivery and Rolling Upgrades
Getting Started with Docker
Using Ansible with the Packet host
Developer Information
Ansible Developer Guide
Ansible Tower
Community Information & Contributing
Ansible Users
For Current and Prospective Developers
Other Topics
Community Code of Conduct
Contributors License Agreement
Ansible Galaxy
The Website
The command line tool
Testing Strategies
Integrating Testing With Ansible Playbooks
The Right Level of Testing
Check Mode As A Drift Test
Modules That Are Useful for Testing
Testing Lifecycle
Integrating Testing With Rolling Updates
Achieving Continuous Deployment
Conclusion
Frequently Asked Questions
How can I set the PATH or any other environment variable for a task or entire playbook?
How do I handle different machines needing different user accounts or ports to log in with?
How do I get ansible to reuse connections, enable Kerberized SSH, or have Ansible pay attention to my local SSH config file?
How do I configure a jump host to access servers that I have no direct access to?
How do I speed up management inside EC2?
How do I handle python pathing not having a Python 2.X in /usr/bin/python on a remote machine?
What is the best way to make content reusable/redistributable?
Where does the configuration file live and what can I configure in it?
How do I disable cowsay?
How do I see a list of all of the ansible_ variables?
How do I see all the inventory vars defined for my host?
How do I loop over a list of hosts in a group, inside of a template?
How do I access a variable name programmatically?
How do I access a variable of the first host in a group?
How do I copy files recursively onto a target host?
How do I access shell environment variables?
How do I generate crypted passwords for the user module?
Can I get training on Ansible?
Is there a web interface / REST API / etc?
How do I submit a change to the documentation?
How do I keep secret data in my playbook?
When should I use {{ }}? Also, how to interpolate variables or dynamic variable names
Why don’t you ship in X format?
I don’t see my question here
Configuration
Common Options
Environment Variables
Glossary
YAML Syntax
YAML Basics
Gotchas
Ansible Porting Guides
Python 3 Support
Testing Python 3 with commands and playbooks
Testing Python 3 module support
What to do if an incompatibility is found
Release and maintenance
Release cycle
Release status
Development and stable version maintenance workflow
AnsibleFest
Products
Community
Webinars & Training
Blog
Ansible Documentation
Docs
»
Modules Maintained by the Ansible Network Team
Edit on GitHub
Modules Maintained by the Ansible Network Team
¶
eos_banner - Manage multiline banners on Arista EOS devices
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_logging - Manage logging on 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
eos_vrf - Manage VRFs on Arista EOS network devices
ios_banner - Manage multiline banners on Cisco IOS devices
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
ios_logging - Manage logging on network devices
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_vrf - Manage the collection of VRF definitions on Cisco IOS devices
iosxr_banner - Manage multiline banners on Cisco IOS XR devices
iosxr_command - Run commands on remote devices running Cisco IOS XR
iosxr_config - Manage Cisco IOS XR configuration sections
iosxr_facts - Collect facts from remote devices running IOS XR
iosxr_interface - Manage Interface on Cisco IOS XR network devices
iosxr_logging - Manage logging on network 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_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
junos_l3_interface - Manage L3 interfaces on Juniper JUNOS network devices
junos_linkagg - Manage link aggregation groups on Juniper JUNOS network devices
junos_lldp - Manage LLDP configuration on Juniper JUNOS network devices
junos_lldp_interface - Manage LLDP interfaces configuration on Juniper JUNOS network 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_rpc - Runs an arbitrary RPC over NetConf on an Juniper JUNOS device
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
junos_vrf - Manage the VRF definitions on Juniper JUNOS devices
net_banner - Manage multiline banners on network devices
net_interface - Manage Interface on network devices
net_l2_interface - Manage Layer-2 interface on network devices
net_l3_interface - Manage L3 interfaces on network devices
net_linkagg - Manage link aggregation groups on network devices
net_lldp - Manage LLDP service configuration on network devices
net_lldp_interface - Manage LLDP interfaces configuration on network devices
net_logging - Manage logging on network devices
net_static_route - Manage static IP routes on network devices
net_system - Manage the system attributes on network devices
net_user - Manage the aggregate of local users on network device
net_vlan - Manage VLANs on network devices
net_vrf - Manage VRFs on network devices
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_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 over SCP.
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 image and kickstart image.
nxos_interface - Manages physical attributes of interfaces.
nxos_interface_ospf - Manages configuration of an OSPF interface instance.
nxos_ip_interface - Manages L3 attributes for IPv4 and IPv6 interfaces.
nxos_logging - Manage logging on network devices
nxos_mtu **(D)** - Manages MTU settings on Nexus switch.
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_ping - Tests reachability using ping from Nexus switch.
nxos_portchannel - Manages port-channel interfaces.
nxos_reboot - Reboot a network device.
nxos_rollback - Set a checkpoint or rollback to a checkpoint.
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_switchport - Manages Layer 2 switchport interfaces.
nxos_system - Manage the system attributes on Cisco NXOS devices
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.
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)
openvswitch_bridge - Manage Open vSwitch bridges
openvswitch_db - Configure open vswitch database.
openvswitch_port - Manage Open vSwitch ports
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 - Collect facts from remote devices running VyOS
vyos_interface - Manage Interface on VyOS network devices
vyos_l3_interface - Manage L3 interfaces on VyOS network devices
vyos_linkagg - Manage link aggregation groups on VyOS network devices
vyos_lldp - Manage LLDP configuration on VyOS network devices
vyos_lldp_interface - Manage LLDP interfaces configuration on VyOS network devices
vyos_logging - Manage logging on network devices
vyos_static_route - Manage static IP routes on Cisco VyOS network devices
vyos_system - Run `set system` commands on VyOS devices
vyos_user - Manage the collection of local users on VyOS device
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.