SnipeitPS/docs/about_SnipeitPS.md

44 lines
977 B
Markdown
Raw Normal View History

2021-06-09 21:08:18 +03:00
# About SnipeitPS
## about_SnipeitPS
# SHORT DESCRIPTION
Powershell API Wrapper for Snipe-it.
# LONG DESCRIPTION
Collection of tools that makes interacting with Snipe-it api more pleasant.
# EXAMPLES
2021-06-09 21:12:30 +03:00
Prepare connection Snipe-It with:
2021-06-09 21:08:18 +03:00
Set-SnipeitInfo -url https://your.site -apikey YourVeryLongApiKey....
2021-06-09 21:12:30 +03:00
To search assets use:
2021-06-09 21:08:18 +03:00
Get-SnipeitAsset -search needle
Piping get and new commands results to set commands is supported. Followirg will
set notes for every asset that have model_id 123.
Get-SnipeitAsset -model_id 123 -all | Set-SnipeitAsset
2021-06-09 21:12:30 +03:00
You can get specific items with -id prameter like
2021-06-09 21:08:18 +03:00
2021-06-09 21:12:30 +03:00
Get-SnipeitModel -id 123
2021-06-09 21:08:18 +03:00
2021-06-09 21:12:30 +03:00
# NOTE
Most of commands are using same parameters as in Snipe It api,
but it's always good idea check syntax with Get-Help
2021-06-09 21:08:18 +03:00
2021-06-09 21:12:30 +03:00
# TROUBLESHOOTING NOTE
Check your api key and certificate on server first.
2021-06-09 21:08:18 +03:00
# SEE ALSO
2021-06-09 21:12:30 +03:00
Report any issues to:
[GitHub project page](https://github.com/snazy2000/SnipeitPS/issues)
2021-06-09 21:08:18 +03:00
# KEYWORDS
2021-06-09 21:12:30 +03:00
- Snipe-It
- asset management