Set-PhysicalDisk
Set-PhysicalDisk
Sets attributes on a specific physical disk.
Syntax
Parameter Set: ByUniqueId
Set-PhysicalDisk -UniqueId <String> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [-Usage <Usage> ] [ <CommonParameters>]
Parameter Set: ByFriendlyName
Set-PhysicalDisk [-FriendlyName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [-Usage <Usage> ] [ <CommonParameters>]
Parameter Set: ByObject
Set-PhysicalDisk -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-NewFriendlyName <String> ] [-ThrottleLimit <Int32> ] [-Usage <Usage> ] [ <CommonParameters>]
Detailed Description
The Set-PhysicalDisk cmdlet sets attributes on a specific physical disk.
Parameters
-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 |
-Description<String>
Sets the description of the specified physical disk.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FriendlyName<String>
Specifies the friendly name of the physical disk on which to set attributes.
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? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-NewFriendlyName<String>
Specifies the new friendly name of the physical 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 UniqueID of the physical disk on which to set attributes.
Aliases |
Id |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Usage<Usage>
Specifies the allocation method (usage) for the disk. Valid values are AutoSelect, HotSpare, Journal, ManualSelect, Retired, and Unknown.
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_PhysicalDisk
You can pipe an MSFT_PhysicalDisk object to the InputObject parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Notes
When using the Storage Spaces subsystem, Set-PhysicalDisk only works on physical disks that have been added to a storage pool.
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.
Examples
Example 1: Change the friendly name of a physical disk
This example changes the friendly name of PhysicalDisk4 to PhysicalDiskInSlot5.
PS C:\> Set-PhysicalDisk -FriendlyName "PhysicalDisk4" -NewFriendlyName "PhysicalDiskInSlot5"
Example 2: Change the Usage of a physical disk
This example changes the Usage property of PhysicalDisk2 to AutoSelect.
PS C:\> Set-PhysicalDisk -FriendlyName PhysicalDisk2 -Usage AutoSelect