Remove-DfsrPropagationTestFile
Remove-DfsrPropagationTestFile
Removes DFS Replication propagation test files.
Syntax
Parameter Set: Default
Remove-DfsrPropagationTestFile [-GroupName] <String[]> [-FolderName] <String[]> [[-ComputerName] <String> ] [-AgeInDays] <UInt32> [[-DomainName] <String> ] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-DfsrPropagationTestFile cmdlet removes test files from a Distributed File System (DFS) Replication replicated folder. Once you remove the file from one member computer in a replication group, DFS Replication removes the file from all other members. To create test files, use the Start-DfsrPropagationTest cmdlet.
Test files contain only test metadata. You can remove them at any time.
Parameters
-AgeInDays<UInt32>
Specifies the age, in days, of propagation test files to delete. To delete propagation files created within the past 24 hours or to delete all propagation test files, set this value to zero (0).
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the name of a replication member computer. If you do not specify this parameter, the cmdlet uses the current computer.
Aliases |
Member,Mem |
Required? |
false |
Position? |
3 |
Default Value |
[local computer] |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DomainName<String>
Specifies the NetBIOS name or fully qualified domain name (FQDN) for the Active Directory Domain Service (AD DS) domain that contains the replication group. If you do not specify this parameter, the cmdlet uses the domain of the current user.
Aliases |
none |
Required? |
false |
Position? |
101 |
Default Value |
[Current Domain] |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-FolderName<String[]>
Specifies an array of names of replicated folders. You can use a comma separated list and the wildcard character (*). If you do not specify this parameter, the cmdlet removes test files from all replicated folders.
Aliases |
RF,RfName |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
true |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GroupName<String[]>
Specifies an array of names of replication groups. You can use a comma separated list and the wildcard character (*). If you do not specify this parameter, the cmdlet removes test files from replicated folders for all groups within the specified domain.
Aliases |
RG,RgName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-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.
- Microsoft.DistributedFileSystemReplication.DfsReplicationGroup, Microsoft.DistributedFileSystemReplication.DfsReplicatedFolder, string
Outputs
The output type is the type of the objects that the cmdlet emits.
- [none]
Examples
Example 1: Remove all test files from a specified replicated folder
This command removes all propagation test files from the RF07 folder on the computer named SRV01. This computer is part of the group named RG01. The value of zero (0) for the AgeInDays parameter causes the command to remove all test files, no matter how long ago you created them. The command does not include the Force parameter, so you must confirm the removal.
PS C:\> Remove-DfsrPropagationTestFile -GroupName "RG01" -FolderName "RF07" -ComputerName "SRV01" -AgeInDays 0