< Back

Get-GlpiToolsConsumableItems

Mon Jan 13, 2020 9:14 pm

NAME Get-GlpiToolsConsumableItems



SYNOPSIS

Function is getting ConsumableItem informations from GLPI





SYNTAX

Get-GlpiToolsConsumableItems [-All] [<CommonParameters>]



Get-GlpiToolsConsumableItems -ConsumableItemId <String[]> [-Raw] [-Parameter <String>] [<CommonParameters>]



Get-GlpiToolsConsumableItems -ConsumableItemName <String> [-SearchInTrash <String>] [<CommonParameters>]





DESCRIPTION

Function is based on ConsumableItemID which you can find in GLPI website

Returns object with property's of ConsumableItem





PARAMETERS

-All [<SwitchParameter>]

This parameter will return all ConsumableItems from GLPI



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ConsumableItemId <String[]>

This parameter can take pipline input, either, you can use this function with -ConsumableItemId keyword.

Provide to this param ConsumableItem ID from GLPI ConsumableItems Bookmark



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Raw [<SwitchParameter>]

Parameter which you can use with ConsumableItemId Parameter.

ConsumableItemId has converted parameters from default, parameter Raw allows not convert this parameters.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ConsumableItemName <String>

Provide to this param ConsumableItem Name from GLPI ConsumableItems Bookmark



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SearchInTrash <String>

Parameter which you can use with ConsumableItemName Parameter.

If you want Search for ConsumableItem name in trash, that parameter allow you to do it.



Required? false

Position? named

Default value No

Accept pipeline input? false

Accept wildcard characters? false



-Parameter <String>

Parameter which you can use with ConsumableItemId Parameter.

If you want to get additional parameter of ConsumableItem object like, disks, or logs, use this parameter.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

ConsumableItem 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 ConsumableItems from GLPI





NOTES





PSP 05/2019



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>326 | Get-GlpiToolsConsumableItems



Function gets ConsumableItemID from GLPI from Pipline, and return ConsumableItem object









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>326, 321 | Get-GlpiToolsConsumableItems



Function gets ConsumableItemID from GLPI from Pipline (u can pass many ID's like that), and return ConsumableItem

object









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-GlpiToolsConsumableItems -ConsumableItemId 326



Function gets ConsumableItemID from GLPI which is provided through -ConsumableItemId after Function type, and

return ConsumableItem object









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-GlpiToolsConsumableItems -ConsumableItemId 326, 321



Function gets ConsumableItemID from GLPI which is provided through -ConsumableItemId keyword after Function type

(u can provide many ID's like that), and return ConsumableItem object









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-GlpiToolsConsumableItems -ConsumableItemId 234 -Raw



Example will show ConsumableItem with id 234, but without any parameter converted









-------------------------- EXAMPLE 6 --------------------------



PS C:\\>234 | Get-GlpiToolsConsumableItems -Raw



Example will show ConsumableItem with id 234, but without any parameter converted









-------------------------- EXAMPLE 7 --------------------------



PS C:\\>Get-GlpiToolsConsumableItems -ConsumableItemName glpi



Example will return glpi ConsumableItem, but what is the most important, ConsumableItem will be shown exacly as

you see in glpi ConsumableItems tab.

If you want to add parameter, you have to modify "default items to show". This is the "key/tool" icon near search.









-------------------------- EXAMPLE 8 --------------------------



PS C:\\>Get-GlpiToolsConsumableItems -ConsumableItemName glpi -SearchInTrash Yes



Example will return glpi ConsumableItem, but from trash











RELATED LINKS