Edit

Share via

Add-CMStateMigrationPoint

Module:
ConfigurationManager Module

Adds a state migration point in Configuration Manager.

Syntax

ByValue (Default) 

Add-CMStateMigrationPoint
    -InputObject <IResultObject>
    -StorageFolder <StorageDirectoryData[]>
    [-AllowFallbackSourceLocationForContent <Boolean>]
    [-BoundaryGroupName <String[]>]
    [-DeleteImmediately]
    [-EnableRestoreOnlyMode <Boolean>]
    [-TimeDeleteAfter <Int32>]
    [-TimeUnit <IntervalType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName 

Add-CMStateMigrationPoint
    [-SiteSystemServerName] <String>
    -StorageFolder <StorageDirectoryData[]>
    [-AllowFallbackSourceLocationForContent <Boolean>]
    [-BoundaryGroupName <String[]>]
    [-DeleteImmediately]
    [-EnableRestoreOnlyMode <Boolean>]
    [-SiteCode <String>]
    [-TimeDeleteAfter <Int32>]
    [-TimeUnit <IntervalType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Add-CMStateMigrationPoint cmdlet adds a state migration point in Configuration Manager. A state migration point is a site system role that manages data transfer from client computers during an operating system installation process.

Note

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

Examples

Example 1: Add a state migration point

PS XYZ:\> $s1 = New-CMStoragefolder -StorageFolderName "C:\Sto-1" -MaximumClientNumber 100 -MinimumFreeSpace 100 -SpaceUnit Megabyte
PS XYZ:\> $s2 = New-CMStoragefolder -StorageFolderName "D:\Sto-2" -MaximumClientNumber 100 -MinimumFreeSpace 10 -SpaceUnit Gigabyte
PS XYZ:\> Add-CMStateMigrationPoint -SiteSystemServerName "Contoso-Migration.Contoso.com" -SiteCode "CM2" -StorageFolders $s1,$s2 -DeleteImmediately -EnableRestoreOnlyMode $False -AllowFallbackSourceLocationForContent $False -BoundaryGroupName "CMC"

The first command creates a storage folder on the C: drive that has a maximum number of clients setting and a minimum free space setting. The command stores the result in the $s1 variable.

The second command creates a storage folder on the D: drive that has a maximum number of clients setting and a minimum free space setting. The command stores the result in the $s2 variable.

The third command adds a state migration point.

Parameters

-AllowFallbackSourceLocationForContent

Indicates whether a fallback source ___location is available.

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

-BoundaryGroupName

Specifies an array of names of boundary groups. You can get a boundary group name by using the Get-CMBoundaryGroup cmdlet.

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

-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

-DeleteImmediately

Indicates that Configuration Manager deletes client data immediately after the target computer downloads the data.

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

-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

-EnableRestoreOnlyMode

Indicates whether to enable restore only mode. If this mode is enabled, Configuration Manager refuses new requests to store client data.

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

-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

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SiteServer

Parameter sets

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

-SiteCode

Specifies the Configuration Manager site that hosts this site system role.

Parameter properties

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

Parameter sets

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

-SiteSystemServerName

Specifies the name of the site system server in Configuration Manager.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name, ServerName

Parameter sets

ByName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageFolder

The Add-CMStateMigrationPoint cmdlet adds a state migration point in Configuration Manager. A state migration point is a site system role that manages data transfer from client computers during an operating system installation process.

Note

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

Parameter properties

Type:

StorageDirectoryData[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:StorageFolders

Parameter sets

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

-TimeDeleteAfter

Specifies a time interval to wait before client data is deleted.

Parameter properties

Type:Int32
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

-TimeUnit

Specifies the unit of time for the TimeDeleteAfter parameter. Valid values are: Days and Hours.

Parameter properties

Type:IntervalType
Default value:None
Accepted values:Hours, Days
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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject