Skip to content

inventory plugin: support netbox endpoints running in a non-root context path (subpath) #1407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/nb_inventory.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
bugfixes:
- nb_inventory - Fixed empty inventory results when netbox server URL is a non-root path
24 changes: 16 additions & 8 deletions plugins/inventory/nb_inventory.py
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,8 @@
from ansible.module_utils.urls import open_url
from ansible.module_utils.six.moves.urllib import error as urllib_error
from ansible.module_utils.six.moves.urllib.parse import urlencode
from ansible.module_utils.six.moves.urllib.parse import urlparse

from ansible.module_utils.six import raise_from

try:
Expand Down Expand Up @@ -1629,26 +1631,32 @@ def fetch_api_docs(self):
self.api_version = version.parse(netbox_api_version)

if self.api_version >= version.parse("3.5.0"):
parsed_endpoint_url = urlparse(self.api_endpoint)
base_path = parsed_endpoint_url.path
self.allowed_device_query_parameters = [
p["name"]
for p in openapi["paths"]["/api/dcim/devices/"]["get"]["parameters"]
for p in openapi["paths"][base_path + "/api/dcim/devices/"]["get"][
"parameters"
]
]
self.allowed_vm_query_parameters = [
p["name"]
for p in openapi["paths"]["/api/virtualization/virtual-machines/"][
"get"
]["parameters"]
for p in openapi["paths"][
base_path + "/api/virtualization/virtual-machines/"
]["get"]["parameters"]
]
else:
self.allowed_device_query_parameters = [
p["name"]
for p in openapi["paths"]["/dcim/devices/"]["get"]["parameters"]
for p in openapi["paths"][base_path + "/dcim/devices/"]["get"][
"parameters"
]
]
self.allowed_vm_query_parameters = [
p["name"]
for p in openapi["paths"]["/virtualization/virtual-machines/"]["get"][
"parameters"
]
for p in openapi["paths"][
base_path + "/virtualization/virtual-machines/"
]["get"]["parameters"]
]

def validate_query_parameter(self, parameter, allowed_query_parameters):
Expand Down
Loading