Edit

Share via

Set-PhysicalDisk

Module:
Storage Module

Sets attributes on a specific physical disk.

Syntax

ByUniqueId (Default) 

Set-PhysicalDisk
    -UniqueId <String>
    [-NewFriendlyName <String>]
    [-Description <String>]
    [-Usage <Usage>]
    [-MediaType <MediaType>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByObject 

Set-PhysicalDisk
    -InputObject <CimInstance[]>
    [-NewFriendlyName <String>]
    [-Description <String>]
    [-Usage <Usage>]
    [-MediaType <MediaType>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByFriendlyName 

Set-PhysicalDisk
    [-FriendlyName] <String>
    [-NewFriendlyName <String>]
    [-Description <String>]
    [-Usage <Usage>]
    [-MediaType <MediaType>]
    [-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 AutoSelect

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Sets the description of the specified physical disk.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FriendlyName

Specifies the friendly name of the physical disk on which to set attributes.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByFriendlyName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InputObject

Specifies the input object that is used in a pipeline command.

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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

Parameter properties

Type:MediaType
Default value:None
Accepted values:HDD, SSD, SCM
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewFriendlyName

Specifies the new friendly name of the physical disk.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UniqueId

Specifies the UniqueID of the physical disk on which to set attributes.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id

Parameter sets

ByUniqueId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Usage

Specifies the allocation method (usage) for the disk. Valid values are AutoSelect, HotSpare, Journal, ManualSelect, Retired, and Unknown.

Parameter properties

Type:Usage
Default value:None
Accepted values:AutoSelect, ManualSelect, HotSpare, Retired, Journal
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

CimInstance

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.
  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).s