Public/ServiceSettings/Set-JIMServiceSetting.ps1
|
# Copyright (c) Tetron Limited. All rights reserved. # Licensed under the Tetron Commercial License. See LICENSE file in the project root. function Set-JIMServiceSetting { <# .SYNOPSIS Updates a service setting value in JIM. .DESCRIPTION Sets the value of a configurable service setting. Read-only settings (mirrored from environment variables) cannot be modified through this cmdlet. An audit activity is created for each update. .PARAMETER Key The key of the setting to change, such as "ChangeTracking.CsoChanges.Enabled". .PARAMETER Value The new value, as a string. .PARAMETER ChangeReason Optional reason for the change, recorded on the audit Activity and shown in the setting's Configuration Change History. .PARAMETER PassThru Returns the setting as updated. .OUTPUTS With -PassThru, the setting as updated; otherwise nothing. .EXAMPLE Set-JIMServiceSetting -Key "ChangeTracking.CsoChanges.Enabled" -Value "false" Disables CSO change tracking. .EXAMPLE Set-JIMServiceSetting -Key "Sync.PageSize" -Value "1000" -PassThru Sets the sync page size to 1000 and returns the updated setting. .EXAMPLE Set-JIMServiceSetting -Key "History.RetentionPeriod" -Value "30.00:00:00" -ChangeReason "Reduce per CHG0102" Sets the history retention period, recording the reason in the setting's change history. .LINK Get-JIMServiceSetting Reset-JIMServiceSetting #> [CmdletBinding(SupportsShouldProcess)] [OutputType('JIM.ServiceSettingDto')] param( [Parameter(Mandatory, Position = 0)] [string]$Key, [Parameter(Mandatory, Position = 1)] [AllowNull()] [AllowEmptyString()] [string]$Value, [Parameter()] [string]$ChangeReason, [switch]$PassThru ) process { # Check connection first if (-not $script:JIMConnection) { Write-Error "You are not connected to JIM. Run Connect-JIM -Url <your JIM URL> to authenticate, then try again." return } if ($PSCmdlet.ShouldProcess($Key, "Update service setting to '$Value'")) { Write-Verbose "Updating service setting: $Key = $Value" try { $body = @{ value = $Value } if ($ChangeReason) { $body.changeReason = $ChangeReason } $response = Invoke-JIMApi -Endpoint "/api/v1/service-settings/$Key" -Method 'PUT' -Body $body Write-Verbose "Updated service setting: $Key" if ($PassThru) { $response } } catch { Write-Error "Failed to update service setting '$Key': $_" } } } } |