Chat now with support
Chat with Support

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

New-RumCleanupTask

Creates a new cleanup task..

Detailed Description

The New-RumCleanupTask cmdlet creates a new cleanup task.

Syntax
New-RumCleanupTask [-Collection] <PSRumCollection> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
New-RumCleanupTask -CollectionName <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
Parameters
-Collection <PSRumCollection>

Collection.

Required? true
Position? 1
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

 

-CollectionName <String>

Name of the collection.

Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Computer <PSRumComputer[]>

Computers where the task will run.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Description <String>

Description of the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-InProgressTimeout <Int32>

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Name <String>

Task name.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PassThru

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PendingTimeout <Int32>

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Schedule <DateTime>

When to run the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

<CommonParameters>

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

Inputs

Collection

Outputs

PSRumTask

Examples
Example 1
Get-RumCollection "collection_1" | New-RumCleanupTask 
-Name "Task_Cleanup" -Schedule "2013/12/31 23:59"

New-RumCollection

Creates a new collection in current project.

Detailed Description

The New-RumCollection cmdlet creates a new collection in current RUM project.

Syntax
New-RumCollection [-Name] <String> [-Description <String>] [
-PassThru] [
<CommonParameters>]
Parameters
-Name <String>

Collection name

Required? true
Position? 1
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

 

-Description <String>

Description of the collection.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PassThru

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

<CommonParameters>

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

Inputs

None

Outputs

PSRumTask

Examples
Example 1
New-RumCollection "new collection name"

New-RumDiscoveryTask

Creates a new discovery task.

Detailed Description

The New-RumDiscoveryTask cmdlet creates a new discovery task.

Syntax
New-RumDiscoveryTask [-Collection] <PSRumCollection> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
New-RumDiscoveryTask -CollectionName <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
Parameters
-Collection <PSRumCollection>

Collection.

Required? true
Position? 1
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

 

-CollectionName <String>

Name of the collection.

Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Computer <PSRumComputer[]>

Collection member computers where the task will run.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Description <String>

Description of the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-InProgressTimeout <Int32>

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Name <String>

Task name.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PassThru

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PendingTimeout <Int32>

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Schedule <DateTime>

When to run the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

<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-RumDiscoveryTask -PassThru

New-RumMoveTask

Creates a new move task.

Detailed Description

The New-RumMoveTask cmdlet creates a new move task

Syntax
New-RumMoveTask [-Collection] <PSRumCollection> 
-TargetDomain <String> [-Computer <PSRumComputer[]>] [
-Description <String>] [-GrantLocalAdmin <String[]>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-RestartMessage <String>] [
-RestartTimeout <Int32>] [-Schedule <DateTime>] [
-ScriptAfter <String>] [-ScriptBefore <String>] [
-TargetContainer <String>] [-PassThru] [-PreserveSourceAccount] [
-Remote] [-Restart] [-RestartForce] [-UpdateLastLoggedDomain] [
<CommonParameters>]
New-RumMoveTask -CollectionName <String> -TargetDomain <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-GrantLocalAdmin <String[]>] [-InProgressTimeout <Int32>] [
-Name <String>] [-PendingTimeout <Int32>] [
-RestartMessage <String>] [-RestartTimeout <Int32>] [
-Schedule <DateTime>] [-ScriptAfter <String>] [
-ScriptBefore <String>] [-TargetContainer <String>] [
-PassThru] [-PreserveSourceAccount] [-Remote] [-Restart] [
-RestartForce] [-UpdateLastLoggedDomain] [<CommonParameters>]
Parameters
-Collection <PSRumCollection>

Collection.

Required? true
Position? 1
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

 

-CollectionName <String>

Name of the collection.

Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Computer <PSRumComputer[]>

Collection member computers where the task will run.

Required? false
Position? named
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

 

-Description <String>

Description of the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-GrantLocalAdmin <String[]>

The accounts that will be added to the local Administrators group on the computers you are going to move.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-InProgressTimeout <Int32>

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Name <String>

Task name.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PassThru

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PendingTimeout <Int32>

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

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-PreserveSourceAccount

Makes the cmdlet preserve the computer account in the source domain.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Remote

Makes the cmdlet perform the task remotely.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Restart

Makes the cmdlet restart the computer.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-RestartForce

Makes the cmdlet force restart.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-RestartMessage <String>

Restart message.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-RestartTimeout <Int32>

Restart timeout.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-Schedule <DateTime>

When to run the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-ScriptAfter <String>

Script to run after the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-ScriptBefore <String>

Script to run before the task.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-TargetContainer <String>

Target container DN.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-TargetDomain <String>

Target domain.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

-UpdateLastLoggedDomain

Makes the cmdlet change the last logged-in domain to the target domain.

Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false

 

<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-RumMoveTask 
-PassThru -TargetDomain "domain"
Related Documents