Rename Filter to LDAPFilter to match ActiveDirectory module API

Author: Pxtl

src/ADServices/ADGroup.psm1

@@ -15,10 +15,10 @@ function Get-ADGroup {
     [OutputType([DirectoryServices.DirectoryEntry])]
     [CmdletBinding(DefaultParameterSetName='Filter')]
     param (
-        # The filter to search for groups. Uses normal AD Search syntax, *not*
+        # The filter to search for groups. Uses normal LDAP Search syntax, *not*
         # PS ActiveDirectory search.
         [Parameter(Mandatory, ValueFromPipeline, ParameterSetName='Filter')]
-        [string] $Filter,
+        [string] $LDAPFilter,
 
         # The identity of the group to retrieve. Can be sAMAcountName, SID, LDAP
         # path, or distinguished name.

src/ADServices/ADObject.psm1

@@ -21,10 +21,10 @@ function Get-ADObject {
         [Parameter(Position=0)]
         [string] $Type,
 
-        # The filter to search for entries. Uses normal AD Search syntax, *not*
+        # The filter to search for entries. Uses normal LDAP Search syntax, *not*
         # PS ActiveDirectory search.
         [Parameter(Mandatory, ValueFromPipeline, ParameterSetName='Filter')]
-        [string] $Filter,
+        [string] $LDAPFilter,
 
         # The identity of the entry to retrieve. Can be sAMAcountName, SID, LDAP
         # path, or distinguished name.
@@ -48,13 +48,13 @@ function Get-ADObject {
     }
     process {
         if ($Identity) {
-            $Filter = Convert-ADIdentityToFilter -Identity $Identity
+            $LDAPFilter = Convert-ADIdentityToFilter -Identity $Identity
         }
 
         if ($Type) {
-            $searcher.Filter = "(&(objectClass=$Type)($Filter))"
+            $searcher.Filter = "(&(objectClass=$Type)($LDAPFilter))"
         } else {
-            $searcher.Filter = "($Filter)"
+            $searcher.Filter = "($LDAPFilter)"
         }
         Write-Verbose "Searching for '$($searcher.Filter)'"
         $searchResult = $searcher.FindAll()
@@ -130,7 +130,7 @@ function New-ADObject {
             Write-Verbose "$($MyInvocation.MyCommand): $targetSummary"
             $newEntry = $baseEntry.Children.Add("$DistinguishedComponenentType=$Name", $Type)
             if ($DoSAMAccountName) {
-                $existing = Get-ADObject -Filter "sAMAccountName=$Name" -Server $Server -Credential $Credential
+                $existing = Get-ADObject -LDAPFilter "sAMAccountName=$Name" -Server $Server -Credential $Credential
                 if (($existing | Measure-Object).Count) {
                     # objectClass contains the full class inheritance hierarchy so we only want the final, most-specific entry.
                     $existingClass = $existing.objectClass | Select-Object -Last 1

src/ADServices/ADOrganizationalUnit.psm1

@@ -19,7 +19,7 @@ function Get-ADOrganizationalUnit {
         # The filter to search for OrganizationalUnits. Uses normal AD Search
         # syntax, *not* PS ActiveDirectory search.
         [Parameter(Mandatory, ValueFromPipeline, ParameterSetName='Filter')]
-        [string] $Filter,
+        [string] $LDAPFilter,
 
         # The identity of the OrganizationalUnit to retrieve. Can be SID, LDAP
         # path, or distinguished name.

src/ADServices/ADUser.psm1

@@ -17,10 +17,10 @@ function Get-ADUser {
     [OutputType([DirectoryServices.DirectoryEntry])]
     [CmdletBinding(DefaultParameterSetName='Filter')]
     param (
-        # The filter to search for users. Uses normal AD Search syntax, *not*
+        # The filter to search for users. Uses normal LDAP Search syntax, *not*
         # PS ActiveDirectory search.
         [Parameter(Mandatory, ValueFromPipeline, ParameterSetName='Filter')]
-        [string] $Filter,
+        [string] $LDAPFilter,
 
         # The identity of the user to retrieve. Can be sAMAcountName, SID, LDAP
         # path, or distinguished name.

src/ADServices/Tests/Integration/ADGroup.tests.ps1

@@ -57,5 +57,5 @@ Describe 'ADGroup' -Tags Integration {
         & "$PSScriptRoot\Shared\Clear-TestObjects.ps1"
     }
 
-    #TODO Test by other Identity types, Set dict, test -Filter, automate clean-up.
+    #TODO Test by other Identity types, Set dict, test -LDAPFilter, automate clean-up.
 }

src/ADServices/Tests/Integration/ADUser.tests.ps1

@@ -75,5 +75,5 @@ Describe 'ADUser' -Tags Integration {
         & "$PSScriptRoot\Shared\Clear-TestObjects.ps1"
     }
 
-    #TODO Test by other Identity types, Set dict, test -Filter, automate clean-up.
+    #TODO Test by other Identity types, Set dict, test -LDAPFilter, automate clean-up.
 }

src/ADServices/Tests/Integration/Shared/Clear-TestObjects.ps1

@@ -11,7 +11,7 @@ process {
     $BuiltInUserDistinguishedNames = & "$PSScriptRoot\Get-BuiltInUserDistinguishedNames.ps1"
 
     # Cleanup ADUsers.
-    Get-ADUser @ConnectionParam -Filter 'sAMAccountName=*' |
+    Get-ADUser @ConnectionParam -LDAPFilter 'sAMAccountName=*' |
         Select-Object -ExpandProperty distinguishedName |
         Where-Object { 
             ($_ -NotIn $BuiltInUserDistinguishedNames) -and ($_ -notlike '*OU=Domain Controllers,DC=samdom,DC=example,DC=com')
@@ -24,7 +24,7 @@ process {
     $BuiltInGroupDistinguishedNames = & "$PSScriptRoot\Get-BuiltInGroupDistinguishedNames.ps1"
 
     # Cleanup ADGroups.
-    Get-ADGroup @ConnectionParam -Filter 'sAMAccountName=*' |
+    Get-ADGroup @ConnectionParam -LDAPFilter 'sAMAccountName=*' |
         Select-Object -ExpandProperty distinguishedName |
         Where-Object {
             $_ -NotIn $BuiltInGroupDistinguishedNames
@@ -39,7 +39,7 @@ process {
     )
 
     # Cleanup ADOrganizationalUnits.
-    Get-ADOrganizationalUnit @ConnectionParam -Filter 'distinguishedName=*' |
+    Get-ADOrganizationalUnit @ConnectionParam -LDAPFilter 'distinguishedName=*' |
         Select-Object -ExpandProperty distinguishedName |
         Where-Object { 
             $_ -NotIn $BuiltInOrganizationalUnitDistinguishedNames