Skip to content

Commit 501faec

Browse files
authored
Merge pull request MicrosoftDocs#3794 from Xelu86/SRCmdlets_Update
Update cmdlets & note for Compression/EnableCompression parameters for WS22
2 parents da96ad6 + fe27097 commit 501faec

File tree

4 files changed

+129
-140
lines changed

4 files changed

+129
-140
lines changed

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

+21-19
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ The `New-SRGroup` cmdlet creates a replication group. A replication group contai
2828
data volumes and an associated log volume. A replication group is the container for replication.
2929

3030
> [!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
31+
> The **EnableCompression** parameter is only available in
32+
> [Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/)
33+
> or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative
34+
> Update for Microsoft server operating system version 21H2 for x64-based Systems
3535
> ([KB5017381](https://support.microsoft.com/help/5017381)).
3636
3737
## EXAMPLES
@@ -42,7 +42,7 @@ data volumes and an associated log volume. A replication group is the container
4242
New-SRGroup -ComputerName "SR-SRV05" -Name "ReplicationGroup01" -VolumeName "D:" -LogVolumeName "E:"
4343
```
4444

45-
This command creates a replication group for server named SR-SRV05. The command specifies the
45+
This command creates a replication group for server named `SR-SRV05`. The command specifies the
4646
replicated volume and the log volume. Because this command does not specify other parameters, the
4747
replication group uses default values. Replication will not start until you run the
4848
`New-SRPartnership` cmdlet.
@@ -61,7 +61,7 @@ $Parameters = @{
6161
New-SRGroup @Parameters
6262
```
6363

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

@@ -90,8 +90,8 @@ Accept wildcard characters: False
9090
### -CimSession
9191
9292
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
93+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
94+
or [Get-CimSession](/powershell/module/cimcmdlets/get-ciminstance) cmdlet. The default is the
9595
current session on the local computer.
9696
9797
```yaml
@@ -141,12 +141,14 @@ Accept wildcard characters: False
141141
142142
### -EnableCompression
143143
144-
Indicates that this Storage Replica group should use SMB compression for data transfer. This
145-
parameter only applies to
144+
Indicates that this Storage Replica group should use SMB compression for data transfer.
145+
146+
This parameter only applies to
146147
[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
148+
or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative Update
149+
for Microsoft server operating system version 21H2 for x64-based Systems
149150
([KB5017381](https://support.microsoft.com/help/5017381)).
151+
150152
```yaml
151153
Type: SwitchParameter
152154
Parameter Sets: (All)
@@ -318,7 +320,7 @@ Accept wildcard characters: False
318320
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
319321
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
320322
-WarningAction, and -WarningVariable. For more information, see
321-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
323+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
322324

323325
## INPUTS
324326

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

331333
## RELATED LINKS
332334

333-
[Get-SRGroup](./Get-SRGroup.md)
335+
[Get-SRGroup](Get-SRGroup.md)
334336

335-
[New-SRPartnership](./New-SRPartnership.md)
337+
[New-SRPartnership](New-SRPartnership.md)
336338

337-
[Remove-SRGroup](./Remove-SRGroup.md)
339+
[Remove-SRGroup](Remove-SRGroup.md)
338340

339-
[Set-SRGroup](./Set-SRGroup.md)
341+
[Set-SRGroup](Set-SRGroup.md)
340342

341-
[Suspend-SRGroup](./Suspend-SRGroup.md)
343+
[Suspend-SRGroup](Suspend-SRGroup.md)
342344

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

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

+30-31
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

@@ -44,10 +45,10 @@ replication groups. This cmdlet can create the complete replication topology. It
4445
together separately created replication groups.
4546

4647
> [!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
48+
> The **EnableCompression** parameter is only available in
49+
> [Azure Stack HCI version 22H2](https://azure.microsoft.com/updates/public-preview-azure-stack-hci-version-22h2/)
50+
> or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative
51+
> Update for Microsoft server operating system version 21H2 for x64-based Systems
5152
> ([KB5017381](https://support.microsoft.com/help/5017381)).
5253
5354
## EXAMPLES
@@ -68,12 +69,12 @@ $Parameters = @{
6869
New-SRPartnership @Parameters
6970
```
7071

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.
72+
This command creates a replication topology between servers `SR-SRV05` and `SR-SRV06`. The
73+
`SR-SRV05` server is the source and `SR-SRV06` is the destination, with volume `D:` used as both
74+
the source and destination. The `E:` volume contains the logs for this partnership. The log has the
75+
default value of 8GB. As the replication mode has not been specified, it will use the default value
76+
of synchronous. The command does not specify seeding, encryption, and consistency groups.
77+
Replication will start immediately.
7778

7879
This example uses splatting to pass parameter values from the `$Parameters` variable to the command.
7980
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
@@ -95,9 +96,6 @@ New-SRPartnership @Parameters"
9596
This example creates two replication groups separately and then creates a partnership between those
9697
groups.
9798

98-
The example uses splatting to pass parameter values from the `$Parameters` variable to the command.
99-
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
100-
10199
## PARAMETERS
102100

103101
### -AsJob
@@ -142,8 +140,8 @@ Accept wildcard characters: False
142140
### -CimSession
143141
144142
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
143+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
144+
or [Get-CimSession](/powershell/module/cimcmdlets/get-ciminstance) cmdlet. The default is the
147145
current session on the local computer.
148146
149147
```yaml
@@ -235,12 +233,12 @@ specify drive letters.
235233
236234
This is an ordered list. The order of volumes determines the order of replication.
237235
238-
For instance, to replicate the F: and H: drives on one server to the F: and H: drives of another
236+
For instance, to replicate the `F:` and `H:` drives on one server to the `F:` and `H:` drives of another
239237
server, specify the following values:
240238

241239
`-SourceVolumeName "F:","H:" -DestinationVolumeName "F:","H:"`
242240

243-
To replicate F: to H: instead, specify the following values:
241+
To replicate `F:` to `H:` instead, specify the following values:
244242

245243
`-SourceVolumeName "F:","H:" -DestinationVolumeName "H:","F:"`
246244

@@ -262,10 +260,11 @@ Accept wildcard characters: False
262260
### -EnableCompression
263261

264262
Indicates that the connections in this partnership should use SMB compression for data transfer.
263+
265264
This parameter only applies to
266265
[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
266+
or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative Update
267+
for Microsoft server operating system version 21H2 for x64-based Systems
269268
([KB5017381](https://support.microsoft.com/help/5017381)).
270269

271270
```yaml
@@ -541,7 +540,7 @@ Accept wildcard characters: False
541540
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
542541
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
543542
-WarningAction, and -WarningVariable. For more information, see
544-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
543+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
545544

546545
## INPUTS
547546

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

554553
## RELATED LINKS
555554

556-
[Get-SRPartnership](./Get-SRPartnership.md)
555+
[Get-SRPartnership](Get-SRPartnership.md)
557556

558-
[New-SRGroup](./New-SRGroup.md)
557+
[New-SRGroup](New-SRGroup.md)
559558

560-
[Remove-SRPartnership](./Remove-SRPartnership.md)
559+
[Remove-SRPartnership](Remove-SRPartnership.md)
561560

562-
[Set-SRPartnership](./Set-SRPartnership.md)
561+
[Set-SRPartnership](Set-SRPartnership.md)
563562

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

0 commit comments

Comments
 (0)