forked from bb-Ricardo/netbox-sync
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig.py
145 lines (120 loc) · 6.29 KB
/
config.py
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
# -*- coding: utf-8 -*-
# Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
#
# netbox-sync.py
#
# This work is licensed under the terms of the MIT license.
# For a copy, see file LICENSE.txt included in this
# repository or visit: <https://opensource.org/licenses/MIT>.
from module.config.option import ConfigOption
from module.config.base import ConfigBase
from module.config import netbox_config_section_name
from module.common.logging import get_logger
log = get_logger()
class NetBoxConfig(ConfigBase):
"""Controls the connection parameters to your netBox instance
"""
section_name = netbox_config_section_name
def __init__(self):
self.options = [
ConfigOption("api_token",
str,
description="""Requires an NetBox API token with full permissions on all objects except
'auth', 'secrets' and 'users'
""",
config_example="XYZ",
mandatory=True,
sensitive=True),
ConfigOption("host_fqdn",
str,
description="Requires a hostname or IP which points to your NetBox instance",
config_example="netbox.example.com",
mandatory=True),
ConfigOption("port",
int,
description="""Define the port your NetBox instance is listening on.
If 'disable_tls' is set to "true" this option might be set to 80
""",
default_value=443),
ConfigOption("disable_tls",
bool,
description="Whether TLS encryption is enabled or disabled",
default_value=False),
ConfigOption("validate_tls_certs",
bool,
description="""Enforces TLS certificate validation. If this system doesn't trust the NetBox
web server certificate then this option needs to be changed
""",
default_value=True),
ConfigOption("proxy",
str,
description="""Defines a proxy which will be used to connect to NetBox.
Proxy setting needs to include the schema.
Proxy basic auth example: http://user:[email protected]:312
""",
config_example="http://example.com:3128"),
ConfigOption("client_cert",
str,
description="Specify a client certificate which can be used to authenticate to NetBox",
config_example="client.pem"),
ConfigOption("client_cert_key",
str,
description="Specify the client certificate private key belonging to the client cert",
config_example="client.key"),
ConfigOption("prune_enabled",
bool,
description="""Whether items which were created by this program but
can't be found in any source anymore will be deleted or not
""",
default_value=False),
ConfigOption("prune_delay_in_days",
int,
description="""Orphaned objects will first be tagged before they get deleted.
Once the amount of days passed the object will actually be deleted
""",
default_value=30),
ConfigOption("ignore_unknown_source_object_pruning",
bool,
description="""This will tell netbox-sync to ignore objects in NetBox
with tag 'NetBox-synced' from pruning if the source is not defined in
this config file (https://github.com/bb-Ricardo/netbox-sync/issues/176)
""",
default_value=False),
ConfigOption("default_netbox_result_limit",
int,
description="""The maximum number of objects returned in a single request.
If a NetBox instance is very quick responding the value should be raised
""",
default_value=200),
ConfigOption("timeout",
int,
description="""The maximum time a query is allowed to execute before being
killed and considered failed
""",
default_value=30),
ConfigOption("max_retry_attempts",
int,
description="""The amount of times a failed request will be reissued.
Once the maximum is reached the syncing process will be stopped completely.
""",
default_value=4),
ConfigOption("use_caching",
bool,
description="""Defines if caching of NetBox objects is used or not.
If problems with unresolved dependencies occur, switching off caching might help.
""",
default_value=True),
ConfigOption("cache_directory_location",
str,
description="The location of the directory where the cache files should be stored",
default_value="cache")
]
super().__init__()
def validate_options(self):
for option in self.options:
if option.key == "proxy" and option.value is not None:
if "://" not in option.value or \
(not option.value.startswith("http") and not option.value.startswith("socks5")):
log.error(f"Config option 'proxy' in '{NetBoxConfig.section_name}' must contain the schema "
f"http, https, socks5 or socks5h")
self.set_validation_failed()