mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-13 18:02:30 +00:00
178 lines
3.1 KiB
Markdown
178 lines
3.1 KiB
Markdown
|
|
---
|
||
|
|
external help file: SnipeItPS-help.xml
|
||
|
|
Module Name: SnipeitPS
|
||
|
|
online version:
|
||
|
|
schema: 2.0.0
|
||
|
|
---
|
||
|
|
|
||
|
|
# New-Category
|
||
|
|
|
||
|
|
## SYNOPSIS
|
||
|
|
# Create a new Snipe-IT Category
|
||
|
|
|
||
|
|
## SYNTAX
|
||
|
|
|
||
|
|
```
|
||
|
|
New-Category [-name] <String> [-category_type] <String> [-url] <String> [-apiKey] <String> [-use_default_eula]
|
||
|
|
[-require_acceptance] [-checkin_email] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||
|
|
```
|
||
|
|
|
||
|
|
## DESCRIPTION
|
||
|
|
{{ Fill in the Description }}
|
||
|
|
|
||
|
|
## EXAMPLES
|
||
|
|
|
||
|
|
### EXAMPLE 1
|
||
|
|
```
|
||
|
|
New-Category -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
|
||
|
|
```
|
||
|
|
|
||
|
|
## PARAMETERS
|
||
|
|
|
||
|
|
### -apiKey
|
||
|
|
User's API Key for Snipeit, can be set using Set-Info command
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: String
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: True
|
||
|
|
Position: 4
|
||
|
|
Default value: None
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -category_type
|
||
|
|
{{ Fill category_type Description }}
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: String
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: True
|
||
|
|
Position: 2
|
||
|
|
Default value: None
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -checkin_email
|
||
|
|
If switch is present, send email to user on checkin/checkout
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: SwitchParameter
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: False
|
||
|
|
Position: Named
|
||
|
|
Default value: False
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -name
|
||
|
|
Name of new category to be created
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: String
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: True
|
||
|
|
Position: 1
|
||
|
|
Default value: None
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -require_acceptance
|
||
|
|
If switch is present, require users to confirm acceptance of assets in this category
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: SwitchParameter
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: False
|
||
|
|
Position: Named
|
||
|
|
Default value: False
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -url
|
||
|
|
URL of Snipeit system, can be set using Set-Info command
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: String
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: True
|
||
|
|
Position: 3
|
||
|
|
Default value: None
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -use_default_eula
|
||
|
|
If switch is present, use the primary default EULA
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: SwitchParameter
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases:
|
||
|
|
|
||
|
|
Required: False
|
||
|
|
Position: Named
|
||
|
|
Default value: False
|
||
|
|
Accept pipeline input: False
|
||
|
|
Accept wildcard characters: False
|
||
|
|
```
|
||
|
|
|
||
|
|
### -Confirm
|
||
|
|
Prompts you for confirmation before running the cmdlet.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
Type: SwitchParameter
|
||
|
|
Parameter Sets: (All)
|
||
|
|
Aliases: cf
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
```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
|