Versions Compared

Key

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

...

A number of settings can be specified for example with the JOC Cockpit Settings page and with Identity Services.
This cmdlet allows such settings to store settings be stored programmatically.

Settings include a hierarchy of objects and are available with

$settings,$item = Get-JS7JOCSettings

* $settings: this object holds the original object returned by the REST Web Service API.
* $item: this object holds the PowerShell representation of the configuration items.

Changes should be not be applied to $settings, but to $item like this:

$item.cleanup.deployment_history_versions.value = 5;

Settings are stored by pipelining the original $settings object and by using the -Item parameter with the modified $item object like this:

$settings | Set-JS7JOCSettings -Item $item

The following REST Web Service API resources are used:

* /configuration/save

...

-Item <PSObject>
Specifies the PowerShell object of a configuratiom configuration item to be stored.

Required?true
Position?8
Default value
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 the JOC Cockpit.
This parameter is not mandatory. However, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

Required?false
Position?9
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 shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.

Required?false
Position?10
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 JobSchedulerJS7.

This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.

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

...