ios

40Modules176Plugins1Dependency

Overview

Description

Ansible Network Collection for Cisco IOS devices.

Readme

Cisco IOS Collection

CI Codecov CI

The Ansible Cisco IOS collection includes a variety of Ansible content to help automate the management of Cisco IOS and Cisco IOS XE network appliances.

This collection has been tested against Cisco IOS XE Version 17.3 on CML.

Support

As a Red Hat Ansible Certified Content, this collection is entitled to support through Ansible Automation Platform (AAP).

If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there is community support available at no charge.

You can join us on #network:ansible.com room or the Ansible Forum Network Working Group.

For more information you can check the communication section below.

Communication

For more information about communication, see the Ansible communication guide.

Ansible version compatibility

This collection has been tested against the following Ansible versions: >=2.16.0.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Supported connections

The Cisco IOS collection supports network_cli connections. A detailed platform guide can be found here.

Included content

Cliconf plugins

NameDescription
cisco.ios.iosUse ios cliconf to run command on Cisco IOS platform

Modules

NameDescription
cisco.ios.ios_acl_interfacesResource module to configure ACL interfaces.
cisco.ios.ios_aclsResource module to configure ACLs.
cisco.ios.ios_bannerModule to configure multiline banners.
cisco.ios.ios_bgp_address_familyResource module to configure BGP Address family.
cisco.ios.ios_bgp_globalResource module to configure BGP.
cisco.ios.ios_commandModule to run commands on remote devices.
cisco.ios.ios_configModule to manage configuration sections.
cisco.ios.ios_evpn_ethernetResource module to configure L2VPN EVPN Ethernet Segment.
cisco.ios.ios_evpn_eviResource module to configure L2VPN EVPN EVI.
cisco.ios.ios_evpn_globalResource module to configure L2VPN EVPN.
cisco.ios.ios_factsModule to collect facts from remote devices.
cisco.ios.ios_hostnameResource module to configure hostname.
cisco.ios.ios_hsrp_interfacesResource module to configure HSRP on interfaces.
cisco.ios.ios_interfacesResource module to configure interfaces.
cisco.ios.ios_l2_interfacesResource module to configure L2 interfaces.
cisco.ios.ios_l3_interfacesResource module to configure L3 interfaces.
cisco.ios.ios_lacpResource module to configure LACP.
cisco.ios.ios_lacp_interfacesResource module to configure LACP interfaces.
cisco.ios.ios_lag_interfacesResource module to configure LAG interfaces.
cisco.ios.ios_lldp_globalResource module to configure LLDP.
cisco.ios.ios_lldp_interfacesResource module to configure LLDP interfaces.
cisco.ios.ios_logging_globalResource module to configure logging.
cisco.ios.ios_ntp_globalResource module to configure NTP.
cisco.ios.ios_ospf_interfacesResource module to configure OSPF interfaces.
cisco.ios.ios_ospfv2Resource module to configure OSPFv2.
cisco.ios.ios_ospfv3Resource module to configure OSPFv3.
cisco.ios.ios_pingTests reachability using ping from IOS switch.
cisco.ios.ios_prefix_listsResource module to configure prefix lists.
cisco.ios.ios_route_mapsResource module to configure route maps.
cisco.ios.ios_serviceResource module to configure service.
cisco.ios.ios_snmp_serverResource module to configure snmp server.
cisco.ios.ios_static_routesResource module to configure static routes.
cisco.ios.ios_systemModule to manage the system attributes.
cisco.ios.ios_userModule to manage the aggregates of local users.
cisco.ios.ios_vlansResource module to configure VLANs.
cisco.ios.ios_vrfModule to configure VRF definitions.
cisco.ios.ios_vrf_address_familyResource module to configure VRF definitions.
cisco.ios.ios_vrf_globalResource module to configure global VRF definitions.
cisco.ios.ios_vrf_interfacesManages VRF configuration on interfaces.
cisco.ios.ios_vxlan_vtepResource module to configure VXLAN VTEP interface.

Installing this collection

You can install the Cisco IOS collection with the Ansible Galaxy CLI:

ansible-galaxy collection install cisco.ios

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: cisco.ios

Using this collection

This collection includes network resource modules.

Using modules from the Cisco IOS collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as cisco.ios.ios_l2_interfaces. The following example task replaces configuration changes in the existing configuration on a Cisco IOS network device, using the FQCN:

---
- name: Replace device configuration of specified L2 interfaces with provided configuration.
  cisco.ios.ios_l2_interfaces:
    config:
      - name: GigabitEthernet0/2
        trunk:
          - allowed_vlans: 20-25,40
            native_vlan: 20
            pruning_vlans: 10
            encapsulation: isl
    state: replaced

NOTE: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.

See Also:

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Cisco IOS collection repository. See Contributing to Ansible-maintained collections for complete details.

You can also join us on:

  • IRC - the #ansible-network libera.chat channel
  • Slack - https://ansiblenetwork.slack.com

See the Ansible Community Guide for details on contributing to Ansible.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

Release notes

Release notes are available here.

More information

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.

Certification

Product
Red Hat Ansible Automation Platform 2.4
Red Hat Ansible Automation Platform 2.5
DocumentationDependencies

This collection requires the following collections for use:

NameSummary

This collection is used by the following collections:

NameSummaryVersionType
View in Automation Hub
Red Hat logoLinkedInYouTubeFacebookTwitter

Platforms

Products & services

Try, buy, sell

Help

About Red Hat Ecosystem Catalog

The Red Hat Ecosystem Catalog is the official source for discovering and learning more about the Red Hat Ecosystem of both Red Hat and certified third-party products and services.

We’re the world’s leading provider of enterprise open source solutions—including Linux, cloud, container, and Kubernetes. We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2025 Red Hat