forked from jamesb2147/netbox-status-loader
/
ping_to_netbox.py
281 lines (262 loc) · 11.5 KB
/
ping_to_netbox.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
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
#Copyright Sean Hunter
#Using MIT License (see license file for detail)
import json, requests, ipaddress, dns.resolver, datetime
#Python3 way (currently broken)
#import ping3
#Python2 way (currently the only non-broken way)
import ping
from multiprocessing import Pool
session = requests.Session()
# FOR DEBUG
#import requests_mock
#adapter = requests_mock.Adapter()
#session.mount('http://', adapter)
#adapter.register_uri(requests_mock.ANY, requests_mock.ANY, text='{"results": [], "next": null}')
#############################################################################
#DEAR USER - YOU MUST DEFINE EVERYTHING FROM HERE ###########################
#############################################################################
#How long to wait for ping responses
timeout = 2
#Currently configured for a local run against a Docker Netbox install
#Adjust to fit your environment (in prod, probably on port 80 or 443)
ip_addresses_url = "http://localhost:32768/api/ipam/ip-addresses/"
ip_prefixes_url = "http://localhost:32768/api/ipam/prefixes/"
#Authorization header
#This must be generated from the Netbox web UI at http://netbox/user/api-tokens/
header={"Authorization": "Token 0123456789abcdef0123456789abcdef01234567"}
#Set to:
#1 - Scan RFC1918 space (192.168.0.0/16, 172.16.0.0/12, 10.0.0.0/8)
#2 - Scan IP addresses defined in Netbox
#3 - Scan prefixes defined in Netbox
#4 - Scan user defined prefixes
load_scanner_from_rfc1918_or_netbox = 4
# global_subnets is subnets options in case of 4
global_subnets = [u'10.0.0.0/21']
#OK, don't touch this line
myResolver = dns.resolver.Resolver()
#But MAKE CERTAIN that this one fits your environment; there will be reverse
#DNS requests made to this(these) server(s)
myResolver.nameservers = ['192.168.0.1','172.16.0.1','10.0.0.1']
#Determines the number of simultaneous pings to execute during timeout
#This can have a *very* high impact on performance, and can impact system
#stability so it is advised to only mess with it if you really know what you
#are doing
numProcesses = 250
#############################################################################
#THROUGH HERE ###############################################################
#############################################################################
#NOTE: Current possible status for IP addresses in Netbox include:
#1 - Active
#2 - Reserved
#3 - Deprecated
#5 - DHCP
#Don't ask what happened to 4. I assume Jeremy Stretch murdered him, the poor fellow.
def threadedPingReverseSave(addr):
#Drop trailing /xx
ip = (addr['address'].split("/"))[0]
#Run ping twice - first to ensure ARP completes before second ping goes through
#this is often visible in labs where the first ping to a newly online device will fail
ping.do_one(ip, timeout, 64)
rtt = ping.do_one(ip, timeout, 64)
#Create the appropriate search string for a PTR record by reversing the IP space and
#adding in-addr.arpa to the query
dnsreq = '.'.join(reversed(ip.split("."))) + ".in-addr.arpa"
#If the ping failed...
if rtt == None:
if __debug__:
print(ip + ": NO RESPONSE BEFORE ICMP TIMEOUT EXPIRY")
#There's not a great answer here, so we're going to assume the IP is merely reserved
#Feel free to adjust this to your needs
addr['status']=2
try:
#Do a reverse DNS (aka pointer/PTR) query
myResolver.query(dnsreq, "PTR")
dnsreply = myResolver.query(dnsreq, "PTR").response.answer
for i in dnsreply:
for j in i.items:
#Save the reply to the description
addr['description'] = j.to_text().rstrip('.')
#Always save IP addresses with a reverse.
saveAddr(addr)
except:
#If there is no reply, set the description variable to...
addr['description'] = "No reverse."
#No ping, but it is an IP-address scan, so we should save the result
#Otherwise, it's from a prefix or RFC1918 space, so do NOT save it
#this allows you to programmatically pull free IP addresses as needed
if load_scanner_from_rfc1918_or_netbox == 2:
saveAddr(addr)
#raise
#If the ping succeeded...
else:
addr['status'] = 1
try:
#Do a reverse DNS (aka pointer/PTR) query
myResolver.query(dnsreq, "PTR")
dnsreply = myResolver.query(dnsreq, "PTR").response.answer
for i in dnsreply:
for j in i.items:
#Save the reply to a description variable
desc = j.to_text()
except:
#If there is no reply, set the description variable to...
desc = "No reverse.."
#raise
if __debug__:
print(ip + ": " + str(rtt) + "s and reverse: " + desc)
#Remove the right-most period (DNS resolver returns one, e.g. example.com.)
addr['description'] = desc.rstrip('.')
#Always save successful pings
saveAddr(addr)
result = addr
return result
def saveAddr(addr):
if __debug__:
print("entered saveAddr for " + addr['address'])
if addr['isNew'] == "new":
addr.pop('isNew', None)
post = session.post(ip_addresses_url, headers=header, json=addr)
if __debug__:
print(post.status_code)
if __debug__:
print(post.json())
elif addr['isNew'] == "old":
addr.pop('isNew', None)
try:
role = addr['role']['value']
addr.pop('role', None)
addr['role'] = role
except:
#Do nothing
if __debug__:
print("Role exception.")
post = session.put(ip_addresses_url + str(addr['id']) + "/", headers=header, json=addr)
if __debug__:
print(post.status_code)
if __debug__:
print(post.json())
return addr
def mergeWithExisting(addr, listOfIps):
for ip_addr in listOfIps:
if __debug__:
print("IP to match: " + addr['address'] + " and checking against IP: " + ip_addr['address'])
if ip_addr['address'] == addr['address']:
if __debug__:
print("MATCH: " + json.dumps(ip_addr, indent=4))
#Get 'id' from existing and stuff it in addr
if __debug__:
print(ip_addr['id'])
addr['id'] = ip_addr['id']
addr['isNew'] = "old"
return addr
if __name__ == '__main__':
start = datetime.datetime.now()
if load_scanner_from_rfc1918_or_netbox == 1:
#Load from RFC1918
if __debug__:
print("Not currently loading addresses from RFC1918, even though I was told to!!")
if load_scanner_from_rfc1918_or_netbox == 2:
#GET IP addresses from Netbox
response = session.get(ip_addresses_url, headers = header)
listOfIpsWithMask = response.json()['results']
while response.json()['next'] is not None:
response = session.get(response.json()['next'], headers = header)
for ip in response.json()['results']:
listOfIpsWithMask.append(ip)
for ipaddr in listOfIpsWithMask:
ipaddr['isNew'] = "old"
if __debug__:
print("Populated from list of existing IP addresses. No new ones will be scanned.")
if load_scanner_from_rfc1918_or_netbox == 3:
#GET IP prefixes from Netbox
response = session.get(ip_prefixes_url, headers = header)
listOfPrefixes = response.json()['results']
while response.json()['next'] is not None:
response = session.get(ip_prefixes_url, headers = header)
for prefix in response.json()['results']:
listOfPrefixes.append(prefix)
if __debug__:
print(json.dumps(listOfPrefixes, indent=4))
listOfIps = []
for prefixObj in listOfPrefixes:
if __debug__:
print(prefixObj['prefix'])
#print(ipaddress.ip_network(prefixObj['prefix']).hosts())
mask = prefixObj['prefix'].split("/")[1]
for host in ipaddress.ip_network(prefixObj['prefix']).hosts():
listOfIps.append({"address": str(host) + "/" + mask})
listOfIpsWithMask = listOfIps
if __debug__:
print("List of IP's with mask: ")
if __debug__:
print(listOfIpsWithMask)
if __debug__:
print("List of existing IP addresses: ")
ip_result = session.get(ip_addresses_url, headers = header)
listOfIps = ip_result.json()['results']
while ip_result.json()['next'] is not None:
ip_result = session.get(ip_result.json()['next'], headers = header)
for ip in ip_result.json()['results']:
listOfIps.append(ip)
if __debug__:
print(json.dumps(listOfIps, indent=4))
for ipaddr in listOfIpsWithMask:
ipaddr['isNew'] = "new"
ipaddr = mergeWithExisting(ipaddr, listOfIps)
if __debug__:
print(json.dumps(ipaddr, indent=4))
if load_scanner_from_rfc1918_or_netbox == 4:
listOfPrefixes = [{'prefix': s} for s in global_subnets]
if __debug__:
print(json.dumps(listOfPrefixes, indent=4))
listOfIps = []
for prefixObj in listOfPrefixes:
if __debug__:
print(prefixObj['prefix'])
#print(ipaddress.ip_network(prefixObj['prefix']).hosts())
mask = prefixObj['prefix'].split("/")[1]
for host in ipaddress.ip_network(prefixObj['prefix']).hosts():
listOfIps.append({"address": str(host) + "/" + mask})
listOfIpsWithMask = listOfIps
if __debug__:
print("List of IP's with mask: ")
if __debug__:
print(listOfIpsWithMask)
if __debug__:
print("List of existing IP addresses: ")
ip_result = session.get(ip_addresses_url, headers = header)
listOfIps = ip_result.json()['results']
while ip_result.json()['next'] is not None:
ip_result = session.get(ip_result.json()['next'], headers = header)
for ip in ip_result.json()['results']:
listOfIps.append(ip)
if __debug__:
print(json.dumps(listOfIps, indent=4))
for ipaddr in listOfIpsWithMask:
ipaddr['isNew'] = "new"
ipaddr = mergeWithExisting(ipaddr, listOfIps)
if __debug__:
print(json.dumps(ipaddr, indent=4))
# print "Stopping..." + None
#Pretty print new copy for debugging
if __debug__:
print(json.dumps(listOfIpsWithMask, indent=4))
#Multithread the process. This isn't to speed up "processing" but eliminate the
#wait on timeout expiry; adjust to speed up/slow down system.
pool = Pool(processes=numProcesses)
#Here, we call isPingable for every entity in listOfIpsWithMask
result = pool.map(threadedPingReverseSave, listOfIpsWithMask)
#Presently looking at solutions that can sort this mess by IP address... currently results are unsorted.
if __debug__:
print(result)
if __debug__:
print(json.dumps(result, indent=4))
# r = session.post(ip_addresses_url, headers=header, json={"address": "192.168.3.2", "status": "1"})
# print r.status_code
# print r.json()
finish = datetime.datetime.now()
print("Completed in: " + str(finish - start))
pingable = list(filter(lambda x: x['status'] == 1, result))
unpingable = list(filter(lambda x: x['status'] == 2, result))
print("UP IPs: " + str(len(pingable)))
print("DOWN IPs: " + str(len(unpingable)))