Updated docs and examples

This commit is contained in:
Petri Asikainen 2021-05-23 23:22:23 +03:00
parent ee0d285ab0
commit 7d95d5078f
80 changed files with 3144 additions and 2438 deletions

View file

@ -27,10 +27,10 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Accessory -search Keyboard
Get-SnipeItAccessory -search Keyboard
.EXAMPLE
Get-Accessory -id 1
Get-SnipeItAccessory -id 1
#>

View file

@ -60,16 +60,16 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Asset -url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -url "https://assets.example.com"-token "token..."
.EXAMPLE
Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -search "myMachine"-url "https://assets.example.com"-token "token..."
.EXAMPLE
Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -search "myMachine"-url "https://assets.example.com"-token "token..."
.EXAMPLE
Get-Asset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
#>
function Get-SnipeItAsset() {

View file

@ -30,13 +30,13 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-AssetMaintenances -url "https://assets.example.com" -token "token..."
Get-SnipeItAssetMaintenances -url "https://assets.example.com" -token "token..."
.EXAMPLE
Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
.EXAMPLE
Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
#>
function Get-SnipeItAssetMaintenance() {
Param(

View file

@ -24,10 +24,10 @@ Url of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Category -id 1
Get-SnipeItCategory -id 1
.EXAMPLE
Get-Category -search "Laptop"
Get-SnipeItCategory -search "Laptop"
#>

View file

@ -23,11 +23,11 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Company
Get-SnipeItCompany
Gets all companies
.EXAMPLE
Get-Company -id 1
Get-SnipeItCompany -id 1
Gets specific company
#>

View file

@ -24,15 +24,15 @@ URL of Snipeit system,can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Component
Get-SnipeItComponent
Returns all components
.EXAMPLE
Get-Component -search display
Get-SnipeItComponent -search display
Returns search results containeing string display
.EXAMPLE
Get-Component -id
Get-SnipeItComponent -id
Returns specific component
#>

View file

@ -12,7 +12,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Field -url "https://assets.example.com" -token "token..."
Get-SnipeItCustomField -url "https://assets.example.com" -token "token..."
#>

View file

@ -24,13 +24,13 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Department -url "https://assets.example.com" -token "token..."
Get-SnipeItDepartment -url "https://assets.example.com" -token "token..."
.EXAMPLE
Get-Department -search Department1
Get-SnipeItDepartment -search Department1
.EXAMPLE
Get-Department -id 1
Get-SnipeItDepartment -id 1
#>

View file

@ -12,10 +12,10 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Fieldset -url "https://assets.example.com" -token "token..."
Get-SnipeItFieldset -url "https://assets.example.com" -token "token..."
.EXAMPLE
Get-Fieldset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Windows" }
Get-SnipeItFieldset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Windows" }
#>

View file

@ -25,10 +25,10 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-License -search SomeLicense
Get-SnipeItLicense -search SomeLicense
.EXAMPLE
Get-License -id 1
Get-SnipeItLicense -id 1
#>

View file

@ -24,10 +24,10 @@ URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Location -search Location1
Get-SnipeItLocation -search Location1
.EXAMPLE
Get-Location -id 3
Get-SnipeItLocation -id 3
#>

View file

@ -24,11 +24,11 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Manufacturer -search HP
Get-SnipeItManufacturer -search HP
Search all manufacturers for string HP
.EXAMPLE
Get-Manufacturer -id 3
Get-SnipeItManufacturer -id 3
Returns manufacturer with id 3
#>

View file

@ -24,10 +24,10 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Model -search "DL380"
Get-SnipeItModel -search "DL380"
.EXAMPLE
Get-Model -id 1
Get-SnipeItModel -id 1
#>

View file

@ -24,10 +24,10 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Status -search "Ready to Deploy"
Get-SnipeItStatus -search "Ready to Deploy"
.EXAMPLE
Get-Status -id 3
Get-SnipeItStatus -id 3
#>

View file

@ -24,10 +24,10 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-Supplier -search MySupplier
Get-SnipeItSupplier -search MySupplier
.EXAMPLE
Get-Supplier -id 2
Get-SnipeItSupplier -id 2
#>

View file

@ -30,16 +30,16 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Get-User -search SomeSurname
Get-SnipeItUser -search SomeSurname
.EXAMPLE
Get-User -id 3
Get-SnipeItUser -id 3
.EXAMPLE
Get-User -username someuser
Get-SnipeItUser -username someuser
.EXAMPLE
Get-User -email user@somedomain.com
Get-SnipeItUser -email user@somedomain.com
#>
function Get-SnipeItUser() {

View file

@ -54,7 +54,7 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Accessory -name "Accessory" -qty 3 -category_id 1
New-SnipeItAccessory -name "Accessory" -qty 3 -category_id 1
#>
function New-SnipeItAccessory() {

View file

@ -53,15 +53,15 @@ Hastable of custom fields and extra fields that need passing through to Snipeit.
Use internal field names from snipeit .You can use Get-CustomField to get internal field names.
.EXAMPLE
New-Asset -status_id 1 -model_id 1 -name "Machine1"
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1"
Create asset with automatic tag if tag genaration is enabled on snipe-it, other wise without tag
.EXAMPLE
New-Asset -status_id 1 -model_id 1 -name "Machine1" -asset_tag "DEV123"
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1" -asset_tag "DEV123"
Specifying asset tag when creating asset
.EXAMPLE
New-Asset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5" = "Windows 10 Pro" }
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5" = "Windows 10 Pro" }
Using customfields when creating asset.
#>

View file

@ -37,7 +37,7 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-AssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
New-SnipeItAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
#>
function New-SnipeItAssetMaintenance() {
[CmdletBinding(

View file

@ -12,7 +12,7 @@ The asset tag of the asset you wish to audit
ID of the location you want to associate with the audit
.EXAMPLE
New-Audit -tag 1 -location_id 1
New-SnipeItAudit -tag 1 -location_id 1
#>

View file

@ -24,7 +24,7 @@ If switch is present, require users to confirm acceptance of assets in this cate
If switch is present, send email to user on checkin/checkout
.EXAMPLE
New-Category -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
New-SnipeItCategory -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
#>
function New-SnipeItCategory()

View file

@ -15,7 +15,7 @@ URL of Snipeit system, can be set using Set-SnipeItInfo command
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Company -name "Acme Company"
New-SnipeItCompany -name "Acme Company"
#>

View file

@ -15,7 +15,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Field -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
New-SnipeItCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
#>
function New-SnipeItCustomField()

View file

@ -24,7 +24,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Department -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
New-SnipeItDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
#>

View file

@ -63,7 +63,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Licence -name "License" -seats 3 -company_id 1
New-SnipeItLicence -name "License" -seats 3 -company_id 1
#>

View file

@ -42,7 +42,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Location -name "Room 1" -address "123 Asset Street" -parent_id 14
New-SnipeItLocation -name "Room 1" -address "123 Asset Street" -parent_id 14
#>
function New-SnipeItLocation() {

View file

@ -15,7 +15,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Manufacturer -name "HP"
New-SnipeItManufacturer -name "HP"
#>
function New-SnipeItManufacturer()

View file

@ -27,7 +27,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
#>
function New-SnipeItModel()

View file

@ -54,7 +54,7 @@
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-user -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
New-SnipeItuser -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
Creates new a new user who can't login to system
.NOTES

View file

@ -12,7 +12,7 @@
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-Asset -ID 44 -Verbose
Remove-SnipeItAsset -ID 44 -Verbose
#>
function Remove-SnipeItAsset ()

View file

@ -13,7 +13,7 @@ function Remove-SnipeItAssetMaintenance {
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-AssetMaintenance -ID 44 -url $url -apiKey $secret -Verbose
Remove-SnipeItAssetMaintenance -ID 44 -url $url -apiKey $secret -Verbose
#>
[CmdletBinding(
SupportsShouldProcess = $true,

View file

@ -13,7 +13,7 @@
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
Remove-SnipeItUser -ID 44 -url $url -apiKey $secret -Verbose
#>
function Remove-SnipeItUser ()

View file

@ -23,7 +23,7 @@
User's API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command
.EXAMPLE
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
Remove-SnipeItUser -ID 44 -url $url -apiKey $secret -Verbose
#>
function Reset-SnipeItAssetOwner() {
[CmdletBinding(

View file

@ -54,7 +54,7 @@ URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command
.EXAMPLE
Set-Accessory -id 1 -qty 3
Set-SnipeItAccessory -id 1 -qty 3
#>
function Set-SnipeItAccessory() {

View file

@ -60,10 +60,10 @@
Hastable of custom fields and extra fields that need passing through to Snipeit
.EXAMPLE
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1"
Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1"
.EXAMPLE
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
#>
function Set-SnipeItAsset()

View file

@ -31,7 +31,7 @@
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
Set-SnipeItAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing check out to user"
#>
function Set-SnipeItAssetOwner()
{

View file

@ -66,7 +66,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Set-Licence -name "License" -seats 3 -company_id 1
Set-SnipeItLicence -name "License" -seats 3 -company_id 1
#>

View file

@ -30,7 +30,7 @@
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
#>
function Set-SnipeItModel() {

View file

@ -54,7 +54,7 @@
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
.EXAMPLE
Update-user -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
Update-SnipeItUser -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
Updates user with id 3
.NOTES

View file

@ -25,46 +25,46 @@ Gets a list of Snipe-it Accessories
### EXAMPLE 1
```
Get-Accessory -search Keyboard
Get-SnipeItAccessory -search Keyboard
```
### EXAMPLE 2
```
Get-Accessory -id 1
Get-SnipeItAccessory -id 1
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the Accessory data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
@ -80,8 +80,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
@ -89,12 +89,57 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
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: 6
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: 7
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -112,21 +157,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Result offset to use
@ -142,68 +172,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Accessory data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -217,6 +202,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
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).

View file

@ -27,51 +27,66 @@ Get-SnipeItAsset [[-search] <String>] [[-id] <Int32>] [[-asset_tag] <String>] [[
### EXAMPLE 1
```
Get-Asset -url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -url "https://assets.example.com"-token "token..."
```
### EXAMPLE 2
```
Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -search "myMachine"-url "https://assets.example.com"-token "token..."
```
### EXAMPLE 3
```
Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -search "myMachine"-url "https://assets.example.com"-token "token..."
```
### EXAMPLE 4
```
Get-Asset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
Get-SnipeItAsset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the assets data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 20
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of excact snipeit asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_tag
Exact asset tag to query
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -92,23 +107,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_tag
Exact asset tag to query
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
Optionally restrict asset results to this category ID
### -order_number
Optionally restrict asset results to this order number
```yaml
Type: Int32
@ -116,99 +116,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optionally restrict asset results to this company ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -depreciation_id
{{ Fill depreciation_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of excact snipeit asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Optionally restrict asset results to this location ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Optionally restrict asset results to this manufacturer ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -229,8 +137,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
### -category_id
Optionally restrict asset results to this category ID
```yaml
Type: Int32
@ -238,29 +146,14 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optionally restrict asset results to this order number
### -manufacturer_id
Optionally restrict asset results to this manufacturer ID
```yaml
Type: Int32
@ -268,7 +161,52 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optionally restrict asset results to this company ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
Optionally restrict asset results to this location ID
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -depreciation_id
{{ Fill depreciation_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -289,36 +227,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the assets data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -status
Optionally restrict asset results to one of these status types: RTD, Deployed, Undeployable, Deleted, Archived, Requestable
@ -349,8 +257,85 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -364,6 +349,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 20
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).

View file

@ -24,46 +24,31 @@ Get-SnipeItAssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort]
### EXAMPLE 1
```
Get-AssetMaintenances -url "https://assets.example.com" -token "token..."
Get-SnipeItAssetMaintenances -url "https://assets.example.com" -token "token..."
```
### EXAMPLE 2
```
Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
```
### EXAMPLE 3
```
Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
Search string
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -84,6 +69,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -101,6 +116,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -116,53 +146,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
Specify the order (asc or desc) you wish to order by on your sort column
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
Search string
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
Specify the column name you wish to sort by
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -176,6 +161,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
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).

View file

@ -24,41 +24,26 @@ Get-SnipeItCategory [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-
### EXAMPLE 1
```
Get-Category -id 1
Get-SnipeItCategory -id 1
```
### EXAMPLE 2
```
Get-Category -search "Laptop"
Get-SnipeItCategory -search "Laptop"
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the Categories data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -79,6 +64,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,38 +111,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Categories data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
Url of Snipeit system, can be set using Set-Info command
Url of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -156,6 +141,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

View file

@ -24,45 +24,30 @@ Get-SnipeItCompany [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-l
### EXAMPLE 1
```
Get-Company
Get-SnipeItCompany
```
Gets all companies
### EXAMPLE 2
```
Get-Company -id 1
Get-SnipeItCompany -id 1
```
Gets specific company
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the Companies data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -83,6 +68,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -115,38 +115,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Companies data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -160,6 +145,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

View file

@ -25,57 +25,57 @@ Get-SnipeItComponent [[-search] <String>] [[-id] <Int32>] [[-category_id] <Int32
### EXAMPLE 1
```
Get-Component
Get-SnipeItComponent
```
Returns all components
### EXAMPLE 2
```
Get-Component -search display
Get-SnipeItComponent -search display
```
Returns search results containeing string display
### EXAMPLE 3
```
Get-Component -id
Get-SnipeItComponent -id
```
Returns specific component
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the Components data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Component
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
@ -106,8 +106,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific Component
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
@ -115,12 +115,42 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -138,21 +168,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -168,53 +183,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Components data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: Created_at
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system,can be set using Set-Info command
URL of Snipeit system,can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -228,6 +213,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
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).

View file

@ -23,26 +23,11 @@ Get-SnipeItCustomField [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<Comm
### EXAMPLE 1
```
Get-Field -url "https://assets.example.com" -token "token..."
Get-SnipeItCustomField -url "https://assets.example.com" -token "token..."
```
## PARAMETERS
### -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
```
### -id
A id of specific field
@ -59,7 +44,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -73,6 +58,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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).

View file

@ -24,46 +24,31 @@ Get-SnipeItDepartment [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [
### EXAMPLE 1
```
Get-Department -url "https://assets.example.com" -token "token..."
Get-SnipeItDepartment -url "https://assets.example.com" -token "token..."
```
### EXAMPLE 2
```
Get-Department -search Department1
Get-SnipeItDepartment -search Department1
```
### EXAMPLE 3
```
Get-Department -id 1
Get-SnipeItDepartment -id 1
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the Departments data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -84,6 +69,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -116,32 +116,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Departments data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -162,7 +147,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -176,6 +161,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
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).

View file

@ -23,31 +23,16 @@ Get-SnipeItFieldset [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonP
### EXAMPLE 1
```
Get-Fieldset -url "https://assets.example.com" -token "token..."
Get-SnipeItFieldset -url "https://assets.example.com" -token "token..."
```
### EXAMPLE 2
```
Get-Fieldset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Windows" }
Get-SnipeItFieldset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Windows" }
```
## PARAMETERS
### -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
```
### -id
A id of specific fieldset
@ -64,7 +49,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -78,6 +63,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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).

351
docs/Get-SnipeItLicense.md Normal file
View file

@ -0,0 +1,351 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-SnipeItLicense
## SYNOPSIS
Gets a list of Snipe-it Licenses
## SYNTAX
```
Get-SnipeItLicense [[-search] <String>] [[-id] <Int32>] [[-name] <String>] [[-company_id] <Int32>]
[[-product_key] <String>] [[-order_number] <Int32>] [[-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>]
```
## DESCRIPTION
{{ Fill in the Description }}
## EXAMPLES
### EXAMPLE 1
```
Get-SnipeItLicense -search SomeLicense
```
### EXAMPLE 2
```
Get-SnipeItLicense -id 1
```
## PARAMETERS
### -search
A text string to search the Licenses data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific License
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
{{ Fill name Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -product_key
{{ Fill product_key Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
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: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_order
{{ Fill purchase_order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_name
{{ Fill license_name Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_email
{{ Fill license_email Description }}
```yaml
Type: MailAddress
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
{{ Fill manufacturer_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -depreciation_id
{{ Fill depreciation_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
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: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -sort
{{ Fill sort Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 19
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

@ -0,0 +1,148 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Get-SnipeItLicenseSeat
## SYNOPSIS
Gets a list of Snipe-it Licenses Seats or specific Seat
## SYNTAX
```
Get-SnipeItLicenseSeat [-id] <Int32> [[-seat_id] <Int32>] [[-limit] <Int32>] [[-offset] <Int32>] [-all]
[-url] <String> [-apiKey] <String> [<CommonParameters>]
```
## DESCRIPTION
{{ Fill in the Description }}
## EXAMPLES
### EXAMPLE 1
```
Get-SnipeItLicenseSeat -id 1
```
## PARAMETERS
### -id
A id of specific License
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -seat_id
A id of specific seat
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
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,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -24,45 +24,30 @@ Get-SnipeItManufacturer [[-search] <String>] [[-id] <Int32>] [[-order] <String>]
### EXAMPLE 1
```
Get-Manufacturer -search HP
Get-SnipeItManufacturer -search HP
```
Search all manufacturers for string HP
### EXAMPLE 2
```
Get-Manufacturer -id 3
Get-SnipeItManufacturer -id 3
```
Returns manufacturer with id 3
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -search
A text string to search the Manufactures data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -83,6 +68,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -115,32 +115,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Manufactures data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -160,6 +145,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

View file

@ -24,41 +24,26 @@ Get-SnipeItModel [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-lim
### EXAMPLE 1
```
Get-Model -search "DL380"
Get-SnipeItModel -search "DL380"
```
### EXAMPLE 2
```
Get-Model -id 1
Get-SnipeItModel -id 1
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the Models data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -79,6 +64,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,38 +111,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Models data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -156,6 +141,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

View file

@ -24,41 +24,26 @@ Get-SnipeItStatus [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-li
### EXAMPLE 1
```
Get-Status -search "Ready to Deploy"
Get-SnipeItStatus -search "Ready to Deploy"
```
### EXAMPLE 2
```
Get-Status -id 3
Get-SnipeItStatus -id 3
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -search
A text string to search the Status Labels data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -79,6 +64,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,38 +111,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Status Labels data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -156,6 +141,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -24,41 +24,26 @@ Get-SnipeItSupplier [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-
### EXAMPLE 1
```
Get-Supplier -search MySupplier
Get-SnipeItSupplier -search MySupplier
```
### EXAMPLE 2
```
Get-Supplier -id 2
Get-SnipeItSupplier -id 2
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -search
A text string to search the Supliers data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -79,6 +64,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,32 +111,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Supliers data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -156,6 +141,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -26,51 +26,51 @@ Get-SnipeItUser [[-search] <String>] [[-id] <String>] [[-company_id] <Int32>] [[
### EXAMPLE 1
```
Get-User -search SomeSurname
Get-SnipeItUser -search SomeSurname
```
### EXAMPLE 2
```
Get-User -id 3
Get-SnipeItUser -id 3
```
### EXAMPLE 3
```
Get-User -username someuser
Get-SnipeItUser -username someuser
```
### EXAMPLE 4
```
Get-User -email user@somedomain.com
Get-SnipeItUser -email user@somedomain.com
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -search
A text string to search the User data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 13
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific User
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -91,8 +91,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
{{ Fill department_id Description }}
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
@ -100,27 +100,12 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
Search string for email field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -group_id
{{ Fill group_id Description }}
@ -136,8 +121,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
A id of specific User
### -department_id
{{ Fill department_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -username
Search string for username field
```yaml
Type: String
@ -145,12 +145,42 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
Search string for email field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -168,21 +198,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
{{ Fill location_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
@ -198,32 +213,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the User data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -243,16 +243,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -username
Search string for username field
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Required: True
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -24,41 +24,26 @@ Get-SnipeitLocation [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-
### EXAMPLE 1
```
Get-Location -search Location1
Get-SnipeItLocation -search Location1
```
### EXAMPLE 2
```
Get-Location -id 3
Get-SnipeItLocation -id 3
```
## PARAMETERS
### -all
A return all results, works with -offset and other parameters
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -search
A text string to search the Locations data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -79,6 +64,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -limit
Specify the number of results you wish to return.
Defaults to 50.
@ -111,32 +111,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -order
{{ Fill order Description }}
### -all
A return all results, works with -offset and other parameters
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
```
### -search
A text string to search the Locations data
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -156,6 +141,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

View file

@ -27,88 +27,42 @@ Long description
### EXAMPLE 1
```
New-Asset -status_id 1 -model_id 1 -name "Machine1"
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1"
```
Create asset with automatic tag if tag genaration is enabled on snipe-it, other wise without tag
### EXAMPLE 2
```
New-Asset -status_id 1 -model_id 1 -name "Machine1" -asset_tag "DEV123"
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1" -asset_tag "DEV123"
```
Specifying asset tag when creating asset
### EXAMPLE 3
```
New-Asset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5" = "Windows 10 Pro" }
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5" = "Windows 10 Pro" }
```
Using customfields when creating asset.
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_tag
Asset Tag for the Asset, not required when snipe asset_tag autogeneration is on.
```yaml
Type: String
Parameter Sets: (All)
Aliases: tag
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optional Company id
### -status_id
Required Status ID of the asset, this can be got using Get-Status
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit.
Use internal field names from snipeit .You can use Get-CustomField to get internal field names.
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_id
Required Model ID of the asset, this can be got using Get-Model
@ -139,8 +93,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Optional Notes
### -asset_tag
Asset Tag for the Asset, not required when snipe asset_tag autogeneration is on.
```yaml
Type: String
Parameter Sets: (All)
Aliases: tag
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Optional Serial number of the Asset
```yaml
Type: String
@ -148,12 +117,27 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
Optional Company id
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Optional Order number
@ -169,6 +153,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Optional Notes
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -warranty_months
{{ Fill warranty_months Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Optional Purchase cost of the Asset
@ -199,51 +213,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -rtd_location_id
Optional Default location id for the asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Optional Serial number of the Asset
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -status_id
Required Status ID of the asset, this can be got using Get-Status
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
{{ Fill supplier_id Description }}
@ -259,8 +228,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -rtd_location_id
Optional Default location id for the asset
```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
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -274,31 +258,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -warranty_months
{{ Fill warranty_months Description }}
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Required: True
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit.
Use internal field names from snipeit .You can use Get-CustomField to get internal field names.
```yaml
Type: SwitchParameter
Type: Hashtable
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -320,6 +305,21 @@ 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).

View file

@ -26,26 +26,11 @@ Long description
### EXAMPLE 1
```
New-AssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
New-SnipeItAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_id
Required ID of the asset, this can be got using Get-Asset
@ -61,6 +46,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
Required maintenance supplier
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_maintenance_type
{{ Fill asset_maintenance_type Description }}
@ -76,61 +76,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -completion_date
{{ Fill completion_date Description }}
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -cost
Optional cost
```yaml
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -is_warranty
Optional Maintenance done under warranty
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
Optional cost
### -title
Required Title of maintenance
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -151,38 +106,68 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -supplier_id
Required maintenance supplier
### -completion_date
{{ Fill completion_date Description }}
```yaml
Type: Int32
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -is_warranty
Optional Maintenance done under warranty
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -cost
Optional cost
```yaml
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -title
Required Title of maintenance
### -notes
Optional cost
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -196,16 +181,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -227,6 +212,21 @@ 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).

View file

@ -24,13 +24,13 @@ New-SnipeItCategory [-name] <String> [-category_type] <String> [-url] <String> [
### EXAMPLE 1
```
New-Category -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
New-SnipeItCategory -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-Info command
### -name
Name of new category to be created
```yaml
Type: String
@ -38,7 +38,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -59,53 +59,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -checkin_email
If switch is present, send email to user on checkin/checkout
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of new category to be created
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -require_acceptance
If switch is present, require users to confirm acceptance of assets in this category
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -119,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -use_default_eula
If switch is present, use the primary default EULA
@ -134,17 +104,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -require_acceptance
If switch is present, require users to confirm acceptance of assets in this category
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkin_email
If switch is present, send email to user on checkin/checkout
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -165,6 +150,21 @@ 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).

View file

@ -30,8 +30,8 @@ An example
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-Info command
### -name
Component name
```yaml
Type: String
@ -39,7 +39,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -60,6 +60,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
@ -90,16 +105,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Component name
### -purchase_date
Date accessory was purchased
```yaml
Type: String
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -120,38 +135,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -165,16 +150,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -196,6 +181,21 @@ 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).

View file

@ -25,13 +25,13 @@ Add a new Custom Field to Snipe-it asset system
### EXAMPLE 1
```
New-Field -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
New-SnipeItCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -Name
Name of the Custom Field
```yaml
Type: String
@ -39,14 +39,14 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -CustomFormat
{{ Fill CustomFormat Description }}
### -HelpText
{{ Fill HelpText Description }}
```yaml
Type: String
@ -54,7 +54,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -75,21 +75,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -field_encrypted
{{ Fill field_encrypted Description }}
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -Format
{{ Fill Format Description }}
@ -105,8 +90,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -HelpText
{{ Fill HelpText Description }}
### -field_encrypted
{{ Fill field_encrypted Description }}
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -CustomFormat
{{ Fill CustomFormat Description }}
```yaml
Type: String
@ -114,29 +114,14 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Name of the Custom Field
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
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
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -150,16 +135,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -181,6 +166,21 @@ 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).

View file

@ -24,13 +24,13 @@ Creates a new department on Snipe-It system
### EXAMPLE 1
```
New-Department -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
New-SnipeItDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -name
Department Name
```yaml
Type: String
@ -38,7 +38,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -89,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Department Name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
{{ Fill notes Description }}
@ -120,7 +105,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -134,16 +119,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -165,6 +150,21 @@ 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).

View file

@ -28,13 +28,13 @@ Creates a new licence on Snipe-It system
### EXAMPLE 1
```
New-Licence -name "License" -seats 3 -company_id 1
New-SnipeItLicence -name "License" -seats 3 -company_id 1
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -name
Name of license being created
```yaml
Type: String
@ -42,12 +42,27 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 19
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
{{ Fill category_id Description }}
@ -153,21 +168,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of license being created
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
License Notes
@ -243,21 +243,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Serialnumber of license
@ -304,7 +289,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -318,16 +303,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -349,6 +334,21 @@ 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).

View file

@ -25,11 +25,26 @@ Long description
### EXAMPLE 1
```
New-Location -name "Room 1" -address "123 Asset Street" -parent_id 14
New-SnipeItLocation -name "Room 1" -address "123 Asset Street" -parent_id 14
```
## PARAMETERS
### -name
Name of the Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address
Address line 1 of the location
@ -60,16 +75,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -state
Address State of the location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -90,8 +105,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_ou
The LDAP OU of the location
### -zip
The zip code of the location
```yaml
Type: String
@ -99,37 +114,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
The manager ID of the location
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of the Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -150,8 +135,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -state
Address State of the location
### -manager_id
The manager ID of the location
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_ou
The LDAP OU of the location
```yaml
Type: String
@ -159,14 +159,14 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -180,31 +180,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
The zip code of the location
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
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
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -226,6 +211,21 @@ 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).

View file

@ -24,26 +24,11 @@ Long description
### EXAMPLE 1
```
New-Manufacturer -name "HP"
New-SnipeItManufacturer -name "HP"
```
## PARAMETERS
### -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
```
### -Name
Name of the Manufacturer
@ -60,7 +45,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -74,16 +59,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -105,6 +90,21 @@ 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).

View file

@ -25,13 +25,13 @@ Long description
### EXAMPLE 1
```
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
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-Info command
### -name
Name of the Asset Model
```yaml
Type: String
@ -39,7 +39,22 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -60,6 +75,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -eol
{{ Fill eol Description }}
@ -90,53 +120,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -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
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -150,16 +135,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -181,6 +166,21 @@ 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).

View file

@ -27,103 +27,13 @@ Creates a new user to Snipe-IT system
### EXAMPLE 1
```
New-user -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
New-SnipeItuser -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
```
Creates new a new user who can't login to system
## PARAMETERS
### -activated
{{ Fill activated Description }}
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
ID number of company users belogs to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
ID number of department
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
email address
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Employeenumber
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -first_name
Users first name
@ -139,21 +49,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_name
Users last name
@ -169,61 +64,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_import
Mark user as import from ldap
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
User Notes
### -username
Username for user
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -244,6 +94,66 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -activated
{{ Fill activated Description }}
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
User Notes
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
email address
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -phone
Phone number
@ -259,8 +169,98 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
ID number of company users belogs to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
ID number of department
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Employeenumber
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_import
Mark user as import from ldap
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -274,8 +274,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -username
Username for user
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -283,22 +283,7 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -320,6 +305,21 @@ 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).

View file

@ -8,7 +8,7 @@ schema: 2.0.0
# Remove-SnipeItAsset
## SYNOPSIS
Removes Asset to Snipe-it asset system
Removes Asset from Snipe-it asset system
## SYNTAX
@ -17,32 +17,17 @@ Remove-SnipeItAsset [-ID] <Int32> [-URL] <String> [-APIKey] <String> [-WhatIf] [
```
## DESCRIPTION
Long description
Removes Asset from Snipe-it asset system
## EXAMPLES
### EXAMPLE 1
```
Remove-Asset -ID 44 -Verbose
Remove-SnipeItAsset -ID 44 -Verbose
```
## PARAMETERS
### -APIKey
User's 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
```
### -ID
Unique ID For Asset to be removed
@ -59,7 +44,7 @@ Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -73,16 +58,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -104,6 +89,21 @@ 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).

View file

@ -23,26 +23,11 @@ Long description
### EXAMPLE 1
```
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
Remove-SnipeItUser -ID 44 -url $url -apiKey $secret -Verbose
```
## PARAMETERS
### -APIKey
User's 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
```
### -ID
Unique ID For User to be removed
@ -59,7 +44,7 @@ Accept wildcard characters: False
```
### -URL
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -73,16 +58,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -APIKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -104,6 +89,21 @@ 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).

View file

@ -26,26 +26,56 @@ Updates accessory on Snipe-It system
### EXAMPLE 1
```
Set-Accessory -id 1 -qty 3
Set-SnipeItAccessory -id 1 -qty 3
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
ID number of Accessory on Snipe-It system
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 13
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the accessory you have
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -category_id
ID number of the category the accessory belongs to
@ -76,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
ID number of the manufacturer for this accessory.
@ -106,36 +121,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -min_qty
Min quantity of the accessory before alert is triggered
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
ID number of Accessory on Snipe-It system
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -order_number
Order number for this accessory.
@ -181,17 +166,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the accessory you have
### -min_qty
Min quantity of the accessory before alert is triggered
```yaml
Type: Int32
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
@ -212,7 +197,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
```yaml
Type: String
@ -226,16 +211,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -257,6 +242,21 @@ 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).

View file

@ -27,43 +27,87 @@ Long description
### EXAMPLE 1
```
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1"
Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1"
```
### EXAMPLE 2
```
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -id
ID of the Asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Asset name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 17
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -archived
Whether or not the asset is archived.
Archived assets cannot be checked out and do not show up in the deployable asset screens
### -Status_id
Status ID of the asset, this can be got using Get-Status
```yaml
Type: Boolean
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Model_id
Model ID of the asset, this can be got using Get-Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_checkout
Date the asset was last checked out
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
@ -98,53 +142,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID of the Asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -last_checkout
Date the asset was last checked out
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Model_id
Model ID of the asset, this can be got using Get-Model
### -serial
Serial number of the asset
```yaml
Type: String
@ -152,22 +151,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Asset name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -188,6 +172,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -warranty_months
Number of months for the asset warranty
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Purchase cost of the asset, without a currency symbol
@ -233,6 +232,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -archived
Whether or not the asset is archived.
Archived assets cannot be checked out and do not show up in the deployable asset screens
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -rtd_location_id
The id that corresponds to the location where the asset is usually located when not checked out
@ -248,38 +263,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Serial number of the asset
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Status_id
Status ID of the asset, this can be got using Get-Status
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
```yaml
Type: String
@ -293,31 +278,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -warranty_months
Number of months for the asset warranty
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command
```yaml
Type: Int32
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Required: True
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -customfields
Hastable of custom fields and extra fields that need passing through to Snipeit
```yaml
Type: SwitchParameter
Type: Hashtable
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -339,6 +324,21 @@ 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).

View file

@ -25,22 +25,22 @@ Checkout asset to user/localtion/asset
### EXAMPLE 1
```
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
Set-SnipeItAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing check out to user"
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-Info command
### -id
Unique ID For asset to checkout
```yaml
Type: String
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Default value: None
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
@ -60,21 +60,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -checkout_at
Optional date to override the checkout time of now
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkout_to_type
{{ Fill checkout_to_type Description }}
@ -90,36 +75,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -expected_checkin
Optional date the asset is expected to be checked in
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Unique ID For asset to checkout
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Optional new asset name.
This is useful for changing the asset's name on new checkout,
@ -153,8 +108,38 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -expected_checkin
Optional date the asset is expected to be checked in
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -checkout_at
Optional date to override the checkout time of now
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -168,16 +153,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -199,6 +184,21 @@ 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).

View file

@ -30,36 +30,6 @@ An example
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of name
@ -75,66 +45,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Component name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Cost of item being purchased.
```yaml
Type: Single
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -qty
Quantity of the components you have
@ -150,8 +60,83 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Component name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
{{ Fill company_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of the location the accessory is assigned to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_date
Date accessory was purchased
```yaml
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -purchase_cost
Cost of item being purchased.
```yaml
Type: Single
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -165,16 +150,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -196,6 +181,21 @@ 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).

View file

@ -23,28 +23,13 @@ Set apikey and url user to connect Snipe-It system
### EXAMPLE 1
```
Set-Info -url $url -apiKey -Verbose
Set-SnipeItInfo -url $url -apiKey -Verbose
```
## PARAMETERS
### -apiKey
User's API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: Uri
@ -58,6 +43,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
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).

View file

@ -28,26 +28,56 @@ Updates licence on Snipe-It system
### EXAMPLE 1
```
Set-Licence -name "License" -seats 3 -company_id 1
Set-SnipeItLicence -name "License" -seats 3 -company_id 1
```
## PARAMETERS
### -apiKey
Users API Key for Snipeit, can be set using Set-Info command
### -id
ID number of licence
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of license
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 20
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```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 }}
@ -93,21 +123,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of licence
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -license_email
Email address associated with license
@ -168,21 +183,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of license
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
License Notes
@ -258,21 +258,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -seats
Number of license seats owned.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -serial
Serialnumber of license
@ -319,7 +304,7 @@ Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -333,16 +318,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -364,6 +349,21 @@ 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).

View file

@ -0,0 +1,186 @@
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
schema: 2.0.0
---
# Set-SnipeItLicenseSeat
## SYNOPSIS
Set license seat or checkout license seat
## SYNTAX
```
Set-SnipeItLicenseSeat [-id] <Int32> [-seat_id] <Int32> [[-assigned_id] <Int32>] [[-asset_id] <Int32>]
[[-note] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
Checkout specific license seat to user, asset or both
## EXAMPLES
### EXAMPLE 1
```
Set-SnipeItLicenceSeat -ID 1 -seat_id 1 -assigned_id 3 -Verbose
```
Checkout licence to user id 3
### EXAMPLE 2
```
Set-SnipeItLicenceSeat -ID 1 -seat_id 1 -asset_id 3 -Verbose
```
Checkout licence to asset id 3
## PARAMETERS
### -id
Unique ID For asset to checkout
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -seat_id
{{ Fill seat_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -assigned_id
{{ Fill assigned_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -asset_id
Id of target asset
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -note
Notes about checkout
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
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

@ -25,21 +25,51 @@ Updates Model on Snipe-it asset system
### EXAMPLE 1
```
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
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-Info command
### -id
ID number of the Asset Model
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -60,16 +90,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -custom_fieldset_id
{{ Fill custom_fieldset_id Description }}
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: fieldset_id
Aliases:
Required: False
Position: 7
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
@ -90,68 +120,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
ID number of the Asset Model
### -custom_fieldset_id
{{ Fill custom_fieldset_id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Aliases: fieldset_id
Required: True
Position: 1
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manufacturer_id
Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -model_number
Model number of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of the Asset Model
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -165,16 +150,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -196,6 +181,21 @@ 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).

View file

@ -27,118 +27,13 @@ Creates a new user to Snipe-IT system
### EXAMPLE 1
```
Update-user -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
Update-SnipeItUser -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
```
Updates user with id 3
## PARAMETERS
### -activated
{{ Fill activated Description }}
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
User's API Key for Snipeit, can be set using Set-Info command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
ID number of company users belogs to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
ID number of department
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
email address
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Employeenumber
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -first_name
Users first name
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
@ -154,8 +49,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
### -first_name
Users first name
```yaml
Type: String
@ -163,7 +58,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -184,38 +79,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
User Notes
### -userName
Username for user
```yaml
Type: String
@ -223,7 +88,37 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -jobtitle
Users job tittle
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -email
email address
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -244,8 +139,113 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -company_id
ID number of company users belogs to
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -location_id
ID number of localtion
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -department_id
ID number of department
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -manager_id
ID number of manager
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -employee_num
Employeenumber
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -activated
{{ Fill activated Description }}
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -notes
User Notes
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-Info command
URL of Snipeit system, can be set using Set-SnipeItInfo command
```yaml
Type: String
@ -259,31 +259,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -userName
Username for user
### -apiKey
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
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
Required: True
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -305,6 +290,21 @@ 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).

View file

@ -1,4 +1,4 @@
---
---
external help file: SnipeItPS-help.xml
Module Name: SnipeitPS
online version:
@ -30,6 +30,36 @@ Set-SnipeitLocation -id 123 -name "Some storage" -parent_id 100
## PARAMETERS
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of Location
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -address
Address line 1
@ -60,16 +90,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
### -state
Address State
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 12
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -90,23 +120,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -id
{{ Fill id Description }}
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_ou
LDAP OU of Location
### -zip
Address zipcode
```yaml
Type: String
@ -114,7 +129,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -135,8 +150,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -name
Name of Location
### -ldap_ou
LDAP OU of Location
```yaml
Type: String
@ -144,7 +159,7 @@ Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -165,21 +180,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -state
Address State
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
@ -195,31 +195,16 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -zip
Address zipcode
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
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
Required: True
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@ -241,6 +226,21 @@ 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).

View file

@ -8,105 +8,126 @@ Locale: en-US
# SnipeitPS Module
## Description
Powershell API for SnipeIt Asset Management
{{ Fill in the Description }}
## SnipeitPS Cmdlets
### [Get-SnipeItAccessory](Get-SnipeItAccessory.md)
Gets a list of Snipe-it Accessories
{{ Fill in the Description }}
### [Get-SnipeItAsset](Get-SnipeItAsset.md)
Gets a list of Snipe-it Assets or specific asset
{{ Fill in the Description }}
### [Get-SnipeItAssetMaintenance](Get-SnipeItAssetMaintenance.md)
Lists Snipe-it Assets Maintenances
{{ Fill in the Description }}
### [Get-SnipeItCategory](Get-SnipeItCategory.md)
Gets a list of Snipe-it Categories
{{ Fill in the Description }}
### [Get-SnipeItCompany](Get-SnipeItCompany.md)
Gets a list of Snipe-it Companies
{{ Fill in the Description }}
### [Get-SnipeItComponent](Get-SnipeItComponent.md)
Gets a list of Snipe-it Components
{{ Fill in the Description }}
### [Get-SnipeItCustomField](Get-SnipeItCustomField.md)
Returns specific Snipe-IT custom field or a list of all custom field
{{ Fill in the Description }}
### [Get-SnipeItDepartment](Get-SnipeItDepartment.md)
Gets a list of Snipe-it Departments
{{ Fill in the Description }}
### [Get-SnipeItFieldset](Get-SnipeItFieldset.md)
Returns a fieldset or list of Snipe-it Fieldsets
{{ Fill in the Description }}
### [Get-SnipeItLicense](Get-SnipeItLicense.md)
{{ Fill in the Description }}
### [Get-SnipeItLicenseSeat](Get-SnipeItLicenseSeat.md)
{{ Fill in the Description }}
### [Get-SnipeitLocation](Get-SnipeitLocation.md)
{{ Fill in the Description }}
### [Get-SnipeItManufacturer](Get-SnipeItManufacturer.md)
{{ Fill in the Description }}
### [Get-SnipeItModel](Get-SnipeItModel.md)
Gets a list of Snipe-it Models
{{ Fill in the Description }}
### [Get-SnipeItStatus](Get-SnipeItStatus.md)
Gets a list of Snipe-it Status Labels
{{ Fill in the Description }}
### [Get-SnipeItSupplier](Get-SnipeItSupplier.md)
{{ Fill in the Description }}
### [Get-SnipeItUser](Get-SnipeItUser.md)
{{ Fill in the Description }}
### [New-SnipeItAsset](New-SnipeItAsset.md)
Add a new Asset to Snipe-it asset system
{{ Fill in the Description }}
### [New-SnipeItAssetMaintenance](New-SnipeItAssetMaintenance.md)
Add a new Asset maintenence to Snipe-it asset system
{{ Fill in the Description }}
### [New-SnipeItCategory](New-SnipeItCategory.md)
Create a new Snipe-IT Category
{{ Fill in the Description }}
### [New-SnipeItComponent](New-SnipeItComponent.md)
Create a new component
{{ Fill in the Description }}
### [New-SnipeItCustomField](New-SnipeItCustomField.md)
Add a new Custom Field to Snipe-it asset system
{{ Fill in the Description }}
### [New-SnipeItDepartment](New-SnipeItDepartment.md)
Creates a department
{{ Fill in the Description }}
### [New-SnipeItLicense](New-SnipeItLicense.md)
Creates a licence
{{ Fill in the Description }}
### [New-SnipeItLocation](New-SnipeItLocation.md)
Add a new Location to Snipe-it asset system
{{ Fill in the Description }}
### [New-SnipeItManufacturer](New-SnipeItManufacturer.md)
Add a new Manufacturer to Snipe-it asset system
{{ Fill in the Description }}
### [New-SnipeItModel](New-SnipeItModel.md)
Add a new Model to Snipe-it asset system
{{ Fill in the Description }}
### [New-SnipeItUser](New-SnipeItUser.md)
Creates a new user
{{ Fill in the Description }}
### [Remove-SnipeItAsset](Remove-SnipeItAsset.md)
Removes Asset to Snipe-it asset system
{{ Fill in the Description }}
### [Remove-SnipeItUser](Remove-SnipeItUser.md)
Removes User from Snipe-it asset system
{{ Fill in the Description }}
### [Set-SnipeItAccessory](Set-SnipeItAccessory.md)
Updates accessory on Snipe-It system
{{ Fill in the Description }}
### [Set-SnipeItAsset](Set-SnipeItAsset.md)
Update a specific Asset in the Snipe-it asset system
{{ Fill in the Description }}
### [Set-SnipeItAssetOwner](Set-SnipeItAssetOwner.md)
Checkout asset
{{ Fill in the Description }}
### [Set-SnipeItComponent](Set-SnipeItComponent.md)
Updates component
{{ Fill in the Description }}
### [Set-SnipeItInfo](Set-SnipeItInfo.md)
Sets authetication information
{{ Fill in the Description }}
### [Set-SnipeItLicense](Set-SnipeItLicense.md)
Updates a licence
{{ Fill in the Description }}
### [Set-SnipeItLicenseSeat](Set-SnipeItLicenseSeat.md)
{{ Fill in the Description }}
### [Set-SnipeitLocation](Set-SnipeitLocation.md)
Updates Location in Snipe-it asset system
{{ Fill in the Description }}
### [Set-SnipeItModel](Set-SnipeItModel.md)
Updates Model on Snipe-it asset system
{{ Fill in the Description }}
### [Set-SnipeItUser](Set-SnipeItUser.md)
Creates a new user
{{ Fill in the Description }}