Public/Remove-GLIndexerIndices.ps1
|
<#
.SYNOPSIS Delete an index. This will also trigger an index ranges rebuild job. .DESCRIPTION Delete an index. This will also trigger an index ranges rebuild job. For more information about this cmdlet - please search for /system/indexer/indices/{index} in the docs available at http(s)://your-graylog.fqdn/api/api-docs .EXAMPLE Remove-GLIndexerIndices -Index <String> .NOTES Auto generated #> function Remove-GLIndexerIndices { [CmdletBinding(SupportsShouldProcess,ConfirmImpact = 'Medium')] param( # Parameter index [Parameter(Mandatory = $False,ValueFromPipelineByPropertyName = $true)] [string]$Index, # 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($Index,"Delete an index. This will also trigger an index ranges rebuild job.")) { $QueryArray = @() if (![string]::IsNullOrEmpty($Index)) { $Index = [system.web.httputility]::UrlEncode($Index) $QueryArray += "index=$Index" } $Headers = @{ Accept = 'application/json'; 'X-Requested-By' = 'PSGraylog Module' } $APIPath = '/system/indexer/indices/{index}' $APIPath = $APIPath -replace "\{Index\}","$Index" try { Invoke-RestMethod -Method DELETE -Headers $Headers -ContentType 'application/json' -Uri "$APIUrl$APIPath" -Credential $Credential -ErrorAction Stop } catch { if ($Error[0].Exception.Response.StatusCode.value__ -eq 403) { Write-Error -Exception $Error[0].Exception -Message "You cannot delete the current deflector target index." -ErrorAction $ErrorActionPreference } else { Write-Error -Exception $Error[0].Exception -Message $Error[0].Message -ErrorAction $ErrorActionPreference } } } } end {} } |