SnipeitPS/docs/Get-Asset.md
Stephen Maunder aa961824a5 Update Help
2018-04-29 08:58:34 +01:00

271 lines
4.1 KiB
Markdown

---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
schema: 2.0.0
---
# Get-Asset
## SYNOPSIS
# Gets a list of Snipe-it Assets
## SYNTAX
```
Get-Asset [[-search] <String>] [[-order_number] <Int32>] [[-model_id] <Int32>] [[-category_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-company_id] <Int32>] [[-location_id] <Int32>] [[-status] <String>]
[[-status_id] <Int32>] [[-sort] <String>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-url] <String> [-apiKey] <String>
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
Get-Asset -url "https://assets.example.com" -token "token..."
```
### -------------------------- EXAMPLE 2 --------------------------
```
Get-Asset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MyMachine" }
```
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
{{Fill order_number Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
{{Fill model_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{Fill category_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{Fill manufacturer_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{Fill company_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{Fill location_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -status
{{Fill status Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -status_id
{{Fill status_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{Fill sort Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{Fill order Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
{{Fill limit Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
{{Fill offset Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
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: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS