Add-CMStateMigrationPoint
Adds a state migration point in Configuration Manager.
Syntax
Add-CMStateMigrationPoint
[-AllowFallbackSourceLocationForContent <Boolean>]
[-BoundaryGroupName <String[]>]
[-DeleteImmediately]
[-EnableRestoreOnlyMode <Boolean>]
-InputObject <IResultObject>
-StorageFolder <StorageDirectoryData[]>
[-TimeDeleteAfter <Int32>]
[-TimeUnit <IntervalType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-CMStateMigrationPoint
[-AllowFallbackSourceLocationForContent <Boolean>]
[-BoundaryGroupName <String[]>]
[-DeleteImmediately]
[-EnableRestoreOnlyMode <Boolean>]
[-SiteCode <String>]
[-SiteSystemServerName] <String>
-StorageFolder <StorageDirectoryData[]>
[-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.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BoundaryGroupName
Specifies an array of names of boundary groups. You can get a boundary group name by using the Get-CMBoundaryGroup cmdlet.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeleteImmediately
Indicates that Configuration Manager deletes client data immediately after the target computer downloads the data.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnableRestoreOnlyMode
Indicates whether to enable restore only mode. If this mode is enabled, Configuration Manager refuses new requests to store client data.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: | IResultObject |
Aliases: | SiteServer |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SiteCode
Specifies the Configuration Manager site that hosts this site system role.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SiteSystemServerName
Specifies the name of the site system server in Configuration Manager.
Type: | String |
Aliases: | Name, ServerName |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StorageFolder
Type: | StorageDirectoryData[] |
Aliases: | StorageFolders |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TimeDeleteAfter
Specifies a time interval to wait before client data is deleted.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TimeUnit
Specifies the unit of time for the TimeDeleteAfter parameter. Valid values are: Days and Hours.
Type: | IntervalType |
Accepted values: | Hours, Days |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject