Set-CMFileReplicationRoute
Set-CMFileReplicationRoute
Changes settings for a file replication route in Configuration Manager.
Syntax
Parameter Set: SetFileReplicationRouteByLimited
Set-CMFileReplicationRoute -DestinationSiteCode <String> -Limited -SourceSiteCode <String> [-FileReplicationAccountName <String> ] [-LimitAvailableBandwidthPercentage <Int32> ] [-LimitedTimePeriodEnd <Int32> ] [-LimitedTimePeriodStart <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetFileReplicationRouteByPulseMode
Set-CMFileReplicationRoute -DestinationSiteCode <String> -PulseMode -SourceSiteCode <String> [-DataBlockSizeKB <Int32> ] [-DelayBetweenDataBlocksSeconds <Int32> ] [-FileReplicationAccountName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetFileReplicationRouteBySchedule
Set-CMFileReplicationRoute -ControlNetworkLoadSchedule -DestinationSiteCode <String> -SourceSiteCode <String> [-AvailabilityLevel <AvailabilityLevel> {All | Closed | High | MediumHigh} ] [-DaysOfWeek {Friday | Monday | Saturday | Sunday | Thursday | Tuesday | Wednesday}[] ] [-TimePeriodEnd <Int32> ] [-TimePeriodStart <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetFileReplicationRouteByUnlimited
Set-CMFileReplicationRoute -DestinationSiteCode <String> -SourceSiteCode <String> -Unlimited [-FileReplicationAccountName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-CMFileReplicationRoute cmdlet changes settings for a file replication route from Microsoft System Center 2012 SP1 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 2012 Configuration Manager. The functionality of file replication routes is the same as that of addresses in earlier versions.
Parameters
-AvailabilityLevel<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
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ControlNetworkLoadSchedule
Indicates that scheduled replication controls network load.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DataBlockSizeKB<Int32>
Specifies a data block size, in kilobytes.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DaysOfWeek<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
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DelayBetweenDataBlocksSeconds<Int32>
Specifies the delay between transmission of data blocks.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DestinationSiteCode<String>
Specifies the destination site in the file replication route that you change by using a site code.
Aliases |
DesSiteCode |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-FileReplicationAccountName<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LimitAvailableBandwidthPercentage<Int32>
Specifies the percentage of available bandwidth to restrict on a network replication route.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Limited
Indicates that bandwidth for a file replication route is limited.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LimitedTimePeriodEnd<Int32>
Specifies when the time period of limited bandwidth ends.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LimitedTimePeriodStart<Int32>
Specifies when the time period of limited bandwidth starts.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SourceSiteCode<String>
Specifies the source site in the file replication route that you change by using a site code.
Aliases |
SiteCode |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TimePeriodEnd<Int32>
Specifies the end time for file replication.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TimePeriodStart<Int32>
Specifies the start time for file replication.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Unlimited
Indicates that bandwidth for a file replication route is unlimited.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Specify a file replication route by using a replication account name
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.
PS C:\> Set-CMFileReplicationRoute -SourceSiteCode "CM2" -DestinationSiteCode "SS2" -FileReplicationAccountName "11\12" -Unlimited
Example 2: Specify a file replication route by using a source and destination site names
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.
PS C:\> Set-CMFileReplicationRoute -SourceSiteCode "CM2" -DestinationSiteCode "SS2" -ControlNetworkLoadSchedule -DaysOfWeek Friday, Sunday -AvailabilityLevel All