...
Add-JobSchedulerEvent [[-EventClass] <String>] [-EventId] <String> [[-ExitCode] <Int32>] [[-AllowedExitCodes] <Int32[]>] [[-Job] <String>] [[-JobChain] <String>] [[-Order] <String>] [[-MasterUrl] <Uri>] [[-SupervisorUrl] <Uri>] [[-SupervisorJobChain] <String>] [[-ExpirationDate] <DateTime>] [[-ExpirationCycle] <String>] [[-ExpirationPeriod] <String>] [-NoExpiration] [[-Parameters] <Hashtable>] [<CommonParameters>]
...
-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? | 8 |
| 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 assign by default the JobScheduler Supervisor that the
current JobScheduler Master is registered for and otherwise assign the JobScheduler Master.
| Required? | false |
| Position? | 9 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-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? | 910 |
| Default value | /sos/events/scheduler_event_service |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-ExpirationDate <DateTime>
Specifies the point in time for which an event automatically expires: this parameter is considered by the
Event Processor. A specific point in time can be specified by use of the ISO date format, i.e. yyyy-MM-dd HH:mm:ss.
The value 'never' ensures that the event does not ever expire.
The parameters -ExpirationDate, -ExpirationCycle, -ExpirationPeriod, -NoExpiration may not be used at the same time.
Default: 00:00 on the following day.
| Required? | false |
| Position? | 1011 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-ExpirationCycle <String>
Specifies the time for which the event will expire in the current period.
Periods start at 00:00 and end at 24:00. An expiration cycle of 21:00
specifies 9pm of the current cycle for event expiration.
Values are specified by use of the format HH:mm:ss.
The parameters -ExpirationDate, -ExpirationCycle, -ExpirationPeriod, -NoExpiration may not be used at the same time.
| Required? | false |
| Position? | 1112 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-ExpirationPeriod <String>
Specifies the duration after which the event will expire in the current period.
Periods start at 00:00 and end at 24:00. An expiration period of 04:00
specifies that the event will expire 4 hours starting from the current point in time.
Values are specified by use of the format HH:mm:ss.
The parameters -ExpirationDate, -ExpirationCycle, -ExpirationPeriod, -NoExpiration may not be used at the same time.
| Required? | false |
| Position? | 1213 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Parameters <Hashtable>
Allows additional parameters for event handlers to be specified. Parameters are created using name-value
pairs from a hashmap as e.g. @{'name1'='value1'; 'name2'='value2'}.
Parameter names can be freely chosen and event handlers configured to
take account of values handed over. Any number of parameters can be added.
| Required? | false |
| Position? | 1314 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
PS > Add-JobSchedulerEvent -EventClass daily_closing -EventId 12345678 -AllowedExitCodes @( 1..4)
Creates an event with the specified event class and event id. The exit code is implicitely added from the global $LastExitCode value. Should the exit code be contained in the list of allowed exit codes then its value is set to 0.
...