mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Adjust booleans in notification modules. (#5157)
This commit is contained in:
parent
1b480e9f37
commit
35a283918a
14 changed files with 30 additions and 30 deletions
|
@ -28,8 +28,8 @@ options:
|
||||||
- Message to send.
|
- Message to send.
|
||||||
markdown:
|
markdown:
|
||||||
description:
|
description:
|
||||||
- If C(yes), text will be parsed as markdown.
|
- If C(true), text will be parsed as markdown.
|
||||||
default: 'yes'
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
channel:
|
channel:
|
||||||
type: str
|
type: str
|
||||||
|
@ -58,7 +58,7 @@ EXAMPLES = """
|
||||||
url: |
|
url: |
|
||||||
https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60
|
https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60
|
||||||
text: "{{ inventory_hostname }} completed"
|
text: "{{ inventory_hostname }} completed"
|
||||||
markdown: no
|
markdown: false
|
||||||
channel: "#ansible"
|
channel: "#ansible"
|
||||||
attachments:
|
attachments:
|
||||||
- title: "Ansible on {{ inventory_hostname }}"
|
- title: "Ansible on {{ inventory_hostname }}"
|
||||||
|
|
|
@ -26,14 +26,14 @@ options:
|
||||||
description:
|
description:
|
||||||
- The request parameter you would like to send the message to.
|
- The request parameter you would like to send the message to.
|
||||||
- Messages can be sent to either a room or individual (by ID or E-Mail).
|
- Messages can be sent to either a room or individual (by ID or E-Mail).
|
||||||
required: yes
|
required: true
|
||||||
choices: ['roomId', 'toPersonEmail', 'toPersonId']
|
choices: ['roomId', 'toPersonEmail', 'toPersonId']
|
||||||
type: str
|
type: str
|
||||||
|
|
||||||
recipient_id:
|
recipient_id:
|
||||||
description:
|
description:
|
||||||
- The unique identifier associated with the supplied C(recipient_type).
|
- The unique identifier associated with the supplied C(recipient_type).
|
||||||
required: yes
|
required: true
|
||||||
type: str
|
type: str
|
||||||
|
|
||||||
msg_type:
|
msg_type:
|
||||||
|
@ -47,14 +47,14 @@ options:
|
||||||
personal_token:
|
personal_token:
|
||||||
description:
|
description:
|
||||||
- Your personal access token required to validate the Webex Teams API.
|
- Your personal access token required to validate the Webex Teams API.
|
||||||
required: yes
|
required: true
|
||||||
aliases: ['token']
|
aliases: ['token']
|
||||||
type: str
|
type: str
|
||||||
|
|
||||||
msg:
|
msg:
|
||||||
description:
|
description:
|
||||||
- The message you would like to send.
|
- The message you would like to send.
|
||||||
required: yes
|
required: true
|
||||||
type: str
|
type: str
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -25,13 +25,13 @@ options:
|
||||||
description:
|
description:
|
||||||
- The webhook ID.
|
- The webhook ID.
|
||||||
- "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})."
|
- "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})."
|
||||||
required: yes
|
required: true
|
||||||
type: str
|
type: str
|
||||||
webhook_token:
|
webhook_token:
|
||||||
description:
|
description:
|
||||||
- The webhook token.
|
- The webhook token.
|
||||||
- "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})."
|
- "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})."
|
||||||
required: yes
|
required: true
|
||||||
type: str
|
type: str
|
||||||
content:
|
content:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -80,10 +80,10 @@ options:
|
||||||
required: false
|
required: false
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
required: false
|
required: false
|
||||||
default: 'yes'
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
|
|
||||||
requirements: [ ]
|
requirements: [ ]
|
||||||
|
|
|
@ -46,9 +46,9 @@ options:
|
||||||
required: false
|
required: false
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
default: 'yes'
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
author: "Jonas Pfenniger (@zimbatm)"
|
author: "Jonas Pfenniger (@zimbatm)"
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -54,13 +54,13 @@ options:
|
||||||
description:
|
description:
|
||||||
- If true, a notification will be triggered for users in the room.
|
- If true, a notification will be triggered for users in the room.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
api:
|
api:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -76,13 +76,13 @@ options:
|
||||||
description:
|
description:
|
||||||
- Designates whether TLS/SSL should be used when connecting to the IRC server
|
- Designates whether TLS/SSL should be used when connecting to the IRC server
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
part:
|
part:
|
||||||
description:
|
description:
|
||||||
- Designates whether user should part from channel after sending message or not.
|
- Designates whether user should part from channel after sending message or not.
|
||||||
Useful for when using a faux bot and not wanting join/parts between messages.
|
Useful for when using a faux bot and not wanting join/parts between messages.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
style:
|
style:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -58,7 +58,7 @@ options:
|
||||||
subject:
|
subject:
|
||||||
description:
|
description:
|
||||||
- The subject of the email being sent.
|
- The subject of the email being sent.
|
||||||
required: yes
|
required: true
|
||||||
type: str
|
type: str
|
||||||
aliases: [ msg ]
|
aliases: [ msg ]
|
||||||
body:
|
body:
|
||||||
|
|
|
@ -64,9 +64,9 @@ options:
|
||||||
default: https://www.ansible.com/favicon.ico
|
default: https://www.ansible.com/favicon.ico
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
default: yes
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,7 @@ options:
|
||||||
applications that subsequently subscribe to the topic can received the last
|
applications that subsequently subscribe to the topic can received the last
|
||||||
retained message immediately.
|
retained message immediately.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
ca_cert:
|
ca_cert:
|
||||||
type: path
|
type: path
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -45,10 +45,10 @@ options:
|
||||||
required: true
|
required: true
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- url
|
- url
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -74,10 +74,10 @@ options:
|
||||||
- 0
|
- 0
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
color:
|
color:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -81,7 +81,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether the body is html content that should be rendered.
|
- Whether the body is html content that should be rendered.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
headers:
|
headers:
|
||||||
type: dict
|
type: dict
|
||||||
description:
|
description:
|
||||||
|
@ -90,7 +90,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The e-mail body content.
|
- The e-mail body content.
|
||||||
required: yes
|
required: true
|
||||||
author: "Matt Makai (@makaimc)"
|
author: "Matt Makai (@makaimc)"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -104,10 +104,10 @@ options:
|
||||||
- 'none'
|
- 'none'
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
color:
|
color:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
|
Loading…
Reference in a new issue