Set-DfsrGroupSchedule
Set-DfsrGroupSchedule
Modifies a replication group schedule.
Syntax
Parameter Set: ScheduleNameParameterSet
Set-DfsrGroupSchedule [-GroupName] <String[]> [[-UseUTC] <Boolean> ] [[-ScheduleType] <GroupScheduleType> {Always | Never} ] [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: CustomScheduleParameterSet
Set-DfsrGroupSchedule [-GroupName] <String[]> [[-UseUTC] <Boolean> ] [-Day] <DayOfWeek[]> [-BandwidthDetail] <String> [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-DfsrGroupSchedule cmdlet modifies a schedule for a replication group. DFS Replication schedules control the availability and bandwidth usage of replication.
By default, DFS Replication schedules replication 24 hours a day, 7 days a week with full bandwidth as the recommended configuration.
Parameters
-BandwidthDetail<String>
Specifies a custom schedule value string that defines the bandwidth settings for each 15-minute interval block, with 4 blocks to a set, where each set represents 1 hour, and 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 through F, with the following mapping of 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.
You must specify a complete value string and include all 24 hourly 4-block sets (for a total of 96 hexadecimal characters). For example: ffffffffffff0000ffff0000ffff00004444000044440000444400004444000044440000ffff0000ffff0000ffffffff
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Day<DayOfWeek[]>
Specifies a day of the week. You can specify either an enumerated string value or its corresponding integer value. 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? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DomainName<String>
Specifies a NetBIOS or fully qualified domain name (FQDN) for an Active Directory domain that contains the replication group. If you do not specify this parameter, the cmdlet uses the current domain.
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 . If you do not specify this parameter, the cmdlet queries for all participating replication groups. You can specify multiple groups, separated by commas, as well as wildcard characters (*).
Aliases |
RG,RgName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-ScheduleType<GroupScheduleType>
Specifies a schedule type with no replication allowed or a full schedule that enables replication for 24 hours a day, 7 days a week using full bandwidth. Acceptable values are Never (0) and Always (1). You can specify either an enumerated string value or its corresponding integer value for this parameter.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UseUTC<Boolean>
Indicates whether the destination computer uses Coordinated Universal Time (UTC) for its schedule. By default, the destination computer interprets the schedule according to its local time.
Aliases |
none |
Required? |
false |
Position? |
2 |
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
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.DistributedFileSystemReplicationDfsrgroupSchedule
Examples
Example 1: Modify a group schedule
This command uses the Set-DfsrGroupSchedule cmdlet to modify the RG01 replication group to allow full replication 24 hours a day, 7 days a week. The command also uses the ScheduleType parameter so there is no need to specify any specific bandwidth blocks or days.
PS C:\> Set-DfsrGroupSchedule -GroupName "RG01" -ScheduleType Always
Example 2: Modify a group schedule to prevent replication
This command uses the Set-DfsrGroupSchedule cmdlet to modify the RG01 replication group schedule to prevent all replication from 9AM to 5PM Monday through Friday, with all other intervals replicating at full bandwidth.
PS C:\> Set-DfsrGroupSchedule -GroupName "RG01" -Day Monday,Tuesday,Wednesday,Thursday,Friday -BandwidthDetail ffffffffffffffffffffffffffffffffffff00000000000000000000000000000000ffffffffffffffffffffffffffff