Prefixed all commands and added aliases

This commit is contained in:
Petri Asikainen 2021-05-22 18:44:36 +03:00
parent bf13cdab6f
commit d4e2360d72
83 changed files with 399 additions and 753 deletions

View file

@ -21,10 +21,10 @@ Result offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Accessory -search Keyboard
@ -34,7 +34,7 @@ Get-Accessory -id 1
#>
function Get-Accessory() {
function Get-SnipeItAccessory() {
Param(
[string]$search,
@ -81,7 +81,7 @@ function Get-Accessory() {
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Accessory @callargs
$res=Get-SnipeItAccessory @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -54,10 +54,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Asset -url "https://assets.example.com"-token "token..."
@ -72,11 +72,11 @@ Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
Get-Asset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
#>
function Get-Asset() {
function Get-SnipeItAsset() {
Param(
[string]$search,
[string]$id,
[int]$id,
[string]$asset_tag,
@ -164,7 +164,7 @@ function Get-Asset() {
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Asset @callargs
$res=Get-SnipeItAsset @callargs
$res
if ( $res.count -lt $limit) {
break

View file

@ -24,10 +24,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-AssetMaintenances -url "https://assets.example.com" -token "token..."
@ -38,7 +38,7 @@ Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -tok
.EXAMPLE
Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
#>
function Get-AssetMaintenance() {
function Get-SnipeItAssetMaintenance() {
Param(
[string]$search,
@ -79,7 +79,7 @@ function Get-AssetMaintenance() {
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-AssetMaintenance @callargs
$res=Get-SnipeItAssetMaintenance @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
Url of Snipeit system, can be set using Set-Info command
Url of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Category -id 1
@ -31,12 +31,12 @@ Get-Category -search "Laptop"
#>
function Get-Category()
function Get-SnipeItCategory()
{
Param(
[string]$search,
[string]$id,
[int]$id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",
@ -81,7 +81,7 @@ function Get-Category()
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Category @callargs
$res=Get-SnipeItCategory @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -17,10 +17,10 @@ Offset to use
.PARAMETER all
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Company
@ -32,12 +32,12 @@ Gets specific company
#>
function Get-Company()
function Get-SnipeItCompany()
{
Param(
[string]$search,
[string]$id,
[int]$id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",
@ -82,7 +82,7 @@ function Get-Company()
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Company @callargs
$res=Get-SnipeItCompany @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system,can be set using Set-Info command
URL of Snipeit system,can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Component
@ -37,11 +37,11 @@ Returns specific component
#>
function Get-Component() {
function Get-SnipeItComponent() {
Param(
[string]$search,
[string]$id,
[int]$id,
[int]$category_id,
@ -95,7 +95,7 @@ function Get-Component() {
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Component @callargs
$res=Get-SnipeItComponent @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -6,17 +6,17 @@
A id of specific field
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Field -url "https://assets.example.com" -token "token..."
#>
function Get-CustomField()
function Get-SnipeItCustomField()
{
Param(
[int]$id,

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Department -url "https://assets.example.com" -token "token..."
@ -34,12 +34,12 @@ Get-Department -id 1
#>
function Get-Department()
function Get-SnipeItDepartment()
{
Param(
[string]$search,
[string]$id,
[int]$id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",
@ -87,7 +87,7 @@ function Get-Department()
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Department @callargs
$res=Get-SnipeItDepartment @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -6,10 +6,10 @@ Returns a fieldset or list of Snipe-it Fieldsets
A id of specific fieldset
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Fieldset -url "https://assets.example.com" -token "token..."
@ -19,7 +19,7 @@ Get-Fieldset -url "https://assets.example.com" -token "token..." | Where-Object
#>
function Get-Fieldset() {
function Get-SnipeItFieldset() {
Param(
[int]$id,

View file

@ -19,10 +19,10 @@ A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-License -search SomeLicense
@ -32,11 +32,11 @@ Get-License -id 1
#>
function Get-License() {
function Get-SnipeItLicense() {
Param(
[string]$search,
[string]$id,
[int]$id,
[string]$name,
@ -106,7 +106,7 @@ function Get-License() {
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-License @callargs
$res=Get-SnipeItLicense @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Location -search Location1
@ -36,7 +36,7 @@ function Get-SnipeitLocation()
Param(
[string]$search,
[string]$id,
[int]$id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Manufacturer -search HP
@ -33,12 +33,12 @@ Returns manufacturer with id 3
#>
function Get-Manufacturer()
function Get-SnipeItManufacturer()
{
Param(
[string]$search,
[string]$id,
[int]$id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",
@ -83,7 +83,7 @@ function Get-Manufacturer()
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Manufacturer @callargs
$res=Get-SnipeItManufacturer @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Model -search "DL380"
@ -31,7 +31,7 @@ Get-Model -id 1
#>
function Get-Model()
function Get-SnipeItModel()
{
Param(
[string]$search,
@ -81,7 +81,7 @@ function Get-Model()
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Model @callargs
$res=Get-SnipeItModel @callargs
$res
if ($res.count -ne $limit ) {
break

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Status -search "Ready to Deploy"
@ -31,12 +31,12 @@ Get-Status -id 3
#>
function Get-Status()
function Get-SnipeItStatus()
{
Param(
[string]$search,
[string]$id,
[int]$id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",
@ -81,7 +81,7 @@ function Get-Status()
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Status @callargs
$res=Get-SnipeItStatus @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -18,10 +18,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Supplier -search MySupplier
@ -31,12 +31,12 @@ Get-Supplier -id 2
#>
function Get-Supplier()
function Get-SnipeItSupplier()
{
Param(
[string]$search,
[string]$id,
[int]$id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",
@ -81,7 +81,7 @@ function Get-Supplier()
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-Supplier @callargs
$res=Get-SnipeItSupplier @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -24,10 +24,10 @@ Offset to use
A return all results, works with -offset and other parameters
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-User -search SomeSurname
@ -42,7 +42,7 @@ Get-User -username someuser
Get-User -email user@somedomain.com
#>
function Get-User() {
function Get-SnipeItUser() {
Param(
[string]$search,
@ -102,7 +102,7 @@ function Get-User() {
while ($true) {
$callargs['offset'] = $offstart
$callargs['limit'] = $limit
$res=Get-User @callargs
$res=Get-SnipeItUser @callargs
$res
if ($res.count -lt $limit) {
break

View file

@ -48,16 +48,16 @@ ID number of the location the accessory is assigned to
Min quantity of the accessory before alert is triggered
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Accessory -name "Accessory" -qty 3 -category_id 1
#>
function New-Accessory() {
function New-SnipeItAccessory() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -43,10 +43,10 @@ Optional Purchase cost of the Asset
Optional Default location id for the asset
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.PARAMETER customfields
Hastable of custom fields and extra fields that need passing through to Snipeit.
@ -65,7 +65,7 @@ New-Asset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit
Using customfields when creating asset.
#>
function New-Asset()
function New-SnipeItAsset()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -31,15 +31,15 @@ Optional completion date
Optional cost
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-AssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
#>
function New-AssetMaintenance() {
function New-SnipeItAssetMaintenance() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -16,7 +16,7 @@ New-Audit -tag 1 -location_id 1
#>
function New-Audit()
function New-SnipeItAudit()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -9,10 +9,10 @@ Name of new category to be created
Type of new category to be created (asset, accessory, consumable, component, license)
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.PARAMETER use_default_eula
If switch is present, use the primary default EULA
@ -27,7 +27,7 @@ If switch is present, send email to user on checkin/checkout
New-Category -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
#>
function New-Category()
function New-SnipeItCategory()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -9,17 +9,17 @@ Creates new company on Snipe-It system
Comapany name
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Company -name "Acme Company"
#>
function New-Company()
function New-SnipeItCompany()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -24,10 +24,10 @@ Date accessory was purchased
Cost of item being purchased.
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
An example
@ -36,7 +36,7 @@ An example
General notes
#>
function New-Component() {
function New-SnipeItComponent() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -9,16 +9,16 @@
Name of the Custom Field
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Field -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
#>
function New-CustomField()
function New-SnipeItCustomField()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -18,17 +18,17 @@
ID number of manager
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Department -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
#>
function New-Department() {
function New-SnipeItDepartment() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -57,17 +57,17 @@
Termination date for license.
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Licence -name "License" -seats 3 -company_id 1
#>
function New-License() {
function New-SnipeItLicense() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -36,16 +36,16 @@
The manager ID of the location
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Location -name "Room 1" -address "123 Asset Street" -parent_id 14
#>
function New-Location() {
function New-SnipeItLocation() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -9,16 +9,16 @@
Name of the Manufacturer
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Manufacturer -name "HP"
#>
function New-Manufacturer()
function New-SnipeItManufacturer()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -21,16 +21,16 @@
Fieldset ID that the asset uses (Custom fields)
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
#>
function New-Model()
function New-SnipeItModel()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -48,10 +48,10 @@
Mark user as import from ldap
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-user -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
@ -60,7 +60,7 @@
.NOTES
General notes
#>
function New-User() {
function New-SnipeItUser() {
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -1,21 +1,21 @@
<#
.SYNOPSIS
Removes Asset to Snipe-it asset system
Removes Asset from Snipe-it asset system
.DESCRIPTION
Long description
Removes Asset from Snipe-it asset system
.PARAMETER ID
Unique ID For Asset to be removed
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-Asset -ID 44 -Verbose
#>
function Remove-Asset ()
function Remove-SnipeItAsset ()
{
[CmdletBinding(
SupportsShouldProcess = $true,
@ -24,7 +24,7 @@ function Remove-Asset ()
Param(
[parameter(mandatory = $true)]
[string]$ID,
[int]$ID,
[parameter(mandatory = $true)]
[string]$URL,
[parameter(mandatory = $true)]

View file

@ -1,4 +1,4 @@
function Remove-AssetMaintenance {
function Remove-SnipeItAssetMaintenance {
<#
.SYNOPSIS
Remove asset maintenance from Snipe-it asset system
@ -7,10 +7,10 @@ function Remove-AssetMaintenance {
.PARAMETER ID
Unique ID of the asset maintenance to be removed
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-AssetMaintenance -ID 44 -url $url -apiKey $secret -Verbose
@ -22,7 +22,7 @@ function Remove-AssetMaintenance {
param (
# Asset maintenance ID
[Parameter(Mandatory = $true)]
[string]
[int]
$ID,
# SnipeIt URL

View file

@ -7,16 +7,16 @@
Unique ID For User to be removed
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
#>
function Remove-User ()
function Remove-SnipeItUser ()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -17,15 +17,15 @@
Notes about checkin
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command
.EXAMPLE
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
#>
function Reset-AssetOwner() {
function Reset-SnipeItAssetOwner() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Medium"

View file

@ -48,16 +48,16 @@ ID number of the location the accessory is assigned to
Min quantity of the accessory before alert is triggered
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command
.EXAMPLE
Set-Accessory -id 1 -qty 3
#>
function Set-Accessory() {
function Set-SnipeItAccessory() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -51,10 +51,10 @@
The id that corresponds to the location where the asset is usually located when not checked out
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command
.PARAMETER customfields
Hastable of custom fields and extra fields that need passing through to Snipeit
@ -66,7 +66,7 @@
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
#>
function Set-Asset()
function Set-SnipeItAsset()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -25,15 +25,15 @@
Optional date to override the checkout time of now
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
#>
function Set-AssetOwner()
function Set-SnipeItAssetOwner()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -27,10 +27,10 @@ Date accessory was purchased
Cost of item being purchased.
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
An example
@ -38,7 +38,7 @@ An example
.NOTES
General notes
#>
function Set-Component()
function Set-SnipeItComponent()
{
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -5,15 +5,15 @@
Set apikey and url user to connect Snipe-It system
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Set-Info -url $url -apiKey -Verbose
Set-SnipeItInfo -url $url -apiKey -Verbose
#>
function Set-Info {
function Set-SnipeItInfo {
[CmdletBinding()]
[System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')]
param (

View file

@ -60,17 +60,17 @@
Termination date for license.
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Set-Licence -name "License" -seats 3 -company_id 1
#>
function Set-License() {
function Set-SnipeItLicense() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Low"

View file

@ -36,10 +36,10 @@
Parent location as id
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Set-SnipeitLocation -id 123 -name "Some storage" -parent_id 100

View file

@ -24,16 +24,16 @@
Fieldset ID that the asset uses (Custom fields)
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
#>
function Set-Model() {
function Set-SnipeItModel() {
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Medium"

View file

@ -48,10 +48,10 @@
Mark user as import from ldap
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
.PARAMETER apiKey
User's API Key for Snipeit, can be set using Set-Info command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Update-user -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
@ -60,7 +60,7 @@
.NOTES
General notes
#>
function Set-User() {
function Set-SnipeItUser() {
[CmdletBinding(
SupportsShouldProcess = $true,

Binary file not shown.

View file

@ -1,3 +1,7 @@
<#
.DESCRIPTION
Powershell API for SnipeIt Asset Management
#>
$scriptRoot = $PSScriptRoot + '\Public'
Get-ChildItem $scriptRoot *.ps1 | ForEach-Object {
@ -9,3 +13,41 @@ $scriptRoot = $PSScriptRoot + '\Private'
Get-ChildItem $scriptRoot *.ps1 | ForEach-Object {
Import-Module $_.FullName
}
#Create unprefixed aliases
Set-Alias -Name Get-Asset -Value Get-SnipeItAsset
Set-Alias -Name Get-AssetMaintenance -Value Get-SnipeItAssetMaintenance
Set-Alias -Name Get-Category -Value Get-SnipeItCategory
Set-Alias -Name Get-Company -Value Get-SnipeItCompany
Set-Alias -Name Get-Component -Value Get-SnipeItCompany
Set-Alias -Name Get-CustomField -Value Get-SnipeItCustomField
Set-Alias -Name Get-Department -Value Get-SnipeItDepartment
Set-Alias -Name Get-Fieldset -Value Get-SnipeItFieldset
Set-Alias -Name Get-Manufacturer -Value Get-SnipeItManufacturer
Set-Alias -Name Get-Model -Value Get-SnipeItModel
Set-Alias -Name Get-Status -Value Get-SnipeItStatus
Set-Alias -Name Get-Supplier -Value Get-SnipeItSupplier
Set-Alias -Name Get-User -Value Get-SnipeItUser
Set-Alias -Name New-Asset -Value New-SnipeItAsset
Set-Alias -Name New-AssetMaintenance -Value New-SnipeItAssetMaintenance
Set-Alias -Name New-Category -Value New-SnipeItCategory
Set-Alias -Name New-Component -Value New-SnipeItComponent
Set-Alias -Name New-CustomField -Value New-SnipeItCustomField
Set-Alias -Name New-Department -Value New-SnipeItDepartment
Set-Alias -Name New-License -Value New-SnipeItLicense
Set-Alias -Name Set-License -Value Set-SnipeItLicense
Set-Alias -Name New-Location -Value New-SnipeItLocation
Set-Alias -Name New-Manufacturer -Value New-Manufacturer
Set-Alias -Name New-Model -Value New-SnipeItModel
Set-Alias -Name New-User -Value New-SnipeItUser
Set-Alias -Name Set-Asset -Value Set-SnipeItAsset
Set-Alias -Name Set-AssetOwner -Value Set-SnipeItAssetOwner
Set-Alias -Name Set-Component -Value Set-SnipeItComponent
Set-Alias -Name Set-Model -Value Set-SnipeItModel
Set-Alias -Name Set-Info -Value Set-SnipeItInfo
Set-Alias -Name Set-User -Value Set-SnipeItUser
Set-Alias -Name New-Accessory -Value New-SnipeItAccessory
Set-Alias -Name Set-Accessory -Value Set-SnipeItAccessory
Set-Alias -Name Get-Accessory -Value Get-SnipeItAccessory
Set-Alias -Name Remove-Asset -Value Remove-SnipeItAsset
Set-Alias -Name Remove-User -Value Remove-SnipeItUser

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Accessory
# Get-SnipeItAccessory
## SYNOPSIS
Gets a list of Snipe-it Accessories
@ -13,7 +13,7 @@ Gets a list of Snipe-it Accessories
## SYNTAX
```
Get-Accessory [[-search] <String>] [[-company_id] <Int32>] [[-category_id] <Int32>]
Get-SnipeItAccessory [[-search] <String>] [[-company_id] <Int32>] [[-category_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-supplier_id] <Int32>] [[-sort] <String>] [[-order] <String>]
[[-limit] <Int32>] [[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Asset
# Get-SnipeItAsset
## SYNOPSIS
Gets a list of Snipe-it Assets or specific asset
@ -13,7 +13,7 @@ Gets a list of Snipe-it Assets or specific asset
## SYNTAX
```
Get-Asset [[-search] <String>] [[-id] <String>] [[-asset_tag] <String>] [[-asset_serial] <String>]
Get-SnipeItAsset [[-search] <String>] [[-id] <Int32>] [[-asset_tag] <String>] [[-asset_serial] <String>]
[[-order_number] <Int32>] [[-model_id] <Int32>] [[-category_id] <Int32>] [[-manufacturer_id] <Int32>]
[[-company_id] <Int32>] [[-location_id] <Int32>] [[-depreciation_id] <Int32>] [[-requestable] <Boolean>]
[[-status] <String>] [[-status_id] <Int32>] [[-sort] <String>] [[-order] <String>] [[-limit] <Int32>]
@ -156,13 +156,13 @@ Accept wildcard characters: False
ID number of excact snipeit asset
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-AssetMaintenance
# Get-SnipeItAssetMaintenance
## SYNOPSIS
Lists Snipe-it Assets Maintenances
@ -13,7 +13,7 @@ Lists Snipe-it Assets Maintenances
## SYNTAX
```
Get-AssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort] <String>] [[-order] <String>]
Get-SnipeItAssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort] <String>] [[-order] <String>]
[[-limit] <Int32>] [-all] [[-offset] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Category
# Get-SnipeItCategory
## SYNOPSIS
Gets a list of Snipe-it Categories
@ -13,8 +13,8 @@ Gets a list of Snipe-it Categories
## SYNTAX
```
Get-Category [[-search] <String>] [[-id] <String>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItCategory [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
@ -68,13 +68,13 @@ Accept wildcard characters: False
A id of specific Category
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Company
# Get-SnipeItCompany
## SYNOPSIS
Gets a list of Snipe-it Companies
@ -13,8 +13,8 @@ Gets a list of Snipe-it Companies
## SYNTAX
```
Get-Company [[-search] <String>] [[-id] <String>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItCompany [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
@ -72,13 +72,13 @@ Accept wildcard characters: False
A id of specific Company
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Component
# Get-SnipeItComponent
## SYNOPSIS
Gets a list of Snipe-it Components
@ -13,7 +13,7 @@ Gets a list of Snipe-it Components
## SYNTAX
```
Get-Component [[-search] <String>] [[-id] <String>] [[-category_id] <Int32>] [[-company_id] <Int32>]
Get-SnipeItComponent [[-search] <String>] [[-id] <Int32>] [[-category_id] <Int32>] [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-order] <String>] [[-sort] <String>] [[-limit] <Int32>] [[-offset] <Int32>] [-all]
[-url] <String> [-apiKey] <String> [<CommonParameters>]
```
@ -110,13 +110,13 @@ Accept wildcard characters: False
A id of specific Component
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -1,19 +1,19 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-CustomField
# Get-SnipeItCustomField
## SYNOPSIS
Returns a list of all Snipe-IT custom fields
Returns specific Snipe-IT custom field or a list of all custom field
## SYNTAX
```
Get-CustomField [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItCustomField [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
@ -37,12 +37,27 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific field
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -52,7 +67,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Department
# Get-SnipeItDepartment
## SYNOPSIS
Gets a list of Snipe-it Departments
@ -13,8 +13,8 @@ Gets a list of Snipe-it Departments
## SYNTAX
```
Get-Department [[-search] <String>] [[-id] <String>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-all] [[-sort] <String>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItDepartment [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [[-sort] <String>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
@ -73,13 +73,13 @@ Accept wildcard characters: False
A id of specific Department
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -1,19 +1,19 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Fieldset
# Get-SnipeItFieldset
## SYNOPSIS
Gets a list of Snipe-it Fieldsets
Returns a fieldset or list of Snipe-it Fieldsets
## SYNTAX
```
Get-Fieldset [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItFieldset [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
@ -42,12 +42,27 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific fieldset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -57,7 +72,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

View file

@ -5,7 +5,7 @@ online version:
schema: 2.0.0
---
# Get-Manufacturer
# Get-SnipeItManufacturer
## SYNOPSIS
# Gets a list of Snipe-it Manufacturers
@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-Manufacturer [[-search] <String>] [[-id] <String>] [[-order] <String>] [[-limit] <Int32>]
Get-SnipeItManufacturer [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
@ -72,13 +72,13 @@ Accept wildcard characters: False
A id of specific Manufactuter
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Model
# Get-SnipeItModel
## SYNOPSIS
Gets a list of Snipe-it Models
@ -13,8 +13,8 @@ Gets a list of Snipe-it Models
## SYNTAX
```
Get-Model [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItModel [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-Status
# Get-SnipeItStatus
## SYNOPSIS
Gets a list of Snipe-it Status Labels
@ -13,8 +13,8 @@ Gets a list of Snipe-it Status Labels
## SYNTAX
```
Get-Status [[-search] <String>] [[-id] <String>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItStatus [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
@ -68,13 +68,13 @@ Accept wildcard characters: False
A id of specific Status Label
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -5,7 +5,7 @@ online version:
schema: 2.0.0
---
# Get-Supplier
# Get-SnipeItSupplier
## SYNOPSIS
# Gets a list of Snipe-it Suppliers
@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Get-Supplier [[-search] <String>] [[-id] <String>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeItSupplier [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
@ -68,13 +68,13 @@ Accept wildcard characters: False
A id of specific Suplier
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -5,7 +5,7 @@ online version:
schema: 2.0.0
---
# Get-User
# Get-SnipeItUser
## SYNOPSIS
# Gets a list of Snipe-it Users
@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-User [[-search] <String>] [[-id] <String>] [[-company_id] <Int32>] [[-location_id] <Int32>]
Get-SnipeItUser [[-search] <String>] [[-id] <String>] [[-company_id] <Int32>] [[-location_id] <Int32>]
[[-group_id] <Int32>] [[-department_id] <Int32>] [[-username] <String>] [[-email] <String>]
[[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String>
[<CommonParameters>]

View file

@ -1,168 +0,0 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-SnipeitLocation
## SYNOPSIS
Gets a list of Snipe-it Locations
## SYNTAX
```
Get-SnipeitLocation [[-search] <String>] [[-id] <String>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
{{ Fill in the Description }}
## EXAMPLES
### EXAMPLE 1
```
Get-Location -search Location1
```
### EXAMPLE 2
```
Get-Location -id 3
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Locations data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-Asset
# New-SnipeItAsset
## SYNOPSIS
Add a new Asset to Snipe-it asset system
@ -13,7 +13,7 @@ Add a new Asset to Snipe-it asset system
## SYNTAX
```
New-Asset [-status_id] <Int32> [-model_id] <Int32> [[-name] <String>] [[-asset_tag] <String>]
New-SnipeItAsset [-status_id] <Int32> [-model_id] <Int32> [[-name] <String>] [[-asset_tag] <String>]
[[-serial] <String>] [[-company_id] <Int32>] [[-order_number] <String>] [[-notes] <String>]
[[-warranty_months] <Int32>] [[-purchase_cost] <String>] [[-purchase_date] <String>] [[-supplier_id] <Int32>]
[[-rtd_location_id] <Int32>] [-url] <String> [-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf]

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-AssetMaintenance
# New-SnipeItAssetMaintenance
## SYNOPSIS
Add a new Asset maintenence to Snipe-it asset system
@ -13,7 +13,7 @@ Add a new Asset maintenence to Snipe-it asset system
## SYNTAX
```
New-AssetMaintenance [-asset_id] <Int32> [-supplier_id] <Int32> [-asset_maintenance_type] <String>
New-SnipeItAssetMaintenance [-asset_id] <Int32> [-supplier_id] <Int32> [-asset_maintenance_type] <String>
[-title] <String> [-start_date] <DateTime> [[-completion_date] <DateTime>] [[-is_warranty] <Boolean>]
[[-cost] <Decimal>] [[-notes] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-Category
# New-SnipeItCategory
## SYNOPSIS
Create a new Snipe-IT Category
@ -13,8 +13,8 @@ Create a new Snipe-IT Category
## SYNTAX
```
New-Category [-name] <String> [-category_type] <String> [-url] <String> [-apiKey] <String> [-use_default_eula]
[-require_acceptance] [-checkin_email] [-WhatIf] [-Confirm] [<CommonParameters>]
New-SnipeItCategory [-name] <String> [-category_type] <String> [-url] <String> [-apiKey] <String>
[-use_default_eula] [-require_acceptance] [-checkin_email] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-Component
# New-SnipeItComponent
## SYNOPSIS
Create a new component
@ -13,7 +13,7 @@ Create a new component
## SYNTAX
```
New-Component [-name] <String> [-category_id] <Int32> [-qty] <String> [[-company_id] <Int32>]
New-SnipeItComponent [-name] <String> [-category_id] <Int32> [-qty] <String> [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-purchase_date] <DateTime>] [[-purchase_cost] <Single>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-CustomField
# New-SnipeItCustomField
## SYNOPSIS
Add a new Custom Field to Snipe-it asset system
@ -13,7 +13,7 @@ Add a new Custom Field to Snipe-it asset system
## SYNTAX
```
New-CustomField [-Name] <String> [[-HelpText] <String>] [[-Element] <String>] [[-Format] <String>]
New-SnipeItCustomField [-Name] <String> [[-HelpText] <String>] [[-Element] <String>] [[-Format] <String>]
[[-field_encrypted] <Boolean>] [[-CustomFormat] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-Department
# New-SnipeItDepartment
## SYNOPSIS
Creates a department
@ -13,7 +13,7 @@ Creates a department
## SYNTAX
```
New-Department [-name] <String> [[-company_id] <Int32>] [[-location_id] <Int32>] [[-manager_id] <Int32>]
New-SnipeItDepartment [-name] <String> [[-company_id] <Int32>] [[-location_id] <Int32>] [[-manager_id] <Int32>]
[[-notes] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-License
# New-SnipeItLicense
## SYNOPSIS
Creates a licence
@ -13,7 +13,7 @@ Creates a licence
## SYNTAX
```
New-License [-name] <String> [-seats] <Int32> [[-category_id] <Int32>] [[-company_id] <Int32>]
New-SnipeItLicense [-name] <String> [-seats] <Int32> [[-category_id] <Int32>] [[-company_id] <Int32>]
[[-expiration_date] <DateTime>] [[-license_email] <MailAddress>] [[-license_name] <String>]
[[-maintained] <Boolean>] [[-manufacturer_id] <Int32>] [[-notes] <String>] [[-order_number] <String>]
[[-purchase_cost] <Single>] [[-purchase_date] <DateTime>] [[-reassignable] <Boolean>] [[-serial] <String>]

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-Location
# New-SnipeItLocation
## SYNOPSIS
Add a new Location to Snipe-it asset system
@ -13,7 +13,7 @@ Add a new Location to Snipe-it asset system
## SYNTAX
```
New-Location [-name] <String> [[-address] <String>] [[-address2] <String>] [[-state] <String>]
New-SnipeItLocation [-name] <String> [[-address] <String>] [[-address2] <String>] [[-state] <String>]
[[-country] <String>] [[-zip] <String>] [[-parent_id] <Int32>] [[-manager_id] <Int32>] [[-ldap_ou] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-Manufacturer
# New-SnipeItManufacturer
## SYNOPSIS
Add a new Manufacturer to Snipe-it asset system
@ -13,7 +13,8 @@ Add a new Manufacturer to Snipe-it asset system
## SYNTAX
```
New-Manufacturer [-Name] <String> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
New-SnipeItManufacturer [-Name] <String> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-Model
# New-SnipeItModel
## SYNOPSIS
Add a new Model to Snipe-it asset system
@ -13,7 +13,7 @@ Add a new Model to Snipe-it asset system
## SYNTAX
```
New-Model [-name] <String> [[-model_number] <String>] [-category_id] <Int32> [-manufacturer_id] <Int32>
New-SnipeItModel [-name] <String> [[-model_number] <String>] [-category_id] <Int32> [-manufacturer_id] <Int32>
[[-eol] <Int32>] [-fieldset_id] <Int32> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```

View file

@ -5,7 +5,7 @@ online version:
schema: 2.0.0
---
# New-User
# New-SnipeItUser
## SYNOPSIS
Creates a new user
@ -13,7 +13,7 @@ Creates a new user
## SYNTAX
```
New-User [-first_name] <String> [-last_name] <String> [-username] <String> [[-password] <String>]
New-SnipeItUser [-first_name] <String> [-last_name] <String> [-username] <String> [[-password] <String>]
[[-activated] <Boolean>] [[-notes] <String>] [[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>]
[[-company_id] <Int32>] [[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>]
[[-employee_num] <String>] [[-ldap_import] <Boolean>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
@ -130,7 +130,7 @@ Users first name
```yaml
Type: String
Parameter Sets: (All)
Aliases: firstName
Aliases:
Required: True
Position: 1
@ -160,7 +160,7 @@ Users last name
```yaml
Type: String
Parameter Sets: (All)
Aliases: lastName
Aliases:
Required: True
Position: 2
@ -175,7 +175,7 @@ Mark user as import from ldap
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases: ldap_user
Aliases:
Required: False
Position: 15

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Remove-Asset
# Remove-SnipeItAsset
## SYNOPSIS
Removes Asset to Snipe-it asset system
@ -13,7 +13,7 @@ Removes Asset to Snipe-it asset system
## SYNTAX
```
Remove-Asset [-ID] <String> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-SnipeItAsset [-ID] <Int32> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -47,13 +47,13 @@ Accept wildcard characters: False
Unique ID For Asset to be removed
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Remove-User
# Remove-SnipeItUser
## SYNOPSIS
Removes User from Snipe-it asset system
@ -13,7 +13,7 @@ Removes User from Snipe-it asset system
## SYNTAX
```
Remove-User [-ID] <String> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-SnipeItUser [-ID] <String> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-Accessory
# Set-SnipeItAccessory
## SYNOPSIS
Updates accessory on Snipe-It system
@ -13,7 +13,7 @@ Updates accessory on Snipe-It system
## SYNTAX
```
Set-Accessory [-id] <Int32> [[-name] <String>] [[-qty] <Int32>] [[-category_id] <Int32>]
Set-SnipeItAccessory [-id] <Int32> [[-name] <String>] [[-qty] <Int32>] [[-category_id] <Int32>]
[[-company_id] <Int32>] [[-manufacturer_id] <Int32>] [[-order_number] <String>] [[-purchase_cost] <Single>]
[[-purchase_date] <DateTime>] [[-min_qty] <Boolean>] [[-supplier_id] <Int32>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-Asset
# Set-SnipeItAsset
## SYNOPSIS
Update a specific Asset in the Snipe-it asset system
@ -13,7 +13,7 @@ Update a specific Asset in the Snipe-it asset system
## SYNTAX
```
Set-Asset [-id] <Int32> [[-Name] <String>] [[-Status_id] <String>] [[-Model_id] <String>]
Set-SnipeItAsset [-id] <Int32> [[-Name] <String>] [[-Status_id] <String>] [[-Model_id] <String>]
[[-last_checkout] <DateTime>] [[-assigned_to] <Int32>] [[-company_id] <Int32>] [[-serial] <String>]
[[-order_number] <String>] [[-warranty_months] <Int32>] [[-purchase_cost] <Double>]
[[-purchase_date] <DateTime>] [[-requestable] <Boolean>] [[-archived] <Boolean>] [[-rtd_location_id] <Int32>]

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-AssetOwner
# Set-SnipeItAssetOwner
## SYNOPSIS
Checkout asset
@ -13,7 +13,7 @@ Checkout asset
## SYNTAX
```
Set-AssetOwner [-id] <Int32> [-assigned_id] <Int32> [[-checkout_to_type] <String>] [[-name] <String>]
Set-SnipeItAssetOwner [-id] <Int32> [-assigned_id] <Int32> [[-checkout_to_type] <String>] [[-name] <String>]
[[-note] <String>] [[-expected_checkin] <DateTime>] [[-checkout_at] <DateTime>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-Component
# Set-SnipeItComponent
## SYNOPSIS
Updates component
@ -13,7 +13,7 @@ Updates component
## SYNTAX
```
Set-Component [-id] <String> [-qty] <String> [[-name] <String>] [[-company_id] <Int32>]
Set-SnipeItComponent [-id] <String> [-qty] <String> [[-name] <String>] [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-purchase_date] <DateTime>] [[-purchase_cost] <Single>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-Info
# Set-SnipeItInfo
## SYNOPSIS
Sets authetication information
@ -13,7 +13,7 @@ Sets authetication information
## SYNTAX
```
Set-Info [[-url] <Uri>] [[-apiKey] <String>] [<CommonParameters>]
Set-SnipeItInfo [[-url] <Uri>] [[-apiKey] <String>] [<CommonParameters>]
```
## DESCRIPTION

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-License
# Set-SnipeItLicense
## SYNOPSIS
Updates a licence
@ -13,7 +13,7 @@ Updates a licence
## SYNTAX
```
Set-License [-id] <Int32> [[-name] <String>] [[-seats] <Int32>] [[-category_id] <Int32>]
Set-SnipeItLicense [-id] <Int32> [[-name] <String>] [[-seats] <Int32>] [[-category_id] <Int32>]
[[-company_id] <Int32>] [[-expiration_date] <DateTime>] [[-license_email] <MailAddress>]
[[-license_name] <String>] [[-maintained] <Boolean>] [[-manufacturer_id] <Int32>] [[-notes] <String>]
[[-order_number] <String>] [[-purchase_cost] <Single>] [[-purchase_date] <DateTime>]

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-Model
# Set-SnipeItModel
## SYNOPSIS
Updates Model on Snipe-it asset system
@ -13,7 +13,7 @@ Updates Model on Snipe-it asset system
## SYNTAX
```
Set-Model [-id] <Int32> [[-name] <String>] [[-model_number] <String>] [[-category_id] <Int32>]
Set-SnipeItModel [-id] <Int32> [[-name] <String>] [[-model_number] <String>] [[-category_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-eol] <Int32>] [[-custom_fieldset_id] <Int32>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```

View file

@ -1,11 +1,11 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-User
# Set-SnipeItUser
## SYNOPSIS
Creates a new user
@ -13,7 +13,7 @@ Creates a new user
## SYNTAX
```
Set-User [-id] <Int32> [[-first_name] <String>] [[-last_name] <String>] [[-userName] <String>]
Set-SnipeItUser [-id] <Int32> [[-first_name] <String>] [[-last_name] <String>] [[-userName] <String>]
[[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>] [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>] [[-employee_num] <String>]
[[-activated] <Boolean>] [[-notes] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]

View file

@ -1,253 +0,0 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-SnipeitLocation
## SYNOPSIS
Updates Location in Snipe-it asset system
## SYNTAX
```
Set-SnipeitLocation [-id] <Int32> [[-name] <String>] [[-address] <String>] [[-address2] <String>]
[[-state] <String>] [[-country] <String>] [[-zip] <String>] [[-manager_id] <Int32>] [[-ldap_ou] <String>]
[[-parent_id] <Int32>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Long description
## EXAMPLES
### EXAMPLE 1
```
Set-SnipeitLocation -id 123 -name "Some storage" -parent_id 100
```
## PARAMETERS
### -address
Address line 1
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address2
Address line 2
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -country
Address Contry
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_ou
LDAP OU of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
Location manager as id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -parent_id
Parent location as id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -state
Address State
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
Address zipcode
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

View file

@ -1,115 +1,109 @@
---
Module Name: SnipeitPS
Module Guid: {{ Update Module Guid }}
Module Guid: f86f4db4-1cb1-45c4-b7bf-6762531bfdeb
Download Help Link: {{ Update Download Link }}
Help Version: {{ Update Help Version }}
Locale: {{ Update Locale }}
Help Version: {{ Please enter version of help manually (X.X.X.X) format }}
Locale: en-US
---
# SnipeitPS Module
## Description
{{ Fill in the Description }}
Powershell API for SnipeIt Asset Management
## SnipeitPS Cmdlets
### [Get-Accessory](Get-Accessory.md)
### [Get-SnipeItAccessory](Get-SnipeItAccessory.md)
Gets a list of Snipe-it Accessories
### [Get-Asset](Get-Asset.md)
### [Get-SnipeItAsset](Get-SnipeItAsset.md)
Gets a list of Snipe-it Assets or specific asset
### [Get-AssetMaintenance](Get-AssetMaintenance.md)
### [Get-SnipeItAssetMaintenance](Get-SnipeItAssetMaintenance.md)
Lists Snipe-it Assets Maintenances
### [Get-Category](Get-Category.md)
### [Get-SnipeItCategory](Get-SnipeItCategory.md)
Gets a list of Snipe-it Categories
### [Get-Company](Get-Company.md)
### [Get-SnipeItCompany](Get-SnipeItCompany.md)
Gets a list of Snipe-it Companies
### [Get-Component](Get-Component.md)
### [Get-SnipeItComponent](Get-SnipeItComponent.md)
Gets a list of Snipe-it Components
### [Get-CustomField](Get-CustomField.md)
Returns a list of all Snipe-IT custom fields
### [Get-SnipeItCustomField](Get-SnipeItCustomField.md)
Returns specific Snipe-IT custom field or a list of all custom field
### [Get-Department](Get-Department.md)
### [Get-SnipeItDepartment](Get-SnipeItDepartment.md)
Gets a list of Snipe-it Departments
### [Get-Fieldset](Get-Fieldset.md)
Gets a list of Snipe-it Fieldsets
### [Get-SnipeItFieldset](Get-SnipeItFieldset.md)
Returns a fieldset or list of Snipe-it Fieldsets
### [Get-Model](Get-Model.md)
### [Get-SnipeItModel](Get-SnipeItModel.md)
Gets a list of Snipe-it Models
### [Get-SnipeitLocation](Get-SnipeitLocation.md)
Gets a list of Snipe-it Locations
### [Get-Status](Get-Status.md)
### [Get-SnipeItStatus](Get-SnipeItStatus.md)
Gets a list of Snipe-it Status Labels
### [New-Asset](New-Asset.md)
### [New-SnipeItAsset](New-SnipeItAsset.md)
Add a new Asset to Snipe-it asset system
### [New-AssetMaintenance](New-AssetMaintenance.md)
### [New-SnipeItAssetMaintenance](New-SnipeItAssetMaintenance.md)
Add a new Asset maintenence to Snipe-it asset system
### [New-Category](New-Category.md)
### [New-SnipeItCategory](New-SnipeItCategory.md)
Create a new Snipe-IT Category
### [New-Component](New-Component.md)
### [New-SnipeItComponent](New-SnipeItComponent.md)
Create a new component
### [New-CustomField](New-CustomField.md)
### [New-SnipeItCustomField](New-SnipeItCustomField.md)
Add a new Custom Field to Snipe-it asset system
### [New-Department](New-Department.md)
### [New-SnipeItDepartment](New-SnipeItDepartment.md)
Creates a department
### [New-License](New-License.md)
### [New-SnipeItLicense](New-SnipeItLicense.md)
Creates a licence
### [New-Location](New-Location.md)
### [New-SnipeItLocation](New-SnipeItLocation.md)
Add a new Location to Snipe-it asset system
### [New-Manufacturer](New-Manufacturer.md)
### [New-SnipeItManufacturer](New-SnipeItManufacturer.md)
Add a new Manufacturer to Snipe-it asset system
### [New-Model](New-Model.md)
### [New-SnipeItModel](New-SnipeItModel.md)
Add a new Model to Snipe-it asset system
### [New-User](New-User.md)
### [New-SnipeItUser](New-SnipeItUser.md)
Creates a new user
### [Remove-Asset](Remove-Asset.md)
### [Remove-SnipeItAsset](Remove-SnipeItAsset.md)
Removes Asset to Snipe-it asset system
### [Remove-User](Remove-User.md)
### [Remove-SnipeItUser](Remove-SnipeItUser.md)
Removes User from Snipe-it asset system
### [Set-Accessory](Set-Accessory.md)
### [Set-SnipeItAccessory](Set-SnipeItAccessory.md)
Updates accessory on Snipe-It system
### [Set-Asset](Set-Asset.md)
### [Set-SnipeItAsset](Set-SnipeItAsset.md)
Update a specific Asset in the Snipe-it asset system
### [Set-AssetOwner](Set-AssetOwner.md)
### [Set-SnipeItAssetOwner](Set-SnipeItAssetOwner.md)
Checkout asset
### [Set-Component](Set-Component.md)
### [Set-SnipeItComponent](Set-SnipeItComponent.md)
Updates component
### [Set-Info](Set-Info.md)
### [Set-SnipeItInfo](Set-SnipeItInfo.md)
Sets authetication information
### [Set-License](Set-License.md)
### [Set-SnipeItLicense](Set-SnipeItLicense.md)
Updates a licence
### [Set-Model](Set-Model.md)
### [Set-SnipeItModel](Set-SnipeItModel.md)
Updates Model on Snipe-it asset system
### [Set-SnipeitLocation](Set-SnipeitLocation.md)
Updates Location in Snipe-it asset system
### [Set-User](Set-User.md)
### [Set-SnipeItUser](Set-SnipeItUser.md)
Creates a new user