SnipeitPS/docs/Get-SnipeitAccessory.md

257 lines
4.5 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
# Get-SnipeitAccessory
2021-05-18 05:57:40 +03:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Gets a list of Snipe-it Accessories
2021-05-18 05:57:40 +03:00
## SYNTAX
2021-06-08 16:30:12 +03:00
### Search
2021-05-18 05:57:40 +03:00
```
2021-06-08 21:48:59 +03:00
<<<<<<< HEAD:docs/Get-SnipeitAccessory.md
2021-06-08 20:23:32 +03:00
Get-SnipeitAccessory [[-search] <String>] [[-company_id] <Int32>] [[-category_id] <Int32>]
2021-05-18 05:57:40 +03:00
[[-manufacturer_id] <Int32>] [[-supplier_id] <Int32>] [[-sort] <String>] [[-order] <String>]
[[-limit] <Int32>] [[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
2021-06-08 21:48:59 +03:00
=======
2021-06-08 16:30:12 +03:00
Get-SnipeItAccessory [-search <String>] [-company_id <Int32>] [-category_id <Int32>] [-manufacturer_id <Int32>]
[-supplier_id <Int32>] [-sort <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
```
### Get by ID
```
Get-SnipeItAccessory [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
2021-06-08 21:48:59 +03:00
>>>>>>> 9f68e602e32566c28846ccb9572fa0b078d64696:docs/Get-SnipeItAccessory.md
2021-05-18 05:57:40 +03:00
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Gets a list of Snipe-it Accessories
2021-05-18 05:57:40 +03:00
## EXAMPLES
### EXAMPLE 1
```
2021-06-08 20:23:32 +03:00
Get-SnipeitAccessory -search Keyboard
2021-05-18 05:57:40 +03:00
```
### EXAMPLE 2
```
2021-06-08 20:23:32 +03:00
Get-SnipeitAccessory -id 1
2021-05-18 05:57:40 +03:00
```
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -all
A return all results, works with -offset and other parameters
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: SwitchParameter
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: Named
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
### -apiKey
2021-06-08 20:23:32 +03:00
Users 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:
2021-05-23 23:24:44 +03:00
Required: True
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
```yaml
Type: Int32
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-18 05:57:40 +03:00
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -company_id
{{ Fill company_id Description }}
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Accessory
```yaml
Type: Int32
Parameter Sets: Get by ID
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-18 05:57:40 +03:00
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
Default value: 50
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -manufacturer_id
{{ Fill manufacturer_id Description }}
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
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
### -offset
Result offset to use
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
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
### -order
{{ Fill order Description }}
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
Default value: Desc
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -search
A text string to search the Accessory data
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -sort
{{ Fill sort Description }}
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
Default value: Created_at
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -supplier_id
{{ Fill supplier_id Description }}
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-06-08 16:30:12 +03:00
Parameter Sets: Search
2021-05-18 05:57:40 +03:00
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
2021-06-08 16:30:12 +03:00
Position: Named
2021-05-23 23:24:44 +03:00
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
### -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-06-08 16:30:12 +03:00
Position: Named
2021-05-18 05:57:40 +03:00
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