Export-ADXMigrationMachinePackage

Namespace ADPlayground.PowerShell

Inputs

ADPlayground.Migrations.Core.AdMigrationPlan

Outputs

ADPlayground.Migrations.Core.AdMigrationMachineHandoffPackage

Exports endpoint handoff files for machine-side AD migration phases.

Examples

Authored help example

Example 1: Export a machine-side handoff package.


$package = $plan | Export-ADXMigrationMachinePackage -Path '.\CAB-1234-machine' -Force -PassThru
            $package.Tasks | Format-Table Order, Kind, TargetComputerName, ArtifactFileName, RequiresReboot, Description -AutoSize

Example 2: Run the generated endpoint script on the target computer.


Set-Location '.\CAB-1234-machine'
            .\Invoke-ADXMigrationMachineHandoff.ps1 -Task ComputerJoin -Intent read_write -AllowWrite -Apply -WriteExecutionId mig-2026-001-pc001 -WriteActorId pc001-local-admin -WriteChangeReason CAB-1234 -WriteRollbackPlanId rollback-CAB-1234
            .\Invoke-ADXMigrationMachineHandoff.ps1 -Task ProfileMigration -Intent read_write -AllowWrite -Apply -WriteExecutionId mig-2026-001-pc001-profile -WriteActorId pc001-local-admin -WriteChangeReason CAB-1234 -WriteRollbackPlanId rollback-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

Export-ADXMigrationMachinePackage -Path <string> -Plan <AdMigrationPlan> [-Force] [-PassThru] [<CommonParameters>]

Parameters

Path string requiredposition: 0pipeline: false: Destination package directory path.
Plan AdMigrationPlan requiredposition: namedpipeline: true (ByValue): Migration plan to package for machine-side execution.
Force SwitchParameter optionalposition: namedpipeline: false: Overwrites existing package files.
PassThru SwitchParameter optionalposition: namedpipeline: false: Returns the package metadata after writing.

Outputs

ADPlayground.Migrations.Core.AdMigrationMachineHandoffPackage