Class: Ansible::Ruby::Modules::Slack

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/notification/slack.rb

Instance Method Summary collapse

Methods inherited from Base

#to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#attachments ⇒ Array<Hash>, ...

Returns Define a list of attachments. This list mirrors the Slack JSON API. For more information, see api.slack.com/docs/attachments.

Returns:

  • (Array<Hash>, Hash, nil) —

    Define a list of attachments. This list mirrors the Slack JSON API. For more information, see api.slack.com/docs/attachments



53
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 53

attribute :attachments

#channel ⇒ String?

Returns Channel to send the message to. If absent, the message goes to the channel selected for the I(token).

Returns:

  • (String, nil) —

    Channel to send the message to. If absent, the message goes to the channel selected for the I(token).



22
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 22

attribute :channel

#color ⇒ :normal, ...

Returns Allow text to use default colors - use the default of ‘normal’ to not send a custom color bar at the start of the message.

Returns:

  • (:normal, :good, :warning, :danger, nil) —

    Allow text to use default colors - use the default of ‘normal’ to not send a custom color bar at the start of the message



49
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 49

attribute :color

#domain ⇒ String?

Returns Slack (sub)domain for your environment without protocol. (i.e. C(future500.slack.com)) In 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information.

Returns:

  • (String, nil) —

    Slack (sub)domain for your environment without protocol. (i.e. C(future500.slack.com)) In 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information.



10
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 10

attribute :domain

#icon_emoji ⇒ Object?

Returns Emoji for the message sender. See Slack documentation for options. (if I(icon_emoji) is set, I(icon_url) will not be used).

Returns:

  • (Object, nil) —

    Emoji for the message sender. See Slack documentation for options. (if I(icon_emoji) is set, I(icon_url) will not be used)



34
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 34

attribute :icon_emoji

#icon_url ⇒ String?

Returns Url for the message sender’s icon (default C(www.ansible.com/favicon.ico)).

Returns:



30
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 30

attribute :icon_url

#link_names ⇒ 1, ...

Returns Automatically create links for channels and usernames in I(msg).

Returns:

  • (1, 0, nil) —

    Automatically create links for channels and usernames in I(msg).



37
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 37

attribute :link_names

#msg ⇒ String?

Returns Message to send.

Returns:

  • (String, nil) —

    Message to send.



18
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 18

attribute :msg

#parse ⇒ :full, ...

Returns Setting for the message parser at Slack.

Returns:

  • (:full, :none, nil) —

    Setting for the message parser at Slack



41
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 41

attribute :parse

#token ⇒ String

Returns Slack integration token. This authenticates you to the slack service. Prior to 1.8, a token looked like C(3Ffe373sfhRE6y42Fg3rvf4GlK). In 1.8 and above, ansible adapts to the new slack API where tokens look like C(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens are in the new format then slack will ignore any value of domain. If the token is in the old format the domain is required. Ansible has no control of when slack will get rid of the old API. When slack does that the old format will stop working.

Returns:

  • (String) —

    Slack integration token. This authenticates you to the slack service. Prior to 1.8, a token looked like C(3Ffe373sfhRE6y42Fg3rvf4GlK). In 1.8 and above, ansible adapts to the new slack API where tokens look like C(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens are in the new format then slack will ignore any value of domain. If the token is in the old format the domain is required. Ansible has no control of when slack will get rid of the old API. When slack does that the old format will stop working.



14
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 14

attribute :token

#username ⇒ String?

Returns This is the sender of the message.

Returns:

  • (String, nil) —

    This is the sender of the message.



26
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 26

attribute :username

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.



45
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/slack.rb', line 45

attribute :validate_certs