Get-DbaAgentSchedule

Want to see the source code for this command? Check out Get-DbaAgentSchedule on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaAgentSchedule.

Synopsis

Returns all SQL Agent Shared Schedules on a SQL Server Agent.

Description

This function returns SQL Agent Shared Schedules.

Syntax

Get-DbaAgentSchedule
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Schedule] <String[]>]
    [[-ScheduleUid] <String[]>]
    [[-Id] <Int32[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaAgentSchedule -SqlInstance localhost

Returns all SQL Agent Shared Schedules on the local default SQL Server instance

Example: 2

PS C:\> Get-DbaAgentSchedule -SqlInstance localhost, sql2016

Returns all SQL Agent Shared Schedules for the local and sql2016 SQL Server instances

Example: 3

PS C:\> Get-DbaAgentSchedule -SqlInstance localhost, sql2016 -Id 3

Returns the SQL Agent Shared Schedules with the Id of 3

Example: 4

PS C:\> Get-DbaAgentSchedule -SqlInstance localhost, sql2016 -ScheduleUid 'bf57fa7e-7720-4936-85a0-87d279db7eb7'

Returns the SQL Agent Shared Schedules with the UID

Example: 5

PS C:\> Get-DbaAgentSchedule -SqlInstance sql2016 -Schedule "Maintenance10min","Maintenance60min"

Returns the "Maintenance10min" & "Maintenance60min" schedules from the sql2016 SQL Server instance

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Schedule

Parameter to filter the schedules returned

-ScheduleUid

The unique identifier of the schedule

-Id

Parameter to filter the schedules returned

-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.