From 574ed8dc7f3eeab550e12142d424619b4658ab5c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= <remy.leone@gmail.com>
Date: Fri, 21 Sep 2018 18:09:35 +0200
Subject: [PATCH] Add documentation about the query filters (#45835)

---
 lib/ansible/plugins/inventory/netbox.py | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/lib/ansible/plugins/inventory/netbox.py b/lib/ansible/plugins/inventory/netbox.py
index 3c5196ff77b..cf4bbbdf4a4 100644
--- a/lib/ansible/plugins/inventory/netbox.py
+++ b/lib/ansible/plugins/inventory/netbox.py
@@ -57,7 +57,7 @@ DOCUMENTATION = '''
 
 EXAMPLES = '''
 # netbox_inventory.yml file in YAML format
-# Example command line: ansible-inventory --list -i netbox_inventory.yml
+# Example command line: ansible-inventory -v --list -i netbox_inventory.yml
 
 plugin: netbox
 api_endpoint: http://localhost:8000
@@ -65,6 +65,22 @@ group_by:
   - device_roles
 query_filters:
   - role: network-edge-router
+
+# Query filters are passed directly as an argument to the fetching queries.
+# You can repeat tags in the query string.
+
+query_filters:
+  - role: server
+  - tag: web
+  - tag: production
+
+# See the NetBox documentation at https://netbox.readthedocs.io/en/latest/api/overview/
+# the query_filters work as a logical **OR**
+#
+# Prefix any custom fields with cf_ and pass the field value with the regular NetBox query string
+
+query_filters:
+  - cf_foo: bar
 '''
 
 import json