Set-CMStateMigrationPoint
Modifies settings for a state migration point in Configuration Manager.
Syntax
SetByValue (Default)
Set-CMStateMigrationPoint
-InputObject <IResultObject>
[-AddBoundaryGroupName <String[]>]
[-AddStorageFolder <StorageDirectoryData[]>]
[-AllowFallbackSourceLocationForContent <Boolean>]
[-DeleteImmediately]
[-EnableRestoreOnlyMode <Boolean>]
[-PassThru]
[-RemoveBoundaryGroupName <String[]>]
[-RemoveStorageFolder <StorageDirectoryData[]>]
[-TimeDeleteAfter <Int32>]
[-TimeUnit <IntervalType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByName
Set-CMStateMigrationPoint
[-SiteSystemServerName] <String>
[-AddBoundaryGroupName <String[]>]
[-AddStorageFolder <StorageDirectoryData[]>]
[-AllowFallbackSourceLocationForContent <Boolean>]
[-DeleteImmediately]
[-EnableRestoreOnlyMode <Boolean>]
[-PassThru]
[-RemoveBoundaryGroupName <String[]>]
[-RemoveStorageFolder <StorageDirectoryData[]>]
[-SiteCode <String>]
[-TimeDeleteAfter <Int32>]
[-TimeUnit <IntervalType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-CMStateMigrationPoint cmdlet modifies settings for 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. Use this cmdlet to modify the boundary groups and storage folders associated with the migration point, how long to wait before the migration point deletes client data, whether to allow a fallback source location for content, and whether to enable restore only mode.
You can specify which migration point to modify by using the site system server name and the site code, or use the Get-CMStateMigrationPoint cmdlet.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Modify a state migration point
PS XYZ:\> $StateMigrationPoint = Get-CMStateMigrationPoint -SiteCode "CM4" -SiteSystemServerName "MigrationServer.TSQA.Contoso.com"
PS XYZ:\> Set-CMStateMigrationPoint -InputObject $StateMigrationPoint -AllowFallbackSourceLocationForContent $True -TimeDeleteAfter 12 -TimeUnit Hours
This example modifies a migration point named MigrationServer.TSQA.Contoso.com for the site that has the code CM4. The example changes the migration point to allow a fallback source location for content, and modifies how long after data download to delete data.
The first command uses the Get-CMStateMigrationPoint cmdlet to obtain a migration point for the specified site code and server name, and stores it in the $StateMigrationPoint variable.
The second command modifies the input object stored in the $StateMigrationPoint variable. The command sets the AllowFallbackSourceLocationForContent parameter to $True, and modifies the time to delete after to 12 hours.
Example 2: Modify storage folders and boundary groups for a state migration point
PS XYZ:\> $Storage01 = New-CMStoragefolder -MaximumClientNumber 100 -MinimumFreeSpace 100 -SpaceUnit Megabyte -StorageFolderName "C:\"
PS XYZ:\> $Storage02 = New-CMStoragefolder -MaximumClientNumber 100 -MinimumFreeSpace 10 -SpaceUnit Gigabyte -StorageFolderName "D:\"
PS XYZ:\> Set-CMStateMigrationPoint -SiteCode "CM4" -SiteSystemServerName "MigrationServer.TSQA.Contoso.com" -AddBoundaryGroupName "BG07" -AddStorageFolder $Storage02 -AllowFallbackSourceLocationForContent $False -DeleteImmediately -EnableRestoreOnlyMode $True -RemoveBoundaryGroupName "BG22" -RemoveStorageFolder $Storage01
This example modifies settings for a state migration point named MigrationServer.TSQA.Contoso.com for the site that has the site code CM4. The example substitutes a different boundary group and different storage folder, and modifies other settings.
The first command uses the New-CMStoragefolder cmdlet to create a storage folder object, and stores it in the $Storage01 variable. Consult documentation for that cmdlet for more information.
The second command uses the New-CMStoragefolder cmdlet to create a storage folder object, and stores it in the $Storage02 variable.
The third command removes the storage folder stored in the $Storage01 variable from the migration point and, in the same command, adds the storage folder stored in the $Storage02 variable to the migration point. Likewise, the command removes the boundary group named BG22 and adds the boundary group named BG07. The command also specifies a value of $False for the AllowFallbackSourceLocationForContent parameter and a value of $True for the EnableRestoreOnlyMode parameter. The command uses the DeleteImmediately parameter; therefore, the migration point deletes client information immediately after download.
Parameters
-AddBoundaryGroupName
Specifies an array of boundary group names. The cmdlet adds these boundary groups to the state migration point. During migration, clients in a boundary group use this site as a source location for content.
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 |
-AddStorageFolder
Specifies an array of storage folders, as storage directory data objects. The cmdlet adds these folders to the state migration point. To obtain a storage directory data object, use the New-CMStoragefolder cmdlet.
A state migration point stores user state data when it migrates a computer to a new operating system.
Parameter properties
| Type: | StorageDirectoryData[] |
| 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 |
-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 |
-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 deletion of client data occurs immediately after the target computer downloads that data. If you select a value of $False, specify how long to wait by using the TimeDeleteAfter and TimeUnit parameters.
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. In restore only mode, 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 a state migration point object. To obtain a state migration point object, use the Get-CMStateMigrationPoint cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | StateMigrationPoint |
Parameter sets
SetByValue
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
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 |
-RemoveBoundaryGroupName
Specifies an array of boundary group names. The cmdlet removes these boundary groups from the state migration point. During migration, clients in a boundary group use this site as a source location for content.
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 |
-RemoveStorageFolder
Specifies an array of storage folders, as storage directory data objects. The cmdlet removes these folders from the state migration point. A state migration point stores user state data when it migrates a computer to a new operating system.
Parameter properties
| Type: | StorageDirectoryData[] |
| 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 |
-SiteCode
Specifies the site code for a Configuration Manager site.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteSystemServerName
Specifies the host name for a state migration point.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name, ServerName |
Parameter sets
SetByName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TimeDeleteAfter
Specifies the amount of time to wait after the target computer downloads data to delete that data. Specify a time unit by using the TimeUnit parameter. To delete data immediately, specify a value of $True for the DeleteImmediately parameter.
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 a time unit for the value specified in the TimeDeleteAfter parameter. The acceptable values for this parameter 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.