Class: Ansible::Ruby::Modules::Mattermost
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Mattermost
- Defined in:
- lib/ansible/ruby/modules/generated/notification/mattermost.rb
Overview
Sends notifications to U(your.mattermost.url) via the Incoming WebHook integration.
Instance Method Summary collapse
-
#api_key ⇒ String
Mattermost webhook api key.
-
#channel ⇒ String?
Channel to send the message to.
-
#icon_url ⇒ String?
Url for the message sender’s icon.
-
#text ⇒ String
Text to send.
-
#url ⇒ String
Mattermost url (i.e. mattermost.yourcompany.com).
-
#username ⇒ String?
This is the sender of the message (Username Override need to be enabled by mattermost admin, see mattermost doc..
-
#validate_certs ⇒ Boolean?
If C(no), SSL certificates will not be validated.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#api_key ⇒ String
Returns Mattermost webhook api key. Log into your mattermost site, go to Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook. This will give you full URL. api_key is the last part. mattermost.example.com/hooks/C(API_KEY).
16 |
# File 'lib/ansible/ruby/modules/generated/notification/mattermost.rb', line 16 attribute :api_key |
#channel ⇒ String?
Returns Channel to send the message to. If absent, the message goes to the channel selected for the I(api_key).
24 |
# File 'lib/ansible/ruby/modules/generated/notification/mattermost.rb', line 24 attribute :channel |
#icon_url ⇒ String?
Returns Url for the message sender’s icon.
32 |
# File 'lib/ansible/ruby/modules/generated/notification/mattermost.rb', line 32 attribute :icon_url |
#text ⇒ String
Returns Text to send. Note that the module does not handle escaping characters.
20 |
# File 'lib/ansible/ruby/modules/generated/notification/mattermost.rb', line 20 attribute :text |
#url ⇒ String
Returns Mattermost url (i.e. mattermost.yourcompany.com).
12 |
# File 'lib/ansible/ruby/modules/generated/notification/mattermost.rb', line 12 attribute :url |
#username ⇒ String?
Returns This is the sender of the message (Username Override need to be enabled by mattermost admin, see mattermost doc.
28 |
# File 'lib/ansible/ruby/modules/generated/notification/mattermost.rb', line 28 attribute :username |
#validate_certs ⇒ Boolean?
Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
36 |
# File 'lib/ansible/ruby/modules/generated/notification/mattermost.rb', line 36 attribute :validate_certs |