Share via

Set-WssReportSchedule

  • Article

Set-WssReportSchedule

Sets the health report schedule.

Syntax

Parameter Set: EnableDaily
Set-WssReportSchedule -At <DateTimeOffset> -Daily -Enable [ <CommonParameters>]

Parameter Set: Disable
Set-WssReportSchedule -Disable [ <CommonParameters>]

Parameter Set: EnableHourly
Set-WssReportSchedule -Enable -Hourly [ <CommonParameters>]

Detailed Description

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

Parameters

-At<DateTimeOffset>

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

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Daily

Indicates that the schedule runs the health report daily.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Disable

Indicates that the automated health report generation is disabled.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Enable

Indicates that the automated health report generation is enabled.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Hourly

Indicates that the schedule runs the health report hourly.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Set the report schedule

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.

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

Get-WssReportSchedule