Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
You can contribute in many ways:
+
Types of Contributions
+
Report Bugs
+
Report bugs at https://github.com/miaow2/netbox-config-diff/issues.
+
If you are reporting a bug, please include:
+
+
Your operating system name and version.
+
Any details about your local setup that might be helpful in troubleshooting.
+
Detailed steps to reproduce the bug.
+
+
Fix Bugs
+
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
Implement Features
+
Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
Write Documentation
+
NetBox Config Diff Plugin could always use more documentation, whether as part of the
+official NetBox Config Diff Plugin docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
Submit Feedback
+
The best way to send feedback is to file an issue at https://github.com/miaow2/netbox-config-diff/issues.
+
If you are proposing a feature:
+
+
Explain in detail how it would work.
+
Keep the scope as narrow as possible, to make it easier to implement.
+
Remember that this is a volunteer-driven project, and that contributions
+ are welcome :)
+
+
Get Started!
+
Ready to contribute? Here's how to set up netbox-config-diff for local development.
When you're done making changes, check that your changes pass the
+ tests, including testing other Python versions, with tox:
+
$ poetry run tox
+
+
+
Commit your changes and push your branch to GitHub:
+
$ git add .
+$ git commit -m "Your detailed description of your changes."
+$ git push origin name-of-your-bugfix-or-feature
+
+
+
Submit a pull request through the GitHub website.
+
+
+
Pull Request Guidelines
+
Before you submit a pull request, check that it meets these guidelines:
+
+
The pull request should include tests.
+
If the pull request adds functionality, the docs should be updated. Put
+ your new functionality into a function with a docstring, and add the
+ feature to the list in README.md.
+
The pull request should work for Python 3.8, 3.9 and 3.10. Check
+ https://github.com/miaow2/netbox-config-diff/actions
+ and make sure that the tests pass for all supported Python versions.
+
+
Deploying
+
A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in CHANGELOG.md).
+Then run:
+
$ poetry run bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+
GitHub Actions will then deploy to PyPI if tests pass.
With this plugin you can find diff between the rendered configuration for a device to its actual configuration, retrieved from the device itself, or stored in DataSource.
+Read about DataSources for further details.
+
Device configuration renders natively in NetBox. This feature was introduced in 3.5 version.
+ NetBox Labs blog post about it.
+
Plugin supports a wide list of vendors (Cisco, Juniper, Huawei, MicroTik etc.) with the help of Scrapli. Read Scrapli and scrapli-community documentations to find full list of vendors.
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py,
+ or if you use netbox-docker, your /configuration/plugins.py file,
+ and define credentials for devices connection:
Also result is storing rendered and actual configurations from device.
+
Compliance finished with error
+
+
Render diff between configurations
+
+
No diff
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search/search_index.json b/search/search_index.json
new file mode 100644
index 0000000..b51f599
--- /dev/null
+++ b/search/search_index.json
@@ -0,0 +1 @@
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#about","title":"About","text":"
With this plugin you can find diff between the rendered configuration for a device to its actual configuration, retrieved from the device itself, or stored in DataSource. Read about DataSources for further details.
Device configuration renders natively in NetBox. This feature was introduced in 3.5 version. NetBox Labs blog post about it.
Plugin supports a wide list of vendors (Cisco, Juniper, Huawei, MicroTik etc.) with the help of Scrapli. Read Scrapli and scrapli-community documentations to find full list of vendors.
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py, or if you use netbox-docker, your /configuration/plugins.py file, and define credentials for devices connection:
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
"},{"location":"contributing/#types-of-contributions","title":"Types of Contributions","text":""},{"location":"contributing/#report-bugs","title":"Report Bugs","text":"
Report bugs at https://github.com/miaow2/netbox-config-diff/issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
NetBox Config Diff Plugin could always use more documentation, whether as part of the official NetBox Config Diff Plugin docs, in docstrings, or even on the web in blog posts, articles, and such.
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for Python 3.8, 3.9 and 3.10. Check https://github.com/miaow2/netbox-config-diff/actions and make sure that the tests pass for all supported Python versions.
Plugin adds a custom script ConfigDiffScript that runs all logic about diff calculations and connections to devices. You can find scripts list in navbar Customization -> Scripts.
In the script, you can define a site, on which devices run compliance, or devices. If you define both fields, script will run only on devices from Devices field
Warning
Script runs only on devices with status Active, assigned Primary IP, Platform and PlatformSetting
If you have configs in NetBox DataSource, you can define it, the script instead of connecting to devices will find configs in DataSource by device's names.
Warning
Be sure that DataSource is synced and has the latest data
Plugin adds a custom script ConfigDiffScript that runs all logic about diff calculations and connections to devices.
+You can find scripts list in navbar Customization -> Scripts.
+
+
In the script, you can define a site, on which devices run compliance, or devices.
+ If you define both fields, script will run only on devices from Devices field
+
+
Warning
+
Script runs only on devices with status Active, assigned Primary IP, Platform and PlatformSetting
+
+
If you have configs in NetBox DataSource, you can define it, the script instead of connecting to devices will find configs in DataSource by device's names.
+
+
Warning
+
Be sure that DataSource is synced and has the latest data
+
+
+
Note
+
Only synced DataSources are acceptable
+
+
+
Results
+
After script is done you can find results in Config Compliances menu. Each device has its own result.
+
+
Also result is storing rendered and actual configurations from devices.
+
With the help of netutils library plugin stores missing and extra config lines.
