Community IOSCM Collection

The Ansible Community IOSCM collection includes a variety of Ansible content to help automate the management of Cisco IOS XE network appliances specifically in controller mode.

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

Ansible version compatibility

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

For collections that support Ansible 2.9, please ensure you update your network_os to use the fully qualified collection name (for example, community.ioscm.ioscm). 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 Community IOSCM collection supports network_cli connections.

Included content

Cliconf plugins

Name	Description
community.ioscm.ioscm	Use ioscm cliconf to run command on Community IOSCM platform

Modules

Name	Description
community.ioscm.ioscm_command	Module to run commands on remote devices.
community.ioscm.ioscm_config	Module to manage configuration sections.
community.ioscm.ioscm_facts	Module to collect facts from remote devices.
community.ioscm.ioscm_ping	Tests reachability using ping from IOS switch.

Installing this collection

You can install the Community IOSCM collection with the Ansible Galaxy CLI:

ansible-galaxy collection install community.ioscm

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: community.ioscm

Using this collection

This collection includes network resource modules.

Using modules from the community IOS collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as community.ioscm.ioscm_config. The following example task to do configuration on a Cisco IOS network device running in controller mode, using the FQCN:

---
- name: Configure policy in Scavenger class
  community.ioscm.ioscm_config:
    lines:
    - conform-action transmit
    - exceed-action drop
    parents:
    - policy-map Foo
    - class Scavenger
    - police cir 64000

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:

• Community IOSCM 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 Community IOSCM 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

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