W3cubDocs

/Ansible

community.general.say module – Makes a computer to speak

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Makes a computer speak! Amuse your friends, annoy your coworkers!

Requirements

The below requirements are needed on the host that executes this module.

  • say or espeak or espeak-ng

Parameters

Parameter

Comments

msg

string / required

What to say.

voice

string

What voice to use.

Attributes

Attribute

Support

Description

check_mode

Support: full

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.

Notes

Note

  • In 2.5, this module has been renamed from osx_say to community.general.say.
  • If you like this module, you may also be interested in the osx_say callback plugin.
  • A list of available voices, with language, can be found by running say -v ? on a OSX host and espeak --voices on a Linux host.

Examples

- name: Makes a computer to speak
  community.general.say:
    msg: '{{ inventory_hostname }} is all done'
    voice: Zarvox
  delegate_to: localhost

Authors

  • Ansible Core Team
  • Michael DeHaan (@mpdehaan)

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