Skip to main content

Configuration manager for network devices

Project description

Homer allows to manage the lifecycle of the configuration for network devices, generating and deploying their configuration.

The configuration generation is based on YAML files to define variables and Jinja2 templates. The YAML files allow for hierarchical override of variables based on the device role, site or hostname. Once generated, the configuration can be deployed to the selected devices.

The device list can either live hardcoded in the configuration files or be dynamically gathered from Netbox. When using Netbox as inventory both the Virtual Chassis endpoint and the Device endpoint are used to select all the devices that matches the configured whitelist of device roles and statuses.

Also when using Netbox as inventory for each device additional metadata is exposed to the templates, namely:

  • role: device role slug

  • site: device site slug

  • type: device type slug

  • ip4: primary IPv4 without netmask

  • ip6: primary IPv6 without netmask

  • netbox_object: the Netbox device object. Directly exposed data should always be preferred in templates. It is exposed to not be a blocker in case some additional data is needed that is not yet exposed by Homer explicitely. It could be removed in a future release.

If any metadata is present in the YAML inventory file when using Netbox as inventory, this additional metadata ie exposed too to the templates, with the Netbox values having precedence in case of overlapping keys.

When using Netbox to gather dynamic configuration, it’s also possible to write a custom plugin in the form of a Python module that implements a class called NetboxDeviceDataPlugin that inherits from homer.netbox.BaseNetboxDeviceData and is in the Python PATH. Assuming that the plugin class implements a method named _get_name, it will be accessible within the templates with netbox.device_plugin.name.

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

homer-0.7.0.tar.gz (55.8 kB view details)

Uploaded Source

Built Distribution

homer-0.7.0-py3-none-any.whl (33.3 kB view details)

Uploaded Python 3

File details

Details for the file homer-0.7.0.tar.gz.

File metadata

  • Download URL: homer-0.7.0.tar.gz
  • Upload date:
  • Size: 55.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for homer-0.7.0.tar.gz
Algorithm Hash digest
SHA256 efaf9b3948f6aecdf88cc87c0296a18aed77c152489a7f85c571965fb16f9e57
MD5 b3d889a0d4d384c16673878d01d7cc2c
BLAKE2b-256 0204f5413c92d5e0274e07624a5687df550388ad88e5845b4e744c2d650f7ca5

See more details on using hashes here.

File details

Details for the file homer-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: homer-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 33.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for homer-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11a62cb0aeedc91ffd90bb1d6a3acb79500cbedb7da67ac0dbe07ea683300a09
MD5 aa18a7320c3c59d68855f4d27da4e049
BLAKE2b-256 53c929e6be4b95e079df3d5662aa5c55400fc2007d7f808ab6a53456dde52940

See more details on using hashes here.

Supported by

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