Skip to main content
SnapCenter 5.0 cmdlets

Get-SmReportSchedule

Contributors
PDFs

Get the list of report schedules using this cmdlet.

Syntax

Get-SmReportSchedule [-Name]  <String>  [-Plugin]  <PluginCode>  [-Enabled]  <Boolean>

Detailed Description

Get the list of report schedules created either by the logged in user or the users with the same role as that of the logged in user.

Parameters

Name Description Required? Pipeline Input Default Value

Name

Get the schedule based on the schedule name.

true

true (ByPropertyName)

Plugin

Get the schedule based on the Plug-in name. Specify "all" to get the schedules configured with "All Plug-ins" Plug-in.

true

true (ByPropertyName)

Enabled

Get the schedules for a specific schedule status (enabled or disabled). Pass $true or 1 to fetch all the enabled schedules and $false or 0 to fetch all the disabled schedules.

false

true (ByPropertyName)

Examples

Example 1: Get the details of a specific report schedule.

 Get-SmReportSchedule -Name schedule1

This example gets the details of a specific schedule.

			ScheduleReportId  : 225
			ScheduleName  : Schedule1
			Enabled   : True
			PluginCode: SCO
			PluginName: Oracle Database
			PluginDisplayName : Oracle Database
			FormatType: PDF
			DayOfTheWeek  : Monday
			DayOfTheMonth :
			TriggerTime   : 21:00
			EmailSubject  : SnapCenter Weekly Report for Oracle Database
			FromEmail : user@domain.com
			Recipients  : user1@domain.com,user2@domain.com
			UserId: 1
			RoleId: 1
			ReportData: Backup,Clone,Restore,Protection
			Frequency : 9:00 pm Monday every week
			CreatedBy : Administrator
			ScheduleType  : Weekly

Example 2: Get the report schedules based on plug-in name.

 Get-SmReportSchedule -Plugin SCO

This example gets the list of schedules created for a specific plug-in.

			ScheduleReportId  : 225
			ScheduleName  : Schedule1
			Enabled   : True
			PluginCode: SCO
			PluginName: Oracle Database
			PluginDisplayName : Oracle Database
			FormatType: PDF
			DayOfTheWeek  : Monday
			DayOfTheMonth :
			TriggerTime   : 21:00
			EmailSubject  : SnapCenter Weekly Report for Oracle Database
			FromEmail : user@domain.com
			Recipients: user1@domain.com,user2@domain.com
			UserId: 1
			RoleId: 1
			ReportData: Backup,Clone,Restore,Protection
			Frequency : 9:00 pm Monday every week
			CreatedBy : Administrator
			ScheduleType  : Weekly
			ScheduleReportId  : 217
			ScheduleName  : Schedule2
			Enabled   : True
			PluginCode: SCO
			PluginName: Oracle Database
			PluginDisplayName : Oracle Database
			FormatType: PDF
			DayOfTheWeek  :
			DayOfTheMonth :
			TriggerTime   : 01:01
			EmailSubject  : SnapCenter Daily Report for Oracle Database
			FromEmail : user@domain.com
			Recipients: user1@domain.com,user2@domain.com
			UserId: 1
			RoleId: 1
			ReportData:
			Frequency : 1:01 am  every day
			CreatedBy : Administrator
			ScheduleType  : Daily

Example 3: Get the enabled or disabled report schedules.

 Get-SmReportSchedule -Enabled $true

This example gets the list of all enabled schedules. Pass $true or 1 to fetch all the enabled schedules and $false or 0 to fetch all the disabled schedules.

			ScheduleReportId  : 202
			ScheduleName  : Schedule3
			Enabled   : False
			PluginCode: All
			PluginName: All Plug-ins
			PluginDisplayName : All Plug-ins
			FormatType: PDF
			DayOfTheWeek  : Monday
			DayOfTheMonth :
			TriggerTime   : 21:00
			EmailSubject  : SnapCenter Weekly Report for All Plug-ins
			FromEmail : user@domain.com
			Recipients: user1@domain.com,user2@domain.com
			UserId: 1
			RoleId: 1
			ReportData: Backup,Clone,Restore,Protection
			Frequency : 9:00 pm Monday every week
			CreatedBy : Administrator
			ScheduleType  : Weekly
			ScheduleReportId  : 221
			ScheduleName  : Schedule4
			Enabled   : False
			PluginCode: SCO
			PluginName: Oracle Database
			PluginDisplayName : Oracle Database
			FormatType: PDF,CSV
			DayOfTheWeek  : monday
			DayOfTheMonth :
			TriggerTime   : 01:10
			EmailSubject  : SnapCenter Weekly Report for Oracle Database
			FromEmail : user@domain.com
			Recipients: user1@domain.com,user2@domain.com
			UserId: 1
			RoleId: 1
			ReportData:
			Frequency : 1:10 am monday every week
			CreatedBy : Administrator
			ScheduleType  : Weekly