Edit

Set-WssReportSchedule

  • Reference
Module:
WSSCmdlets

Sets the health report schedule.

Syntax

Set-WssReportSchedule
   [-Enable]
   [-Daily]
   -At <DateTimeOffset>
   [<CommonParameters>]
Set-WssReportSchedule
   [-Disable]
   [<CommonParameters>]
Set-WssReportSchedule
   [-Enable]
   [-Hourly]
   [<CommonParameters>]

Description

The Set-WssReportSchedule cmdlet sets the health report schedule. Schedule the report to run daily, hourly, or never.

Examples

Example 1: Set the report schedule

PS C:\> $Time = [System.DateTimeOffset]::Now
PS C:\> Set-WssReportSchedule -Enable -Daily -At $Time

The first command gets the current time and stores the result in the $Time variable.

The second command sets the report schedule to run daily at the time specified by the $Time variable.

Parameters

-At

Specifies the time of day to run the daily health report.

Type:DateTimeOffset
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Daily

Indicates that the schedule runs the health report daily.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Disable

Indicates that the automated health report generation is disabled.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Enable

Indicates that the automated health report generation is enabled.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Hourly

Indicates that the schedule runs the health report hourly.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False