Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-VirtualDisk

Set-VirtualDisk

storagecmdlets.cdxml

Synopsis

Modifies the attributes of an existing virtual disk.

Syntax

Set-VirtualDisk [-AsJob] [-CimSession] [-NewFriendlyName] [-OtherUsageDescription] [-ThrottleLimit] [-Usage] [-UniqueId] [<CommonParameters>]

Set-VirtualDisk [-InputObject] [-Access] [-AsJob] [-CimSession] [-IsManualAttach] [-StorageNodeName] [-ThrottleLimit] [<CommonParameters>]

Set-VirtualDisk [-FriendlyName] [-Access] [-AsJob] [-CimSession] [-IsManualAttach] [-StorageNodeName] [-ThrottleLimit] [<CommonParameters>]

Set-VirtualDisk [-Access] [-AsJob] [-CimSession] [-IsManualAttach] [-StorageNodeName] [-ThrottleLimit] [-UniqueId] [<CommonParameters>]

Set-VirtualDisk [-Access] [-AsJob] [-CimSession] [-IsManualAttach] [-StorageNodeName] [-ThrottleLimit] [-Name] [<CommonParameters>]

Set-VirtualDisk [-AsJob] [-CimSession] [-NewFriendlyName] [-OtherUsageDescription] [-ThrottleLimit] [-Usage] [-Name] [<CommonParameters>]

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

Set-VirtualDisk [-InputObject] [-AsJob] [-CimSession] [-NewFriendlyName] [-OtherUsageDescription] [-ThrottleLimit] [-Usage] [<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 <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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 a VirtualDisk 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 the virtual disk to modify.

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

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

-StorageNodeName <String>

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.

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 the unique ID of the virtual disk to modify.

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

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

Return Type

None

Notes

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

Online Version
Connect-VirtualDisk
Disconnect-VirtualDisk
Get-VirtualDisk
Hide-VirtualDisk
New-VirtualDisk
Remove-VirtualDisk
Repair-VirtualDisk
Resize-VirtualDisk
Show-VirtualDisk