Public/Assets/Phones/Get-GlpiToolsPhones.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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<#
.SYNOPSIS
    Function is getting Phone informations from GLPI
.DESCRIPTION
    Function is based on PhoneID which you can find in GLPI website
    Returns object with property's of Phone
.PARAMETER All
    This parameter will return all Phones from GLPI
.PARAMETER PhoneId
    This parameter can take pipline input, either, you can use this function with -PhoneId keyword.
    Provide to this param Phone ID from GLPI Phones Bookmark
.PARAMETER Raw
    Parameter which you can use with PhoneId Parameter.
    PhoneId has converted parameters from default, parameter Raw allows not convert this parameters.
.PARAMETER PhoneName
    Provide to this param Phone Name from GLPI Phones Bookmark
.PARAMETER SearchInTrash
    Parameter which you can use with PhoneName Parameter.
    If you want Search for Phone name in trash, that parameter allow you to do it.
.PARAMETER Parameter
    Parameter which you can use with PhoneId Parameter.
    If you want to get additional parameter of Phone object like, disks, or logs, use this parameter.
.EXAMPLE
    PS C:\> 326 | Get-GlpiToolsPhones
    Function gets PhoneID from GLPI from Pipline, and return Phone object
.EXAMPLE
    PS C:\> 326, 321 | Get-GlpiToolsPhones
    Function gets PhoneID from GLPI from Pipline (u can pass many ID's like that), and return Phone object
.EXAMPLE
    PS C:\> Get-GlpiToolsPhones -PhoneId 326
    Function gets PhoneID from GLPI which is provided through -PhoneId after Function type, and return Phone object
.EXAMPLE
    PS C:\> Get-GlpiToolsPhones -PhoneId 326, 321
    Function gets PhoneID from GLPI which is provided through -PhoneId keyword after Function type (u can provide many ID's like that), and return Phone object
.EXAMPLE
    PS C:\> Get-GlpiToolsPhones -PhoneId 234 -Raw
    Example will show Phone with id 234, but without any parameter converted
.EXAMPLE
    PS C:\> 234 | Get-GlpiToolsPhones -Raw
    Example will show Phone with id 234, but without any parameter converted
.EXAMPLE
    PS C:\> Get-GlpiToolsPhones -PhoneName glpi
    Example will return glpi Phone, but what is the most important, Phone will be shown exacly as you see in glpi Phones tab.
    If you want to add parameter, you have to modify "default items to show". This is the "key/tool" icon near search.
.EXAMPLE
    PS C:\> Get-GlpiToolsPhones -PhoneName glpi -SearchInTrash Yes
    Example will return glpi Phone, but from trash
.INPUTS
    Phone 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 Phones from GLPI
.NOTES
    PSP 05/2019
#>


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

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

        [parameter(Mandatory = $true,
            ParameterSetName = "PhoneName")]
        [alias('PN')]
        [string]$PhoneName,
        [parameter(Mandatory = $false,
            ParameterSetName = "PhoneName")]
        [alias('SIT')]
        [ValidateSet("Yes", "No")]
        [string]$SearchInTrash = "No",

        [parameter(Mandatory = $false,
            ParameterSetName = "PhoneId")]
        [alias('Param')]
        [ValidateSet("ExpandDropdowns",
            "GetHateoas",
            "GetSha1",
            "WithDevices",
            "WithDisks",
            "WithSoftwares",
            "WithConnections",
            "WithNetworkports",
            "WithInfocoms",
            "WithContracts",
            "WithDocuments",
            "WithTickets",
            "WithProblems",
            "WithChanges",
            "WithNotes",
            "WithLogs")]
        [string]$Parameter
    )
    
    begin {

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

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

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

        $PhoneObjectArray = [System.Collections.Generic.List[PSObject]]::New()

        switch ($Parameter) {
            ExpandDropdowns { $ParamValue = "?expand_dropdowns=true" }
            GetHateoas { $ParamValue = "?get_hateoas=true" }
            GetSha1 { $ParamValue = "?get_sha1=true" }
            WithDevices { $ParamValue = "?with_devices=true" }
            WithDisks { $ParamValue = "?with_disks=true" }
            WithSoftwares { $ParamValue = "?with_softwares=true" }
            WithConnections { $ParamValue = "?with_connections=true" }
            WithNetworkports { $ParamValue = "?with_networkports=true" }
            WithInfocoms { $ParamValue = "?with_infocoms=true" }
            WithContracts { $ParamValue = "?with_contracts=true" }
            WithDocuments { $ParamValue = "?with_documents=true" }
            WithTickets { $ParamValue = "?with_tickets=true" } 
            WithProblems { $ParamValue = "?with_problems=true" }
            WithChanges { $ParamValue = "?with_changes=true" }
            WithNotes { $ParamValue = "?with_notes=true" } 
            WithLogs { $ParamValue = "?with_logs=true" }
            Default { $ParamValue = "" }
        }

    }
    
    process {
        switch ($ChoosenParam) {
            All { 
                $params = @{
                    headers = @{
                        'Content-Type'  = 'application/json'
                        'App-Token'     = $AppToken
                        'Session-Token' = $SessionToken
                    }
                    method  = 'get'
                    uri     = "$($PathToGlpi)/Phone/?range=0-9999999999999"
                }
                
                $GlpiPhoneAll = Invoke-RestMethod @params -Verbose:$false

                foreach ($GlpiPhone in $GlpiPhoneAll) {
                    $PhoneHash = [ordered]@{ }
                            $PhoneProperties = $GlpiPhone.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($PhoneProp in $PhoneProperties) {
                                $PhoneHash.Add($PhoneProp.Name, $PhoneProp.Value)
                            }
                            $object = [pscustomobject]$PhoneHash
                            $PhoneObjectArray.Add($object)
                }
                $PhoneObjectArray
                $PhoneObjectArray = [System.Collections.Generic.List[PSObject]]::New()
            }
            PhoneId { 
                foreach ( $PId in $PhoneId ) {
                    $params = @{
                        headers = @{
                            'Content-Type'  = 'application/json'
                            'App-Token'     = $AppToken
                            'Session-Token' = $SessionToken
                        }
                        method  = 'get'
                        uri     = "$($PathToGlpi)/Phone/$($PId)$ParamValue"
                    }

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

                        if ($Raw) {
                            $PhoneHash = [ordered]@{ }
                            $PhoneProperties = $GlpiPhone.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($PhoneProp in $PhoneProperties) {
                                $PhoneHash.Add($PhoneProp.Name, $PhoneProp.Value)
                            }
                            $object = [pscustomobject]$PhoneHash
                            $PhoneObjectArray.Add($object)
                        } else {
                            $PhoneHash = [ordered]@{ }
                            $PhoneProperties = $GlpiPhone.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($PhoneProp in $PhoneProperties) {

                                $PhonePropNewValue = Get-GlpiToolsParameters -Parameter $PhoneProp.Name -Value $PhoneProp.Value
                                $PhoneHash.Add($PhoneProp.Name, $PhonePropNewValue)

                            }
                            $object = [pscustomobject]$PhoneHash
                            $PhoneObjectArray.Add($object)
                        }
                    } Catch {

                        Write-Verbose -Message "Phone ID = $PId is not found"
                        
                    }
                    $PhoneObjectArray
                    $PhoneObjectArray = [System.Collections.Generic.List[PSObject]]::New()
                }
            }
            PhoneName { 
                Search-GlpiToolsItems -SearchFor Phone -SearchType contains -SearchValue $PhoneName -SearchInTrash $SearchInTrash
            }
            Default {
                
            }
        }
    }
    
    end {
        Set-GlpiToolsKillSession -SessionToken $SessionToken -Verbose:$false
    }
}