iosxr

35Modules145Plugins1Dependency

Overview

Description

Ansible Network Collection for Cisco IOSXR devices.

Readme

Cisco IOSXR Collection

CI Codecov CI

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

This collection has been tested against Cisco IOS-XR version 7.0.2

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 following Ansible versions: >=2.16.0.

For collections that support Ansible 2.9, please ensure you update your network_os to use the fully qualified collection name (for example, cisco.ios.ios). 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-XR collection supports network_cli and netconf connections. A detailed platform guide can be found here.

Included content

Cliconf plugins

NameDescription
cisco.iosxr.iosxrUse iosxr cliconf to run command on Cisco IOS XR platform

Netconf plugins

NameDescription
cisco.iosxr.iosxrUse iosxr netconf plugin to run netconf commands on Cisco IOSXR platform

Modules

NameDescription
cisco.iosxr.iosxr_acl_interfacesResource module to configure ACL interfaces.
cisco.iosxr.iosxr_aclsResource module to configure ACLs.
cisco.iosxr.iosxr_bannerModule to configure multiline banners.
cisco.iosxr.iosxr_bgp_address_familyResource module to configure BGP Address family.
cisco.iosxr.iosxr_bgp_globalResource module to configure BGP.
cisco.iosxr.iosxr_bgp_neighbor_address_familyResource module to configure BGP Neighbor Address family.
cisco.iosxr.iosxr_bgp_templatesManages BGP templates resource module.
cisco.iosxr.iosxr_commandModule to run commands on remote devices.
cisco.iosxr.iosxr_configModule to manage configuration sections.
cisco.iosxr.iosxr_factsModule to collect facts from remote devices.
cisco.iosxr.iosxr_hostnameResource module to configure hostname.
cisco.iosxr.iosxr_interfacesResource module to configure interfaces.
cisco.iosxr.iosxr_l2_interfacesResource Module to configure L2 interfaces.
cisco.iosxr.iosxr_l3_interfacesResource module to configure L3 interfaces.
cisco.iosxr.iosxr_lacpResource module to configure LACP.
cisco.iosxr.iosxr_lacp_interfacesResource module to configure LACP interfaces.
cisco.iosxr.iosxr_lag_interfacesResource module to configure LAG interfaces.
cisco.iosxr.iosxr_lldp_globalResource module to configure LLDP.
cisco.iosxr.iosxr_lldp_interfacesResource module to configure LLDP interfaces.
cisco.iosxr.iosxr_logging_globalResource module to configure logging.
cisco.iosxr.iosxr_netconfConfigures NetConf sub-system service on Cisco IOS-XR devices
cisco.iosxr.iosxr_ntp_globalResource module to configure NTP.
cisco.iosxr.iosxr_ospf_interfacesResource module to configure OSPF interfaces.
cisco.iosxr.iosxr_ospfv2Resource module to configure OSPFv2.
cisco.iosxr.iosxr_ospfv3Resource module to configure OSPFv3.
cisco.iosxr.iosxr_pingTests reachability using ping from IOSXR switch.
cisco.iosxr.iosxr_prefix_listsResource module to configure prefix lists.
cisco.iosxr.iosxr_route_mapsResource module to configure route maps.
cisco.iosxr.iosxr_snmp_serverResource module to configure snmp server.
cisco.iosxr.iosxr_static_routesResource module to configure static routes.
cisco.iosxr.iosxr_systemModule to manage the system attributes.
cisco.iosxr.iosxr_userModule to manage the aggregates of local users.
cisco.iosxr.iosxr_vrf_address_familyResource module to configure VRF Address family.
cisco.iosxr.iosxr_vrf_globalManages global VRF configuration.
cisco.iosxr.iosxr_vrf_interfacesResource module to configure VRF interfaces.

Click the Content button to see the list of content included in this collection.

Installing this collection

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

ansible-galaxy collection install cisco.iosxr

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.iosxr

Using this collection

This collection includes network resource modules.

Using modules from the Cisco IOSXR collection in your playbooks

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

---
 - name: Replace device configuration of specified L2 interfaces with provided configuration.
   cisco.iosxr.iosxr_l2_interfaces:
     config:
       - name: GigabitEthernet0/0/0/4
         native_vlan: 40
         l2transport: True
         l2protocol:
         - stp: forward
       - name: GigabitEthernet0/0/0/3.900
         q_vlan:
         - 20
         - any
     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 IOSXR 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.

Roadmap

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