API Reference
Command
Get-ADXSidHistoryMigrationPlan
Builds an expert SIDHistory migration plan for a source and destination principal. Prefer New-ADXMigrationPlan for full user, group, computer, credential, resource, and SIDHistory migration workflows.
Examples
Example 1: Preview the SIDHistory phase directly after the broader migration plan identifies SIDHistory as the continuity mechanism.
$plan = New-ADXMigrationPlan -SourceDomain old.contoso.com -DestinationDomain new.contoso.com -SourceDomainController old-pdc.old.contoso.com -DestinationDomainController new-dc01.new.contoso.com -DestinationOrganizationalUnit 'OU=Migrated,DC=new,DC=contoso,DC=com' -SourceAuditReady -SourceTcpipClientSupportReady -ResourceAclScanCompleted -BusinessJustification CAB-1234 {
New-ADXMigrationUser -SourceSamAccountName alice -CredentialStrategy ResetRandom -MigrateMembership
}
$plan | Test-ADXMigrationPlan -PassThru | Select-Object -ExpandProperty Phases | Where-Object Kind -eq SidHistory | Format-Table Kind, Item, Description -AutoSize
Get-ADXSidHistoryMigrationPlan -SourceDomain old.contoso.com -SourceSamAccountName alice -DestinationDomain new.contoso.com -DestinationSamAccountName alice -SourceAuditReady -SourceTcpipClientSupportReady -ResourceAclScanCompleted -BusinessJustification CAB-1234
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Get-ADXSidHistoryMigrationPlan -DestinationDomain <string> -DestinationSamAccountName <string> -SourceDomain <string> -SourceSamAccountName <string> [-AllowPrivilegedSidHistory] [-BusinessJustification <string>] [-DestinationDomainController <string>] [-ResourceAclDependencyCount <int>] [-ResourceAclScanCompleted] [-SourceAuditReady] [-SourceDomainController <string>] [-SourceTcpipClientSupportReady] [<CommonParameters>]#Parameters
- DestinationDomain string
- Destination DNS domain name.
- DestinationSamAccountName string
- Destination domain-relative SAM account name.
- SourceDomain string
- Source DNS domain name.
- SourceSamAccountName string
- Source domain-relative SAM account name.
- AllowPrivilegedSidHistory SwitchParameter
- Allows migration of privileged source SIDs when explicitly approved.
- BusinessJustification string
- Business justification or change ticket.
- DestinationDomainController string
- Destination domain controller.
- ResourceAclDependencyCount int
- Number of resource ACL dependencies still relying on the source SID.
- ResourceAclScanCompleted SwitchParameter
- Confirms that resource ACL dependency discovery was completed.
- SourceAuditReady SwitchParameter
- Confirms that source audit prerequisites are ready.
- SourceDomainController string
- Source PDC emulator or source domain controller.
- SourceTcpipClientSupportReady SwitchParameter
- Confirms that source TcpipClientSupport is ready.
Outputs
ADPlayground.Migrations.SidHistory.SidHistoryMigrationPlan