cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Document 'msg' param and fix examples

Browse source 
The 'msg' alias for 'subject' isn't in the documentation, so adding it.

In the gmail example, it uses both the 'subject' and 'msg' params, but 'msg' is an alias of 'subject', so you are essentially declaring the same param twice. If you use this example, then no subject is sent (I tested with gmail). Documentation example is updated to use 'body' as intended.

Also, updated the simple example to use 'subject' instead of the 'msg' alias since it is more explicit.
This commit is contained in:
Matt Jaynes 2015-04-22 21:14:47 +02:00 committed by Matt Clay
parent 948c05ac5e
commit 94f581b83a
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/ansible/modules/extras/notification/mail.py
View file

@ -61,7 +61,7 @@ options:
required: false required: false
subject: subject:
description: description:
- The subject of the email being sent. - The subject of the email being sent. Alias: I(msg)
aliases: [ msg ] aliases: [ msg ]
required: true required: true
body: body:
@ -115,7 +115,7 @@ options:
EXAMPLES = ''' EXAMPLES = '''
# Example playbook sending mail to root # Example playbook sending mail to root
- local_action: mail msg='System {{ ansible_hostname }} has been successfully provisioned.' - local_action: mail subject='System {{ ansible_hostname }} has been successfully provisioned.'
# Sending an e-mail using Gmail SMTP servers # Sending an e-mail using Gmail SMTP servers
- local_action: mail - local_action: mail
@ -125,7 +125,7 @@ EXAMPLES = '''
password='mysecret' password='mysecret'
to="John Smith <john.smith@example.com>" to="John Smith <john.smith@example.com>"
subject='Ansible-report' subject='Ansible-report'
msg='System {{ ansible_hostname }} has been successfully provisioned.' body='System {{ ansible_hostname }} has been successfully provisioned.'
# Send e-mail to a bunch of users, attaching files # Send e-mail to a bunch of users, attaching files
- local_action: mail - local_action: mail