Remove-IscsiVirtualDiskTargetMapping

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Remove-IscsiVirtualDiskTargetMapping

Removes the assignment between the specified iSCSI virtual disk and the specified iSCSI target.

Syntax

Parameter Set: Default
Remove-IscsiVirtualDiskTargetMapping [-TargetName] <String> [-Path] <String> [-ComputerName <String> ] [ <CommonParameters>]

Detailed Description

The Remove-IscsiVirtualDiskTargetMapping cmdlet removes the assignment between a virtual disk and an iSCSI target. The virtual disk will no longer be accessible by an iSCSI initiator once the assignment is removed.

Parameters

-ComputerName<String>

Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer.
Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String>

Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk.
Filter the iSCSI Virtual Disk object using this parameter.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-TargetName<String>

Specifies the name of the iSCSI target.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Examples

EXAMPLE 1

This example unassigns, or disassociates, the virtual disk at E:\temp\vhd1.vhd from the target named TargetOne. Use Add-VirtualDiskTargetMapping to assign the virtual disk to an iSCSI target before it can be used by an iSCSI initiator.

PS C:\> Remove-IscsiVirtualDiskTargetMapping -TargetName "TargetOne" –Path "E:\temp\vhd1.vhd"

Add-VirtualDiskTargetMapping