diff --git a/SnipeitPS/Public/Get-SnipeItAccessory.ps1 b/SnipeitPS/Public/Get-SnipeItAccessory.ps1 index e86937b..8ac47b9 100644 --- a/SnipeitPS/Public/Get-SnipeItAccessory.ps1 +++ b/SnipeitPS/Public/Get-SnipeItAccessory.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItAsset.ps1 b/SnipeitPS/Public/Get-SnipeItAsset.ps1 index c85312d..40bf01b 100644 --- a/SnipeitPS/Public/Get-SnipeItAsset.ps1 +++ b/SnipeitPS/Public/Get-SnipeItAsset.ps1 @@ -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() { diff --git a/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 b/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 index 00efc33..602b0c6 100644 --- a/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 +++ b/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 @@ -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( diff --git a/SnipeitPS/Public/Get-SnipeItCategory.ps1 b/SnipeitPS/Public/Get-SnipeItCategory.ps1 index 72d64d8..827feb5 100644 --- a/SnipeitPS/Public/Get-SnipeItCategory.ps1 +++ b/SnipeitPS/Public/Get-SnipeItCategory.ps1 @@ -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" #> diff --git a/SnipeitPS/Public/Get-SnipeItCompany.ps1 b/SnipeitPS/Public/Get-SnipeItCompany.ps1 index d105df8..99748d6 100644 --- a/SnipeitPS/Public/Get-SnipeItCompany.ps1 +++ b/SnipeitPS/Public/Get-SnipeItCompany.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItComponent.ps1 b/SnipeitPS/Public/Get-SnipeItComponent.ps1 index ef680e8..9adb8c1 100644 --- a/SnipeitPS/Public/Get-SnipeItComponent.ps1 +++ b/SnipeitPS/Public/Get-SnipeItComponent.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItCustomField.ps1 b/SnipeitPS/Public/Get-SnipeItCustomField.ps1 index fb4c1d8..276b7bf 100644 --- a/SnipeitPS/Public/Get-SnipeItCustomField.ps1 +++ b/SnipeitPS/Public/Get-SnipeItCustomField.ps1 @@ -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..." #> diff --git a/SnipeitPS/Public/Get-SnipeItDepartment.ps1 b/SnipeitPS/Public/Get-SnipeItDepartment.ps1 index d9a527b..b80ec8a 100644 --- a/SnipeitPS/Public/Get-SnipeItDepartment.ps1 +++ b/SnipeitPS/Public/Get-SnipeItDepartment.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItFieldset.ps1 b/SnipeitPS/Public/Get-SnipeItFieldset.ps1 index fcc37c0..33d0252 100644 --- a/SnipeitPS/Public/Get-SnipeItFieldset.ps1 +++ b/SnipeitPS/Public/Get-SnipeItFieldset.ps1 @@ -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" } #> diff --git a/SnipeitPS/Public/Get-SnipeItLicense.ps1 b/SnipeitPS/Public/Get-SnipeItLicense.ps1 index 08d91a0..bdca13b 100644 --- a/SnipeitPS/Public/Get-SnipeItLicense.ps1 +++ b/SnipeitPS/Public/Get-SnipeItLicense.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItLocation.ps1 b/SnipeitPS/Public/Get-SnipeItLocation.ps1 index b16e9fc..718e251 100644 --- a/SnipeitPS/Public/Get-SnipeItLocation.ps1 +++ b/SnipeitPS/Public/Get-SnipeItLocation.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 b/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 index 10e57fb..36bcb61 100644 --- a/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 +++ b/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItModel.ps1 b/SnipeitPS/Public/Get-SnipeItModel.ps1 index 2ddd9dd..7219657 100644 --- a/SnipeitPS/Public/Get-SnipeItModel.ps1 +++ b/SnipeitPS/Public/Get-SnipeItModel.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItStatus.ps1 b/SnipeitPS/Public/Get-SnipeItStatus.ps1 index e529b01..ebeb50b 100644 --- a/SnipeitPS/Public/Get-SnipeItStatus.ps1 +++ b/SnipeitPS/Public/Get-SnipeItStatus.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItSupplier.ps1 b/SnipeitPS/Public/Get-SnipeItSupplier.ps1 index a6b2ec5..d5c84fe 100644 --- a/SnipeitPS/Public/Get-SnipeItSupplier.ps1 +++ b/SnipeitPS/Public/Get-SnipeItSupplier.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Get-SnipeItUser.ps1 b/SnipeitPS/Public/Get-SnipeItUser.ps1 index 41b12c2..9f02830 100644 --- a/SnipeitPS/Public/Get-SnipeItUser.ps1 +++ b/SnipeitPS/Public/Get-SnipeItUser.ps1 @@ -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() { diff --git a/SnipeitPS/Public/New-SnipeItAccessory.ps1 b/SnipeitPS/Public/New-SnipeItAccessory.ps1 index fea6331..493f628 100644 --- a/SnipeitPS/Public/New-SnipeItAccessory.ps1 +++ b/SnipeitPS/Public/New-SnipeItAccessory.ps1 @@ -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() { diff --git a/SnipeitPS/Public/New-SnipeItAsset.ps1 b/SnipeitPS/Public/New-SnipeItAsset.ps1 index 198d1e1..9db73ec 100644 --- a/SnipeitPS/Public/New-SnipeItAsset.ps1 +++ b/SnipeitPS/Public/New-SnipeItAsset.ps1 @@ -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. #> diff --git a/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 b/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 index 3d53d54..0f37fd2 100644 --- a/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 +++ b/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 @@ -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( diff --git a/SnipeitPS/Public/New-SnipeItAudit.ps1 b/SnipeitPS/Public/New-SnipeItAudit.ps1 index 21dd686..985979e 100644 --- a/SnipeitPS/Public/New-SnipeItAudit.ps1 +++ b/SnipeitPS/Public/New-SnipeItAudit.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/New-SnipeItCategory.ps1 b/SnipeitPS/Public/New-SnipeItCategory.ps1 index d692d39..16a9c75 100644 --- a/SnipeitPS/Public/New-SnipeItCategory.ps1 +++ b/SnipeitPS/Public/New-SnipeItCategory.ps1 @@ -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() diff --git a/SnipeitPS/Public/New-SnipeItCompany.ps1 b/SnipeitPS/Public/New-SnipeItCompany.ps1 index fbfb9f5..c479aeb 100644 --- a/SnipeitPS/Public/New-SnipeItCompany.ps1 +++ b/SnipeitPS/Public/New-SnipeItCompany.ps1 @@ -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" #> diff --git a/SnipeitPS/Public/New-SnipeItCustomField.ps1 b/SnipeitPS/Public/New-SnipeItCustomField.ps1 index 219d014..d4b2d55 100644 --- a/SnipeitPS/Public/New-SnipeItCustomField.ps1 +++ b/SnipeitPS/Public/New-SnipeItCustomField.ps1 @@ -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() diff --git a/SnipeitPS/Public/New-SnipeItDepartment.ps1 b/SnipeitPS/Public/New-SnipeItDepartment.ps1 index c51d094..d6141cd 100644 --- a/SnipeitPS/Public/New-SnipeItDepartment.ps1 +++ b/SnipeitPS/Public/New-SnipeItDepartment.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/New-SnipeItLicense.ps1 b/SnipeitPS/Public/New-SnipeItLicense.ps1 index b5e4d4a..ecfc9df 100644 --- a/SnipeitPS/Public/New-SnipeItLicense.ps1 +++ b/SnipeitPS/Public/New-SnipeItLicense.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/New-SnipeItLocation.ps1 b/SnipeitPS/Public/New-SnipeItLocation.ps1 index a6dc864..f3ecd6e 100644 --- a/SnipeitPS/Public/New-SnipeItLocation.ps1 +++ b/SnipeitPS/Public/New-SnipeItLocation.ps1 @@ -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() { diff --git a/SnipeitPS/Public/New-SnipeItManufacturer.ps1 b/SnipeitPS/Public/New-SnipeItManufacturer.ps1 index bcdbb30..c7c1f69 100644 --- a/SnipeitPS/Public/New-SnipeItManufacturer.ps1 +++ b/SnipeitPS/Public/New-SnipeItManufacturer.ps1 @@ -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() diff --git a/SnipeitPS/Public/New-SnipeItModel.ps1 b/SnipeitPS/Public/New-SnipeItModel.ps1 index 6fe1119..603e052 100644 --- a/SnipeitPS/Public/New-SnipeItModel.ps1 +++ b/SnipeitPS/Public/New-SnipeItModel.ps1 @@ -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() diff --git a/SnipeitPS/Public/New-SnipeItUser.ps1 b/SnipeitPS/Public/New-SnipeItUser.ps1 index 120b26d..2dbac25 100644 --- a/SnipeitPS/Public/New-SnipeItUser.ps1 +++ b/SnipeitPS/Public/New-SnipeItUser.ps1 @@ -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 diff --git a/SnipeitPS/Public/Remove-SnipeItAsset.ps1 b/SnipeitPS/Public/Remove-SnipeItAsset.ps1 index 013147c..3fe5f53 100644 --- a/SnipeitPS/Public/Remove-SnipeItAsset.ps1 +++ b/SnipeitPS/Public/Remove-SnipeItAsset.ps1 @@ -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 () diff --git a/SnipeitPS/Public/Remove-SnipeItAssetMaintenance.ps1 b/SnipeitPS/Public/Remove-SnipeItAssetMaintenance.ps1 index b48afcb..e64c941 100644 --- a/SnipeitPS/Public/Remove-SnipeItAssetMaintenance.ps1 +++ b/SnipeitPS/Public/Remove-SnipeItAssetMaintenance.ps1 @@ -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, diff --git a/SnipeitPS/Public/Remove-SnipeItUser.ps1 b/SnipeitPS/Public/Remove-SnipeItUser.ps1 index b30f550..b6f64cf 100644 --- a/SnipeitPS/Public/Remove-SnipeItUser.ps1 +++ b/SnipeitPS/Public/Remove-SnipeItUser.ps1 @@ -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 () diff --git a/SnipeitPS/Public/Reset-SnipeItAssetOwner.ps1 b/SnipeitPS/Public/Reset-SnipeItAssetOwner.ps1 index e4588a7..235942a 100644 --- a/SnipeitPS/Public/Reset-SnipeItAssetOwner.ps1 +++ b/SnipeitPS/Public/Reset-SnipeItAssetOwner.ps1 @@ -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( diff --git a/SnipeitPS/Public/Set-SnipeItAccessory.ps1 b/SnipeitPS/Public/Set-SnipeItAccessory.ps1 index b0d619c..668092e 100644 --- a/SnipeitPS/Public/Set-SnipeItAccessory.ps1 +++ b/SnipeitPS/Public/Set-SnipeItAccessory.ps1 @@ -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() { diff --git a/SnipeitPS/Public/Set-SnipeItAsset.ps1 b/SnipeitPS/Public/Set-SnipeItAsset.ps1 index 1e73704..fb3d6cf 100644 --- a/SnipeitPS/Public/Set-SnipeItAsset.ps1 +++ b/SnipeitPS/Public/Set-SnipeItAsset.ps1 @@ -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() diff --git a/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 b/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 index 0c83ecb..55193f6 100644 --- a/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 +++ b/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 @@ -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() { diff --git a/SnipeitPS/Public/Set-SnipeItLicense.ps1 b/SnipeitPS/Public/Set-SnipeItLicense.ps1 index 0cf0b18..3e8dc5e 100644 --- a/SnipeitPS/Public/Set-SnipeItLicense.ps1 +++ b/SnipeitPS/Public/Set-SnipeItLicense.ps1 @@ -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 #> diff --git a/SnipeitPS/Public/Set-SnipeItModel.ps1 b/SnipeitPS/Public/Set-SnipeItModel.ps1 index ad07e57..f2c7051 100644 --- a/SnipeitPS/Public/Set-SnipeItModel.ps1 +++ b/SnipeitPS/Public/Set-SnipeItModel.ps1 @@ -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() { diff --git a/SnipeitPS/Public/Set-SnipeItUser.ps1 b/SnipeitPS/Public/Set-SnipeItUser.ps1 index 6486af3..38738a9 100644 --- a/SnipeitPS/Public/Set-SnipeItUser.ps1 +++ b/SnipeitPS/Public/Set-SnipeItUser.ps1 @@ -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 diff --git a/docs/Get-SnipeItAccessory.md b/docs/Get-SnipeItAccessory.md index 1a6b592..259521f 100644 --- a/docs/Get-SnipeItAccessory.md +++ b/docs/Get-SnipeItAccessory.md @@ -25,12 +25,12 @@ 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 @@ -51,7 +51,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -203,7 +203,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 diff --git a/docs/Get-SnipeItAsset.md b/docs/Get-SnipeItAsset.md index f10fa59..7828560 100644 --- a/docs/Get-SnipeItAsset.md +++ b/docs/Get-SnipeItAsset.md @@ -27,22 +27,22 @@ Get-SnipeItAsset [[-search] ] [[-id] ] [[-asset_tag] ] [[ ### 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 @@ -63,7 +63,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -350,7 +350,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 diff --git a/docs/Get-SnipeItAssetMaintenance.md b/docs/Get-SnipeItAssetMaintenance.md index fb3de97..f2a4a63 100644 --- a/docs/Get-SnipeItAssetMaintenance.md +++ b/docs/Get-SnipeItAssetMaintenance.md @@ -24,17 +24,17 @@ Get-SnipeItAssetMaintenance [[-search] ] [[-asset_id] ] [[-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 @@ -55,7 +55,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -162,7 +162,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 diff --git a/docs/Get-SnipeItCategory.md b/docs/Get-SnipeItCategory.md index 97df32a..b66f781 100644 --- a/docs/Get-SnipeItCategory.md +++ b/docs/Get-SnipeItCategory.md @@ -24,12 +24,12 @@ Get-SnipeItCategory [[-search] ] [[-id] ] [[-order] ] [[- ### EXAMPLE 1 ``` -Get-Category -id 1 +Get-SnipeItCategory -id 1 ``` ### EXAMPLE 2 ``` -Get-Category -search "Laptop" +Get-SnipeItCategory -search "Laptop" ``` ## PARAMETERS @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -142,7 +142,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 diff --git a/docs/Get-SnipeItCompany.md b/docs/Get-SnipeItCompany.md index 85f877e..e7f9d6b 100644 --- a/docs/Get-SnipeItCompany.md +++ b/docs/Get-SnipeItCompany.md @@ -24,14 +24,14 @@ Get-SnipeItCompany [[-search] ] [[-id] ] [[-order] ] [[-l ### EXAMPLE 1 ``` -Get-Company +Get-SnipeItCompany ``` Gets all companies ### EXAMPLE 2 ``` -Get-Company -id 1 +Get-SnipeItCompany -id 1 ``` Gets specific company @@ -54,7 +54,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -146,7 +146,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 diff --git a/docs/Get-SnipeItComponent.md b/docs/Get-SnipeItComponent.md index 5ee4bb1..1e8405a 100644 --- a/docs/Get-SnipeItComponent.md +++ b/docs/Get-SnipeItComponent.md @@ -25,21 +25,21 @@ Get-SnipeItComponent [[-search] ] [[-id] ] [[-category_id] ] [-url] [-apiKey] [] [[-id] ] [[-order] ] [ ### 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 @@ -55,7 +55,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -162,7 +162,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 diff --git a/docs/Get-SnipeItFieldset.md b/docs/Get-SnipeItFieldset.md index 2f3c54d..e5e17aa 100644 --- a/docs/Get-SnipeItFieldset.md +++ b/docs/Get-SnipeItFieldset.md @@ -23,18 +23,18 @@ Get-SnipeItFieldset [[-id] ] [-url] [-apiKey] [] [[-id] ] [[-name] ] [[-company_id] ] + [[-product_key] ] [[-order_number] ] [[-purchase_order] ] [[-license_name] ] + [[-license_email] ] [[-manufacturer_id] ] [[-supplier_id] ] + [[-depreciation_id] ] [[-category_id] ] [[-order] ] [[-sort] ] + [[-limit] ] [[-offset] ] [-all] [-url] [-apiKey] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-SnipeItLicense -search SomeLicense +``` + +### EXAMPLE 2 +``` +Get-SnipeItLicense -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-SnipeItInfo command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 19 +Default value: None +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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### 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 diff --git a/docs/Get-SnipeItLicenseSeat.md b/docs/Get-SnipeItLicenseSeat.md new file mode 100644 index 0000000..cc81450 --- /dev/null +++ b/docs/Get-SnipeItLicenseSeat.md @@ -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] [[-seat_id] ] [[-limit] ] [[-offset] ] [-all] + [-url] [-apiKey] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-SnipeItLicenseSeat -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-SnipeItInfo command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +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: True +Position: 1 +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 +``` + +### -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 +``` + +### -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 +``` + +### 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 diff --git a/docs/Get-SnipeItManufacturer.md b/docs/Get-SnipeItManufacturer.md index e3a775f..de28bf0 100644 --- a/docs/Get-SnipeItManufacturer.md +++ b/docs/Get-SnipeItManufacturer.md @@ -24,14 +24,14 @@ Get-SnipeItManufacturer [[-search] ] [[-id] ] [[-order] ] ### 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 diff --git a/docs/Get-SnipeItModel.md b/docs/Get-SnipeItModel.md index 77b2d62..6c74880 100644 --- a/docs/Get-SnipeItModel.md +++ b/docs/Get-SnipeItModel.md @@ -24,12 +24,12 @@ Get-SnipeItModel [[-search] ] [[-id] ] [[-order] ] [[-lim ### EXAMPLE 1 ``` -Get-Model -search "DL380" +Get-SnipeItModel -search "DL380" ``` ### EXAMPLE 2 ``` -Get-Model -id 1 +Get-SnipeItModel -id 1 ``` ## PARAMETERS @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -142,7 +142,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 diff --git a/docs/Get-SnipeItStatus.md b/docs/Get-SnipeItStatus.md index 2a287e0..a08bd6d 100644 --- a/docs/Get-SnipeItStatus.md +++ b/docs/Get-SnipeItStatus.md @@ -24,12 +24,12 @@ Get-SnipeItStatus [[-search] ] [[-id] ] [[-order] ] [[-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 @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -142,7 +142,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 diff --git a/docs/Get-SnipeItSupplier.md b/docs/Get-SnipeItSupplier.md index 5df5f74..0413493 100644 --- a/docs/Get-SnipeItSupplier.md +++ b/docs/Get-SnipeItSupplier.md @@ -24,12 +24,12 @@ Get-SnipeItSupplier [[-search] ] [[-id] ] [[-order] ] [[- ### EXAMPLE 1 ``` -Get-Supplier -search MySupplier +Get-SnipeItSupplier -search MySupplier ``` ### EXAMPLE 2 ``` -Get-Supplier -id 2 +Get-SnipeItSupplier -id 2 ``` ## PARAMETERS diff --git a/docs/Get-SnipeItUser.md b/docs/Get-SnipeItUser.md index e7e1410..7d643f4 100644 --- a/docs/Get-SnipeItUser.md +++ b/docs/Get-SnipeItUser.md @@ -26,22 +26,22 @@ Get-SnipeItUser [[-search] ] [[-id] ] [[-company_id] ] [[ ### 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 diff --git a/docs/Get-SnipeitLocation.md b/docs/Get-SnipeitLocation.md index fbf0088..2c7ed5b 100644 --- a/docs/Get-SnipeitLocation.md +++ b/docs/Get-SnipeitLocation.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: @@ -24,12 +24,12 @@ Get-SnipeitLocation [[-search] ] [[-id] ] [[-order] ] [[- ### EXAMPLE 1 ``` -Get-Location -search Location1 +Get-SnipeItLocation -search Location1 ``` ### EXAMPLE 2 ``` -Get-Location -id 3 +Get-SnipeItLocation -id 3 ``` ## PARAMETERS diff --git a/docs/New-SnipeItAsset.md b/docs/New-SnipeItAsset.md index 76e1b2a..d4057f8 100644 --- a/docs/New-SnipeItAsset.md +++ b/docs/New-SnipeItAsset.md @@ -27,21 +27,21 @@ 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. @@ -49,7 +49,7 @@ Using customfields when creating asset. ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -260,7 +260,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 diff --git a/docs/New-SnipeItAssetMaintenance.md b/docs/New-SnipeItAssetMaintenance.md index 8474800..f49bac6 100644 --- a/docs/New-SnipeItAssetMaintenance.md +++ b/docs/New-SnipeItAssetMaintenance.md @@ -26,13 +26,13 @@ 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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -182,7 +182,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 diff --git a/docs/New-SnipeItCategory.md b/docs/New-SnipeItCategory.md index 3b1b56a..2d058df 100644 --- a/docs/New-SnipeItCategory.md +++ b/docs/New-SnipeItCategory.md @@ -24,13 +24,13 @@ New-SnipeItCategory [-name] [-category_type] [-url] [ ### 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 +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -105,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 diff --git a/docs/New-SnipeItComponent.md b/docs/New-SnipeItComponent.md index 8bc5144..2292692 100644 --- a/docs/New-SnipeItComponent.md +++ b/docs/New-SnipeItComponent.md @@ -31,7 +31,7 @@ An example ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-Info command +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -151,7 +151,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 diff --git a/docs/New-SnipeItCustomField.md b/docs/New-SnipeItCustomField.md index fb55d4a..b411e55 100644 --- a/docs/New-SnipeItCustomField.md +++ b/docs/New-SnipeItCustomField.md @@ -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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -136,7 +136,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 diff --git a/docs/New-SnipeItDepartment.md b/docs/New-SnipeItDepartment.md index c94b892..d582ff6 100644 --- a/docs/New-SnipeItDepartment.md +++ b/docs/New-SnipeItDepartment.md @@ -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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -120,7 +120,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 diff --git a/docs/New-SnipeItLicense.md b/docs/New-SnipeItLicense.md index e628927..8de15ba 100644 --- a/docs/New-SnipeItLicense.md +++ b/docs/New-SnipeItLicense.md @@ -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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -304,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 diff --git a/docs/New-SnipeItLocation.md b/docs/New-SnipeItLocation.md index 3ec6c2b..d2c35e9 100644 --- a/docs/New-SnipeItLocation.md +++ b/docs/New-SnipeItLocation.md @@ -25,7 +25,7 @@ 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 @@ -61,7 +61,7 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -166,7 +166,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 diff --git a/docs/New-SnipeItManufacturer.md b/docs/New-SnipeItManufacturer.md index 5a07084..dc9236d 100644 --- a/docs/New-SnipeItManufacturer.md +++ b/docs/New-SnipeItManufacturer.md @@ -24,13 +24,13 @@ 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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -60,7 +60,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 diff --git a/docs/New-SnipeItModel.md b/docs/New-SnipeItModel.md index 6f69c93..24d2ecc 100644 --- a/docs/New-SnipeItModel.md +++ b/docs/New-SnipeItModel.md @@ -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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -136,7 +136,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 diff --git a/docs/New-SnipeItUser.md b/docs/New-SnipeItUser.md index 3ecf106..dd563e9 100644 --- a/docs/New-SnipeItUser.md +++ b/docs/New-SnipeItUser.md @@ -27,7 +27,7 @@ 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 @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### -apiKey -User's API Key for Snipeit, can be set using Set-Info command +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -260,7 +260,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 diff --git a/docs/Remove-SnipeItAsset.md b/docs/Remove-SnipeItAsset.md index de978c4..a79edcc 100644 --- a/docs/Remove-SnipeItAsset.md +++ b/docs/Remove-SnipeItAsset.md @@ -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,19 +17,19 @@ Remove-SnipeItAsset [-ID] [-URL] [-APIKey] [-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 +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -59,7 +59,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 diff --git a/docs/Remove-SnipeItUser.md b/docs/Remove-SnipeItUser.md index d0ff674..22d52a1 100644 --- a/docs/Remove-SnipeItUser.md +++ b/docs/Remove-SnipeItUser.md @@ -23,13 +23,13 @@ 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 +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -59,7 +59,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 diff --git a/docs/Set-SnipeItAccessory.md b/docs/Set-SnipeItAccessory.md index 0915aae..3b10b76 100644 --- a/docs/Set-SnipeItAccessory.md +++ b/docs/Set-SnipeItAccessory.md @@ -26,13 +26,13 @@ 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 +Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command ```yaml Type: String @@ -212,7 +212,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 diff --git a/docs/Set-SnipeItAsset.md b/docs/Set-SnipeItAsset.md index ab0765b..d199e77 100644 --- a/docs/Set-SnipeItAsset.md +++ b/docs/Set-SnipeItAsset.md @@ -27,18 +27,18 @@ 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 +Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command ```yaml Type: String @@ -279,7 +279,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 diff --git a/docs/Set-SnipeItAssetOwner.md b/docs/Set-SnipeItAssetOwner.md index e7a75c8..3b87adb 100644 --- a/docs/Set-SnipeItAssetOwner.md +++ b/docs/Set-SnipeItAssetOwner.md @@ -25,13 +25,13 @@ 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 +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -154,7 +154,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 diff --git a/docs/Set-SnipeItComponent.md b/docs/Set-SnipeItComponent.md index f48c027..13aeb56 100644 --- a/docs/Set-SnipeItComponent.md +++ b/docs/Set-SnipeItComponent.md @@ -31,7 +31,7 @@ An example ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-Info command +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -151,7 +151,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 diff --git a/docs/Set-SnipeItInfo.md b/docs/Set-SnipeItInfo.md index bcf16b2..5af19dd 100644 --- a/docs/Set-SnipeItInfo.md +++ b/docs/Set-SnipeItInfo.md @@ -23,13 +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 +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -44,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: Uri diff --git a/docs/Set-SnipeItLicense.md b/docs/Set-SnipeItLicense.md index 5afe0a1..8dfa8cc 100644 --- a/docs/Set-SnipeItLicense.md +++ b/docs/Set-SnipeItLicense.md @@ -28,13 +28,13 @@ 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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -319,7 +319,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 diff --git a/docs/Set-SnipeItLicenseSeat.md b/docs/Set-SnipeItLicenseSeat.md new file mode 100644 index 0000000..0bbca1a --- /dev/null +++ b/docs/Set-SnipeItLicenseSeat.md @@ -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] [-seat_id] [[-assigned_id] ] [[-asset_id] ] + [[-note] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## 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 + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### -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 +``` + +### 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 diff --git a/docs/Set-SnipeItModel.md b/docs/Set-SnipeItModel.md index 5475fe1..816f4e0 100644 --- a/docs/Set-SnipeItModel.md +++ b/docs/Set-SnipeItModel.md @@ -25,13 +25,13 @@ 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 +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -151,7 +151,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 diff --git a/docs/Set-SnipeItUser.md b/docs/Set-SnipeItUser.md index 799c740..1b2f9e1 100644 --- a/docs/Set-SnipeItUser.md +++ b/docs/Set-SnipeItUser.md @@ -27,7 +27,7 @@ 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 @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### -apiKey -User's API Key for Snipeit, can be set using Set-Info command +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -245,7 +245,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 diff --git a/docs/Set-SnipeitLocation.md b/docs/Set-SnipeitLocation.md index 792cc2a..8c9a0da 100644 --- a/docs/Set-SnipeitLocation.md +++ b/docs/Set-SnipeitLocation.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: diff --git a/docs/SnipeItPS.md b/docs/SnipeItPS.md index 7f94ac4..2189f2f 100644 --- a/docs/SnipeItPS.md +++ b/docs/SnipeItPS.md @@ -8,7 +8,7 @@ Locale: en-US # SnipeitPS Module ## Description -Powershell API for SnipeIt Asset Management +{{ Fill in the Description }} ## SnipeitPS Cmdlets ### [Get-SnipeItAccessory](Get-SnipeItAccessory.md) @@ -38,6 +38,15 @@ Gets a list of Snipe-it Departments ### [Get-SnipeItFieldset](Get-SnipeItFieldset.md) Returns a fieldset or list of Snipe-it Fieldsets +### [Get-SnipeItLicense](Get-SnipeItLicense.md) +Gets a list of Snipe-it Licenses + +### [Get-SnipeItLicenseSeat](Get-SnipeItLicenseSeat.md) +Gets a list of Snipe-it Licenses Seats or specific Seat + +### [Get-SnipeitLocation](Get-SnipeitLocation.md) +Gets a list of Snipe-it Locations + ### [Get-SnipeItModel](Get-SnipeItModel.md) Gets a list of Snipe-it Models @@ -78,7 +87,7 @@ Add a new Model to Snipe-it asset system Creates a new user ### [Remove-SnipeItAsset](Remove-SnipeItAsset.md) -Removes Asset to Snipe-it asset system +Removes Asset from Snipe-it asset system ### [Remove-SnipeItUser](Remove-SnipeItUser.md) Removes User from Snipe-it asset system @@ -101,6 +110,9 @@ Sets authetication information ### [Set-SnipeItLicense](Set-SnipeItLicense.md) Updates a licence +### [Set-SnipeItLicenseSeat](Set-SnipeItLicenseSeat.md) +Set license seat or checkout license seat + ### [Set-SnipeitLocation](Set-SnipeitLocation.md) Updates Location in Snipe-it asset system