1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Adjust booleans in monitoring modules. (#5156)

This commit is contained in:
Felix Fontein 2022-08-24 19:59:30 +02:00 committed by GitHub
parent ddc989ec6d
commit 1b480e9f37
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 50 additions and 50 deletions

View file

@ -65,10 +65,10 @@ options:
type: str type: str
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates for the target url will not be validated. This should only be used - If C(false), SSL certificates for the target url 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: []

View file

@ -68,10 +68,10 @@ options:
default: https://api.bigpanda.io default: https://api.bigpanda.io
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates for the target url will not be validated. This should only be used - If C(false), SSL certificates for the target url 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
deployment_message: deployment_message:
type: str type: str

View file

@ -75,10 +75,10 @@ options:
description: ["An arbitrary string to use for aggregation."] description: ["An arbitrary string to use for aggregation."]
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
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -91,7 +91,7 @@ options:
description: description:
- Whether this monitor will notify when data stops reporting. - Whether this monitor will notify when data stops reporting.
type: bool type: bool
default: 'no' default: false
no_data_timeframe: no_data_timeframe:
description: description:
- The number of minutes before a monitor will notify when data stops reporting. - The number of minutes before a monitor will notify when data stops reporting.
@ -116,7 +116,7 @@ options:
description: description:
- Whether tagged users will be notified on changes to this monitor. - Whether tagged users will be notified on changes to this monitor.
type: bool type: bool
default: 'no' default: false
thresholds: thresholds:
type: dict type: dict
description: description:
@ -128,7 +128,7 @@ options:
description: description:
- Whether changes to this monitor should be restricted to the creator or admins. - Whether changes to this monitor should be restricted to the creator or admins.
type: bool type: bool
default: 'no' default: false
require_full_window: require_full_window:
description: description:
- Whether this monitor needs a full window of data before it gets evaluated. - Whether this monitor needs a full window of data before it gets evaluated.
@ -153,7 +153,7 @@ options:
description: description:
- Whether notifications from this monitor automatically inserts its triggering tags into the title. - Whether notifications from this monitor automatically inserts its triggering tags into the title.
type: bool type: bool
default: yes default: true
version_added: 1.3.0 version_added: 1.3.0
priority: priority:
description: description:

View file

@ -45,10 +45,10 @@ options:
default: "https://api.honeybadger.io/v1/deploys" default: "https://api.honeybadger.io/v1/deploys"
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates for the target url will not be validated. This should only be used - If C(false), SSL certificates for the target url 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
''' '''

View file

@ -26,16 +26,16 @@ options:
- HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path - HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
use_proxy: use_proxy:
description: description:
- If C(no), it will not use a proxy, even if one is defined in - If C(false), it will not use a proxy, even if one is defined in
an environment variable on the target hosts. an environment variable on the target hosts.
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
url_username: url_username:
type: str type: str
description: description:
@ -53,7 +53,7 @@ options:
send a 401, logins will fail. This option forces the sending of the Basic authentication header send a 401, logins will fail. This option forces the sending of the Basic authentication header
upon initial request. upon initial request.
type: bool type: bool
default: 'no' default: false
client_cert: client_cert:
type: path type: path
description: description:

View file

@ -64,10 +64,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: []

View file

@ -73,10 +73,10 @@ options:
default: Created by Ansible default: Created by Ansible
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
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -73,10 +73,10 @@ options:
type: str type: str
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates for the target URL will not be validated. - If C(false), SSL certificates for the target URL will not be validated.
This should only be used on personally controlled sites using self-signed certificates. This should only be used on personally controlled sites using self-signed certificates.
required: false required: false
default: yes default: true
type: bool type: bool
notes: notes:
- Supports C(check_mode). Note that check mode simply does nothing except returning C(changed=true) in case the I(url) seems to be correct. - Supports C(check_mode). Note that check mode simply does nothing except returning C(changed=true) in case the I(url) seems to be correct.

View file

@ -56,11 +56,11 @@ options:
default: 'https://api.rollbar.com/api/1/deploy/' default: 'https://api.rollbar.com/api/1/deploy/'
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates for the target url will not be validated. - If C(false), SSL certificates for the target url will not be validated.
This should only be used on personally controlled sites using This should only be used on personally controlled sites using
self-signed certificates. self-signed certificates.
required: false required: false
default: 'yes' default: true
type: bool type: bool
''' '''

View file

@ -43,7 +43,7 @@ options:
- Create a backup file (if yes), including the timestamp information so - Create a backup file (if yes), including the timestamp information so
- you can get the original file back if you somehow clobbered it incorrectly. - you can get the original file back if you somehow clobbered it incorrectly.
type: bool type: bool
default: 'no' default: false
command: command:
type: str type: str
description: description:
@ -97,7 +97,7 @@ options:
description: description:
- Whether the check is a metric - Whether the check is a metric
type: bool type: bool
default: 'no' default: false
standalone: standalone:
description: description:
- Whether the check should be scheduled by the sensu client or server - Whether the check should be scheduled by the sensu client or server
@ -153,7 +153,7 @@ EXAMPLES = '''
community.general.sensu_check: community.general.sensu_check:
name: cpu_load name: cpu_load
command: /etc/sensu/plugins/system/cpu-mpstat-metrics.rb command: /etc/sensu/plugins/system/cpu-mpstat-metrics.rb
metric: yes metric: true
handlers: relay handlers: relay
subscribers: common subscribers: common
interval: 60 interval: 60
@ -328,7 +328,7 @@ def main():
arg_spec = {'name': {'type': 'str', 'required': True}, arg_spec = {'name': {'type': 'str', 'required': True},
'path': {'type': 'str', 'default': '/etc/sensu/conf.d/checks.json'}, 'path': {'type': 'str', 'default': '/etc/sensu/conf.d/checks.json'},
'state': {'type': 'str', 'default': 'present', 'choices': ['present', 'absent']}, 'state': {'type': 'str', 'default': 'present', 'choices': ['present', 'absent']},
'backup': {'type': 'bool', 'default': 'no'}, 'backup': {'type': 'bool', 'default': False},
'command': {'type': 'str'}, 'command': {'type': 'str'},
'handlers': {'type': 'list', 'elements': 'str'}, 'handlers': {'type': 'list', 'elements': 'str'},
'subscribers': {'type': 'list', 'elements': 'str'}, 'subscribers': {'type': 'list', 'elements': 'str'},
@ -339,7 +339,7 @@ def main():
'subdue_begin': {'type': 'str'}, 'subdue_begin': {'type': 'str'},
'subdue_end': {'type': 'str'}, 'subdue_end': {'type': 'str'},
'dependencies': {'type': 'list', 'elements': 'str'}, 'dependencies': {'type': 'list', 'elements': 'str'},
'metric': {'type': 'bool', 'default': 'no'}, 'metric': {'type': 'bool', 'default': False},
'standalone': {'type': 'bool'}, 'standalone': {'type': 'bool'},
'publish': {'type': 'bool'}, 'publish': {'type': 'bool'},
'occurrences': {'type': 'int'}, 'occurrences': {'type': 'int'},

View file

@ -44,7 +44,7 @@ options:
description: description:
- If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the check. - If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the check.
type: bool type: bool
default: 'no' default: false
redact: redact:
type: list type: list
elements: str elements: str
@ -58,7 +58,7 @@ options:
description: description:
- If Sensu should monitor keepalives for this client. - If Sensu should monitor keepalives for this client.
type: bool type: bool
default: 'yes' default: true
keepalive: keepalive:
type: dict type: dict
description: description:

View file

@ -64,12 +64,12 @@ options:
description: description:
- If events matching one or more silence entries should be handled. - If events matching one or more silence entries should be handled.
type: bool type: bool
default: 'no' default: false
handle_flapping: handle_flapping:
description: description:
- If events in the flapping state should be handled. - If events in the flapping state should be handled.
type: bool type: bool
default: 'no' default: false
command: command:
type: str type: str
description: description:

View file

@ -40,7 +40,7 @@ options:
- can get the original file back if you somehow clobbered it incorrectly. - can get the original file back if you somehow clobbered it incorrectly.
type: bool type: bool
required: false required: false
default: no default: false
requirements: [ ] requirements: [ ]
author: Anders Ingemann (@andsens) author: Anders Ingemann (@andsens)
''' '''
@ -133,7 +133,7 @@ def main():
arg_spec = {'name': {'type': 'str', 'required': True}, arg_spec = {'name': {'type': 'str', 'required': True},
'path': {'type': 'str', 'default': '/etc/sensu/conf.d/subscriptions.json'}, 'path': {'type': 'str', 'default': '/etc/sensu/conf.d/subscriptions.json'},
'state': {'type': 'str', 'default': 'present', 'choices': ['present', 'absent']}, 'state': {'type': 'str', 'default': 'present', 'choices': ['present', 'absent']},
'backup': {'type': 'bool', 'default': 'no'}, 'backup': {'type': 'bool', 'default': False},
} }
module = AnsibleModule(argument_spec=arg_spec, module = AnsibleModule(argument_spec=arg_spec,

View file

@ -65,16 +65,16 @@ options:
use_proxy: use_proxy:
required: false required: false
description: description:
- if C(no), it will not use a proxy, even if one is defined in an environment - if C(false), it will not use a proxy, even if one is defined in an environment
variable on the target hosts. variable on the target hosts.
default: 'yes' default: true
type: bool type: bool
validate_certs: validate_certs:
required: false required: false
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
agentport: agentport:
type: int type: int
@ -108,7 +108,7 @@ EXAMPLES = '''
oneclick_url: http://oneclick.example.com:8080 oneclick_url: http://oneclick.example.com:8080
oneclick_user: username oneclick_user: username
oneclick_password: password oneclick_password: password
use_proxy: no use_proxy: false
state: absent state: absent
''' '''

View file

@ -43,9 +43,9 @@ options:
aliases: [password] aliases: [password]
use_proxy: use_proxy:
description: description:
- if C(no), it will not use a proxy, even if one is defined in - if C(false), it will not use a proxy, even if one is defined in
an environment variable on the target hosts. an environment variable on the target hosts.
default: yes default: true
required: false required: false
type: bool type: bool
name: name:
@ -63,7 +63,7 @@ options:
- Validate SSL certificates. Only change this to C(false) if you can guarantee that you are talking to the correct endpoint and there is no - Validate SSL certificates. Only change this to C(false) if you can guarantee that you are talking to the correct endpoint and there is no
man-in-the-middle attack happening. man-in-the-middle attack happening.
type: bool type: bool
default: yes default: true
required: false required: false
attributes: attributes:
description: description:

View file

@ -74,32 +74,32 @@ options:
description: description:
- If it affects all components and containers - If it affects all components and containers
type: bool type: bool
default: 'no' default: false
automation: automation:
description: description:
- Automatically start and end the maintenance window - Automatically start and end the maintenance window
type: bool type: bool
default: 'no' default: false
maintenance_notify_now: maintenance_notify_now:
description: description:
- Notify subscribers now - Notify subscribers now
type: bool type: bool
default: 'no' default: false
maintenance_notify_72_hr: maintenance_notify_72_hr:
description: description:
- Notify subscribers 72 hours before maintenance start time - Notify subscribers 72 hours before maintenance start time
type: bool type: bool
default: 'no' default: false
maintenance_notify_24_hr: maintenance_notify_24_hr:
description: description:
- Notify subscribers 24 hours before maintenance start time - Notify subscribers 24 hours before maintenance start time
type: bool type: bool
default: 'no' default: false
maintenance_notify_1_hr: maintenance_notify_1_hr:
description: description:
- Notify subscribers 1 hour before maintenance start time - Notify subscribers 1 hour before maintenance start time
type: bool type: bool
default: 'no' default: false
maintenance_id: maintenance_id:
type: str type: str
description: description: