iSCSI Target Cmdlets in Windows PowerShell

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

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

iSCSI target service

This reference provides cmdlet descriptions and syntax for all iSCSI target service-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

cmdlet	Description
Add-IscsiVirtualDiskTargetMapping	Assigns a virtual disk to an iSCSI target.
Checkpoint-IscsiVirtualDisk	Creates a virtual disk snapshot.
Convert-IscsiVirtualDisk	Converts an iSCSI virtual disk to a Generation one Advanced Format-aligned (4K sector technology) virtual disk.
Dismount-IscsiVirtualDiskSnapshot	Dismounts the snapshot.
Expand-IscsiVirtualDisk	Expands a virtual disk.
Export-IscsiVirtualDiskSnapshot	Exports a snapshot.
Get-IscsiServerTarget	Obtains iSCSI targets and their associated properties.
Get-IscsiTargetServerSetting	Gets the global settings or common configurations for iSCSI targets, virtual disks or snapshots.
Get-IscsiVirtualDisk	Obtains the iSCSI virtual disks and their associated properties.
Get-IscsiVirtualDiskSnapshot	Gets properties of snapshots.
Import-IscsiVirtualDisk	Adds an iSCSI Virtual Disk object using an existing virtual hard disk (VHD) file.
Mount-IscsiVirtualDiskSnapshot	Mounts a snapshot locally.
New-IscsiServerTarget	Creates a new iSCSI Target object with the specified name.
New-IscsiVirtualDisk	Creates an iSCSI virtual disk with the specified file path and size.
Remove-IscsiServerTarget	Deletes the specified iSCSI target.
Remove-IscsiVirtualDisk	Deletes a Virtual Disk object, without deleting the virtual hard disk (VHD) file.
Remove-IscsiVirtualDiskSnapshot	Deletes the specified snapshot.
Remove-IscsiVirtualDiskTargetMapping	Removes the assignment between the specified iSCSI virtual disk and the specified iSCSI target.
Restore-IscsiVirtualDisk	Restores an iSCSI virtual disk from a snapshot.
Set-IscsiServerTarget	Modifies settings for the specified iSCSI target.
Set-IscsiTargetServerSetting	Sets the global settings or common configurations for an iSCSI target virtual disk.
Set-IscsiVirtualDisk	Modifies the settings for the specified iSCSI virtual disk.
Set-IscsiVirtualDiskSnapshot	Sets the description for a snapshot.

Note

To list all the cmdlets that are available, use the Get-Command –Module IscsiTarget cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

● Get-Help <cmdlet name> -Detailed
● Get-Help <cmdlet name> -Examples
● Get-Help <cmdlet name> -Full

More Information

For more information about the cmdlets, see the following:

-