Cliconf Plugins — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# Cliconf Plugins

- Adding cliconf plugins
- Using cliconf plugins
- Plugin list

Cliconf plugins are abstractions over the CLI interface to network devices. They provide a standard interface for Ansible to execute tasks on those network devices.

These plugins generally correspond one-to-one to network device platforms. The appropriate cliconf plugin will thus be automatically loaded based on the `ansible_network_os` variable.

## Adding cliconf plugins

You can extend Ansible to support other network devices by dropping a custom plugin into the `cliconf_plugins` directory.

## Using cliconf plugins

The cliconf plugin to use is determined automatically from the `ansible_network_os` variable. There should be no reason to override this functionality.

Most cliconf plugins can operate without configuration. A few have additional options that can be set to impact how tasks are translated into CLI commands.

Plugins are self-documenting. Each plugin should document its configuration options.

## Plugin list

You can use `ansible-doc -t cliconf -l` to see the list of available plugins. Use `ansible-doc -t cliconf <plugin name>` to see detailed documentation and examples.

- aireos – Use aireos cliconf to run command on Cisco WLC platform
- aruba – Use aruba cliconf to run command on Aruba platform
- asa – Use asa cliconf to run command on Cisco ASA platform
- ce – Use ce cliconf to run command on HUAWEI CloudEngine platform
- cnos – Use cnos cliconf to run command on Lenovo CNOS platform
- dellos10 – Use dellos10 cliconf to run command on Dell OS10 platform
- dellos6 – Use dellos6 cliconf to run command on Dell OS6 platform
- dellos9 – Use dellos9 cliconf to run command on Dell OS9 platform
- edgeos – Use edgeos cliconf to run command on EdgeOS platform
- edgeswitch – Use edgeswitch cliconf to run command on EdgeSwitch platform
- enos – Use enos cliconf to run command on Lenovo ENOS platform
- eos – Use eos cliconf to run command on Arista EOS platform
- eric_eccli – Use eccli cliconf to run command on Ericsson ECCLI platform
- exos – Use exos cliconf to run command on Extreme EXOS platform
- frr – Use frr cliconf to run command on Free Range Routing platform
- icx – Use icx cliconf to run command on Ruckus ICX platform
- ios – Use ios cliconf to run command on Cisco IOS platform
- iosxr – Use iosxr cliconf to run command on Cisco IOS XR platform
- ironware – Use ironware cliconf to run command on Extreme Ironware platform
- junos – Use junos cliconf to run command on Juniper Junos OS platform
- netvisor – Use netvisor cliconf to run command on Pluribus netvisor platform
- nos – Use nos cliconf to run command on Extreme NOS platform
- nxos – Use nxos cliconf to run command on Cisco NX-OS platform
- onyx – Use onyx cliconf to run command on Mellanox ONYX platform
- routeros – Use routeros cliconf to run command on MikroTik RouterOS platform
- slxos – Use slxos cliconf to run command on Extreme SLX-OS platform
- voss – Use voss cliconf to run command on Extreme VOSS platform
- vyos – Use vyos cliconf to run command on VyOS platform

See also

Ansible for Network Automation
  An overview of using Ansible to automate networking devices.
User Mailing List
  Have a question? Stop by the google group!
irc.freenode.net
  #ansible-network IRC chat channel