mirror of
https://github.com/bb-Ricardo/netbox-sync.git
synced 2026-01-20 07:50:16 -06:00
146 lines
4.3 KiB
Python
Executable File
146 lines
4.3 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# -*- 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>.
|
|
|
|
self_description = """
|
|
Sync objects from various sources to NetBox
|
|
"""
|
|
|
|
|
|
from datetime import datetime
|
|
|
|
from module.common.misc import grab, get_relative_time, do_error_exit
|
|
from module.common.cli_parser import parse_command_line
|
|
from module.common.logging import setup_logging
|
|
from module.netbox.connection import NetBoxHandler
|
|
from module.netbox.inventory import NetBoxInventory
|
|
from module.sources import instantiate_sources
|
|
from module.config.parser import ConfigParser
|
|
from module.common.config import CommonConfig
|
|
from module.config.file_output import ConfigFileOutput
|
|
from module import __version__, __version_date__, __description__
|
|
|
|
|
|
def main():
|
|
|
|
start_time = datetime.now()
|
|
|
|
# parse command line
|
|
args = parse_command_line(self_description=self_description)
|
|
|
|
# write out default config file and exit if "generate_config" is defined
|
|
ConfigFileOutput(args)
|
|
|
|
# parse config files and environment variables
|
|
config_parse_handler = ConfigParser()
|
|
config_parse_handler.add_config_file_list(args.config_files)
|
|
config_parse_handler.read_config()
|
|
|
|
# read common config
|
|
common_config = CommonConfig().parse(do_log=False)
|
|
|
|
# cli option overwrites config file
|
|
log_level = grab(args, "log_level", fallback=common_config.log_level)
|
|
|
|
log_file = None
|
|
if common_config.log_to_file is True:
|
|
log_file = common_config.log_file
|
|
|
|
# setup logging
|
|
log = setup_logging(log_level, log_file)
|
|
|
|
# now we are ready to go
|
|
log.info(f"Starting {__description__} v{__version__} ({__version_date__})")
|
|
for config_file in config_parse_handler.file_list:
|
|
log.debug(f"Using config file: {config_file}")
|
|
|
|
# exit if any parser errors occurred here
|
|
config_parse_handler.log_end_exit_on_errors()
|
|
|
|
# just to print config options to log/console
|
|
CommonConfig().parse()
|
|
|
|
# initialize an empty inventory which will be used to hold and reference all objects
|
|
inventory = NetBoxInventory()
|
|
|
|
# establish NetBox connection
|
|
nb_handler = NetBoxHandler()
|
|
|
|
# if purge was selected we go ahead and remove all items which were managed by this tools
|
|
if args.purge is True:
|
|
|
|
if args.dry_run is True:
|
|
do_error_exit("Purge not available with option 'dry_run'")
|
|
|
|
nb_handler.just_delete_all_the_things()
|
|
|
|
# that's it, we are done here
|
|
exit(0)
|
|
|
|
# instantiate source handlers and get attributes
|
|
log.info("Initializing sources")
|
|
sources = instantiate_sources()
|
|
|
|
# all sources are unavailable
|
|
if len(sources) == 0:
|
|
log.error("No working sources found. Exit.")
|
|
exit(1)
|
|
|
|
# collect all dependent object classes
|
|
log.info("Querying necessary objects from NetBox. This might take a while.")
|
|
for source in sources:
|
|
nb_handler.query_current_data(source.dependent_netbox_objects)
|
|
|
|
log.info("Finished querying necessary objects from NetBox")
|
|
|
|
# resolve object relations within the initial inventory
|
|
inventory.resolve_relations()
|
|
|
|
# initialize basic data needed for syncing
|
|
nb_handler.initialize_basic_data()
|
|
|
|
# loop over sources and patch netbox data
|
|
for source in sources:
|
|
log.debug(f"Retrieving data from source '{source.name}'")
|
|
source.apply()
|
|
|
|
# add/remove tags to/from all inventory items
|
|
inventory.tag_all_the_things(nb_handler)
|
|
|
|
# update all IP addresses
|
|
inventory.query_ptr_records_for_all_ips()
|
|
|
|
if args.dry_run is True:
|
|
log.info("This is a dry run and we stop here. Running time: %s" %
|
|
get_relative_time(datetime.now() - start_time))
|
|
exit(0)
|
|
|
|
# update data in NetBox
|
|
nb_handler.update_instance()
|
|
|
|
# prune orphaned objects from NetBox
|
|
nb_handler.prune_data()
|
|
|
|
# loop over sources and patch netbox data
|
|
for source in sources:
|
|
# closing all open connections
|
|
source.finish()
|
|
|
|
# closing NetBox connection
|
|
nb_handler.finish()
|
|
|
|
# finish
|
|
log.info("Completed NetBox Sync in %s" % get_relative_time(datetime.now() - start_time))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|
|
|
|
# EOF
|