Write-DfsrHealthReport
Generates a DFS Replication health report.
Syntax
Default (Default)
Write-DfsrHealthReport
[-GroupName] <String[]>
[[-ReferenceComputerName] <String>]
[[-MemberComputerName] <String[]>]
[[-Path] <String>]
[-CountFiles]
[[-DomainName] <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Write-DfsrHealthReport cmdlet generates a Distributed File System (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.
Examples
Example 1: Generate a health report with a file count
PS C:\> Write-DfsrHealthReport -GroupName "RG01" -ReferenceComputerName "SRV01" -MemberComputerName "SRV02" -Path "C:\reports" -CountFiles
This command generates a report for the replication group RG01 and the reference computer SRV01.
Example 2: Generate a health report
PS C:\> Write-DfsrHealthReport -GroupName "RG01" -ReferenceComputerName "SRV01" -Verbose
VERBOSE: Performing operation "Write-DfsrHealthReport" on Target "RG01".
VERBOSE: Successfully saved the health report for the replication group named "RG01". The XML file is located here: "C:\Health-RG01-04Apr2013-2022.xml". The HTML file is located here: "C:\Health-RG01-04Apr2013-2022.html".
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.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainName
Specifies the NetBIOS name or fully qualified domain name (FQDN) for the Active Directory Domain Service (AD DS) domain that contains a replication group. If you do not specify this parameter, the cmdlet uses the current domain of the user.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 100 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-GroupName
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 use a comma separated list and the wildcard character (*).
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | RG, RgName |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-MemberComputerName
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 (*).
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | MemberList, MemList |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Path
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | FilePath |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ReferenceComputerName
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ReferenceMember, RefMem |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.