Transform your operations with intelligent AI Agents tailored to your business. Join us to modernize workflows, boost efficiency, and unlock new growth.
Let’s implement AI Agents that work the way your business does.
]]>First, go to the doc which describing the Search Function
Search-GlpiToolsItems
Now you are able to put more filtering on a search, you can link with the operators like AND
But the better way to descibe it, is to have a real example
Here is command which gets the computers
Search-GlpiToolsItems -SearchFor Computer -SearchType contains, contains -SearchField 1, 40 -SearchValue c, virtual -SearchLink AND
And now:
SearchFor here we put what we want to search
SearchType here you can specify a type of a search, you can choose between values like contains equals and more, you can put here more than one type
SearchField here you need to specify field of a search which you can get from different command, and as well you can put here more than one value
SearchValue put here values that you want to search, you can put more than one
SearchLink here you are able to choose how do you want to link these values, you have two values for SearchType, SearchField, SearchValue you linking them with one SearchLink like in a example
This command has backward compatibility so you shoudn’t have problems with your scripts after module update, but be aware of this!
]]>If you reading this article, I assume that you already did steps from: How to start with GlpiTools Module
There is a few things that you have to know about the module, and in my opinion is important to know them
Ok, Let’s go 😀
Configuration is just a .json file
I secure (just to hide real values, because converting is easy to revert) configuration parameters by converting them to secure strings
Depend on OS where do you use module, Configuration is stored in different places
On Linux
"$env:HOME/.config/GlpiToolsConfig\Configuration.json"
On Windows
"$env:LOCALAPPDATA\GlpiToolsConfig\Configuration.json"
This file is using for autocomplete parameters from functions like:
Get-GlpiToolsItems
Get-GlpiToolsListSearchOptions
Search-GlpiToolsItems
Add-GlpiToolsItems
Update-GlpiToolsItems
Remove-GlpiToolsItems
Parameters.json is located inside the module, inside Private folder
On my computer this is:
"c:\Program Files\WindowsPowerShell\Modules\GlpiTools\Private\"
But, you have to check in your system where module is installed
Check inside folders shown by command
$env:PSModulePath
The most important thing is that, you can add to the file your own endpoints/components!!
Do you installed new plugin and want to use it with module? You don’t have to wait for new functions or write it on your own
All what you doing is
like:
"GlpiComponents": [
"Computer",
"Monitor",
"Software",
"NetworkEquipment",
"Peripheral",
"Printer",
"provide it here"
]
The best way to find name of the endpoint/component is to look on database structure and names of the tables
Then you have to remember, to make a copy of this file if you updating/installing on your system or installing module on another system or server etc…
Function Search-GlpiToolsItems, can a little bit confuse you if you don’t know two things
This function will show that many properties, as see user which is use in API
But, the best way is to show it on example
We have a Computers Tab, you are logged in as user used in API
You see only three properites: ID, Name, and Serial number of all computers there
You use
Get-GlpiToolsComputers -All
And you get all computers with all properties inside
Then, you use
Search-GlpiToolsItems -SearchFor Computer -SearchType contains -SearchValue <name of computer>
And get only 3 properties, why?
Because, to get that you have to modify the view in GUI
There is icon like “key” or “keytool” where you can define which properties do you see
Add there that many parameters, as you want to see when you will use Search function
Function has one special parameter called “-SearchField”
This is a parameter where you provide an ID or parameter from output of another function
Get-GlpiToolsListSearchOptions
By default Search function use parameter “name”, but if you want to search computer by property “serial number” you have to know which ID “serial number” has
This parameter is not mandatory, but is good to know how it works and how you can customize command to Search not only for names
And that’s it 😀
If you have more questions, feel free to find me and PM on FB or Twitter
To start with module GlpiTools which wrap Glpi API into PowerShell functions you have to complete few steps below.
Run PowerShell console with elevated permissions - its important!
Install-Module -Name GlpiTools
After Module Instalation from PS Gallery you have to import module to use
Import-Module -Name GlpiTools
Last step, and you are ready to go!
$param = {
AppToken = "provide here app_token"
UserToken = "provide here user_token"
PathToGlpi = "provide here URL of the API"
}
Set-GlpiToolsConfig @param
You can check existing configuration by running
Get-GlpiToolsConfig
There is always one configuration, so if you want to change, you have to run commands from “Set API configuration” step
Enjoy!
]]>