SnipeitPS/docs/Get-Asset.md

74 lines
1.1 KiB
Markdown
Raw Normal View History

2017-11-18 19:50:47 +00:00
---
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 [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
2017-11-20 09:07:58 +00:00
Get-Asset -url "https://assets.example.com" -token "token..."
2017-11-18 19:50:47 +00:00
```
### -------------------------- EXAMPLE 2 --------------------------
```
2017-11-20 09:07:58 +00:00
Get-Asset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MyMachine" }
2017-11-18 19:50:47 +00:00
```
## PARAMETERS
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
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: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS