W3cubDocs

/Ansible

logstash_plugin - Manage Logstash plugins

New in version 2.3.

Synopsis

  • Manages Logstash plugins.

Options

parameter required default choices comments
name
 yes
Install plugin with that name.
plugin_bin
 no /usr/share/logstash/bin/logstash-plugin
Specify logstash-plugin to use for plugin management.
proxy_host
 no None
Proxy host to use during plugin installation.
proxy_port
 no None
Proxy port to use during plugin installation.
state
 no present
  • present
  • absent
Apply plugin state.
version
 no None
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
  logstash_plugin:
    state: present
    name: logstash-input-beats

- name: Install specific version of a plugin
  logstash_plugin:
    state: present
    name: logstash-input-syslog
    version: '3.2.0'

- name: Uninstall Logstash plugin
  logstash_plugin:
    state: absent
    name: logstash-filter-multiline

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/logstash_plugin_module.html