PowerShell CLI 2.0 - Cmdlets - Set-JS7JOCSettings

Name

Set-JS7JOCSettings

SYNOPSIS

Stores JS7 settings

SYNTAX

Set-JS7JOCSettings [[-ConfigurationType] <String>] [-ConfigurationItem] <String> [[-ObjectType] <String>] [[-Name] <String>] [[-Id] <Int32>] [[-ControllerId] <String>] [[-Account] <String>] [-Shared] [-Item] <PSObject> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

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 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 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

PARAMETERS

ConfigurationType

-ConfigurationType <String>
Populated from a pipelined settings object.

ConfigurationItem

-ConfigurationItem <String>
Populated from a pipelined settings object.

ObjectType

-ObjectType <String>
Populated from a pipelined settings object.

Name

-Name <String>
Populated from a pipelined settings object.

Id

-Id <Int32>
Populated from a pipelined settings object.

ControllerId

-ControllerId <String>
Populated from a pipelined settings object.

Account

-Account <String>
Populated from a pipelined settings object.

Shared

-Shared <SwitchParameter>
Populated from a pipelined settings object.

Item

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

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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.

AuditTicketLink

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.

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

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > $settings,$item = Get-JS7JOCSettings;
$item.cleanup.deployment_history_versions.value = 5;
$settings | Set-JS7JOCSettings -Item $item

Reads, modifies and stores global settings.

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

PS > $settings,$item = Get-JS7JOCSettings -ConfigurationType 'IAM' -ObjectType 'LDAP' -Name 'PublicLDAP';
$item.ldap.expert.iamLdapServerUrl = 'ldap://ldap.forumsys.com:389';
$settings | Set-JS7JOCSettings -Item $item

Reads, modifies and stores settings of an LDAP Identity Service.