SnipeitPS/docs/Set-SnipeitAssetOwner.md

212 lines
3.8 KiB
Markdown
Raw Normal View History

---
2021-06-08 20:20:03 +03: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
---
2021-06-08 20:23:32 +03:00
# Set-SnipeitAssetOwner
2017-11-18 19:50:47 +00:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Checkout asset
2017-11-18 19:50:47 +00:00
## SYNTAX
```
2021-06-08 20:23:32 +03:00
Set-SnipeitAssetOwner [-id] <Int32[]> [-assigned_id] <Int32> [[-checkout_to_type] <String>] [[-name] <String>]
2021-05-19 15:51:49 +03:00
[[-note] <String>] [[-expected_checkin] <DateTime>] [[-checkout_at] <DateTime>] [-url] <String>
2018-04-29 08:58:34 +01:00
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
2017-11-18 19:50:47 +00:00
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Checkout asset to user/localtion/asset
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-06-08 20:23:32 +03:00
Set-SnipeitAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing check out to user"
2017-11-18 19:50:47 +00:00
```
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -apiKey
2021-06-08 20:23:32 +03:00
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
2017-11-18 19:50:47 +00:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
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: 9
Default value: None
2017-11-18 19:50:47 +00:00
Accept pipeline input: False
Accept wildcard characters: False
```
2018-04-29 08:58:34 +01:00
### -assigned_id
2021-05-19 15:51:49 +03:00
Id of target user , location or asset
2017-11-18 19:50:47 +00:00
```yaml
Type: Int32
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
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -checkout_at
Optional date to override the checkout time of now
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-05-23 23:24:44 +03:00
Position: 7
Default value: None
2017-11-18 19:50:47 +00:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -checkout_to_type
2021-07-29 12:49:16 +03:00
Checkout asset to one of following types user, location, asset
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
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 3
Default value: User
2021-05-19 15:51:49 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -expected_checkin
Optional date the asset is expected to be checked in
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-05-23 23:24:44 +03:00
Position: 6
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
### -id
2021-06-08 22:04:25 +03:00
Unique IDs For assets to checkout
2017-11-18 19:50:47 +00:00
```yaml
2021-06-06 06:22:08 +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
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-19 15:51:49 +03:00
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -name
Optional new asset name.
This is useful for changing the asset's name on new checkout,
for example, an asset that was named "Anna's Macbook Pro" could be renamed on the fly
when it's checked out to Elizabeth, to "Beth's Macbook Pro"
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-05-23 23:24:44 +03:00
Position: 4
2021-05-19 15:51:49 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -note
Notes about checkout
2021-05-19 15:51:49 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 5
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -url
2021-06-08 20:23:32 +03:00
URL of Snipeit system, can be set using Set-SnipeitInfo command
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: True
2021-05-23 23:24:44 +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-23 23:24:44 +03:00
### -Confirm
Prompts you for confirmation before running the cmdlet.
2021-05-18 05:57:40 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
2021-05-18 05:57:40 +03:00
Required: False
Position: Named
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.
2021-05-18 05:57:40 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: wi
2021-05-18 05:57:40 +03:00
Required: False
Position: Named
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