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

Getting Started

Getting Started

Resource Updating Manager operation can be automated using Resource Updating Toolkit for PowerShell (PowerRUM). This is a collection of Windows PowerShell cmdlets that replicate the functionality of the Resource Updating Manager console: you can use them to create, view and remove collections, computers and tasks, run tasks, and so on. These command-line tools are useful whenever your resource processing scenarios lend themselves to automation through scripts.

The following software is required on the computer where you run Resource Updating Toolkit cmdlets:

  • Windows Management Framework 3.0
  • One of the following:
    • Migration Manager console
    • Standalone Resource Updating Manager console

You can work locally on this computer or connect to it remotely.

Using Resource Updating Toolkit for PowerShell Remotely

On the remote computer, run the PowerShell prompt, and start your session as follows (changing the path and target computer as appropriate):

Enable-PSRemoting -Force

$cred = Get-Credential

Enter-PSSession -ComputerName COMPUTER -Credential $cred -ConfigurationName Microsoft.PowerShell32

Set-Executionpolicy -ExecutionPolicy Unrestricted -Force

cd "C:\Program Files (x86)\Quest Software\Migration Manager\PowerRUM"

Import-Module .\PowerRUM.dll

Using Resource Updating Toolkit for PowerShell Locally

Run the 32-bit (x86) version of the PowerShell prompt, and start your session as follows (changing the path if necessary):

Set-Executionpolicy -ExecutionPolicy Unrestricted -Force

cd "C:\Program Files (x86)\Quest Software\Migration Manager\PowerRUM"

Import-Module .\PowerRUM.dll

Cmdlet Reference

Cmdlet Reference

The following list contains links to the help topics for Resource Updating Toolkit for PowerShell cmdlets.

Name Description
Add-RumComputer Adds a computer to a collection
Add-RumDomainCredential Adds an domain credential to a collection or project root; the credential will be used for access to the specified domain
Copy-RumTask Makes a copy of an existing task
Get-RumCollection Returns existing collections
Get-RumComputer Returns existing computers in a collection
Get-RumConfiguration Returns the current configuration
Get-RumDomainCredential Returns the objects representing domain credential
Get-RumProject Returns a list of existing projects
Get-RumResult Returns task results
Get-RumTask Returns existing tasks for the specified collection
New-RumCleanupTask Creates a new cleanup task
New-RumCollection Creates a new collection in current RUM project
New-RumDiscoveryTask Creates a new discovery task
New-RumMoveTask Creates a new move task
New-RumProcessingTask Creates a new processing task
New-RumRenameTask Creates a new rename task
New-RumScriptingTask Creates a new scripting task
Remove-RumCollection Removes a collection from the project
Remove-RumComputer Removes a computer from a collection
Remove-RumDomainCredential Removes account-representing objects from a collection

Reset-RumCollectionDataProvider

Resets currently specified external account mapping data provider for a collection

Set-RumCollectionDataProvider Sets an external account mapping data provider for a collection
Set-RumConfiguration Modifies configuration parameters
Start-RumTask Runs a task
Stop-RumTask Stops a running task
Wait-RumUpdate

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

Add-RumComputer

Add-RumComputer

Adds a computer to a collection.

Detailed Description

The Add-RumComputer cmdlet adds a computer to a collection; the computer is not necessarily included in the project.

Syntax
Add-RumComputer [-Computer] <PSRumComputer[]> 
-CollectionName <String> [-PassThru] [<CommonParameters>]
Add-RumComputer [-Computer] <PSRumComputer[]> [
-Collection] <PSRumCollection> [-PassThru] [<CommonParameters>]
Add-RumComputer [-ComputerName] <String[]> 
-CollectionName <String> [-ComputerDomain <String>] [
-PassThru] [<CommonParameters>]
Add-RumComputer [-ComputerName] <String[]> [
-Collection] <PSRumCollection> [-ComputerDomain <String>] [
-PassThru] [<CommonParameters>]
Parameters
-Computer <PSRumComputer[]>

The computer to add to the collection.

Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
 
-ComputerName <String[]>

The name of the computer to add to the collection.

Required? true
Position? 1
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
 
-Collection <PSRumCollection>

The collection to add the computer to.

Required? true
Position? 2
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
 
-CollectionName <String>

The name of the collection to add the computer to

Required? true
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? false
 
-ComputerDomain <String>

The domain of the computer to add to the collection.

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

Returns the objects that represent the collections that were changed. 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

PSRumCollection

PSRumComputer

String

Outputs

PSRumComputer

Examples
Example 1
Get-RumCollection "collection_1" | Add-RumComputer 
"domain_1\computer_1"
Example 2
Get-RumCollection "collection_1" | Add-RumComputer "computer_1" 
-ComputerDomain "domain_1"
Example 3
"computer_1", "computer_2", "computer_3" | Add-RumComputer 
-CollectionName "collection_1" -ComputerDomain "domain_1"
Example 4
Get-RumComputer -CollectionName "collection_1" | Add-RumComputer 
-CollectionName "collection_2"

Add-RumDomainCredential

Add-RumDomainCredential

Adds an domain credential to a collection or project root; the credential will be used for access to the specified domain.

Detailed Description

The Add-RumDomainCredential cmdlet adds an domain credential to a collection or project root; the credential will be used for access to the specified domain.

Syntax
Add-RumDomainCredential [-Name] <String> [
-Credential] <PSCredential> [[-Collection] <PSRumCollection>] [
-PassThru] [<CommonParameters>]
Add-RumDomainCredential [-Name] <String> [
-Credential] <PSCredential> -CollectionName <String> [
-PassThru] [<CommonParameters>]
Parameters
-Name <String>

Domain.

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

 

-Credential <PSCredential&gt>

Credentials for access to the domain.

Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
 
-Collection <PSRumCollection>

Collection.

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

 

-CollectionName <String>

Name of the collection.

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

Returns the object that represent the domain credential. 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

PSRumCollection

Outputs

PSRumDomainCredential

Examples
Example 1
Add-RumDomainCredential "domain_1" (Get-Credential)
Example 2
Get-RumCollection "collection_1" | Add-RumDomainCredential 
"domain_1" (Get-Credential)
Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents