Remove-DfsnFolder

Removes a DFS namespace folder.

Syntax

Remove-DfsnFolder
      [-Path] <String>
      [-Force]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-DfsnFolder cmdlet removes a Distributed File System (DFS) namespace folder. When you remove a folder, this cmdlet deletes all the folder targets for the folder. This cmdlet does not delete the folders specified by DFS namespace targets or the files in those folders.

If you remove the last folder within a parent directory, the cmdlet removes the parent folder as well, unless it is the DFS namespace root. To remove a DFS namespace root, use the Remove-DfsnRoot cmdlet.

For more information about DFS namespaces, see Overview of DFS Namespaces on TechNet.

Examples

Example 1: Remove a DFS namespace folder

Remove-DfsnFolder -Path '\\Contoso\AccountingResources\LegacySoftware'

This command removes the DFS namespace folder \\Contoso\AccountingResources\LegacySoftware.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Removes a DFS namespace folder without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Specifies the path for a DFS namespace folder. This cmdlet removes the folder that has the path specified.

Type:String
Aliases:DfsPath, FolderPath, NamespacePath
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

Object