SnipeitPS/docs/Set-Asset.md

181 lines
2.9 KiB
Markdown
Raw Normal View History

2017-11-18 19:50:47 +00:00
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
schema: 2.0.0
---
# Set-Asset
## SYNOPSIS
2017-11-20 09:07:58 +00:00
Update a Asset in the Snipe-it asset system
2017-11-18 19:50:47 +00:00
## SYNTAX
```
Set-Asset [-id] <Int32> [-Name] <String> [-Status_id] <String> [-Model_id] <String> [-url] <String>
2017-11-18 21:41:35 +00:00
[-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm]
2017-11-18 19:50:47 +00:00
```
## DESCRIPTION
2017-11-20 09:07:58 +00:00
Long description
2017-11-18 19:50:47 +00:00
## EXAMPLES
2017-11-20 09:07:58 +00:00
### -------------------------- EXAMPLE 1 --------------------------
2017-11-18 19:50:47 +00:00
```
2017-11-20 09:07:58 +00:00
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1"
2017-11-18 19:50:47 +00:00
```
2017-11-20 09:07:58 +00:00
### -------------------------- EXAMPLE 2 --------------------------
```
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
```
2017-11-18 19:50:47 +00:00
## PARAMETERS
2017-11-20 09:07:58 +00:00
### -id
ID of the Asset
2017-11-18 21:41:35 +00:00
```yaml
2017-11-20 09:07:58 +00:00
Type: Int32
2017-11-18 21:41:35 +00:00
Parameter Sets: (All)
2017-11-20 09:07:58 +00:00
Aliases:
2017-11-18 21:41:35 +00:00
2017-11-20 09:07:58 +00:00
Required: True
Position: 1
Default value: 0
2017-11-18 21:41:35 +00:00
Accept pipeline input: False
Accept wildcard characters: False
```
2017-11-20 09:07:58 +00:00
### -Name
Name of the Asset
2017-11-18 19:50:47 +00:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2017-11-20 09:07:58 +00:00
Position: 2
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2017-11-20 09:07:58 +00:00
### -Status_id
Status ID of the asset, this can be got using Get-Status
2017-11-18 19:50:47 +00:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2017-11-20 09:07:58 +00:00
Position: 3
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2017-11-20 09:07:58 +00:00
### -Model_id
Model ID of the asset, this can be got using Get-Model
2017-11-18 19:50:47 +00:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2017-11-20 09:07:58 +00:00
Position: 4
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2017-11-20 09:07:58 +00:00
### -url
URL of Snipeit system, can be set using Set-Info command
2017-11-18 21:41:35 +00:00
```yaml
2017-11-20 09:07:58 +00:00
Type: String
2017-11-18 21:41:35 +00:00
Parameter Sets: (All)
2017-11-20 09:07:58 +00:00
Aliases:
2017-11-18 21:41:35 +00:00
2017-11-20 09:07:58 +00:00
Required: True
Position: 5
2017-11-18 21:41:35 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2017-11-18 19:50:47 +00:00
### -apiKey
2017-11-20 09:07:58 +00:00
Users API Key for Snipeit, can be set using Set-Info command
2017-11-18 19:50:47 +00:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2017-11-20 09:07:58 +00:00
Position: 6
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -customfields
2017-11-20 09:07:58 +00:00
Hastable of custom fields and extra fields that need passing through to Snipeit
2017-11-18 19:50:47 +00:00
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
2017-11-20 09:07:58 +00:00
Position: 7
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2017-11-20 09:07:58 +00:00
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
2017-11-18 19:50:47 +00:00
```yaml
2017-11-20 09:07:58 +00:00
Type: SwitchParameter
2017-11-18 19:50:47 +00:00
Parameter Sets: (All)
2017-11-20 09:07:58 +00:00
Aliases: wi
2017-11-18 19:50:47 +00:00
2017-11-20 09:07:58 +00:00
Required: False
Position: Named
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2017-11-20 09:07:58 +00:00
### -Confirm
Prompts you for confirmation before running the cmdlet.
2017-11-18 19:50:47 +00:00
```yaml
2017-11-20 09:07:58 +00:00
Type: SwitchParameter
2017-11-18 19:50:47 +00:00
Parameter Sets: (All)
2017-11-20 09:07:58 +00:00
Aliases: cf
2017-11-18 19:50:47 +00:00
2017-11-20 09:07:58 +00:00
Required: False
Position: Named
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS