Set-PhysicalDisk
Sets attributes on a specific physical disk.
Syntax
Set-PhysicalDisk
[-NewFriendlyName <String>]
[-Description <String>]
[-Usage <Usage>]
[-MediaType <MediaType>]
-UniqueId <String>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Set-PhysicalDisk
-InputObject <CimInstance[]>
[-NewFriendlyName <String>]
[-Description <String>]
[-Usage <Usage>]
[-MediaType <MediaType>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Set-PhysicalDisk
[-NewFriendlyName <String>]
[-Description <String>]
[-Usage <Usage>]
[-MediaType <MediaType>]
[-FriendlyName] <String>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Set-PhysicalDisk cmdlet sets attributes on a specific physical disk in a storage pool, other than the primordial pool when using Storage Spaces.
When using the Windows Storage subsystem, this cmdlet only works on physical disks that have been added to a storage pool.
Examples
Example 1: Change the friendly name of a physical disk
PS C:\>Set-PhysicalDisk -FriendlyName "PhysicalDisk4" -NewFriendlyName "PhysicalDiskInSlot5"This example changes the friendly name of PhysicalDisk4 to PhysicalDiskInSlot5.
Example 2: Change the Usage of a physical disk
PS C:\>Set-PhysicalDisk -FriendlyName PhysicalDisk2 -Usage AutoSelectThis example changes the Usage property of PhysicalDisk2 to AutoSelect.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| 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-CimSession or Get-CimSession 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 |
-Description
Sets the description of the specified physical disk.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FriendlyName
Specifies the friendly name of the physical disk on which to set attributes.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MediaType
Specifies a media type. The cmdlet changes the media type that is associated with physical disk to the media type that you specify. The acceptable values for this parameter are:
- SSD
- HDD
| Type: | MediaType |
| Accepted values: | HDD, SSD, SCM |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewFriendlyName
Specifies the new friendly name of the physical disk.
| 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 the UniqueID of the physical disk on which to set attributes.
| Type: | String |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Usage
Specifies the allocation method (usage) for the disk. Valid values are AutoSelect, HotSpare, Journal, ManualSelect, Retired, and Unknown.
| Type: | Usage |
| Accepted values: | AutoSelect, ManualSelect, HotSpare, Retired, Journal |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
You can use the pipeline operator to pass an MSFT_PhysicalDisk object to the InputObject parameter.
Outputs
None
Notes
- When using the Windows Storage subsystem, this cmdlet works only on physical disks that have been added to a storage pool.
- The
Microsoft.Management.Infrastructure.CimInstanceobject 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. - When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).s