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
 

Set-IscsiVirtualDisk

Set-IscsiVirtualDisk

microsoft.iscsi.target.commands.dll

Synopsis

Modifies the settings for the specified iSCSI virtual disk.

Syntax

Set-IscsiVirtualDisk [-Path] [-ComputerName] [-Credential] [-Description] [-Enable] [-PassThru] [<CommonParameters>]

Set-IscsiVirtualDisk [-ComputerName] [-Credential] [-Description] [-Enable] [-PassThru] [-InputObject] [<CommonParameters>]

Detailed Description

The Set-IscsiVirtualDisk cmdlet modifies the settings for a virtual disk and returns the corresponding iSCSI Virtual Disk object, if the PassThru parameter is specified.

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.

If you do not specify a value for this parameter, the cmdlet uses the local computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Credential <PSCredential>

Specifies the credentials when connecting to a remote computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Description <String>

Specifies the description for the iSCSI virtual disk.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Enable <Boolean>

Specifies that the specified iSCSI virtual disk is either enabled or disabled.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <IscsiVirtualDisk>

Accepts an iSCSI virtual disk object from the input pipeline.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. 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

-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

DevicePath

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type

Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk

Return Type

Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk

Notes

None

Examples

EXAMPLE 1

This example changes the VHD description to disk for data.

PS C:\> Set-IscsiVirtualDisk –Path "E:\Temp\vhd1.vhdx" -Description "disk for data"

EXAMPLE 2

This example disables the VHD with the path E:\Temp\vhd1.vhdx.

PS C:\> Set-IscsiVirtualDisk –Path "E:\Temp\vhd1.vhdx" -Enable $false

Online Version
Checkpoint-IscsiVirtualDisk
Convert-IscsiVirtualDisk
Get-IscsiVirtualDisk
Import-IscsiVirtualDisk
New-IscsiVirtualDisk
Remove-IscsiVirtualDisk
Restore-IscsiVirtualDisk