SnipeitPS/docs/Set-SnipeitAccessory.md

349 lines
5.8 KiB
Markdown
Raw Permalink Normal View History

---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
2021-10-27 14:11:27 +03:00
Module Name: SnipeitPS
2021-05-18 05:57:40 +03:00
online version:
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Set-SnipeitAccessory
2021-05-18 05:57:40 +03:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Updates accessory on Snipe-It system
2021-05-18 05:57:40 +03:00
## SYNTAX
```
2021-06-08 20:23:32 +03:00
Set-SnipeitAccessory [-id] <Int32[]> [[-name] <String>] [[-qty] <Int32>] [[-category_id] <Int32>]
2021-06-17 10:37:15 +03:00
[[-company_id] <Int32>] [[-manufacturer_id] <Int32>] [[-model_number] <String>] [[-order_number] <String>]
[[-purchase_cost] <Single>] [[-purchase_date] <DateTime>] [[-min_amt] <Int32>] [[-supplier_id] <Int32>]
2021-08-23 18:50:13 +03:00
[[-location_id] <Int32>] [[-image] <String>] [-image_delete] [[-RequestType] <String>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
2021-05-18 05:57:40 +03:00
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Updates accessory on Snipe-It system
2021-05-18 05:57:40 +03:00
## EXAMPLES
2021-05-19 15:51:49 +03:00
### EXAMPLE 1
```
2021-06-08 20:23:32 +03:00
Set-SnipeitAccessory -id 1 -qty 3
2021-05-18 05:57:40 +03: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 for Snipeit.
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 17
2021-05-23 23:24:44 +03:00
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -category_id
ID number of the category the accessory belongs to
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 4
Default value: 0
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -company_id
ID Number of the company the accessory is assigned to
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 5
2021-06-16 10:37:57 +03:00
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -id
{{ Fill id Description }}
2021-05-18 05:57:40 +03:00
```yaml
2021-06-06 06:22:08 +03:00
Type: Int32[]
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: True
Position: 1
2021-06-08 22:04:25 +03:00
Default value: None
2021-06-06 06:22:08 +03:00
Accept pipeline input: True (ByPropertyName)
2021-05-18 05:57:40 +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: 14
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
```
### -location_id
ID number of the location the accessory is assigned to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -manufacturer_id
ID number of the manufacturer for this accessory.
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 6
2021-06-16 10:37:57 +03:00
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-06-16 10:37:57 +03:00
### -min_amt
Minimum amount of the accessory, before alert is triggered
2021-05-18 05:57:40 +03:00
```yaml
2021-06-16 10:37:57 +03:00
Type: Int32
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-06-17 10:37:15 +03:00
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number for this accessory
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
2021-06-16 10:37:57 +03:00
Default value: None
2021-05-23 23:24:44 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
2021-06-08 22:04:25 +03:00
ID number of Accessory or array of IDs on Snipe-It system
2021-05-23 23:24:44 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-19 15:51:49 +03:00
### -order_number
Order number for this accessory.
2021-05-18 05:57:40 +03:00
```yaml
2021-05-19 15:51:49 +03:00
Type: String
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-06-17 10:37:15 +03:00
Position: 8
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-19 15:51:49 +03:00
### -purchase_cost
Cost of item being purchased.
2021-05-18 05:57:40 +03:00
```yaml
2021-05-19 15:51:49 +03:00
Type: Single
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-06-17 10:37:15 +03:00
Position: 9
2021-05-19 15:51:49 +03:00
Default value: 0
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-19 15:51:49 +03:00
### -purchase_date
Date accessory was purchased
2021-05-18 05:57:40 +03:00
```yaml
2021-05-19 15:51:49 +03:00
Type: DateTime
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-06-17 10:37:15 +03:00
Position: 10
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -qty
Quantity of the accessory you have
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 3
Default value: 0
2021-05-18 05:57:40 +03: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: 15
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -supplier_id
2021-05-19 15:51:49 +03:00
ID number of the supplier for this accessory
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-06-17 10:37:15 +03:00
Position: 12
2021-06-16 10:37:57 +03:00
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 16
2021-05-18 05:57:40 +03: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.
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: SwitchParameter
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
2021-05-18 05:57:40 +03:00
2021-05-23 23:24:44 +03:00
Required: False
Position: Named
2021-05-18 05:57:40 +03:00
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