Set-CMFileReplicationRoute

Changes settings for a file replication route in Configuration Manager.

Syntax

Set-CMFileReplicationRoute
   [-AvailabilityLevel <AvailabilityLevel>]
   [-BeginHr <Int32>]
   [-Confirm]
   [-ControlNetworkLoadSchedule]
   [-DaysOfWeek <DaysOfWeek[]>]
   -DestinationSiteCode <String>
   [-DisableWildcardHandling]
   [-EndHr <Int32>]
   [-ForceWildcardHandling]
   -SourceSiteCode <String>
   [-WhatIf]
   [<CommonParameters>]
Set-CMFileReplicationRoute [-Confirm] [-DataBlockSizeKB ] [-DelayBetweenDataBlockSec ]
 -DestinationSiteCode  [-DisableWildcardHandling] [-FileReplicationAccountName ]
 [-ForceWildcardHandling] [-PulseMode] -SourceSiteCode  [-WhatIf] []
Set-CMFileReplicationRoute [-Confirm] -DestinationSiteCode  [-DisableWildcardHandling]
 -FileReplicationAccountName  [-ForceWildcardHandling] -SourceSiteCode  [-WhatIf]
 []
Set-CMFileReplicationRoute [-Confirm] -DestinationSiteCode  [-DisableWildcardHandling]
 [-FileReplicationAccountName ] [-ForceWildcardHandling] [-LimitAvailableBandwidthPercent ]
 [-Limited] [-LimitedBeginHr ] [-LimitedEndHr ] -SourceSiteCode  [-WhatIf]
 []
Set-CMFileReplicationRoute [-Confirm] -DestinationSiteCode  [-DisableWildcardHandling]
 [-FileReplicationAccountName ] [-ForceWildcardHandling] -SourceSiteCode  [-Unlimited]
 [-WhatIf] []

Description

The Set-CMFileReplicationRoute cmdlet changes settings for a file replication route from Microsoft System Center 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 System Center Configuration Manager. The functionality of file replication routes is the same as that of addresses in earlier versions.

Examples

Example 1: Specify a file replication route by using a replication account name

PS C:\> Set-CMFileReplicationRoute -SourceSiteCode "CM2" -DestinationSiteCode "SS2" -FileReplicationAccountName "11\12" -Unlimited

This 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 C:\> Set-CMFileReplicationRoute -SourceSiteCode "CM2" -DestinationSiteCode "SS2" -ControlNetworkLoadSchedule -DaysOfWeek Friday, Sunday -AvailabilityLevel All

This 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.

Required Parameters

-ControlNetworkLoadSchedule

Indicates that scheduled replication controls network load.

Type:SwitchParameter
Required:True
Position:Named
Default value:None
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
Required:True
Position:Named
Default value:None
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
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Limited

Indicates that bandwidth for a file replication route is limited.

Type:SwitchParameter
Required:True
Position:Named
Default value:None
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
Required:True
Position:Named
Default value:None
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
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Unlimited

Indicates that bandwidth for a file replication route is unlimited.

Type:SwitchParameter
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional 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
Parameter Sets:All, MediumHigh, High, Closed
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-BeginHr
Type:Int32
Aliases:TimePeriodStart, BeginHour
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DataBlockSizeKB

Specifies a data block size, in kilobytes.

Type:Int32
Required:False
Position:Named
Default value:None
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[]
Parameter Sets:Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DelayBetweenDataBlockSec
Type:Int32
Aliases:DelayBetweenDataBlocksSeconds, DelayBetweenDataBlocksSec
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

Indicates that wildcard handling is disabled.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EndHr
Type:Int32
Aliases:TimePeriodEnd, EndHour
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

Indicates that wildcard handling is enabled.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LimitAvailableBandwidthPercent
Type:Int32
Aliases:LimitAvailableBandwidthPercentage
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LimitedBeginHr
Type:Int32
Aliases:LimitedTimePeriodStart, LimitedBeginHour
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LimitedEndHr
Type:Int32
Aliases:LimitedTimePeriodEnd, LimitedEndHour
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False