From 2b922954f4a3a9f8373ec084f2cd9a6e3c5bb69c Mon Sep 17 00:00:00 2001 From: Julian Noble Date: Thu, 18 Aug 2022 13:04:03 +0000 Subject: [PATCH] Update 'Home' --- Home.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..38f3f11 --- /dev/null +++ b/Home.md @@ -0,0 +1,18 @@ +Welcome to the Wiki for pyscaniptonetbox. + +This is a simplistic script which scans an IPV4 network (using ping via python networkscan library) and then adds each IP address to a Netbox server that is configured in local_settings.yaml + +local_settings.yaml will require the netbox server url and an api Key. +For this reason - local_settings.yaml is configured in .gitignore + +There is a sample in examples/local_settings_SAMPLE.yaml + + +The script takes as the first argument, the name of the 'tenant' configured in Netbox to determine what IP prefixes are assigned. +The second argument is the IP subnet to scan in CIDR notation e.g 192.168.1.0/24 + +An actual update will only be performed if the word 'update' is typed at the relevant prompt. +(todo - add extra flags to allow non-interactive use) + + +