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

Note

This module is part of the community.general collection (version 6.6.9).

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

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 has been removed in community.general 4.0.0.

service

string

Name of the service (displayed as the “user” in the message)

Default: "ansible"

url

string

Service URL for the web client

validate_certs

boolean

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

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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)