Set-SRGroup
Modifies settings of a replication group.
Syntax
Set-SRGroup
[[-ComputerName] <String>]
[-Name] <String>
[-AddVolumeName] <String[]>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Set-SRGroup
[[-ComputerName] <String>]
[-Name] <String>
[-Force]
[-RemoveVolumeName] <String[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Set-SRGroup
[[-ComputerName] <String>]
[-Name] <String>
[-Force]
[[-LogSizeInBytes] <UInt64>]
[[-Description] <String>]
[[-ReplicationMode] <ReplicationMode>]
[[-Encryption] <Boolean>]
[[-Compression] <Boolean>]
[[-AllowVolumeResize] <Boolean>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
The Set-SRGroup cmdlet modifies settings of an existing replication group. A replication group
contains one or more data volumes and an associated log volume. A replication group is the
container for replication.
Examples
Example 1: Add a volume to a replication group
Set-SRGroup -Name "ReplicationGroup01" -AddVolumeName "F:"This command adds the F: volume to the existing replication group named ReplicationGroup01 on
the local computer.
Example 2: Remove a volume from a replication group
Set-SRGroup -Name "ReplicationGroup01" -RemoveVolumeName "F:"This command removes the F: volume from the existing replication group ReplicationGroup01 on the
local computer.
Example 3: Resize volumes in a replication group
Set-SRGroup -Name "ReplicationGroup01" -AllowVolumeResize $TrueThis command lets you resize volumes in the replication group named ReplicationGroup01 on the
local computer. By default, the Storage Replica driver prevents volume resizes in order to protect
from block mismatches. To grow a volume, enable the allow volume resize mode on both resource
groups, increase the size of the volume on both servers to be the same size, then disable this
mode.
Parameters
-AddVolumeName
Specifies an array of drive letters or mount point paths of partitions for the replica to add to the group. The volumes must exist. The volumes cannot be mapped drives or UNC paths.
This is an ordered list. The order of volumes determines the order of replication. For more
information, see the DestinationVolumeName parameter of the New-SRPartnership cmdlet.
| Type: | String[] |
| Aliases: | AV |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AllowVolumeResize
Indicates that the replication group enables resizing of volumes.
| Type: | Boolean |
| Aliases: | VR |
| Position: | 10 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Compression
Indicates that this Storage Replica group should use SMB compression for data transfer.
| Type: | Boolean |
| Aliases: | CMP |
| Position: | 10 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ComputerName
Specifies a single replica host computer NetBIOS name or fully qualified domain name (FQDN) of a computer. The default value is the local computer.
| Type: | String |
| Aliases: | CN |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specifies a description for the replication group.
| Type: | String |
| Aliases: | D |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encryption
Indicates this partnership should encrypt connections by using SMB AES-128-GCM. Enabling encryption can protect Storage Replica block transfers from man-in-the-middle interception or reading. Enabling encryption decreases performance.
| Type: | Boolean |
| Aliases: | ENC |
| Position: | 9 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Aliases: | F |
| Position: | 100 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogSizeInBytes
Specifies the aggregate size of log files on each server in the replication group for the volumes that are associated with this replication group. The minimum size 512MB. You can specify a value by using the Windows PowerShell byte conversion capability, such as 4GB or 3200MB.
A value that is too small may cause decreased replication performance or increased recovery time after an interruption between computers.
| Type: | UInt64 |
| Aliases: | LS |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the replication group to modify.
| Type: | String |
| Aliases: | N |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RemoveVolumeName
Specifies an array of drive letters or mount point paths of partitions for the replica to remove from the group. The volumes must exist. The volumes cannot be mapped drives or UNC paths.
This is an ordered list. The order of volumes determines the order of replication. For more
information, see the DestinationVolumeName parameter of the New-SRPartnership cmdlet.
If there is a partnership already configured, before you change this replication group, you must
remove the partnership by using the Set-SRPartnership cmdlet. Then you must remove the same
volumes from the previously partnered replication group.
| Type: | String[] |
| Aliases: | RVN |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ReplicationMode
Specifies the desired mode of replication for this source and destination pair. The acceptable values for this parameter are:
- Synchronous or 1. The synchronous mode requires all writes to commit on the destination server and commit on the source server, which guarantees data integrity between computers.
- Asynchronous or 2. The asynchronous mode writes to the source server without waiting for the source server, which allows for replication over high latency, geographic networks.
The default value is synchronous. The default asynchronous recovery point alert time is 5 minutes.
You can modify it by using the Set-SRPartnership cmdlet. The alert time has no effect on
replication behavior, only on reporting.
| Type: | ReplicationMode |
| Aliases: | RM |
| Accepted values: | Synchronous, Asynchronous |
| Position: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.PowerShell.Cmdletization.GeneratedTypes.SREnum.ReplicationMode