/ home / community / community.general / 8.5.0 / module / logstash_plugin

community.general.logstash_plugin (8.5.0) — module

Manage Logstash plugins

Authors: Loic Blot (@nerzhul)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Manages Logstash plugins.

Usage examples

Scanned by Steampunk Spotter

- name: Install Logstash beats input plugin
  community.general.logstash_plugin:
    state: present
    name: logstash-input-beats

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

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

Inputs

    
name:
    description:
    - Install plugin with that name.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Apply plugin state.
    type: str

version:
    description:
    - Specify plugin Version of the plugin to install. If plugin exists with previous
      version, it will NOT be updated.
    type: str

plugin_bin:
    default: /usr/share/logstash/bin/logstash-plugin
    description:
    - Specify logstash-plugin to use for plugin management.
    type: path

proxy_host:
    description:
    - Proxy host to use during plugin installation.
    type: str

proxy_port:
    description:
    - Proxy port to use during plugin installation.
    type: str