Cisco IOS Collection

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

This collection has been tested against Cisco IOSv version 15.2 on VIRL.

Supported connections

The Cisco IOS collection supports network_cli connections.

Included content

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

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
    version: 0.0.3

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

Alternately, you can call modules by their short name if you list the cisco.ios collection in the playbook's collections, as follows:

---
- hosts: ios01
  gather_facts: false
  connection: network_cli

  collections:
    - cisco.ios

  tasks:
    - name: Override device configuration of all interfaces with provided configuration
      ios_l3_interfaces:
        config:
          - name: GigabitEthernet0/2
            ipv4:
            - address: 192.168.0.1/24
          - name: GigabitEthernet0/3.100
            ipv6:
            - address: autoconfig
        state: overridden

See Also:

• Cisco IOS 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 IOS collection repository.

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.

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.