Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.logstash_plugin.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| name string / required | Install plugin with that name. | |
| plugin_bin path | Default: "/usr/share/logstash/bin/logstash-plugin" | Specify logstash-plugin to use for plugin management. |
| proxy_host string | Proxy host to use during plugin installation. | |
| proxy_port string | Proxy port to use during plugin installation. | |
| state string |
| Apply plugin state. |
| version string | Specify plugin Version of the plugin to install. If plugin exists with previous version, it will NOT be updated. |
- name: Install Logstash beats input plugin
community.general.logstash_plugin:
state: present
name: logstash-input-beats
- name: Install specific version of a plugin
community.general.logstash_plugin:
state: present
name: logstash-input-syslog
version: '3.2.0'
- name: Uninstall Logstash plugin
community.general.logstash_plugin:
state: absent
name: logstash-filter-multiline
- name: Install Logstash plugin with alternate heap size
community.general.logstash_plugin:
state: present
name: logstash-input-beats
environment:
LS_JAVA_OPTS: "-Xms256m -Xmx256m"
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/logstash_plugin_module.html