Storage

This reference provides cmdlet descriptions and syntax for all Windows Storage Management-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

storage

Add-​Initiator​Id​To​Masking​Set

Adds an initiator ID to an existing masking set, granting the host associated with the initiator ID access to the virtual disk and target port resources defined in the masking set.

Add-​Partition​Access​Path

Adds an access path such as a drive letter or folder to a partition.

Add-​Physical​Disk

Adds a physical disk to the specified storage pool or manually assigns a physical disk to a specific virtual disk.

Add-​Target​Port​To​Masking​Set

Adds one or more target ports to a specified masking set, allowing a connection between the target ports, and any virtual disks and initiator IDs that the masking set contains.

Add-​Virtual​Disk​To​Masking​Set

Adds a virtual disk to a specified masking set and grants access to the virtual disk to all initiator IDs defined in the masking set.

Block-​File​Share​Access

Blocks access to a file share.

Clear-​Disk

Cleans a disk by removing all partition information and un-initializing it, erasing all data on the disk.

Clear-​File​Storage​Tier

Unpins a file from the specified storage tier.

Connect-​Virtual​Disk

Connects a disconnected virtual disk to the specified computer when using the Windows Storage subsystem.

Debug-​File​Share

Finds problems with a file share and recommends solutions.

Debug-​Storage​Sub​System

Finds problems with a storage subsystem and recommends solutions.

Debug-​Volume

Finds problems with a volume and recommends solutions.

Disable-​Physical​Disk​Identification

Turns off the identification LED on the specified physical disk.

Disable-​Storage​Enclosure​Identification

Turns off the identification LED on a storage enclosure or the slots for individual disks.

Disable-​Storage​High​Availability

Disables a Storage resource.

Disable-​Storage​Maintenance​Mode

Disables storage maintenance mode on a fault domain.

Disconnect-​Virtual​Disk

Disconnects a virtual disk from the specified computer, revoking access to the virtual disk.

Dismount-​Disk​Image

Dismounts a disk image (virtual hard disk or ISO) so that it can no longer be accessed as a disk.

Enable-​Physical​Disk​Identification

Enables the identification LED on the specified physical disk.

Enable-​Storage​Enclosure​Identification

Enables the identification LED on a storage enclosure or the slots for individual disks.

Enable-​Storage​High​Availability

Enables a disk to be added to the failover cluster.

Enable-​Storage​Maintenance​Mode

Enables storage maintenance mode on a device.

Format-​Volume

Formats one or more existing volumes or a new volume on an existing partition.

Get-​Dedup​Properties

Gets Data Deduplication information.

Get-​Disk

Gets one or more disks visible to the operating system.

Get-​Disk​Image

Gets one or more disk image objects (virtual hard disk or ISO).

Get-​Disk​Storage​Node​View

Gets the view of a disk from a storage node.

Get-​File​Integrity

Gets integrity information for a file on an ReFS volume.

Get-​File​Share

Retrieves file share objects and their properties.

Get-​File​Share​Access​Control​Entry

Retrieves an access control entry for the share corresponding to a single account.

Get-​File​Storage​Tier

Gets the files assigned to a Storage tier on a volume, and their status.

Get-​Initiator​Id

Gets the InitiatorID objects for the specified iSCSI initiators.

Get-​Initiator​Port

Gets one or more host bus adapter (HBA) initiator ports.

Get-​Masking​Set

Gets masking sets.

Get-​Offload​Data​Transfer​Setting

Returns offloaded data transfer (ODX) settings for the specified subsystem.

Get-​Partition

Returns a list of all partition objects visible on all disks, or optionally a filtered list using specified parameters.

Get-​Partition​Supported​Size

Returns information on supported partition sizes for the specified Disk object.

Get-​Physical​Disk

Gets a list of all PhysicalDisk objects visible across any available Storage Management Providers, or optionally a filtered list.

Get-​Physical​Disk​Storage​Node​View

Gets the node view of a physical disk.

Get-​Physical​Extent

Gets physical allocations for a physical disk, storage tier, or virtual disk.

Get-​Physical​Extent​Association

Gets the physical disk, storage tier, or virtual disk that is associated with a physical extent.

Get-​Resiliency​Setting

Gets the resiliency settings (also known as storage layouts) available for creating virtual disks on the specified storage subsystem.

Get-​Storage​Advanced​Property

Gets the advanced properties on a storage device.

Get-​Storage​Diagnostic​Info

Gets Storage diagnostic information.

Get-​Storage​Enclosure

Gets storage enclosures.

Get-​Storage​Enclosure​Storage​Node​View

Gets the node view of a Storage enclosure.

Get-​Storage​Enclosure​Vendor​Data

Gets vendor-specific data for an enclosure.

Get-​Storage​Fault​Domain

Gets a Storage fault domain object.

Get-​Storage​File​Server

Gets a storage file server.

Get-​Storage​Firmware​Information

Gets information about firmware on a storage object.

Get-​Storage​Health​Action

Gets health-related system activities.

Get-​Storage​Health​Report

Gets a storage health report.

Get-​Storage​Health​Setting

Gets storage health service settings.

Get-​Storage​Job

Returns information about long-running Storage module jobs, such as a repair task.

Get-​Storage​Node

Gets storage nodes.

Get-​Storage​Pool

Gets a specific storage pool, or a set of StoragePool objects either from all storage subsystems across all storage providers, or optionally a filtered subset based on specific parameters.

Get-​Storage​Provider

Returns a list of the storage providers available on the local computer.

Get-​Storage​Reliability​Counter

Gets storage reliability counters.

Get-​Storage​Setting

Gets a StorageSettings object.

Get-​Storage​Subsystem

Gets one or more StorageSubsystem objects.

Get-​Storage​Tier

Gets storage tiers on Windows Storage subsystems.

Get-​Storage​Tier​Supported​Size

Gets the minimum and maximum possible sizes of a storage tier.

Get-​Supported​Cluster​Sizes

Gets the supported cluster sizes.

Get-​Supported​File​Systems

Gets the file system choices for a specified volume.

Get-​Target​Port

Returns a TargetPort object associated with a specific port address and connection type.

Get-​Target​Portal

Returns a TargetPortal object.

Get-​Virtual​Disk

Returns a list of VirtualDisk objects, across all storage pools, across all providers, or optionally a filtered subset based on provided criteria.

Get-​Virtual​Disk​Supported​Size

Returns all sizes supported by a storage pool for virtual disk creation based on the specified resiliency setting name.

Get-​Volume

Gets the specified Volume object, or all Volume objects if no filter is provided.

Get-​Volume​Corruption​Count

Gets a count of the file system errors on the NTFS volume.

Get-​Volume​Scrub​Policy

Gets the status of the volume scrub policy.

Grant-​File​Share​Access

Grants access to a file share.

Hide-​Virtual​Disk

Hides the virtual disk from the host when the Storage Management Provider in use does not support masking sets.

Initialize-​Disk

Initializes a RAW disk for first time use, enabling the disk to be formatted and used to store data.

Mount-​Disk​Image

Mounts a previously created disk image (virtual hard disk or ISO), making it appear as a normal disk.

New-​File​Share

Creates an access point for a remote file share.

New-​Masking​Set

Creates a new masking set.

New-​Partition

Creates a new partition on an existing Disk object.

New-​Storage​File​Server

Creates a storage file server.

New-​Storage​Pool

Creates a new storage pool using a group of physical disks.

New-​Storage​Subsystem​Virtual​Disk

Allows the creation of a VirtualDisk object on a storage subsystem that does not support creation of storage pools.

New-​Storage​Tier

Creates a storage tier.

New-​Virtual​Disk

Creates a new virtual disk in the specified storage pool.

New-​Virtual​Disk​Clone

Creates a new clone of a specified virtual disk.

New-​Virtual​Disk​Snapshot

Creates a new snapshot of the specified virtual disk.

New-​Volume

Creates a volume with the specified file system.

Optimize-​Storage​Pool

Optimizes a Storage pool.

Optimize-​Volume

Optimizes a volume.

Register-​Storage​Subsystem

Connects to storage subsystems on a remote computer.

Remove-​File​Share

Removes a file share.

Remove-​Initiator​Id

Removes an initiator identifier (ID).

Remove-​Initiator​Id​From​Masking​Set

Removes an initiator identifier (ID) from a masking set.

Remove-​Masking​Set

Removes a masking set.

Remove-​Partition

Deletes the specified Partition object on an existing disk and any underlying Volume objects.

Remove-​Partition​Access​Path

Removes an access path such as a drive letter or folder from a partition.

Remove-​Physical​Disk

Removes a physical disk from a specified storage pool.

Remove-​Storage​File​Server

Removes a file server.

Remove-​Storage​Health​Setting

Removes a storage health service setting.

Remove-​Storage​Pool

Deletes a storage pool and associated VirtualDisk objects.

Remove-​Storage​Tier

Removes storage tiers from a storage pool.

Remove-​Target​Port​From​Masking​Set

Removes a specified target port from a masking set.

Remove-​Virtual​Disk

Deletes an existing virtual disk and reclaims the used space for use by other virtual disks in the same storage pool.

Remove-​Virtual​Disk​From​Masking​Set

Removes a virtual disk from a specified masking set to block access to the virtual disk by an InitiatorIds object defined in the masking set.

Rename-​Masking​Set

Renames an existing masking set.

Repair-​File​Integrity

Repairs a corrupted file on an NTFS or ReFS volume.

Repair-​Virtual​Disk

Performs repairs on a virtual disk that is unhealthy.

Repair-​Volume

Performs repairs on a volume.

Reset-​Physical​Disk

Resets the status of a physical disk.

Reset-​Storage​Reliability​Counter

Resets storage reliability counters for a disk.

Resize-​Partition

Resizes a partition and the underlying file system.

Resize-​Storage​Tier

Increases the size of storage tiers.

Resize-​Virtual​Disk

Resizes an existing virtual disk to be larger or smaller.

Revoke-​File​Share​Access

Revokes access to a file share.

Set-​Disk

Takes a Disk object or unique disk identifiers and a set of attributes, and updates the physical disk on the system.

Set-​File​Integrity

Sets integrity for a file on an ReFS volume.

Set-​File​Share

Modifies a file share.

Set-​File​Storage​Tier

Assigns a file to a storage tier.

Set-​Initiator​Port

Sets properties on the InitiatorPort object.

Set-​Partition

Sets attributes of a partition, such as active, read-only, and offline states.

Set-​Physical​Disk

Sets attributes on a specific physical disk.

Set-​Resiliency​Setting

Modifies the properties of the specified resiliency setting name.

Set-​Storage​File​Server

Modifies a storage file server.

Set-​Storage​Health​Setting

Modifies a storage health service setting.

Set-​Storage​Pool

Modifies the properties of the specified storage pool.

Set-​Storage​Provider

Modifies whether to enable the SMP provider cache.

Set-​Storage​Setting

Adjusts or configures current storage settings of the StorageSetting object.

Set-​Storage​Subsystem

Modifies the properties of a StorageSubsystem object.

Set-​Storage​Tier

Modifies a storage tier.

Set-​Virtual​Disk

Modifies the attributes of an existing virtual disk.

Set-​Volume

Sets or changes the file system label of an existing volume.

Set-​Volume​Scrub​Policy

Sets the status of the volume scrub policy.

Show-​Virtual​Disk

Makes a virtual disk available to a host.

Start-​Storage​Diagnostic​Log

Starts Storage diagnostic logging.

Stop-​Storage​Diagnostic​Log

Stops a Storage diagnostic log.

Stop-​Storage​Job

Stops storage job.

Unblock-​File​Share​Access

Unblocks access to a file share.

Unregister-​Storage​Subsystem

Disconnects from storage subsystems on a remote computer.

Update-​Disk

Updates cached information about the specified Disk object only

Update-​Host​Storage​Cache

Initiates an update on the host storage cache to reflect the current status of storage.

Update-​Storage​Firmware

Updates the firmware on a storage device.

Update-​Storage​Pool

Updates the metadata of a Windows Server 2012 R2 storage pool.

Update-​Storage​Provider​Cache

Updates the cache of the service for a particular provider and associated child objects.

Write-​Volume​Cache

Writes the file system cache to disk.