SnipeitPS/docs/New-SnipeItLicense.md

362 lines
5.8 KiB
Markdown
Raw Normal View History

---
2021-05-18 05:57:40 +03:00
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# New-SnipeItLicense
2021-05-18 05:57:40 +03:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Creates a licence
2021-05-18 05:57:40 +03:00
## SYNTAX
```
New-SnipeItLicense [-name] <String> [-seats] <Int32> [[-category_id] <Int32>] [[-company_id] <Int32>]
2021-05-18 05:57:40 +03:00
[[-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>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Creates a new 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-05-23 23:22:23 +03:00
New-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
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 19
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: 3
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: 4
Default value: 0
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: 5
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -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: 6
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: 7
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: 8
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: 9
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 being created
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
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: 10
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: 11
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: 12
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: 13
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: 14
Default value: False
2021-05-18 05:57:40 +03:00
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: True
Position: 2
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: 15
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: 16
Default value: 0
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: 17
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
2021-05-23 23:22:23 +03:00
URL of Snipeit system, can be set using Set-SnipeItInfo command
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
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
```
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