SnipeitPS/docs/New-SnipeitAssetMaintenance.md

242 lines
4 KiB
Markdown
Raw 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
# New-SnipeitAssetMaintenance
2021-05-18 05:57:40 +03:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Add a new Asset maintenence to Snipe-it asset system
2021-05-18 05:57:40 +03:00
## SYNTAX
```
2021-06-08 20:23:32 +03:00
New-SnipeitAssetMaintenance [-asset_id] <Int32> [-supplier_id] <Int32> [-asset_maintenance_type] <String>
2021-05-18 05:57:40 +03:00
[-title] <String> [-start_date] <DateTime> [[-completion_date] <DateTime>] [[-is_warranty] <Boolean>]
2021-08-23 18:50:13 +03:00
[[-cost] <Decimal>] [[-notes] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
2021-05-18 05:57:40 +03:00
[<CommonParameters>]
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Long description
2021-05-18 05:57:40 +03:00
## EXAMPLES
2021-05-19 15:51:49 +03:00
### EXAMPLE 1
```
2021-06-08 20:23:32 +03:00
New-SnipeitAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
2021-05-18 05:57:40 +03:00
```
## PARAMETERS
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: 11
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
Required ID of the asset, this can be got using Get-Asset
2021-05-18 05:57:40 +03:00
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 1
2021-05-19 15:51:49 +03:00
Default value: 0
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_maintenance_type
{{ Fill asset_maintenance_type Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2021-05-19 15:51:49 +03:00
Position: 3
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -completion_date
{{ Fill completion_date Description }}
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:22:23 +03:00
Type: DateTime
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 6
2021-05-23 23:22:23 +03:00
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
### -cost
Optional cost
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Decimal
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 8
Default value: 0
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:22:23 +03:00
### -is_warranty
Optional Maintenance done under warranty
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:22:23 +03:00
Type: Boolean
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:22:23 +03:00
Position: 7
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
### -notes
2021-05-23 23:22:23 +03:00
Optional cost
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-05-23 23:22:23 +03:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 9
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
### -start_date
Required start date
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: DateTime
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: True
Position: 5
2021-05-23 23:22:23 +03:00
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
### -supplier_id
Required maintenance supplier
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -title
Required Title of maintenance
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 4
2021-05-18 05:57:40 +03:00
Default value: None
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: 10
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -Confirm
Prompts you for confirmation before running the cmdlet.
2021-05-18 05:57:40 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
2021-05-18 05:57:40 +03:00
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
2021-05-18 05:57:40 +03:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: wi
2021-05-18 05:57:40 +03:00
Required: False
Position: Named
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