File: lookup.md

package info (click to toggle)
python-pyfunceble 4.2.29.dev-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,108 kB
  • sloc: python: 27,413; sh: 142; makefile: 27
file content (174 lines) | stat: -rw-r--r-- 3,822 bytes parent folder | download
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# `lookup`

To lookup or not lookup, that is the question!

## Overview

```yaml title=".PyFunceble.overwrite.yaml"
lookup:
  # Provides everything related to the lookups.

  # Enable/Disable the usage of DNS records to lookup the status.
  #
  # CLI Argument: --dns-lookup
  # Exclusive CLI Argument: --dns-lookup-only
  dns: yes

  # Enable/Disable the usage of HTTP status codes to lookup the status.
  #
  # CLI Argument: --http | --http-status-code-lookup
  # Exclusive CLI Argument: --http-only | --http-status-code-lookup
  http_status_code: yes

  # Enable/Disable the usage of network (information) socket to lookup the status.
  #
  # CLI Argument: --netinfo-lookup
  # Exclusive CLI Argument: --netinfo-lookup-only
  netinfo: yes

  # Enable/Disable the usage of special rules to lookup or switch the status.
  #
  # CLI Argument: --special-lookup
  # Exclusive CLI Argument: --special-lookup-only
  special: yes

  # Enable/Disable the usage of WHOIS records to lookup the status.
  #
  # CLI Argument: --whois-lookup
  # Exclusive CLI Argument: --whois-lookup-only
  whois: yes

  # Enable/Disable the usage of the reputation data to lookup the status.
  #
  # NOTE:
  #     The reputation lookup is actualy a lookup against the AlienVault IPv4
  #     reputation file.s
  #
  # CLI Argument: --reputation-lookup
  # Exclusive CLI Argument: --reputation-lookup
  reputation: no

  # Enable/Disable the usage of the platform (API) to lookup the status.
  #
  # CLI Argument: --platform-lookup
  # Exclusive CLI Argument: --platform-lookup-only
  platform: no

  # Set the timeout to apply to each of our lookup methods - when possible.
  #
  # WARNING:
  #     This should be a value >= 0.
  #
  # CLI Argument: -t | --timeout
  timeout: 5
```

## `dns`

Enable or disable the usage of DNS recors to lookup the status.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--dns-lookup`

**Exclusive CLI Argument:** `--dns-lookup-only`

## `http_status_code`

Enable or disable the usage of HTTP status codes to lookup the status.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--http-only`, `--http-status-code-lookup`

**Exclusive CLI Argument:** `--http-only`, `--http-status-code-lookup-only`

## `netinfo`

Enable or disable the usage of network (information) socket to lookup the status.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--netinfo-lookup`

**Exclusive CLI Argument:** `--netinfo-lookup-only`

## `special`

Enable or disable the usage of special rules to lookup or switch the status.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--special-lookup`

**Exclusive CLI Argument:** `--special-lookup-only`

## `whois`

Enable or disable the usage of WHOIS records to lookup the status.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--whois-lookup`

**Exclusive CLI Argument:** `--whois-lookup-only`

## `reputation`

Enable or disable the usage of reputation data to lookup the status.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--reputation-lookup`

**Exclusive CLI Argument:** `--reputation-lookup-only`

## `platform`

Enable or disable the usage of the platform (API) to lookup the status.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--platform-lookup`

**Exclusive CLI Argument:** `--platform-lookup-only`

## `timeout`

Set the timeout to apply to each of our lookup methods - when possible.

**Type:** integer

**Default Value:** `5`

**Available Values:** Any value greater that `0`.

**CLI Argument:** `-t`, `--timeout`