AnsibleFest
Products
Community
Webinars & Training
Blog
Documentation
ANSIBLE
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
Playbook Roles and Include Statements
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
Vault
Start and Step
Directives Glossary
About Modules
Introduction
Return Values
Module 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
Network Modules
Notification Modules
Packaging Modules
Remote Management Modules
Source Control Modules
Storage Modules
System Modules
Utilities Modules
Web Infrastructure Modules
Windows Modules
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
Glossary
YAML Syntax
YAML Basics
Gotchas
Porting Guide
Playbook
Porting plugins
Hybrid plugins
Porting custom scripts
Python 3 Support
Testing Python 3 with commands and playbooks
Testing Python 3 module support
AnsibleFest
Products
Community
Webinars & Training
Blog
Ansible Documentation
Docs
»
Network Modules
Network Modules
¶
cloudflare_dns - manage Cloudflare DNS records
dnsimple - Interface with dnsimple.com (a DNS hosting service).
dnsmadeeasy - Interface with dnsmadeeasy.com (a DNS hosting service).
haproxy - Enable, disable, and set weights for HAProxy backend servers using socket commands.
ipify_facts - Retrieve the public IP of your internet gateway.
ipinfoio_facts - Retrieve IP geolocation facts of a host’s IP address
ldap_attr - Add or remove LDAP attribute values.
ldap_entry - Add or remove LDAP entries.
lldp - get details reported by lldp
nmcli - Manage Networking
nsupdate - Manage DNS records.
omapi_host - Setup OMAPI hosts.
snmp_facts - Retrieve facts for a device using SNMP.
A10
¶
a10_server - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ server object.
a10_server_axapi3 - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices
a10_service_group - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ service groups.
a10_virtual_server - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ virtual servers.
Aos
¶
aos_asn_pool - Manage AOS ASN Pool
aos_blueprint - Manage AOS blueprint instance
aos_blueprint_param - Manage AOS blueprint parameter values
aos_blueprint_virtnet - Manage AOS blueprint parameter values
aos_device - Manage Devices on AOS Server
aos_external_router - Manage AOS External Router
aos_ip_pool - Manage AOS IP Pool
aos_logical_device - Manage AOS Logical Device
aos_logical_device_map - Manage AOS Logical Device Map
aos_login - Login to AOS server for session token
aos_rack_type - Manage AOS Rack Type
aos_template - Manage AOS Template
Asa
¶
asa_acl - Manage access-lists on a Cisco ASA
asa_command - Run arbitrary commands on Cisco ASA devices
asa_config - Manage configuration sections on Cisco ASA devices
Avi
¶
avi_analyticsprofile - Module for setup of AnalyticsProfile Avi RESTful Object
avi_api_session - Avi API Module
avi_applicationpersistenceprofile - Module for setup of ApplicationPersistenceProfile Avi RESTful Object
avi_applicationprofile - Module for setup of ApplicationProfile Avi RESTful Object
avi_certificatemanagementprofile - Module for setup of CertificateManagementProfile Avi RESTful Object
avi_healthmonitor - Module for setup of HealthMonitor Avi RESTful Object
avi_networkprofile - Module for setup of NetworkProfile Avi RESTful Object
avi_pkiprofile - Module for setup of PKIProfile Avi RESTful Object
avi_pool - Module for setup of Pool Avi RESTful Object
avi_poolgroup - Module for setup of PoolGroup Avi RESTful Object
avi_role - Module for setup of Role Avi RESTful Object
avi_sslkeyandcertificate - Module for setup of SSLKeyAndCertificate Avi RESTful Object
avi_sslprofile - Module for setup of SSLProfile Avi RESTful Object
avi_systemconfiguration - Module for setup of SystemConfiguration Avi RESTful Object
avi_tenant - Module for setup of Tenant Avi RESTful Object
avi_virtualservice - Module for setup of VirtualService Avi RESTful Object
Basics
¶
get_url - Downloads files from HTTP, HTTPS, or FTP to node
slurp - Slurps a file from remote nodes
uri - Interacts with webservices
Bigswitch
¶
bigmon_chain - Create and remove a bigmon inline service chain.
bigmon_policy - Create and remove a bigmon out-of-band policy.
Citrix
¶
netscaler - Manages Citrix NetScaler entities
Cloudengine
¶
ce_command - Run arbitrary command on HUAWEI CloudEngine devices
Cumulus
¶
cl_bond (D) - Configures a bond port on Cumulus Linux
cl_bridge (D) - Configures a bridge port on Cumulus Linux
cl_img_install (D) - Install a different Cumulus Linux version.
cl_interface (D) - Configures a front panel port, loopback or management port on Cumulus Linux.
cl_interface_policy (D) - Configure interface enforcement policy on Cumulus Linux
cl_license (D) - Install licenses fo Cumulus Linux
cl_ports (D) - Configure Cumulus Switch port attributes (ports.conf)
nclu - Configure network interfaces using NCLU
Dellos10
¶
dellos10_command - Run commands on remote devices running Dell OS10
dellos10_config - Manage Dell EMC Networking OS10 configuration sections
dellos10_facts - Collect facts from remote devices running Dell EMC Networking OS10
Dellos6
¶
dellos6_command - Run commands on remote devices running Dell OS6
dellos6_config - Manage Dell EMC Networking OS6 configuration sections
dellos6_facts - Collect facts from remote devices running Dell EMC Networking OS6
Dellos9
¶
dellos9_command - Run commands on remote devices running Dell OS9
dellos9_config - Manage Dell EMC Networking OS9 configuration sections
dellos9_facts - Collect facts from remote devices running Dell EMC Networking OS9
Eos
¶
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_system - Manage the system attributes on Arista EOS devices
eos_template (D) - Manage Arista EOS device configurations
eos_user - Manage the collection of local users on EOS devices
Exoscale
¶
exo_dns_domain - Manages domain records on Exoscale DNS API.
exo_dns_record - Manages DNS records on Exoscale DNS.
F5
¶
bigip_device_dns - Manage BIG-IP device DNS settings
bigip_device_ntp - Manage NTP servers on a BIG-IP
bigip_device_sshd - Manage the SSHD settings of a BIG-IP
bigip_facts - Collect facts from F5 BIG-IP devices
bigip_gtm_datacenter - Manage Datacenter configuration in BIG-IP
bigip_gtm_facts - Collect facts from F5 BIG-IP GTM devices.
bigip_gtm_virtual_server - Manages F5 BIG-IP GTM virtual servers
bigip_gtm_wide_ip - Manages F5 BIG-IP GTM wide ip
bigip_hostname - Manage the hostname of a BIG-IP.
bigip_irule - Manage iRules across different modules on a BIG-IP.
bigip_monitor_http - Manages F5 BIG-IP LTM http monitors
bigip_monitor_tcp - Manages F5 BIG-IP LTM tcp monitors
bigip_node - Manages F5 BIG-IP LTM nodes
bigip_pool - Manages F5 BIG-IP LTM pools
bigip_pool_member - Manages F5 BIG-IP LTM pool members
bigip_routedomain - Manage route domains on a BIG-IP
bigip_selfip - Manage Self-IPs on a BIG-IP system
bigip_snat_pool - Manage SNAT pools on a BIG-IP.
bigip_ssl_certificate - Import/Delete certificates from BIG-IP
bigip_sys_db - Manage BIG-IP system database variables
bigip_sys_global - Manage BIG-IP global settings.
bigip_virtual_server - Manages F5 BIG-IP LTM virtual servers
bigip_vlan - Manage VLANs on a BIG-IP system
Fortios
¶
fortios_config - Manage config on Fortinet FortiOS firewall devices
fortios_ipv4_policy - Manage IPv4 policy objects on Fortinet FortiOS firewall devices
Illumos
¶
dladm_etherstub - Manage etherstubs on Solaris/illumos systems.
dladm_iptun - Manage IP tunnel interfaces on Solaris/illumos systems.
dladm_linkprop - Manage link properties on Solaris/illumos systems.
dladm_vlan - Manage VLAN interfaces on Solaris/illumos systems.
dladm_vnic - Manage VNICs on Solaris/illumos systems.
flowadm - Manage bandwidth resource control and priority for protocols, services and zones on Solaris/illumos systems
ipadm_addr - Manage IP addresses on an interface on Solaris/illumos systems
ipadm_addrprop - Manage IP address properties on Solaris/illumos systems.
ipadm_if - Manage IP interfaces on Solaris/illumos systems.
ipadm_ifprop - Manage IP interface properties on Solaris/illumos systems.
ipadm_prop - Manage protocol properties on Solaris/illumos systems.
Ios
¶
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_system - Manage the system attributes on Cisco IOS devices
ios_template (D) - Manage Cisco IOS device configurations over SSH
ios_vrf - Manage the collection of VRF definitions on Cisco IOS devices
Iosxr
¶
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_system - Manage the system attributes on Cisco IOS XR devices
iosxr_template (D) - Manage Cisco IOS XR device configurations over SSH
Junos
¶
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_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_template (D) - Manage configuration on remote devices running Juniper JUNOS
junos_user - Manage local user accounts on Juniper JUNOS devices
Lenovo
¶
cnos_backup - Backup the current running or startup configuration to a remote server on devices running Lenovo CNOS
cnos_bgp - Manage BGP resources and attributes on devices running Lenovo CNOS
cnos_command - Execute a single command on devices running Lenovo CNOS
cnos_conditional_command - Execute a single command based on condition on devices running Lenovo CNOS
cnos_conditional_template - Manage switch configuration using templates based on condition on devices running Lenovo CNOS
cnos_factory - Reset the switch’s startup configuration to default (factory) on devices running Lenovo CNOS
cnos_facts - Collect facts on devices running Lenovo CNOS
cnos_image - Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS
cnos_interface - Manage interface configuration on devices running Lenovo CNOS
cnos_portchannel - Manage portchannel (port aggregation) configuration on devices running Lenovo CNOS
cnos_reload - Perform switch restart on devices running Lenovo CNOS
cnos_rollback - Roll back the running or startup configuration from a remote server on devices running Lenovo CNOS
cnos_save - Save the running configuration as the startup configuration on devices running Lenovo CNOS
cnos_showrun - Collect the current running configuration on devices running Lenovo CNOS
cnos_template - Manage switch configuration using templates on devices running Lenovo CNOS
cnos_vlag - Manage VLAG resources and attributes on devices running Lenovo CNOS
cnos_vlan - Manage VLAN resources and attributes on devices running Lenovo CNOS
Netconf
¶
netconf_config - netconf device configuration
Netvisor
¶
pn_cluster - CLI command to create/delete a cluster.
pn_ospf - CLI command to add/remove ospf protocol to a vRouter.
pn_ospfarea - CLI command to add/remove ospf area to/from a vrouter.
pn_show - Run show commands on nvOS device.
pn_trunk - CLI command to create/delete/modify a trunk.
pn_vlag - CLI command to create/delete/modify vlag.
pn_vlan - CLI command to create/delete a VLAN.
pn_vrouter - CLI command to create/delete/modify a vrouter.
pn_vrouterbgp - CLI command to add/remove/modify vrouter-bgp.
pn_vrouterif - CLI command to add/remove/modify vrouter-interface.
pn_vrouterlbif - CLI command to add/remove vrouter-loopback-interface.
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_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_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_template (D) - Manage Cisco NXOS device configurations
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)
Openswitch
¶
ops_command - Run arbitrary commands on OpenSwitch devices.
ops_config - Manage OpenSwitch configuration using CLI
ops_facts - Collect device specific facts from OpenSwitch
ops_template (D) - Push configuration to OpenSwitch
Ordnance
¶
ordnance_config - Manage Ordnance configuration sections
ordnance_facts - Collect facts from Ordnance Virtual Routers over SSH
Ovs
¶
openvswitch_bridge - Manage Open vSwitch bridges
openvswitch_db - Configure open vswitch database.
openvswitch_port - Manage Open vSwitch ports
Panos
¶
panos_address - Create address service object on PanOS devices
panos_admin - Add or modify PAN-OS user accounts password.
panos_admpwd - change admin password of PAN-OS device using SSH with SSH key
panos_cert_gen_ssh - generates a self-signed certificate using SSH protocol with SSH key
panos_check - check if PAN-OS device is ready for configuration
panos_commit - commit firewall’s candidate configuration
panos_dag - create a dynamic address group
panos_import - import file on PAN-OS devices
panos_interface - configure data-port network interface for DHCP
panos_lic - apply authcode to a device/instance
panos_loadcfg - load configuration on PAN-OS device
panos_mgtconfig - configure management settings of device
panos_nat_policy - create a policy NAT rule
panos_pg - create a security profiles group
panos_restart - restart a device
panos_security_policy - Create security rule policy on PanOS devices.
panos_service - create a service object
Sros
¶
sros_command - Run commands on remote devices running Nokia SR OS
sros_config - Manage Nokia SR OS device configuration
sros_rollback - Configure Nokia SR OS rollback
Vyos
¶
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_system - Run `set system` commands on VyOS 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.