Name
Remove-JobSchedulerOrder
SYNOPSIS
Removes a number of ad hoc orders in the JobScheduler Master.
SYNTAX
Remove-JobSchedulerOrder [-Order] <String> [-JobChain] <String> [[-Directory] <String>] [[-Path] <String>] [<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 -Order and -JobChain parameters.
PARAMETERS
Order
-Order <String>
Specifies the identifier of an order.
Both parameters -Order 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 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 -Order 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 |
Path
-Path <String>
| Required? | false |
| Position? | 4 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Remove-JobSchedulerOrder -Order 234 -JobChain sos/reporting/Reporting
Removes the order from the specified job chain.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerOrder -NoPermanent | Remove-JobSchedulerOrder
Retrieves and removes all ad hoc orders.
-------------------------- EXAMPLE 3 --------------------------
PS > Get-JobSchedulerOrder -Directory /sos -NoPermanent | Remove-JobSchedulerOrder
Retrieves and removes all ad hoc orders from the specified directory including subfolders.