Merge pull request #417 from nanobeep/patch-1
Document mail module's 'msg' param and fix examples
This commit is contained in:
commit
b544431a18
1 changed files with 2 additions and 3 deletions
|
@ -62,7 +62,6 @@ options:
|
||||||
subject:
|
subject:
|
||||||
description:
|
description:
|
||||||
- The subject of the email being sent.
|
- The subject of the email being sent.
|
||||||
aliases: [ msg ]
|
|
||||||
required: true
|
required: true
|
||||||
body:
|
body:
|
||||||
description:
|
description:
|
||||||
|
@ -115,7 +114,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 +124,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
|
||||||
|
|
Loading…
Reference in a new issue