|
| 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