Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Dismount-NcVol


NAME
Dismount-NcVol

SYNOPSIS
Unmount a volume from its parent volume and delete the junction path at whic
h the volume is mounted.

SYNTAX
Dismount-NcVol [-Name] <String> [-Force] [-VserverContext <String>] [-Contro
ller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Unmount a volume from its parent volume and delete the junction path at whic
h the volume is mounted.


PARAMETERS
-Name <String>
The name of the volume.

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

-Force
This specifies whether the volume unmount operation is forced or not. T
he default value is false. Under certain circumstances, such as an unex
pected reboot while in the middle of unmounting, the unmount operation m
ight find that after the reboot, it is unable to delete the junction pat
h at which the volume is mounted in the file system. In this situation,
if the force option is set to false, the unmount operation is failed, l
eaving the junction path information intact in the Volume Management Dat
abase. Instead, if the force option is set to true, the unmount operatio
n proceeds to delete the junction path information in the Volume Managem
ent Database, irrespective of any failure to delete the junction path in
the file system.

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

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

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

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

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

-WhatIf


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

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
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.C.Types.Volume.VolumeAttributes


NOTES


Category: volume
API: volume-unmount
Family: vserver

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

C:\PS>Dismount-NcVol vol2


Remove junction path from volume 'vol2'.


Name State TotalSize Used Available Dedupe Aggregate Vserver
---- ----- --------- ---- --------- ------ --------- -------
vol2 online 10.0 GB 5% 9.5 GB False aggr1 vserver1



RELATED LINKS
Mount-NcVol







 Data ONTAP® PowerShell Toolkit