Write-DfsrHealthReport
Write-DfsrHealthReport
Generates a DFS Replication health report.
Syntax
Parameter Set: Default
Write-DfsrHealthReport [-GroupName] <String[]> [[-ReferenceComputerName] <String> ] [[-MemberComputerName] <String[]> ] [[-Path] <String> ] [[-DomainName] <String> ] [-CountFiles] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Write-DfsrHealthReport cmdlet generates a DFS Replication health, or diagnostic, report for two or more servers. A health reports contains administrative information about replication state, efficiency, and any potential replication issues.
The cmdlet creates the reports as an HTML file, with an associated XML file.
Parameters
-CountFiles
Indicates that the cmdlet counts the number of files present in the replicated content folders. By default, the cmdlet does not count files, in order to save time while generating a report.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DomainName<String>
Specifies a NetBIOS or fully qualified domain name (FQDN) for an Active Directory domain that contains a replication group. If you do not specify this parameter, the cmdlet uses the current domain of the user.
Aliases |
none |
Required? |
false |
Position? |
101 |
Default Value |
[Current Domain] |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GroupName<String[]>
Specifies an array of names of replication groups. If you do not specify this parameter, the cmdlet queries for all participating replication groups. You can specify multiple groups, separated by commas, as well as wildcard characters (*).
Aliases |
RG,RgName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-MemberComputerName<String[]>
Specifies an array of DFS Replication members to analyze in comparison to a server specified by the ReferenceComputerName parameter. If you do not specify this parameter, the cmdlet includes all members of the replication group. You can specify multiple computer names, separated by commas, as well as wildcard characters (*).
Aliases |
MemberList,MemList |
Required? |
false |
Position? |
3 |
Default Value |
[All members] |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
true |
-Path<String>
Specifies the folder path for the report file. If you do not specify this parameter, the cmdlet uses the current working directory.
The cmdlet names each report in the format Health-<Replication Group Name>-<Date>-<Time> with HTML and XML extensions.
Aliases |
FilePath |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ReferenceComputerName<String>
Specifies the name of a reference computer in the replication group. The replication backlog from this server is compared to all other members specified in the MemberComputerName parameter. If you do not specify this parameter, the cmdlet uses the local computer.
Aliases |
ReferenceMember,RefMem |
Required? |
false |
Position? |
2 |
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
Outputs
The output type is the type of the objects that the cmdlet emits.
- [none]
Examples
Example 1: Generate a health report with a file count
This command generates a report for the replication group RG01 and the reference computer SRV01.
PS C:\> Write-DfsrHealthReport -GroupName "RG01" -ReferenceComputerName "SRV01" -MemberComputerName SRV02 -Path C:\reports -CountFiles
Example 2: Generate a health report
This command generates a health report for the RG01 replication group with a baseline computer of SRV01 and all other servers in the replication group. The command writes the report to the C:\ folder.
PS C:\> Write-DfsrHealthReport -GroupName "RG01" -ReferenceComputerName "SRV01" -Verbose