Disconnect-Virtual Disk

Module:
storage
Disconnects a virtual disk from the specified computer, revoking access to the virtual disk.

Syntax 

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

Description

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.

Examples

Example 1: Disconnect a virtual disk by friendly name 

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.

Example 2: Disconnect a virtual disk from a remote computer from a management node 

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.

Required Parameters

-FriendlyName

Specifies the friendly name of the virtual disk to disconnect.

Type: String[]
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name

Specifies the name of the virtual disk to disconnect.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-UniqueId

Specifies the UniqueID of the virtual disk to disconnect.

Type: String[]
Aliases: Id
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CimSession

Runs 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[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

Specifies that the cmdlet should output an object representing the disconnected virtual disk. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StorageNodeName

Specifies 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
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

Specifies 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
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Inputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

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.

Outputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

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.