Skip to main content
SnapCenter 4.9 cmdlets

Set-SmReportSchedule

Contributors
PDFs

Modify the report schedule using this cmdlet.

Syntax

Set-SmReportSchedule [-Name]  <String>  [-Plugin]  <PluginCode>  [-Enabled]  <Boolean>  [-ScheduleType]  <String>  [-DayOfTheWeek]  <String>  [-DayOfTheMonth]  <String>  [-TriggerTime]  <String>  [-DocumentType]  <String>  [-FromEmail]  <String>  [-Recipients]  <String>

Detailed Description

Modify the report schedule by passing the required schedule name and the parameters. This command can be used to enable or disable a schedule.

Parameters

Name Description Required? Pipeline Input Default Value

Name

Specify the name of the schedule to be modified.

true

true (ByPropertyName)

Plugin

Specify the plug-in code to generate the report. For custom plug-ins, specify the custom plug-in name for example, hana, mysql. Specify 'all' to generate report for "All Plug-ins".

true

true (ByPropertyName)

Enabled

Specify the state as $true or 1 to enable the schedule and $false or 0 to disable the schedule. Disabled schedules will not be triggered.

false

true (ByPropertyName)

ScheduleType

Specify the schedule type. Valid values are 'daily', 'weekly', and 'monthly'.

true

true (ByPropertyName)

DayOfTheWeek

Specify the day of the week to run the schedule. Valid values are 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'. This field is applicable only for weekly schedule.

false

true (ByPropertyName)

DayOfTheMonth

Specify the day (number) of the month to run the schedule. The value should be between 0 and 28. Enter zero to run the schedule for the last day of the month. This field is applicable only for monthly schedule.

false

true (ByPropertyName)

TriggerTime

Specify the TriggerTime HH:MM in 24 Hours format.

true

true (ByPropertyName)

DocumentType

Specify the format of the report to be sent over e-mail. The valid formats are PDF and CSV. Add the comma separator if both the formats are needed.

true

true (ByPropertyName)

FromEmail

Specify the e-mail address from which the report has to be sent.

true

true (ByPropertyName)

Recipients

Specify the e-mail address to send the report. For multiple e-mail ID's, seperate them by comma.

true

true (ByPropertyName)

Examples

Example 1: Modifying plug-in of a report schedule.

 Set-SmReportSchedule -Name schedule1 -Plugin SCO

This example modifies the plug-in of an existing schedule to 'SCO'. Plug-in value can be any specific plug-in or 'all'. Specify 'all', to generate the report for all the configured plug-ins. For the custom plug-ins specify the plug-in name instead of the plug-in code for example, hana, mysql.

Example 2: Modifying frequency of a report schedule.

 Set-SmReportSchedule -Name schedule1 -ScheduleType weekly -DayOfTheWeek sunday  -TriggerTime 1:10

This example modifies the frequency of an existing schedule to weekly. The ScheduleType, DayOfTheWeek/DayOfTheMonth, and TriggerTime constitutes a frequency, hence all these values should be specified to modify the frequency.

Example 3: Modifying From and Recipients e-mail id(s) of a report schedule.

 Set-SmReportSchedule -Name schedule1 -FromEmail user@domain.com -Recipients "user1@domain.com,user2@domain.com"

This example modifies From and Recipients e-mail ids of an existing schedule. FromEmail can be any single valid e-mail id and Recipients can be a single or multiple comma separated e-mail ids.

Example 4: Disabling a report schedule.

 Set-SmReportSchedule -Name schedule1 -Enabled $false

This example disables a report schedule. The parameter $true or 1 will enable the schedule and $false or 0 will disable the schedule. Disabled schedules will not be triggered.