SnipeitPS/docs/Get-SnipeitAssetMaintenance.md

191 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
2021-10-27 14:11:27 +03:00
Module Name: SnipeitPS
2021-05-18 05:57:40 +03:00
online version:
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Get-SnipeitAssetMaintenance
2021-05-18 05:57:40 +03:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Lists Snipe-it Assets Maintenances
2021-05-18 05:57:40 +03:00
## SYNTAX
```
2021-06-08 20:23:32 +03:00
Get-SnipeitAssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort] <String>] [[-order] <String>]
2021-08-23 18:50:13 +03:00
[[-limit] <Int32>] [-all] [[-offset] <Int32>] [[-url] <String>] [[-apiKey] <String>] [<CommonParameters>]
2021-05-18 05:57:40 +03:00
```
## DESCRIPTION
{{ Fill in the Description }}
## EXAMPLES
### EXAMPLE 1
```
2021-08-23 18:50:13 +03:00
Get-SnipeitAssetMaintenances
2021-05-18 05:57:40 +03:00
```
### EXAMPLE 2
```
2021-08-23 18:50:13 +03:00
Get-SnipeitAssetMaintenances -search "myMachine"
2021-05-18 05:57:40 +03:00
```
### EXAMPLE 3
```
2021-08-23 18:50:13 +03:00
Get-SnipeitAssetMaintenances -search "myMachine"
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-05-18 05:57:40 +03:00
Parameter Sets: (All)
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-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
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-08-23 18:50:13 +03:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 8
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
### -asset_id
Asset ID of the asset you'd like to return maintenances for
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 2
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
### -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
2021-05-23 23:24:44 +03:00
Type: Int32
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 5
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
### -offset
Offset to use
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 6
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
Specify the order (asc or desc) you wish to order by on your sort column
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:
Required: False
2021-05-23 23:24:44 +03:00
Position: 4
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
Search string
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:
Required: False
2021-05-23 23:24:44 +03:00
Position: 1
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
Specify the column name you wish to sort by
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 3
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
### -url
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 7
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