Migration Manager for AD 8.15 - Resource Updating Toolkit for PowerShell Reference

New-RumProcessingTask

Creates a new processing task.

Detailed Description

The New-RumProcessingTask cmdlet creates a new processing task.

Syntax

New-RumProcessingTask [-Collection] <PSRumCollection> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Process <ProcessResource>] [
-ProcessingMode <RumProcessingModes>] [-Schedule <DateTime>] [
-ScriptAfter <String>] [-ScriptBefore <String>] 
[-SidHistoryTargetDomain <String>] [-PassThru] [
<CommonParameters>]

New-RumProcessingTask -CollectionName <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Process <ProcessResource>] [
-ProcessingMode <RumProcessingModes>] [-Schedule <DateTime>] [
-ScriptAfter <String>] [-ScriptBefore <String>] 
[-SidHistoryTargetDomain <String>] [-PassThru] [
<CommonParameters>]

Parameters

-Collection <PSRumCollection>

Collection.

-CollectionName <String>

Name of the collection.

-Computer <PSRumComputer[]>

Collection member computers where the task will run.

-Description <String>

Description of the task.

-InProgressTimeout <Int32>

The timeout in minutes for keeping the task in the In Progress state.

-Name <String>

Task name.

-SidHistoryTargetDomain <String>

Target domain where SIDHistory of objects will be used for account matching.

-PassThru

Returns the object that represents the task that was created. By default, this cmdlet does not generate any output.

-PendingTimeout <Int32>

The timeout in minutes for keeping the task in the Pending state.

-Process<ProcessResource>

The types of objects whose permissions should be re-assigned to target users.

Values : LocalGroupMembership, UserRights, ServiceAccounts, ScheduledTasks, LocalProfiles, RoamingProfiles, Registry, FileSystem, FileOwnership, Shares, Printers, COMPlus, DCOM, IIS, All

-ProcessingMode <RumProcessingModes>

Re-Permissioning mode.

Values : Reassign, Copy, Cleanup, Revert

-Schedule <DateTime>

When to run the task.

-ScriptAfter <String>

Script to run after the task

-ScriptBefore <String>

Script to run before the task.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.

Inputs

PSRumCollection

PSRumComputer

Outputs

PSRumTask

Examples

Example 1

$task = Get-RumCollection "collection_1" | New-RumProcessingTask 
-PassThru -Process All

Example 2

New-RumProcessingTask -Name "task_1" -CollectionName "collection_2" 
-SidHistoryTargetDomain domainName.local -ProcessingMode Copy -Process Shares,Printers

New-RumRenameTask

Creates a new rename task.

Detailed Description

The New-RumRenameTask cmdlet creates a new rename task.

Syntax

New-RumRenameTask [-Collection] <PSRumCollection> 
-RenameFile <String> [-Computer <PSRumComputer[]>] [
-Description <String>] [-InProgressTimeout <Int32>] [
-Name <String>] [-PendingTimeout <Int32>] [-Remote <Boolean>] [
-RestartMessage <String>] [-RestartTimeout <Int32>] [
-Schedule <DateTime>] [-ScriptAfter <String>] [
-ScriptBefore <String>] [-PassThru] [-Restart] [-RestartForce] [
<CommonParameters>]

New-RumRenameTask -CollectionName <String> -RenameFile <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Remote <Boolean>] [
-RestartMessage <String>] [-RestartTimeout <Int32>] [
-Schedule <DateTime>] [-ScriptAfter <String>] [
-ScriptBefore <String>] [-PassThru] [-Restart] [-RestartForce] [
<CommonParameters>]

Parameters

-Collection <PSRumCollection>

Collection.

-CollectionName <String>

Name of the collection.

-Computer <PSRumComputer[]>

Collection member computers where the task will run.

-Description <String>

Description of the task.

-InProgressTimeout <Int32>

The timeout in minutes for keeping the task in the In Progress state.

-Name <String>

Task name.

-PassThru

Returns the object that represents the task that was created. By default, this cmdlet does not generate any output.

-PendingTimeout <Int32>

The timeout in minutes for keeping the task in the Pending state.

-Remote <Boolean>

Makes the cmdlet perform the task remotely.

-RenameFile <String>

File containing pairs of the old and new computer names.

-Restart

Makes the cmdlet restart the computer.

-RestartForce

Makes the cmdlet force restart.

-RestartMessage <String>

Restart message.

-RestartTimeout <Int32>

Restart timeout.

-Schedule <DateTime>

When to run the task.

-ScriptAfter <String>

Script to run after the task.

-ScriptBefore <String>

Script to run before the task.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.

Inputs

PSRumCollection

PSRumComputer

Outputs

PSRumTask

Examples

Example 1

$task = Get-RumCollection "collection_1" | New-RumRenameTask 
-PassThru -RenameFile c:\rename.txt

New-RumScriptingTask

Creates a new scripting task.

Detailed Description

The New-RumScriptingTask cmdlet creates a new scripting task.

Syntax

New-RumScriptingTask [-Collection] <PSRumCollection> 
-Script <String> [-Computer <PSRumComputer[]>] [
-Description <String>] [-InProgressTimeout <Int32>] [
-Name <String>] [-PendingTimeout <Int32>] [-Schedule <DateTime>] [
-PassThru] [<CommonParameters>]

New-RumScriptingTask -CollectionName <String> -Script <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]

Parameters

-Collection <PSRumCollection>

Collection.

-CollectionName <String>

Name of the collection.

-Computer <PSRumComputer[]>

Collection member computers where the task will run.

-Description <String>

Description of the task.

-InProgressTimeout <Int32>

The timeout in minutes for keeping the task in the In Progress state.

-Name <String>

Task name.

-PassThru

Returns the object that represents the task that was created. By default, this cmdlet does not generate any output.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.

Inputs

PSRumCollection

PSRumComputer

Outputs

PSRumTask

Examples

Example 1

$task = Get-RumCollection "collection_1" | New-RumScriptingTask 
-PassThru -Script c:\script.cmd

Remove-RumCollection

Removes a collection from the project.

Detailed Description

The Remove-RumCollection cmdlet removes a collection from the project

Syntax

Remove-RumCollection [-Collection] <PSRumCollection[]> [
<CommonParameters>]

Remove-RumCollection [-Id] <Guid[]> [<CommonParameters>]

Remove-RumCollection [-Name] <String[]> [<CommonParameters>]

Parameters

-Collection <PSRumCollection[]>

Collection to remove.

-Id <Guid[]>

ID of the collection to remove.

-Name <String[]>

Name of the collection to remove.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.

Inputs

PSRumCollection

Outputs

None

Examples

Example 1

Remove-RumCollection "collection_1"

Example 2

Get-RumCollection "collection_1" | Remove-RumCollection