aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/meta/argument_specs.yml
blob: b35c993a5526ed0cf9098f80e800316066b53793 (plain) (blame)
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
---
argument_specs:
  main:
    options:

################################################################################
# Required
################################################################################
      prometheus_target_host:
        type: str
        required: true

################################################################################
# Optional
################################################################################
      prometheus_target_exporter_target_prefix:
        type: str
        required: false
        default: ""

      prometheus_target_strategy:
        type: str
        required: false
        default: lineinfile
        choices:
          - lineinfile
          - yaml

      prometheus_target_strategy_lineinfile_prefix:
        type: str
        required: false
        default: "    - "

      prometheus_target_strategy_lineinfile_suffix:
        type: str
        required: false
        default: ""

      prometheus_target_handler_command_enabled:
        type: bool
        required: false
        default: false

      prometheus_target_handler_command_become:
        type: bool
        required: false
        default: true

      prometheus_target_handler_command_become_method:
        type: str
        required: false

      prometheus_target_handler_command_become_user:
        type: str
        required: false

      prometheus_target_handler_command_run_once:
        type: bool
        required: false
        default: false

      prometheus_target_handler_command:
        type: dict
        required: false
        # Options from ansible command module
        # https://docs.ansible.com/ansible/latest/collections/ansible/builtin/command_module.html

      prometheus_target_handler_shell_enabled:
        type: bool
        required: false
        default: false

      prometheus_target_handler_shell_become:
        type: bool
        required: false
        default: true

      prometheus_target_handler_shell_become_method:
        type: str
        required: false

      prometheus_target_handler_shell_become_user:
        type: str
        required: false

      prometheus_target_handler_shell_run_once:
        type: bool
        required: false
        default: false

      prometheus_target_handler_shell:
        type: dict
        required: false
        # Options from ansible shell module
        # https://docs.ansible.com/ansible/latest/collections/ansible/builtin/shell_module.html

      prometheus_target_exporter_defaults:
        type: dict
        required: false
        default: {}

      prometheus_target_exporter:
        type: list
        required: false
        default: []
        elements: dict
        options:
          id:
            type: str
            required: false
          path:
            type: str
            required: false
          path_prefix:
            type: str
            required: false
          host:
            type: str
            required: false
          labels:
            type: dict
            required: false
            description: Labels to match the target group in the YAML file (yaml strategy only)

      prometheus_target_default_exporters:
        type: list
        required: false
        default: []
        elements: dict
        options:
          id:
            type: str
            required: false
          path:
            type: str
            required: false
          path_prefix:
            type: str
            required: false
          host:
            type: str
            required: false
          labels:
            type: dict
            required: false
            description: Labels to match the target group in the YAML file (yaml strategy only)

      prometheus_target_skip_default_exporters:
        type: bool
        required: false
        default: false