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

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

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

Add-PhysicalDisk

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

Add-TargetPortToMaskingSet

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

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

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

Unpins a file from the specified storage tier.

Connect-VirtualDisk

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

Debug-FileShare

Finds problems with a file share and recommends solutions.

Debug-StorageSubSystem

Finds problems with a storage subsystem and recommends solutions.

Debug-Volume

Finds problems with a volume and recommends solutions.

Disable-PhysicalDiskIdentification

Turns off the identification LED on the specified physical disk.

Disable-StorageEnclosureIdentification

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

Disable-StorageHighAvailability

Disables a Storage resource.

Disable-StorageMaintenanceMode

Disables storage maintenance mode on a fault domain.

Disconnect-VirtualDisk

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

Dismount-DiskImage

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

Enable-PhysicalDiskIdentification

Enables the identification LED on the specified physical disk.

Enable-StorageEnclosureIdentification

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

Enable-StorageHighAvailability

Enables a disk to be added to the failover cluster.

Enable-StorageMaintenanceMode

Enables storage maintenance mode on a device.

Format-Volume

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

Get-DedupProperties

Gets Data Deduplication information.

Get-Disk

Gets one or more disks visible to the operating system.

Note

This cmdlet returns physical disk objects like basic disks and partitioned drive partitions. Dynamic disks can span multiple pieces of physical media, so they will not be returned by Get-Disk. For more information, see Basic and Dynamic Disks.

Get-DiskImage

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

Get-DiskStorageNodeView

Gets the view of a disk from a storage node.

Get-FileIntegrity

Gets integrity information for a file on an ReFS volume.

Get-FileShare

Retrieves file share objects and their properties.

Get-FileShareAccessControlEntry

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

Get-FileStorageTier

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

Get-InitiatorId

Gets the InitiatorID objects for the specified iSCSI initiators.

Get-InitiatorPort

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

Get-MaskingSet

Gets masking sets. Masking sets are used to grant access to a virtual disk or iSCSI VHD for one or more servers.

Get-OffloadDataTransferSetting

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

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

Get-PhysicalDisk

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

Get-PhysicalDiskStorageNodeView

Gets the node view of a physical disk.

Get-PhysicalExtent

This cmdlet gets physical allocations for a physical disk, storage tier, or virtual disk. The "extent" (also known as "allocation" or "slab") is the area on a pooled disk containing one fragment of data for storage space.

Get-PhysicalExtentAssociation

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

Get-ResiliencySetting

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

Get-StorageAdvancedProperty

Gets the advanced properties on a storage device.

Get-StorageDiagnosticInfo

Gets Storage diagnostic information.

Get-StorageEnclosure

Gets storage enclosures.

Get-StorageEnclosureStorageNodeView

Gets the node view of a Storage enclosure.

Get-StorageEnclosureVendorData

Gets vendor-specific data for an enclosure.

Get-StorageFaultDomain

Gets a Storage fault domain object.

Get-StorageFileServer

Gets a storage file server.

Get-StorageFirmwareInformation

Gets information about firmware on a storage object.

Get-StorageHealthAction

Gets health-related system activities.

Get-StorageHealthReport

Gets a storage health report.

Get-StorageHealthSetting

Gets storage health service settings.

Get-StorageJob

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

Get-StorageNode

Gets storage nodes.

Get-StoragePool

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

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

Get-StorageReliabilityCounter

Gets storage reliability counters.

Get-StorageSetting

Gets a StorageSetting object.

Get-StorageSubSystem

Gets one or more StorageSubSystem objects.

Get-StorageTier

Gets storage tiers on Windows Storage subsystems.

Get-StorageTierSupportedSize

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

Get-SupportedClusterSizes

Gets the supported cluster sizes.

Get-SupportedFileSystems

Gets the file system choices for a specified volume.

Get-TargetPort

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

Get-TargetPortal

Returns a TargetPortal object.

Get-VirtualDisk

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

Get-VirtualDiskSupportedSize

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

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

Get-VolumeScrubPolicy

Gets the status of the volume scrub policy.

Grant-FileShareAccess

Grants access to a file share.

Hide-VirtualDisk

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

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

New-FileShare

Creates an access point for a remote file share.

New-MaskingSet

Creates a new masking set.

New-Partition

Creates a new partition on an existing Disk object.

New-StorageFileServer

Creates a storage file server.

New-StoragePool

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

New-StorageSubsystemVirtualDisk

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

New-StorageTier

Creates a storage tier.

New-VirtualDisk

Creates a new virtual disk in the specified storage pool.

New-VirtualDiskClone

Creates a new clone of a specified virtual disk.

New-VirtualDiskSnapshot

Creates a new snapshot of the specified virtual disk.

New-Volume

Creates a volume with the specified file system.

Optimize-StoragePool

Optimizes a Storage pool.

Optimize-Volume

Optimizes a volume.

Register-StorageSubsystem

Connects to storage subsystems on a remote computer.

Remove-FileShare

Removes a file share.

Remove-InitiatorId

Removes an initiator identifier (ID).

Remove-InitiatorIdFromMaskingSet

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

Remove-MaskingSet

Removes a masking set.

Remove-Partition

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

Remove-PartitionAccessPath

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

Remove-PhysicalDisk

Removes a physical disk from a specified storage pool.

Remove-StorageFileServer

Removes a file server.

Remove-StorageHealthSetting

Removes a storage health service setting.

Remove-StoragePool

Deletes a storage pool and associated VirtualDisk objects.

Remove-StorageTier

Removes storage tiers from a storage pool.

Remove-TargetPortFromMaskingSet

Removes a specified target port from a masking set.

Remove-VirtualDisk

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

Remove-VirtualDiskFromMaskingSet

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

Renames an existing masking set.

Repair-FileIntegrity

Repairs a corrupted file on an NTFS or ReFS volume.

Repair-VirtualDisk

Performs repairs on a virtual disk that is unhealthy.

Repair-Volume

Performs repairs on a volume.

Reset-PhysicalDisk

Resets the status of a physical disk.

Reset-StorageReliabilityCounter

Resets storage reliability counters for a disk.

Resize-Partition

Resizes a partition and the underlying file system.

Resize-StorageTier

Increases the size of storage tiers.

Resize-VirtualDisk

Resizes an existing virtual disk to be larger or smaller.

Revoke-FileShareAccess

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

Sets integrity for a file on an ReFS volume.

Set-FileShare

Modifies a file share.

Set-FileStorageTier

Assigns a file to a storage tier.

Set-InitiatorPort

Sets properties on the InitiatorPort object.

Set-Partition

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

Set-PhysicalDisk

Sets attributes on a specific physical disk.

Set-ResiliencySetting

Modifies the properties of the specified resiliency setting name.

Set-StorageFileServer

Modifies a storage file server.

Set-StorageHealthSetting

Modifies a storage health service setting.

Set-StoragePool

Modifies the properties of the specified storage pool.

Set-StorageProvider

Modifies whether to enable the SMP provider cache.

Set-StorageSetting

Adjusts or configures current storage settings of the StorageSetting object.

Set-StorageSubSystem

Modifies the properties of a StorageSubSystem object.

Set-StorageTier

Modifies a storage tier.

Set-VirtualDisk

Modifies the attributes of an existing virtual disk.

Set-Volume

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

Set-VolumeScrubPolicy

Sets the status of the volume scrub policy.

Show-VirtualDisk

Makes a virtual disk available to a host.

Start-StorageDiagnosticLog

Starts Storage diagnostic logging.

Stop-StorageDiagnosticLog

Stops a Storage diagnostic log.

Stop-StorageJob

Stops storage job.

Unblock-FileShareAccess

Unblocks access to a file share.

Unregister-StorageSubsystem

Disconnects from storage subsystems on a remote computer.

Update-Disk

Updates cached information about the specified Disk object only

Update-HostStorageCache

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

Update-StorageFirmware

Updates the firmware on a storage device.

Update-StoragePool

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

Update-StorageProviderCache

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

Write-VolumeCache

Writes the file system cache to disk.