Edit

Set-VirtualDisk

  • Reference
Module:
Storage

Modifies the attributes of an existing virtual disk.

Syntax

Set-VirtualDisk
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-NewFriendlyName <String>]
   [-OtherUsageDescription <String>]
   [-ThrottleLimit <Int32>]
   [-Usage <Usage>]
   -UniqueId <String>
Set-VirtualDisk
   [-Access <Access>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IsManualAttach <Boolean>]
   [-ThrottleLimit <Int32>]
   -Name <String>
Set-VirtualDisk
   [-Access <Access>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IsManualAttach <Boolean>]
   [-ThrottleLimit <Int32>]
   -UniqueId <String>
Set-VirtualDisk
   [-InputObject] <CimInstance[]>
   [-Access <Access>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IsManualAttach <Boolean>]
   [-ThrottleLimit <Int32>]
Set-VirtualDisk
   [-FriendlyName] <String>
   [-Access <Access>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IsManualAttach <Boolean>]
   [-ThrottleLimit <Int32>]
Set-VirtualDisk
   [-InputObject] <CimInstance[]>
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-NewFriendlyName <String>]
   [-OtherUsageDescription <String>]
   [-ThrottleLimit <Int32>]
   [-Usage <Usage>]
Set-VirtualDisk
   [-FriendlyName] <String>
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-NewFriendlyName <String>]
   [-OtherUsageDescription <String>]
   [-ThrottleLimit <Int32>]
   [-Usage <Usage>]
Set-VirtualDisk
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-NewFriendlyName <String>]
   [-OtherUsageDescription <String>]
   [-ThrottleLimit <Int32>]
   [-Usage <Usage>]
   -Name <String>

Description

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

Examples

EXAMPLE 1

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

This example changes the friendly name of a virtual disk.

EXAMPLE 2

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

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

Parameters

-Access

Manages access permissions to the VirtualDisk object.

Type:Access
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Accepts an object from the pipeline as input.

Type:CimInstance[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IsManualAttach

Specifies that the object is set as manual-attach.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of an object or setting.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NewFriendlyName

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OtherUsageDescription

Specifies the usage of this object.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UniqueId

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

Type:String
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Usage

Specifies the intended usage.

Type:Usage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

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

None