Name
Send-JobSchedulerCommand
SYNOPSIS
Sends an XMl command to the JobScheduler Master.
SYNTAX
Send-JobSchedulerCommand [-Command] <String> [[-Headers] <Hashtable>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
JobScheduler Master supports a number of XML commands.
This cmdlet accepts XML commands and forwards them to the JobScheduler Master.
PARAMETERS
Command
-Command <String>
Specifies the XML command to be executed, e.g. <show_state/>
Required? | true |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByValue, ByPropertyName) |
Accept wildcard characters? | false |
Headers
-Headers <Hashtable>
A hashmap can be specified with name/value pairs for HTTP headers.
Required? | false |
Position? | 2 |
Default value | @{'Accept' = 'application/xml'} |
Accept pipeline input? | true (ByValue, 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 value | 0 |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
AuditTicketLink
-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 |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
$stateXml = Send-JobSchedulerCommand '<show_state/> '
Returns summary information and inventory of jobs and job chains.
-------------------------- EXAMPLE 2 --------------------------
$stateXml = Send-JobSchedulerCommand '<show_state/> ' @{'Accept'='application/xml'}
Returns summary information including the inventory while using individual HTTP headers.