| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
Microsoft.Iscsi.Target.Commands.dll-Help.xml |
IscsiTarget |
12/20/2016 |
2.0.0 |
Set-IscsiVirtualDisk |
Modifies the settings for the specified iSCSI virtual disk.
Set-IscsiVirtualDisk [-Path] <String> [-Description <String>] [-PassThru] [-Enable <Boolean>]
[-ComputerName <String>] [-Credential <PSCredential>] [<CommonParameters>]
Set-IscsiVirtualDisk -InputObject <IscsiVirtualDisk> [-Description <String>] [-PassThru] [-Enable <Boolean>]
[-ComputerName <String>] [-Credential <PSCredential>] [<CommonParameters>]
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.
PS C:\> Set-IscsiVirtualDisk -Path "E:\Temp\vhd1.vhdx" -Description "disk for data"
This example changes the VHD description to disk for data.
PS C:\> Set-IscsiVirtualDisk -Path "E:\Temp\vhd1.vhdx" -Enable $False
This example disables the VHD with the path E:\Temp\vhd1.vhdx.
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: FalseSpecifies 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: FalseSpecifies 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: FalseSpecifies 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: FalseAccepts 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: FalseReturns 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: FalseSpecifies 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.