Skip to content

Commit 2c7feac

Browse files
committed
Updated cmdlets, removed Compression param note where applicable
1 parent da96ad6 commit 2c7feac

File tree

4 files changed

+113
-150
lines changed

4 files changed

+113
-150
lines changed

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

Lines changed: 13 additions & 24 deletions
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,8 +83,8 @@ 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
86+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
87+
or [Get-CimSession](/powershell/module/cimcmdlets/get-ciminstance) cmdlet. The default is the
9588
current session on the local computer.
9689
9790
```yaml
@@ -141,12 +134,8 @@ 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.
138+
150139
```yaml
151140
Type: SwitchParameter
152141
Parameter Sets: (All)
@@ -318,7 +307,7 @@ Accept wildcard characters: False
318307
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
319308
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
320309
-WarningAction, and -WarningVariable. For more information, see
321-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
310+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
322311

323312
## INPUTS
324313

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

331320
## RELATED LINKS
332321

333-
[Get-SRGroup](./Get-SRGroup.md)
322+
[Get-SRGroup](Get-SRGroup.md)
334323

335-
[New-SRPartnership](./New-SRPartnership.md)
324+
[New-SRPartnership](New-SRPartnership.md)
336325

337-
[Remove-SRGroup](./Remove-SRGroup.md)
326+
[Remove-SRGroup](Remove-SRGroup.md)
338327

339-
[Set-SRGroup](./Set-SRGroup.md)
328+
[Set-SRGroup](Set-SRGroup.md)
340329

341-
[Suspend-SRGroup](./Suspend-SRGroup.md)
330+
[Suspend-SRGroup](Suspend-SRGroup.md)
342331

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

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

Lines changed: 22 additions & 36 deletions
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
67+
the 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).
@@ -95,9 +89,6 @@ New-SRPartnership @Parameters"
9589
This example creates two replication groups separately and then creates a partnership between those
9690
groups.
9791

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-
10192
## PARAMETERS
10293

10394
### -AsJob
@@ -142,8 +133,8 @@ Accept wildcard characters: False
142133
### -CimSession
143134
144135
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
136+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
137+
or [Get-CimSession](/powershell/module/cimcmdlets/get-ciminstance) cmdlet. The default is the
147138
current session on the local computer.
148139
149140
```yaml
@@ -240,7 +231,7 @@ server, specify the following values:
240231
241232
`-SourceVolumeName "F:","H:" -DestinationVolumeName "F:","H:"`
242233

243-
To replicate F: to H: instead, specify the following values:
234+
To replicate F: to H: instead, specify the following values:
244235

245236
`-SourceVolumeName "F:","H:" -DestinationVolumeName "H:","F:"`
246237

@@ -262,11 +253,6 @@ Accept wildcard characters: False
262253
### -EnableCompression
263254

264255
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)).
270256

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

546532
## INPUTS
547533

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

554540
## RELATED LINKS
555541

556-
[Get-SRPartnership](./Get-SRPartnership.md)
542+
[Get-SRPartnership](Get-SRPartnership.md)
557543

558-
[New-SRGroup](./New-SRGroup.md)
544+
[New-SRGroup](New-SRGroup.md)
559545

560-
[Remove-SRPartnership](./Remove-SRPartnership.md)
546+
[Remove-SRPartnership](Remove-SRPartnership.md)
561547

562-
[Set-SRPartnership](./Set-SRPartnership.md)
548+
[Set-SRPartnership](Set-SRPartnership.md)
563549

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

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

Lines changed: 45 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +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.
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.
4848

4949
> [!NOTE]
5050
> The **Compression** parameter is only available in
@@ -61,28 +61,29 @@ A replication group is the container for replication.
6161
Set-SRGroup -Name "ReplicationGroup01" -AddVolumeName "F:"
6262
```
6363

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

6767
### Example 2: Remove a volume from a replication group
6868

6969
```powershell
7070
Set-SRGroup -Name "ReplicationGroup01" -RemoveVolumeName "F:"
7171
```
7272

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

7676
### Example 3: Resize volumes in a replication group
7777

7878
```powershell
7979
Set-SRGroup -Name "ReplicationGroup01" -AllowVolumeResize $True
8080
```
8181

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.
82+
This command lets you resize volumes in the replication group named `ReplicationGroup01` on the
83+
local computer. By default, the Storage Replica driver prevents volume resizes in order to protect
84+
from block mismatches. To grow a volume, enable the allow volume resize mode on both resource
85+
groups, increase the size of the volume on both servers to be the same size, then disable this
86+
mode.
8687

8788
## PARAMETERS
8889

@@ -142,8 +143,8 @@ Accept wildcard characters: False
142143
### -CimSession
143144
144145
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
146+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
147+
or [Get-CimSession](/powershell/module/cimcmdlets/get-ciminstance) cmdlet. The default is the
147148
current session on the local computer.
148149
149150
```yaml
@@ -160,11 +161,12 @@ Accept wildcard characters: False
160161
161162
### -Compression
162163
163-
Indicates that this Storage Replica group should use SMB compression for data transfer. This
164-
parameter only applies to
164+
Indicates that this Storage Replica group should use SMB compression for data transfer.
165+
166+
This parameter only applies to
165167
[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+
or later, and Windows Server Datacenter: Azure Edition beginning with the 2022-09 Cumulative Update
169+
for Microsoft server operating system version 21H2 for x64-based Systems
168170
([KB5017381](https://support.microsoft.com/help/5017381)).
169171
170172
```yaml
@@ -196,22 +198,6 @@ Accept pipeline input: True (ByPropertyName)
196198
Accept wildcard characters: False
197199
```
198200
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-
215201
### -Description
216202
217203
Specifies a description for the replication group.
@@ -334,8 +320,8 @@ values for this parameter are:
334320
source server, which allows for replication over high latency, geographic networks.
335321

336322
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.
323+
You can modify it by using the `Set-SRPartnership` cmdlet. The alert time has no effect on
324+
replication behavior, only on reporting.
339325

340326
```yaml
341327
Type: ReplicationMode
@@ -370,10 +356,25 @@ Accept pipeline input: False
370356
Accept wildcard characters: False
371357
```
372358

359+
### -Confirm
360+
361+
Prompts you for confirmation before running the cmdlet.
362+
363+
```yaml
364+
Type: SwitchParameter
365+
Parameter Sets: (All)
366+
Aliases: cf
367+
368+
Required: False
369+
Position: Named
370+
Default value: False
371+
Accept pipeline input: False
372+
Accept wildcard characters: False
373+
```
374+
373375
### -WhatIf
374376

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

378379
```yaml
379380
Type: SwitchParameter
@@ -392,14 +393,12 @@ Accept wildcard characters: False
392393
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
393394
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
394395
-WarningAction, and -WarningVariable. For more information, see
395-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
396+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
396397

397398
## INPUTS
398399

399400
### System.String
400401

401-
### System.String[]
402-
403402
### System.UInt64
404403

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

415414
## RELATED LINKS
416415

417-
[Get-SRGroup](./Get-SRGroup.md)
416+
[Get-SRGroup](Get-SRGroup.md)
418417

419-
[New-SRGroup](./New-SRGroup.md)
418+
[New-SRGroup](New-SRGroup.md)
420419

421-
[Remove-SRGroup](./Remove-SRGroup.md)
420+
[Remove-SRGroup](Remove-SRGroup.md)
422421

423-
[Set-SRPartnership](./Set-SRPartnership.md)
422+
[Set-SRPartnership](Set-SRPartnership.md)
424423

425-
[Suspend-SRGroup](./Suspend-SRGroup.md)
424+
[Suspend-SRGroup](Suspend-SRGroup.md)
426425

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

0 commit comments

Comments
 (0)