Name
Get-JobSchedulerEvent
SYNOPSIS
Retrieves events from a JobScheduler instance.
SYNTAX
Get-JobSchedulerEvent [[-EventClass] <String>] [[-EventId] <String>] [[-ExitCode] <Int32>] [[-MasterUrl] <Uri>] [[-SupervisorUrl] <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.
Specifies a unique identifier when used together with the -EventId parameter. Can, for example, be used to remove
events, e.g. remove all events of a particular event class.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
EventId
-EventId <String>
An identifier for an event. Allows event handlers to react to events having a particular ID.
Specifies a unique identifier when used together with the -EventClass parameter. An event id is required to be unique
for the same event class.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ExitCode
-ExitCode <Int32>
| Required? | false |
| Position? | 3 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
MasterUrl
-MasterUrl <Uri>
Specifies the Job Scheduler Master instance URL.
The URL consists of the protocol, host name and port, e.g. http://localhost:4454.
Default: If used with a job then the CLI will assign by default the JobScheduler Master that the job is running for
otherwise the JobScheduler Master as specified with the Use-JobSchedulerMaster cmdlet will be used.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SupervisorUrl
-SupervisorUrl <Uri>
Specifies a Job Scheduler Supervisor instance URL.
Job Scheduler Master instances register with a JobScheduler Supervisor (if configured to do so)
in order to synchronize job configurations. The Supervisor instance receives events, executes the
event handler and starts jobs and job chains for registered JobScheduler Master instances.
The URL consists of the protocol, host name and port, e.g. http://localhost:4454.
Default: If used with a job then the CLI will by default assign the JobScheduler Supervisor that the
current JobScheduler Master is registered for and otherwise assign the JobScheduler Master.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SupervisorJobChain
-SupervisorJobChain <String>
Specifies the path of the job chain in the JobScheduler Master or Supervisor instance that implements the event
processor.
Default: /sos/events/scheduler_event_service
| Required? | false |
| Position? | 6 |
| Default value | /sos/events/scheduler_event_service |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $event = Get-JobSchedulerEvent -EventClass daily_closing -EventId 12345678
Returns an event object from the event class and event id.
-------------------------- EXAMPLE 2 --------------------------
PS > $events = Get-JobSchedulerEvent -EventClass daily_closing
Returns an array of event objects for the specified event class.
-------------------------- EXAMPLE 3 --------------------------
PS > Get-JobSchedulerEvent -Xpath "//events/event[starts-with(@event_id, 'my')]"
Returns a number of event objects that are assigned an event id starting with the characters 'my'.