SnipeitPS/docs/Set-SnipeitLicense.md

395 lines
6.4 KiB
Markdown
Raw Normal View History

---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
2021-08-23 18:50:13 +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-SnipeitLicense
2021-05-18 05:57:40 +03:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Updates a licence
2021-05-18 05:57:40 +03:00
## SYNTAX
```
2021-06-08 20:23:32 +03:00
Set-SnipeitLicense [-id] <Int32[]> [[-name] <String>] [[-seats] <Int32>] [[-category_id] <Int32>]
2021-05-18 05:57:40 +03:00
[[-company_id] <Int32>] [[-expiration_date] <DateTime>] [[-license_email] <MailAddress>]
[[-license_name] <String>] [[-maintained] <Boolean>] [[-manufacturer_id] <Int32>] [[-notes] <String>]
[[-order_number] <String>] [[-purchase_cost] <Single>] [[-purchase_date] <DateTime>]
[[-reassignable] <Boolean>] [[-serial] <String>] [[-supplier_id] <Int32>] [[-termination_date] <DateTime>]
2021-08-23 18:50:13 +03:00
[[-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 licence 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-SnipeitLicence -name "License" -seats 3 -company_id 1
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-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: 21
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 4
Default value: 0
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
2021-05-19 15:51:49 +03:00
Id number of company license belongs to
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +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
```
### -expiration_date
2021-05-19 15:51:49 +03:00
Date of license expiration
2021-05-18 05:57:40 +03:00
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 6
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
### -id
2021-06-08 22:04:25 +03:00
ID number of license or array of license IDs
2021-05-23 23:24:44 +03:00
```yaml
2021-06-06 06:22:08 +03:00
Type: Int32[]
2021-05-23 23:24:44 +03:00
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)
2021-05-23 23:24:44 +03:00
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -license_email
2021-05-19 15:51:49 +03:00
Email address associated with license
2021-05-18 05:57:40 +03:00
```yaml
Type: MailAddress
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 7
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_name
2021-05-19 15:51:49 +03:00
Name of license contact person
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 8
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -maintained
2021-05-19 15:51:49 +03:00
Maintained status of license
2021-05-18 05:57:40 +03:00
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 9
Default value: False
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
2021-05-19 15:51:49 +03:00
ID number of manufacturer of license.
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 10
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
### -name
Name of license
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -notes
2021-05-19 15:51:49 +03:00
License Notes
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 11
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
2021-05-19 15:51:49 +03:00
Order number of license purchase
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 12
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
2021-05-19 15:51:49 +03:00
Cost of license
2021-05-18 05:57:40 +03:00
```yaml
Type: Single
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 13
Default value: 0
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
2021-05-19 15:51:49 +03:00
Date of license purchase
2021-05-18 05:57:40 +03:00
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 14
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -reassignable
2021-05-19 15:51:49 +03:00
Is license reassignable?
2021-05-18 05:57:40 +03:00
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 15
Default value: False
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: 19
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -serial
2021-05-19 15:51:49 +03:00
Serialnumber of license
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 16
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
2021-05-19 15:51:49 +03:00
ID number of license supplier
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 17
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
```
### -termination_date
2021-05-19 15:51:49 +03:00
Termination date for license.
2021-05-18 05:57:40 +03:00
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
2021-05-19 15:51:49 +03:00
Position: 18
2021-05-18 05:57:40 +03:00
Default value: None
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: 20
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