4 KiB
| external help file | Module Name | online version | schema |
|---|---|---|---|
| SnipeitPS-help.xml | snipeitps | 2.0.0 |
Get-SnipeitComponent
SYNOPSIS
Gets a list of Snipe-it Components
SYNTAX
Search (Default)
Get-SnipeitComponent [-search <String>] [-category_id <Int32>] [-company_id <Int32>] [-location_id <Int32>]
[-order <String>] [-sort <String>] [-limit <Int32>] [-offset <Int32>] [-all] [-url <String>]
[-apiKey <String>] [<CommonParameters>]
Get with ID
Get-SnipeitComponent [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
EXAMPLE 1
Get-SnipeitComponent
Returns all components
EXAMPLE 2
Get-SnipeitComponent -search display
Returns search results containeing string display
EXAMPLE 3
Get-SnipeitComponent -id
Returns specific component
PARAMETERS
-all
A return all results, works with -offset and other parameters
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-apiKey
Deprecated parameter, please use Connect-SnipeitPS instead. Users API Key for Snipeit.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-category_id
{{ Fill category_id Description }}
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-company_id
{{ Fill company_id Description }}
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-id
A id of specific Component
Type: Int32
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-limit
Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
-location_id
{{ Fill location_id Description }}
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-offset
Offset to use
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-order
{{ Fill order Description }}
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
-search
A text string to search the Components data
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-sort
{{ Fill sort Description }}
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Created_at
Accept pipeline input: False
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: 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.