Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Set-IscsiVirtualDisk

Last Updated: 2/14/2017

SYNOPSIS

Modifies the settings for the specified iSCSI virtual disk.

SYNTAX

DevicePath (Default)

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

InputObject

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

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.

EXAMPLES

Example 1: Change a VHD description

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

This example changes the VHD description to disk for data.

Example 2: Disable a VHD

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

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

PARAMETERS

-ComputerName

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.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Credential

Specifies the credentials when connecting to a remote computer.

Type: PSCredential
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

Specifies the description for the iSCSI virtual disk.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Enable

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

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InputObject

Accepts an iSCSI virtual disk object from the input pipeline.

Type: IscsiVirtualDisk
Parameter Sets: InputObject
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

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

Type: String
Parameter Sets: DevicePath
Aliases: DevicePath

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk

OUTPUTS

Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk

NOTES

Checkpoint-IscsiVirtualDisk

Convert-IscsiVirtualDisk

Get-IscsiVirtualDisk

Import-IscsiVirtualDisk

New-IscsiVirtualDisk

Remove-IscsiVirtualDisk

Restore-IscsiVirtualDisk

© 2017 Microsoft