Public/Assets/Cartridges/Get-GlpiToolsCartridgeItems.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 CartridgeItem informations from GLPI
.DESCRIPTION
    Function is based on CartridgeItemID which you can find in GLPI website
    Returns object with property's of CartridgeItem
.PARAMETER All
    This parameter will return all CartridgeItems from GLPI
.PARAMETER CartridgeItemId
    This parameter can take pipline input, either, you can use this function with -CartridgeItemId keyword.
    Provide to this param CartridgeItem ID from GLPI CartridgeItems Bookmark
.PARAMETER Raw
    Parameter which you can use with CartridgeItemId Parameter.
    CartridgeItemId has converted parameters from default, parameter Raw allows not convert this parameters.
.PARAMETER CartridgeItemName
    Provide to this param CartridgeItem Name from GLPI CartridgeItems Bookmark
.PARAMETER SearchInTrash
    Parameter which you can use with CartridgeItemName Parameter.
    If you want Search for CartridgeItem name in trash, that parameter allow you to do it.
.PARAMETER Parameter
    Parameter which you can use with CartridgeItemId Parameter.
    If you want to get additional parameter of CartridgeItem object like, disks, or logs, use this parameter.
.EXAMPLE
    PS C:\> 326 | Get-GlpiToolsCartridgeItems
    Function gets CartridgeItemID from GLPI from Pipline, and return CartridgeItem object
.EXAMPLE
    PS C:\> 326, 321 | Get-GlpiToolsCartridgeItems
    Function gets CartridgeItemID from GLPI from Pipline (u can pass many ID's like that), and return CartridgeItem object
.EXAMPLE
    PS C:\> Get-GlpiToolsCartridgeItems -CartridgeItemId 326
    Function gets CartridgeItemID from GLPI which is provided through -CartridgeItemId after Function type, and return CartridgeItem object
.EXAMPLE
    PS C:\> Get-GlpiToolsCartridgeItems -CartridgeItemId 326, 321
    Function gets CartridgeItemID from GLPI which is provided through -CartridgeItemId keyword after Function type (u can provide many ID's like that), and return CartridgeItem object
.EXAMPLE
    PS C:\> Get-GlpiToolsCartridgeItems -CartridgeItemId 234 -Raw
    Example will show CartridgeItem with id 234, but without any parameter converted
.EXAMPLE
    PS C:\> 234 | Get-GlpiToolsCartridgeItems -Raw
    Example will show CartridgeItem with id 234, but without any parameter converted
.EXAMPLE
    PS C:\> Get-GlpiToolsCartridgeItems -CartridgeItemName glpi
    Example will return glpi CartridgeItem, but what is the most important, CartridgeItem will be shown exacly as you see in glpi CartridgeItems 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-GlpiToolsCartridgeItems -CartridgeItemName glpi -SearchInTrash Yes
    Example will return glpi CartridgeItem, but from trash
.INPUTS
    CartridgeItem 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 CartridgeItems from GLPI
.NOTES
    PSP 05/2019
#>


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

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

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

        [parameter(Mandatory = $false,
            ParameterSetName = "CartridgeItemId")]
        [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

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

                foreach ($GlpiCartridgeItem in $GlpiCartridgeItemAll) {
                    $CartridgeItemHash = [ordered]@{ }
                            $CartridgeItemProperties = $GlpiCartridgeItem.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($CartridgeItemProp in $CartridgeItemProperties) {
                                $CartridgeItemHash.Add($CartridgeItemProp.Name, $CartridgeItemProp.Value)
                            }
                            $object = [pscustomobject]$CartridgeItemHash
                            $CartridgeItemObjectArray.Add($object)
                }
                $CartridgeItemObjectArray
                $CartridgeItemObjectArray = [System.Collections.Generic.List[PSObject]]::New()
            }
            CartridgeItemId { 
                foreach ( $CIId in $CartridgeItemId ) {
                    $params = @{
                        headers = @{
                            'Content-Type'  = 'application/json'
                            'App-Token'     = $AppToken
                            'Session-Token' = $SessionToken
                        }
                        method  = 'get'
                        uri     = "$($PathToGlpi)/CartridgeItem/$($CIId)$ParamValue"
                    }

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

                        if ($Raw) {
                            $CartridgeItemHash = [ordered]@{ }
                            $CartridgeItemProperties = $GlpiCartridgeItem.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($CartridgeItemProp in $CartridgeItemProperties) {
                                $CartridgeItemHash.Add($CartridgeItemProp.Name, $CartridgeItemProp.Value)
                            }
                            $object = [pscustomobject]$CartridgeItemHash
                            $CartridgeItemObjectArray.Add($object)
                        } else {
                            $CartridgeItemHash = [ordered]@{ }
                            $CartridgeItemProperties = $GlpiCartridgeItem.PSObject.Properties | Select-Object -Property Name, Value 
                                
                            foreach ($CartridgeItemProp in $CartridgeItemProperties) {

                                $CartridgePropNewValue = Get-GlpiToolsParameters -Parameter $CartridgeItemProp.Name -Value $CartridgeItemProp.Value
                                $CartridgeItemHash.Add($CartridgeItemProp.Name, $CartridgePropNewValue)

                            }
                            $object = [pscustomobject]$CartridgeItemHash
                            $CartridgeItemObjectArray.Add($object)
                        }
                    } Catch {

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