Set-IscsiVirtualDisk
Set-IscsiVirtualDisk
Modifies the settings for the specified iSCSI virtual disk.
Syntax
Parameter Set: DevicePath
Set-IscsiVirtualDisk [-Path] <String> [ <CommonParameters>]
Parameter Set: __AllParameterSets
Set-IscsiVirtualDisk [-ComputerName <String> ] [-Credential <PSCredential> ] [-Description <String> ] [-Enable <Boolean> ] [-PassThru] [ <CommonParameters>]
Parameter Set: InputObject
Set-IscsiVirtualDisk -InputObject <IscsiVirtualDisk> [ <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.
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
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 |
<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.
- Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk
Examples
EXAMPLE 1
This example changes the VHD description to disk for data.
PS C:\> Set-IscsiVirtualDisk –Path "E:\Temp\vhd1.vhd" -Description "disk for data"
EXAMPLE 2
This example disables the VHD with the path E:\Temp\vhd1.vhd.
PS C:\> Set-IscsiVirtualDisk –Path "E:\Temp\vhd1.vhd" -Enable $false