< Back

Get-GlpiToolsCartridgeItems

Mon Jan 13, 2020 9:11 pm

NAME Get-GlpiToolsCartridgeItems



SYNOPSIS

Function is getting CartridgeItem informations from GLPI





SYNTAX

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



Get-GlpiToolsCartridgeItems -CartridgeItemId <String[]> [-Raw] [-Parameter <String>] [<CommonParameters>]



Get-GlpiToolsCartridgeItems -CartridgeItemName <String> [-SearchInTrash <String>] [<CommonParameters>]





DESCRIPTION

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

Returns object with property's of CartridgeItem





PARAMETERS

-All [<SwitchParameter>]

This parameter will return all CartridgeItems from GLPI



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-CartridgeItemId <String[]>

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



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Raw [<SwitchParameter>]

Parameter which you can use with CartridgeItemId Parameter.

CartridgeItemId 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



-CartridgeItemName <String>

Provide to this param CartridgeItem Name from GLPI CartridgeItems Bookmark



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SearchInTrash <String>

Parameter which you can use with CartridgeItemName Parameter.

If you want Search for CartridgeItem 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 CartridgeItemId Parameter.

If you want to get additional parameter of CartridgeItem 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

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



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



PS C:\\>326 | Get-GlpiToolsCartridgeItems



Function gets CartridgeItemID from GLPI from Pipline, and return CartridgeItem object









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



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 3 --------------------------



PS C:\\>Get-GlpiToolsCartridgeItems -CartridgeItemId 326



Function gets CartridgeItemID from GLPI which is provided through -CartridgeItemId after Function type, and return

CartridgeItem object









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



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 5 --------------------------



PS C:\\>Get-GlpiToolsCartridgeItems -CartridgeItemId 234 -Raw



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









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



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



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









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



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 8 --------------------------



PS C:\\>Get-GlpiToolsCartridgeItems -CartridgeItemName glpi -SearchInTrash Yes



Example will return glpi CartridgeItem, but from trash











RELATED LINKS