Skip to content

Commit cde74f7

Browse files
tiburdtiburd
authored
Merge pull request MicrosoftDocs#2681 from TimShererWithAquent/storagereplica-v-tishe
storagereplica PowerShell reference update
2 parents 8babebe + 1b4fc11 commit cde74f7

File tree

4 files changed

+402
-4
lines changed

4 files changed

+402
-4
lines changed

‎docset/winserver2022-ps/storagereplica/Dismount-SRDestination.md‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
---
2+
description: The Dismount-SRDestination cmdlet dismounts a test failover snapshot.
3+
external help file: MSFT_WvrAdminTasks.cdxml-help.xml
4+
Module Name: storagereplica
5+
ms.date: 10/06/2021
6+
online version: https://docs.microsoft.com/powershell/module/storagereplica/dismount-srdestination?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Dismount-SRDestination
9+
---
10+
11+
# Dismount-SRDestination
12+
13+
## SYNOPSIS
14+
Dismounts a test failover snapshot.
15+
16+
## SYNTAX
17+
18+
```
19+
Dismount-SRDestination [[-ComputerName] <String>] [-Name] <String> [-Force] [-CimSession <CimSession[]>]
20+
[-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
The **Dismount-SRDestination** cmdlet dismounts a test failover snapshot.
25+
26+
## EXAMPLES
27+
28+
### Example 1: Dismount a snapshot of replicated storage
29+
```powershell
30+
Dismount-SRDestination -ComputerName "SR-SRV05" -Name "ReplicationGroup01"
31+
```
32+
33+
This command dismounts the snapshot for the replication group `ReplicationGroup01` on the specified computer.
34+
35+
## PARAMETERS
36+
37+
### -AsJob
38+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
39+
40+
```yaml
41+
Type: SwitchParameter
42+
Parameter Sets: (All)
43+
Aliases:
44+
45+
Required: False
46+
Position: Named
47+
Default value: False
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### -CimSession
53+
Runs the cmdlet in a remote session or on a remote computer.
54+
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
55+
The default is the current session on the local computer.
56+
57+
```yaml
58+
Type: CimSession[]
59+
Parameter Sets: (All)
60+
Aliases: Session
61+
62+
Required: False
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -ComputerName
70+
Specifies a single replica host computer NetBIOS name or fully qualified domain name (FQDN).
71+
The default value is the local computer.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases: CN
77+
78+
Required: False
79+
Position: 1
80+
Default value: None
81+
Accept pipeline input: True (ByPropertyName)
82+
Accept wildcard characters: False
83+
```
84+
85+
### -Force
86+
Forces the command to run without asking for user confirmation.
87+
88+
```yaml
89+
Type: SwitchParameter
90+
Parameter Sets: (All)
91+
Aliases: F
92+
93+
Required: False
94+
Position: 100
95+
Default value: False
96+
Accept pipeline input: False
97+
Accept wildcard characters: False
98+
```
99+
100+
### -Name
101+
Specifies the name of the replication group for which this cmdlet dismounts destination storage.
102+
103+
```yaml
104+
Type: String
105+
Parameter Sets: (All)
106+
Aliases: N
107+
108+
Required: True
109+
Position: 2
110+
Default value: None
111+
Accept pipeline input: True (ByPropertyName)
112+
Accept wildcard characters: False
113+
```
114+
115+
### -ThrottleLimit
116+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
117+
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.
118+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
119+
120+
```yaml
121+
Type: Int32
122+
Parameter Sets: (All)
123+
Aliases:
124+
125+
Required: False
126+
Position: Named
127+
Default value: 0
128+
Accept pipeline input: False
129+
Accept wildcard characters: False
130+
```
131+
132+
### -Confirm
133+
Prompts you for confirmation before running the cmdlet.
134+
135+
```yaml
136+
Type: SwitchParameter
137+
Parameter Sets: (All)
138+
Aliases: cf
139+
140+
Required: False
141+
Position: Named
142+
Default value: None
143+
Accept pipeline input: False
144+
Accept wildcard characters: False
145+
```
146+
147+
### -WhatIf
148+
Shows what would happen if the cmdlet runs.
149+
The cmdlet is not run.
150+
151+
```yaml
152+
Type: SwitchParameter
153+
Parameter Sets: (All)
154+
Aliases: wi
155+
156+
Required: False
157+
Position: Named
158+
Default value: None
159+
Accept pipeline input: False
160+
Accept wildcard characters: False
161+
```
162+
163+
### CommonParameters
164+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
165+
166+
## INPUTS
167+
168+
### System.String
169+
170+
## OUTPUTS
171+
172+
### System.Object
173+
174+
## NOTES
175+
176+
## RELATED LINKS
177+
178+
[Mount-SRDestination](Mount-SRDestination.md)

‎docset/winserver2022-ps/storagereplica/Mount-SRDestination.md‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
---
2+
description: The Mount-SRDestination cmdlet mounts a snapshot of replicated storage temporarily for testing or backup purposes.
3+
external help file: MSFT_WvrAdminTasks.cdxml-help.xml
4+
Module Name: storagereplica
5+
ms.date: 10/06/2021
6+
online version: https://docs.microsoft.com/powershell/module/storagereplica/mount-srdestination?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Mount-SRDestination
9+
---
10+
11+
# Mount-SRDestination
12+
13+
## SYNOPSIS
14+
Mounts a snapshot of replicated storage temporarily for testing or backup purposes.
15+
16+
## SYNTAX
17+
18+
```
19+
Mount-SRDestination [[-ComputerName] <String>] [-Name] <String> [-TemporaryPath] <String> [-Force]
20+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
The **Mount-SRDestination** cmdlet mounts a snapshot of replicated storage temporarily for testing or backup purposes.
25+
Storage Replica dismounts the destination volume when replication begins.
26+
Mounting the destination storage is called *test failover*.
27+
28+
Test failover requires an unused NTFS or ReFS formatted volume that isn't currently being replicated.
29+
30+
## EXAMPLES
31+
32+
### Example 1: Mount a snapshot of replicated storage
33+
```powershell
34+
Mount-SRDestination -ComputerName "SR-SRV05" -Name "ReplicationGroup01" -TemporaryPath T:\
35+
```
36+
37+
This command sets up test failover for the replication group on the specified computer.
38+
39+
## PARAMETERS
40+
41+
### -AsJob
42+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
43+
44+
```yaml
45+
Type: SwitchParameter
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: False
50+
Position: Named
51+
Default value: False
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -CimSession
57+
Runs the cmdlet in a remote session or on a remote computer.
58+
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
59+
The default is the current session on the local computer.
60+
61+
```yaml
62+
Type: CimSession[]
63+
Parameter Sets: (All)
64+
Aliases: Session
65+
66+
Required: False
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### -ComputerName
74+
Specifies a single replica host computer NetBIOS name or fully qualified domain name (FQDN).
75+
The default value is the local computer.
76+
77+
```yaml
78+
Type: String
79+
Parameter Sets: (All)
80+
Aliases: CN
81+
82+
Required: False
83+
Position: 1
84+
Default value: None
85+
Accept pipeline input: True (ByPropertyName)
86+
Accept wildcard characters: False
87+
```
88+
89+
### -Force
90+
Forces the command to run without asking for user confirmation.
91+
92+
```yaml
93+
Type: SwitchParameter
94+
Parameter Sets: (All)
95+
Aliases: F
96+
97+
Required: False
98+
Position: 100
99+
Default value: False
100+
Accept pipeline input: False
101+
Accept wildcard characters: False
102+
```
103+
104+
### -Name
105+
Specifies the name of the replication group for which this cmdlet mounts destination storage.
106+
107+
```yaml
108+
Type: String
109+
Parameter Sets: (All)
110+
Aliases: N
111+
112+
Required: True
113+
Position: 2
114+
Default value: None
115+
Accept pipeline input: True (ByPropertyName)
116+
Accept wildcard characters: False
117+
```
118+
119+
### -TemporaryPath
120+
Specifies the path of the test failover volume.
121+
This volume must be an unused NTFS or ReFS formatted volume that isn't currently replicating.
122+
123+
```yaml
124+
Type: String
125+
Parameter Sets: (All)
126+
Aliases: D
127+
128+
Required: True
129+
Position: 3
130+
Default value: None
131+
Accept pipeline input: False
132+
Accept wildcard characters: False
133+
```
134+
135+
### -ThrottleLimit
136+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
137+
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.
138+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
139+
140+
```yaml
141+
Type: Int32
142+
Parameter Sets: (All)
143+
Aliases:
144+
145+
Required: False
146+
Position: Named
147+
Default value: 0
148+
Accept pipeline input: False
149+
Accept wildcard characters: False
150+
```
151+
152+
### -Confirm
153+
Prompts you for confirmation before running the cmdlet.
154+
155+
```yaml
156+
Type: SwitchParameter
157+
Parameter Sets: (All)
158+
Aliases: cf
159+
160+
Required: False
161+
Position: Named
162+
Default value: None
163+
Accept pipeline input: False
164+
Accept wildcard characters: False
165+
```
166+
167+
### -WhatIf
168+
Shows what would happen if the cmdlet runs.
169+
The cmdlet is not run.
170+
171+
```yaml
172+
Type: SwitchParameter
173+
Parameter Sets: (All)
174+
Aliases: wi
175+
176+
Required: False
177+
Position: Named
178+
Default value: None
179+
Accept pipeline input: False
180+
Accept wildcard characters: False
181+
```
182+
183+
### CommonParameters
184+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
185+
186+
## INPUTS
187+
188+
### System.String
189+
190+
## OUTPUTS
191+
192+
### System.Object
193+
194+
## NOTES
195+
196+
## RELATED LINKS
197+
198+
[Dismount-SRDestination](Dismount-SRDestination.md)

0 commit comments

Comments
 (0)