Public/Remove-GLSystemGrokPattern.ps1
<#
.SYNOPSIS Remove an existing pattern by id .DESCRIPTION Remove an existing pattern by id For more information about this cmdlet - please search for /system/grok/{patternId} in the docs available at http(s)://your-graylog.fqdn/api/api-docs .EXAMPLE Remove-GLSystemGrokPattern -Patternid <String> .NOTES Auto generated #> function Remove-GLSystemGrokPattern { [CmdletBinding(SupportsShouldProcess,ConfirmImpact = 'Medium')] param( # Parameter patternId [Parameter(Mandatory = $True,ValueFromPipelineByPropertyName = $true)] [string]$Patternid, # 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($Patternid,"Remove an existing pattern by id")) { $QueryArray = @() if (![string]::IsNullOrEmpty($Patternid)) { $Patternid = [system.web.httputility]::UrlEncode($Patternid) $QueryArray += "patternId=$Patternid" } $Headers = @{ Accept = 'application/json'; 'X-Requested-By' = 'PSGraylog Module' } $APIPath = '/system/grok/{patternId}' $APIPath = $APIPath -replace "\{Patternid\}","$Patternid" try { Invoke-RestMethod -Method DELETE -Headers $Headers -ContentType 'application/json' -Uri "$APIUrl$APIPath" -Credential $Credential -ErrorAction Stop } catch { Write-Error -Exception $Error[0].Exception -Message $Error[0].Message -ErrorAction $ErrorActionPreference } } } end {} } |