Remove-DfsnFolderTarget

Removes a target for a DFS namespace folder.

Syntax

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

Description

The Remove-DfsnFolderTarget cmdlet removes a target for a Distributed File System (DFS) namespace folder. A folder target is the Universal Naming Convention (UNC) path of a shared folder or another namespace associated with a folder in a namespace. The folder target is where data and content is stored. This cmdlet deletes a target, but does not delete the contents of the folder target.

A DFS namespace folder can have more than one target. If you remove the last target associated with a DFS namespace folder, this cmdlet deletes the namespace folder as well. Users cannot use the DFS namespace folder after you delete it.

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

Examples

Example 1: Remove a folder target

Remove-DfsnFolderTarget -Path '\\Contoso\AccountingResources\LegacySoftware' -TargetPath '\\Contoso-FS\LegacySoftware'

This command removes the target \\Contoso-FS\LegacySoftware for 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 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 the DFS namespace folder.

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

-TargetPath

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

Type:String
Aliases:Target, DfsTarget, FolderTarget
Position:1
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