< Back

Set-PhysicalDisk

Wed Jan 30, 2019 6:04 pm

NAME Set-PhysicalDisk



SYNOPSIS

Sets attributes on a specific physical disk.





SYNTAX

Set-PhysicalDisk [-CimSession <CimSession[]>] [-Description <String>] [-MediaType {HDD | SSD | SCM}] [-NewFriendlyName <String>] [-ThrottleLimit

<Int32>] [-Usage {AutoSelect | ManualSelect | HotSpare | Retired | Journal}] -UniqueId <String> [<CommonParameters>]



Set-PhysicalDisk [-FriendlyName] <String> [-CimSession <CimSession[]>] [-Description <String>] [-MediaType {HDD | SSD | SCM}] [-NewFriendlyName

<String>] [-ThrottleLimit <Int32>] [-Usage {AutoSelect | ManualSelect | HotSpare | Retired | Journal}] [<CommonParameters>]



Set-PhysicalDisk [-CimSession <CimSession[]>] [-Description <String>] [-MediaType {HDD | SSD | SCM}] [-NewFriendlyName <String>] [-ThrottleLimit

<Int32>] [-Usage {AutoSelect | ManualSelect | HotSpare | Retired | Journal}] [<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.





PARAMETERS

-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



-Description [<String>]

Sets the description of the specified physical disk.



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.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MediaType [<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



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-NewFriendlyName [<String>]

Specifies the new friendly name of the physical 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 UniqueID of the physical disk on which to set attributes.



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.



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_PhysicalDisk

http://msdn.microsoft.com/library/windo ... 30532.aspx





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



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 AutoSelect



This example changes the Usage property of PhysicalDisk2 to AutoSelect.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=816483

Add-PhysicalDisk

Get-PhysicalDiskStorageNodeView

Remove-PhysicalDisk

Reset-PhysicalDisk