Terminal plugins contain information on how to prepare a particular network device’s SSH shell is properly initialized to be used with Ansible. This typically includes disabling automatic paging, detecting errors in output, and enabling privileged mode if supported and required on the device.
These plugins correspond one-to-one to network device platforms. Ansible loads the appropriate terminal plugin automatically based on the
You can extend Ansible to support other network devices by dropping a custom plugin into the
Ansible determines which terminal plugin to use automatically from the
ansible_network_os variable. There should be no reason to override this functionality.
Terminal plugins operate without configuration. All options to control the terminal are exposed in the
network_cli connection plugin.
Plugins are self-documenting. Each plugin should document its configuration options.
These plugins have migrated to collections on Ansible Galaxy. If you installed Ansible version 2.10 or later using
pip, you have access to several terminal plugins. To list all available terminal plugins on your control node, type
ansible-doc -t terminal -l. To view plugin-specific documentation and examples, use
ansible-doc -t terminal.