Write-DfsrPropagationReport
Write-DfsrPropagationReport
Generates reports for propagation test files in a replication group.
Syntax
Parameter Set: Default
Write-DfsrPropagationReport [-GroupName] <String[]> [-FolderName] <String[]> [-ReferenceComputerName] <String> [[-Path] <String> ] [[-FileCount] <Int32> ] [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Write-DfsrPropagationReport cmdlet generates reports for the replication progress of propagation test files in a replication group. Specify the replication group, replicated folder, and a member computer to act as the reference computer.
The cmdlet creates files named Propagation-<RG Name>-<Date>-<Time>.html and Propagation-<RG Name>-<Date>-<Time>.xml. You can specify a folder to save these files to, or use the current working directory.
Use the Start-DfsrPropagationTest cmdlet to create a propagation test file.
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 |
-FileCount<Int32>
Specifies the number of most recently generated propagation test files to use for generating the report. If you do not specify this parameter, the cmdlet uses all files.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FolderName<String[]>
Specifies an array of names of replicated folders. If you do not specify this parameter, the cmdlet applies to all participating replicated folders. You can use a comma separated list and the wildcard character (*).
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. If you do not specify this parameter, the cmdlet applies to all participating replication groups. You can use a comma separated list and the wildcard character (*).
Aliases |
RG,RgName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-Path<String>
Specifies a folder for the report file. If you do not specify this parameter, the cmdlet uses the current working directory.
Aliases |
FilePath |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ReferenceComputerName<String>
Specifies the name of a reference computer in the replication group. The cmdlet compares the replication test file from this reference computer to test files for all other members of the replication group. If you do not specify this parameter, the cmdlet uses the current 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 propagation report for a specific group and replicated folder
This command creates a propagation report, as HTML and XML files, in the folder C:\Reports. The command specifies SRV01 as reference computer and specifies group name and folder name.
PS C:\> Write-DfsrPropagationReport -GroupName "RG01" -FolderName "RF22" -ReferenceComputerName "SRV01" -Path "C:\Reports"
Example 2: Create propagation reports for all groups and replicated folders by using wildcards
This command creates propagation reports for all replicated folders in all replication groups by using a wildcard character (*) for the GroupName and FolderName parameters. The command specifies SRV01 as the reference computer. This command uses the Verbose parameter to display information to the console.
PS C:\> Write-DfsrPropagationReport -GroupName * -FolderName * -ReferenceComputerName "SRV01" -Verbose