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
»
Network Modules
Network Modules
¶
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.
Aci
¶
aci_aep - Manage attachable Access Entity Profile (AEP) on Cisco ACI fabrics (infra:AttEntityP)
aci_ap - Manage top level Application Profile (AP) objects on Cisco ACI fabrics (fv:Ap)
aci_bd - Manage Bridge Domains (BD) on Cisco ACI Fabrics (fv:BD)
aci_bd_subnet - Manage Subnets on Cisco ACI fabrics (fv:Subnet)
aci_bd_to_l3out - Bind Bridge Domain to L3 Out on Cisco ACI fabrics (fv:RsBDToOut)
aci_config_rollback - Provides rollback and rollback preview functionality for Cisco ACI fabrics (config:ImportP)
aci_config_snapshot - Manage Config Snapshots on Cisco ACI fabrics (config:Snapshot, config:ExportP)
aci_contract - Manage contract resources on Cisco ACI fabrics (vz:BrCP)
aci_contract_subject - Manage initial Contract Subjects on Cisco ACI fabrics (vz:Subj)
aci_contract_subject_to_filter - Bind Contract Subjects to Filters on Cisco ACI fabrics (vz:RsSubjFiltAtt)
aci_epg - Manage End Point Groups (EPG) on Cisco ACI fabrics (fv:AEPg)
aci_epg_monitoring_policy - Manage monitoring policies on Cisco ACI fabrics (mon:EPGPol)
aci_epg_to_contract - Bind EPGs to Contracts on Cisco ACI fabrics (fv:RsCons and fv:RsProv)
aci_epg_to_domain - Bind EPGs to Domains on Cisco ACI fabrics (fv:RsDomAtt)
aci_filter - Manages top level filter objects on Cisco ACI fabrics (vz:Filter)
aci_filter_entry - Manage filter entries on Cisco ACI fabrics (vz:Entry)
aci_intf_policy_fc - Manage Fibre Channel interface policies on Cisco ACI fabrics (fc:IfPol)
aci_intf_policy_l2 - Manage Layer 2 interface policies on Cisco ACI fabrics (l2:IfPol)
aci_intf_policy_lldp - Manage LLDP interface policies on Cisco ACI fabrics (lldp:IfPol)
aci_intf_policy_mcp - Manage MCP interface policies on Cisco ACI fabrics (mcp:IfPol)
aci_intf_policy_port_channel - Manage port channel interface policies on Cisco ACI fabrics (lacp:LagPol)
aci_intf_policy_port_security - Manage port security on Cisco ACI fabrics (l2:PortSecurityPol)
aci_l3out_route_tag_policy - Manage route tag policies on Cisco ACI fabrics (l3ext:RouteTagPol)
aci_rest - Direct access to the Cisco APIC REST API
aci_taboo_contract - Manage taboo contracts on Cisco ACI fabrics (vz:BrCP)
aci_tenant - Manage tenants on Cisco ACI fabrics (fv:Tenant)
aci_tenant_action_rule_profile - Manage action rule profiles on Cisco ACI fabrics (rtctrl:AttrP)
aci_tenant_ep_retention_policy - Manage End Point (EP) retention protocol policies on Cisco ACI fabrics (fv:EpRetPol)
aci_tenant_span_dst_group - Manage SPAN destination groups on Cisco ACI fabrics (span:DestGrp)
aci_tenant_span_src_group - Manage SPAN source groups on Cisco ACI fabrics (span:SrcGrp)
aci_tenant_span_src_group_to_dst_group - Manage SPAN source group to destination group bindings on Cisco ACI fabrics (span:SpanLbl)
aci_vrf - Manage VRF (private networks aka. contexts) on Cisco ACI fabrics (fv:Ctx)
Aireos
¶
aireos_command - Run commands on remote devices running Cisco WLC
aireos_config - Manage Cisco WLC configurations
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
Aruba
¶
aruba_command - Run commands on remote devices running Aruba Mobility Controller
aruba_config - Manage Aruba configuration sections
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_actiongroupconfig - Module for setup of ActionGroupConfig Avi RESTful Object
avi_alertconfig - Module for setup of AlertConfig Avi RESTful Object
avi_alertemailconfig - Module for setup of AlertEmailConfig Avi RESTful Object
avi_alertscriptconfig - Module for setup of AlertScriptConfig Avi RESTful Object
avi_alertsyslogconfig - Module for setup of AlertSyslogConfig Avi RESTful Object
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_authprofile - Module for setup of AuthProfile Avi RESTful Object
avi_backup - Module for setup of Backup Avi RESTful Object
avi_backupconfiguration - Module for setup of BackupConfiguration Avi RESTful Object
avi_certificatemanagementprofile - Module for setup of CertificateManagementProfile Avi RESTful Object
avi_cloud - Module for setup of Cloud Avi RESTful Object
avi_cloudconnectoruser - Module for setup of CloudConnectorUser Avi RESTful Object
avi_cloudproperties - Module for setup of CloudProperties Avi RESTful Object
avi_cluster - Module for setup of Cluster Avi RESTful Object
avi_controllerproperties - Module for setup of ControllerProperties Avi RESTful Object
avi_dnspolicy - Module for setup of DnsPolicy Avi RESTful Object
avi_gslb - Module for setup of Gslb Avi RESTful Object
avi_gslbapplicationpersistenceprofile - Module for setup of GslbApplicationPersistenceProfile Avi RESTful Object
avi_gslbgeodbprofile - Module for setup of GslbGeoDbProfile Avi RESTful Object
avi_gslbhealthmonitor - Module for setup of GslbHealthMonitor Avi RESTful Object
avi_gslbservice - Module for setup of GslbService Avi RESTful Object
avi_hardwaresecuritymodulegroup - Module for setup of HardwareSecurityModuleGroup Avi RESTful Object
avi_healthmonitor - Module for setup of HealthMonitor Avi RESTful Object
avi_httppolicyset - Module for setup of HTTPPolicySet Avi RESTful Object
avi_ipaddrgroup - Module for setup of IpAddrGroup Avi RESTful Object
avi_ipamdnsproviderprofile - Module for setup of IpamDnsProviderProfile Avi RESTful Object
avi_microservicegroup - Module for setup of MicroServiceGroup Avi RESTful Object
avi_network - Module for setup of Network Avi RESTful Object
avi_networkprofile - Module for setup of NetworkProfile Avi RESTful Object
avi_networksecuritypolicy - Module for setup of NetworkSecurityPolicy 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_poolgroupdeploymentpolicy - Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object
avi_prioritylabels - Module for setup of PriorityLabels Avi RESTful Object
avi_role - Module for setup of Role Avi RESTful Object
avi_scheduler - Module for setup of Scheduler Avi RESTful Object
avi_seproperties - Module for setup of SeProperties Avi RESTful Object
avi_serverautoscalepolicy - Module for setup of ServerAutoScalePolicy Avi RESTful Object
avi_serviceengine - Module for setup of ServiceEngine Avi RESTful Object
avi_serviceenginegroup - Module for setup of ServiceEngineGroup Avi RESTful Object
avi_snmptrapprofile - Module for setup of SnmpTrapProfile Avi RESTful Object
avi_sslkeyandcertificate - Module for setup of SSLKeyAndCertificate Avi RESTful Object
avi_sslprofile - Module for setup of SSLProfile Avi RESTful Object
avi_stringgroup - Module for setup of StringGroup Avi RESTful Object
avi_systemconfiguration - Module for setup of SystemConfiguration Avi RESTful Object
avi_tenant - Module for setup of Tenant Avi RESTful Object
avi_trafficcloneprofile - Module for setup of TrafficCloneProfile Avi RESTful Object
avi_useraccountprofile - Module for setup of UserAccountProfile Avi RESTful Object
avi_virtualservice - Module for setup of VirtualService Avi RESTful Object
avi_vrfcontext - Module for setup of VrfContext Avi RESTful Object
avi_vsdatascriptset - Module for setup of VSDataScriptSet Avi RESTful Object
avi_vsvip - Module for setup of VsVip Avi RESTful Object
avi_webhook - Module for setup of Webhook Avi RESTful Object
Bigswitch
¶
bcf_switch - Create and remove a bcf switch.
bigmon_chain - Create and remove a bigmon inline service chain.
bigmon_policy - Create and remove a bigmon out-of-band policy.
Citrix
¶
netscaler **(D)** - Manages Citrix NetScaler entities
Cloudengine
¶
ce_aaa_server - Manages AAA server global configuration on HUAWEI CloudEngine switches.
ce_aaa_server_host - Manages AAA server host configuration on HUAWEI CloudEngine switches.
ce_acl - Manages base ACL configuration on HUAWEI CloudEngine switches.
ce_acl_advance - Manages advanced ACL configuration on HUAWEI CloudEngine switches.
ce_acl_interface - Manages applying ACLs to interfaces on HUAWEI CloudEngine switches.
ce_bfd_global - Manages BFD global configuration on HUAWEI CloudEngine devices.
ce_bfd_session - Manages BFD session configuration on HUAWEI CloudEngine devices.
ce_bfd_view - Manages BFD session view configuration on HUAWEI CloudEngine devices.
ce_bgp - Manages BGP configuration on HUAWEI CloudEngine switches.
ce_bgp_af - Manages BGP Address-family configuration on HUAWEI CloudEngine switches.
ce_bgp_neighbor - Manages BGP peer configuration on HUAWEI CloudEngine switches.
ce_bgp_neighbor_af - Manages BGP neighbor Address-family configuration on HUAWEI CloudEngine switches.
ce_command - Run arbitrary command on HUAWEI CloudEngine devices.
ce_config - Manage Huawei CloudEngine configuration sections.
ce_dldp - Manages global DLDP configuration on HUAWEI CloudEngine switches.
ce_dldp_interface - Manages interface DLDP configuration on HUAWEI CloudEngine switches.
ce_eth_trunk - Manages Eth-Trunk interfaces on HUAWEI CloudEngine switches.
ce_evpn_bd_vni - Manages EVPN VXLAN Network Identifier (VNI) on HUAWEI CloudEngine switches.
ce_evpn_bgp - Manages BGP EVPN configuration on HUAWEI CloudEngine switches.
ce_evpn_bgp_rr - Manages RR for the VXLAN Network on HUAWEI CloudEngine switches.
ce_evpn_global - Manages global configuration of EVPN on HUAWEI CloudEngine switches.
ce_facts - Gets facts about HUAWEI CloudEngine switches.
ce_file_copy - Copy a file to a remote cloudengine device over SCP on HUAWEI CloudEngine switches.
ce_info_center_debug - Manages information center debug configuration on HUAWEI CloudEngine switches.
ce_info_center_global - Manages outputting logs on HUAWEI CloudEngine switches.
ce_info_center_log - Manages information center log configuration on HUAWEI CloudEngine switches.
ce_info_center_trap - Manages information center trap configuration on HUAWEI CloudEngine switches.
ce_interface - Manages physical attributes of interfaces on HUAWEI CloudEngine switches.
ce_interface_ospf - Manages configuration of an OSPF interface instanceon HUAWEI CloudEngine switches.
ce_ip_interface - Manages L3 attributes for IPv4 and IPv6 interfaces on HUAWEI CloudEngine switches.
ce_link_status - Get interface link status on HUAWEI CloudEngine switches.
ce_mlag_config - Manages MLAG configuration on HUAWEI CloudEngine switches.
ce_mlag_interface - Manages MLAG interfaces on HUAWEI CloudEngine switches.
ce_mtu - Manages MTU settings on HUAWEI CloudEngine switches.
ce_netconf - Run an arbitrary netconf command on HUAWEI CloudEngine switches.
ce_netstream_aging - Manages timeout mode of NetStream on HUAWEI CloudEngine switches.
ce_netstream_export - Manages netstream export on HUAWEI CloudEngine switches.
ce_netstream_global - Manages global parameters of NetStream on HUAWEI CloudEngine switches.
ce_netstream_template - Manages NetStream template configuration on HUAWEI CloudEngine switches.
ce_ntp - Manages core NTP configuration on HUAWEI CloudEngine switches.
ce_ntp_auth - Manages NTP authentication configuration on HUAWEI CloudEngine switches.
ce_ospf - Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.
ce_ospf_vrf - Manages configuration of an OSPF VPN instance on HUAWEI CloudEngine switches.
ce_reboot - Reboot a HUAWEI CloudEngine switches.
ce_rollback - Set a checkpoint or rollback to a checkpoint on HUAWEI CloudEngine switches.
ce_sflow - Manages sFlow configuration on HUAWEI CloudEngine switches.
ce_snmp_community - Manages SNMP community configuration on HUAWEI CloudEngine switches.
ce_snmp_contact - Manages SNMP contact configuration on HUAWEI CloudEngine switches.
ce_snmp_location - Manages SNMP location configuration on HUAWEI CloudEngine switches.
ce_snmp_target_host - Manages SNMP target host configuration on HUAWEI CloudEngine switches.
ce_snmp_traps - Manages SNMP traps configuration on HUAWEI CloudEngine switches.
ce_snmp_user - Manages SNMP user configuration on HUAWEI CloudEngine switches.
ce_startup - Manages a system startup information on HUAWEI CloudEngine switches.
ce_static_route - Manages static route configuration on HUAWEI CloudEngine switches.
ce_stp - Manages STP configuration on HUAWEI CloudEngine switches.
ce_switchport - Manages Layer 2 switchport interfaces on HUAWEI CloudEngine switches.
ce_vlan - Manages VLAN resources and attributes on Huawei CloudEngine switches.
ce_vrf - Manages VPN instance on HUAWEI CloudEngine switches.
ce_vrf_af - Manages VPN instance address family on HUAWEI CloudEngine switches.
ce_vrf_interface - Manages interface specific VPN configuration on HUAWEI CloudEngine switches.
ce_vrrp - Manages VRRP interfaces on HUAWEI CloudEngine devices.
ce_vxlan_arp - Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices.
ce_vxlan_gateway - Manages gateway for the VXLAN network on HUAWEI CloudEngine devices.
ce_vxlan_global - Manages global attributes of VXLAN and bridge domain on HUAWEI CloudEngine devices.
ce_vxlan_tunnel - Manages VXLAN tunnel configuration on HUAWEI CloudEngine devices.
ce_vxlan_vap - Manages VXLAN virtual access point on HUAWEI CloudEngine Devices.
Cloudvision
¶
cv_server_provision - Provision server port by applying or removing template configuration to an Arista CloudVision Portal configlet that is applied to a switch.
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_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
F5
¶
bigip_command - Run arbitrary command on F5 devices.
bigip_config - Manage BIG-IP configuration sections.
bigip_configsync_actions - Perform different actions related to config-sync.
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_pool - Manages F5 BIG-IP GTM pools.
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_iapp_service - Manages TCL iApp services on a BIG-IP.
bigip_iapp_template - Manages TCL iApp templates on 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_monitor_tcp_echo - Manages F5 BIG-IP LTM tcp monitors.
bigip_monitor_tcp_half_open - 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_provision - Manage BIG-IP module provisioning.
bigip_qkview - Manage qkviews on the device.
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_snmp - Manipulate general SNMP settings on a BIG-IP.
bigip_snmp_trap - Manipulate SNMP trap information 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_ucs - Manage upload, installation and removal of UCS files.
bigip_user - Manage user accounts and user attributes on a BIG-IP.
bigip_virtual_address - Manage LTM virtual addresses on a BIG-IP.
bigip_virtual_server - Manages F5 BIG-IP LTM virtual servers
bigip_vlan - Manage VLANs on a BIG-IP system
Fortios
¶
fortios_address - Manage fortios firewall address objects
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.
Interface
¶
net_interface - Manage Interface on network devices
net_linkagg - Manage link aggregation groups on network devices
net_lldp_interface - Manage LLDP interfaces configuration on network devices
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_interface - Manage Interface on Cisco IOS network devices
ios_logging - Manage logging on network devices
ios_ping - Tests reachability using ping from IOS switch
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
¶
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
¶
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
Layer2
¶
net_l2_interface - Manage Layer-2 interface on network devices
net_vlan - Manage VLANs on network devices
Layer3
¶
net_l3_interface - Manage L3 interfaces on network devices
net_vrf - Manage VRFs on network 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
Netscaler
¶
netscaler_cs_action - Manage content switching actions
netscaler_cs_policy - Manage content switching policy
netscaler_cs_vserver - Manage content switching vserver
netscaler_gslb_service - Manage gslb service entities in Netscaler.
netscaler_gslb_site - Manage gslb site entities in Netscaler.
netscaler_gslb_vserver - Configure gslb vserver entities in Netscaler.
netscaler_lb_monitor - Manage load balancing monitors
netscaler_lb_vserver - Manage load balancing vserver configuration
netscaler_save_config - Save Netscaler configuration.
netscaler_server - Manage server configuration
netscaler_service - Manage service configuration in Netscaler
netscaler_servicegroup - Manage service group configuration in Netscaler
netscaler_ssl_certkey - Manage ssl cerificate keys.
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.
Nuage
¶
nuage_vspk - Manage Nuage VSP environments
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_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)
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_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_nat_rule - create a policy NAT rule
panos_object - create/read/update/delete object in PAN-OS or Panorama
panos_pg - create a security profiles group
panos_restart - restart a device
panos_sag - Create a static address group.
panos_security_policy - Create security rule policy on PanOS devices.
panos_security_rule - Create security rule policy on PAN-OS devices or Panorama management console.
Protocol
¶
net_lldp - Manage LLDP service configuration on network devices
Radware
¶
vdirect_file - Uploads a new or updates an existing runnable file into Radware vDirect server
Routing
¶
net_static_route - Manage static IP routes on network devices
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
System
¶
net_banner - Manage multiline banners on network devices
net_logging - Manage logging on network devices
net_ping - Tests reachability using ping from a network device
net_system - Manage the system attributes on network devices
net_user - Manage the aggregate of local users on network device
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 - 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.