Edit

Remove-DfsrPropagationTestFile

  • Reference
Module:
DFSR

Removes DFS Replication propagation test files.

Syntax

Remove-DfsrPropagationTestFile
      [-GroupName] <String[]>
      [-FolderName] <String[]>
      [[-ComputerName] <String>]
      [-AgeInDays] <UInt32>
      [-Force]
      [[-DomainName] <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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.

Examples

Example 1: Remove all test files from a specified replicated folder

PS C:\> Remove-DfsrPropagationTestFile -GroupName "RG01" -FolderName "RF07" -ComputerName "SRV01" -AgeInDays 0
This operation will remove the propagation test files from the computer named "SRV01" that are more than 0 days old.
Are you sure you want to continue to remove this propagation test file?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):

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.

Parameters

-AgeInDays

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).

Type:UInt32
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies the name of a replication member computer. If you do not specify this parameter, the cmdlet uses the current computer.

Type:String
Aliases:Member, Mem
Position:2
Default value:[local computer]
Required:False
Accept pipeline input:True
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

-DomainName

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.

Type:String
Position:100
Default value:[Current Domain]
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-FolderName

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.

Type:String[]
Aliases:RF, RfName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

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

-GroupName

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.

Type:String[]
Aliases:RG, RgName
Position:0
Default value:None
Required:True
Accept pipeline input:True
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

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup, Microsoft.DistributedFileSystemReplication.DfsReplicatedFolder, string

Outputs

[none]