Set-CMFileReplicationRoute
Changes settings for a file replication route in Configuration Manager.
Syntax
Set-CMFileReplicationRoute
-DestinationSiteCode <String>
[-FileReplicationAccountName <String>]
-SourceSiteCode <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMFileReplicationRoute
[-AvailabilityLevel <AvailabilityLevel>]
[-BeginHr <Int32>]
[-ControlNetworkLoadSchedule]
[-DaysOfWeek <DaysOfWeek[]>]
-DestinationSiteCode <String>
[-EndHr <Int32>]
-SourceSiteCode <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMFileReplicationRoute
[-DataBlockSizeKB <Int32>]
[-DelayBetweenDataBlockSec <Int32>]
-DestinationSiteCode <String>
[-FileReplicationAccountName <String>]
[-PulseMode]
-SourceSiteCode <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMFileReplicationRoute
-DestinationSiteCode <String>
[-FileReplicationAccountName <String>]
-SourceSiteCode <String>
[-Unlimited]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMFileReplicationRoute
-DestinationSiteCode <String>
[-FileReplicationAccountName <String>]
[-LimitAvailableBandwidthPercent <Int32>]
[-Limited]
[-LimitedBeginHr <Int32>]
[-LimitedEndHr <Int32>]
-SourceSiteCode <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-CMFileReplicationRoute cmdlet changes settings for a file replication route from Configuration Manager. Configuration Manager uses file replication routes to transfer file-based data between sites in a hierarchy. Each file replication route identifies a destination site to which file-based data can transfer.
File replication routes were known as addresses in versions of Configuration Manager before Configuration Manager. The functionality of file replication routes is the same as that of addresses in earlier versions.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Specify a file replication route by using a replication account name
PS XYZ:\> Set-CMFileReplicationRoute -SourceSiteCode "CM2" -DestinationSiteCode "SS2" -FileReplicationAccountName "11\12" -UnlimitedThis command specifies a file replication route between the source site named CM2 and the destination site named SS2. It uses the user account name 11\12 for file replication.
Example 2: Specify a file replication route by using a source and destination site names
PS XYZ:\> Set-CMFileReplicationRoute -SourceSiteCode "CM2" -DestinationSiteCode "SS2" -ControlNetworkLoadSchedule -DaysOfWeek Friday, Sunday -AvailabilityLevel AllThis command specifies a file replication route between the source site named CM2 and the destination site named SS2. It schedules file replication for Fridays and Sundays.
Parameters
-AvailabilityLevel
Specifies a value that indicates the priorities for which the scheduled restriction allows. The system allows all priorities, no priorities, high priority only or high and medium priority. The acceptable values for this parameter are:
- All
- Closed
- High
- MediumHigh
| Type: | AvailabilityLevel |
| Accepted values: | All, MediumHigh, High, Closed |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BeginHr
| Type: | Int32 |
| Aliases: | TimePeriodStart, BeginHour |
| 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 |
-ControlNetworkLoadSchedule
Indicates that scheduled replication controls network load.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DataBlockSizeKB
Specifies a data block size, in kilobytes.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DaysOfWeek
Specifies an array of values that indicate when the file replication runs for this route. The acceptable values for this parameter are:
- Friday
- Saturday
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
| Type: | DaysOfWeek[] |
| Accepted values: | Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DelayBetweenDataBlockSec
| Type: | Int32 |
| Aliases: | DelayBetweenDataBlocksSeconds, DelayBetweenDataBlocksSec |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestinationSiteCode
Specifies the destination site in the file replication route that you change by using a site code.
| Type: | String |
| Aliases: | DesSiteCode, DestSiteCode, ServerFqdn |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-EndHr
| Type: | Int32 |
| Aliases: | TimePeriodEnd, EndHour |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileReplicationAccountName
Specifies the account that Configuration Manager uses to install a site on the specified server and maintain communications between the site and other sites. This account must have local administrative credentials.
| Type: | String |
| 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 |
-LimitAvailableBandwidthPercent
| Type: | Int32 |
| Aliases: | LimitAvailableBandwidthPercentage |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Limited
Indicates that bandwidth for a file replication route is limited.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LimitedBeginHr
| Type: | Int32 |
| Aliases: | LimitedTimePeriodStart, LimitedBeginHour |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LimitedEndHr
| Type: | Int32 |
| Aliases: | LimitedTimePeriodEnd, LimitedEndHour |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PulseMode
Indicates that file replication uses data block size and delays between transmissions. Use this parameter when you have low network bandwidth between sites.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourceSiteCode
Specifies the source site in the file replication route that you change by using a site code.
| Type: | String |
| Aliases: | SiteCode |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Unlimited
Indicates that bandwidth for a file replication route is unlimited.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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
None
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for