netbox: _get_circuits: add patch panel support.
When an interface is connected to a patch panel, traverse it to expose the "real" z side.
Requires Netbox 3.1 minimum.
Add Python 3.10 support.
config: fix type hints for YAML callables.
doc: set default language.
transports: allow to set a global timeout in the configuration file for all transports related operations.
devices: allow to pass additional metadata
When using Netbox as inventory for the device list, the device metadata comes from Netbox and any metadata present in the YAML configuration file
Fix this behaviour loading any additional metadata present in the
devices.yamlfile for each device and merge it with the metadata generated from Netbox data.
If a key is present in both sources, the Netbox data has precedence and the data from the
devices.yamlfile is silently discarded.
transports: allow to override the global timeout on a per-device basis through the
devices.yamlfile passing additional metadata to the host using the
homer: expand user paths when reading
~/some_configis a supported use case.
capirca: catch also requests exceptions that are not catched by pynetbox.
prospector: update config for latest version.
setup.py: add missing types for requests.
netbox: inject in the device metadata also the device status from Netbox so that it can be used to query (i.e. status:active).
transports.junos: catch another timeout exception (
jnpr.junos.exception.RpcTimeoutError) on close that was raised in some real life usage.
Added option to disable Capirca ACL generation completely
Capirca: disable shade check
Force paramiko to 2.8.1
Bump Capirca to 2.0.4
transports: catch connection error:
To prevent that a connection error on one device fails the entire run for all devices, catch a new
HomerConnectErrorwhen executing the action on the devices.
JunOS transport: raise
HomerConnectErrorwhen failing to connect to the device.
Exceptions: add a new
Fix typo in retry log message on timeout.
Add Python 3.9 support.
setup.py: include type hints for dependencies.
pylint: fixed newly reported issues.
setup.py: limit max version of pynetbox that in release 6.0.0 introduced some breacking changes in the API.
doc: fix documentation generation that prevented from properly including the auto-generated documentation.
tests: fix pip backtracking moving prospector to its own environment in tox.
tests: add missing tests for the circuits and vlan capabilities in the Netbox module.
tests: add missing tests for the device data inventory.
tests: fix typo in mocked object.
tests: fix deprecated pytest CLI argument.
junos: catch exceptions in rollbacks. The rollback operation could also fail, catch the error and log it but do not make the whole run to fail.
dependency: remove temporary upper limit for test dependency prospector, not needed anymore.
--skip B322from Bandit config, not supported anymore.
type hints: mark the package as type hinted, making it PEP 561 compatible.
netbox: make Netbox errors surface through Jinja:
When an error in the calls to Netbox API occurs it currently gets swallowed by Jinja behing an
Make it explicitely raise an
HomerErrorthat gets correctly reported from Jinja showing the original traceback, needed for debug.
templates: add support for private templates:
Tell Jinja2 to load templates also from the private path if it's set, to enable the support for private templates or subtemplates.
netbox: add circuits support:
Pulls all the cables terminating on the target device to then find the circuits attached to those cables.
setup.py: add upper limit to prospector version
Packaging: define a standard
homer_pluginsname for the external plugins and explicitely exclude them from the PyPI packaging.
Removed support for Python version 3.5 and 3.6.
Improve error catching (T253795).
For the diff action catch all the errors directly in the transport in order to return a consistent success and diff result for each device, skipping as a result those with failure. In case of failure return
Noneso that it can be distinguished from an empty diff and reported as such both in logging and in the output.
For the commit action let the exceptions raise in the transport and be catched and logged in the main
Homerclass with the same effective result that any failing device is skipped without interrupting the whole run.
In both cases log also the traceback when the debug logging is enabled.
netbox: adapt to new Netbox API
Netbox API starting with Netbox 2.8.0 have removed the choices API endpoint. Adapt the handling of the device status accordingly.
Add Python 3.8 support
transports.junos: do not commit check on empty diff:
When performing a commit check, do not actually run the
commit_checkon the device if there is no diff.
In all cases perform a rollback, even on empty diff.
Handle commit abort separately (T244362).
Introduce a new
HomerAbortErrorexception to specifically handle cases in which the user explicitely aborted a write operation.
In the commit callback raise an
HomerAbortErrorexception when the user abort the commit or reach the limit of invalid replies.
transports.junos: retry when a timeout occurs during commits (T244363).
transports.junos: handle timeouts separately (T244363).
RpcTimeoutErrorjunos exception separately to avoid to have a full stacktrace in the logs as it's a normal failure scenario.
TimeoutExpiredErrorncclient exception separately to avoid failures when calling
allow overriding the
ssh_configpath in homer's config.
plugins: initial implementation for Netbox data.
Allow to specify via configuration a Python module to load as a plugin for the Netbox data gathering.
When configured the plugin class is dynamically loaded and exposed to the templates as netbox.device_plugin.
It is basically the same implementation of
NetboxDeviceDatabut allows for any specific selection of data from Netbox that is not generic enough to be included in Homer itself.
commit: do not
commit_checkon initial empty diff.
As a consequence of commit
1edb7c2if a device have an empty diff and a commit is run on it, it will run a
commit_checkanyway. Avoid this situation skipping the whole operation if at the first attempt the diff is empty.
In case of enough timeouts that don't allow Homer to complete the commit operation within the same run, the automatic rollback should be waited before retrying, otherwise the device will just be skipped.
To achieve this, passing the attempt number to all the operation callbacks, also if it's currently only used in the commit one to keep the same interface for all of them.
diff: allow to omit the actual diff.
-o/--omit-diffoption to the
diffsub-command to allow to omit the actual diff for security reasons if the diff results will be used for monitoring/alarming purposes, as the diff might contain sensitive data.
diff: use different exit code if there is a diff (T249224).
To allow to run automatic checks on outstanding diffs between the devices running configuration and the one defined in Homer's config and templates, make the diff command to return a different exit code when successfull but there is any diff.
In case of failure the failure exit code will prevail.
netbox: silently skip devices without platform.
Some devices might not be reachable by default because not managed. Allow to more silently skip those (debug level logging only) if they are missing both the FQDN and the Platform in Netbox.
Sort deviced by FQDN
netbox: skip virtual chassis devices without a domain field set, as they would not be reachable.
examples: add comments to example config
config: complete test coverage
doc: fix example
/pluginsto gitignore to be able to link a plugin directory from other locations in a local checkout.
Make the transport username configurable
First release (T228388).