Edit

Share via

Set-CMFileReplicationRoute

Module:
ConfigurationManager Module

Changes settings for a file replication route in Configuration Manager.

Syntax

SetFileReplicationAccount (Default) 

Set-CMFileReplicationRoute
    -DestinationSiteCode <String>
    -SourceSiteCode <String>
    [-FileReplicationAccountName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetFileReplicationRouteBySchedule 

Set-CMFileReplicationRoute
    -DestinationSiteCode <String>
    -SourceSiteCode <String>
    [-AvailabilityLevel <AvailabilityLevel>]
    [-BeginHr <Int32>]
    [-ControlNetworkLoadSchedule]
    [-DaysOfWeek <DaysOfWeek[]>]
    [-EndHr <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetFileReplicationRouteByPulseMode 

Set-CMFileReplicationRoute
    -DestinationSiteCode <String>
    -SourceSiteCode <String>
    [-DataBlockSizeKB <Int32>]
    [-DelayBetweenDataBlockSec <Int32>]
    [-FileReplicationAccountName <String>]
    [-PulseMode]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetFileReplicationRouteByUnlimited 

Set-CMFileReplicationRoute
    -DestinationSiteCode <String>
    -SourceSiteCode <String>
    [-FileReplicationAccountName <String>]
    [-Unlimited]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetFileReplicationRouteByLimited 

Set-CMFileReplicationRoute
    -DestinationSiteCode <String>
    -SourceSiteCode <String>
    [-FileReplicationAccountName <String>]
    [-LimitAvailableBandwidthPercent <Int32>]
    [-Limited]
    [-LimitedBeginHr <Int32>]
    [-LimitedEndHr <Int32>]
    [-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" -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 XYZ:\> 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.

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

Parameter properties

Type:AvailabilityLevel
Default value:None
Accepted values:All, MediumHigh, High, Closed
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationRouteBySchedule
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BeginHr

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TimePeriodStart, BeginHour

Parameter sets

SetFileReplicationRouteBySchedule
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

-ControlNetworkLoadSchedule

Indicates that scheduled replication controls network load.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationRouteBySchedule
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DataBlockSizeKB

Specifies a data block size, in kilobytes.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationRouteByPulseMode
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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

Parameter properties

Type:

DaysOfWeek[]

Default value:None
Accepted values:Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationRouteBySchedule
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DelayBetweenDataBlockSec

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DelayBetweenDataBlocksSeconds, DelayBetweenDataBlocksSec

Parameter sets

SetFileReplicationRouteByPulseMode
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DestinationSiteCode

Specifies the destination site in the file replication route that you change by using a site code.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DesSiteCode, DestSiteCode, ServerFqdn

Parameter sets

(All)
Position:Named
Mandatory:True
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

-EndHr

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TimePeriodEnd, EndHour

Parameter sets

SetFileReplicationRouteBySchedule
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationAccount
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetFileReplicationRouteByPulseMode
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetFileReplicationRouteByUnlimited
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetFileReplicationRouteByLimited
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

-LimitAvailableBandwidthPercent

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:LimitAvailableBandwidthPercentage

Parameter sets

SetFileReplicationRouteByLimited
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Limited

Indicates that bandwidth for a file replication route is limited.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationRouteByLimited
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LimitedBeginHr

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:LimitedTimePeriodStart, LimitedBeginHour

Parameter sets

SetFileReplicationRouteByLimited
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LimitedEndHr

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:LimitedTimePeriodEnd, LimitedEndHour

Parameter sets

SetFileReplicationRouteByLimited
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationRouteByPulseMode
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceSiteCode

Specifies the source site in the file replication route that you change by using a site code.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SiteCode

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Unlimited

Indicates that bandwidth for a file replication route is unlimited.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetFileReplicationRouteByUnlimited
Position:Named
Mandatory:True
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.

Inputs

None