New in version 2.3.
Parameter | Choices/Defaults | Comments |
---|---|---|
end_sound_path path | Full path to a .wav file containing a sound to play after the text has been spoken.Useful on conference calls to alert other speakers that ansible has finished speaking. | |
msg | The text to be spoken. Use either msg or msg_file .Optional so that you can use this module just to play sounds. | |
msg_file path | Full path to a windows format text file containing the text to be spokend. Use either msg or msg_file .Optional so that you can use this module just to play sounds. | |
speech_speed int | Default: 0 | How fast or slow to speak the text. Must be an integer value in the range -10 to 10. -10 is slowest, 10 is fastest. |
start_sound_path path | Full path to a .wav file containing a sound to play before the text is spoken.Useful on conference calls to alert other speakers that ansible has something to say. | |
voice | Default: system default voice | Which voice to use. See notes for how to discover installed voices. If the requested voice is not available the default voice will be used. Example voice names from Windows 10 are Microsoft Zira Desktop and Microsoft Hazel Desktop . |
Note
To find which voices are installed, run the following Powershell commands.
Add-Type -AssemblyName System.Speech $speech = New-Object -TypeName System.Speech.Synthesis.SpeechSynthesizer $speech.GetInstalledVoices() | ForEach-Object { $_.VoiceInfo } $speech.Dispose()
- name: Warn of impending deployment win_say: msg: Warning, deployment commencing in 5 minutes, please log out. - name: Using a different voice and a start sound win_say: start_sound_path: C:\Windows\Media\ding.wav msg: Warning, deployment commencing in 5 minutes, please log out. voice: Microsoft Hazel Desktop - name: With start and end sound win_say: start_sound_path: C:\Windows\Media\Windows Balloon.wav msg: New software installed end_sound_path: C:\Windows\Media\chimes.wav - name: Text from file example win_say: start_sound_path: C:\Windows\Media\Windows Balloon.wav msg_file: AppData\Local\Temp\morning_report.txt end_sound_path: C:\Windows\Media\chimes.wav
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
message_text string | success | the text that the module attempted to speak Sample: Warning, deployment commencing in 5 minutes. |
voice string | success | the voice used to speak the text. Sample: Microsoft Hazel Desktop |
voice_info string | when requested voice could not be loaded | the voice used to speak the text. Sample: Could not load voice TestVoice, using system default voice |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/win_say_module.html