Edit

Share via


New-CMMigrationJob

Creates a migration job in Configuration Manager.

Syntax

NewMigrationJobByObject (Default)

New-CMMigrationJob
    -MigrationObject <IResultObject[]>
    -Name <String>
    -SecurityScope <IResultObject[]>
    [-ContentObjectsSiteCodeMapping <Hashtable>]
    [-Description <String>]
    [-MigrationJobSchedule <DateTime>]
    [-ObjectMigrationJobType]
    [-OverwriteAllObject <Boolean>]
    [-SaveObjectInfoPath <String>]
    [-SiteCodeReplacementMapping <Hashtable>]
    [-TransferOrganizationalFolderStructure <Boolean>]
    [-UtcTime <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewMigrationJobByCollectionNotMigrateObject

New-CMMigrationJob
    -MigrationCollection <IResultObject[]>
    -Name <String>
    -SecurityScope <IResultObject[]>
    [-CollectionLimitingMapping <Hashtable>]
    [-CollectionMigrationJobType]
    [-Description <String>]
    [-EnableProgramAfterAdvertisementMigrated <Boolean>]
    [-MigrationJobSchedule <DateTime>]
    [-OverwriteAllObject <Boolean>]
    [-SaveCollectionInfoPath <String>]
    [-SaveObjectInfoPath <String>]
    [-SiteCodeReplacementMapping <Hashtable>]
    [-TransferOrganizationalFolderStructure <Boolean>]
    [-UtcTime <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewMigrationJobByCollectionMigrateObject

New-CMMigrationJob
    -MigrationCollection <IResultObject[]>
    -MigrationObject <IResultObject[]>
    -Name <String>
    -SecurityScope <IResultObject[]>
    [-CollectionLimitingMapping <Hashtable>]
    [-CollectionMigrationJobType]
    [-ContentObjectsSiteCodeMapping <Hashtable>]
    [-Description <String>]
    [-EnableProgramAfterAdvertisementMigrated <Boolean>]
    [-MigrateObjectWithSpecifiedCollection]
    [-MigrationJobSchedule <DateTime>]
    [-OverwriteAllObject <Boolean>]
    [-SaveCollectionInfoPath <String>]
    [-SaveObjectInfoPath <String>]
    [-SiteCodeReplacementMapping <Hashtable>]
    [-TransferOrganizationalFolderStructure <Boolean>]
    [-UtcTime <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewMigrationJobByObjectModified

New-CMMigrationJob
    -MigrationObject <IResultObject[]>
    -Name <String>
    -SecurityScope <IResultObject[]>
    [-ContentObjectsSiteCodeMapping <Hashtable>]
    [-Description <String>]
    [-MigrationJobSchedule <DateTime>]
    [-ObjectModifiedAfterMigrationJobType]
    [-OverwriteAllObject <Boolean>]
    [-SaveObjectInfoPath <String>]
    [-SiteCodeReplacementMapping <Hashtable>]
    [-TransferOrganizationalFolderStructure <Boolean>]
    [-UtcTime <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-CMMigrationJob cmdlet creates a migration job in Configuration Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Create a migration job

PS XYZ:\> $CategoryObjects = Get-CMInitialModifiableSecuredCategory
PS XYZ:\> $MigrationEntity = Get-CMMigrationEntity
PS XYZ:\> New-CMMigrationJob -Name "123" -ObjectMigrationJobType -SecurityScope $CategoryObjects -MigrationObject $MigrationEntity

The first command uses the Get-CMInitialModifiableSecuredCategory cmdlet and stores the result in the $CategoryObjects variable.

The second command uses the Get-CMMigrationEntity cmdlet and stores the result in the $MigrationEntity variable.

The last command creates a migration job.

Parameters

-CollectionLimitingMapping

Specifies key-value pairings to limit a collection. Collection limiting prevents the addition of collection members you do want in the collection.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByCollectionNotMigrateObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CollectionMigrationJobType

Indicates that the job migrates collections, objects, or previously migrated objects.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByCollectionNotMigrateObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentObjectsSiteCodeMapping

Specifies key-value pairs that map content objects in the new site.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByObjectModified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the migration job.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableProgramAfterAdvertisementMigrated

Indicates whether to enable programs associated with an advertisement after they have migrated.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByCollectionNotMigrateObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MigrateObjectWithSpecifiedCollection

Indicates that you migrate associated objects with the collection.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MigrationCollection

Specifies an array of input objects.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByCollectionNotMigrateObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MigrationJobSchedule

Specifies a date time, in D.HH:MM:SS format, to schedule the migration job.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MigrationObject

Specifies an array of input objects.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByObjectModified
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of a migration job in Configuration Manager.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ObjectMigrationJobType

Indicates that the job type is an object migration job.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ObjectModifiedAfterMigrationJobType

Indicates that the new migration job only includes objects that were modified since the last migration.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByObjectModified
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OverwriteAllObject

Indicates whether to overwrite objects in the destination database.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SaveCollectionInfoPath

Specifies a path for the collection information.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewMigrationJobByCollectionNotMigrateObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
NewMigrationJobByCollectionMigrateObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SaveObjectInfoPath

Specifies a path for the object information.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SecurityScope

Specifies an array of security scope objects. To obtain a security scope object, use the Get-CMSecurityScope cmdlet. The cmdlet applies the security scopes that you specify to data migrated to the destination hierarchy.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SiteCodeReplacementMapping

Specifies key-value pairs that map a migrated collection to a site in the destination.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TransferOrganizationalFolderStructure

Indicates whether to migrate an empty collection. Configuration Manager converts the empty collection to an organizational folder.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UtcTime

Indicates whether to use UTC time.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

None

Outputs

IResultObject