Merge pull request #6 from snazy2000/develop

Develop
This commit is contained in:
Stephen 2018-05-01 08:40:43 +01:00 committed by GitHub
commit e06c6ac57d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 1656 additions and 70 deletions

View file

@ -1,6 +1,45 @@
<#
.SYNOPSIS
# Gets a list of Snipe-it Assets
Gets a list of Snipe-it Assets
.PARAMETER search
A text string to search the assets data
.PARAMETER order_number
Optionally restrict asset results to this order number
.PARAMETER model_id
Optionally restrict asset results to this asset model ID
.PARAMETER category_id
Optionally restrict asset results to this category ID
.PARAMETER manufacturer_id
Optionally restrict asset results to this manufacturer ID
.PARAMETER company_id
Optionally restrict asset results to this company ID
.PARAMETER location_id
Optionally restrict asset results to this location ID
.PARAMETER status
Optionally restrict asset results to one of these status types: RTD, Deployed, Undeployable, Deleted, Archived, Requestable
.PARAMETER status_id
Optionally restrict asset results to this status label ID
.PARAMETER sort
Specify the column name you wish to sort by
.PARAMETER order
Specify the order (asc or desc) you wish to order by on your sort column
.PARAMETER limit
Specify the number of results you wish to return. Defaults to 50.
.PARAMETER offset
Offset to use
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
@ -13,9 +52,7 @@ Get-Asset -url "https://assets.example.com" -token "token..."
.EXAMPLE
Get-Asset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MyMachine" }
#>
function Get-Asset() {
Param(
[string]$search,

View file

@ -44,13 +44,10 @@ function Set-Asset()
[parameter(mandatory = $true)]
[int]$id,
[parameter(mandatory = $true)]
[string]$Name,
[parameter(mandatory = $true)]
[string]$Status_id,
[parameter(mandatory = $true)]
[string]$Model_id,
[parameter(mandatory = $true)]

View file

@ -13,7 +13,10 @@ schema: 2.0.0
## SYNTAX
```
Get-Asset [-url] <String> [-apiKey] <String>
Get-Asset [[-search] <String>] [[-order_number] <Int32>] [[-model_id] <Int32>] [[-category_id] <Int32>]
[[-manufacturer_id] <Int32>] [[-company_id] <Int32>] [[-location_id] <Int32>] [[-status] <String>]
[[-status_id] <Int32>] [[-sort] <String>] [[-order] <String>] [[-limit] <Int32>] [[-offset] <Int32>]
[-url] <String> [-apiKey] <String>
```
## DESCRIPTION
@ -33,6 +36,201 @@ Get-Asset -url "https://assets.example.com" -token "token..." | Where-Object {$_
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
{{Fill order_number Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
{{Fill model_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{Fill category_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{Fill manufacturer_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{Fill company_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{Fill location_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -status
{{Fill status Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -status_id
{{Fill status_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{Fill sort Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{Fill order Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
{{Fill limit Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
{{Fill offset Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -42,7 +240,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -57,7 +255,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

View file

@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-Category [-url] <String> [-apiKey] <String>
Get-Category [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
@ -33,6 +33,21 @@ Get-Category -url "https://assets.example.com" -token "token..." | Where-Object
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -42,7 +57,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -57,7 +72,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

88
docs/Get-Company.md Normal file
View file

@ -0,0 +1,88 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
schema: 2.0.0
---
# Get-Company
## SYNOPSIS
# Gets a list of Snipe-it Companies
## SYNTAX
```
Get-Company [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
Get-Company -url "https://assets.example.com" -token "token..."
```
### -------------------------- EXAMPLE 2 --------------------------
```
Get-Company -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Company1" }
```
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

View file

@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-Component [-url] <String> [-apiKey] <String>
Get-Component [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
@ -33,6 +33,21 @@ Get-Component -url "https://assets.example.com" -token "token..." | Where-Object
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -42,7 +57,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -57,7 +72,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

88
docs/Get-Department.md Normal file
View file

@ -0,0 +1,88 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
schema: 2.0.0
---
# Get-Department
## SYNOPSIS
# Gets a list of Snipe-it Departments
## SYNTAX
```
Get-Department [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
Get-Department -url "https://assets.example.com" -token "token..."
```
### -------------------------- EXAMPLE 2 --------------------------
```
Get-Department -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Department1" }
```
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-Manufacturer [-url] <String> [-apiKey] <String>
Get-Manufacturer [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
@ -33,6 +33,21 @@ Get-Manufacturer -url "https://assets.example.com" -token "token..." | Where-Obj
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -42,7 +57,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -57,7 +72,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-Model [-url] <String> [-apiKey] <String>
Get-Model [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
@ -33,6 +33,21 @@ Get-Models -url "https://assets.example.com" -token "token..." | Where-Object {$
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -42,7 +57,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -57,7 +72,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-Status [-url] <String> [-apiKey] <String>
Get-Status [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
@ -33,6 +33,21 @@ Get-Status -url "https://assets.example.com" -token "token..." | Where-Object {$
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -42,7 +57,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -57,7 +72,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

88
docs/Get-Supplier.md Normal file
View file

@ -0,0 +1,88 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
# Get-Supplier
## SYNOPSIS
# Gets a list of Snipe-it Suppliers
## SYNTAX
```
Get-Supplier [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
Get-Supplier -url "https://assets.example.com" -token "token..."
```
### -------------------------- EXAMPLE 2 --------------------------
```
Get-Supplier -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MySupplier" }
```
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Get-User [-url] <String> [-apiKey] <String>
Get-User [[-search] <String>] [-url] <String> [-apiKey] <String>
```
## DESCRIPTION
@ -33,6 +33,21 @@ Get-User -url "https://assets.example.com" -token "token..." | Where-Object {$_.
## PARAMETERS
### -search
{{Fill search Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
@ -42,7 +57,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -57,7 +72,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,8 +13,8 @@ Add a new Asset to Snipe-it asset system
## SYNTAX
```
New-Asset [[-tag] <String>] [-Name] <String> [-Status_id] <String> [-Model_id] <String> [-url] <String>
[-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm]
New-Asset [[-tag] <String>] [-Name] <String> [-Status_id] <Int32> [-Model_id] <Int32> [-url] <String>
[-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -68,13 +68,13 @@ Accept wildcard characters: False
Status ID of the asset, this can be got using Get-Status
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -83,13 +83,13 @@ Accept wildcard characters: False
Model ID of the asset, this can be got using Get-Model
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -170,6 +170,9 @@ 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

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -14,7 +14,7 @@ Short description
```
New-Component [-name] <String> [-category_id] <String> [-qty] <String> [-url] <String> [-apiKey] <String>
[-WhatIf] [-Confirm]
[-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -135,6 +135,9 @@ 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

164
docs/New-Department.md Normal file
View file

@ -0,0 +1,164 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
# New-Department
## SYNOPSIS
Short description
## SYNTAX
```
New-Department [-name] <String> [[-company_id] <String>] [[-location_id] <String>] [[-manager_id] <String>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Long description
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
An example
```
## PARAMETERS
### -name
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{Fill company_id Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{Fill location_id Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
{{Fill manager_id Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
General notes
## RELATED LINKS

194
docs/New-Location.md Normal file
View file

@ -0,0 +1,194 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
# New-Location
## SYNOPSIS
Add a new Model to Snipe-it asset system
## SYNTAX
```
New-Location [-name] <String> [[-address] <String>] [[-address2] <String>] [[-state] <String>]
[[-country] <String>] [[-zip] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
Long description
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
```
## PARAMETERS
### -name
Name of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address
{{Fill address Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address2
{{Fill address2 Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -state
{{Fill state Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -country
{{Fill country Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
{{Fill zip Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,7 +13,7 @@ Add a new Manufacturer to Snipe-it asset system
## SYNTAX
```
New-Manufacturer [-Name] <String> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
New-Manufacturer [-Name] <String> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -104,6 +104,9 @@ 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

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -14,7 +14,7 @@ Add a new Model to Snipe-it asset system
```
New-Model [-name] <String> [-category_id] <Int32> [-manufacturer_id] <Int32> [-fieldset_id] <Int32>
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -150,6 +150,9 @@ 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

286
docs/New-User.md Normal file
View file

@ -0,0 +1,286 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
# New-User
## SYNOPSIS
Short description
## SYNTAX
```
New-User [-firstName] <String> [-lastName] <String> [-userName] <String> [[-jobTitle] <String>]
[[-email] <String>] [[-phone] <String>] [[-company_id] <Int32>] [[-location_id] <Int32>]
[[-department_id] <Int32>] [[-manager_id] <Int32>] [[-employee_num] <String>] [[-ldap_user] <Boolean>]
[-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Long description
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
An example
```
## PARAMETERS
### -firstName
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -lastName
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -userName
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobTitle
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -phone
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_user
Parameter description
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
General notes
## RELATED LINKS

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -14,7 +14,7 @@ Update a Asset in the Snipe-it asset system
```
Set-Asset [-id] <Int32> [-Name] <String> [-Status_id] <String> [-Model_id] <String> [-url] <String>
[-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm]
[-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -170,6 +170,9 @@ 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

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,7 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Set-AssetOwner [-id] <Int32> [-user_id] <Int32> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
Set-AssetOwner [-id] <Int32> [-assigned_id] <Int32> [[-checkout_to_type] <String>] [-url] <String>
[-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@ -70,7 +71,38 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -assigned_id
{{Fill assigned_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkout_to_type
{{Fill checkout_to_type Description}}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: location, asset, user
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -100,32 +132,19 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -user_id
{{Fill user_id Description}}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
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
### None
## OUTPUTS
### System.Object

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -14,6 +14,7 @@ schema: 2.0.0
```
Set-Component [-id] <String> [-qty] <String> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@ -121,11 +122,13 @@ 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
### None
## OUTPUTS
### System.Object

View file

@ -1,7 +1,7 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version:
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Set-Info [[-url] <Uri>] [[-apiKey] <String>]
Set-Info [[-url] <Uri>] [[-apiKey] <String>] [<CommonParameters>]
```
## DESCRIPTION
@ -60,11 +60,13 @@ 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
### None
## OUTPUTS
### System.Object

317
docs/Set-User.md Normal file
View file

@ -0,0 +1,317 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeItPS
online version: http://go.microsoft.com/fwlink/?LinkId=821589
schema: 2.0.0
---
# Set-User
## SYNOPSIS
Short description
## SYNTAX
```
Set-User [-id] <Int32> [[-first_name] <String>] [[-last_name] <String>] [[-userName] <String>]
[[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>] [[-company_id] <Int32>]
[[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>] [[-employee_num] <String>]
[[-activated] <Boolean>] [[-notes] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
Long description
## EXAMPLES
### -------------------------- EXAMPLE 1 --------------------------
```
An example
```
## PARAMETERS
### -id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -first_name
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_name
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -userName
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -phone
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
Parameter description
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -activated
Parameter description
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Parameter description
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
General notes
## RELATED LINKS