Scripts/ExternalSources/ADUsers.ps1
|
<# .SYNOPSIS Pull users from Active Directory, add to Neo4j .DESCRIPTION Pull users from Active Directory, add to Neo4j * Only pulls enabled users This is invoked by Connect-TheDots .PARAMETER Prefix Prefix to append to properties when we add them to Neo4j This helps identify properties that might come from mutiple sources, or where the source is ambiguous For example, Description becomes ADDescription Defaults to AD. Change at your own risk .PARAMETER MergeProperty We use this to correlate with existing AD user data in Neo4j Default: SID .PARAMETER Label What label do we assign the data we pull? Defaults to User. Change at your own risk .PARAMETER Properties Properties to extract and select from AD .PARAMETER Excludes Properties to exclude (in line with transforms) .PARAMETER Transforms Properties to select again (in line with excludes) Example: *, # Keep all properties from -Properties @{ label = 'ParentCanonicalName' expression = {$_.CanonicalName -replace "/$($_.Name)$"} } This would keep all properties from -Properties, and add a calculated ParentCanonicalName .FUNCTIONALITY Dots #> [cmdletbinding()] param( [string]$Prefix = 'AD', [string]$MergeProperty = 'SID', [string]$Label = 'User', [string[]]$Properties = @( 'SamAccountName', 'CN', 'CanonicalName', 'DisplayName', 'Company', 'Department', 'Title', 'givenName', 'surname', 'mail', 'uidNumber', 'gidNumber', 'SID', 'LastLogonDate' ), [string[]]$Excludes = @('CanonicalName', 'CN'), [object[]]$Transforms = @( '*', @{ label = 'ParentCanonicalName' expression = {$_.CanonicalName -replace "/$($_.CN)$"} } ), [switch]$AllLower = $Script:AllLower ) $Unique = "${Prefix}${MergeProperty}" $Date = Get-Date # Dot source so module import is available in this scope if($script:TestMode) { Write-Verbose "Using mock functions from $ModuleRoot/Mock/Mocks.ps1" . "$ModuleRoot/Mock/Mocks.ps1" } else { . Import-RequiredModule ActiveDirectory -ErrorAction Stop } $Nodes = Get-ADUser -Filter 'enabled -eq $true' -Properties $Properties | Select-Object -Property $Properties | Select-Object -Property $Transforms -ExcludeProperty $Excludes $Nodes = Foreach($Node in $Nodes) { $Node.SID = $Node.SID.Value $Output = Add-PropertyPrefix -Prefix $Prefix -Object $Node Add-Member -InputObject $Output -MemberType NoteProperty -Name "${script:CMDBPrefix}${Prefix}UpdateDate" -Value $Date -Force if($AllLower) { ConvertTo-Lower -InputObject $Output -Exclude ADSID } $Output } $TotalCount = $Nodes.count $Count = 0 Foreach($Node in $Nodes) { Write-Progress -Activity "Updating Neo4j" -Status "Adding $($Node.$MergeProperty) users" -PercentComplete (($Count / $TotalCount)*100) $Count++ Set-Neo4jNode -Label $Label -Hash @{$Unique = $Node.$Unique} -InputObject $Node } |