Public/Administration/Groups/Get-GlpiToolsGroups.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<#
.SYNOPSIS
    Function is getting Group informations from GLPI
.DESCRIPTION
    Function is based on GroupID which you can find in GLPI website
    Returns object with property's of group
.PARAMETER All
    This parameter will return all Groups from GLPI
.PARAMETER GroupId
    This parameter can take pipline input, either, you can use this function with -GroupId keyword.
    Provide to this param Group ID from GLPI Group Bookmark
.PARAMETER Raw
    Parameter which you can use with GroupId Parameter.
    GroupId has converted parameters from default, parameter Raw allows not convert this parameters.
.PARAMETER GroupName
    This parameter can take pipline input, either, you can use this function with -GroupName keyword.
    Provide to this param Group Name from GLPI Group Bookmark
.EXAMPLE
    PS C:\> Get-GlpiToolsGroups -All
    Example will return all Groups from Groups.
.EXAMPLE
    PS C:\> 326 | Get-GlpiToolsGroups
    Function gets GroupID from GLPI from Pipline, and return Group object
.EXAMPLE
    PS C:\> 326, 321 | Get-GlpiToolsGroups
    Function gets GroupID from GLPI from Pipline (u can pass many ID's like that), and return Group object
.EXAMPLE
    PS C:\> Get-GlpiToolsGroups -GroupId 326
    Function gets GroupID from GLPI which is provided through -GroupId after Function type, and return Group object
.EXAMPLE
    PS C:\> Get-GlpiToolsGroups -GroupId 326, 321
    Function gets GroupID from GLPI which is provided through -GroupId keyword after Function type (u can provide many ID's like that), and return Group object
.EXAMPLE
    PS C:\> Get-GlpiToolsGroups -GroupId 234 -Raw
    Example will show Group with id 234, but without any parameter converted
.EXAMPLE
    PS C:\> 234 | Get-GlpiToolsGroups -Raw
    Example will show Group with id 234, but without any parameter converted
.EXAMPLE
    PS C:\> Get-GlpiToolsGroups -GroupName glpi
    Example will return glpi Group, but what is the most important, Group will be shown exactly as you see in glpi Groups tab.
    If you want to add parameter, you have to modify "default items to show". This is the "key/tool" icon near search.
.INPUTS
    Group 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 Groups from GLPI
.NOTES
    PSP 03/2019
#>


function Get-GlpiToolsGroups {
    [CmdletBinding()]
    param (
        [parameter(Mandatory = $false,
            ParameterSetName = "All")]
        [switch]$All,

        [parameter(Mandatory = $true,
            ValueFromPipeline = $true,
            ParameterSetName = "GroupId")]
        [alias('GID')]
        [string[]]$GroupId,
        [parameter(Mandatory = $false,
            ParameterSetName = "GroupId")]
        [switch]$Raw,

        [parameter(Mandatory = $true,
            ParameterSetName = "GroupName")]
        [alias('GN')]
        [string]$GroupName
    )
    
    begin {

        $AppToken = $Script:AppToken
        $PathToGlpi = $Script:PathToGlpi
        $SessionToken = $Script:SessionToken

        $AppToken = Get-GlpiToolsConfig | Select-Object -ExpandProperty AppToken
        $PathToGlpi = Get-GlpiToolsConfig | Select-Object -ExpandProperty PathToGlpi
        $SessionToken = Set-GlpiToolsInitSession | Select-Object -ExpandProperty SessionToken

        $ChoosenParam = ($PSCmdlet.MyInvocation.BoundParameters).Keys

        $GroupObjectArray = [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)/Group/?range=0-9999999999999"
                }
                
                $GlpiGroupsAll = Invoke-RestMethod @params -Verbose:$false

                foreach ($GlpiGroup in $GlpiGroupsAll) {
                    $GroupHash = [ordered]@{ }
                            $GroupProperties = $GlpiGroup.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($GroupProp in $GroupProperties) {
                                $GroupHash.Add($GroupProp.Name, $GroupProp.Value)
                            }
                            $object = [pscustomobject]$GroupHash
                            $GroupObjectArray.Add($object)
                }
                $GroupObjectArray
                $GroupObjectArray = [System.Collections.Generic.List[PSObject]]::New()
            }
            GroupId { 
                foreach ( $GId in $GroupId ) {
                    $params = @{
                        headers = @{
                            'Content-Type'  = 'application/json'
                            'App-Token'     = $AppToken
                            'Session-Token' = $SessionToken
                        }
                        method  = 'get'
                        uri     = "$($PathToGlpi)/Group/$($GId)"
                    }

                    Try {
                        $GlpiGroup = Invoke-RestMethod @params -ErrorAction Stop

                        if ($Raw) {
                            $GroupHash = [ordered]@{ }
                            $GroupProperties = $GlpiGroup.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($GroupProp in $GroupProperties) {
                                $GroupHash.Add($GroupProp.Name, $GroupProp.Value)
                            }
                            $object = [pscustomobject]$GroupHash
                            $GroupObjectArray.Add($object)
                        } else {
                            $GroupHash = [ordered]@{ }
                            $GroupProperties = $GlpiGroup.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($GroupProp in $GroupProperties) {

                                $GroupPropNewValue = Get-GlpiToolsParameters -Parameter $GroupProp.Name -Value $GroupProp.Value

                                $GroupHash.Add($GroupProp.Name, $GroupPropNewValue)
                            }
                            $object = [pscustomobject]$GroupHash
                            $GroupObjectArray.Add($object)
                        }
                    } Catch {

                        Write-Verbose -Message "Group ID = $GId is not found"
                        
                    }
                    $GroupObjectArray
                    $GroupObjectArray = [System.Collections.Generic.List[PSObject]]::New()
                }
            }
            GroupName { 
                Search-GlpiToolsItems -SearchFor Group -SearchType contains -SearchValue $GroupName 
            }
            Default {
                
            }
        }
    }
    
    end {
        Set-GlpiToolsKillSession -SessionToken $SessionToken
    }
}