community.general.logstash_plugin module – Manage Logstash plugins
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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.
Aliases: monitoring.logstash_plugin
Parameters
Parameter |
Comments |
---|---|
Install plugin with that name. |
|
Specify logstash-plugin to use for plugin management. Default: |
|
Proxy host to use during plugin installation. |
|
Proxy port to use during plugin installation. |
|
Apply plugin state. Choices:
|
|
Specify plugin Version of the plugin to install. If plugin exists with previous version, it will NOT be updated. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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"