ansible.builtin.logstash_plugin (v2.9.27) — module

Manage Logstash plugins

| "added in version" 2.3 of ansible.builtin"

Authors: Loic Blot (@nerzhul)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Manages Logstash plugins.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Install Logstash beats input plugin
  logstash_plugin:
    state: present
    name: logstash-input-beats
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Install specific version of a plugin
  logstash_plugin:
    state: present
    name: logstash-input-syslog
    version: '3.2.0'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Uninstall Logstash plugin
  logstash_plugin:
    state: absent
    name: logstash-filter-multiline
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: install Logstash plugin with alternate heap size
  logstash_plugin:
    state: present
    name: logstash-input-beats
  environment:
    LS_JAVA_OPTS: "-Xms256m -Xmx256m"

Inputs

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

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

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

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

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

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