TestimoX

API Reference

Command

New-ADXMigrationGroup

Namespace ADPlayground.PowerShell
Outputs
ADPlayground.Migrations.Core.AdMigrationPrincipalItem

Creates a typed group item for an AD migration plan.

Examples

Authored help example

Example 1: Add an access group to a complete migration plan and review membership and SIDHistory phases.


$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-ADXMigrationGroup -SourceSamAccountName 'APP-Finance-Readers' -DestinationSamAccountName 'APP-Finance-Readers' -CopyAttribute description,mail -MigrateMembers
                New-ADXMigrationResource -Path '\\FS1\Finance' -ReAclMode AddDestinationBeforeRemoveSource
            }
            $checked = $plan | Test-ADXMigrationPlan -PassThru
            $checked.Issues | Format-Table Severity, Code, Target, Message -AutoSize
            $checked.Phases | Where-Object { $_.Kind -in 'PrepareDestination','Membership','SidHistory','ResourceReAcl' } | Format-Table Kind, Item, Description -AutoSize
        

Example 2: Plan a group without SIDHistory after the replacement access path is documented.


$plan = New-ADXMigrationPlan -SourceDomain old.contoso.com -DestinationDomain new.contoso.com -DestinationOrganizationalUnit 'OU=Migrated,DC=new,DC=contoso,DC=com' -ResourceAclScanCompleted -BusinessJustification CAB-1234 {
                New-ADXMigrationGroup -SourceSamAccountName 'APP-Legacy-Archive' -NoSidHistory -CopyAttribute description
                New-ADXMigrationResource -Path '\\FS1\Archive' -ReAclMode ReportOnly
            }
            if ($plan | Test-ADXMigrationPlan) {
                $plan | Invoke-ADXMigrationPlan
            }
        

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

New-ADXMigrationGroup -SourceSamAccountName <string> [-AllowPrivilegedSidHistory] [-Attribute <Hashtable>] [-CommonName <string>] [-CopyAttribute <string[]>] [-Description <string>] [-DestinationOrganizationalUnit <string>] [-DestinationSamAccountName <string>] [-DisplayName <string>] [-Mail <string>] [-MigrateMembers] [-NoSidHistory] [-SkipDestinationPreparation] [<CommonParameters>]
#

Parameters

SourceSamAccountName string requiredposition: namedpipeline: false
Source SAM account name.
AllowPrivilegedSidHistory SwitchParameter optionalposition: namedpipeline: false
Allows privileged SIDHistory when explicitly approved.
Attribute Hashtable optionalposition: namedpipeline: false
Explicit destination attributes to set during preparation.
CommonName string optionalposition: namedpipeline: false
Optional destination common name.
CopyAttribute string[] optionalposition: namedpipeline: false
Attribute names to copy from source to destination.
Description string optionalposition: namedpipeline: false
Optional destination description.
DestinationOrganizationalUnit string optionalposition: namedpipeline: false
Destination organizational unit distinguished name.
DestinationSamAccountName string optionalposition: namedpipeline: false
Destination SAM account name. Defaults to the source SAM account name.
DisplayName string optionalposition: namedpipeline: false
Optional destination display name.
Mail string optionalposition: namedpipeline: false
Optional destination mail address.
MigrateMembers SwitchParameter optionalposition: namedpipeline: false
Requests scoped group member migration.
NoSidHistory SwitchParameter optionalposition: namedpipeline: false
Disables SIDHistory continuity for this item.
SkipDestinationPreparation SwitchParameter optionalposition: namedpipeline: false
Skips destination object creation/update preparation.

Outputs

ADPlayground.Migrations.Core.AdMigrationPrincipalItem