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 IOSXR version 7.0.2.

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

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.

The Cisco IOSXR collection supports network_cli and netconf connections.

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

You can install the Cisco IOSXR 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

This collection includes network resource modules.

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.

• Cisco IOSXR Platform Options
• Ansible Using collections for more details.

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.

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

Release notes are available here.

• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

GNU General Public License v3.0 or later.

See LICENSE to see the full text.