From 7d95d5078fd0d4dd78a2b3a8f9b3596b12f6398b Mon Sep 17 00:00:00 2001 From: Petri Asikainen Date: Sun, 23 May 2021 23:22:23 +0300 Subject: [PATCH 1/2] Updated docs and examples --- SnipeitPS/Public/Get-SnipeItAccessory.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItAsset.ps1 | 8 +- .../Public/Get-SnipeItAssetMaintenance.ps1 | 6 +- SnipeitPS/Public/Get-SnipeItCategory.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItCompany.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItComponent.ps1 | 6 +- SnipeitPS/Public/Get-SnipeItCustomField.ps1 | 2 +- SnipeitPS/Public/Get-SnipeItDepartment.ps1 | 6 +- SnipeitPS/Public/Get-SnipeItFieldset.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItLicense.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItLocation.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItManufacturer.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItModel.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItStatus.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItSupplier.ps1 | 4 +- SnipeitPS/Public/Get-SnipeItUser.ps1 | 8 +- SnipeitPS/Public/New-SnipeItAccessory.ps1 | 2 +- SnipeitPS/Public/New-SnipeItAsset.ps1 | 6 +- .../Public/New-SnipeItAssetMaintenance.ps1 | 2 +- SnipeitPS/Public/New-SnipeItAudit.ps1 | 2 +- SnipeitPS/Public/New-SnipeItCategory.ps1 | 2 +- SnipeitPS/Public/New-SnipeItCompany.ps1 | 2 +- SnipeitPS/Public/New-SnipeItCustomField.ps1 | 2 +- SnipeitPS/Public/New-SnipeItDepartment.ps1 | 2 +- SnipeitPS/Public/New-SnipeItLicense.ps1 | 2 +- SnipeitPS/Public/New-SnipeItLocation.ps1 | 2 +- SnipeitPS/Public/New-SnipeItManufacturer.ps1 | 2 +- SnipeitPS/Public/New-SnipeItModel.ps1 | 2 +- SnipeitPS/Public/New-SnipeItUser.ps1 | 2 +- SnipeitPS/Public/Remove-SnipeItAsset.ps1 | 2 +- .../Public/Remove-SnipeItAssetMaintenance.ps1 | 2 +- SnipeitPS/Public/Remove-SnipeItUser.ps1 | 2 +- SnipeitPS/Public/Reset-SnipeItAssetOwner.ps1 | 2 +- SnipeitPS/Public/Set-SnipeItAccessory.ps1 | 2 +- SnipeitPS/Public/Set-SnipeItAsset.ps1 | 4 +- SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 | 2 +- SnipeitPS/Public/Set-SnipeItLicense.ps1 | 2 +- SnipeitPS/Public/Set-SnipeItModel.ps1 | 2 +- SnipeitPS/Public/Set-SnipeItUser.ps1 | 2 +- docs/Get-SnipeItAccessory.md | 180 ++++----- docs/Get-SnipeItAsset.md | 370 +++++++++--------- docs/Get-SnipeItAssetMaintenance.md | 136 +++---- docs/Get-SnipeItCategory.md | 84 ++-- docs/Get-SnipeItCompany.md | 84 ++-- docs/Get-SnipeItComponent.md | 152 +++---- docs/Get-SnipeItCustomField.md | 34 +- docs/Get-SnipeItDepartment.md | 86 ++-- docs/Get-SnipeItFieldset.md | 36 +- docs/Get-SnipeItLicense.md | 351 +++++++++++++++++ docs/Get-SnipeItLicenseSeat.md | 148 +++++++ docs/Get-SnipeItManufacturer.md | 84 ++-- docs/Get-SnipeItModel.md | 84 ++-- docs/Get-SnipeItStatus.md | 84 ++-- docs/Get-SnipeItSupplier.md | 84 ++-- docs/Get-SnipeItUser.md | 168 ++++---- docs/Get-SnipeitLocation.md | 84 ++-- docs/New-SnipeItAsset.md | 226 +++++------ docs/New-SnipeItAssetMaintenance.md | 162 ++++---- docs/New-SnipeItCategory.md | 108 ++--- docs/New-SnipeItComponent.md | 90 ++--- docs/New-SnipeItCustomField.md | 94 ++--- docs/New-SnipeItDepartment.md | 52 +-- docs/New-SnipeItLicense.md | 82 ++-- docs/New-SnipeItLocation.md | 122 +++--- docs/New-SnipeItManufacturer.md | 46 +-- docs/New-SnipeItModel.md | 112 +++--- docs/New-SnipeItUser.md | 348 ++++++++-------- docs/Remove-SnipeItAsset.md | 50 +-- docs/Remove-SnipeItUser.md | 46 +-- docs/Set-SnipeItAccessory.md | 124 +++--- docs/Set-SnipeItAsset.md | 234 +++++------ docs/Set-SnipeItAssetOwner.md | 116 +++--- docs/Set-SnipeItComponent.md | 194 ++++----- docs/Set-SnipeItInfo.md | 34 +- docs/Set-SnipeItLicense.md | 114 +++--- docs/Set-SnipeItLicenseSeat.md | 186 +++++++++ docs/Set-SnipeItModel.md | 132 +++---- docs/Set-SnipeItUser.md | 324 +++++++-------- docs/Set-SnipeitLocation.md | 120 +++--- docs/SnipeItPS.md | 89 +++-- 80 files changed, 3144 insertions(+), 2438 deletions(-) create mode 100644 docs/Get-SnipeItLicense.md create mode 100644 docs/Get-SnipeItLicenseSeat.md create mode 100644 docs/Set-SnipeItLicenseSeat.md 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..7547e6b 100644 --- a/docs/Get-SnipeItAccessory.md +++ b/docs/Get-SnipeItAccessory.md @@ -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). diff --git a/docs/Get-SnipeItAsset.md b/docs/Get-SnipeItAsset.md index f10fa59..60f9bc5 100644 --- a/docs/Get-SnipeItAsset.md +++ b/docs/Get-SnipeItAsset.md @@ -27,51 +27,66 @@ 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 -### -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). diff --git a/docs/Get-SnipeItAssetMaintenance.md b/docs/Get-SnipeItAssetMaintenance.md index fb3de97..dc207e7 100644 --- a/docs/Get-SnipeItAssetMaintenance.md +++ b/docs/Get-SnipeItAssetMaintenance.md @@ -24,46 +24,31 @@ 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 -### -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). diff --git a/docs/Get-SnipeItCategory.md b/docs/Get-SnipeItCategory.md index 97df32a..88d2ddc 100644 --- a/docs/Get-SnipeItCategory.md +++ b/docs/Get-SnipeItCategory.md @@ -24,41 +24,26 @@ 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 -### -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). diff --git a/docs/Get-SnipeItCompany.md b/docs/Get-SnipeItCompany.md index 85f877e..3257b97 100644 --- a/docs/Get-SnipeItCompany.md +++ b/docs/Get-SnipeItCompany.md @@ -24,45 +24,30 @@ 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 ## 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). diff --git a/docs/Get-SnipeItComponent.md b/docs/Get-SnipeItComponent.md index 5ee4bb1..1776a02 100644 --- a/docs/Get-SnipeItComponent.md +++ b/docs/Get-SnipeItComponent.md @@ -25,57 +25,57 @@ 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 -### -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). diff --git a/docs/Get-SnipeItFieldset.md b/docs/Get-SnipeItFieldset.md index 2f3c54d..5185c15 100644 --- a/docs/Get-SnipeItFieldset.md +++ b/docs/Get-SnipeItFieldset.md @@ -23,31 +23,16 @@ 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 + +### -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 diff --git a/docs/Get-SnipeItLicenseSeat.md b/docs/Get-SnipeItLicenseSeat.md new file mode 100644 index 0000000..db3221b --- /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 + +### -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 diff --git a/docs/Get-SnipeItManufacturer.md b/docs/Get-SnipeItManufacturer.md index e3a775f..fd87dd9 100644 --- a/docs/Get-SnipeItManufacturer.md +++ b/docs/Get-SnipeItManufacturer.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: @@ -24,45 +24,30 @@ 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 ## 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). diff --git a/docs/Get-SnipeItModel.md b/docs/Get-SnipeItModel.md index 77b2d62..c534e60 100644 --- a/docs/Get-SnipeItModel.md +++ b/docs/Get-SnipeItModel.md @@ -24,41 +24,26 @@ 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 -### -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). diff --git a/docs/Get-SnipeItStatus.md b/docs/Get-SnipeItStatus.md index 2a287e0..ad5d2f5 100644 --- a/docs/Get-SnipeItStatus.md +++ b/docs/Get-SnipeItStatus.md @@ -24,41 +24,26 @@ 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 -### -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). diff --git a/docs/Get-SnipeItSupplier.md b/docs/Get-SnipeItSupplier.md index 5df5f74..dd2fbd5 100644 --- a/docs/Get-SnipeItSupplier.md +++ b/docs/Get-SnipeItSupplier.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: @@ -24,41 +24,26 @@ 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 -### -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). diff --git a/docs/Get-SnipeItUser.md b/docs/Get-SnipeItUser.md index e7e1410..b157893 100644 --- a/docs/Get-SnipeItUser.md +++ b/docs/Get-SnipeItUser.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: @@ -26,51 +26,51 @@ 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 -### -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 diff --git a/docs/Get-SnipeitLocation.md b/docs/Get-SnipeitLocation.md index fbf0088..920baac 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,41 +24,26 @@ 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 -### -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). diff --git a/docs/New-SnipeItAsset.md b/docs/New-SnipeItAsset.md index 76e1b2a..0f5a2c6 100644 --- a/docs/New-SnipeItAsset.md +++ b/docs/New-SnipeItAsset.md @@ -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). diff --git a/docs/New-SnipeItAssetMaintenance.md b/docs/New-SnipeItAssetMaintenance.md index 8474800..39c2272 100644 --- a/docs/New-SnipeItAssetMaintenance.md +++ b/docs/New-SnipeItAssetMaintenance.md @@ -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). diff --git a/docs/New-SnipeItCategory.md b/docs/New-SnipeItCategory.md index 3b1b56a..a96c4fb 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 +### -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). diff --git a/docs/New-SnipeItComponent.md b/docs/New-SnipeItComponent.md index 8bc5144..60910d3 100644 --- a/docs/New-SnipeItComponent.md +++ b/docs/New-SnipeItComponent.md @@ -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). diff --git a/docs/New-SnipeItCustomField.md b/docs/New-SnipeItCustomField.md index fb55d4a..90f207a 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 +### -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). diff --git a/docs/New-SnipeItDepartment.md b/docs/New-SnipeItDepartment.md index c94b892..797b985 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 +### -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). diff --git a/docs/New-SnipeItLicense.md b/docs/New-SnipeItLicense.md index e628927..841736b 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 +### -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). diff --git a/docs/New-SnipeItLocation.md b/docs/New-SnipeItLocation.md index 3ec6c2b..8f5f31f 100644 --- a/docs/New-SnipeItLocation.md +++ b/docs/New-SnipeItLocation.md @@ -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). diff --git a/docs/New-SnipeItManufacturer.md b/docs/New-SnipeItManufacturer.md index 5a07084..50cd5e9 100644 --- a/docs/New-SnipeItManufacturer.md +++ b/docs/New-SnipeItManufacturer.md @@ -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). diff --git a/docs/New-SnipeItModel.md b/docs/New-SnipeItModel.md index 6f69c93..105f39b 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 +### -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). diff --git a/docs/New-SnipeItUser.md b/docs/New-SnipeItUser.md index 3ecf106..07eb6be 100644 --- a/docs/New-SnipeItUser.md +++ b/docs/New-SnipeItUser.md @@ -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). diff --git a/docs/Remove-SnipeItAsset.md b/docs/Remove-SnipeItAsset.md index de978c4..8ac679c 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,32 +17,17 @@ 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 - -```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). diff --git a/docs/Remove-SnipeItUser.md b/docs/Remove-SnipeItUser.md index d0ff674..891ffd5 100644 --- a/docs/Remove-SnipeItUser.md +++ b/docs/Remove-SnipeItUser.md @@ -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). diff --git a/docs/Set-SnipeItAccessory.md b/docs/Set-SnipeItAccessory.md index 0915aae..06e039a 100644 --- a/docs/Set-SnipeItAccessory.md +++ b/docs/Set-SnipeItAccessory.md @@ -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). diff --git a/docs/Set-SnipeItAsset.md b/docs/Set-SnipeItAsset.md index ab0765b..4ad339a 100644 --- a/docs/Set-SnipeItAsset.md +++ b/docs/Set-SnipeItAsset.md @@ -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). diff --git a/docs/Set-SnipeItAssetOwner.md b/docs/Set-SnipeItAssetOwner.md index e7a75c8..1d0dc2c 100644 --- a/docs/Set-SnipeItAssetOwner.md +++ b/docs/Set-SnipeItAssetOwner.md @@ -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). diff --git a/docs/Set-SnipeItComponent.md b/docs/Set-SnipeItComponent.md index f48c027..52d0154 100644 --- a/docs/Set-SnipeItComponent.md +++ b/docs/Set-SnipeItComponent.md @@ -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). diff --git a/docs/Set-SnipeItInfo.md b/docs/Set-SnipeItInfo.md index bcf16b2..5f7c4bb 100644 --- a/docs/Set-SnipeItInfo.md +++ b/docs/Set-SnipeItInfo.md @@ -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). diff --git a/docs/Set-SnipeItLicense.md b/docs/Set-SnipeItLicense.md index 5afe0a1..13416fb 100644 --- a/docs/Set-SnipeItLicense.md +++ b/docs/Set-SnipeItLicense.md @@ -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). diff --git a/docs/Set-SnipeItLicenseSeat.md b/docs/Set-SnipeItLicenseSeat.md new file mode 100644 index 0000000..3620715 --- /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 + +### -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 diff --git a/docs/Set-SnipeItModel.md b/docs/Set-SnipeItModel.md index 5475fe1..40c5277 100644 --- a/docs/Set-SnipeItModel.md +++ b/docs/Set-SnipeItModel.md @@ -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). diff --git a/docs/Set-SnipeItUser.md b/docs/Set-SnipeItUser.md index 799c740..4bf1538 100644 --- a/docs/Set-SnipeItUser.md +++ b/docs/Set-SnipeItUser.md @@ -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). diff --git a/docs/Set-SnipeitLocation.md b/docs/Set-SnipeitLocation.md index 792cc2a..6f22496 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: @@ -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). diff --git a/docs/SnipeItPS.md b/docs/SnipeItPS.md index 7f94ac4..256e56d 100644 --- a/docs/SnipeItPS.md +++ b/docs/SnipeItPS.md @@ -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 }} From 06305b1b6396e36cd92cb58a6066861e1dbcdfca Mon Sep 17 00:00:00 2001 From: Petri Asikainen Date: Sun, 23 May 2021 23:24:44 +0300 Subject: [PATCH 2/2] Updated docs and examples --- docs/Get-SnipeItAccessory.md | 174 +++++++-------- docs/Get-SnipeItAsset.md | 328 ++++++++++++++-------------- docs/Get-SnipeItAssetMaintenance.md | 128 +++++------ docs/Get-SnipeItCategory.md | 78 +++---- docs/Get-SnipeItCompany.md | 78 +++---- docs/Get-SnipeItComponent.md | 144 ++++++------ docs/Get-SnipeItCustomField.md | 30 +-- docs/Get-SnipeItDepartment.md | 78 +++---- docs/Get-SnipeItFieldset.md | 30 +-- docs/Get-SnipeItLicense.md | 318 +++++++++++++-------------- docs/Get-SnipeItLicenseSeat.md | 70 +++--- docs/Get-SnipeItManufacturer.md | 80 +++---- docs/Get-SnipeItModel.md | 78 +++---- docs/Get-SnipeItStatus.md | 78 +++---- docs/Get-SnipeItSupplier.md | 80 +++---- docs/Get-SnipeItUser.md | 136 ++++++------ docs/Get-SnipeitLocation.md | 78 +++---- docs/New-SnipeItAsset.md | 238 ++++++++++---------- docs/New-SnipeItAssetMaintenance.md | 158 +++++++------- docs/New-SnipeItCategory.md | 104 ++++----- docs/New-SnipeItComponent.md | 88 ++++---- docs/New-SnipeItCustomField.md | 90 ++++---- docs/New-SnipeItDepartment.md | 48 ++-- docs/New-SnipeItLicense.md | 78 +++---- docs/New-SnipeItLocation.md | 118 +++++----- docs/New-SnipeItManufacturer.md | 42 ++-- docs/New-SnipeItModel.md | 108 ++++----- docs/New-SnipeItUser.md | 294 ++++++++++++------------- docs/Remove-SnipeItAsset.md | 42 ++-- docs/Remove-SnipeItUser.md | 42 ++-- docs/Set-SnipeItAccessory.md | 120 +++++----- docs/Set-SnipeItAsset.md | 244 ++++++++++----------- docs/Set-SnipeItAssetOwner.md | 112 +++++----- docs/Set-SnipeItComponent.md | 116 +++++----- docs/Set-SnipeItInfo.md | 30 +-- docs/Set-SnipeItLicense.md | 110 +++++----- docs/Set-SnipeItLicenseSeat.md | 68 +++--- docs/Set-SnipeItModel.md | 126 +++++------ docs/Set-SnipeItUser.md | 316 +++++++++++++-------------- docs/Set-SnipeitLocation.md | 144 ++++++------ docs/SnipeItPS.md | 83 ++++--- 41 files changed, 2448 insertions(+), 2457 deletions(-) diff --git a/docs/Get-SnipeItAccessory.md b/docs/Get-SnipeItAccessory.md index 7547e6b..259521f 100644 --- a/docs/Get-SnipeItAccessory.md +++ b/docs/Get-SnipeItAccessory.md @@ -35,36 +35,36 @@ Get-SnipeItAccessory -id 1 ## PARAMETERS -### -search -A text string to search the Accessory data +### -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: False -Position: 1 +Required: True +Position: 11 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 ``` -### -manufacturer_id -{{ Fill manufacturer_id Description }} +### -company_id +{{ Fill company_id Description }} ```yaml Type: Int32 @@ -89,57 +89,12 @@ Parameter Sets: (All) Aliases: Required: False -Position: 4 +Position: 2 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. @@ -157,6 +112,21 @@ 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 @@ -172,17 +142,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -202,21 +217,6 @@ 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). diff --git a/docs/Get-SnipeItAsset.md b/docs/Get-SnipeItAsset.md index 60f9bc5..7828560 100644 --- a/docs/Get-SnipeItAsset.md +++ b/docs/Get-SnipeItAsset.md @@ -47,46 +47,31 @@ Get-SnipeItAsset -asset_tag "myAssetTag"-url "https://assets.example.com"-token ## PARAMETERS -### -search -A text string to search the assets data +### -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: 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 +Required: True +Position: 20 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -107,32 +92,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -order_number -Optionally restrict asset results to this order number +### -asset_tag +Exact asset tag to query ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: False -Position: 5 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -model_id -Optionally restrict asset results to this asset model ID - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: 0 +Position: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -152,21 +122,6 @@ 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 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -company_id Optionally restrict asset results to this company ID @@ -182,6 +137,53 @@ 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 @@ -197,8 +199,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -depreciation_id -{{ Fill depreciation_id Description }} +### -manufacturer_id +Optionally restrict asset results to this manufacturer ID ```yaml Type: Int32 @@ -206,7 +208,67 @@ Parameter Sets: (All) Aliases: Required: False -Position: 11 +Position: 8 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -model_id +Optionally restrict asset results to this asset model ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 0 +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 +``` + +### -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 + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -227,6 +289,36 @@ 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 @@ -257,83 +349,6 @@ 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-SnipeItInfo command @@ -349,21 +364,6 @@ 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). diff --git a/docs/Get-SnipeItAssetMaintenance.md b/docs/Get-SnipeItAssetMaintenance.md index dc207e7..f2a4a63 100644 --- a/docs/Get-SnipeItAssetMaintenance.md +++ b/docs/Get-SnipeItAssetMaintenance.md @@ -39,16 +39,31 @@ Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.co ## PARAMETERS -### -search -Search string +### -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: False -Position: 1 +Required: True +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,36 +84,6 @@ 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. @@ -116,21 +101,6 @@ 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 @@ -146,6 +116,51 @@ 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-SnipeItInfo command @@ -161,21 +176,6 @@ 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). diff --git a/docs/Get-SnipeItCategory.md b/docs/Get-SnipeItCategory.md index 88d2ddc..b66f781 100644 --- a/docs/Get-SnipeItCategory.md +++ b/docs/Get-SnipeItCategory.md @@ -34,16 +34,31 @@ Get-SnipeItCategory -search "Laptop" ## PARAMETERS -### -search -A text string to search the Categories data +### -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: False -Position: 1 +Required: True +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -64,21 +79,6 @@ 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,17 +111,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -141,21 +156,6 @@ 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). diff --git a/docs/Get-SnipeItCompany.md b/docs/Get-SnipeItCompany.md index 3257b97..e7f9d6b 100644 --- a/docs/Get-SnipeItCompany.md +++ b/docs/Get-SnipeItCompany.md @@ -38,16 +38,31 @@ Gets specific company ## PARAMETERS -### -search -A text string to search the Companies data +### -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: False -Position: 1 +Required: True +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -68,21 +83,6 @@ 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,17 +115,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -145,21 +160,6 @@ 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). diff --git a/docs/Get-SnipeItComponent.md b/docs/Get-SnipeItComponent.md index 1776a02..1e8405a 100644 --- a/docs/Get-SnipeItComponent.md +++ b/docs/Get-SnipeItComponent.md @@ -46,36 +46,36 @@ Returns specific component ## PARAMETERS -### -search -A text string to search the Components data +### -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: False -Position: 1 +Required: True +Position: 11 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 ``` -### -location_id -{{ Fill location_id Description }} +### -id +A id of specific Component ```yaml Type: Int32 @@ -115,42 +115,12 @@ Parameter Sets: (All) Aliases: Required: False -Position: 5 +Position: 2 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. @@ -168,6 +138,21 @@ 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 @@ -183,17 +168,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -213,21 +228,6 @@ 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). diff --git a/docs/Get-SnipeItCustomField.md b/docs/Get-SnipeItCustomField.md index acfd03e..b5d284b 100644 --- a/docs/Get-SnipeItCustomField.md +++ b/docs/Get-SnipeItCustomField.md @@ -28,6 +28,21 @@ Get-SnipeItCustomField -url "https://assets.example.com" -token "token..." ## PARAMETERS +### -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 +``` + ### -id A id of specific field @@ -58,21 +73,6 @@ 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). diff --git a/docs/Get-SnipeItDepartment.md b/docs/Get-SnipeItDepartment.md index 55bcd56..1572f9f 100644 --- a/docs/Get-SnipeItDepartment.md +++ b/docs/Get-SnipeItDepartment.md @@ -39,16 +39,31 @@ Get-SnipeItDepartment -id 1 ## PARAMETERS -### -search -A text string to search the Departments data +### -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: False -Position: 1 +Required: True +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,21 +84,6 @@ 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,17 +116,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -161,21 +176,6 @@ 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). diff --git a/docs/Get-SnipeItFieldset.md b/docs/Get-SnipeItFieldset.md index 5185c15..e5e17aa 100644 --- a/docs/Get-SnipeItFieldset.md +++ b/docs/Get-SnipeItFieldset.md @@ -33,6 +33,21 @@ Get-SnipeItFieldset -url "https://assets.example.com" -token "token..." | Where- ## PARAMETERS +### -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 +``` + ### -id A id of specific fieldset @@ -63,21 +78,6 @@ 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). diff --git a/docs/Get-SnipeItLicense.md b/docs/Get-SnipeItLicense.md index e0d1146..7be41ae 100644 --- a/docs/Get-SnipeItLicense.md +++ b/docs/Get-SnipeItLicense.md @@ -37,23 +37,38 @@ Get-SnipeItLicense -id 1 ## PARAMETERS -### -search -A text string to search the Licenses data +### -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: False -Position: 1 +Required: True +Position: 19 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -id -A id of specific License +### -category_id +{{ Fill category_id Description }} ```yaml Type: Int32 @@ -61,27 +76,12 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: 13 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 }} @@ -97,111 +97,6 @@ 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 }} @@ -217,8 +112,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -category_id -{{ Fill category_id Description }} +### -id +A id of specific License ```yaml Type: Int32 @@ -226,29 +121,29 @@ Parameter Sets: (All) Aliases: Required: False -Position: 13 +Position: 2 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -order -{{ Fill order Description }} +### -license_email +{{ Fill license_email Description }} ```yaml -Type: String +Type: MailAddress Parameter Sets: (All) Aliases: Required: False -Position: 14 -Default value: Desc +Position: 9 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -sort -{{ Fill sort Description }} +### -license_name +{{ Fill license_name Description }} ```yaml Type: String @@ -256,8 +151,8 @@ Parameter Sets: (All) Aliases: Required: False -Position: 15 -Default value: Created_at +Position: 8 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -279,6 +174,36 @@ 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 @@ -294,17 +219,107 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 ``` @@ -324,21 +339,6 @@ 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). diff --git a/docs/Get-SnipeItLicenseSeat.md b/docs/Get-SnipeItLicenseSeat.md index db3221b..cc81450 100644 --- a/docs/Get-SnipeItLicenseSeat.md +++ b/docs/Get-SnipeItLicenseSeat.md @@ -29,6 +29,36 @@ 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 @@ -44,21 +74,6 @@ 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. @@ -91,17 +106,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -seat_id +A id of specific seat ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 2 +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -121,21 +136,6 @@ 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). diff --git a/docs/Get-SnipeItManufacturer.md b/docs/Get-SnipeItManufacturer.md index fd87dd9..de28bf0 100644 --- a/docs/Get-SnipeItManufacturer.md +++ b/docs/Get-SnipeItManufacturer.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: @@ -38,16 +38,31 @@ Returns manufacturer with id 3 ## PARAMETERS -### -search -A text string to search the Manufactures data +### -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: False -Position: 1 +Required: True +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -68,21 +83,6 @@ 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,17 +115,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -145,21 +160,6 @@ 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). diff --git a/docs/Get-SnipeItModel.md b/docs/Get-SnipeItModel.md index c534e60..6c74880 100644 --- a/docs/Get-SnipeItModel.md +++ b/docs/Get-SnipeItModel.md @@ -34,16 +34,31 @@ Get-SnipeItModel -id 1 ## PARAMETERS -### -search -A text string to search the Models data +### -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: False -Position: 1 +Required: True +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -64,21 +79,6 @@ 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,17 +111,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -141,21 +156,6 @@ 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). diff --git a/docs/Get-SnipeItStatus.md b/docs/Get-SnipeItStatus.md index ad5d2f5..a08bd6d 100644 --- a/docs/Get-SnipeItStatus.md +++ b/docs/Get-SnipeItStatus.md @@ -34,16 +34,31 @@ Get-SnipeItStatus -id 3 ## PARAMETERS -### -search -A text string to search the Status Labels data +### -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: False -Position: 1 +Required: True +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -64,21 +79,6 @@ 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,17 +111,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -141,21 +156,6 @@ 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). diff --git a/docs/Get-SnipeItSupplier.md b/docs/Get-SnipeItSupplier.md index dd2fbd5..0413493 100644 --- a/docs/Get-SnipeItSupplier.md +++ b/docs/Get-SnipeItSupplier.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: @@ -34,16 +34,31 @@ Get-SnipeItSupplier -id 2 ## PARAMETERS -### -search -A text string to search the Supliers data +### -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: False -Position: 1 +Required: True +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -64,21 +79,6 @@ 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,17 +111,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -141,21 +156,6 @@ 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). diff --git a/docs/Get-SnipeItUser.md b/docs/Get-SnipeItUser.md index b157893..7d643f4 100644 --- a/docs/Get-SnipeItUser.md +++ b/docs/Get-SnipeItUser.md @@ -1,4 +1,4 @@ ---- +--- external help file: SnipeItPS-help.xml Module Name: SnipeitPS online version: @@ -46,31 +46,31 @@ Get-SnipeItUser -email user@somedomain.com ## PARAMETERS -### -search -A text string to search the User data +### -all +A return all results, works with -offset and other parameters ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -id -A id of specific User +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: 2 +Required: True +Position: 13 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -91,36 +91,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 -``` - -### -group_id -{{ Fill group_id Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -department_id {{ Fill department_id Description }} @@ -136,21 +106,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -username -Search string for username field - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -email Search string for email field @@ -166,8 +121,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -order -{{ Fill order Description }} +### -group_id +{{ Fill group_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific User ```yaml Type: String @@ -175,8 +145,8 @@ Parameter Sets: (All) Aliases: Required: False -Position: 9 -Default value: Desc +Position: 2 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -198,6 +168,21 @@ 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 @@ -213,17 +198,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -243,16 +243,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -username +Search string for username field ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 13 +Required: False +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeitLocation.md b/docs/Get-SnipeitLocation.md index 920baac..2c7ed5b 100644 --- a/docs/Get-SnipeitLocation.md +++ b/docs/Get-SnipeitLocation.md @@ -34,16 +34,31 @@ Get-SnipeItLocation -id 3 ## PARAMETERS -### -search -A text string to search the Locations data +### -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: False -Position: 1 +Required: True +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -64,21 +79,6 @@ 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,17 +111,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -all -A return all results, works with -offset and other parameters +### -order +{{ Fill order Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: 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 Accept pipeline input: False Accept wildcard characters: False ``` @@ -141,21 +156,6 @@ 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). diff --git a/docs/New-SnipeItAsset.md b/docs/New-SnipeItAsset.md index 0f5a2c6..d4057f8 100644 --- a/docs/New-SnipeItAsset.md +++ b/docs/New-SnipeItAsset.md @@ -48,21 +48,67 @@ Using customfields when creating asset. ## PARAMETERS -### -status_id -Required Status ID of the asset, this can be got using Get-Status +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo 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 ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: 6 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 @@ -93,66 +139,6 @@ 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 -``` - -### -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 -``` - -### -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 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -notes Optional Notes @@ -168,17 +154,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -warranty_months -{{ Fill warranty_months Description }} +### -order_number +Optional Order number ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: False -Position: 9 -Default value: 0 +Position: 7 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -213,21 +199,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -supplier_id -{{ Fill supplier_id Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 12 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -rtd_location_id Optional Default location id for the asset @@ -243,6 +214,51 @@ 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 }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url URL of Snipeit system, can be set using Set-SnipeItInfo command @@ -258,32 +274,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -warranty_months +{{ Fill warranty_months Description }} ```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 15 -Default value: None -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 +Type: Int32 Parameter Sets: (All) Aliases: Required: False -Position: 16 +Position: 9 +Default value: 0 +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 @@ -305,21 +320,6 @@ 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). diff --git a/docs/New-SnipeItAssetMaintenance.md b/docs/New-SnipeItAssetMaintenance.md index 39c2272..f49bac6 100644 --- a/docs/New-SnipeItAssetMaintenance.md +++ b/docs/New-SnipeItAssetMaintenance.md @@ -31,6 +31,21 @@ New-SnipeItAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" ## PARAMETERS +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command + +```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 @@ -46,21 +61,6 @@ 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,16 +76,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -title -Required Title of maintenance +### -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 ```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 @@ -106,61 +151,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -completion_date -{{ Fill completion_date Description }} +### -supplier_id +Required maintenance supplier ```yaml -Type: DateTime +Type: Int32 Parameter Sets: (All) Aliases: -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 +Required: True +Position: 2 Default value: 0 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 @@ -181,16 +196,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 11 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -212,21 +227,6 @@ 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). diff --git a/docs/New-SnipeItCategory.md b/docs/New-SnipeItCategory.md index a96c4fb..2d058df 100644 --- a/docs/New-SnipeItCategory.md +++ b/docs/New-SnipeItCategory.md @@ -29,8 +29,8 @@ New-SnipeItCategory -name "Laptops" -category_type asset -url "Snipe-IT URL here ## PARAMETERS -### -name -Name of new category to be created +### -apiKey +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -38,7 +38,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -59,6 +59,51 @@ 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-SnipeItInfo command @@ -74,21 +119,6 @@ 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 @@ -104,32 +134,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -require_acceptance -If switch is present, require users to confirm acceptance of assets in this category +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -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 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -150,21 +165,6 @@ 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). diff --git a/docs/New-SnipeItComponent.md b/docs/New-SnipeItComponent.md index 60910d3..2292692 100644 --- a/docs/New-SnipeItComponent.md +++ b/docs/New-SnipeItComponent.md @@ -30,8 +30,8 @@ An example ## PARAMETERS -### -name -Component name +### -apiKey +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -39,7 +39,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -60,21 +60,6 @@ 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 }} @@ -105,16 +90,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -purchase_date -Date accessory was purchased +### -name +Component name ```yaml -Type: DateTime +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: 6 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -135,6 +120,36 @@ 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-SnipeItInfo command @@ -150,16 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 9 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -181,21 +196,6 @@ 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). diff --git a/docs/New-SnipeItCustomField.md b/docs/New-SnipeItCustomField.md index 90f207a..b411e55 100644 --- a/docs/New-SnipeItCustomField.md +++ b/docs/New-SnipeItCustomField.md @@ -30,8 +30,8 @@ New-SnipeItCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I ## PARAMETERS -### -Name -Name of the Custom Field +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -39,14 +39,14 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpText -{{ Fill HelpText Description }} +### -CustomFormat +{{ Fill CustomFormat Description }} ```yaml Type: String @@ -54,7 +54,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -75,21 +75,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Format -{{ Fill Format Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: ANY -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -field_encrypted {{ Fill field_encrypted Description }} @@ -105,8 +90,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomFormat -{{ Fill CustomFormat Description }} +### -Format +{{ Fill Format Description }} ```yaml Type: String @@ -114,7 +99,37 @@ Parameter Sets: (All) Aliases: Required: False -Position: 6 +Position: 4 +Default value: ANY +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HelpText +{{ Fill HelpText Description }} + +```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 Custom Field + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -135,16 +150,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 8 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -166,21 +181,6 @@ 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). diff --git a/docs/New-SnipeItDepartment.md b/docs/New-SnipeItDepartment.md index 797b985..d582ff6 100644 --- a/docs/New-SnipeItDepartment.md +++ b/docs/New-SnipeItDepartment.md @@ -29,8 +29,8 @@ New-SnipeItDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager ## PARAMETERS -### -name -Department Name +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -38,7 +38,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -89,6 +89,21 @@ 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 }} @@ -119,16 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 7 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,21 +165,6 @@ 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). diff --git a/docs/New-SnipeItLicense.md b/docs/New-SnipeItLicense.md index 841736b..8de15ba 100644 --- a/docs/New-SnipeItLicense.md +++ b/docs/New-SnipeItLicense.md @@ -33,8 +33,8 @@ New-SnipeItLicence -name "License" -seats 3 -company_id 1 ## PARAMETERS -### -name -Name of license being created +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -42,27 +42,12 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 19 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 }} @@ -168,6 +153,21 @@ 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,6 +243,21 @@ 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 @@ -303,16 +318,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 19 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -334,21 +349,6 @@ 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). diff --git a/docs/New-SnipeItLocation.md b/docs/New-SnipeItLocation.md index 8f5f31f..d2c35e9 100644 --- a/docs/New-SnipeItLocation.md +++ b/docs/New-SnipeItLocation.md @@ -30,21 +30,6 @@ 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 @@ -75,16 +60,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -state -Address State 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: 4 +Required: True +Position: 11 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,8 +90,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -zip -The zip code of the location +### -ldap_ou +The LDAP OU of the location ```yaml Type: String @@ -114,7 +99,37 @@ Parameter Sets: (All) Aliases: Required: False -Position: 6 +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 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -135,23 +150,8 @@ 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 -``` - -### -ldap_ou -The LDAP OU of the location +### -state +Address State of the location ```yaml Type: String @@ -159,7 +159,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 9 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -180,16 +180,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -zip +The zip code of the location ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 11 +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 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -211,21 +226,6 @@ 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). diff --git a/docs/New-SnipeItManufacturer.md b/docs/New-SnipeItManufacturer.md index 50cd5e9..dc9236d 100644 --- a/docs/New-SnipeItManufacturer.md +++ b/docs/New-SnipeItManufacturer.md @@ -29,6 +29,21 @@ New-SnipeItManufacturer -name "HP" ## PARAMETERS +### -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 +``` + ### -Name Name of the Manufacturer @@ -59,16 +74,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 3 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -90,21 +105,6 @@ 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). diff --git a/docs/New-SnipeItModel.md b/docs/New-SnipeItModel.md index 105f39b..24d2ecc 100644 --- a/docs/New-SnipeItModel.md +++ b/docs/New-SnipeItModel.md @@ -30,8 +30,8 @@ New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1 ## PARAMETERS -### -name -Name of the Asset Model +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -39,22 +39,7 @@ Parameter Sets: (All) Aliases: Required: True -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 +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -75,21 +60,6 @@ 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 }} @@ -120,6 +90,51 @@ 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-SnipeItInfo command @@ -135,16 +150,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 8 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -166,21 +181,6 @@ 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). diff --git a/docs/New-SnipeItUser.md b/docs/New-SnipeItUser.md index 07eb6be..dd563e9 100644 --- a/docs/New-SnipeItUser.md +++ b/docs/New-SnipeItUser.md @@ -34,66 +34,6 @@ Creates new a new user who can't login to system ## PARAMETERS -### -first_name -Users first name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -last_name -Users last name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -username -Username for user - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -password -{{ Fill password Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -activated {{ Fill activated Description }} @@ -109,61 +49,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -notes -User Notes +### -apiKey +User's 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 -``` - -### -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 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 +Required: True +Position: 17 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -184,21 +79,6 @@ 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 @@ -214,17 +94,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -manager_id -ID number of manager +### -email +email address ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: False -Position: 13 -Default value: 0 +Position: 8 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -244,6 +124,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -first_name +Users first name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 +``` + +### -last_name +Users last name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ldap_import Mark user as import from ldap @@ -259,6 +184,81 @@ 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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -password +{{ Fill password Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -phone +Phone number + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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-SnipeItInfo command @@ -274,8 +274,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -username +Username for user ```yaml Type: String @@ -283,7 +283,22 @@ Parameter Sets: (All) Aliases: Required: True -Position: 17 +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 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -305,21 +320,6 @@ 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). diff --git a/docs/Remove-SnipeItAsset.md b/docs/Remove-SnipeItAsset.md index 8ac679c..a79edcc 100644 --- a/docs/Remove-SnipeItAsset.md +++ b/docs/Remove-SnipeItAsset.md @@ -28,6 +28,21 @@ Remove-SnipeItAsset -ID 44 -Verbose ## 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: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ID Unique ID For Asset to be removed @@ -58,16 +73,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 3 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -89,21 +104,6 @@ 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). diff --git a/docs/Remove-SnipeItUser.md b/docs/Remove-SnipeItUser.md index 891ffd5..22d52a1 100644 --- a/docs/Remove-SnipeItUser.md +++ b/docs/Remove-SnipeItUser.md @@ -28,6 +28,21 @@ Remove-SnipeItUser -ID 44 -url $url -apiKey $secret -Verbose ## 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: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ID Unique ID For User to be removed @@ -58,16 +73,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 3 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -89,21 +104,6 @@ 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). diff --git a/docs/Set-SnipeItAccessory.md b/docs/Set-SnipeItAccessory.md index 06e039a..3b10b76 100644 --- a/docs/Set-SnipeItAccessory.md +++ b/docs/Set-SnipeItAccessory.md @@ -31,51 +31,21 @@ Set-SnipeItAccessory -id 1 -qty 3 ## 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 -ID number of Accessory on Snipe-It system +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: 2 +Required: True +Position: 13 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 @@ -106,6 +76,21 @@ 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. @@ -121,6 +106,36 @@ 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. @@ -166,17 +181,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -min_qty -Min quantity of the accessory before alert is triggered +### -qty +Quantity of the accessory you have ```yaml -Type: Boolean +Type: Int32 Parameter Sets: (All) Aliases: Required: False -Position: 10 -Default value: False +Position: 3 +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -211,16 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 13 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -242,21 +257,6 @@ 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). diff --git a/docs/Set-SnipeItAsset.md b/docs/Set-SnipeItAsset.md index 4ad339a..d199e77 100644 --- a/docs/Set-SnipeItAsset.md +++ b/docs/Set-SnipeItAsset.md @@ -37,77 +37,33 @@ Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = ## PARAMETERS -### -id -ID of the Asset +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command ```yaml -Type: Int32 +Type: String 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: False -Position: 2 +Position: 17 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 +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: Required: 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 +Position: 14 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -142,8 +98,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -serial -Serial number of the asset +### -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 ```yaml Type: String @@ -151,7 +152,22 @@ Parameter Sets: (All) Aliases: Required: False -Position: 8 +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 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -172,21 +188,6 @@ 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 @@ -232,22 +233,6 @@ 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 @@ -263,6 +248,36 @@ 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-SnipeItInfoeItInfo command @@ -278,31 +293,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command +### -warranty_months +Number of months for the asset warranty ```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 17 -Default value: None -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 +Type: Int32 Parameter Sets: (All) Aliases: Required: False -Position: 18 +Position: 10 +Default value: 0 +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 @@ -324,21 +339,6 @@ 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). diff --git a/docs/Set-SnipeItAssetOwner.md b/docs/Set-SnipeItAssetOwner.md index 1d0dc2c..3b87adb 100644 --- a/docs/Set-SnipeItAssetOwner.md +++ b/docs/Set-SnipeItAssetOwner.md @@ -30,17 +30,17 @@ Set-SnipeItAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing ## PARAMETERS -### -id -Unique ID For asset to checkout +### -apiKey +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: True -Position: 1 -Default value: 0 +Position: 9 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -60,6 +60,21 @@ 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 }} @@ -75,6 +90,36 @@ 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, @@ -108,36 +153,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 -``` - -### -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-SnipeItInfo command @@ -153,16 +168,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 9 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -184,21 +199,6 @@ 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). diff --git a/docs/Set-SnipeItComponent.md b/docs/Set-SnipeItComponent.md index 52d0154..13aeb56 100644 --- a/docs/Set-SnipeItComponent.md +++ b/docs/Set-SnipeItComponent.md @@ -30,8 +30,8 @@ An example ## PARAMETERS -### -id -ID number of name +### -apiKey +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String @@ -39,37 +39,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 -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: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -name -Component name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -90,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -id +ID number of name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -location_id ID number of the location the accessory is assigned to @@ -105,16 +90,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -purchase_date -Date accessory was purchased +### -name +Component name ```yaml -Type: DateTime +Type: String Parameter Sets: (All) Aliases: Required: False -Position: 6 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -135,6 +120,36 @@ 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: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url URL of Snipeit system, can be set using Set-SnipeItInfo command @@ -150,16 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 9 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -181,21 +196,6 @@ 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). diff --git a/docs/Set-SnipeItInfo.md b/docs/Set-SnipeItInfo.md index 5f7c4bb..5af19dd 100644 --- a/docs/Set-SnipeItInfo.md +++ b/docs/Set-SnipeItInfo.md @@ -28,21 +28,6 @@ Set-SnipeItInfo -url $url -apiKey -Verbose ## PARAMETERS -### -url -URL of Snipeit system, can be set using Set-SnipeItInfo command - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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 @@ -58,6 +43,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -url +URL of Snipeit system, can be set using Set-SnipeItInfo command + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/Set-SnipeItLicense.md b/docs/Set-SnipeItLicense.md index 13416fb..8dfa8cc 100644 --- a/docs/Set-SnipeItLicense.md +++ b/docs/Set-SnipeItLicense.md @@ -33,51 +33,21 @@ Set-SnipeItLicence -name "License" -seats 3 -company_id 1 ## PARAMETERS -### -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 +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: 2 +Required: True +Position: 20 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 }} @@ -123,6 +93,21 @@ 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 @@ -183,6 +168,21 @@ 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,6 +258,21 @@ 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 @@ -318,16 +333,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 20 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -349,21 +364,6 @@ 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). diff --git a/docs/Set-SnipeItLicenseSeat.md b/docs/Set-SnipeItLicenseSeat.md index 3620715..0bbca1a 100644 --- a/docs/Set-SnipeItLicenseSeat.md +++ b/docs/Set-SnipeItLicenseSeat.md @@ -38,31 +38,31 @@ Checkout licence to asset id 3 ## PARAMETERS -### -id -Unique ID For asset to checkout +### -apiKey +User's API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: True -Position: 1 -Default value: 0 +Position: 7 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -seat_id -{{ Fill seat_id Description }} +### -asset_id +Id of target asset ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Required: True -Position: 2 +Required: False +Position: 4 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -83,16 +83,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -asset_id -Id of target asset +### -id +Unique ID For asset to checkout ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Required: False -Position: 4 +Required: True +Position: 1 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -113,6 +113,21 @@ 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 @@ -128,16 +143,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 7 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -159,21 +174,6 @@ 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). diff --git a/docs/Set-SnipeItModel.md b/docs/Set-SnipeItModel.md index 40c5277..816f4e0 100644 --- a/docs/Set-SnipeItModel.md +++ b/docs/Set-SnipeItModel.md @@ -30,46 +30,16 @@ New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1 ## PARAMETERS -### -id -ID number of the Asset Model +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml -Type: Int32 +Type: String 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: 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 +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -90,16 +60,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -manufacturer_id -Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer +### -custom_fieldset_id +{{ Fill custom_fieldset_id Description }} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: fieldset_id Required: False -Position: 5 +Position: 7 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -120,21 +90,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -custom_fieldset_id -{{ Fill custom_fieldset_id Description }} +### -id +ID number of the Asset Model ```yaml Type: Int32 Parameter Sets: (All) -Aliases: fieldset_id +Aliases: + +Required: True +Position: 1 +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: 7 +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-SnipeItInfo command @@ -150,16 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 9 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -181,21 +196,6 @@ 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). diff --git a/docs/Set-SnipeItUser.md b/docs/Set-SnipeItUser.md index 4bf1538..1b2f9e1 100644 --- a/docs/Set-SnipeItUser.md +++ b/docs/Set-SnipeItUser.md @@ -34,106 +34,31 @@ Updates user with id 3 ## PARAMETERS -### -id -{{ Fill id Description }} +### -activated +{{ Fill activated Description }} ```yaml -Type: Int32 +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-SnipeItInfo command + +```yaml +Type: String Parameter Sets: (All) Aliases: Required: True -Position: 1 -Default value: 0 -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 -``` - -### -last_name -Users last name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -userName -Username for user - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -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 -``` - -### -phone -Phone number - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 +Position: 16 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -154,21 +79,6 @@ 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 @@ -184,6 +94,111 @@ 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 }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +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 +``` + +### -last_name +Users last name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +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 @@ -199,36 +214,6 @@ 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 @@ -244,6 +229,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -phone +Phone number + +```yaml +Type: String +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-SnipeItInfo command @@ -259,16 +259,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeItInfo command +### -userName +Username for user ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 16 +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 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -290,21 +305,6 @@ 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). diff --git a/docs/Set-SnipeitLocation.md b/docs/Set-SnipeitLocation.md index 6f22496..8c9a0da 100644 --- a/docs/Set-SnipeitLocation.md +++ b/docs/Set-SnipeitLocation.md @@ -30,36 +30,6 @@ 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 @@ -90,16 +60,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -state -Address State +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeItInfo command ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: 5 +Required: True +Position: 12 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -120,31 +90,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -zip -Address zipcode - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -manager_id -Location manager as id +### -id +{{ Fill id Description }} ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Required: False -Position: 8 +Required: True +Position: 1 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -165,6 +120,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -manager_id +Location manager as id + +```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 Location + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -parent_id Parent location as id @@ -180,6 +165,21 @@ 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,16 +195,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeItInfo command +### -zip +Address zipcode ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 12 +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 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -226,21 +241,6 @@ 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). diff --git a/docs/SnipeItPS.md b/docs/SnipeItPS.md index 256e56d..2189f2f 100644 --- a/docs/SnipeItPS.md +++ b/docs/SnipeItPS.md @@ -12,122 +12,113 @@ Locale: en-US ## SnipeitPS Cmdlets ### [Get-SnipeItAccessory](Get-SnipeItAccessory.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Accessories ### [Get-SnipeItAsset](Get-SnipeItAsset.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Assets or specific asset ### [Get-SnipeItAssetMaintenance](Get-SnipeItAssetMaintenance.md) -{{ Fill in the Description }} +Lists Snipe-it Assets Maintenances ### [Get-SnipeItCategory](Get-SnipeItCategory.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Categories ### [Get-SnipeItCompany](Get-SnipeItCompany.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Companies ### [Get-SnipeItComponent](Get-SnipeItComponent.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Components ### [Get-SnipeItCustomField](Get-SnipeItCustomField.md) -{{ Fill in the Description }} +Returns specific Snipe-IT custom field or a list of all custom field ### [Get-SnipeItDepartment](Get-SnipeItDepartment.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Departments ### [Get-SnipeItFieldset](Get-SnipeItFieldset.md) -{{ Fill in the Description }} +Returns a fieldset or list of Snipe-it Fieldsets ### [Get-SnipeItLicense](Get-SnipeItLicense.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Licenses ### [Get-SnipeItLicenseSeat](Get-SnipeItLicenseSeat.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Licenses Seats or specific Seat ### [Get-SnipeitLocation](Get-SnipeitLocation.md) -{{ Fill in the Description }} - -### [Get-SnipeItManufacturer](Get-SnipeItManufacturer.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Locations ### [Get-SnipeItModel](Get-SnipeItModel.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Models ### [Get-SnipeItStatus](Get-SnipeItStatus.md) -{{ Fill in the Description }} - -### [Get-SnipeItSupplier](Get-SnipeItSupplier.md) -{{ Fill in the Description }} - -### [Get-SnipeItUser](Get-SnipeItUser.md) -{{ Fill in the Description }} +Gets a list of Snipe-it Status Labels ### [New-SnipeItAsset](New-SnipeItAsset.md) -{{ Fill in the Description }} +Add a new Asset to Snipe-it asset system ### [New-SnipeItAssetMaintenance](New-SnipeItAssetMaintenance.md) -{{ Fill in the Description }} +Add a new Asset maintenence to Snipe-it asset system ### [New-SnipeItCategory](New-SnipeItCategory.md) -{{ Fill in the Description }} +Create a new Snipe-IT Category ### [New-SnipeItComponent](New-SnipeItComponent.md) -{{ Fill in the Description }} +Create a new component ### [New-SnipeItCustomField](New-SnipeItCustomField.md) -{{ Fill in the Description }} +Add a new Custom Field to Snipe-it asset system ### [New-SnipeItDepartment](New-SnipeItDepartment.md) -{{ Fill in the Description }} +Creates a department ### [New-SnipeItLicense](New-SnipeItLicense.md) -{{ Fill in the Description }} +Creates a licence ### [New-SnipeItLocation](New-SnipeItLocation.md) -{{ Fill in the Description }} +Add a new Location to Snipe-it asset system ### [New-SnipeItManufacturer](New-SnipeItManufacturer.md) -{{ Fill in the Description }} +Add a new Manufacturer to Snipe-it asset system ### [New-SnipeItModel](New-SnipeItModel.md) -{{ Fill in the Description }} +Add a new Model to Snipe-it asset system ### [New-SnipeItUser](New-SnipeItUser.md) -{{ Fill in the Description }} +Creates a new user ### [Remove-SnipeItAsset](Remove-SnipeItAsset.md) -{{ Fill in the Description }} +Removes Asset from Snipe-it asset system ### [Remove-SnipeItUser](Remove-SnipeItUser.md) -{{ Fill in the Description }} +Removes User from Snipe-it asset system ### [Set-SnipeItAccessory](Set-SnipeItAccessory.md) -{{ Fill in the Description }} +Updates accessory on Snipe-It system ### [Set-SnipeItAsset](Set-SnipeItAsset.md) -{{ Fill in the Description }} +Update a specific Asset in the Snipe-it asset system ### [Set-SnipeItAssetOwner](Set-SnipeItAssetOwner.md) -{{ Fill in the Description }} +Checkout asset ### [Set-SnipeItComponent](Set-SnipeItComponent.md) -{{ Fill in the Description }} +Updates component ### [Set-SnipeItInfo](Set-SnipeItInfo.md) -{{ Fill in the Description }} +Sets authetication information ### [Set-SnipeItLicense](Set-SnipeItLicense.md) -{{ Fill in the Description }} +Updates a licence ### [Set-SnipeItLicenseSeat](Set-SnipeItLicenseSeat.md) -{{ Fill in the Description }} +Set license seat or checkout license seat ### [Set-SnipeitLocation](Set-SnipeitLocation.md) -{{ Fill in the Description }} +Updates Location in Snipe-it asset system ### [Set-SnipeItModel](Set-SnipeItModel.md) -{{ Fill in the Description }} +Updates Model on Snipe-it asset system ### [Set-SnipeItUser](Set-SnipeItUser.md) -{{ Fill in the Description }} +Creates a new user