SnipeitPS/docs/Set-SnipeitLicenseSeat.md

185 lines
3.1 KiB
Markdown
Raw 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-05-23 23:22:23 +03:00
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-SnipeItLicenseSeat
## SYNOPSIS
Set license seat or checkout license seat
## SYNTAX
```
2021-06-06 06:22:08 +03:00
Set-SnipeItLicenseSeat [-id] <Int32[]> [-seat_id] <Int32> [[-assigned_id] <Int32>] [[-asset_id] <Int32>]
2021-05-23 23:22:23 +03:00
[[-note] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Checkout specific license seat to user, asset or both
## EXAMPLES
### EXAMPLE 1
```
Set-SnipeItLicenceSeat -ID 1 -seat_id 1 -assigned_id 3 -Verbose
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 -Verbose
Checkout licence to asset id 3
2021-06-05 08:10:45 +03:00
```
2021-05-23 23:22:23 +03:00
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
2021-05-23 23:22:23 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2021-05-23 23:22:23 +03:00
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 7
Default value: None
2021-05-23 23:22:23 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -asset_id
Id of target asset
2021-05-23 23:22:23 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 4
2021-05-23 23:22:23 +03:00
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -assigned_id
{{ Fill assigned_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -id
Unique ID For asset to checkout
2021-05-23 23:22:23 +03:00
```yaml
2021-06-06 06:22:08 +03:00
Type: Int32[]
2021-05-23 23:22:23 +03:00
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: True
Position: 1
2021-05-23 23:22:23 +03:00
Default value: 0
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-05-23 23:24:44 +03:00
### -seat_id
{{ Fill seat_id Description }}
2021-05-23 23:22:23 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-05-23 23:22:23 +03:00
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 2
Default value: 0
2021-05-23 23:22:23 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
2021-05-23 23:22:23 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 6
2021-05-23 23:22:23 +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-23 23:22:23 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
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
```
2021-05-23 23:24:44 +03:00
### -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)
2021-05-23 23:24:44 +03:00
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