mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Add attributes to some messaging modules (#5962)
Add attributes to some messaging modules.
This commit is contained in:
parent
673c79f6d9
commit
51394b55a0
21 changed files with 176 additions and 30 deletions
|
@ -16,6 +16,13 @@ short_description: Send a message to Campfire
|
||||||
description:
|
description:
|
||||||
- Send a message to Campfire.
|
- Send a message to Campfire.
|
||||||
- Messages with newlines will result in a "Paste" message being sent.
|
- 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:
|
options:
|
||||||
subscription:
|
subscription:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -20,6 +20,14 @@ notes:
|
||||||
- The C(recipient_id) type must be valid for the supplied C(recipient_id).
|
- 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).
|
- 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:
|
options:
|
||||||
|
|
||||||
recipient_type:
|
recipient_type:
|
||||||
|
|
|
@ -20,6 +20,13 @@ seealso:
|
||||||
- name: API documentation
|
- name: API documentation
|
||||||
description: Documentation for Discord API
|
description: Documentation for Discord API
|
||||||
link: https://discord.com/developers/docs/resources/webhook#execute-webhook
|
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:
|
options:
|
||||||
webhook_id:
|
webhook_id:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -15,6 +15,13 @@ module: hipchat
|
||||||
short_description: Send a message to Hipchat
|
short_description: Send a message to Hipchat
|
||||||
description:
|
description:
|
||||||
- Send a message to a Hipchat room, with options to control the formatting.
|
- 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:
|
options:
|
||||||
token:
|
token:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -14,7 +14,14 @@ DOCUMENTATION = '''
|
||||||
module: irc
|
module: irc
|
||||||
short_description: Send a message to an IRC channel or a nick
|
short_description: Send a message to an IRC channel or a nick
|
||||||
description:
|
description:
|
||||||
- Send a message to an IRC channel or a nick. This is a very simplistic implementation.
|
- 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:
|
options:
|
||||||
server:
|
server:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -14,7 +14,14 @@ DOCUMENTATION = '''
|
||||||
module: jabber
|
module: jabber
|
||||||
short_description: Send a message to jabber user or chat room
|
short_description: Send a message to jabber user or chat room
|
||||||
description:
|
description:
|
||||||
- Send a message to jabber
|
- Send a message to jabber
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
user:
|
user:
|
||||||
type: str
|
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
|
- 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)"
|
author: "Seth Edwards (@Sedward)"
|
||||||
requirements: []
|
requirements: []
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
user:
|
user:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -16,6 +16,13 @@ author: "Ivan Vanderbyl (@ivanvanderbyl)"
|
||||||
short_description: Module for tracking logs via logentries.com
|
short_description: Module for tracking logs via logentries.com
|
||||||
description:
|
description:
|
||||||
- Sends logs to LogEntries in realtime
|
- Sends logs to LogEntries in realtime
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
path:
|
path:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -14,9 +14,14 @@ DOCUMENTATION = '''
|
||||||
module: logentries_msg
|
module: logentries_msg
|
||||||
short_description: Send a message to logentries
|
short_description: Send a message to logentries
|
||||||
description:
|
description:
|
||||||
- Send a message to logentries
|
- Send a message to logentries
|
||||||
requirements:
|
extends_documentation_fragment:
|
||||||
- "python >= 2.6"
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
token:
|
token:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -28,6 +28,13 @@ description:
|
||||||
- Of course sending out a mail can be equally useful as a way to notify
|
- 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
|
one or more people in a team that a specific action has been
|
||||||
(successfully) taken.
|
(successfully) taken.
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
sender:
|
sender:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -15,6 +15,13 @@ module: matrix
|
||||||
short_description: Send notifications to matrix
|
short_description: Send notifications to matrix
|
||||||
description:
|
description:
|
||||||
- This module sends html formatted notifications to matrix rooms.
|
- 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:
|
options:
|
||||||
msg_plain:
|
msg_plain:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -21,6 +21,13 @@ short_description: Send Mattermost notifications
|
||||||
description:
|
description:
|
||||||
- Sends notifications to U(http://your.mattermost.url) via the Incoming WebHook integration.
|
- Sends notifications to U(http://your.mattermost.url) via the Incoming WebHook integration.
|
||||||
author: "Benjamin Jolivot (@bjolivot)"
|
author: "Benjamin Jolivot (@bjolivot)"
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
url:
|
url:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -18,6 +18,13 @@ short_description: Send notifications to Rocket Chat
|
||||||
description:
|
description:
|
||||||
- The C(rocketchat) module sends notifications to Rocket Chat via the Incoming WebHook integration
|
- The C(rocketchat) module sends notifications to Rocket Chat via the Incoming WebHook integration
|
||||||
author: "Ramon de la Fuente (@ramondelafuente)"
|
author: "Ramon de la Fuente (@ramondelafuente)"
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
domain:
|
domain:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -14,21 +14,28 @@ DOCUMENTATION = '''
|
||||||
module: say
|
module: say
|
||||||
short_description: Makes a computer to speak
|
short_description: Makes a computer to speak
|
||||||
description:
|
description:
|
||||||
- makes a computer speak! Amuse your friends, annoy your coworkers!
|
- makes a computer speak! Amuse your friends, annoy your coworkers!
|
||||||
notes:
|
notes:
|
||||||
- In 2.5, this module has been renamed from C(osx_say) to M(community.general.say).
|
- 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.
|
- 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.
|
- 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:
|
options:
|
||||||
msg:
|
msg:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
What to say
|
- What to say.
|
||||||
required: true
|
required: true
|
||||||
voice:
|
voice:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
What voice to use
|
- What voice to use.
|
||||||
required: false
|
required: false
|
||||||
requirements: [ say or espeak or espeak-ng ]
|
requirements: [ say or espeak or espeak-ng ]
|
||||||
author:
|
author:
|
||||||
|
|
|
@ -14,19 +14,26 @@ DOCUMENTATION = r'''
|
||||||
module: sendgrid
|
module: sendgrid
|
||||||
short_description: Sends an email with the SendGrid API
|
short_description: Sends an email with the SendGrid API
|
||||||
description:
|
description:
|
||||||
- "Sends an email with a SendGrid account through their API, not through
|
- "Sends an email with a SendGrid account through their API, not through
|
||||||
the SMTP service."
|
the SMTP service."
|
||||||
notes:
|
notes:
|
||||||
- "This module is non-idempotent because it sends an email through the
|
- "This module is non-idempotent because it sends an email through the
|
||||||
external API. It is idempotent only in the case that the module fails."
|
external API. It is idempotent only in the case that the module fails."
|
||||||
- "Like the other notification modules, this one requires an external
|
- "Like the other notification modules, this one requires an external
|
||||||
dependency to work. In this case, you'll need an active SendGrid
|
dependency to work. In this case, you'll need an active SendGrid
|
||||||
account."
|
account."
|
||||||
- "In order to use api_key, cc, bcc, attachments, from_name, html_body, headers
|
- "In order to use api_key, cc, bcc, attachments, from_name, html_body, headers
|
||||||
you must pip install sendgrid"
|
you must pip install sendgrid"
|
||||||
- "since 2.2 I(username) and I(password) are not required if you supply an I(api_key)"
|
- "since 2.2 I(username) and I(password) are not required if you supply an I(api_key)"
|
||||||
requirements:
|
requirements:
|
||||||
- sendgrid Python library 1.6.22 or lower (Sendgrid API V2 supported)
|
- 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:
|
options:
|
||||||
username:
|
username:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -19,8 +19,15 @@ DOCUMENTATION = """
|
||||||
module: slack
|
module: slack
|
||||||
short_description: Send Slack notifications
|
short_description: Send Slack notifications
|
||||||
description:
|
description:
|
||||||
- The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration
|
- The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration
|
||||||
author: "Ramon de la Fuente (@ramondelafuente)"
|
author: "Ramon de la Fuente (@ramondelafuente)"
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
domain:
|
domain:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -13,6 +13,13 @@ module: syslogger
|
||||||
short_description: Log messages in the syslog
|
short_description: Log messages in the syslog
|
||||||
description:
|
description:
|
||||||
- Uses syslog to add log entries to the host.
|
- 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:
|
options:
|
||||||
msg:
|
msg:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -17,6 +17,13 @@ description:
|
||||||
- Creates/deletes an issue in a Taiga Project Management Platform (U(https://taiga.io)).
|
- 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.
|
- 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).
|
- 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:
|
options:
|
||||||
taiga_host:
|
taiga_host:
|
||||||
type: str
|
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.
|
- Also, the user may try to use any other telegram bot API method, if you specify I(api_method) argument.
|
||||||
notes:
|
notes:
|
||||||
- You will require a telegram account and create telegram bot to use this module.
|
- 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:
|
options:
|
||||||
token:
|
token:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -21,39 +21,46 @@ notes:
|
||||||
- Like the other notification modules, this one requires an external
|
- Like the other notification modules, this one requires an external
|
||||||
dependency to work. In this case, you'll need a Twilio account with
|
dependency to work. In this case, you'll need a Twilio account with
|
||||||
a purchased or verified phone number to send the text message.
|
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:
|
options:
|
||||||
account_sid:
|
account_sid:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
user's Twilio account token found on the account page
|
- User's Twilio account token found on the account page.
|
||||||
required: true
|
required: true
|
||||||
auth_token:
|
auth_token:
|
||||||
type: str
|
type: str
|
||||||
description: user's Twilio authentication token
|
description:
|
||||||
|
- User's Twilio authentication token.
|
||||||
required: true
|
required: true
|
||||||
msg:
|
msg:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
the body of the text message
|
- The body of the text message.
|
||||||
required: true
|
required: true
|
||||||
to_numbers:
|
to_numbers:
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
description:
|
description:
|
||||||
one or more phone numbers to send the text message to,
|
- One or more phone numbers to send the text message to, format C(+15551112222).
|
||||||
format +15551112222
|
|
||||||
required: true
|
required: true
|
||||||
aliases: [ to_number ]
|
aliases: [ to_number ]
|
||||||
from_number:
|
from_number:
|
||||||
type: str
|
type: str
|
||||||
description:
|
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
|
required: true
|
||||||
media_url:
|
media_url:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
a URL with a picture, video or sound clip to send with an MMS
|
- A URL with a picture, video or sound clip to send with an MMS
|
||||||
(multimedia message) instead of a plain SMS
|
(multimedia message) instead of a plain SMS.
|
||||||
required: false
|
required: false
|
||||||
|
|
||||||
author: "Matt Makai (@makaimc)"
|
author: "Matt Makai (@makaimc)"
|
||||||
|
|
|
@ -15,6 +15,13 @@ module: typetalk
|
||||||
short_description: Send a message to typetalk
|
short_description: Send a message to typetalk
|
||||||
description:
|
description:
|
||||||
- Send a message to typetalk using typetalk API
|
- Send a message to typetalk using typetalk API
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
client_id:
|
client_id:
|
||||||
type: str
|
type: str
|
||||||
|
|
Loading…
Reference in a new issue