Cisco IOSXR Collection

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

Ansible version compatibility

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

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 IOSXR collection supports network_cli and netconf connections.

Included content

Cliconf plugins

Name	Description
cisco.iosxr.iosxr	Use iosxr cliconf to run command on Cisco IOS XR platform

Netconf plugins

Name	Description
cisco.iosxr.iosxr	Use iosxr netconf plugin to run netconf commands on Cisco IOSXR platform

Modules

Name	Description
cisco.iosxr.iosxr_acl_interfaces	ACL interfaces resource module
cisco.iosxr.iosxr_acls	ACLs resource module
cisco.iosxr.iosxr_banner	Manage multiline banners on Cisco IOS XR devices
cisco.iosxr.iosxr_bgp	Configure global BGP protocol settings on Cisco IOS-XR
cisco.iosxr.iosxr_command	Run commands on remote devices running Cisco IOS XR
cisco.iosxr.iosxr_config	Manage Cisco IOS XR configuration sections
cisco.iosxr.iosxr_facts	Get facts about iosxr devices.
cisco.iosxr.iosxr_interface	(deprecated, removed after 2022-06-01) Manage Interface on Cisco IOS XR network devices
cisco.iosxr.iosxr_interfaces	Interfaces resource module
cisco.iosxr.iosxr_l2_interfaces	L2 interfaces resource module
cisco.iosxr.iosxr_l3_interfaces	L3 interfaces resource module
cisco.iosxr.iosxr_lacp	LACP resource module
cisco.iosxr.iosxr_lacp_interfaces	LACP interfaces resource module
cisco.iosxr.iosxr_lag_interfaces	LAG interfaces resource module
cisco.iosxr.iosxr_lldp_global	LLDP resource module
cisco.iosxr.iosxr_lldp_interfaces	LLDP interfaces resource module
cisco.iosxr.iosxr_logging	Configuration management of system logging services on network devices
cisco.iosxr.iosxr_netconf	Configures NetConf sub-system service on Cisco IOS-XR devices
cisco.iosxr.iosxr_ospfv2	OSPFv2 resource module
cisco.iosxr.iosxr_static_routes	Static routes resource module
cisco.iosxr.iosxr_system	Manage the system attributes on Cisco IOS XR devices
cisco.iosxr.iosxr_user	Manage the aggregate of local users on Cisco IOS XR device

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

Installing 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

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:

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

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:

• Freenode IRC - #ansible-network Freenode 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.

Changelogs

Roadmap

More information

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

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.