TestimoX

API Reference

Command

Invoke-ADXSidHistoryMigration

Namespace ADPlayground.PowerShell
Outputs
ADPlayground.Migrations.SidHistory.SidHistoryMigrationExecutionResult

Executes a governed SIDHistory-only migration using the ADPlayground migration workflow. Prefer Invoke-ADXMigrationPlan for full migrations that also create destination objects, handle credential strategy, membership, computer transition, profile work, and resource re-ACL phases.

Examples

Authored help example

Example 1: Apply only the SIDHistory phase after validating that the full migration plan already covers the surrounding work.


$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
            Invoke-ADXSidHistoryMigration -SourceDomain old.contoso.com -SourceSamAccountName alice -DestinationDomain new.contoso.com -DestinationSamAccountName alice -SourceAuditReady -SourceTcpipClientSupportReady -ResourceAclScanCompleted -Intent read_write -AllowWrite -Apply -WriteExecutionId exec-1 -WriteActorId admin -WriteChangeReason CAB-1234 -WriteRollbackPlanId rollback-1

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

Invoke-ADXSidHistoryMigration -DestinationDomain <string> -DestinationSamAccountName <string> -SourceDomain <string> -SourceSamAccountName <string> [-AllowPrivilegedSidHistory] [-AllowWrite] [-Apply] [-BusinessJustification <string>] [-DestinationCredential <PSCredential>] [-DestinationDomainController <string>] [-DryRun <bool>] [-Intent <string>] [-ResourceAclDependencyCount <int>] [-ResourceAclScanCompleted] [-SourceAuditReady] [-SourceCredential <PSCredential>] [-SourceDomainController <string>] [-SourceTcpipClientSupportReady] [-WriteActorId <string>] [-WriteAuditCorrelationId <string>] [-WriteChangeReason <string>] [-WriteExecutionId <string>] [-WriteRollbackPlanId <string>] [-WriteRollbackProviderId <string>] [<CommonParameters>]
#

Parameters

DestinationDomain string requiredposition: namedpipeline: false
Destination DNS domain name.
DestinationSamAccountName string requiredposition: namedpipeline: false
Destination domain-relative SAM account name.
SourceDomain string requiredposition: namedpipeline: false
Source DNS domain name.
SourceSamAccountName string requiredposition: namedpipeline: false
Source domain-relative SAM account name.
AllowPrivilegedSidHistory SwitchParameter optionalposition: namedpipeline: false
Allows migration of privileged source SIDs when explicitly approved.
AllowWrite SwitchParameter optionalposition: namedpipeline: falsealiases: allow_write
Explicit write confirmation flag for mutating operations.
Apply SwitchParameter optionalposition: namedpipeline: false
Applies changes. Without this switch, the cmdlet runs in dry-run mode.
BusinessJustification string optionalposition: namedpipeline: false
Business justification or change ticket.
DestinationCredential PSCredential optionalposition: namedpipeline: false
Optional destination-domain credential.
DestinationDomainController string optionalposition: namedpipeline: false
Destination domain controller.
DryRun bool optionalposition: namedpipeline: falsealiases: dry_run
Dry-run mode flag. Defaults to true; set to false and use -Apply to execute writes.
Intent string optionalposition: namedpipeline: false
Execution intent (read_only or read_write). Default: read_only.
ResourceAclDependencyCount int optionalposition: namedpipeline: false
Number of resource ACL dependencies still relying on the source SID.
ResourceAclScanCompleted SwitchParameter optionalposition: namedpipeline: false
Confirms that resource ACL dependency discovery was completed.
SourceAuditReady SwitchParameter optionalposition: namedpipeline: false
Confirms that source audit prerequisites are ready.
SourceCredential PSCredential optionalposition: namedpipeline: false
Optional source-domain administrator credential.
SourceDomainController string optionalposition: namedpipeline: false
Source PDC emulator or source domain controller.
SourceTcpipClientSupportReady SwitchParameter optionalposition: namedpipeline: false
Confirms that source TcpipClientSupport is ready.
WriteActorId string optionalposition: namedpipeline: falsealiases: write_actor_id
Write actor identifier.
WriteAuditCorrelationId string optionalposition: namedpipeline: falsealiases: write_audit_correlation_id
Optional write audit correlation identifier.
WriteChangeReason string optionalposition: namedpipeline: falsealiases: write_change_reason
Write change reason, ticket, or approval reference.
WriteExecutionId string optionalposition: namedpipeline: falsealiases: write_execution_id
Write execution identifier for governance/audit correlation.
WriteRollbackPlanId string optionalposition: namedpipeline: falsealiases: write_rollback_plan_id
Write rollback plan identifier.
WriteRollbackProviderId string optionalposition: namedpipeline: falsealiases: write_rollback_provider_id
Optional write rollback provider identifier.

Outputs

ADPlayground.Migrations.SidHistory.SidHistoryMigrationExecutionResult