Name

Start-JobSchedulerJobStream

SYNOPSIS

Starts job streams with the JobScheduler Master.

SYNTAX

Start-JobSchedulerJobStream [-JobStreamStarter] <String> [[-Parameters] <Hashtable>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet starts job streams with the JobScheduler Master.
Job streams are started by indicated a Starter and optionally start parameters.

PARAMETERS

JobStreamStarter

-JobStreamStarter <String>
Specifies the full path and name of a job stream starter.

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

Parameters

-Parameters <Hashtable>
Specifies the parameters for the job stream. Parameters are created from a hashmap,
i.e. a list of names and values.

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

AuditComment

-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.

The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.

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

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.

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

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.

This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.

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

WhatIf

-WhatIf <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

Confirm

-Confirm <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

about_JobScheduler

EXAMPLES

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

PS > $jsStart = Start-JobSchedulerJobStream -JobStreamStarter some_starter

Starts the indicated job stream starter.

-------------------------- EXAMPLE 2 --------------------------

PS > $jsStart = Start-JobSchedulerJobStream -JobStreamStarter some_starter -Parameters @{ 'par1' = 'val1'; 'par2' = 'val2' }

Starts the job stream starter with parameters 'par1', 'par2' and respective values.

  • No labels