2021-05-22 18:44:36 +03:00
---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
2021-08-23 18:50:13 +03:00
Module Name: snipeitps
2021-05-19 15:51:49 +03:00
online version:
2017-11-18 19:50:47 +00:00
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Set-SnipeitComponent
2017-11-18 19:50:47 +00:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Updates component
2017-11-18 19:50:47 +00:00
## SYNTAX
```
2021-06-16 01:04:35 +03:00
Set-SnipeitComponent [-id] < Int32 [ ] > [-qty] < Int32 > [[-min_amt] < Int32 > ] [[-name] < String > ]
[[-company_id] < Int32 > ] [[-location_id] < Int32 > ] [[-order_number] < String > ] [[-purchase_date] < DateTime > ]
2021-08-23 18:50:13 +03:00
[[-purchase_cost] < Single > ] [[-image] < String > ] [-image_delete] [[-RequestType] < String > ] [[-url] < String > ]
[[-apiKey] < String > ] [-WhatIf] [-Confirm] [< CommonParameters > ]
2017-11-18 19:50:47 +00:00
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Updates component on Snipe-It system
2017-11-18 19:50:47 +00:00
## EXAMPLES
2021-05-19 15:51:49 +03:00
### EXAMPLE 1
2017-11-18 19:50:47 +00:00
```
2021-08-23 18:50:13 +03:00
Set-SnipeitComponent -id 42 -qty 12
Sets count of component with ID 42 to 12
2017-11-18 19:50:47 +00:00
```
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -apiKey
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
2017-11-18 21:41:35 +00:00
```yaml
2021-05-18 05:57:40 +03:00
Type: String
2017-11-18 21:41:35 +00:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2017-11-18 21:41:35 +00:00
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 13
2017-11-18 21:41:35 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -company_id
{{ Fill company_id Description }}
2021-05-19 15:51:49 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-05-19 15:51:49 +03:00
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
2021-06-16 01:04:35 +03:00
Position: 5
2021-06-16 10:37:57 +03:00
Default value: None
2021-05-19 15:51:49 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -id
ID number of name
2017-11-18 21:41:35 +00:00
```yaml
2021-06-16 01:04:35 +03:00
Type: Int32[]
2017-11-18 21:41:35 +00:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2017-11-18 21:41:35 +00:00
2021-05-23 23:24:44 +03:00
Required: True
Position: 1
2021-06-16 10:37:57 +03:00
Default value: None
2021-06-16 01:04:35 +03:00
Accept pipeline input: True (ByPropertyName)
2021-05-19 15:51:49 +03:00
Accept wildcard characters: False
```
2021-07-08 23:59:31 +03:00
### -image
Image file name and path for item
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -location_id
ID number of the location the accessory is assigned to
2021-05-19 15:51:49 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-06-16 01:04:35 +03:00
Position: 6
2021-06-16 10:37:57 +03:00
Default value: None
2021-06-16 01:04:35 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -min_amt
Minimum Quantity of the components before alert is triggered
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
2021-06-16 10:37:57 +03:00
Default value: None
2021-05-19 15:51:49 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -name
Component name
2021-05-19 15:51:49 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2021-05-19 15:51:49 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-06-16 01:04:35 +03:00
Position: 4
2021-05-23 23:24:44 +03:00
Default value: None
2021-05-19 15:51:49 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-06-08 16:30:12 +03:00
### -order_number
Order number for the accessory
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-06-16 01:04:35 +03:00
Position: 7
2021-06-08 16:30:12 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -purchase_cost
Cost of item being purchased.
2021-05-19 15:51:49 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Single
2021-05-19 15:51:49 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-06-16 01:04:35 +03:00
Position: 9
2021-05-23 23:24:44 +03:00
Default value: 0
2021-05-19 15:51:49 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -purchase_date
Date accessory was purchased
2021-05-19 15:51:49 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: DateTime
2021-05-19 15:51:49 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-06-16 01:04:35 +03:00
Position: 8
2021-05-23 23:24:44 +03:00
Default value: None
2017-11-18 21:41:35 +00:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -qty
Quantity of the components you have
2017-11-18 19:50:47 +00:00
```yaml
2021-05-25 11:17:22 +03:00
Type: Int32
2017-11-18 19:50:47 +00:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2017-11-18 19:50:47 +00:00
Required: True
2021-05-23 23:24:44 +03:00
Position: 2
2021-05-25 11:17:22 +03:00
Default value: 0
2017-11-18 19:50:47 +00:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-07-14 11:16:55 +03:00
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -url
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2017-11-18 19:50:47 +00:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2017-11-18 19:50:47 +00:00
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 12
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -Confirm
Prompts you for confirmation before running the cmdlet.
2017-11-18 19:50:47 +00:00
```yaml
2021-05-18 05:57:40 +03:00
Type: SwitchParameter
2017-11-18 19:50:47 +00:00
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
2017-11-18 19:50:47 +00:00
2021-05-18 05:57:40 +03:00
Required: False
Position: Named
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
2017-11-18 19:50:47 +00:00
```yaml
2021-05-18 05:57:40 +03:00
Type: SwitchParameter
2017-11-18 19:50:47 +00:00
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: wi
2017-11-18 19:50:47 +00:00
2021-05-18 05:57:40 +03:00
Required: False
Position: Named
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2018-04-29 08:58:34 +01:00
### CommonParameters
2021-05-18 05:57:40 +03:00
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 ).
2018-04-29 08:58:34 +01:00
2017-11-18 19:50:47 +00:00
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS