2021-05-19 15:51:49 +03:00
---
2017-11-18 19:50:47 +00:00
external help file: SnipeItPS-help.xml
2021-05-18 05:57:40 +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
---
2017-11-18 21:41:35 +00:00
# Set-Component
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-05-19 15:51:49 +03:00
Set-Component [-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 > ]
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-05-19 15:51:49 +03:00
An example
2017-11-18 19:50:47 +00:00
```
## PARAMETERS
2021-05-18 05:57:40 +03:00
### -apiKey
2021-05-19 15:51:49 +03:00
User's API Key for Snipeit, can be set using Set-Info command
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-05-18 05:57:40 +03:00
Required: True
2021-05-19 15:51:49 +03:00
Position: 9
2017-11-18 21:41:35 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-19 15:51:49 +03:00
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -id
2021-05-19 15:51:49 +03:00
ID number of name
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-05-18 05:57:40 +03:00
Required: True
2021-05-19 15:51:49 +03:00
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Component name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Cost of item being purchased.
```yaml
Type: Single
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
2017-11-18 21:41:35 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -qty
2021-05-19 15:51:49 +03:00
Quantity of the components you have
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
Required: True
2021-05-19 15:51:49 +03:00
Position: 2
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -url
2021-05-19 15:51:49 +03:00
URL of Snipeit system, can be set using Set-Info command
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
Required: True
2021-05-19 15:51:49 +03:00
Position: 8
2017-11-18 19:50:47 +00:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +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-18 05:57:40 +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-18 05:57:40 +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-18 05:57:40 +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
2021-05-19 15:51:49 +03:00
General notes
2017-11-18 19:50:47 +00:00
## RELATED LINKS