Get-DbaAgentSchedule

NAME Get-DbaAgentSchedule



SYNOPSIS

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





SYNTAX

Get-DbaAgentSchedule [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]

<Pscredential>] [[-Schedule] <System.String[]>] [[-Id] <System.Int32[]>] [-EnableException <Switch>]

[<CommonParameters>]





DESCRIPTION

This function returns SQL Agent Shared Schedules.





PARAMETERS

-EnableException [<Switch>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Id [<System.Int32[]>]

Parameter to filter the schedules returned



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Schedule [<System.String[]>]

Parameter to filter the schedules returned



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlCredential [<Pscredential>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Tags: Agent, Schedule

Author: Chris McKeown (@devopsfu), http://www.devopsfu.com



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- 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 sql2016 -Schedule "Maintenance10min","Maintenance60min"



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



RELATED LINKS

https://dbatools.io/Get-DbaAgentSchedule