Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Disconnect-VirtualDisk

Disconnect-VirtualDisk

virtualdisk.cdxml

Synopsis

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

Syntax

Disconnect-VirtualDisk [-FriendlyName] [-AsJob] [-CimSession] [-PassThru] [-StorageNodeName] [-ThrottleLimit] [<CommonParameters>]

Disconnect-VirtualDisk [-AsJob] [-CimSession] [-PassThru] [-StorageNodeName] [-ThrottleLimit] [-InputObject] [<CommonParameters>]

Disconnect-VirtualDisk [-AsJob] [-CimSession] [-PassThru] [-StorageNodeName] [-ThrottleLimit] [-Name] [<CommonParameters>]

Disconnect-VirtualDisk [-AsJob] [-CimSession] [-PassThru] [-StorageNodeName] [-ThrottleLimit] [-UniqueId] [<CommonParameters>]

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

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-FriendlyName <String[]>

Specifies the friendly name of the virtual disk to disconnect.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the VirtualDisk object to disconnect. Enter a VirtualDisk CIM object, which you can get by using the Get-VirtualDisk cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Name <String[]>

Specifies the name of the virtual disk to disconnect.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-StorageNodeName <String>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-UniqueId <String[]>

Specifies the UniqueID of the virtual disk to disconnect.

Aliases

Id

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type

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

Return Type

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

Notes

None

Examples

Example 1: Disconnect a virtual disk by friendly name

This example disconnects a virtual disk named VirtualDisk01 from the local machine to prevent futher access to the virtual disk.

PS C:\>Disconnect-VirtualDisk -FriendlyName VirtualDisk01

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

This command disconnects a virtual disk to from remote computer from a management node in a subsystem that is registered on the management node.

PS C:\>Get-StorageSubSystem –FriendlyName "Clustered Storage Spaces on Cluster01" | Get-VirtualDisk –FriendlyName "VDisk01" | Disconnect-VirtualDisk –StorageNodeName "ClustNode1"

Online Version
Connect-VirtualDisk
Get-VirtualDisk
Hide-VirtualDisk
New-VirtualDisk
Remove-VirtualDisk
Repair-VirtualDisk
Resize-VirtualDisk
Set-VirtualDisk
Show-VirtualDisk