Data ONTAP PowerShell Toolkit: Cmdlet Dismount-NcHostVolume

Overview
Categories
Cmdlets
APIs
Provider
Release notes
License
Data ONTAP® PowerShell Toolkit
Switch to Data ONTAP 7-mode documentation.
Cmdlet: Dismount-NcHostVolume


NAME
    Dismount-NaHostVolume
    
SYNOPSIS
    Remove one or all mount points from a Windows volume.
    
SYNTAX
    Dismount-NaHostVolume [-MountPoint] <String> [-Force] [<CommonParameters>]
    
    Dismount-NaHostVolume [-VdsId] <Guid> [-Force] [<CommonParameters>]
    
    
DESCRIPTION
    Remove one or all mount points from a Windows volume.
    
    This cmdlet must be run with administrative privileges.
    

PARAMETERS
    -MountPoint <String>
        An active drive letter (i.e. 'G') or folder mount point to remove from t
        he volume
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        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.  Specify this parameter di
        rectly or via the pipeline to remove all mount points from a single volu
        me.
        
        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>Dismount-NaHostVolume J:\
    
    
    Remove the drive letter J:\ from the volume.
    
    
    
    
    
    --------------  Example 2 --------------
    
    C:\PS>Get-NaHostVolume -DiskIndex 4 | Dismount-NaHostVolume
    
    
    Pass the volume object on the pipeline to remove all mount points (drive let
    ter & folders) from a volume.
    
    
    
    
    
    
RELATED LINKS
    New-NaHostVolume 
    Remove-NaHostVolume 
    Dismount-NaHostVolume 
    Get-NaHostVolume
Data ONTAP® PowerShell Toolkit