SnipeitPS/docs/Get-AssetMaintenance.md
Petri Asikainen 8d33d687b0 Updated docs
2021-05-19 15:51:49 +03:00

3.2 KiB

external help file Module Name online version schema
SnipeItPS-help.xml SnipeitPS 2.0.0

Get-AssetMaintenance

SYNOPSIS

Lists Snipe-it Assets Maintenances

SYNTAX

Get-AssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort] <String>] [[-order] <String>]
 [[-limit] <Int32>] [-all] [[-offset] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-AssetMaintenances -url "https://assets.example.com" -token "token..."

EXAMPLE 2

Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."

EXAMPLE 3

Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."

PARAMETERS

-all

A return all results, works with -offset and other parameters

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-apiKey

Users API Key for Snipeit, can be set using Set-Info command

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-asset_id

Asset ID of the asset you'd like to return maintenances for

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-limit

Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False

-offset

Offset to use

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-order

Specify the order (asc or desc) you wish to order by on your sort column

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False

Search string

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-sort

Specify the column name you wish to sort by

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False

-url

URL of Snipeit system, can be set using Set-Info command

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 7
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.

INPUTS

OUTPUTS

NOTES