functions/Get-DbaAgentSchedule.ps1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
function Get-DbaAgentSchedule { <# .SYNOPSIS Returns all SQL Agent Shared Schedules on a SQL Server Agent. .DESCRIPTION This function returns SQL Agent Shared Schedules. .PARAMETER SqlInstance SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances. .PARAMETER SqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Schedule Parameter to filter the schedules returned .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: Agent, Schedule Author: Chris McKeown (@devopsfu), http://www.devopsfu.com Website: https://dbatools.io Copyright: (C) Chrissy LeMaire, clemaire@gmail.com License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Get-DbaAgentSchedule .EXAMPLE Get-DbaAgentSchedule -SqlInstance localhost Returns all SQL Agent Shared Schedules on the local default SQL Server instance .EXAMPLE Get-DbaAgentSchedule -SqlInstance localhost, sql2016 Returns all SQL Agent Shared Schedules for the local and sql2016 SQL Server instances #> [CmdletBinding()] param ( [parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)] [Alias("ServerInstance", "Instance", "SqlServer")] [DbaInstanceParameter[]]$SqlInstance, [Alias("Schedules")] [object[]]$Schedule, [PSCredential]$SqlCredential, [Alias('Silent')] [switch]$EnableException ) begin { function Get-ScheduleDescription { param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [object]$Schedule ) # Get the culture to make sure the right date and time format is displayed $datetimeFormat = (Get-culture).DateTimeFormat # Set the intial description $description = "" # Get the date and time values $startDate = Get-Date $Schedule.ActiveStartDate -format $datetimeFormat.ShortDatePattern $startTime = Get-Date ($Schedule.ActiveStartTimeOfDay.ToString()) -format $datetimeFormat.LongTimePattern $endDate = Get-Date $Schedule.ActiveEndDate -format $datetimeFormat.ShortDatePattern $endTime = Get-Date ($Schedule.ActiveEndTimeOfDay.ToString()) -format $datetimeFormat.LongTimePattern # Start setting the description based on the frequency type switch ($schedule.FrequencyTypes) { {($_ -eq 1) -or ($_ -eq "Once")} { $description += "Occurs on $startDate at $startTime" } {($_ -in 4, 8, 16, 32) -or ($_ -in "Daily", "Weekly", "Monthly")} { $description += "Occurs every "} {($_ -eq 64) -or ($_ -eq "AutoStart")} {$description += "Start automatically when SQL Server Agent starts "} {($_ -eq 128) -or ($_ -eq "OnIdle")} {$description += "Start whenever the CPUs become idle"} } # Check the frequency types for daily or weekly i.e. switch ($schedule.FrequencyTypes) { # Daily {$_ -in 4, "Daily"} { if ($Schedule.FrequencyInterval -eq 1) { $description += "day " } elseif ($Schedule.FrequencyInterval -gt 1) { $description += "$($Schedule.FrequencyInterval) day(s) " } } # Weekly {$_ -in 8, "Weekly"} { # Check if it's for one or more weeks if ($Schedule.FrequencyRecurrenceFactor -eq 1) { $description += "week on " } elseif ($Schedule.FrequencyRecurrenceFactor -gt 1) { $description += "$($Schedule.FrequencyRecurrenceFactor) week(s) on " } # Save the interval for the loop $frequencyInterval = $Schedule.FrequencyInterval # Create the array to hold the days $days = ($false, $false, $false, $false, $false, $false, $false) # Loop through the days while ($frequencyInterval -gt 0) { switch ($FrequenctInterval) { {($frequencyInterval - 64) -ge 0} { $days[5] = "Saturday" $frequencyInterval -= 64 } {($frequencyInterval - 32) -ge 0} { $days[4] = "Friday" $frequencyInterval -= 32 } {($frequencyInterval - 16) -ge 0} { $days[3] = "Thursday" $frequencyInterval -= 16 } {($frequencyInterval - 8) -ge 0} { $days[2] = "Wednesday" $frequencyInterval -= 8 } {($frequencyInterval - 4) -ge 0} { $days[1] = "Tuesday" $frequencyInterval -= 4 } {($frequencyInterval - 2) -ge 0} { $days[0] = "Monday" $frequencyInterval -= 2 } {($frequencyInterval - 1) -ge 0} { $days[6] = "Sunday" $frequencyInterval -= 1 } } } # Add the days to the description by selecting the days and exploding the array $description += ($days | Where-Object {$_ -ne $false}) -join ", " $description += " " } # Monthly {$_ -in 16, "Monthly"} { # Check if it's for one or more months if ($Schedule.FrequencyRecurrenceFactor -eq 1) { $description += "month " } elseif ($Schedule.FrequencyRecurrenceFactor -gt 1) { $description += "$($Schedule.FrequencyRecurrenceFactor) month(s) " } # Add the interval $description += "on day $($Schedule.FrequencyInterval) of that month " } # Monthly relative {$_ -in 32, "MonthlyRelative"} { # Check for the relative day switch ($Schedule.FrequencyRelativeIntervals) { {$_ -in 1, "First"} {$description += "first "} {$_ -in 2, "Second"} {$description += "second "} {$_ -in 4, "Third"} {$description += "third "} {$_ -in 8, "Fourth"} {$description += "fourth "} {$_ -in 16, "Last"} {$description += "last "} } # Get the relative day of the week switch ($Schedule.FrequencyInterval) { 1 { $description += "Sunday "} 2 { $description += "Monday "} 3 { $description += "Tuesday "} 4 { $description += "Wednesday "} 5 { $description += "Thursday "} 6 { $description += "Friday "} 7 { $description += "Saturday "} 8 { $description += "Day "} 9 { $description += "Weekday "} 10 { $description += "Weekend day "} } $description += "of every $($Schedule.FrequencyRecurrenceFactor) month(s) " } } # Check the frequency type if ($schedule.FrequencyTypes -notin 64, 128) { # Check the subday types for minutes or hours i.e. if ($schedule.FrequencySubDayInterval -in 0, 1) { $description += "at $startTime. " } else { switch ($Schedule.FrequencySubDayTypes) { {$_ -in 2, "Seconds"} { $description += "every $($schedule.FrequencySubDayInterval) second(s) "} {$_ -in 4, "Minutes"} {$description += "every $($schedule.FrequencySubDayInterval) minute(s) " } {$_ -in 8, "Hours"} { $description += "every $($schedule.FrequencySubDayInterval) hour(s) " } } $description += "between $startTime and $endTime. " } # Check if an end date has been given if ($Schedule.ActiveEndDate.Year -eq 9999) { $description += "Schedule will be used starting on $startDate." } else { $description += "Schedule will used between $startDate and $endDate." } } return $description } } process { foreach ($instance in $SqlInstance) { Write-Message -Level Verbose -Message "Attempting to connect to $instance" try { $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential } catch { Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue } if ($server.Edition -like 'Express*') { Stop-Function -Message "$($server.Edition) does not support SQL Server Agent. Skipping $server." -Continue } if ($Schedule) { $scheduleCollection = $server.JobServer.SharedSchedules | Where-Object { $_.Name -in $Schedule } } else { $scheduleCollection = $server.JobServer.SharedSchedules } } $defaults = "ComputerName", "InstanceName", "SqlInstance", "Name as ScheduleName", "ActiveEndDate", "ActiveEndTimeOfDay", "ActiveStartDate", "ActiveStartTimeOfDay", "DateCreated", "FrequencyInterval", "FrequencyRecurrenceFactor", "FrequencyRelativeIntervals", "FrequencySubDayInterval", "FrequencySubDayTypes", "FrequencyTypes", "IsEnabled", "JobCount", "Description" foreach ($schedule in $scheduleCollection) { $description = Get-ScheduleDescription -Schedule $schedule Add-Member -Force -InputObject $schedule -MemberType NoteProperty ComputerName -value $server.NetName Add-Member -Force -InputObject $schedule -MemberType NoteProperty InstanceName -value $server.ServiceName Add-Member -Force -InputObject $schedule -MemberType NoteProperty SqlInstance -value $server.DomainInstanceName Add-Member -Force -InputObject $schedule -MemberType NoteProperty Description -Value $description Select-DefaultView -InputObject $schedule -Property $defaults } } } |