Skip to content

Feature nautobot inventory#934

Open
housepbass wants to merge 16 commits intonetenglabs:developfrom
housepbass:feature_nautobot_inventory
Open

Feature nautobot inventory#934
housepbass wants to merge 16 commits intonetenglabs:developfrom
housepbass:feature_nautobot_inventory

Conversation

@housepbass
Copy link
Copy Markdown

@housepbass housepbass commented Apr 8, 2024 •
edited
Loading

Related Issue

Fixes #921

Description

Nautobot has been added as a dynamic inventory source for SuzieQ.

Type of change

  • New feature (non-breaking change which adds functionality)
  • Documentation update

New Behavior

Users can now specify nautobot as an inventory source for SuzieQ. The feature uses Pynautobot and allows for Nautobot 2.x support. Filtering is possible using pynautobot's filters:

sources:
  - name: nautobot-instance
    token: 0123456789abcdef0123456789abcdef01234567
    url: http://localhost:8080
    ssl-verify: false
    type: nautobot
    period: 3600
    device_filters: # pynautobot filters
      location: "Athens, GA"
      role: "Spine"

Contrast to Current Behavior

Nautobot is not currently supported.

Discussion: Benefits and Drawbacks

  • I have read the comments and followed the CONTRIBUTING.md.
  • I have explained my PR according to the information in the comments or in a linked issue.
  • My PR source branch is created from the develop branch.
  • My PR targets the develop branch.
  • All my commits have --signoff applied (Only my last commit has this, how can I remediate?)

@housepbass housepbass force-pushed the feature_nautobot_inventory branch from d476abf to e7aa786 Compare April 8, 2024 20:27
LucaNicosia
LucaNicosia requested changes Apr 9, 2024
View reviewed changes
Comment thread docs/inventory.md Outdated
Comment thread pyproject.toml Outdated
Comment thread suzieq/poller/controller/source/nautobot.py Outdated
Comment thread suzieq/poller/controller/source/nautobot.py
Comment on lines +151 to +165
if self._data.device_filters:
devices = self._session.dcim.devices.filter(**self._data.device_filters)
else:
devices = self._session.dcim.devices.all()
Copy link
Copy Markdown
Collaborator

@LucaNicosia LucaNicosia Apr 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In netbox, this function handles NSOT servers behind a proxy. Do you know if the pynautobot automatically handles these kind of problems?

Copy link
Copy Markdown
Author

@housepbass housepbass Apr 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about that.

Comment thread suzieq/poller/controller/source/nautobot.py Outdated
Anthony House and others added 15 commits April 9, 2024 20:46
Initial framework for Nautobot inventory
066cb45 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Add pynautobot filter definitions into inventory
6142d78 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Add initial tests for Nautobot source
c00b854 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Add tests structure and response data
268a17b 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Add tests with filters
5545751 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Update data path
0f4dcbe 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Update docs
4bddad8 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Remove reference to Nautobot 1.0 support
720157e 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Add bad device_filters test case
a01953d 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Correct docs
ce0da94 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Correct docs
c19dad2 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
@housepbass @LucaNicosia
Update suzieq/poller/controller/source/nautobot.py
08ab876 
Co-authored-by: Luca Nicosia <66721906+LucaNicosia@users.noreply.github.com>
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Update tests, remove leftover json files
980e2bf 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Correct flake8/pylint errors
0015291 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Fix docs, remove black, update lock file
0bcf819 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
@housepbass housepbass force-pushed the feature_nautobot_inventory branch from fb00461 to 0bcf819 Compare April 10, 2024 00:46
Add multi-filter test
33debbb 
Signed-off-by: Anthony House <anthony.house@networktocode.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LucaNicosia LucaNicosia LucaNicosia requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature]: custom netbox queries / add nautobot 2.X support

2 participants

@housepbass @LucaNicosia