Set-DfsrConnectionSchedule
Set-DfsrConnectionSchedule
Changes the settings of a connection schedule between members of a replication group.
Syntax
Parameter Set: ScheduleNameParameterSet
Set-DfsrConnectionSchedule [[-GroupName] <String[]> ] [-SourceComputerName] <String> [-DestinationComputerName] <String> [[-UseUTC] <Boolean> ] [[-ScheduleType] <ConnectionScheduleType> {Always | Never | UseGroupSchedule} ] [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: CustomScheduleParameterSet
Set-DfsrConnectionSchedule [[-GroupName] <String[]> ] [-SourceComputerName] <String> [-DestinationComputerName] <String> [[-UseUTC] <Boolean> ] [-Day] <DayOfWeek[]> [-BandwidthDetail] <String> [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-DfsrConnectionSchedule cmdlet changes the schedule and bandwidth throttle of a connection between two members of a replication group.
DFS Replication connections are the logical partnerships between members in a replication group. The DFS Replication service uses the Remote Procedure Call (RPC) protocol to communicate between servers. By default, DFS Replication creates connections with the recommended schedule and bandwidth configuration: full bandwidth, and 24 hours a day, seven days a week availability.
Parameters
-BandwidthDetail<String>
Specifies a custom schedule value string.
The schedule value defines the settings for each 15-minute interval block with its bandwidth, with 4 blocks to a set, where each set represents 1 hour. There are 24 sets. The time starts at 00:00 and ends at 24:00. The valid settings on a 15-minute block are 0 (zero) through F, using hexadecimal. The following shows the mapping of the valid settings:
0 = No replication
1 = 16 kilobits per second (Kbps)
2 = 64 Kbps
3 = 128 Kbps
4 = 256 Kbps
5 = 512 Kbps.
6 = 1 megabit per second (Mbps)
7 = 2 Mbps
8 = 4 Mbps
9 = 8 Mbps
A = 16 Mbps
B = 32 Mbps
C = 64 Mbps
D = 128 Mbps
E = 256 Mbps
F = Full bandwidth replication
A complete value string must include all 24 sets with 4 blocks to a set, for a total of 96 hexadecimal characters. For example: ffffffffffff0000ffff0000ffff00004444000044440000444400004444000044440000ffff0000ffff0000ffffffff
Aliases |
none |
Required? |
true |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Day<DayOfWeek[]>
Specifies an array of days of the week. You can specify either an enumerated string value or its corresponding integer for this parameter. The acceptable values for this parameter are:
-- Sunday (0)
-- Monday (1)
-- Tuesday (2)
-- Wednesday (3)
-- Thursday (4)
-- Friday (5)
-- Saturday (6)
Aliases |
none |
Required? |
true |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DestinationComputerName<String>
Specifies the name of the receiving computer. A receiving computer is also called an inbound or downstream computer.
Aliases |
ReceivingMember,RMem |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DomainName<String>
Specifies the NetBIOS name or fully qualified domain name (FQDN) for the Active Directory Domain Service (AD DS) domain that contains the replication group. If you do not specify this parameter, the cmdlet uses the domain of the current user.
Aliases |
none |
Required? |
false |
Position? |
101 |
Default Value |
[Current Domain] |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GroupName<String[]>
Specifies an array of names of replication groups. You can use a comma separated list and the wildcard character (*).
Aliases |
RG,RgName |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-ScheduleType<ConnectionScheduleType>
Specifies the type of connection schedule. You can specify the inherited replication group schedule, a connection-based closed schedule that allows no replication, or a connection-based full schedule that enables replication for 24 hours a day, seven days a week using full bandwidth. You can specify either an enumerated string value or its corresponding integer for this parameter. The acceptable values for this parameter are:
-- UseGroupSchedule (0)
-- Never (1)
-- Always (2)
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
0 |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SourceComputerName<String>
Specifies the name of the sending computer. A sending computer is also called an outbound or upstream computer.
Aliases |
SendingMember,SMem |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UseUTC<Boolean>
Indicates whether the destination computer uses Coordinated Universal Time (UTC) for the schedule. By default, the destination computer interprets the schedule in its own local time.
Aliases |
none |
Required? |
false |
Position? |
4 |
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.
- Microsoft.DistributedFileSystemReplication.DfsReplicationGroup, string
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.DistributedFileSystemReplication.DfsrConnectionSchedule
Examples
Example 1: Configure a full connection schedule
This command configures the connection schedule from the server named SRV01 to the server named SRV02 in the RG24 replication group. The ScheduleType parameter specifies a full schedule that enables replication 24 hours a day, seven days a week that uses full bandwidth.
PS C:\> Set-DfsrConnectionSchedule -GroupName "RG24" -SourceComputerName "SRV01" -DestinationComputerName "SRV02" -ScheduleType Always
Example 2: Set a connection schedule
This command configures the connection schedule from the server named SRV01 to the server named SRV02 in the RG24 replication group. The command specifies that the DFS Replication service prevents all replication from 9 A.M. to 5 P.M. Monday through Friday, and allows replicating in all other intervals at full bandwidth.
PS C:\> Set-DfsrConnectionSchedule -GroupName "RG24" -SourceComputerName "SRV01" -DestinationComputerName "SRV01" -Day Monday,Tuesday,Wednesday,Thursday,Friday - BandwidthDetail "ffffffffffffffffffffffffffffffffffff00000000000000000000000000000000ffffffffffffffffffffffffffff"