Remove-DfsnRootTarget
Remove-DfsnRootTarget
Removes a target for a DFS namespace root.
Syntax
Parameter Set: RemoveNamespaceRootTarget2
Remove-DfsnRootTarget [-TargetPath] <String> [[-Cleanup]] [-AsJob] [-CimSession <CimSession[]> ] [-Path <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-DfsnRootTarget cmdlet removes a target for a Distributed File System (DFS) namespace root. 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 root can have more than one root target. If you remove the last root target associated with a DFS namespace root, this cmdlet deletes the namespace as well. Users cannot use the DFS namespace path after you delete the namespace.
For more information about DFS namespaces, see Overview of DFS Namespaces (https://technet.microsoft.com/library/cc730736) on TechNet.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Cleanup
Indicates that the cmdlet attempts to force a clean-up of the root target in Active Directory Domain Services (AD DS).
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the path for the root of a DFS namespace.
Aliases |
DfsPath,NamespaceRoot |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TargetPath<String>
Specifies a path for the folder target. This cmdlet removes the folder target that has the path specified.
Aliases |
Target,DfsTarget,RootTargetPath |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Remove a root target
This command removes a DFS root target path \\Contoso-FS\AccountingSoftware from the DFS namespace that has the path \\Contoso\AccountingSoftware.
PS C:\> Remove-DfsnRootTarget -TargetPath "\\Contoso-FS\AccountingSoftware" -Path "\\Contoso\AccountingSoftware"