Skip to main content

Netbox Plugin to store textfiles(e.g. configs) alongside devices

Project description

netbox_textdatastore

Store raw text files for devices, like configuration files, unparsed command output or test results Use version 0.0.5 for netbox 3.6

TextData Object: ''' { "id": Int, # unique id "name": String, # Object Name, eg "device config" 'device': Device ID, # Device ID from Netbox 'hash': String, # Hash of your Text Data 'data': String, # Your text data, eg Device Configfile } '''

Example:

extend python-netbox

https://github.com/jagter/python-netbox

''' from netbox import NetBox as NetBoxOrig

class textdata(object):

def __init__(self, netbox_con):
    self.netbox_con = netbox_con

def get_data(self, **kwargs):
    return self.netbox_con.get('/plugins/textdata/data/', **kwargs)

def add_data(self, device, name, hash, data,  **kwargs):
    required_fields = {
        "name": name,
        'device': device,
        'hash': hash,
        'data': data,
        }
    print(required_fields)

    return self.netbox_con.post(
        '/plugins/textdata/data/',
        required_fields,
        **kwargs
    )

def update_data_id(self, pk, **kwargs):
    return self.netbox_con.patch(
        '/plugins/textdata/data/',
        pk,
        **kwargs
    )

class NetBox(NetBoxOrig):

def __init__(self, host, **kwargs):
    super().__init__(host, **kwargs)
    self.textdata = textdata(self.connection)

'''

use it in napalm

''' def store_config(task, obj, content): """store config to netbox"""

hasher = md5()
hasher.update(content.encode('utf-8'))
hash = hasher.hexdigest()
device_id = task.host.data["id"]
res = obj.netbox.textdata.get_data(
    device_id=device_id,
    name="device config"
)
if(len(res) > 0):
    res = res[0]
    if(res["hash"] == hash):
        print("No change")
        return
    print(obj.netbox.textdata.update_data_id(
        pk=res["pk"],
        data=content,
        hash=hash
    ))
    return
print(obj.netbox.textdata.add_data(
    device=device_id,
    name="device config",
    hash=hash,
    data=content
))

def backup_config(task, obj): """ get config from devices"""

from nornir_napalm.plugins.tasks import napalm_get
device_config = task.run(task=napalm_get, getters=["config"])
task.run(
    task=store_config,
    obj=obj,
    content=device_config.result["config"]["running"]
)

'''

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_textdatastore-0.1.1.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_textdatastore-0.1.1-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file netbox_textdatastore-0.1.1.tar.gz.

File metadata

  • Download URL: netbox_textdatastore-0.1.1.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for netbox_textdatastore-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e7dcc04a6852ad0148e100200642b0a716b8aae96a39c600f698c7f2dcb26aa0
MD5 145277a1381d3672220f04437ad88ddd
BLAKE2b-256 8953b9b78babcd5ef487f56562c52dad882bd47e7ec4d4ba22d511ff4026a14c

See more details on using hashes here.

File details

Details for the file netbox_textdatastore-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_textdatastore-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 85dae89441cee74a147c162100d375e1d8fe74b00aa89343c1eb5c14aefd677e
MD5 e30da94d354fc33d9ffb5249a3f507d7
BLAKE2b-256 24ad757169dc484655438ecc2c42daefa222203b0a7ac9b31da288af220b8dc8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page