SnipeitPS/docs/Remove-SnipeitConsumable.md
Petri Asikainen dd2bf7371e updated docs
2021-10-27 14:11:27 +03:00

2.2 KiB

external help file Module Name online version schema
SnipeitPS-help.xml SnipeitPS 2.0.0

Remove-SnipeitConsumable

SYNOPSIS

Removes consumable from Snipe-it asset system

SYNTAX

Remove-SnipeitConsumable [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes consumable or multiple consumables from Snipe-it asset system

EXAMPLES

EXAMPLE 1

Remove-SnipeitConsumable -ID 44

EXAMPLE 2

Get-SnipeitConsumable -search "paper"  | Remove-SnipeitConsumable

PARAMETERS

-apiKey

Deprecated parameter, please use Connect-SnipeitPS instead. User's API Key for Snipeit.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

Unique ID For consumable to be removed

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-url

Deprecated parameter, please use Connect-SnipeitPS instead. URL of Snipeit system.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

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.

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.

INPUTS

OUTPUTS

NOTES