SnipeitPS/SnipeitPS/Public/Set-Asset.ps1
shcgitpf 63f6ae12e2
Updated for current API fields
The API supports a 'PUT' for modifying parts of an asset, but most of the supported fields were missing (I need to be able to set a location for example which was missing).  I've added all the current API fields and replaced the $values section with Get-ParameterValue.  Not fully tested everything but looking good so far.
2021-03-11 10:04:42 +00:00

139 lines
3 KiB
PowerShell

<#
.SYNOPSIS
Update a specific Asset in the Snipe-it asset system
.DESCRIPTION
Long description
.PARAMETER id
ID of the Asset
.PARAMETER Name
Asset name
.PARAMETER Status_id
Status ID of the asset, this can be got using Get-Status
.PARAMETER Model_id
Model ID of the asset, this can be got using Get-Model
.PARAMETER last_checkout
Date the asset was last checked out
.PARAMETER assigned_to
The id of the user the asset is currently checked out to
.PARAMETER company_id
The id of an associated company id
.PARAMETER serial
Serial number of the asset
.PARAMETER order_number
Order number for the asset
.PARAMETER warranty_months
Number of months for the asset warranty
.PARAMETER purchase_cost
Purchase cost of the asset, without a currency symbol
.PARAMETER purchase_date
Date of asset purchase
.PARAMETER requestable
Whether or not the asset can be requested by users with the permission to request assets
.PARAMETER archived
Whether or not the asset is archived. Archived assets cannot be checked out and do not show up in the deployable asset screens
.PARAMETER rtd_location_id
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
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
.PARAMETER customfields
Hastable of custom fields and extra fields that need passing through to Snipeit
.EXAMPLE
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1"
.EXAMPLE
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
#>
function Set-Asset()
{
[CmdletBinding(
SupportsShouldProcess = $true,
ConfirmImpact = "Medium"
)]
Param(
[parameter(mandatory = $true)]
[int]$id,
[string]$Name,
[string]$Status_id,
[string]$Model_id,
[DateTime]$last_checkout,
[int]$assigned_to,
[int]$company_id,
[string]$serial,
[string]$order_number,
[int]$warranty_months,
[double]$purchase_cost,
[DateTime]$purchase_date,
[bool]$requestable,
[bool]$archived,
[int]$rtd_location_id,
[parameter(mandatory = $true)]
[string]$url,
[parameter(mandatory = $true)]
[string]$apiKey,
[hashtable] $customfields
)
$Values = . Get-ParameterValue
if ($customfields)
{
$Values += $customfields
}
$Body = $Values | ConvertTo-Json;
$Parameters = @{
Uri = "$url/api/v1/hardware/$id"
Method = 'Put'
Body = $Body
Token = $apiKey
}
If ($PSCmdlet.ShouldProcess("ShouldProcess?"))
{
$result = Invoke-SnipeitMethod @Parameters
}
$result
}