Public/Get-GLSystemLookupCaches.ps1
|
<#
.SYNOPSIS List available caches .DESCRIPTION List available caches For more information about this cmdlet - please search for /system/lookup/caches in the docs available at http(s)://your-graylog.fqdn/api/api-docs .EXAMPLE Get-GLSystemLookupCaches -Page <Int> -Per_Page <Int> -Sort <String> -Order <String> -Query <String> .NOTES Auto generated #> function Get-GLSystemLookupCaches { [CmdletBinding()] param( # Parameter page [Parameter(Mandatory = $False,ValueFromPipelineByPropertyName = $true)] [int]$Page, # Parameter per_page [Parameter(Mandatory = $False,ValueFromPipelineByPropertyName = $true)] [int]$Per_Page, # The field to sort the result on [Parameter(Mandatory = $True,ValueFromPipelineByPropertyName = $true)] [string]$Sort, # The sort direction [Parameter(Mandatory = $False,ValueFromPipelineByPropertyName = $true)] [string]$Order, # Parameter query [Parameter(Mandatory = $False,ValueFromPipelineByPropertyName = $true)] [string]$Query, # 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 { $QueryArray = @() if (![string]::IsNullOrEmpty($Page)) { $QueryArray += "page=$Page" } if (![string]::IsNullOrEmpty($Per_Page)) { $QueryArray += "per_page=$Per_Page" } if (![string]::IsNullOrEmpty($Sort)) { $Sort = [system.web.httputility]::UrlEncode($Sort) $QueryArray += "sort=$Sort" } if (![string]::IsNullOrEmpty($Order)) { $Order = [system.web.httputility]::UrlEncode($Order) $QueryArray += "order=$Order" } if (![string]::IsNullOrEmpty($Query)) { $Query = [system.web.httputility]::UrlEncode($Query) $QueryArray += "query=$Query" } $Headers = @{ Accept = 'application/json'; 'X-Requested-By' = 'PSGraylog Module' } $APIPath = '/system/lookup/caches' $APIPath = $APIPath -replace "\{\}","$" $QueryString = $QueryArray -join '&' try { Invoke-RestMethod -Method GET -Headers $Headers -ContentType 'application/json' -Uri ($APIUrl + $APIPath + "?" + $QueryString) -Credential $Credential -ErrorAction Stop } catch { Write-Error -Exception $Error[0].Exception -Message $Error[0].Message -ErrorAction $ErrorActionPreference } } end {} } |