Reworded help for -Filter and added note about case-sensitivity. (#65)

rmbolger · Jan 25, 2024 · b2b64d8 · b2b64d8
1 parent fc68174
commit b2b64d8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/Posh-IBWAPI/en-US/Posh-IBWAPI-help.xml b/Posh-IBWAPI/en-US/Posh-IBWAPI-help.xml
@@ -301,7 +301,9 @@
         <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Filters">
           <maml:name>Filter</maml:name>
           <maml:description>
-            <maml:para>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.</maml:para>
+            <maml:para>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.</maml:para>
+            <maml:para>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.</maml:para>
+            <maml:para>See Infoblox WAPI documentation for advanced usage details.</maml:para>
           </maml:description>
           <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
           <dev:type>
@@ -456,7 +458,9 @@
         <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Filters">
           <maml:name>Filter</maml:name>
           <maml:description>
-            <maml:para>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.</maml:para>
+            <maml:para>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.</maml:para>
+            <maml:para>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.</maml:para>
+            <maml:para>See Infoblox WAPI documentation for advanced usage details.</maml:para>
           </maml:description>
           <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
           <dev:type>
@@ -610,7 +614,9 @@
       <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Filters">
         <maml:name>Filter</maml:name>
         <maml:description>
-          <maml:para>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.</maml:para>
+          <maml:para>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.</maml:para>
+          <maml:para>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.</maml:para>
+          <maml:para>See Infoblox WAPI documentation for advanced usage details.</maml:para>
         </maml:description>
         <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
         <dev:type>

diff --git 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