Versions Compared

Key

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

...

Remove-JobSchedulerOrder

SYNOPSIS

Removes a number of ad hoc orders in the JobScheduler Master.

...

Remove-JobSchedulerOrder [-OrderIdOrder] <String> [-JobChain] <String> [[-Directory] <String>] [[-AuditCommentPath] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

Only Ad hoc orders can be removed. Such orders are not permanently stored in files
but instead have been added on-the-fly. Typically ad hoc orders are created
for one-time execution of a job chain.

Orders are selected for removal

* by a pipelined object, e.g. the output of the Get-JobSchedulerOrder cmdlet
* by specifying an individual order with the -OrderId Order and -JobChain parameters.

PARAMETERS

...

Order

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

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

...

-JobChain <String>
Specifies the path and name of a job chain for which an order should be removed.
If the name of a job chain is specified then the -Directory parameter is used to determine the folder.

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

...

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

...

Path

-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. Path <String>

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

AuditTimeSpent

...

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

...

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

...

PS > Remove-JobSchedulerOrder -OrderId Order 234 -JobChain sos/reporting/Reporting

Removes the order from the indicated specified job chain.

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

PS > Get-JobSchedulerOrder -Temporary NoPermanent | Remove-JobSchedulerOrder

...

PS > Get-JobSchedulerOrder -Directory /sos -Recursive NoPermanent | Remove-JobSchedulerOrder

Retrieves and removes all ad hoc orders from the indicated specified directory including any sub-folderssubfolders.