Skip to content

Commit e607be5

Browse files
authored
Merge pull request MicrosoftDocs#3795 from Xelu86/Update_SRcmdlets
Update cmdlets & remove note for Compression parameter for WS25
2 parents 501faec + 94b3db4 commit e607be5

File tree

4 files changed

+113
-170
lines changed

4 files changed

+113
-170
lines changed

docset/winserver2025-ps/storagereplica/New-SRGroup.md

+15-25
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,6 @@ New-SRGroup [[-ComputerName] <String>] [-Name] <String> [-VolumeName] <String[]>
2727
The `New-SRGroup` cmdlet creates a replication group. A replication group contains one or more
2828
data volumes and an associated log volume. A replication group is the container for replication.
2929

30-
> [!NOTE]
31-
> The **Compression** parameter is only available in
32-
> [Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/) or later,
33-
> and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative Update for Microsoft
34-
> server operating system version 21H2 for x64-based Systems
35-
> ([KB5017381](https://support.microsoft.com/help/5017381)).
36-
3730
## EXAMPLES
3831

3932
### Example 1: Create a replication group
@@ -42,7 +35,7 @@ data volumes and an associated log volume. A replication group is the container
4235
New-SRGroup -ComputerName "SR-SRV05" -Name "ReplicationGroup01" -VolumeName "D:" -LogVolumeName "E:"
4336
```
4437

45-
This command creates a replication group for server named SR-SRV05. The command specifies the
38+
This command creates a replication group for server named `SR-SRV05`. The command specifies the
4639
replicated volume and the log volume. Because this command does not specify other parameters, the
4740
replication group uses default values. Replication will not start until you run the
4841
`New-SRPartnership` cmdlet.
@@ -61,7 +54,7 @@ $Parameters = @{
6154
New-SRGroup @Parameters
6255
```
6356

64-
This command creates a replication group for server named SR-SRV05. The command specifies the
57+
This command creates a replication group for server named `SR-SRV05`. The command specifies the
6558
replicated volume and the log volume. The command also specifies a custom log size in GB and enables
6659
replication traffic encryption. Replication will not start until you run `New-SRPartnership`.
6760

@@ -90,9 +83,9 @@ Accept wildcard characters: False
9083
### -CimSession
9184
9285
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
93-
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
94-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
95-
current session on the local computer.
86+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
87+
[Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the current
88+
session on the local computer.
9689
9790
```yaml
9891
Type: CimSession[]
@@ -141,12 +134,9 @@ Accept wildcard characters: False
141134
142135
### -EnableCompression
143136
144-
Indicates that this Storage Replica group should use SMB compression for data transfer. This
145-
parameter only applies to
146-
[Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/)
147-
or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative
148-
Update for Microsoft server operating system version 21H2 for x64-based Systems
149-
([KB5017381](https://support.microsoft.com/help/5017381)).
137+
Indicates that this Storage Replica group should use SMB compression for data transfer. SMB
138+
compression is only used with TCP, and isn't supported on both SMB Direct and RDMA networks.
139+
150140
```yaml
151141
Type: SwitchParameter
152142
Parameter Sets: (All)
@@ -318,7 +308,7 @@ Accept wildcard characters: False
318308
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
319309
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
320310
-WarningAction, and -WarningVariable. For more information, see
321-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
311+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
322312

323313
## INPUTS
324314

@@ -330,14 +320,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
330320

331321
## RELATED LINKS
332322

333-
[Get-SRGroup](./Get-SRGroup.md)
323+
[Get-SRGroup](Get-SRGroup.md)
334324

335-
[New-SRPartnership](./New-SRPartnership.md)
325+
[New-SRPartnership](New-SRPartnership.md)
336326

337-
[Remove-SRGroup](./Remove-SRGroup.md)
327+
[Remove-SRGroup](Remove-SRGroup.md)
338328

339-
[Set-SRGroup](./Set-SRGroup.md)
329+
[Set-SRGroup](Set-SRGroup.md)
340330

341-
[Suspend-SRGroup](./Suspend-SRGroup.md)
331+
[Suspend-SRGroup](Suspend-SRGroup.md)
342332

343-
[Sync-SRGroup](./Sync-SRGroup.md)
333+
[Sync-SRGroup](Sync-SRGroup.md)

docset/winserver2025-ps/storagereplica/New-SRPartnership.md

+24-35
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,13 @@ New-SRPartnership [[-SourceComputerName] <String>] [-SourceRGName] <String>
2828
### CreateTopology
2929

3030
```
31-
New-SRPartnership [[-SourceComputerName] <String>] [-SourceRGName] <String> [-SourceVolumeName]
32-
<String[]> [-SourceLogVolumeName] <String> [[-SourceRGDescription] <String>]
33-
[-DestinationComputerName] <String> [-DestinationRGName] <String> [-DestinationVolumeName]
34-
<String[]> [-DestinationLogVolumeName] <String> [[-DestinationRGDescription] <String>]
35-
[[-ReplicationMode] <ReplicationMode>] [[-LogSizeInBytes] <UInt64>] [-PreventReplication] [-Seeded]
36-
[-EnableConsistencyGroups] [[-AsyncRPO] <UInt32>] [-EnableEncryption] [-EnableCompression] [-Force]
31+
New-SRPartnership [[-SourceComputerName] <String>] [-SourceRGName] <String>
32+
[-SourceVolumeName] <String[]> [-SourceLogVolumeName] <String> [[-SourceRGDescription] <String>]
33+
[-DestinationComputerName] <String> [-DestinationRGName] <String>
34+
[-DestinationVolumeName] <String[]> [-DestinationLogVolumeName] <String>
35+
[[-DestinationRGDescription] <String>] [[-ReplicationMode] <ReplicationMode>]
36+
[[-LogSizeInBytes] <UInt64>] [-PreventReplication] [-Seeded] [-EnableConsistencyGroups]
37+
[[-AsyncRPO] <UInt32>] [-EnableEncryption] [-EnableCompression] [-Force]
3738
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
3839
```
3940

@@ -43,13 +44,6 @@ The `New-SRPartnership` cmdlet creates a replication partnership between two new
4344
replication groups. This cmdlet can create the complete replication topology. It can also tie
4445
together separately created replication groups.
4546

46-
> [!NOTE]
47-
> The **Compression** parameter is only available in
48-
> [Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/) or later,
49-
> and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative Update for Microsoft
50-
> server operating system version 21H2 for x64-based Systems
51-
> ([KB5017381](https://support.microsoft.com/help/5017381)).
52-
5347
## EXAMPLES
5448

5549
### Example 1: Create a topology between two servers
@@ -68,12 +62,12 @@ $Parameters = @{
6862
New-SRPartnership @Parameters
6963
```
7064

71-
This command creates a replication topology between servers SR-SRV05 and SR-SRV06. The SR-SRV05
72-
server is the source and SR-SRV06 is the destination, with volume D: used as both the source and
73-
destination. The E: volume contains the logs for this partnership. The log has the default value of
74-
8GB. As the replication mode has not been specified, it will use the default value of synchronous.
75-
The command does not specify seeding, encryption, and consistency groups. Replication will start
76-
immediately.
65+
This command creates a replication topology between servers `SR-SRV05` and `SR-SRV06`. The
66+
`SR-SRV05` server is the source and `SR-SRV06` is the destination, with volume `D:` used as both the
67+
source and destination. The `E:` volume contains the logs for this partnership. The log has the
68+
default value of 8GB. As the replication mode has not been specified, it will use the default value
69+
of synchronous. The command does not specify seeding, encryption, and consistency groups.
70+
Replication will start immediately.
7771

7872
This example uses splatting to pass parameter values from the `$Parameters` variable to the command.
7973
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
@@ -142,9 +136,9 @@ Accept wildcard characters: False
142136
### -CimSession
143137
144138
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
145-
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
146-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
147-
current session on the local computer.
139+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
140+
[Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the current
141+
session on the local computer.
148142
149143
```yaml
150144
Type: CimSession[]
@@ -244,8 +238,8 @@ server, specify the following values:
244238

245239
`-SourceVolumeName "F:","H:" -DestinationVolumeName "H:","F:"`
246240

247-
We do not recommend replicating different drive letters or mount point paths.
248-
The practice can cause application failures because of stored settings after a failover occurs.
241+
We do not recommend replicating different drive letters or mount point paths. This practice can
242+
cause application failures because of stored settings after a failover occurs.
249243

250244
```yaml
251245
Type: String[]
@@ -262,11 +256,6 @@ Accept wildcard characters: False
262256
### -EnableCompression
263257

264258
Indicates that the connections in this partnership should use SMB compression for data transfer.
265-
This parameter only applies to
266-
[Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/)
267-
or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative
268-
Update for Microsoft server operating system version 21H2 for x64-based Systems
269-
([KB5017381](https://support.microsoft.com/help/5017381)).
270259

271260
```yaml
272261
Type: SwitchParameter
@@ -541,7 +530,7 @@ Accept wildcard characters: False
541530
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
542531
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
543532
-WarningAction, and -WarningVariable. For more information, see
544-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
533+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
545534

546535
## INPUTS
547536

@@ -553,12 +542,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
553542

554543
## RELATED LINKS
555544

556-
[Get-SRPartnership](./Get-SRPartnership.md)
545+
[Get-SRPartnership](Get-SRPartnership.md)
557546

558-
[New-SRGroup](./New-SRGroup.md)
547+
[New-SRGroup](New-SRGroup.md)
559548

560-
[Remove-SRPartnership](./Remove-SRPartnership.md)
549+
[Remove-SRPartnership](Remove-SRPartnership.md)
561550

562-
[Set-SRPartnership](./Set-SRPartnership.md)
551+
[Set-SRPartnership](Set-SRPartnership.md)
563552

564-
[Sync-SRGroup](./Sync-SRGroup.md)
553+
[Sync-SRGroup](Sync-SRGroup.md)

docset/winserver2025-ps/storagereplica/Set-SRGroup.md

+41-55
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,9 @@ Set-SRGroup [[-ComputerName] <String>] [-Name] <String> [-Force] [[-LogSizeInByt
4242

4343
## DESCRIPTION
4444

45-
The `Set-SRGroup` cmdlet modifies settings of an existing replication group.
46-
A replication group contains one or more data volumes and an associated log volume.
47-
A replication group is the container for replication.
48-
49-
> [!NOTE]
50-
> The **Compression** parameter is only available in
51-
> [Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/) or later,
52-
> and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative Update for Microsoft
53-
> server operating system version 21H2 for x64-based Systems
54-
> ([KB5017381](https://support.microsoft.com/help/5017381)).
45+
The `Set-SRGroup` cmdlet modifies settings of an existing replication group. A replication group
46+
contains one or more data volumes and an associated log volume. A replication group is the
47+
container for replication.
5548

5649
## EXAMPLES
5750

@@ -61,16 +54,16 @@ A replication group is the container for replication.
6154
Set-SRGroup -Name "ReplicationGroup01" -AddVolumeName "F:"
6255
```
6356

64-
This command adds the F: volume to the existing replication group named ReplicationGroup01 on the
65-
local computer.
57+
This command adds the `F:` volume to the existing replication group named `ReplicationGroup01` on
58+
the local computer.
6659

6760
### Example 2: Remove a volume from a replication group
6861

6962
```powershell
7063
Set-SRGroup -Name "ReplicationGroup01" -RemoveVolumeName "F:"
7164
```
7265

73-
This command removes the F: volume from the existing replication group ReplicationGroup01 on the
66+
This command removes the `F:` volume from the existing replication group `ReplicationGroup01` on the
7467
local computer.
7568

7669
### Example 3: Resize volumes in a replication group
@@ -79,10 +72,11 @@ local computer.
7972
Set-SRGroup -Name "ReplicationGroup01" -AllowVolumeResize $True
8073
```
8174

82-
This command lets you resize volumes in the replication group named ReplicationGroup01 on the local
83-
computer. By default, the Storage Replica driver prevents volume resizes in order to protect from
84-
block mismatches. To grow a volume, enable the allow volume resize mode on both resource groups,
85-
increase the size of the volume on both servers to be the same size, then disable this mode.
75+
This command lets you resize volumes in the replication group named `ReplicationGroup01` on the
76+
local computer. By default, the Storage Replica driver prevents volume resizes in order to protect
77+
from block mismatches. To grow a volume, enable the allow volume resize mode on both resource
78+
groups, increase the size of the volume on both servers to be the same size, then disable this
79+
mode.
8680

8781
## PARAMETERS
8882

@@ -142,9 +136,9 @@ Accept wildcard characters: False
142136
### -CimSession
143137
144138
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
145-
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
146-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
147-
current session on the local computer.
139+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
140+
[Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the current
141+
session on the local computer.
148142
149143
```yaml
150144
Type: CimSession[]
@@ -160,12 +154,7 @@ Accept wildcard characters: False
160154
161155
### -Compression
162156
163-
Indicates that this Storage Replica group should use SMB compression for data transfer. This
164-
parameter only applies to
165-
[Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/)
166-
or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative
167-
Update for Microsoft server operating system version 21H2 for x64-based Systems
168-
([KB5017381](https://support.microsoft.com/help/5017381)).
157+
Indicates that this Storage Replica group should use SMB compression for data transfer.
169158
170159
```yaml
171160
Type: Boolean
@@ -196,22 +185,6 @@ Accept pipeline input: True (ByPropertyName)
196185
Accept wildcard characters: False
197186
```
198187
199-
### -Confirm
200-
201-
Prompts you for confirmation before running the cmdlet.
202-
203-
```yaml
204-
Type: SwitchParameter
205-
Parameter Sets: (All)
206-
Aliases: cf
207-
208-
Required: False
209-
Position: Named
210-
Default value: False
211-
Accept pipeline input: False
212-
Accept wildcard characters: False
213-
```
214-
215188
### -Description
216189
217190
Specifies a description for the replication group.
@@ -334,8 +307,8 @@ values for this parameter are:
334307
source server, which allows for replication over high latency, geographic networks.
335308

336309
The default value is synchronous. The default asynchronous recovery point alert time is 5 minutes.
337-
You can modify it by using the `Set-SRPartnership` cmdlet. The alert time has no effect on replication
338-
behavior, only on reporting.
310+
You can modify it by using the `Set-SRPartnership` cmdlet. The alert time has no effect on
311+
replication behavior, only on reporting.
339312

340313
```yaml
341314
Type: ReplicationMode
@@ -370,10 +343,25 @@ Accept pipeline input: False
370343
Accept wildcard characters: False
371344
```
372345

346+
### -Confirm
347+
348+
Prompts you for confirmation before running the cmdlet.
349+
350+
```yaml
351+
Type: SwitchParameter
352+
Parameter Sets: (All)
353+
Aliases: cf
354+
355+
Required: False
356+
Position: Named
357+
Default value: False
358+
Accept pipeline input: False
359+
Accept wildcard characters: False
360+
```
361+
373362
### -WhatIf
374363

375-
Shows what would happen if the cmdlet runs.
376-
The cmdlet is not run.
364+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
377365

378366
```yaml
379367
Type: SwitchParameter
@@ -392,14 +380,12 @@ Accept wildcard characters: False
392380
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
393381
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
394382
-WarningAction, and -WarningVariable. For more information, see
395-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
383+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
396384

397385
## INPUTS
398386

399387
### System.String
400388

401-
### System.String[]
402-
403389
### System.UInt64
404390

405391
### Microsoft.PowerShell.Cmdletization.GeneratedTypes.SREnum.ReplicationMode
@@ -414,14 +400,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
414400

415401
## RELATED LINKS
416402

417-
[Get-SRGroup](./Get-SRGroup.md)
403+
[Get-SRGroup](Get-SRGroup.md)
418404

419-
[New-SRGroup](./New-SRGroup.md)
405+
[New-SRGroup](New-SRGroup.md)
420406

421-
[Remove-SRGroup](./Remove-SRGroup.md)
407+
[Remove-SRGroup](Remove-SRGroup.md)
422408

423-
[Set-SRPartnership](./Set-SRPartnership.md)
409+
[Set-SRPartnership](Set-SRPartnership.md)
424410

425-
[Suspend-SRGroup](./Suspend-SRGroup.md)
411+
[Suspend-SRGroup](Suspend-SRGroup.md)
426412

427-
[Sync-SRGroup](./Sync-SRGroup.md)
413+
[Sync-SRGroup](Sync-SRGroup.md)

0 commit comments

Comments
 (0)