New-CMFileReplicationRoute
New-CMFileReplicationRoute
Creates a file replication route for Configuration Manager.
Syntax
Parameter Set: NewFileReplicationRoute
New-CMFileReplicationRoute -DestinationSiteCode <String> -SourceSiteCode <String> [-DestinationSiteServerName <String> ] [-FileReplicationAccountName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The New-CMFileReplicationRoute cmdlet creates a file replication route for Microsoft System Center 2012 Configuration Manager. System Center 2012 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
-DestinationSiteCode<String>
Specifies a destination site for data transfers by using a site code.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DestinationSiteServerName<String>
Specifies a destination site server for data transfers by using a site server name.
Aliases |
none |
Required? |
false |
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 |
-SourceSiteCode<String>
Specifies a source site for data transfers by using a site code.
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: Create a file replication route
This command creates a file replication route from the site named ImgData01 to the site named ImgData05 on the server named ImgDataServer01. System Center 2012 Configuration Manager uses the account named AdminRepl01 to manage data transfer over this route.
PS C:\> New-CMFileReplicationRoute -DestinationSiteCode "ImgData05" -SourceSiteCode "ImgData01" -DestinationSiteServerName "ImgDataServer01" -FileReplicationAccountName "AdminRepl01"