:plugin: xmpp
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}-{plugin}"]

=== Xmpp output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

This output allows you ship events over XMPP/Jabber.

This plugin can be used for posting events to humans over XMPP, or you can
use it for PubSub or general message passing for logstash to logstash.

[id="plugins-{type}s-{plugin}-options"]
==== Xmpp Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-message>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|Yes
| <<plugins-{type}s-{plugin}-rooms>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-users>> |<<array,array>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-host"]
===== `host` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

The xmpp server to connect to. This is optional. If you omit this setting,
the host on the user/identity is used. (foo.com for user@foo.com)

[id="plugins-{type}s-{plugin}-message"]
===== `message` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The message to send. This supports dynamic strings like `%{host}`

[id="plugins-{type}s-{plugin}-password"]
===== `password` 

  * This is a required setting.
  * Value type is <<password,password>>
  * There is no default value for this setting.

The xmpp password for the user/identity.

[id="plugins-{type}s-{plugin}-rooms"]
===== `rooms` 

  * Value type is <<array,array>>
  * There is no default value for this setting.

if muc/multi-user-chat required, give the name of the room that
you want to join: room@conference.domain/nick

[id="plugins-{type}s-{plugin}-user"]
===== `user` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The user or resource ID, like foo@example.com.

[id="plugins-{type}s-{plugin}-users"]
===== `users` 

  * Value type is <<array,array>>
  * There is no default value for this setting.

The users to send messages to



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]