SnipeitPS/docs/Set-SnipeitLicenseSeat.md

210 lines
3.6 KiB
Markdown
Raw Permalink Normal View History

2021-05-23 23:22:23 +03:00
---
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-23 23:22:23 +03:00
online version:
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Set-SnipeitLicenseSeat
2021-05-23 23:22:23 +03:00
## SYNOPSIS
Set license seat or checkout license seat
## SYNTAX
```
Set-SnipeitLicenseSeat [-id] <Int32[]> [-seat_id] <Int32> [[-assigned_to] <Int32>] [[-asset_id] <Int32>]
2021-08-23 18:50:13 +03:00
[[-note] <String>] [[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
2021-07-14 11:16:55 +03:00
[<CommonParameters>]
2021-05-23 23:22:23 +03:00
```
## DESCRIPTION
Checkout specific license seat to user, asset or both
## EXAMPLES
### EXAMPLE 1
```
Set-SnipeitLicenceSeat -ID 1 -seat_id 1 -assigned_id 3
2021-05-23 23:22:23 +03:00
Checkout licence to user id 3
2021-06-05 08:10:45 +03:00
```
2021-05-23 23:22:23 +03:00
### EXAMPLE 2
```
Set-SnipeitLicenceSeat -ID 1 -seat_id 1 -asset_id 3
2021-05-23 23:22:23 +03:00
Checkout licence to asset id 3
2021-06-05 08:10:45 +03:00
```
2021-05-23 23:22:23 +03:00
### EXAMPLE 3
```
Set-SnipeitLicenceSeat -ID 1 -seat_id 1 -asset_id $null -assigned_id $null
Checkin licence seat id 1 of licence id 1
```
2021-05-23 23:22:23 +03:00
## PARAMETERS
### -apiKey
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
2021-05-23 23:22:23 +03:00
```yaml
Type: String
2021-05-23 23:22:23 +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: 8
2021-05-23 23:24:44 +03:00
Default value: None
2021-05-23 23:22:23 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_id
Id of target asset
2021-05-23 23:22:23 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
2021-05-23 23:22:23 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -assigned_to
Id of target user
2021-05-23 23:22:23 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: assigned_id
2021-05-23 23:22:23 +03:00
Required: False
Position: 3
2021-06-16 10:37:57 +03:00
Default value: None
2021-05-23 23:22:23 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Unique ID For license to checkout or array of IDs
2021-05-23 23:22:23 +03:00
```yaml
Type: Int32[]
2021-05-23 23:22:23 +03:00
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
2021-06-08 22:04:25 +03:00
Default value: None
2021-05-23 23:22:23 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -note
Notes about checkout
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
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: 6
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
### -seat_id
{{ Fill seat_id Description }}
2021-05-23 23:22:23 +03:00
```yaml
Type: Int32
2021-05-23 23:22:23 +03:00
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
2021-05-23 23:22:23 +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-23 23:22:23 +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: 7
2021-05-23 23:22:23 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
2021-05-23 23:22:23 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
2021-05-23 23:22:23 +03:00
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.
2021-05-23 23:22:23 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
2021-05-23 23:22:23 +03:00
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