SnipeitPS/docs/Remove-SnipeitAsset.md

123 lines
2.1 KiB
Markdown
Raw Normal View History

---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
2021-05-18 05:57:40 +03:00
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Remove-SnipeitAsset
2021-05-18 05:57:40 +03:00
## SYNOPSIS
2021-05-23 23:22:23 +03:00
Removes Asset from Snipe-it asset system
2021-05-18 05:57:40 +03:00
## SYNTAX
```
2021-06-12 12:30:41 +03:00
Remove-SnipeitAsset [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
2021-05-18 05:57:40 +03:00
```
## DESCRIPTION
2021-06-12 12:30:41 +03:00
Removes asset or multiple assets from Snipe-it asset system
2021-05-18 05:57:40 +03:00
## EXAMPLES
### EXAMPLE 1
```
2021-06-08 20:23:32 +03:00
Remove-SnipeitAsset -ID 44 -Verbose
2021-05-18 05:57:40 +03:00
```
2021-06-12 12:30:41 +03:00
### EXAMPLE 2
```
Get-SnipeitAsset -serial 123456789 | Remove-SnipeitAsset
```
2021-05-18 05:57:40 +03:00
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -APIKey
2021-06-08 20:23:32 +03:00
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 3
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-25 11:17:22 +03:00
### -id
2021-05-23 23:24:44 +03:00
Unique ID For Asset to be removed
2021-05-18 05:57:40 +03:00
```yaml
2021-06-12 12:30:41 +03:00
Type: Int32[]
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 1
2021-06-12 12:30:41 +03:00
Default value: None
Accept pipeline input: True (ByPropertyName)
2021-05-18 05:57:40 +03:00
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -URL
2021-06-08 20:23:32 +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-23 23:24:44 +03:00
Position: 2
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
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
2021-05-18 05:57:40 +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-18 05:57:40 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: wi
2021-05-18 05:57:40 +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