Skip to content

Enhancement: Allow id for api_filter that uses .get instead of .filter #376

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.

Sign up for GitHub

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 2 commits into from
Nov 16, 2020
Merged

Enhancement: Allow id for api_filter that uses .get instead of .filter #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbcefb6
Add option for lookup plugin to use .get when id=x passed into api_fi…
FragmentedPacket Nov 13, 2020
9e969c1
Made a few more changes to stop from repeatedly casting to dict in re…
FragmentedPacket Nov 16, 2020
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
23 changes: 19 additions & 4 deletions plugins/lookup/nb_lookup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,20 @@ def run(self, terms, variables=None, **kwargs):
if netbox_api_filter:
filter = build_filters(netbox_api_filter)

if "id" in filter:
Display().vvvv(
u"Filter is: %s and includes id, will use .get instead of .filter"
% (filter)
)
try:
id = int(filter["id"][0])
nb_data = endpoint.get(id)
data = dict(nb_data)
Display().vvvvv(pformat(data))
return [data]
except pynetbox.RequestError as e:
raise AnsibleError(e.error)

Display().vvvv("filter is %s" % filter)

# Make call to NetBox API and capture any failures
Expand All @@ -338,13 +352,14 @@ def run(self, terms, variables=None, **kwargs):
)

for data in nb_data:
Display().vvvvv(pformat(dict(data)))
data = dict(data)
Display().vvvvv(pformat(data))

if netbox_raw_return:
results.append(dict(data))
results.append(data)
else:
key = dict(data)["id"]
result = {key: dict(data)}
key = data["id"]
result = {key: data}
results.extend(self._flatten_hash_to_list(result))

return results
5 changes: 5 additions & 0 deletions tests/integration/targets/latest/tasks/netbox_lookup.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,8 @@
- "'L2' in {{ query_result |json_query('[*].display_name') }}"
vars:
query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}"

- name: "NETBOX_LOOKUP 10: Device query by ID"
assert:
that:
- "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}"
5 changes: 5 additions & 0 deletions tests/integration/targets/v2.8/tasks/netbox_lookup.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,8 @@
- "'L2' in {{ query_result |json_query('[*].display_name') }}"
vars:
query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}"

- name: "NETBOX_LOOKUP 10: Device query by ID"
assert:
that:
- "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}"