Docs4dev
Docs
ansible / latest / collections / community / general / grove_module.html

community.general.grove – Sends a notification to a grove.io channel

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.grove.

Synopsis

  • The grove module sends a message for a service to a Grove.io channel.

Parameters

Parameter Choices/Defaults Comments
channel_token
string / required
Token of the channel to post to.
icon_url
string
Icon for the service
message_content
string / required
Message content.
The alias message is deprecated and will be removed in community.general 4.0.0.

aliases: message
service
string
Default:
"ansible"
Name of the service (displayed as the "user" in the message)
url
string
Service URL for the web client
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Sends a notification to a grove.io channel
  community.general.grove:
    channel_token: 6Ph62VBBJOccmtTPZbubiPzdrhipZXtg
    service: my-app
    message: 'deployed {{ target }}'

Authors

  • Jonas Pfenniger (@zimbatm)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/grove_module.html