blob: 4fe8aee04e92ca85aed8db2fe71965923522dd4b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# -*- coding: utf-8 -*-
# Copyright: (c) 2019, XLAB Steampunk <steampunk@xlab.si>
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
class ModuleDocFragment(object):
DOCUMENTATION = """
options:
auth:
description:
- Authentication parameters. Can define each of them with ENV as well.
type: dict
suboptions:
user:
description:
- The username to use for connecting to the Sensu API.
If this is not set the value of the SENSU_USER environment
variable will be checked.
- This parameter is ignored if the I(auth.api_key) parameter is set.
type: str
default: admin
password:
description:
- The Sensu user's password.
If this is not set the value of the SENSU_PASSWORD environment
variable will be checked.
- This parameter is ignored if the I(auth.api_key) parameter is set.
type: str
default: P@ssw0rd!
url:
description:
- Location of the Sensu backend API.
If this is not set the value of the SENSU_URL environment variable
will be checked.
type: str
default: http://localhost:8080
api_key:
description:
- The API key that should be used when authenticating. If this is
not set, the value of the SENSU_API_KEY environment variable will
be checked.
- This replaces I(auth.user) and I(auth.password) parameters.
- For more information about the API key, refer to the official
Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/).
type: str
version_added: 1.3.0
verify:
description:
- Flag that controls the certificate validation.
- If you are using self-signed certificates, you can set this
parameter to C(false).
- ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use
self-signed certificates in production, see the I(auth.ca_path)
parameter.
- It is also possible to set this parameter via the I(SENSU_VERIFY)
environment variable.
type: bool
default: true
version_added: 1.5.0
ca_path:
description:
- Path to the CA bundle that should be used to validate the backend
certificate.
- If this parameter is not set, module will use the CA bundle that
python is using.
- It is also possible to set this parameter via the I(SENSU_CA_PATH)
environment variable.
type: path
version_added: 1.5.0
"""
|
