SnipeitPS/docs/Set-SnipeitAccessoryOwner.md

148 lines
2.5 KiB
Markdown
Raw Normal View History

---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Set-SnipeitAccessoryOwner
## SYNOPSIS
Checkout accessory
## SYNTAX
```
2021-06-08 20:23:32 +03:00
Set-SnipeitAccessoryOwner [-id] <Int32[]> [-assigned_to] <Int32> [[-note] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Checkout accessory to user
## EXAMPLES
### EXAMPLE 1
```
2021-06-08 20:23:32 +03:00
Set-SnipeitAccessoryOwner -id 1 -assigned_id 1 -note "testing check out to user"
```
## PARAMETERS
### -apiKey
2021-06-08 20:23:32 +03:00
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -assigned_to
{{ Fill assigned_to Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
2021-06-08 22:04:25 +03:00
Unique ID For accessory or array of IDs to checkout
```yaml
2021-06-06 06:22:08 +03:00
Type: Int32[]
Parameter Sets: (All)
Aliases:
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)
Accept wildcard characters: False
```
### -note
Notes about checkout
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
2021-06-08 20:23:32 +03:00
URL of Snipeit system, can be set using Set-SnipeitInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
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