-
Notifications
You must be signed in to change notification settings - Fork 7
Start Migration
external help file: JumpCloud.ADMU-help.xml Module Name: JumpCloud.ADMU online version: https://github.com/TheJumpCloud/jumpcloud-ADMU/wiki/Start-Migration schema: 2.0.0
Starts the JumpCloud Active Directory Migration process.
Start-Migration -JumpCloudUserName <String> -SelectedUserName <String> -TempPassword <String>
[-LeaveDomain <Boolean>] [-ForceReboot <Boolean>] [-UpdateHomePath <Boolean>] [-InstallJCAgent <Boolean>]
[-AutobindJCUser <Boolean>] [-BindAsAdmin <Boolean>] [-SetDefaultWindowsUser <Boolean>]
[-JumpCloudConnectKey <String>] [-JumpCloudAPIKey <String>] [-JumpCloudOrgID <String>] [<CommonParameters>]
Start-Migration [-inputObject <Object>] [<CommonParameters>]
The Start-Migration function allows the starting of the JumpCloud Active Directory Migration Process. This utility can be used to convert domain bound user accounts into locally managed accounts ready to be taken over by JumpCloud. There are various options to run the utility depending on the administrators requirements.
PS C:\> Start-Migration -SelectedUserName 'DOMAIN\bobfay' -JumpCloudUserName 'bob.fay' -TempPassword 'Temp123!Temp123!' -LeaveDomain $true -ForceReboot $true -InstallJCAgent $true -JumpCloudConnectKey 'ConnectKEY' -AutobindJCUser $true -JumpCloudAPIKey 'APIKEY'This example would run the Start-Migration function on a domain user DOMAIN\bobfay and create a new local user account COMPUTERNAME\bob.fay. Using a temporary password Temp123!Temp123!. The JumpCloud Agent would be installed. After migration the JumpCloud user bob.fay would be bound to the system. Finally, the system would leave the bound domain and reboot.
PS C:\> Start-Migration -SelectedUserName 'DOMAIN\bobfay' -JumpCloudUserName 'bob.fay' -TempPassword 'Temp123!Temp123!' $false -ForceReboot $false -InstallJCAgent $falseThis example would run the Start-Migration function on a domain user DOMAIN\jsmith and create a new local user account COMPUTERNAME\john.smith. Using a temporary password Temp123!Temp123!, the system would remain bound to the current domain and not reboot. The JumpCloud Agent would not be installed. This would allow the administrator to run the converted account in parallel for testing.
A boolean $true/$false value to force the system to reboot at the end of the migration process. A reboot is required when unbinding from a domain.
Type: System.Boolean
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA boolean $true/$false value to install the JumpCloud agent on the system. If this value is $true you will be required to also pass a JumpCloudConnectKey value. If the system remains on the domain, the JumpCloud agent will be installed but not connected until it leaves the domain.
Type: System.Boolean
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA string value that is required if -InstallJCAgent is $true. This connect key can be found in the JumpCloud console under add systems. It must be 24 chars and is different than an JumpCloud API key.
Type: System.String
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA string value that will be used for the new converted local account that can be bound to JumpCloud. This value must be unique on the system, if it is not unique an error will stop the migration. This value should match the JumpCloud Username value to allow takeover when a User is bound to a system within the JumpCloud console.
Type: System.String
Parameter Sets: cmd
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA boolean $true/$false value to force the system to leave currently bound domain, this is required for the JumpCloud Agent to operate. It can also be reversed by simply rejoining the system back to the domain. This will also work for AzureAD and will disconnect the AzureAD bind.
Type: System.Boolean
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA string value that is used to set the new local accounts password. When duplicating the user account a password must be set when created and this value is passed. Once the system is online in JumpCloud the password will be overwritten and synced with JumpCloud if the user is taken over.
Type: System.String
Parameter Sets: cmd
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAn PSObject can be passed to the function with the required values for the migration process. This is used when the GUI version of the tool is used and inputs to the XAML form are passed to this function.
Type: System.Object
Parameter Sets: form
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA string value for the DomainUserName that is used in the migration script. This value is verified to make sure the account exists on the system. If the Domain Account does not exist, the script will error and not continue. Either pass a username using the "Domain\username" syntax or a domain user SID.
Type: System.String
Parameter Sets: cmd
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter will bind the username specified in the JumpCloudUserName field to the current system after Migration.
Type: System.Boolean
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf set to $true, the ADMU will attempt to rename the selected username's homepath to the jumpcloud username. Note, this could break any applications that rely on a hard coded homepath. By default this is not set and will not rename the homepath.
Type: System.Boolean
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe Read/Write API key of a JumpCloud Administrator. This parameter is required if the AutoBind JC User parameter is specified.
Type: System.String
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe ID of the JumpCloud Organization you wish to connect to. This field is only required if an MTP Api Key is used in the JumpCloudApiKey Parameter
Type: System.String
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOption to bind user as sudo administrator or not. This parameter is not required and will default to $false (User will not be bound as admin). Set to $true if you'd like to bind the JumpCloudUserName as administrator during migration.
Type: System.Boolean
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOption to set the windows default login user to the migrated user post-migration. This parameter is not required and will default to $true (the next login window user will be the migrated user). Set to $false if you'd like to disable this functionality during migration.
Type: System.Boolean
Parameter Sets: cmd
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
https://github.com/TheJumpCloud/jumpcloud-ADMU/wiki/Start-Migration