Public/Update-GLSystemOutputs.ps1
|
<#
.SYNOPSIS Update output .DESCRIPTION Update output For more information about this cmdlet - please search for /system/outputs/{outputId} in the docs available at http(s)://your-graylog.fqdn/api/api-docs .EXAMPLE Update-GLSystemOutputs -Outputid <String> -Body <PSCustomObject> .NOTES Auto generated #> function Update-GLSystemOutputs { [CmdletBinding(SupportsShouldProcess,ConfirmImpact = 'Medium')] param( # The id of the output that should be deleted [Parameter(Mandatory = $True,ValueFromPipelineByPropertyName = $true)] [string]$Outputid, # Parameter JSON body [Parameter(Mandatory = $True,ValueFromPipelineByPropertyName = $true)] [pscustomobject]$Body, # Base url for the API, normally https://<grayloghost>:<port>/api [string]$APIUrl = $Global:GLApiUrl, # Graylog credentials as username:password or use Convert-GLTokenToCredential for token usage [pscredential]$Credential = $Global:GLCredential ) begin { if ([string]::IsNullOrEmpty($APIUrl)) { Write-Error -ErrorAction Stop -Exception "APIUrl not set" -Message "APIUrl was null or empty, refer to the documentation" } if ($Null -eq $Credential) { Write-Error -ErrorAction Stop -Exception "Credential not set" -Message "Credential not set - refer to the documentation for help" } } process { if ($PSCmdlet.ShouldProcess($Outputid,"Update output")) { $QueryArray = @() if (![string]::IsNullOrEmpty($Outputid)) { $Outputid = [system.web.httputility]::UrlEncode($Outputid) $QueryArray += "outputId=$Outputid" } if (![string]::IsNullOrEmpty($Body)) { $QueryArray += "JSON body=$Body" } $Headers = @{ Accept = 'application/json'; 'X-Requested-By' = 'PSGraylog Module' } $APIPath = '/system/outputs/{outputId}' $APIPath = $APIPath -replace "\{Outputid\}","$Outputid" try { Invoke-RestMethod -Method PUT -Headers $Headers -ContentType 'application/json' -Uri "$APIUrl$APIPath" -Credential $Credential -Body ($Body | ConvertTo-Json) -ErrorAction Stop } catch { if ($Error[0].Exception.Response.StatusCode.value__ -eq 404) { Write-Error -Exception $Error[0].Exception -Message "No such output on this node." -ErrorAction $ErrorActionPreference } else { Write-Error -Exception $Error[0].Exception -Message $Error[0].Message -ErrorAction $ErrorActionPreference } } } } end {} } |