Chat now with support
Chat with Support

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

Copy-RumTask

Makes a copy of an existing task.

Detailed Description

The Copy-RumTask cmdlet makes a copy of an existing task and lets you specify any of the following properties: task name, list of computers to include and when to run the task.

Syntax
Copy-RumTask [-Task] <PSRumTask> [-Collection] <PSRumCollection> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
Copy-RumTask [-TaskId] <Guid> [-Collection] <PSRumCollection> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
Copy-RumTask [-Task] <PSRumTask> -CollectionName <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
Copy-RumTask [-TaskId] <Guid> -CollectionName <String> [
-Computer <PSRumComputer[]>] [-Description <String>] [
-InProgressTimeout <Int32>] [-Name <String>] [
-PendingTimeout <Int32>] [-Schedule <DateTime>] [-PassThru] [
<CommonParameters>]
Parameters
-Task <PSRumTask>

Original task.

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

 

-TaskId <Guid>

Original task ID.

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

Collection.

Required? true
Position? 2
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[]>

List of computers.

Required? false
Position? named
Defaultvalue none
Accept pipeline input? false
Accept wildcard characters? false

 

-Description <String>

Description of the new 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>

Name of the new task.

Required? false
Position? named
Default value 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

 

-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

PSRumTask

Outputs

PSRumTask

Examples
Example 1
Get-RumCollection "collection_1" | Copy-RumTask 
-TaskId $sourceTaskId -PassThru
Example 2

Get-RumTask $sourceTaskId | Copy-RumTask -CollectionName "collection_1"
-PassThru

Get-RumCollection

Returns existing collections.

Detailed Description

The Get-RumCollection cmdlet returns all existing collections that match the specified name wildcard or ID.

Syntax
Get-RumCollection [-Id] <Guid[]> [<CommonParameters>]
Get-RumCollection [[-Name] <String[]>] [<CommonParameters>]
Parameters
-Id <Guid[]>

ID of the requested collection.

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

 

-Name <String[]>

Name of the collection.

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

 

<CommonParameters>

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

Inputs

String

Guid

Outputs

PSRumCollection

Examples
Example 1
Get-RumCollection
Example 2
Get-RumCollection "collection_1"
Example 3
Get-RumCollection ([guid]$id)

Get-RumComputer

Returns existing computers in a collection.

Detailed Description

The Get-RumComputer cmdlet returns all existing computers in collection or category that match the specified name wildcard or ID

Syntax
Get-RumComputer [[-Collection] <PSRumCollection>] [
<CommonParameters>]
Get-RumComputer [-Id] <Guid[]> [<CommonParameters>]
Get-RumComputer [[-Name] <String[]>] -CollectionName <String> [
<CommonParameters>]
Get-RumComputer [-Name] <String[]> [[
-Collection] <PSRumCollection>] [<CommonParameters>]
Parameters
-Id <Guid[]>

ID of the requested computer.

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

Wildcard for the names of the requested computers.

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

 

-Collection <PSRumCollection>

Collection.

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

 

-CollectionName <String>

Name of the collection.

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

PSRumComputer

Examples
Example 1
Get-RumComputer
Example 2
Get-RumCollection "collection_1" | Get-RumComputer"
Example 3
Get-RumCollection "collection_1" | Get-RumComputer 
"domain_1\computer_1"

Get-RumConfiguration

Returns the current configuration.

Detailed Description

The Get-RumConfiguration cmdlet returns the current Resource Updating Manager configuration.

Syntax
Get-RumConfiguration [<CommonParameters>]
Parameters
<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

PSRumConfiguration

Object containing the current configuration

Examples
Example 1
Get-RumConfiguration
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating