W3cubDocs

/Ansible 2.11

community.general.logstash_plugin – Manage Logstash plugins

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.logstash_plugin.

Synopsis

  • Manages Logstash plugins.

Parameters

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
    Choices:
  • present ←
  • absent
Apply plugin state.
version
string
Specify plugin Version of the plugin to install. If plugin exists with previous version, it will NOT be updated.

Examples

- 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"

Authors

  • Loic Blot (@nerzhul)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/logstash_plugin_module.html