mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
[PR #5962/51394b55 backport][stable-6] Add attributes to some messaging modules (#6060)
Add attributes to some messaging modules (#5962)
Add attributes to some messaging modules.
(cherry picked from commit 51394b55a0
)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
93650233e4
commit
4fc0c9a6d8
21 changed files with 176 additions and 30 deletions
|
@ -16,6 +16,13 @@ short_description: Send a message to Campfire
|
|||
description:
|
||||
- Send a message to Campfire.
|
||||
- Messages with newlines will result in a "Paste" message being sent.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
subscription:
|
||||
type: str
|
||||
|
|
|
@ -20,6 +20,14 @@ notes:
|
|||
- The C(recipient_id) type must be valid for the supplied C(recipient_id).
|
||||
- Full API documentation can be found at U(https://developer.webex.com/docs/api/basics).
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
|
||||
recipient_type:
|
||||
|
|
|
@ -20,6 +20,13 @@ seealso:
|
|||
- name: API documentation
|
||||
description: Documentation for Discord API
|
||||
link: https://discord.com/developers/docs/resources/webhook#execute-webhook
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
webhook_id:
|
||||
description:
|
||||
|
|
|
@ -15,6 +15,13 @@ module: hipchat
|
|||
short_description: Send a message to Hipchat
|
||||
description:
|
||||
- Send a message to a Hipchat room, with options to control the formatting.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
token:
|
||||
type: str
|
||||
|
|
|
@ -15,6 +15,13 @@ module: irc
|
|||
short_description: Send a message to an IRC channel or a nick
|
||||
description:
|
||||
- Send a message to an IRC channel or a nick. This is a very simplistic implementation.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
server:
|
||||
type: str
|
||||
|
|
|
@ -15,6 +15,13 @@ module: jabber
|
|||
short_description: Send a message to jabber user or chat room
|
||||
description:
|
||||
- Send a message to jabber
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
user:
|
||||
type: str
|
||||
|
|
|
@ -17,6 +17,13 @@ description:
|
|||
- Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically
|
||||
author: "Seth Edwards (@Sedward)"
|
||||
requirements: []
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
user:
|
||||
type: str
|
||||
|
|
|
@ -16,6 +16,13 @@ author: "Ivan Vanderbyl (@ivanvanderbyl)"
|
|||
short_description: Module for tracking logs via logentries.com
|
||||
description:
|
||||
- Sends logs to LogEntries in realtime
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
path:
|
||||
type: str
|
||||
|
|
|
@ -15,8 +15,13 @@ module: logentries_msg
|
|||
short_description: Send a message to logentries
|
||||
description:
|
||||
- Send a message to logentries
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
token:
|
||||
type: str
|
||||
|
|
|
@ -28,6 +28,13 @@ description:
|
|||
- Of course sending out a mail can be equally useful as a way to notify
|
||||
one or more people in a team that a specific action has been
|
||||
(successfully) taken.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
sender:
|
||||
description:
|
||||
|
|
|
@ -15,6 +15,13 @@ module: matrix
|
|||
short_description: Send notifications to matrix
|
||||
description:
|
||||
- This module sends html formatted notifications to matrix rooms.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
msg_plain:
|
||||
type: str
|
||||
|
|
|
@ -21,6 +21,13 @@ short_description: Send Mattermost notifications
|
|||
description:
|
||||
- Sends notifications to U(http://your.mattermost.url) via the Incoming WebHook integration.
|
||||
author: "Benjamin Jolivot (@bjolivot)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
url:
|
||||
type: str
|
||||
|
|
|
@ -18,6 +18,13 @@ short_description: Send notifications to Rocket Chat
|
|||
description:
|
||||
- The C(rocketchat) module sends notifications to Rocket Chat via the Incoming WebHook integration
|
||||
author: "Ramon de la Fuente (@ramondelafuente)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
domain:
|
||||
type: str
|
||||
|
|
|
@ -19,16 +19,23 @@ notes:
|
|||
- In 2.5, this module has been renamed from C(osx_say) to M(community.general.say).
|
||||
- If you like this module, you may also be interested in the osx_say callback plugin.
|
||||
- A list of available voices, with language, can be found by running C(say -v ?) on a OSX host and C(espeak --voices) on a Linux host.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
msg:
|
||||
type: str
|
||||
description:
|
||||
What to say
|
||||
- What to say.
|
||||
required: true
|
||||
voice:
|
||||
type: str
|
||||
description:
|
||||
What voice to use
|
||||
- What voice to use.
|
||||
required: false
|
||||
requirements: [ say or espeak or espeak-ng ]
|
||||
author:
|
||||
|
|
|
@ -27,6 +27,13 @@ notes:
|
|||
- "since 2.2 I(username) and I(password) are not required if you supply an I(api_key)"
|
||||
requirements:
|
||||
- sendgrid Python library 1.6.22 or lower (Sendgrid API V2 supported)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
username:
|
||||
type: str
|
||||
|
|
|
@ -21,6 +21,13 @@ short_description: Send Slack notifications
|
|||
description:
|
||||
- The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration
|
||||
author: "Ramon de la Fuente (@ramondelafuente)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
domain:
|
||||
type: str
|
||||
|
|
|
@ -13,6 +13,13 @@ module: syslogger
|
|||
short_description: Log messages in the syslog
|
||||
description:
|
||||
- Uses syslog to add log entries to the host.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
msg:
|
||||
type: str
|
||||
|
|
|
@ -17,6 +17,13 @@ description:
|
|||
- Creates/deletes an issue in a Taiga Project Management Platform (U(https://taiga.io)).
|
||||
- An issue is identified by the combination of project, issue subject and issue type.
|
||||
- This module implements the creation or deletion of issues (not the update).
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
taiga_host:
|
||||
type: str
|
||||
|
|
|
@ -23,6 +23,13 @@ description:
|
|||
- Also, the user may try to use any other telegram bot API method, if you specify I(api_method) argument.
|
||||
notes:
|
||||
- You will require a telegram account and create telegram bot to use this module.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
token:
|
||||
type: str
|
||||
|
|
|
@ -21,39 +21,46 @@ notes:
|
|||
- Like the other notification modules, this one requires an external
|
||||
dependency to work. In this case, you'll need a Twilio account with
|
||||
a purchased or verified phone number to send the text message.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
account_sid:
|
||||
type: str
|
||||
description:
|
||||
user's Twilio account token found on the account page
|
||||
- User's Twilio account token found on the account page.
|
||||
required: true
|
||||
auth_token:
|
||||
type: str
|
||||
description: user's Twilio authentication token
|
||||
description:
|
||||
- User's Twilio authentication token.
|
||||
required: true
|
||||
msg:
|
||||
type: str
|
||||
description:
|
||||
the body of the text message
|
||||
- The body of the text message.
|
||||
required: true
|
||||
to_numbers:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
one or more phone numbers to send the text message to,
|
||||
format +15551112222
|
||||
- One or more phone numbers to send the text message to, format C(+15551112222).
|
||||
required: true
|
||||
aliases: [ to_number ]
|
||||
from_number:
|
||||
type: str
|
||||
description:
|
||||
the Twilio number to send the text message from, format +15551112222
|
||||
- The Twilio number to send the text message from, format C(+15551112222).
|
||||
required: true
|
||||
media_url:
|
||||
type: str
|
||||
description:
|
||||
a URL with a picture, video or sound clip to send with an MMS
|
||||
(multimedia message) instead of a plain SMS
|
||||
- A URL with a picture, video or sound clip to send with an MMS
|
||||
(multimedia message) instead of a plain SMS.
|
||||
required: false
|
||||
|
||||
author: "Matt Makai (@makaimc)"
|
||||
|
|
|
@ -15,6 +15,13 @@ module: typetalk
|
|||
short_description: Send a message to typetalk
|
||||
description:
|
||||
- Send a message to typetalk using typetalk API
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
client_id:
|
||||
type: str
|
||||
|
|
Loading…
Reference in a new issue