Product Knowledge Base

Space shortcuts

Page tree

Name

Reset-JobSchedulerOrder

SYNOPSIS

Resets orders in the JobScheduler Master.

SYNTAX

Reset-JobSchedulerOrder [-OrderId] <String> [-JobChain] <String> [[-Directory] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Orders can be reset in a job chain, i.e. they are moved to the begin of a job chain.

PARAMETERS

OrderId

-OrderId <String>
Specifies the identifier of an order.

Both parameters -OrderId and -JobChain have to be specified if no pipelined order objects are used.

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

JobChain

-JobChain <String>
Specifies the path and name of a job chain for which orders should be reset.

Both parameters -OrderId and -JobChain have to be specified if no pipelined order objects are used.

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

Directory

-Directory <String>
Optionally specifies the folder where the job chain is located. The directory is determined
from the root folder, i.e. the "live" directory.

If the -JobChain parameter specifies the name of job chain then the location specified from the
-Directory parameter is added to the job chain location.

Required?false
Position?3
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?4
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?5
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?6
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 > Reset-JobSchedulerOrder -OrderId Reporting -JobChain /sos/reporting/Reporting

Resets the order "Reporting" from the specified job chain.

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

PS > Get-JobSchedulerOrder | Reset-JobSchedulerOrder

Resets all orders for all job chains.

-------------------------- EXAMPLE 3 --------------------------

PS > Get-JobSchedulerOrder -Directory /some_path -Recursive | Reset-JobSchedulerOrder

Resets orders that are configured with the "/some:path" directory and any sub-folders.

-------------------------- EXAMPLE 4 --------------------------

PS > Get-JobSchedulerOrder -JobChain /test/globals/chain1 | Reset-JobSchedulerOrder

Resets all orders for the specified job chain.

  • No labels