Skip to content

Commit d105a1d

Browse files
committed
Additional Storage Replica parameters
1 parent ec9af8d commit d105a1d

File tree

4 files changed

+119
-11
lines changed

4 files changed

+119
-11
lines changed

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

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,23 @@ Creates a replication group.
1717

1818
```
1919
New-SRGroup [[-ComputerName] <String>] [-Name] <String> [-VolumeName] <String[]> [-LogVolumeName] <String>
20-
[[-LogSizeInBytes] <UInt64>] [[-Description] <String>] [-EnableConsistencyGroups] [-EnableEncryption] [-Force]
21-
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
20+
[[-LogSizeInBytes] <UInt64>] [[-Description] <String>] [-EnableConsistencyGroups] [-EnableEncryption]
21+
[-EnableCompression] [-Force] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
22+
[<CommonParameters>]
2223
```
2324

2425
## DESCRIPTION
2526
The **New-SRGroup** cmdlet creates a replication group.
2627
A replication group contains one or more data volumes and an associated log volume.
2728
A replication group is the container for replication.
2829

30+
> [!NOTE]
31+
> The **EnableCompression** parameter is currently in PREVIEW beginning with TODO: 2022-08
32+
> Cumulative Update for Microsoft server operating system version 21H2 for x64-based Systems
33+
> ([KB5016693](https://support.microsoft.com/help/5016693)). Some information relates to prerelease
34+
> product that may be substantially modified before it's released. Microsoft makes no warranties,
35+
> express or implied, with respect to the information provided here.
36+
2937
## EXAMPLES
3038

3139
### Example 1: Create a replication group
@@ -159,6 +167,21 @@ Accept pipeline input: False
159167
Accept wildcard characters: False
160168
```
161169
170+
### -EnableCompression
171+
Indicates that the connections on this partnership should use compression.
172+
173+
```yaml
174+
Type: SwitchParameter
175+
Parameter Sets: (All)
176+
Aliases: ECMP
177+
178+
Required: False
179+
Position: 9
180+
Default value: None
181+
Accept pipeline input: False
182+
Accept wildcard characters: False
183+
```
184+
162185
### -EnableConsistencyGroups
163186
Indicates that consistency groups are enabled for the replication group that contains multiple volumes.
164187
Consistency groups provide write ordering.
@@ -312,7 +335,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
312335

313336
## OUTPUTS
314337

315-
### replicationgroup
338+
### Microsoft.Management.Infrastructure.CimInstance
316339

317340
## NOTES
318341

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

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Creates a replication partnership between two replication groups.
1919
```
2020
New-SRPartnership [[-SourceComputerName] <String>] [-SourceRGName] <String> [-DestinationComputerName] <String>
2121
[-DestinationRGName] <String> [[-ReplicationMode] <ReplicationMode>] [-PreventReplication] [-Seeded]
22-
[[-AsyncRPO] <UInt32>] [-EnableEncryption] [-Force] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
23-
[-AsJob] [<CommonParameters>]
22+
[[-AsyncRPO] <UInt32>] [-EnableEncryption] [-EnableCompression] [-Force] [-CimSession <CimSession[]>]
23+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2424
```
2525

2626
### CreateTopology
@@ -29,15 +29,23 @@ New-SRPartnership [[-SourceComputerName] <String>] [-SourceRGName] <String> [-So
2929
[-SourceLogVolumeName] <String> [[-SourceRGDescription] <String>] [-DestinationComputerName] <String>
3030
[-DestinationRGName] <String> [-DestinationVolumeName] <String[]> [-DestinationLogVolumeName] <String>
3131
[[-DestinationRGDescription] <String>] [[-ReplicationMode] <ReplicationMode>] [[-LogSizeInBytes] <UInt64>]
32-
[-PreventReplication] [-Seeded] [-EnableConsistencyGroups] [[-AsyncRPO] <UInt32>] [-EnableEncryption] [-Force]
33-
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
32+
[-PreventReplication] [-Seeded] [-EnableConsistencyGroups] [[-AsyncRPO] <UInt32>] [-EnableEncryption]
33+
[-EnableCompression] [-Force] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
34+
[<CommonParameters>]
3435
```
3536

3637
## DESCRIPTION
3738
The **New-SRPartnership** cmdlet creates a replication partnership between two new or existing replication groups.
3839
This cmdlet can create the complete replication topology.
3940
It can also tie together separately created replication groups.
4041

42+
> [!NOTE]
43+
> The **EnableCompression** parameter is currently in PREVIEW beginning with TODO: 2022-08
44+
> Cumulative Update for Microsoft server operating system version 21H2 for x64-based Systems
45+
> ([KB5016693](https://support.microsoft.com/help/5016693)). Some information relates to prerelease
46+
> product that may be substantially modified before it's released. Microsoft makes no warranties,
47+
> express or implied, with respect to the information provided here.
48+
4149
## EXAMPLES
4250

4351
### Example 1: Create a topology between two servers
@@ -278,6 +286,21 @@ Accept pipeline input: True (ByPropertyName)
278286
Accept wildcard characters: False
279287
```
280288

289+
### -EnableCompression
290+
Indicates that the connections on this partnership should use compression.
291+
292+
```yaml
293+
Type: SwitchParameter
294+
Parameter Sets: (All)
295+
Aliases: ECMP
296+
297+
Required: False
298+
Position: 99
299+
Default value: None
300+
Accept pipeline input: False
301+
Accept wildcard characters: False
302+
```
303+
281304
### -EnableConsistencyGroups
282305
Indicates that consistency groups are enabled for the replication group that contains multiple volumes.
283306
Consistency groups provide write ordering.

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

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,22 @@ Set-SRGroup [[-ComputerName] <String>] [-Name] <String> [-Force] [-RemoveVolumeN
3131
```
3232
Set-SRGroup [[-ComputerName] <String>] [-Name] <String> [-Force] [[-LogSizeInBytes] <UInt64>]
3333
[[-Description] <String>] [[-ReplicationMode] <ReplicationMode>] [[-Encryption] <Boolean>]
34-
[[-AllowVolumeResize] <Boolean>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf]
35-
[-Confirm] [<CommonParameters>]
34+
[[-Compression] <Boolean>] [[-AllowVolumeResize] <Boolean>] [-CimSession <CimSession[]>]
35+
[-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
3636
```
3737

3838
## DESCRIPTION
3939
The **Set-SRGroup** cmdlet modifies settings of an existing replication group.
4040
A replication group contains one or more data volumes and an associated log volume.
4141
A replication group is the container for replication.
4242

43+
> [!NOTE]
44+
> The **Compression** parameter is currently in PREVIEW beginning with TODO: 2022-08
45+
> Cumulative Update for Microsoft server operating system version 21H2 for x64-based Systems
46+
> ([KB5016693](https://support.microsoft.com/help/5016693)). Some information relates to prerelease
47+
> product that may be substantially modified before it's released. Microsoft makes no warranties,
48+
> express or implied, with respect to the information provided here.
49+
4350
## EXAMPLES
4451

4552
### Example 1: Add a volume to a replication group
@@ -135,6 +142,21 @@ Accept pipeline input: False
135142
Accept wildcard characters: False
136143
```
137144
145+
### -Compression
146+
Indicates that the connections in this Storage Replica group should use compression.
147+
148+
```yaml
149+
Type: Boolean
150+
Parameter Sets: ModifyConfig
151+
Aliases: CMP
152+
153+
Required: False
154+
Position: 10
155+
Default value: None
156+
Accept pipeline input: True (ByPropertyName)
157+
Accept wildcard characters: False
158+
```
159+
138160
### -ComputerName
139161
Specifies a single replica host computer NetBIOS name or fully qualified domain name (FQDN) of a computer.
140162
The default value is the local computer.
@@ -336,8 +358,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
336358

337359
## INPUTS
338360

361+
### System.String
362+
363+
### System.String[]
364+
365+
### System.UInt64
366+
367+
### Microsoft.PowerShell.Cmdletization.GeneratedTypes.SREnum.ReplicationMode
368+
369+
### System.Boolean
370+
339371
## OUTPUTS
340372

373+
### System.Object
341374
## NOTES
342375

343376
## RELATED LINKS

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

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Set-SRPartnership [[-SourceComputerName] <String>] [-SourceRGName] <String>
2727
```
2828
Set-SRPartnership [[-SourceComputerName] <String>] [-SourceRGName] <String> [-DestinationComputerName] <String>
2929
[-DestinationRGName] <String> [[-ReplicationMode] <ReplicationMode>] [[-LogSizeInBytes] <UInt64>]
30-
[[-AsyncRPO] <UInt32>] [[-Encryption] <Boolean>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
31-
[-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
30+
[[-AsyncRPO] <UInt32>] [[-Encryption] <Boolean>] [[-Compression] <Boolean>] [-CimSession <CimSession[]>]
31+
[-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
3232
```
3333

3434
### ModifyPartnership
@@ -43,6 +43,13 @@ The **Set-SRPartnership** cmdlet modifies a replication partnership between two
4343
You can use this cmdlet to add replicated volumes.
4444
You can also change the direction of replication which makes a source volume into a destination volume.
4545

46+
> [!NOTE]
47+
> The **Compression** parameter is currently in PREVIEW beginning with TODO: 2022-08
48+
> Cumulative Update for Microsoft server operating system version 21H2 for x64-based Systems
49+
> ([KB5016693](https://support.microsoft.com/help/5016693)). Some information relates to prerelease
50+
> product that may be substantially modified before it's released. Microsoft makes no warranties,
51+
> express or implied, with respect to the information provided here.
52+
4653
## EXAMPLES
4754

4855
### Example 1: Reverse replication direction
@@ -231,6 +238,21 @@ Accept pipeline input: False
231238
Accept wildcard characters: False
232239
```
233240
241+
### -Compression
242+
Indicates that the connections on this partnership should use compression.
243+
244+
```yaml
245+
Type: Boolean
246+
Parameter Sets: ModifySettings
247+
Aliases: CMP
248+
249+
Required: False
250+
Position: 53
251+
Default value: None
252+
Accept pipeline input: False
253+
Accept wildcard characters: False
254+
```
255+
234256
### -Confirm
235257
Prompts you for confirmation before running the cmdlet.
236258
@@ -521,8 +543,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
521543

522544
## INPUTS
523545

546+
### System.String
547+
548+
### System.String[]
549+
550+
### System.UInt64
551+
524552
## OUTPUTS
525553

554+
### System.Object
526555
## NOTES
527556

528557
## RELATED LINKS

0 commit comments

Comments
 (0)