| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
VirtualDisk.cdxml-help.xml |
Storage |
12/20/2016 |
2.0.0 |
Disconnect-VirtualDisk |
Disconnects a virtual disk from the specified computer, revoking access to the virtual disk.
Disconnect-VirtualDisk [-FriendlyName] <String[]> [-StorageNodeName <String>] [-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]
Disconnect-VirtualDisk -UniqueId <String[]> [-StorageNodeName <String>] [-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]
Disconnect-VirtualDisk -Name <String[]> [-StorageNodeName <String>] [-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]
Disconnect-VirtualDisk -InputObject <CimInstance[]> [-StorageNodeName <String>] [-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]
The Disconnect-VirtualDisk cmdlet disconnects a virtual disk from the specified computer, revoking access to the virtual disk.
To disconnect a virtual disk from a remote computer, from a management node in a subsystem that is registered on the management node, specify the StorageNodeName parameter.
PS C:\>Disconnect-VirtualDisk -FriendlyName VirtualDisk01
This example disconnects a virtual disk named VirtualDisk01 from the local machine to prevent futher access to the virtual disk.
PS C:\>Get-StorageSubSystem -FriendlyName "Clustered Storage Spaces on Cluster01" | Get-VirtualDisk -FriendlyName "VDisk01" | Disconnect-VirtualDisk -StorageNodeName "ClustNode1"
This command disconnects a virtual disk to from remote computer from a management node in a subsystem that is registered on the management node.
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the friendly name of the virtual disk to disconnect.
Type: String[]
Parameter Sets: ByFriendlyName
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the input object that is used in a pipeline command.
Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of the virtual disk to disconnect.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies that the cmdlet should output an object representing the disconnected virtual disk. By default, this cmdlet does not generate any output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of a computer. The cmdlet disconnects the virtual disk from the computer that you specify.
Use this parameter only when you run the cmdlet from a management node to disconnect a virtual disk from a remote cluster subsystem.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum number of concurrent operations that can be established to run the cmdlet.
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.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the UniqueID of the virtual disk to disconnect.
Type: String[]
Parameter Sets: ByUniqueId
Aliases: Id
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can use the pipeline operator to pass an array of VirtualDisk objects to the InputObject parameter to specify one or more virtual disks to disconnect.
The Disconnect-VirtualDisk cmdlet does not output objects unless you use the PassThru parameter, in which case it outputs objects that represent the virtual disks that you disconnected.
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).