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

88 lines
1.4 KiB
Markdown

---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
# Get-Model
## SYNOPSIS
# Gets a list of Snipe-it Models
## SYNTAX
```
Get-Model [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
Get-Models -url "https://assets.example.com" -token "token..."
```
### -------------------------- EXAMPLE 2 --------------------------
```
Get-Models -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "DL380" }
```
## 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
```
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
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: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS