Versions Compared

Key

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

...

Send-JobSchedulerRequest [-Path] <String> [-Body] <String> [[-Id] <String>] [[-Method] <String>] [[-ContentType] <String>] [[-Headers] <Hashtable>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

...

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

Id

...

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

...

-Method <String>
This parameter specifies the HTTP method in use.

There should be no reason to modify the default value.

Default: POST

Required?false
Position?43
Default valuePOST
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-ContentType <String>
The HTTP content type is

* application/json for JSON requests
* application/xml for XML commands

The content type is automatically adjusted by the cmdlet if XML commands are used.

Default: application/json

Required?false
Position?54
Default valueapplication/xml
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-Headers <Hashtable>
A hashmap can be specified with name/value pairs for HTTP headers.
Typicall the Accept header is required for use of the REST API.

Required?false
Position?65
Default value@{'Accept' = 'application/xml'}
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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?76
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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?87
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?98
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...