Chat now with support
Chat with Support

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

Set-RumConfiguration

Modifies configuration parameters.

Detailed Description

The Set-RumConfiguration cmdlet modifies Resource Updating Manager configuration parameters.

Syntax
Set-RumConfiguration -Project <String> [<CommonParameters>]
Set-RumConfiguration [-Server] <String> [-Port] <Int32> [[
-Project] <String>] [-ControllerCredential <PSCredential>] [
<CommonParameters>]
Parameters
-Server <String>

AD LDS or ADAM server.

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

 

-Port <Int32>

Port number.

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

 

-Project <String>

Project name.

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

 

-ControllerCredential <PSCredential>

Credentials for the service controller.

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

None

Examples
Example 1
Set-RumConfiguration "server" 389 "CN=QMMADProject"
Example 2
Set-RumConfiguration "server" 389; Set-RumConfiguration 
-Project (Get-RumProject | select -first 1)

Start-RumTask

Runs a task.

Detailed Description

The Start-RumTask cmdlet runs the task immediately or sets a schedule.

Syntax
Start-RumTask [-Task] <PSRumTask> [[-Schedule] <DateTime>] [
-PassThru] [<CommonParameters>]
Parameters
-Task <PSRumTask>

Task.

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

 

-Schedule <DateTime>

When to run the task.

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

 

-PassThru

Returns the object that represents the task. 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

PSRumTask

Outputs

PSRumTask

Examples
Example 1
Get-RumTask -CollectionName "collection_1" | Start-RumTask 
-PassThru | Wait-RumUpdate

Stop-RumTask

Stops a running task.

Detailed Description

The Stop-RumTask cmdlet stops a running task

Syntax
Stop-RumTask [-Task] <PSRumTask> [-PassThru] [<CommonParameters>]
Parameters
-Task <PSRumTask>

Task.

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

 

-PassThru

Returns the object that represents the task. 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

PSRumTask

Outputs

PSRumTask

Examples
Example 1
Get-RumTask "task name" -CollectionName "collection_1" | Stop-RumTask

Wait-RumUpdate

Waits until tasks or processing of computers complete with specified statuses.

Detailed Description

The Wait-RumUpdate cmdlet waits until tasks or processing of computers complete with specified statuses.

Syntax
Wait-RumUpdate [-Task] <PSRumTask[]> [-PollInterval <TimeSpan>] [
-Timeout <TimeSpan>] [-WaitTaskStatus <RumTaskStatuses[]>] [
-All] [-PassThru] [<CommonParameters>]
Wait-RumUpdate [-Computer] <PSRumComputer[]> [
-PollInterval <TimeSpan>] [-Timeout <TimeSpan>] [
-WaitComputerStatus <RumComputerStatuses[]>] [-All] [-PassThru] [
<CommonParameters>]
Parameters
-Task <PSRumTask[]>

Tasks to be monitored.

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

 

-Computer <PSRumComputer[]>

Computers to be monitored.

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

Makes the cmdlet wait until all tasks or processing of all computers complete; otherwise, the waiting stops as soon as any task or processing of any computer completes.

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

 

-PassThru

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

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

 

-PollInterval <TimeSpan>

Polling interval for status information updating in HH:mm:ss format.

Required? false
Position? named
Default value 00:00:10
Accept pipeline input? false
Accept wildcard characters? false

 

-Timeout <TimeSpan>

Timeout for waiting in HH:mm:ss format. By default, there is no timeout.

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

 

-WaitComputerStatus <RumComputerStatuses[]>

Processing statuses for specified computers that cause cmdlet completion.

Required? false
Position? named
Default value ComputerStatusOk, ComputerStatusFailure, ComputerStatusWarning, ComputerStatusUnknown
Accept pipeline input? false
Accept wildcard characters? false

 

-WaitTaskStatus <RumTaskStatuses[]>

Task statuses that cause cmdlet completion.

Required? false
Position? named
Default value Cancelled, Completed, Failed
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

PSRumTask

PSRumComputer

Outputs

Object

Examples
Example 1
Get-RumTask -CollectionName "collection_1" | Start-RumTask -PassThru | Wait-RumUpdate
Example 2
New-RumDiscoveryTask -CollectionName $value -PassThru | Start-RumTask -PassThru | Wait-RumUpdate -WaitTaskStatus Completed -Timeout 00:01:30
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating