COMMAND EVERYTHING.

Set-VirtualDisk

Modifies the attributes of an existing virtual disk.

Last verified: 2026-10-26

Microsoft Storage reference: Modifies the attributes of an existing virtual disk. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

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

Required permissions

Use an account with the target resource permissions documented for Set-VirtualDisk. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / Storage · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-Access

Manages access permissions to the VirtualDisk object.

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

-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.

-FriendlyName (required)

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

-InputObject (required)

Specifies the input object that is used in a pipeline command.

-IsManualAttach

Specifies that the object is set as manual-attach.

-Name (required)

Specifies the name of the virtual disk to modify.

-NewFriendlyName

Specifies the new name of the virtual disk.

-OtherUsageDescription

Specifies the usage of this object.

-StorageNodeName

Specifies the name of the computer on which to run the cmdlet. Use this parameter only when you run the cmdlet from a management node to modify a virtual disk on a remote cluster subsystem for the purpose of setting the manual-attach attribute of the virtual disk. Specify the IsManualAttach parameter to set the manual-attach attribute of the virtual disk.

-ThrottleLimit

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.

-UniqueId (required)

Specifies the unique ID of the virtual disk to modify.

-Usage

Specifies the intended usage.

Prerequisites

Windows with the Storage module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Set-VirtualDisk -FriendlyName VirtualDisk1 -NewFriendlyName "Storage For Contoso"

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/Storage/Set-VirtualDisk.md

https://learn.microsoft.com/powershell/module/storage/set-virtualdisk?view=windowsserver2025-ps

Explain or customize this command with AI

Related commands

Add-CauClusterRole

Add-ClusterCheckpoint

Get-FsrmAdrSetting

Clear-HgsServer