From b2b64d8974fcffe22c1f35c286935ff9a908b67f Mon Sep 17 00:00:00 2001 From: Ryan Bolger Date: Wed, 24 Jan 2024 21:58:09 -0800 Subject: [PATCH] Reworded help for -Filter and added note about case-sensitivity. (#65) --- Posh-IBWAPI/en-US/Posh-IBWAPI-help.xml | 12 +++++++++--- docs/Functions/Get-IBObject.md | 6 ++++-- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/Posh-IBWAPI/en-US/Posh-IBWAPI-help.xml b/Posh-IBWAPI/en-US/Posh-IBWAPI-help.xml index 12bd343..3f8d362 100644 --- a/Posh-IBWAPI/en-US/Posh-IBWAPI-help.xml +++ b/Posh-IBWAPI/en-US/Posh-IBWAPI-help.xml @@ -301,7 +301,9 @@ Filter - A string array of search filter conditions (e.g. "name%7E=myhost","ipv4addr=10.10.10.10") or hashtable (e.g. @{'name~'='myhost';ipv4addr='10.10.10.10'}). All conditions must be satisfied to match an object. String based filters must be properly URL encoded. Hashtable filters will be automatically URL encoded. See Infoblox WAPI documentation for advanced usage details. + A hashtable with search filter conditions (e.g. `@{'name~'='myhost';ipv4addr='10.10.10.10'}`). All conditions must be satisfied to match an object. The filters can also be specified as an array of strings but the field names and values must be URL encoded by the caller in advance (e.g. `"name%7E=myhost","ipv4addr=10.10.10.10"`). With both methods, all conditions must be satisfied to match an object. + NOTE: WAPI field names are case sensitive. The value specified for a field is also case sensitive unless using the case insensitive modififer, `:`, or accounting for case via regex. + See Infoblox WAPI documentation for advanced usage details. Object @@ -456,7 +458,9 @@ Filter - A string array of search filter conditions (e.g. "name%7E=myhost","ipv4addr=10.10.10.10") or hashtable (e.g. @{'name~'='myhost';ipv4addr='10.10.10.10'}). All conditions must be satisfied to match an object. String based filters must be properly URL encoded. Hashtable filters will be automatically URL encoded. See Infoblox WAPI documentation for advanced usage details. + A hashtable with search filter conditions (e.g. `@{'name~'='myhost';ipv4addr='10.10.10.10'}`). All conditions must be satisfied to match an object. The filters can also be specified as an array of strings but the field names and values must be URL encoded by the caller in advance (e.g. `"name%7E=myhost","ipv4addr=10.10.10.10"`). With both methods, all conditions must be satisfied to match an object. + NOTE: WAPI field names are case sensitive. The value specified for a field is also case sensitive unless using the case insensitive modififer, `:`, or accounting for case via regex. + See Infoblox WAPI documentation for advanced usage details. Object @@ -610,7 +614,9 @@ Filter - A string array of search filter conditions (e.g. "name%7E=myhost","ipv4addr=10.10.10.10") or hashtable (e.g. @{'name~'='myhost';ipv4addr='10.10.10.10'}). All conditions must be satisfied to match an object. String based filters must be properly URL encoded. Hashtable filters will be automatically URL encoded. See Infoblox WAPI documentation for advanced usage details. + A hashtable with search filter conditions (e.g. `@{'name~'='myhost';ipv4addr='10.10.10.10'}`). All conditions must be satisfied to match an object. The filters can also be specified as an array of strings but the field names and values must be URL encoded by the caller in advance (e.g. `"name%7E=myhost","ipv4addr=10.10.10.10"`). With both methods, all conditions must be satisfied to match an object. + NOTE: WAPI field names are case sensitive. The value specified for a field is also case sensitive unless using the case insensitive modififer, `:`, or accounting for case via regex. + See Infoblox WAPI documentation for advanced usage details. Object diff --git a/docs/Functions/Get-IBObject.md b/docs/Functions/Get-IBObject.md index 6467b49..783edf3 100644 --- a/docs/Functions/Get-IBObject.md +++ b/docs/Functions/Get-IBObject.md @@ -123,8 +123,10 @@ Accept wildcard characters: False ``` ### -Filter -A string array of search filter conditions (e.g. "name%7E=myhost","ipv4addr=10.10.10.10") or hashtable (e.g. @{'name~'='myhost';ipv4addr='10.10.10.10'}). All conditions must be satisfied to match an object. -String based filters must be properly URL encoded. Hashtable filters will be automatically URL encoded. +A hashtable with search filter conditions (e.g. `@{'name~'='myhost';ipv4addr='10.10.10.10'}`). All conditions must be satisfied to match an object. The filters can also be specified as an array of strings but the field names and values must be URL encoded by the caller in advance (e.g. `"name%7E=myhost","ipv4addr=10.10.10.10"`). With both methods, all conditions must be satisfied to match an object. + +NOTE: WAPI field names are case sensitive. The value specified for a field is also case sensitive unless using the case insensitive modififer, `:`, or accounting for case via regex. + See Infoblox WAPI documentation for advanced usage details. ```yaml