Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Write-DfsrHealthReport

Write-DfsrHealthReport

dfsrpowershell.dll

Synopsis

Generates a DFS Replication health report.

Syntax

Write-DfsrHealthReport [-GroupName] [-DomainName] [-ReferenceComputerName] [-MemberComputerName] [-Path] [-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 <SwitchParameter>

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 <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup

Return Type

[none]

Notes

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

Online Version