Get-IscsiVirtualDisk

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

Get-IscsiVirtualDisk

Obtains the iSCSI virtual disks and their associated properties.

Syntax

Parameter Set: Device
Get-IscsiVirtualDisk [[-Path] <String> ] [-ClusterGroupName <String> ] [-ComputerName <String> ] [ <CommonParameters>]

Parameter Set: Initiator
Get-IscsiVirtualDisk [-ClusterGroupName <String> ] [-ComputerName <String> ] [-InitiatorId <InitiatorId> ] [ <CommonParameters>]

Parameter Set: Target
Get-IscsiVirtualDisk [-ClusterGroupName <String> ] [-ComputerName <String> ] [-TargetName <String> ] [ <CommonParameters>]

Detailed Description

The Get-IscsiVirtualDisk cmdlet obtains the iSCSI virtual disks and their associated properties.

Parameters

-ClusterGroupName<String>

Specifies the name of the resource group or network within the resource group on which this cmdlet should be run.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-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

-InitiatorId<InitiatorId>

Specifies the iSCSI initiator identifiers (IDs) to which the iSCSI target is assigned.
Use this parameter to filter out the iSCSI Virtual Disk object that can be accessed by the given iSCSI initiator.
The format for this parameter is IdType:Value.
The acceptable values for this parameter are:DNSName, IPAddress, IPv6Address, IQN, MACAddress.

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?	false
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-TargetName<String>

Specifies the name of the iSCSI target.
Use this parameter to filter out the iSCSI Virtual Disk object that are assigned to the specified iSCSI target.

Aliases	none
Required?	false
Position?	named
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.

• Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk

Examples

EXAMPLE 1

This example gets all of the virtual disks on the local server.

PS C:\> Get-IscsiVirtualDisk

EXAMPLE 2

This example gets the virtual disk object with the path E:\temp\test.vhd on the local server.

PS C:\> Get-IscsiVirtualDisk –Path "E:\temp\test.vhd"

EXAMPLE 3

This example gets the Virtual Disk object with the path E:\temp\test.vhd in the resource group named target1Group on cluster server named fscluster.contoso.com.

PS C:\> Get-IscsiVirtualDisk –Path "E:\temp\test.vhd" -ComputerName "fscluster.contoso.com" -ClusterGroupName "target1Group"

EXAMPLE 4

This example gets all of the virtual disks that are associated with the target named TargetOne on the local server.

PS C:\> Get-IscsiVirtualDisk -TargetName "TargetOne"

EXAMPLE 5

This example gets all of the virtual disks on the local server that are used by the initiator with IP address 10.10.1.1.

PS C:\> Get-IscsiVirtualDisk -InitiatorId "IpAddress:10.10.1.1"