Public/Administration/Rules/Get-GlpiToolsRules.ps1
|
<#
.SYNOPSIS Function is getting Rules informations from GLPI .DESCRIPTION Function is based on RuleId which you can find in GLPI website Returns object with property's of Rules .PARAMETER All This parameter will return all Rules from GLPI .PARAMETER RuleId This parameter can take pipeline input, either, you can use this function with -RuleId keyword. Provide to this param RuleId from GLPI Rules Bookmark .PARAMETER Raw Parameter which you can use with RuleId Parameter. RuleId has converted parameters from default, parameter Raw allows not convert this parameters. .PARAMETER RuleName This parameter can take pipeline input, either, you can use this function with -RuleId keyword. Provide to this param Rules Name from GLPI Rules Bookmark .EXAMPLE PS C:\> Get-GlpiToolsRules -All Example will return all Rules from Glpi .EXAMPLE PS C:\> 326 | Get-GlpiToolsRules Function gets RuleId from GLPI from pipeline, and return Rules object .EXAMPLE PS C:\> 326, 321 | Get-GlpiToolsRules Function gets RuleId from GLPI from pipeline (u can pass many ID's like that), and return Rules object .EXAMPLE PS C:\> Get-GlpiToolsRules -RuleId 326 Function gets RuleId from GLPI which is provided through -RuleId after Function type, and return Rules object .EXAMPLE PS C:\> Get-GlpiToolsRules -RuleId 326, 321 Function gets Rules Id from GLPI which is provided through -RuleId keyword after Function type (u can provide many ID's like that), and return Rules object .EXAMPLE PS C:\> Get-GlpiToolsRules -RuleName Fusion Example will return glpi Rules, but what is the most important, Rules will be shown exactly as you see in glpi dropdown Rules. If you want to add parameter, you have to modify "default items to show". This is the "key/tool" icon near search. .INPUTS Rules ID which you can find in GLPI, or use this Function to convert ID returned from other Functions .OUTPUTS Function returns PSCustomObject with property's of Rules from GLPI .NOTES PSP 09/2019 #> function Get-GlpiToolsRules { [CmdletBinding()] param ( [parameter(Mandatory = $false, ParameterSetName = "All")] [switch]$All, [parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "RuleId")] [alias('RID')] [string[]]$RuleId, [parameter(Mandatory = $false, ParameterSetName = "RuleId")] [switch]$Raw, [parameter(Mandatory = $true, ParameterSetName = "RuleName")] [alias('RN')] [string]$RuleName ) begin { $SessionToken = $Script:SessionToken $AppToken = $Script:AppToken $PathToGlpi = $Script:PathToGlpi $SessionToken = Set-GlpiToolsInitSession | Select-Object -ExpandProperty SessionToken $AppToken = Get-GlpiToolsConfig | Select-Object -ExpandProperty AppToken $PathToGlpi = Get-GlpiToolsConfig | Select-Object -ExpandProperty PathToGlpi $ChoosenParam = ($PSCmdlet.MyInvocation.BoundParameters).Keys $RulesArray = [System.Collections.Generic.List[PSObject]]::New() } process { switch ($ChoosenParam) { All { $params = @{ headers = @{ 'Content-Type' = 'application/json' 'App-Token' = $AppToken 'Session-Token' = $SessionToken } method = 'get' uri = "$($PathToGlpi)/rule/?range=0-9999999999999" } $RulesAll = Invoke-RestMethod @params -Verbose:$false foreach ($RuleName in $RulesAll) { $RuleNameHash = [ordered]@{ } $RuleNameProperties = $RuleName.PSObject.Properties | Select-Object -Property Name, Value foreach ($RuleNameProp in $RuleNameProperties) { $RuleNameHash.Add($RuleNameProp.Name, $RuleNameProp.Value) } $object = [pscustomobject]$RuleNameHash $RulesArray.Add($object) } $RulesArray $RulesArray = [System.Collections.Generic.List[PSObject]]::New() } RuleId { foreach ( $RId in $RuleId ) { $params = @{ headers = @{ 'Content-Type' = 'application/json' 'App-Token' = $AppToken 'Session-Token' = $SessionToken } method = 'get' uri = "$($PathToGlpi)/rule/$($RId)" } Try { $RuleName = Invoke-RestMethod @params -ErrorAction Stop if ($Raw) { $RuleNameHash = [ordered]@{ } $RuleNameProperties = $RuleName.PSObject.Properties | Select-Object -Property Name, Value foreach ($RuleNameProp in $RuleNameProperties) { $RuleNameHash.Add($RuleNameProp.Name, $RuleNameProp.Value) } $object = [pscustomobject]$RuleNameHash $RulesArray.Add($object) } else { $RuleNameHash = [ordered]@{ } $RuleNameProperties = $RuleName.PSObject.Properties | Select-Object -Property Name, Value foreach ($RuleNameProp in $RuleNameProperties) { $RuleNamePropNewValue = Get-GlpiToolsParameters -Parameter $RuleNameProp.Name -Value $RuleNameProp.Value $RuleNameHash.Add($RuleNameProp.Name, $RuleNamePropNewValue) } $object = [pscustomobject]$RuleNameHash $RulesArray.Add($object) } } Catch { Write-Verbose -Message "Rule ID = $RId is not found" } $RulesArray $RulesArray = [System.Collections.Generic.List[PSObject]]::New() } } RuleName { Search-GlpiToolsItems -SearchFor rule -SearchType contains -SearchValue $RuleName } Default { } } } end { Set-GlpiToolsKillSession -SessionToken $SessionToken } } |