Start-DfsrPropagationTest

Start-DfsrPropagationTest

Creates a propagation test file in a replicated folder.

Syntax

Parameter Set: Default
Start-DfsrPropagationTest [[-GroupName] <String[]> ] [-FolderName] <String[]> [-ReferenceComputerName] <String> [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Start-DfsrPropagationTest cmdlet creates a propagation test file in a Distributed File System (DFS) replicated folder. The test file contains metadata, such as time and date stamps. The DFS Replication service propagates the file to other computers in the replication group. You can create propagation reports by using the Write-DfsrPropagationReport cmdlet.

This cmdlet creates test files in replicated folders in a hidden, read-only system folder named __DFSR_DIAGNOSTICS_TEST_FOLDER__. The cmdlet names the test files <Reference Computer Name>@<GUID>@<RG Name>-<RF Name>.xml. Use the Remove-DfsrPropagationTestFile cmdlet to delete old test files.

Parameters

-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 creates test files for all replicated folders within the specified group and domain.

Aliases

RF,RfName

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-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 creates test files for all replicated folders that have name that matches the value of the FolderName parameter within the specified domain.

Aliases

RG,RgName

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

true

-ReferenceComputerName<String>

Specifies the name of a reference computer in the replication group. The cmdlet creates the propagation test file on the reference computer. If you do not specify this parameter, the cmdlet uses the local computer as the reference computer.

Aliases

ReferenceMember,RefMem

Required?

true

Position?

3

Default Value

[local computer]

Accept Pipeline Input?

True (ByPropertyName)

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.

  • 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: Create a test file on a specified reference computer

This command creates a propagation test file for the replicated folder named ReplicatedFolder19 in the group named ReplicationGroup07. The command specifies a reference computer name.

PS C:\> Start-DfsrPropagationTest -GroupName "ReplicationGroup07" -FolderName "ReplicatedFolder19" -ReferenceComputerName "SRV01.Contoso.com"

Example 2: Create test files for all replicated folders

This command creates test files in all replicated folders on the reference computer named SRV01.corp.Contoso.com. The command uses the wildcard character (*) for the GroupName and FolderName parameter values, and, therefore, it creates a test file in any replicated folder on the computer, regardless of what replication group or groups the computer might be a member of.

PS C:\> Start-DfsrPropagationTest -GroupName * -FolderName * -ReferenceComputerName "SRV01.corp.Contoso.com" -Verbose

Remove-DfsrPropagationTestFile

Write-DfsrPropagationReport