logstash_plugin – Manage Logstash plugins

From Get docs
Ansible/docs/2.8/modules/logstash plugin module


logstash_plugin – Manage Logstash plugins

New in version 2.3.


Synopsis

  • Manages Logstash plugins.

Parameters

Parameter Choices/Defaults Comments

name

- / required

Install plugin with that name.

plugin_bin

-

Default:

"/usr/share/logstash/bin/logstash-plugin"

Specify logstash-plugin to use for plugin management.

proxy_host

-

Proxy host to use during plugin installation.

proxy_port

-

Proxy port to use during plugin installation.

state

-

  • present

  • absent

Apply plugin state.

version

-

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

- name: install Logstash plugin with alternate heap size
  logstash_plugin:
    state: present
    name: logstash-input-beats
  environment:
    LS_JAVA_OPTS: "-Xms256m -Xmx256m"

Status

Authors

  • Loic Blot (@nerzhul)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


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