Set-VirtualDisk

Set-VirtualDisk

Modifies the attributes of an existing virtual disk.

Syntax

Parameter Set: ByUniqueId
Set-VirtualDisk -UniqueId <String> [-AsJob] [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-OtherUsageDescription <String> ] [-ThrottleLimit <Int32> ] [-Usage <Usage> ] [ <CommonParameters>]

Parameter Set: ByFriendlyName
Set-VirtualDisk [-FriendlyName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-OtherUsageDescription <String> ] [-ThrottleLimit <Int32> ] [-Usage <Usage> ] [ <CommonParameters>]

Parameter Set: ByFriendlyNameAttributes
Set-VirtualDisk [-FriendlyName] <String> [-Access <Access> ] [-AsJob] [-CimSession <CimSession[]> ] [-IsManualAttach <Boolean> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByName
Set-VirtualDisk -Name <String> [-AsJob] [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-OtherUsageDescription <String> ] [-ThrottleLimit <Int32> ] [-Usage <Usage> ] [ <CommonParameters>]

Parameter Set: ByNameAttributes
Set-VirtualDisk -Name <String> [-Access <Access> ] [-AsJob] [-CimSession <CimSession[]> ] [-IsManualAttach <Boolean> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByObject
Set-VirtualDisk [-InputObject] <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-NewFriendlyName <String> ] [-OtherUsageDescription <String> ] [-ThrottleLimit <Int32> ] [-Usage <Usage> ] [ <CommonParameters>]

Parameter Set: ByObjectAttributes
Set-VirtualDisk [-InputObject] <CimInstance[]> [-Access <Access> ] [-AsJob] [-CimSession <CimSession[]> ] [-IsManualAttach <Boolean> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueIdAttributes
Set-VirtualDisk -UniqueId <String> [-Access <Access> ] [-AsJob] [-CimSession <CimSession[]> ] [-IsManualAttach <Boolean> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Set-VirtualDisk cmdlet modifies the attributes of an existing virtual disk.

Parameters

-Access<Access>

Manages access permissions to the VirtualDisk object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-FriendlyName<String>

Specifies a friendly name for a disk. The friendly name may be defined by a user and is not guaranteed to be unique.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-InputObject<CimInstance[]>

Accepts an object from the pipeline as input.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-IsManualAttach<Boolean>

Specifies that the object is set as manual-attach.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of an object or setting.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-NewFriendlyName<String>

Specifies the new name of the object. The new name may be defined by a user.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-OtherUsageDescription<String>

Specifies the usage of this object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-UniqueId<String>

Specifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.

Aliases	Id
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Usage<Usage>

Specifies the intended usage.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

The output type is the type of the objects that the cmdlet emits.

• None

Examples

EXAMPLE 1

This example changes the friendly name of a virtual disk.

PS C:\> Set-VirtualDisk -FriendlyName VirtualDisk1 -NewFriendlyName "Storage For Contoso"

EXAMPLE 2

This example attaches a virtual disk that is currently set to manual-attach.

PS C:\> Set-VirtualDisk -FriendlyName "Storage For Contoso" -IsManualAttach $False

Related topics

Connect-VirtualDisk

Disconnect-VirtualDisk

Get-VirtualDisk

Hide-VirtualDisk

New-VirtualDisk

Remove-VirtualDisk

Repair-VirtualDisk

Resize-VirtualDisk

Show-VirtualDisk