External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-01-14 19:30:39 -03:30
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7153 from chrismeyersfsu/fix-6762

Browse Source 
add API docs for host_filter
This commit is contained in:
Chris Meyers 2017-07-19 11:37:38 -04:00 committed by GitHub
commit f31cec2848
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
awx/api/templates/api/host_list.md Normal file
View File

@ -0,0 +1,15 @@
{% include "api/list_api_view.md" %}
`host_filter` is available on this endpoint. The filter supports: relational queries, `AND` `OR` boolean logic, as well as expression grouping via `()`.
?host_filter=name=my_host
?host_filter=name="my host" OR name=my_host
?host_filter=groups__name="my group"
?host_filter=name=my_host AND groups__name="my group"
?host_filter=name=my_host AND groups__name="my group"
?host_filter=(name=my_host AND groups__name="my group") OR (name=my_host2 AND groups__name=my_group2)
`host_filter` can also be used to query JSON data in the related `ansible_facts`. `__` may be used to traverse JSON dictionaries. `[]` may be used to traverse JSON arrays.
?host_filter=ansible_facts__ansible_processor_vcpus=8
?host_filter=ansible_facts__ansible_processor_vcpus=8 AND name="my_host" AND ansible_facts__ansible_lo__ipv6[]__scope=host