Get-​Sql​Agent​Job​Schedule

Gets a job schedule object for each schedule that is present in the target instance of SQL Agent Job.

Syntax

Get-SqlAgentJobSchedule
   [[-Name] <String>]
   [[-Path] <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Get-SqlAgentJobSchedule
   [[-Name] <String>]
   [-InputObject] <Job>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Get-SqlAgentJobSchedule cmdlet gets a SQL JobStepSchedule object for each step that is present in the target instance of SQL Agent Job. If the name of the job schedule is provided, the cmdlet gets only this specific JobSchedule object.

This cmdlet supports the following modes of operation to get a collection of JobSchedule objects:

  • Pass the instance of the SQL Agent Job in the input.
  • Specify the Path parameter of the Job instance.
  • Invoke the cmdlet in a valid context.

Examples

Example 1: Get all JobSchedule object instances in the specified server instance

PS C:\> Get-SqlAgent -ServerInstance "MyServerInstance" | Get-SqlAgentJob | Get-SqlAgentJobSchedule
Name                           Jobs  Enabled    DateCreated               ActiveStartDate           ActiveEndDate             ID
----                           ----  -------    -----------               ---------------           -------------             --
Schedule1                      1     False      6/2/2016 10:21:44 AM      6/14/2016 12:00:00 AM     12/31/9999 12:00:00 AM    10
Schedule2                      1     True       6/9/2016 4:35:25 PM       6/9/2016 12:00:00 AM      12/31/9999 12:00:00 AM    58
Schedule3                      1     True       6/9/2016 4:35:25 PM       6/9/2016 12:00:00 AM      12/31/9999 12:00:00 AM    59

This command gets all JobSchedule object instances in the Job Instances passed by pipeline.

Example 2: Get a JobSchedule object instance in the specified server instance

PS C:\> Get-SqlAgentJob -ServerInstance "MyServer" | Get-SqlAgentJobSchedule -Name "Schedule1"

This command gets the JobSchedule object instance named Schedule1 from the Job instances passed by pipeline.

Required Parameters

-InputObject

Specifies the Job object of the target instance.

Type:Job
Position:2
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the JobSchedule object that this cmdlet gets.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies the path to the Job object on which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet uses the current working location.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False