dips/SnipeitPS
1
0
Fork 0
mirror of https://github.com/snazy2000/SnipeitPS.git synced 2025-12-13 01:42:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updates docs

Browse source
This commit is contained in:
Petri Asikainen 2021-08-23 18:50:13 +03:00
parent 88a94115b1
commit 69faba1856
75 changed files with 827 additions and 536 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

137
docs/Connect-SnipeitPS.md Normal file
View file

@ -0,0 +1,137 @@
---
external help file: SnipeitPS-help.xml
Module Name: snipeitps
online version:
schema: 2.0.0
---
# Connect-SnipeitPS
## SYNOPSIS
Sets authetication information
## SYNTAX
### Connect with url and apikey (Default)
```
Connect-SnipeitPS -url <Uri> -apiKey <String> [<CommonParameters>]
```
### Connect with url and secure apikey
```
Connect-SnipeitPS -url <Uri> -secureApiKey <SecureString> [<CommonParameters>]
```
### Connect with credential
```
Connect-SnipeitPS -siteCred <PSCredential> [<CommonParameters>]
```
## DESCRIPTION
Sets apikey and url to connect Snipe-It system.
Based on Set-SnipeitInfo command, what is now just combatipility wrapper
and calls Connect-SnipeitPS
## EXAMPLES
### EXAMPLE 1
```
Connect-SnipeitPS -Url $url -apiKey $myapikey
Connect to Snipe it api.
```
### EXAMPLE 2
```
Connect-SnipeitPS -Url $url -SecureApiKey $myapikey
Connects to Snipe it api with apikey stored to securestring
```
### EXAMPLE 3
```
Connect-SnipeitPS -siteCred (Get-Credential -message "Use site url as username and apikey as password")
Connect to Snipe It with PSCredential object.
To use saved creadentials yu can use export-clixml and import-clixml commandlets.
```
### EXAMPLE 4
```
Build credential with apikey value from secret vault (Microsoft.PowerShell.SecretManagement)
$siteurl = "https://mysnipeitsite.url"
$apikey = Get-SecretInfo -Name SnipeItApiKey
$siteCred = New-Object -Type PSCredential -Argumentlist $siteurl,$spikey
Connect-SnipeitPS -siteCred $siteCred
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: Connect with url and apikey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -secureApiKey
Snipe it Api key as securestring
```yaml
Type: SecureString
Parameter Sets: Connect with url and secure apikey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteCred
PSCredential where username shoul be snipe it url and password should be
snipe it apikey.
```yaml
Type: PSCredential
Parameter Sets: Connect with credential
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system.
```yaml
Type: Uri
Parameter Sets: Connect with url and apikey, Connect with url and secure apikey
Aliases:
Required: True
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

18
docs/Get-SnipeitAccessory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,17 +16,17 @@ Gets a list of Snipe-it Accessories
```
Get-SnipeitAccessory [-search <String>] [-company_id <Int32>] [-category_id <Int32>] [-manufacturer_id <Int32>]
[-supplier_id <Int32>] [-sort <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get by ID
```
Get-SnipeitAccessory [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitAccessory [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Accessories checked out to user id
```
Get-SnipeitAccessory [-user_id <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitAccessory [-user_id <Int32>] [-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -68,14 +68,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -235,14 +236,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

14
docs/Get-SnipeitAccessoryOwner.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Get list of checked out accessories
## SYNTAX
```
Get-SnipeitAccessoryOwner [-id] <Int32> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
Get-SnipeitAccessoryOwner [-id] <Int32> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -30,14 +30,15 @@ Get-SnipeitAccessoryOwner -id 1
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -60,14 +61,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

14
docs/Get-SnipeitActivity.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,7 +15,7 @@ Gets and search Snipe-it Activity history
```
Get-SnipeitActivity [[-search] <String>] [[-target_type] <String>] [[-target_id] <Int32>]
[[-item_type] <String>] [[-item_id] <Int32>] [[-action_type] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
[-all] [[-url] <String>] [[-apiKey] <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -67,14 +67,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False
@ -189,14 +190,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 9
Default value: None
Accept pipeline input: False

30
docs/Get-SnipeitAsset.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -17,46 +17,46 @@ Gets a list of Snipe-it Assets or specific asset
Get-SnipeitAsset [-search <String>] [-order_number <String>] [-model_id <Int32>] [-category_id <Int32>]
[-manufacturer_id <Int32>] [-company_id <Int32>] [-location_id <Int32>] [-depreciation_id <Int32>]
[-requestable <Boolean>] [-status <String>] [-status_id <Int32>] [-sort <String>] [-order <String>]
[-limit <Int32>] [-offset <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
[-limit <Int32>] [-offset <Int32>] [-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with id
```
Get-SnipeitAsset [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitAsset [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with asset tag
```
Get-SnipeitAsset [-asset_tag <String>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitAsset [-asset_tag <String>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with serial
```
Get-SnipeitAsset [-serial <String>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitAsset [-serial <String>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Assets due auditing soon
```
Get-SnipeitAsset [-audit_due] [-sort <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Assets overdue for auditing
```
Get-SnipeitAsset [-audit_overdue] [-sort <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Assets checked out to user id
```
Get-SnipeitAsset [-user_id <Int32>] [-sort <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>]
[-all] -url <String> -apiKey <String> [<CommonParameters>]
[-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Assets with component id
```
Get-SnipeitAsset [-component_id <Int32>] [-sort <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>]
[-all] -url <String> -apiKey <String> [<CommonParameters>]
[-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -66,7 +66,7 @@ Get-SnipeitAsset [-component_id <Int32>] [-sort <String>] [-order <String>] [-li
### EXAMPLE 1
```
Get-SnipeitAsset -all -url "https://assets.example.com"-token "token..."
Get-SnipeitAsset -all
Returens all assets
```
@ -136,14 +136,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -468,14 +469,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

20
docs/Get-SnipeitAssetMaintenance.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Lists Snipe-it Assets Maintenances
```
Get-SnipeitAssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort] <String>] [[-order] <String>]
[[-limit] <Int32>] [-all] [[-offset] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
[[-limit] <Int32>] [-all] [[-offset] <Int32>] [[-url] <String>] [[-apiKey] <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -24,17 +24,17 @@ Get-SnipeitAssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort]
### EXAMPLE 1
```
Get-SnipeitAssetMaintenances -url "https://assets.example.com" -token "token..."
Get-SnipeitAssetMaintenances
```
### EXAMPLE 2
```
Get-SnipeitAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
Get-SnipeitAssetMaintenances -search "myMachine"
```
### EXAMPLE 3
```
Get-SnipeitAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
Get-SnipeitAssetMaintenances -search "myMachine"
```
## PARAMETERS
@ -55,14 +55,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 8
Default value: None
Accept pipeline input: False
@ -162,14 +163,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 7
Default value: None
Accept pipeline input: False

16
docs/Get-SnipeitCategory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,12 +15,12 @@ Gets a list of Snipe-it Categories
### Search (Default)
```
Get-SnipeitCategory [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitCategory [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitCategory [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -56,14 +56,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -148,14 +149,15 @@ Accept wildcard characters: False
```
### -url
Url of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Url of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

18
docs/Get-SnipeitCompany.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,13 +14,13 @@ Gets a list of Snipe-it Companies
### Search (Default)
```
Get-SnipeitCompany [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all] -url <String>
-apiKey <String> [<CommonParameters>]
Get-SnipeitCompany [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitCompany [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitCompany [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -58,14 +58,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -150,14 +151,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

18
docs/Get-SnipeitComponent.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,13 +15,13 @@ Gets a list of Snipe-it Components
### Search (Default)
```
Get-SnipeitComponent [-search <String>] [-category_id <Int32>] [-company_id <Int32>] [-location_id <Int32>]
[-order <String>] [-sort <String>] [-limit <Int32>] [-offset <Int32>] [-all] -url <String> -apiKey <String>
[<CommonParameters>]
[-order <String>] [-sort <String>] [-limit <Int32>] [-offset <Int32>] [-all] [-url <String>]
[-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitComponent [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitComponent [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -65,14 +65,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -217,14 +218,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system,can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

16
docs/Get-SnipeitConsumable.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,12 +16,12 @@ Gets a list of Snipe-it consumables
```
Get-SnipeitConsumable [-search <String>] [-category_id <Int32>] [-company_id <Int32>]
[-manufacturer_id <Int32>] [-location_id <Int32>] [-order <String>] [-sort <String>] [-expand]
[-limit <Int32>] [-offset <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
[-limit <Int32>] [-offset <Int32>] [-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitConsumable [-id <Int32[]>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitConsumable [-id <Int32[]>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -65,14 +65,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -247,14 +248,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system,can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

23
docs/Get-SnipeitCustomField.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Returns specific Snipe-IT custom field or a list of all custom field
## SYNTAX
```
Get-SnipeitCustomField [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeitCustomField [[-id] <Int32>] [[-url] <String>] [[-apiKey] <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -23,20 +23,28 @@ Get-SnipeitCustomField [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<Comm
### EXAMPLE 1
```
Get-SnipeitCustomField -url "https://assets.example.com" -token "token..."
Get-SnipeitCustomField
Get all custom fields
```
### EXAMPLE 2
```
Get-SnipeitCustomField -id 1
Get custom field with ID 1
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -59,14 +67,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

18
docs/Get-SnipeitDepartment.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,12 +15,12 @@ Gets a list of Snipe-it Departments
### Search (Default)
```
Get-SnipeitDepartment [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
[-sort <String>] -url <String> -apiKey <String> [<CommonParameters>]
[-sort <String>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitDepartment [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitDepartment [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -30,7 +30,7 @@ Get-SnipeitDepartment [-id <Int32>] -url <String> -apiKey <String> [<CommonParam
### EXAMPLE 1
```
Get-SnipeitDepartment -url "https://assets.example.com" -token "token..."
Get-SnipeitDepartment
```
### EXAMPLE 2
@ -61,14 +61,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -168,14 +169,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

20
docs/Get-SnipeitFieldset.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Returns a fieldset or list of Snipe-it Fieldsets
## SYNTAX
```
Get-SnipeitFieldset [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]
Get-SnipeitFieldset [[-id] <Int32>] [[-url] <String>] [[-apiKey] <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -23,25 +23,28 @@ Get-SnipeitFieldset [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonP
### EXAMPLE 1
```
Get-SnipeitFieldset -url "https://assets.example.com" -token "token..."
Get-SnipeitFieldset
Get all fieldsets
```
### EXAMPLE 2
```
Get-SnipeitFieldset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Windows" }
Get-SnipeitFieldset | Where-Object {$_.name -eq "Windows" }
Gets fieldset by name
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,14 +67,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

22
docs/Get-SnipeitLicense.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -17,23 +17,23 @@ Gets a list of Snipe-it Licenses
Get-SnipeitLicense [-search <String>] [-name <String>] [-company_id <Int32>] [-product_key <String>]
[-order_number <String>] [-purchase_order <String>] [-license_name <String>] [-license_email <MailAddress>]
[-manufacturer_id <Int32>] [-supplier_id <Int32>] [-depreciation_id <Int32>] [-category_id <Int32>]
[-order <String>] [-sort <String>] [-limit <Int32>] [-offset <Int32>] [-all] -url <String> -apiKey <String>
[<CommonParameters>]
[-order <String>] [-sort <String>] [-limit <Int32>] [-offset <Int32>] [-all] [-url <String>]
[-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitLicense [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitLicense [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get licenses checked out to user ID
```
Get-SnipeitLicense [-user_id <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitLicense [-user_id <Int32>] [-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get licenses checked out to asset ID
```
Get-SnipeitLicense [-asset_id <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitLicense [-asset_id <Int32>] [-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -69,14 +69,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -356,14 +357,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

14
docs/Get-SnipeitLicenseSeat.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Gets a list of Snipe-it Licenses Seats or specific Seat
```
Get-SnipeitLicenseSeat [-id] <Int32> [[-seat_id] <Int32>] [[-limit] <Int32>] [[-offset] <Int32>] [-all]
[-url] <String> [-apiKey] <String> [<CommonParameters>]
[[-url] <String>] [[-apiKey] <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -45,14 +45,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 6
Default value: None
Accept pipeline input: False
@ -122,14 +123,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 5
Default value: None
Accept pipeline input: False

16
docs/Get-SnipeitLocation.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,12 +15,12 @@ Gets a list of Snipe-it Locations
### Search (Default)
```
Get-SnipeitLocation [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitLocation [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitLocation [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -56,14 +56,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -148,14 +149,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

16
docs/Get-SnipeitManufacturer.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,12 +15,12 @@ schema: 2.0.0
### Search (Default)
```
Get-SnipeitManufacturer [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitManufacturer [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitManufacturer [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -58,14 +58,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -150,14 +151,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

18
docs/Get-SnipeitModel.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,13 +14,13 @@ Gets a list of Snipe-it Models
### Search (Default)
```
Get-SnipeitModel [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all] -url <String>
-apiKey <String> [<CommonParameters>]
Get-SnipeitModel [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all] [-url <String>]
[-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitModel [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitModel [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -56,14 +56,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -148,14 +149,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

18
docs/Get-SnipeitStatus.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,13 +14,13 @@ Gets a list of Snipe-it Status Labels
### Search (Default)
```
Get-SnipeitStatus [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all] -url <String>
-apiKey <String> [<CommonParameters>]
Get-SnipeitStatus [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitStatus [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitStatus [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -56,14 +56,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -148,14 +149,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

16
docs/Get-SnipeitSupplier.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,12 +15,12 @@ schema: 2.0.0
### Search (Default)
```
Get-SnipeitSupplier [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all]
-url <String> -apiKey <String> [<CommonParameters>]
[-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitSupplier [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitSupplier [-id <Int32>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -56,14 +56,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -148,14 +149,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

18
docs/Get-SnipeitUser.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,17 +16,17 @@ schema: 2.0.0
```
Get-SnipeitUser [-search <String>] [-company_id <Int32>] [-location_id <Int32>] [-group_id <Int32>]
[-department_id <Int32>] [-username <String>] [-email <String>] [-order <String>] [-limit <Int32>]
[-offset <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
[-offset <Int32>] [-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get with ID
```
Get-SnipeitUser [-id <String>] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitUser [-id <String>] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
### Get users a specific accessory id has been checked out to
```
Get-SnipeitUser [-accessory_id <String>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
Get-SnipeitUser [-accessory_id <String>] [-all] [-url <String>] [-apiKey <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -93,14 +93,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -260,14 +261,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

14
docs/New-SnipeitAccessory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,7 +16,7 @@ Creates new accessory on Snipe-It system
New-SnipeitAccessory [-name] <String> [-qty] <Int32> [-category_id] <Int32> [[-company_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-order_number] <String>] [[-model_number] <String>] [[-purchase_cost] <Single>]
[[-purchase_date] <DateTime>] [[-min_amt] <Int32>] [[-supplier_id] <Int32>] [[-location_id] <Int32>]
[[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-image] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -32,14 +32,15 @@ New-SnipeitAccessory -name "Accessory" -qty 3 -category_id 1
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 15
Default value: None
Accept pipeline input: False
@ -242,14 +243,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 14
Default value: None
Accept pipeline input: False

16
docs/New-SnipeitAsset.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -17,7 +17,7 @@ Add a new Asset to Snipe-it asset system
New-SnipeitAsset -status_id <Int32> -model_id <Int32> [-name <String>] [-asset_tag <String>] [-serial <String>]
[-company_id <Int32>] [-order_number <String>] [-notes <String>] [-warranty_months <Int32>]
[-purchase_cost <String>] [-purchase_date <DateTime>] [-supplier_id <Int32>] [-rtd_location_id <Int32>]
[-image <String>] -url <String> -apiKey <String> [-customfields <Hashtable>] [-WhatIf] [-Confirm]
[-image <String>] [-url <String>] [-apiKey <String>] [-customfields <Hashtable>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -26,7 +26,7 @@ New-SnipeitAsset -status_id <Int32> -model_id <Int32> [-name <String>] [-asset_t
New-SnipeitAsset -status_id <Int32> -model_id <Int32> [-name <String>] [-asset_tag <String>] [-serial <String>]
[-company_id <Int32>] [-order_number <String>] [-notes <String>] [-warranty_months <Int32>]
[-purchase_cost <String>] [-purchase_date <DateTime>] [-supplier_id <Int32>] [-rtd_location_id <Int32>]
[-image <String>] -assigned_id <Int32> -checkout_to_type <String> -url <String> -apiKey <String>
[-image <String>] -assigned_id <Int32> -checkout_to_type <String> [-url <String>] [-apiKey <String>]
[-customfields <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
@ -56,14 +56,15 @@ Using customfields when creating asset.
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@ -312,14 +313,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False

14
docs/New-SnipeitAssetMaintenance.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,7 +15,7 @@ Add a new Asset maintenence to Snipe-it asset system
```
New-SnipeitAssetMaintenance [-asset_id] <Int32> [-supplier_id] <Int32> [-asset_maintenance_type] <String>
[-title] <String> [-start_date] <DateTime> [[-completion_date] <DateTime>] [[-is_warranty] <Boolean>]
[[-cost] <Decimal>] [[-notes] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[[-cost] <Decimal>] [[-notes] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -32,14 +32,15 @@ New-SnipeitAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard"
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 11
Default value: None
Accept pipeline input: False
@ -182,14 +183,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False

8
docs/New-SnipeitAudit.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Add a new Audit to Snipe-it asset system
## SYNTAX
```
New-SnipeitAudit [-tag] <String> [[-location_id] <Int32>] [-url] <String> [-apiKey] <String> [-WhatIf]
New-SnipeitAudit [-tag] <String> [[-location_id] <Int32>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
@ -37,7 +37,7 @@ Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 4
Default value: None
Accept pipeline input: False
@ -82,7 +82,7 @@ Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False

16
docs/New-SnipeitCategory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Create a new Snipe-IT Category
```
New-SnipeitCategory [-name] <String> [-category_type] <String> [[-eula_text] <String>] [-use_default_eula]
[-require_acceptance] [-checkin_email] [[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[-require_acceptance] [-checkin_email] [[-image] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
@ -25,20 +25,21 @@ New-SnipeitCategory [-name] <String> [-category_type] <String> [[-eula_text] <St
### EXAMPLE 1
```
New-SnipeitCategory -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
New-SnipeitCategory -name "Laptops" -category_type asset
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 6
Default value: None
Accept pipeline input: False
@ -136,14 +137,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 5
Default value: None
Accept pipeline input: False

16
docs/New-SnipeitCompany.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,8 +13,8 @@ Creates a new Company
## SYNTAX
```
New-SnipeitCompany [-name] <String> [[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
New-SnipeitCompany [-name] <String> [[-image] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -30,14 +30,15 @@ New-SnipeitCompany -name "Acme Company"
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 4
Default value: None
Accept pipeline input: False
@ -75,14 +76,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False

17
docs/New-SnipeitComponent.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,7 +15,7 @@ Create a new component
```
New-SnipeitComponent [-name] <String> [-category_id] <Int32> [-qty] <String> [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-order_number] <String>] [[-purchase_date] <DateTime>] [[-purchase_cost] <Single>]
[[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-image] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -25,20 +25,21 @@ Createa new componen on Snipe-It system
### EXAMPLE 1
```
An example
New-SnipeitComponent -name 'Display adapter' -catecory_id 3 -qty 10
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 11
Default value: None
Accept pipeline input: False
@ -181,14 +182,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False
@ -234,6 +236,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## OUTPUTS
## NOTES
General notes
## RELATED LINKS

14
docs/New-SnipeitConsumable.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,7 +16,7 @@ Add a new Consumable to Snipe-it asset system
New-SnipeitConsumable [-name] <String> [-qty] <Int32> [-category_id] <Int32> [[-min_amt] <Int32>]
[[-company_id] <Int32>] [[-order_number] <String>] [[-manufacturer_id] <Int32>] [[-location_id] <Int32>]
[[-requestable] <Boolean>] [[-purchase_date] <DateTime>] [[-purchase_cost] <String>]
[[-model_number] <String>] [[-item_no] <String>] [[-image] <String>] [-url] <String> [-apiKey] <String>
[[-model_number] <String>] [[-item_no] <String>] [[-image] <String>] [[-url] <String>] [[-apiKey] <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]
```
@ -34,14 +34,15 @@ Create consumable with stock count 20 , alert when stock is 5 or lower
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 16
Default value: None
Accept pipeline input: False
@ -259,14 +260,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 15
Default value: None
Accept pipeline input: False

14
docs/New-SnipeitCustomField.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,7 +15,7 @@ Add a new Custom Field to Snipe-it asset system
```
New-SnipeitCustomField [-name] <String> [[-help_text] <String>] [-element] <String> [-format] <String>
[[-field_values] <String>] [[-field_encrypted] <Boolean>] [[-show_in_email] <Boolean>]
[[-custom_format] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-custom_format] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -31,14 +31,15 @@ New-SnipeitCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False
@ -167,14 +168,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 9
Default value: None
Accept pipeline input: False

14
docs/New-SnipeitDepartment.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Creates a department
```
New-SnipeitDepartment [-name] <String> [[-company_id] <Int32>] [[-location_id] <Int32>] [[-manager_id] <Int32>]
[[-notes] <String>] [[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String> [-WhatIf]
[[-notes] <String>] [[-image] <String>] [-image_delete] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
@ -31,14 +31,15 @@ New-SnipeitDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 8
Default value: None
Accept pipeline input: False
@ -151,14 +152,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 7
Default value: None
Accept pipeline input: False

14
docs/New-SnipeitLicense.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -17,7 +17,7 @@ New-SnipeitLicense [-name] <String> [-seats] <Int32> [[-category_id] <Int32>] [[
[[-expiration_date] <DateTime>] [[-license_email] <MailAddress>] [[-license_name] <String>]
[[-maintained] <Boolean>] [[-manufacturer_id] <Int32>] [[-notes] <String>] [[-order_number] <String>]
[[-purchase_cost] <Single>] [[-purchase_date] <DateTime>] [[-reassignable] <Boolean>] [[-serial] <String>]
[[-supplier_id] <Int32>] [[-termination_date] <DateTime>] [-url] <String> [-apiKey] <String> [-WhatIf]
[[-supplier_id] <Int32>] [[-termination_date] <DateTime>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
@ -34,14 +34,15 @@ New-SnipeitLicence -name "License" -seats 3 -company_id 1
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 19
Default value: None
Accept pipeline input: False
@ -304,14 +305,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 18
Default value: None
Accept pipeline input: False

16
docs/New-SnipeitLocation.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,8 +15,8 @@ Add a new Location to Snipe-it asset system
```
New-SnipeitLocation [-name] <String> [[-address] <String>] [[-address2] <String>] [[-city] <String>]
[[-state] <String>] [[-country] <String>] [[-zip] <String>] [[-currency] <String>] [[-parent_id] <Int32>]
[[-manager_id] <Int32>] [[-ldap_ou] <String>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-manager_id] <Int32>] [[-ldap_ou] <String>] [[-image] <String>] [-image_delete] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -62,14 +62,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 14
Default value: None
Accept pipeline input: False
@ -227,14 +228,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 13
Default value: None
Accept pipeline input: False

16
docs/New-SnipeitManufacturer.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,8 +13,8 @@ Add a new Manufacturer to Snipe-it asset system
## SYNTAX
```
New-SnipeitManufacturer [-Name] <String> [[-image] <String>] [-image_delete] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
New-SnipeitManufacturer [-Name] <String> [[-image] <String>] [-image_delete] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -30,14 +30,15 @@ New-SnipeitManufacturer -name "HP"
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 4
Default value: None
Accept pipeline input: False
@ -90,14 +91,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False

14
docs/New-SnipeitModel.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Add a new Model to Snipe-it asset system
```
New-SnipeitModel [-name] <String> [[-model_number] <String>] [-category_id] <Int32> [-manufacturer_id] <Int32>
[[-eol] <Int32>] [-fieldset_id] <Int32> [[-image] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[[-eol] <Int32>] [-fieldset_id] <Int32> [[-image] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
@ -31,14 +31,15 @@ New-SnipeitModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 9
Default value: None
Accept pipeline input: False
@ -151,14 +152,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 8
Default value: None
Accept pipeline input: False

16
docs/New-SnipeitSupplier.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,8 +15,8 @@ Creates a supplier
```
New-SnipeitSupplier [-name] <String> [[-address] <String>] [[-address2] <String>] [[-city] <String>]
[[-state] <String>] [[-country] <String>] [[-zip] <String>] [[-phone] <String>] [[-fax] <String>]
[[-email] <String>] [[-contact] <String>] [[-notes] <String>] [[-image] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-email] <String>] [[-contact] <String>] [[-notes] <String>] [[-image] <String>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -62,14 +62,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 15
Default value: None
Accept pipeline input: False
@ -227,14 +228,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 14
Default value: None
Accept pipeline input: False

16
docs/New-SnipeitUser.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,8 +16,8 @@ Creates a new user
New-SnipeitUser [-first_name] <String> [-last_name] <String> [-username] <String> [[-password] <String>]
[[-activated] <Boolean>] [[-notes] <String>] [[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>]
[[-company_id] <Int32>] [[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>]
[[-employee_num] <String>] [[-ldap_import] <Boolean>] [[-image] <String>] [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
[[-employee_num] <String>] [[-ldap_import] <Boolean>] [[-image] <String>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -49,14 +49,15 @@ Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 18
Default value: None
Accept pipeline input: False
@ -274,14 +275,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 17
Default value: None
Accept pipeline input: False

18
docs/Remove-SnipeitAccessory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes Accessory from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitAccessory [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitAccessory [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -34,15 +34,16 @@ Get-SnipeitAccessory -search needle | Remove-SnipeitAccessory
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

18
docs/Remove-SnipeitAsset.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes Asset from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitAsset [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitAsset [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -34,15 +34,16 @@ Get-SnipeitAsset -serial 123456789 | Remove-SnipeitAsset
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

15
docs/Remove-SnipeitAssetMaintenance.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Remove asset maintenance from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitAssetMaintenance [-id] <Int32[]> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitAssetMaintenance [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,20 +24,20 @@ Removes asset maintenance event or events from Snipe-it asset system by ID
### EXAMPLE 1
```
Remove-SnipeitAssetMaintenance -ID 44 -url $url -apiKey $secret -Verbose
Remove-SnipeitAssetMaintenance -ID 44
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
{{ Fill apiKey Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -60,14 +60,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitCategory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes category from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitCategory [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitCategory [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes category or multiple categories from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitCategory -ID 44 -Verbose
Remove-SnipeitCategory -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitCategory -search something | Remove-SnipeitCategory
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitCompany.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes Company from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitCompany [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitCompany [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes Company or multiple Companies from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitCompany -ID 44 -Verbose
Remove-SnipeitCompany -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitCompany | | Where-object {$_.name -like '*some*'} | Remove-SnipeitCom
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitComponent.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes component from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitComponent [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitComponent [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes component or multiple components from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitComponent -ID 44 -Verbose
Remove-SnipeitComponent -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitComponent -search 123456789 | Remove-SnipeitComponent
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

22
docs/Remove-SnipeitConsumable.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes consumable from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitConsumable [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitConsumable [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,25 +24,26 @@ Removes consumable or multiple consumables from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitConsumable -ID 44 -Verbose
Remove-SnipeitConsumable -ID 44
```
### EXAMPLE 2
```
Get-SnipeitConsumable -search "paper" | Remove-Snipeitconsumable
Get-SnipeitConsumable -search "paper" | Remove-SnipeitConsumable
```
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

18
docs/Remove-SnipeitCustomField.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes custom field from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitCustomField [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitCustomField [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -34,15 +34,16 @@ Get-SnipeitCustomField | Where-object {$_.name -like '*address*'} | Remove-Snip
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitDepartment.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes department from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitDepartment [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitDepartment [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes department or multiple departments from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitDepartment -ID 44 -Verbose
Remove-SnipeitDepartment -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitDepartment | Where-object {$_.name -like '*head*'} | Remove-SnipeitDe
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitLicense.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes licence from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitLicense [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitLicense [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes licence or multiple licenses from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitLicence -ID 44 -Verbose
Remove-SnipeitLicence -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitLicence -product_key 123456789 | Remove-SnipeitLicense
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitLocation.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes Location from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitLocation [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitLocation [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes localtion or multiple locations from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitLocation -ID 44 -Verbose
Remove-SnipeitLocation -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitLocation -city Arkham | Remove-SnipeitLocation
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitManufacturer.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes manufacturer from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitManufacturer [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitManufacturer [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes manufacturer or multiple manufacturers from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitManufacturer -ID 44 -Verbose
Remove-SnipeitManufacturer -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitManufacturer | Where-object {$_.name -like '*something*'} | Remove-S
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

20
docs/Remove-SnipeitModel.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes Asset model from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitModel [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitModel [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -24,7 +24,7 @@ Removes asset model or multiple assets models from Snipe-it asset system
### EXAMPLE 1
```
Remove-SnipeitModel -ID 44 -Verbose
Remove-SnipeitModel -ID 44
```
### EXAMPLE 2
@ -34,15 +34,16 @@ Get-SnipeitModel -search needle | Remove-SnipeitModel
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

18
docs/Remove-SnipeitSupplier.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Removes supplier from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitSupplier [-id] <Int32[]> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm]
Remove-SnipeitSupplier [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -34,15 +34,16 @@ Get-SnipeitSupplier | Where-object {$_.name -like '*something*'} | Remove-Snipe
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

23
docs/Remove-SnipeitUser.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,8 @@ Removes User from Snipe-it asset system
## SYNTAX
```
Remove-SnipeitUser [-id] <Int32> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-SnipeitUser [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@ -28,15 +29,16 @@ Remove-SnipeitUser -ID 44 -url $url -apiKey $secret -Verbose
## PARAMETERS
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -47,26 +49,27 @@ Accept wildcard characters: False
Unique ID For User to be removed
```yaml
Type: Int32
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-SnipeitInfo command
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

14
docs/Reset-SnipeitAccessoryOwner.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,7 +13,7 @@ Checkin accessories
## SYNTAX
```
Reset-SnipeitAccessoryOwner [-assigned_pivot_id] <Int32> [-url] <String> [-apiKey] <String> [-WhatIf]
Reset-SnipeitAccessoryOwner [-assigned_pivot_id] <Int32> [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
@ -36,14 +36,15 @@ Get-SnipeitAccessoryOwner -assigned_pivot_id xxx
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 3
Default value: None
Accept pipeline input: False
@ -67,14 +68,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: False

16
docs/Reset-SnipeitAssetOwner.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Checkin asset
```
Reset-SnipeitAssetOwner [-id] <Int32> [[-status_id] <Int32>] [[-location_id] <Int32>] [[-notes] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -24,20 +24,21 @@ Checks asset in from current user/localtion/asset
### EXAMPLE 1
```
Remove-SnipeitUser -ID 44 -url $url -apiKey $secret -Verbose
Remove-SnipeitUser -ID 44
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 6
Default value: None
Accept pipeline input: False
@ -105,14 +106,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 5
Default value: None
Accept pipeline input: False

16
docs/Set-SnipeitAccessory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,8 +16,8 @@ Updates accessory on Snipe-It system
Set-SnipeitAccessory [-id] <Int32[]> [[-name] <String>] [[-qty] <Int32>] [[-category_id] <Int32>]
[[-company_id] <Int32>] [[-manufacturer_id] <Int32>] [[-model_number] <String>] [[-order_number] <String>]
[[-purchase_cost] <Single>] [[-purchase_date] <DateTime>] [[-min_amt] <Int32>] [[-supplier_id] <Int32>]
[[-location_id] <Int32>] [[-image] <String>] [-image_delete] [[-RequestType] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-location_id] <Int32>] [[-image] <String>] [-image_delete] [[-RequestType] <String>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -33,14 +33,15 @@ Set-SnipeitAccessory -id 1 -qty 3
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfoeItInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 17
Default value: None
Accept pipeline input: False
@ -289,14 +290,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 16
Default value: None
Accept pipeline input: False

16
docs/Set-SnipeitAccessoryOwner.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,8 +13,8 @@ Checkout accessory
## SYNTAX
```
Set-SnipeitAccessoryOwner [-id] <Int32[]> [-assigned_to] <Int32> [[-note] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Set-SnipeitAccessoryOwner [-id] <Int32[]> [-assigned_to] <Int32> [[-note] <String>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -30,14 +30,15 @@ Set-SnipeitAccessoryOwner -id 1 -assigned_id 1 -note "testing check out to user
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 5
Default value: None
Accept pipeline input: False
@ -90,14 +91,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 4
Default value: None
Accept pipeline input: False

16
docs/Set-SnipeitAsset.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -17,8 +17,8 @@ Set-SnipeitAsset [-id] <Int32[]> [[-name] <String>] [[-status_id] <Int32>] [[-mo
[[-last_checkout] <DateTime>] [[-assigned_to] <Int32>] [[-company_id] <Int32>] [[-serial] <String>]
[[-order_number] <String>] [[-warranty_months] <Int32>] [[-purchase_cost] <Double>]
[[-purchase_date] <DateTime>] [[-requestable] <Boolean>] [[-archived] <Boolean>] [[-rtd_location_id] <Int32>]
[[-notes] <String>] [[-RequestType] <String>] [[-image] <String>] [-image_delete] [-url] <String>
[-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
[[-notes] <String>] [[-RequestType] <String>] [[-image] <String>] [-image_delete] [[-url] <String>]
[[-apiKey] <String>] [[-customfields] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -44,14 +44,15 @@ Get-SnipeitAsset -serial 12345678 | Set-SnipeitAsset -notes 'Just updated'
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 20
Default value: None
Accept pipeline input: False
@ -346,14 +347,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 19
Default value: None
Accept pipeline input: False

16
docs/Set-SnipeitAssetOwner.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,8 +14,8 @@ Checkout asset
```
Set-SnipeitAssetOwner [-id] <Int32[]> [-assigned_id] <Int32> [[-checkout_to_type] <String>] [[-name] <String>]
[[-note] <String>] [[-expected_checkin] <DateTime>] [[-checkout_at] <DateTime>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-note] <String>] [[-expected_checkin] <DateTime>] [[-checkout_at] <DateTime>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -31,14 +31,15 @@ Set-SnipeitAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 9
Default value: None
Accept pipeline input: False
@ -154,14 +155,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 8
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitCategory.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,7 +15,7 @@ Create a new Snipe-IT Category
```
Set-SnipeitCategory [-id] <Int32[]> [[-name] <String>] [[-category_type] <String>] [[-eula_text] <String>]
[[-use_default_eula] <Boolean>] [[-require_acceptance] <Boolean>] [[-checkin_email] <Boolean>]
[[-image] <String>] [-image_delete] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf]
[[-image] <String>] [-image_delete] [[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
@ -32,14 +32,15 @@ Set-SnipeitCategory -id 4 -name "Laptops"
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 11
Default value: None
Accept pipeline input: False
@ -183,14 +184,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitCompany.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Updates company name
```
Set-SnipeitCompany [-id] <Int32[]> [-name] <String> [[-image] <String>] [-image_delete]
[[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -30,14 +30,15 @@ An example
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 6
Default value: None
Accept pipeline input: False
@ -121,14 +122,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 5
Default value: None
Accept pipeline input: False

20
docs/Set-SnipeitComponent.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,8 +15,8 @@ Updates component
```
Set-SnipeitComponent [-id] <Int32[]> [-qty] <Int32> [[-min_amt] <Int32>] [[-name] <String>]
[[-company_id] <Int32>] [[-location_id] <Int32>] [[-order_number] <String>] [[-purchase_date] <DateTime>]
[[-purchase_cost] <Single>] [[-image] <String>] [-image_delete] [[-RequestType] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-purchase_cost] <Single>] [[-image] <String>] [-image_delete] [[-RequestType] <String>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -26,20 +26,22 @@ Updates component on Snipe-It system
### EXAMPLE 1
```
An example
Set-SnipeitComponent -id 42 -qty 12
Sets count of component with ID 42 to 12
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 13
Default value: None
Accept pipeline input: False
@ -228,14 +230,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 12
Default value: None
Accept pipeline input: False
@ -281,6 +284,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## OUTPUTS
## NOTES
General notes
## RELATED LINKS

14
docs/Set-SnipeitConsumable.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -17,7 +17,7 @@ Set-SnipeitConsumable [-id] <Int32[]> [[-name] <String>] [[-qty] <Int32>] [[-cat
[[-min_amt] <Int32>] [[-company_id] <Int32>] [[-order_number] <String>] [[-manufacturer_id] <Int32>]
[[-location_id] <Int32>] [[-requestable] <Boolean>] [[-purchase_date] <DateTime>] [[-purchase_cost] <String>]
[[-model_number] <String>] [[-item_no] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -34,14 +34,15 @@ Create consumable with stock count 20 , alert when stock is 5 or lower
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 18
Default value: None
Accept pipeline input: False
@ -305,14 +306,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 17
Default value: None
Accept pipeline input: False

16
docs/Set-SnipeitCustomField.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,8 +15,8 @@ Add a new Custom Field to Snipe-it asset system
```
Set-SnipeitCustomField [-id] <Int32[]> [[-name] <String>] [[-help_text] <String>] [-element] <String>
[[-format] <String>] [[-field_values] <String>] [[-field_encrypted] <Boolean>] [[-show_in_email] <Boolean>]
[[-custom_format] <String>] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
[[-custom_format] <String>] [[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -32,14 +32,15 @@ New-SnipeitCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 12
Default value: None
Accept pipeline input: False
@ -199,14 +200,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 11
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitDepartment.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,7 +15,7 @@ Updates a department
```
Set-SnipeitDepartment [-id] <Int32[]> [[-name] <String>] [[-company_id] <Int32>] [[-location_id] <Int32>]
[[-manager_id] <Int32>] [[-notes] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -31,14 +31,15 @@ Set-SnipeitDepartment -id 4 -manager_id 3
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False
@ -182,14 +183,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 9
Default value: None
Accept pipeline input: False

18
docs/Set-SnipeitInfo.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -8,16 +8,18 @@ schema: 2.0.0
# Set-SnipeitInfo
## SYNOPSIS
Sets authetication information
Sets authetication information.
Deprecated, use Connect-SnipeitPS instead.
## SYNTAX
```
Set-SnipeitInfo [[-url] <Uri>] [[-apiKey] <String>] [<CommonParameters>]
Set-SnipeitInfo [-url] <Uri> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
Set apikey and url user to connect Snipe-It system
Deprecated combatibilty function that Set apikey and url user to connect Snipe-It system.
Please use Connect-SnipeitPS instead.
## EXAMPLES
@ -29,14 +31,14 @@ Set-SnipeitInfo -url $url -apiKey -Verbose
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: 2
Default value: None
Accept pipeline input: False
@ -44,14 +46,14 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
URL of Snipeit system.
```yaml
Type: Uri
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: 1
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitLicense.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -18,7 +18,7 @@ Set-SnipeitLicense [-id] <Int32[]> [[-name] <String>] [[-seats] <Int32>] [[-cate
[[-license_name] <String>] [[-maintained] <Boolean>] [[-manufacturer_id] <Int32>] [[-notes] <String>]
[[-order_number] <String>] [[-purchase_cost] <Single>] [[-purchase_date] <DateTime>]
[[-reassignable] <Boolean>] [[-serial] <String>] [[-supplier_id] <Int32>] [[-termination_date] <DateTime>]
[[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -34,14 +34,15 @@ Set-SnipeitLicence -name "License" -seats 3 -company_id 1
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 21
Default value: None
Accept pipeline input: False
@ -335,14 +336,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 20
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitLicenseSeat.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Set license seat or checkout license seat
```
Set-SnipeitLicenseSeat [-id] <Int32[]> [-seat_id] <Int32> [[-assigned_to] <Int32>] [[-asset_id] <Int32>]
[[-note] <String>] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[[-note] <String>] [[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -44,14 +44,15 @@ Checkin licence seat id 1 of licence id 1
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 8
Default value: None
Accept pipeline input: False
@ -150,14 +151,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 7
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitLocation.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,7 +16,7 @@ Updates Location in Snipe-it asset system
Set-SnipeitLocation [-id] <Int32[]> [[-name] <String>] [[-address] <String>] [[-address2] <String>]
[[-state] <String>] [[-country] <String>] [[-zip] <String>] [[-city] <String>] [[-currency] <String>]
[[-manager_id] <Int32>] [[-ldap_ou] <String>] [[-parent_id] <Int32>] [[-image] <String>] [-image_delete]
[[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -62,14 +62,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 16
Default value: None
Accept pipeline input: False
@ -258,14 +259,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 15
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitManufacturer.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,7 +14,7 @@ Add a new Manufacturer to Snipe-it asset system
```
Set-SnipeitManufacturer [-Name] <String> [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -30,14 +30,15 @@ New-SnipeitManufacturer -name "HP"
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 5
Default value: None
Accept pipeline input: False
@ -106,14 +107,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 4
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitModel.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -15,7 +15,7 @@ Updates Model on Snipe-it asset system
```
Set-SnipeitModel [-id] <Int32[]> [[-name] <String>] [[-model_number] <String>] [[-category_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-eol] <Int32>] [[-custom_fieldset_id] <Int32>] [[-image] <String>]
[-image_delete] [[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[-image_delete] [[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@ -32,14 +32,15 @@ New-SnipeitModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 11
Default value: None
Accept pipeline input: False
@ -198,14 +199,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False

16
docs/Set-SnipeitStatus.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -14,8 +14,8 @@ Sets Snipe-it Status Labels
```
Set-SnipeitStatus [-id] <Int32[]> [[-name] <String>] [-type] <String> [[-notes] <String>] [[-color] <String>]
[[-show_in_nav] <Boolean>] [[-default_label] <Boolean>] [[-RequestType] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-show_in_nav] <Boolean>] [[-default_label] <Boolean>] [[-RequestType] <String>] [[-url] <String>]
[[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -36,14 +36,15 @@ Set-SnipeitStatus -id 3 -name 'Waiting for arrival' -type pending
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 10
Default value: None
Accept pipeline input: False
@ -172,14 +173,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 9
Default value: None
Accept pipeline input: False

14
docs/Set-SnipeitSupplier.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -16,7 +16,7 @@ Modify the supplier
Set-SnipeitSupplier [-name] <String> [[-address] <String>] [[-address2] <String>] [[-city] <String>]
[[-state] <String>] [[-country] <String>] [[-zip] <String>] [[-phone] <String>] [[-fax] <String>]
[[-email] <String>] [[-contact] <String>] [[-notes] <String>] [[-image] <String>] [-image_delete]
[[-RequestType] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-RequestType] <String>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -62,14 +62,15 @@ Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
Users API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 16
Default value: None
Accept pipeline input: False
@ -258,14 +259,15 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 15
Default value: None
Accept pipeline input: False

18
docs/Set-SnipeitUser.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---
@ -13,11 +13,11 @@ Creates a new user
## SYNTAX
```
Set-SnipeitUser [-id] <Int32[]> [[-first_name] <String>] [[-last_name] <String>] [[-userName] <String>]
Set-SnipeitUser [-id] <Int32[]> [[-first_name] <String>] [[-last_name] <String>] [[-username] <String>]
[[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>] [[-password] <String>] [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>] [[-employee_num] <String>]
[[-activated] <Boolean>] [[-notes] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
[[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -49,14 +49,15 @@ Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 19
Default value: None
Accept pipeline input: False
@ -305,21 +306,22 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeitInfo command
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -userName
### -username
Username for user
```yaml

12
docs/SnipeitPS.md
View file

@ -1,16 +1,19 @@
---
Module Name: SnipeitPS
Module Name: snipeitps
Module Guid: f86f4db4-1cb1-45c4-b7bf-6762531bfdeb
Download Help Link: {{ Update Download Link }}
Help Version: {{ Please enter version of help manually (X.X.X.X) format }}
Locale: en-US
---
# SnipeitPS Module
# snipeitps Module
## Description
{{ Fill in the Description }}
## SnipeitPS Cmdlets
## snipeitps Cmdlets
### [Connect-SnipeitPS](Connect-SnipeitPS.md)
Sets authetication information
### [Get-SnipeitAccessory](Get-SnipeitAccessory.md)
Gets a list of Snipe-it Accessories
@ -192,7 +195,8 @@ Add a new Custom Field to Snipe-it asset system
Updates a department
### [Set-SnipeitInfo](Set-SnipeitInfo.md)
Sets authetication information
Sets authetication information.
Deprecated, use Connect-SnipeitPS instead.
### [Set-SnipeitLicense](Set-SnipeitLicense.md)
Updates a licence

2
docs/Update-SnipeitAlias.md
View file

@ -1,6 +1,6 @@
---
external help file: SnipeitPS-help.xml
Module Name: SnipeitPS
Module Name: snipeitps
online version:
schema: 2.0.0
---