Merge pull request #1 from ramondelafuente/feature/nsg-full-attachment-support

module guidelines compliency
This commit is contained in:
Stefan Berggren 2015-10-11 16:38:45 +02:00
commit df90e3b162

View file

@ -24,7 +24,7 @@ module: slack
short_description: Send Slack notifications
description:
- The M(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration
version_added: 1.6
version_added: "1.6"
author: "Ramon de la Fuente (@ramondelafuente)"
options:
domain:
@ -33,6 +33,7 @@ options:
C(future500.slack.com)) In 1.8 and beyond, this is deprecated and may
be ignored. See token documentation for information.
required: false
default: None
token:
description:
- Slack integration token. This authenticates you to the slack service.
@ -48,15 +49,17 @@ options:
description:
- Message to send.
required: false
default: None
channel:
description:
- Channel to send the message to. If absent, the message goes to the channel selected for the I(token).
required: false
default: None
username:
description:
- This is the sender of the message.
required: false
default: ansible
default: "Ansible"
icon_url:
description:
- Url for the message sender's icon (default C(http://www.ansible.com/favicon.ico))
@ -66,6 +69,7 @@ options:
- Emoji for the message sender. See Slack documentation for options.
(if I(icon_emoji) is set, I(icon_url) will not be used)
required: false
default: None
link_names:
description:
- Automatically create links for channels and usernames in I(msg).
@ -78,6 +82,7 @@ options:
description:
- Setting for the message parser at Slack
required: false
default: None
choices:
- 'full'
- 'none'
@ -91,7 +96,7 @@ options:
- 'yes'
- 'no'
color:
version_added: 2.0
version_added: "2.0"
description:
- Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message
required: false
@ -105,21 +110,20 @@ options:
description:
- Define a list of attachments. This list mirrors the Slack JSON API. For more information, see https://api.slack.com/docs/attachments
required: false
default: None
"""
EXAMPLES = """
- name: Send notification message via Slack
local_action:
module: slack
domain: future500.slack.com
token: thetokengeneratedbyslack
token: thetoken/generatedby/slack
msg: "{{ inventory_hostname }} completed"
- name: Send notification message via Slack all options
local_action:
module: slack
domain: future500.slack.com
token: thetokengeneratedbyslack
token: thetoken/generatedby/slack
msg: "{{ inventory_hostname }} completed"
channel: "#ansible"
username: "Ansible on {{ inventory_hostname }}"
@ -129,8 +133,7 @@ EXAMPLES = """
- name: insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in Slack
slack:
domain: future500.slack.com
token: thetokengeneratedbyslack
token: thetoken/generatedby/slack
msg: "{{ inventory_hostname }} is alive!"
color: good
username: ""
@ -138,8 +141,7 @@ EXAMPLES = """
- name: Use the attachments API
slack:
domain: future500.slack.com
token: thetokengeneratedbyslack
token: thetoken/generatedby/slack
attachments:
- text: "Display my system load on host A and B"
color: "#ff00dd"
@ -151,6 +153,14 @@ EXAMPLES = """
- title: "System B"
value: "load average: 5,16, 4,64, 2,43"
short: "true"
- name: Send notification message via Slack (deprecated API using domian)
local_action:
module: slack
domain: future500.slack.com
token: thetokengeneratedbyslack
msg: "{{ inventory_hostname }} completed"
"""
OLD_SLACK_INCOMING_WEBHOOK = 'https://%s/services/hooks/incoming-webhook?token=%s'
@ -243,4 +253,6 @@ def main():
# import module snippets
from ansible.module_utils.basic import *
from ansible.module_utils.urls import *
main()
if __name__ == '__main__':
main()