Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Format-NcHostVolume


NAME
Format-NaHostVolume

SYNOPSIS
Perform a quick NTFS format on an existing Windows volume. Optionally, this
can trigger a reclaim of any data previously held by the volume.

SYNTAX
Format-NaHostVolume [-Path] <String> [[-Label] <String>] [[-AllocationUnitSi
ze] <Int32>] [-Reclaim] [-Force] [<CommonParameters>]

Format-NaHostVolume [-VdsId] <Guid> [[-Label] <String>] [[-AllocationUnitSiz
e] <Int32>] [-Reclaim] [-Force] [<CommonParameters>]


DESCRIPTION
Perform a quick NTFS format on an existing Windows volume. Optionally, this
can trigger a reclaim of any data previously held by the volume.


This cmdlet must be run with administrative privileges.


PARAMETERS
-Path <String>
The mount point (i.e. G:, \\?\Volume{12345678-abcd-1234-abcd-1234567890a
b}\) or a path to any file on the volume to process

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Label <String>
The label to assign the volume

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-AllocationUnitSize <Int32>
The allocation unit (cluster) size for the volume. Valid values are 4KB
, 8KB, 16KB, 32KB, and 64KB

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Reclaim
Free any blocks which formerly occupied the space used by the new volume
. This option is only supported on Windows Vista sp1, Server 2008 or la
ter.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force
Continue even if volume is in use. This might cause unexpected errors in
any application using this volume.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VdsId <Guid>
The Guid object which uniquely identifies the volume in VDS. Note that
this is not the same as the volume guid path.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.PowerShell.SDK.Cmdlets.Toolkit.Windows.HostVolume


NOTES


Category: host

-------------- Example 1 --------------

C:\PS>Format-NaHostVolume F:\


Format the volume mounted at drive F:\ with default options.





-------------- Example 2 --------------

C:\PS>Format-NaHostVolume "\\?\Volume{20a7fe7b-f8e4-11e0-949b-00155da1ce00}\
" -Label "DB Logs" -Reclaim


Format a volume by Guid path with a file system label. Reclaim any previous
ly used space on the storage controller.






RELATED LINKS







 Data ONTAP® PowerShell Toolkit