Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NAME

Get-JobSchedulerEvent

SYNOPSIS

Retrieves events from a JobScheduler instance.

SYNTAX

Get-JobSchedulerEvent [-EventClass <String>] [-EventId <String>] [-ExitCode <Int32>] [-MasterUrl <Uri>] [[-Supe
rvisorUrl] <Uri>] [-SupervisorJobChain <String>] [-XPath <String>] <CommonParameters>

DESCRIPTION

Events can be retrieved from a JobScheduler instance by specifying the event class
and optionally the event id.

PARAMETERS

EventClass

-EventClass <String>
Specifies a common name for a set of events that enable event handlers to process multiple events of the
same event class. For example, "daily_closing" could be an event class for jobs that should start once day-time
business processes have drawn to a close.

...

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

EventId

-EventId <String>
An identifier for an event. Allows event handlers to react to events having a particular ID.

...

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ExitCode

-ExitCode <Int32>

Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

MasterUrl

-MasterUrl <Uri>
Specifies the Job Scheduler Master instance URL.

...

Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

SupervisorUrl

-SupervisorUrl <Uri>
Specifies a Job Scheduler Supervisor instance URL.

...

Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

SupervisorJobChain

-SupervisorJobChain <String>
Specifies the path of the job chain in the JobScheduler Master or Supervisor instance that implements the event
processor.

...

Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

XPath

-XPath <String>
All events corresponding to the XPath expression specified when this parameter is set. Complex expressions
are possible and any attributes of an event can be addressed. This parameter allows complex queries to
be made, that would not be possible with the -EventClass, -EventId and -ExitCode parameters.

Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

about_jobscheduler

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

...