< Back
Set-VirtualDisk
Post
NAME Set-VirtualDisk
SYNOPSIS
Modifies the attributes of an existing virtual disk.
SYNTAX
Set-VirtualDisk [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit <Int32>] [-Usage {Other |
Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource | RemoteReplicaSource |
LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget | ElementComponent |
ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] -UniqueId <String> [<CommonParameters>]
Set-VirtualDisk [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>] [-IsManualAttach <Boolean>]
[-StorageNodeName <String>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-VirtualDisk [-FriendlyName] <String> [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>]
[-IsManualAttach <Boolean>] [-StorageNodeName <String>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-VirtualDisk [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>] [-IsManualAttach <Boolean>]
[-StorageNodeName <String>] [-ThrottleLimit <Int32>] -UniqueId <String> [<CommonParameters>]
Set-VirtualDisk [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>] [-IsManualAttach <Boolean>]
[-StorageNodeName <String>] [-ThrottleLimit <Int32>] -Name <String> [<CommonParameters>]
Set-VirtualDisk [-FriendlyName] <String> [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit
<Int32>] [-Usage {Other | Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource
| RemoteReplicaSource | LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget |
ElementComponent | ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] [<CommonParameters>]
Set-VirtualDisk [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit <Int32>] [-Usage {Other |
Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource | RemoteReplicaSource |
LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget | ElementComponent |
ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] -Name <String> [<CommonParameters>]
Set-VirtualDisk [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit <Int32>] [-Usage {Other |
Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource | RemoteReplicaSource |
LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget | ElementComponent |
ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
DESCRIPTION
The Set-VirtualDisk cmdlet modifies the attributes of an existing virtual disk.
PARAMETERS
-Access [<Access>]
Manages access permissions to the VirtualDisk object.
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.
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.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-IsManualAttach [<Boolean>]
Specifies that the object is set as manual-attach.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NumberOfDataCopies [<UInt16>]
Specifies the number of data copies to create. Specify 2 to create a two-way mirror, or 3 to specify a three-way mirror or for dual-parity.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-OtherUsageDescription [<String>]
Specifies the usage of this object.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PhysicalDiskRedundancy [<UInt16>]
Specifies the physical disk redundancy value to use during the creation of a virtual disk. This value represents how many failed physical disks the
virtual disk can tolerate without data loss. The redundancy values are as follows:
-- For two-way mirror spaces, the virtual disk can tolerate 1 failed physical disk without data loss.
-- For three-way mirror spaces, the virtual disk can tolerate 2 failed physical disks without data loss.
-- For single-parity spaces, the virtual disk can tolerate 1 failed physical disk without data loss.
-- For dual-parity spaces the virtual disk can tolerate 2 failed physical disks without data loss.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ProvisioningType [<Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.ProvisioningType>]
Specifies the type of provisioning. The acceptable values for this parameter are: Fixed and Thin. Specify Fixed for storage spaces that use storage
tiers or a clustered storage pool.
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.
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.
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.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Usage [<Usage>]
Specifies the intended usage.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk
http://msdn.microsoft.com/library/windo ... 30584.aspx
You can use the pipeline operator to pass an MSFT_VirtualDisk object to the InputObject parameter.
OUTPUTS
None
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816492
Connect-VirtualDisk
Disconnect-VirtualDisk
Get-VirtualDisk
Hide-VirtualDisk
New-VirtualDisk
Remove-VirtualDisk
Repair-VirtualDisk
Resize-VirtualDisk
Show-VirtualDisk
SYNOPSIS
Modifies the attributes of an existing virtual disk.
SYNTAX
Set-VirtualDisk [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit <Int32>] [-Usage {Other |
Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource | RemoteReplicaSource |
LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget | ElementComponent |
ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] -UniqueId <String> [<CommonParameters>]
Set-VirtualDisk [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>] [-IsManualAttach <Boolean>]
[-StorageNodeName <String>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-VirtualDisk [-FriendlyName] <String> [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>]
[-IsManualAttach <Boolean>] [-StorageNodeName <String>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-VirtualDisk [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>] [-IsManualAttach <Boolean>]
[-StorageNodeName <String>] [-ThrottleLimit <Int32>] -UniqueId <String> [<CommonParameters>]
Set-VirtualDisk [-Access {Unknown | Readable | Writeable | ReadWrite | WriteOnce}] [-CimSession <CimSession[]>] [-IsManualAttach <Boolean>]
[-StorageNodeName <String>] [-ThrottleLimit <Int32>] -Name <String> [<CommonParameters>]
Set-VirtualDisk [-FriendlyName] <String> [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit
<Int32>] [-Usage {Other | Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource
| RemoteReplicaSource | LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget |
ElementComponent | ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] [<CommonParameters>]
Set-VirtualDisk [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit <Int32>] [-Usage {Other |
Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource | RemoteReplicaSource |
LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget | ElementComponent |
ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] -Name <String> [<CommonParameters>]
Set-VirtualDisk [-CimSession <CimSession[]>] [-NewFriendlyName <String>] [-OtherUsageDescription <String>] [-ThrottleLimit <Int32>] [-Usage {Other |
Unrestricted | ReservedForComputerSystem | ReservedForReplicationServices | ReservedForMigrationServices | LocalReplicaSource | RemoteReplicaSource |
LocalReplicaTarget | RemoteReplicaTarget | LocalReplicaSourceOrTarget | RemoteReplicaSourceOrTarget | DeltaReplicaTarget | ElementComponent |
ReservedAsPoolContributer | CompositeVolumeMember | CompositeVirtualDiskMember | ReservedForSparing}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
Set-VirtualDisk [-NumberOfDataCopies <UInt16>] [-PhysicalDiskRedundancy <UInt16>] [-ProvisioningType {Thin | Fixed}] [<CommonParameters>]
DESCRIPTION
The Set-VirtualDisk cmdlet modifies the attributes of an existing virtual disk.
PARAMETERS
-Access [<Access>]
Manages access permissions to the VirtualDisk object.
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.
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.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-IsManualAttach [<Boolean>]
Specifies that the object is set as manual-attach.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NumberOfDataCopies [<UInt16>]
Specifies the number of data copies to create. Specify 2 to create a two-way mirror, or 3 to specify a three-way mirror or for dual-parity.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-OtherUsageDescription [<String>]
Specifies the usage of this object.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PhysicalDiskRedundancy [<UInt16>]
Specifies the physical disk redundancy value to use during the creation of a virtual disk. This value represents how many failed physical disks the
virtual disk can tolerate without data loss. The redundancy values are as follows:
-- For two-way mirror spaces, the virtual disk can tolerate 1 failed physical disk without data loss.
-- For three-way mirror spaces, the virtual disk can tolerate 2 failed physical disks without data loss.
-- For single-parity spaces, the virtual disk can tolerate 1 failed physical disk without data loss.
-- For dual-parity spaces the virtual disk can tolerate 2 failed physical disks without data loss.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ProvisioningType [<Microsoft.PowerShell.Cmdletization.GeneratedTypes.Set.ProvisioningType>]
Specifies the type of provisioning. The acceptable values for this parameter are: Fixed and Thin. Specify Fixed for storage spaces that use storage
tiers or a clustered storage pool.
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.
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.
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.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Usage [<Usage>]
Specifies the intended usage.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk
http://msdn.microsoft.com/library/windo ... 30584.aspx
You can use the pipeline operator to pass an MSFT_VirtualDisk object to the InputObject parameter.
OUTPUTS
None
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816492
Connect-VirtualDisk
Disconnect-VirtualDisk
Get-VirtualDisk
Hide-VirtualDisk
New-VirtualDisk
Remove-VirtualDisk
Repair-VirtualDisk
Resize-VirtualDisk
Show-VirtualDisk