mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-13 01:42:29 +00:00
Merge pull request #114 from PetriAsi/feature/prefix-commands
Updated docs and examples
This commit is contained in:
Petri Asikainen
GitHub
commit
8d1dd48b2c
80 changed files with 889 additions and 192 deletions
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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() {
|
||||
|
|
|
|||
|
|
@ -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(
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
|
|
|||
|
|
@ -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..."
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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" }
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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() {
|
||||
|
|
|
|||
|
|
@ -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() {
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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(
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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()
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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()
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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() {
|
||||
|
|
|
|||
|
|
@ -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()
|
||||
|
|
|
|||
|
|
@ -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()
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 ()
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
|
|
|
|||
|
|
@ -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 ()
|
||||
|
|
|
|||
|
|
@ -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(
|
||||
|
|
|
|||
|
|
@ -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() {
|
||||
|
|
|
|||
|
|
@ -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()
|
||||
|
|
|
|||
|
|
@ -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()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#>
|
||||
|
||||
|
|
|
|||
|
|
@ -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() {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -25,12 +25,12 @@ Gets a list of Snipe-it Accessories
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Accessory -search Keyboard
|
||||
Get-SnipeItAccessory -search Keyboard
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Accessory -id 1
|
||||
Get-SnipeItAccessory -id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -51,7 +51,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -203,7 +203,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -27,22 +27,22 @@ Get-SnipeItAsset [[-search] <String>] [[-id] <Int32>] [[-asset_tag] <String>] [[
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Asset -url "https://assets.example.com"-token "token..."
|
||||
Get-SnipeItAsset -url "https://assets.example.com"-token "token..."
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
|
||||
Get-SnipeItAsset -search "myMachine"-url "https://assets.example.com"-token "token..."
|
||||
```
|
||||
|
||||
### EXAMPLE 3
|
||||
```
|
||||
Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
|
||||
Get-SnipeItAsset -search "myMachine"-url "https://assets.example.com"-token "token..."
|
||||
```
|
||||
|
||||
### EXAMPLE 4
|
||||
```
|
||||
Get-Asset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
|
||||
Get-SnipeItAsset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -63,7 +63,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -350,7 +350,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,17 +24,17 @@ Get-SnipeItAssetMaintenance [[-search] <String>] [[-asset_id] <Int32>] [[-sort]
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-AssetMaintenances -url "https://assets.example.com" -token "token..."
|
||||
Get-SnipeItAssetMaintenances -url "https://assets.example.com" -token "token..."
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
|
||||
Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
|
||||
```
|
||||
|
||||
### EXAMPLE 3
|
||||
```
|
||||
Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
|
||||
Get-SnipeItAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..."
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -55,7 +55,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -162,7 +162,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@ Get-SnipeItCategory [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Category -id 1
|
||||
Get-SnipeItCategory -id 1
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Category -search "Laptop"
|
||||
Get-SnipeItCategory -search "Laptop"
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -50,7 +50,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -142,7 +142,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
Url of Snipeit system, can be set using Set-Info command
|
||||
Url of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,14 +24,14 @@ Get-SnipeItCompany [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-l
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Company
|
||||
Get-SnipeItCompany
|
||||
```
|
||||
|
||||
Gets all companies
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Company -id 1
|
||||
Get-SnipeItCompany -id 1
|
||||
```
|
||||
|
||||
Gets specific company
|
||||
|
|
@ -54,7 +54,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -146,7 +146,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -25,21 +25,21 @@ Get-SnipeItComponent [[-search] <String>] [[-id] <Int32>] [[-category_id] <Int32
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Component
|
||||
Get-SnipeItComponent
|
||||
```
|
||||
|
||||
Returns all components
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Component -search display
|
||||
Get-SnipeItComponent -search display
|
||||
```
|
||||
|
||||
Returns search results containeing string display
|
||||
|
||||
### EXAMPLE 3
|
||||
```
|
||||
Get-Component -id
|
||||
Get-SnipeItComponent -id
|
||||
```
|
||||
|
||||
Returns specific component
|
||||
|
|
@ -62,7 +62,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -214,7 +214,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
|
||||
|
|
|
|||
|
|
@ -23,13 +23,13 @@ Get-SnipeItCustomField [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<Comm
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Field -url "https://assets.example.com" -token "token..."
|
||||
Get-SnipeItCustomField -url "https://assets.example.com" -token "token..."
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -59,7 +59,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,17 +24,17 @@ Get-SnipeItDepartment [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Department -url "https://assets.example.com" -token "token..."
|
||||
Get-SnipeItDepartment -url "https://assets.example.com" -token "token..."
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Department -search Department1
|
||||
Get-SnipeItDepartment -search Department1
|
||||
```
|
||||
|
||||
### EXAMPLE 3
|
||||
```
|
||||
Get-Department -id 1
|
||||
Get-SnipeItDepartment -id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -55,7 +55,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -162,7 +162,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -23,18 +23,18 @@ Get-SnipeItFieldset [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonP
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Fieldset -url "https://assets.example.com" -token "token..."
|
||||
Get-SnipeItFieldset -url "https://assets.example.com" -token "token..."
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Fieldset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Windows" }
|
||||
Get-SnipeItFieldset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Windows" }
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -64,7 +64,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
|
||||
|
|
|
|||
351
docs/Get-SnipeItLicense.md
Normal file
351
docs/Get-SnipeItLicense.md
Normal file
|
|
@ -0,0 +1,351 @@
|
|||
---
|
||||
external help file: SnipeItPS-help.xml
|
||||
Module Name: SnipeitPS
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-SnipeItLicense
|
||||
|
||||
## SYNOPSIS
|
||||
Gets a list of Snipe-it Licenses
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Get-SnipeItLicense [[-search] <String>] [[-id] <Int32>] [[-name] <String>] [[-company_id] <Int32>]
|
||||
[[-product_key] <String>] [[-order_number] <Int32>] [[-purchase_order] <String>] [[-license_name] <String>]
|
||||
[[-license_email] <MailAddress>] [[-manufacturer_id] <Int32>] [[-supplier_id] <Int32>]
|
||||
[[-depreciation_id] <Int32>] [[-category_id] <Int32>] [[-order] <String>] [[-sort] <String>]
|
||||
[[-limit] <Int32>] [[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{ Fill in the Description }}
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-SnipeItLicense -search SomeLicense
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-SnipeItLicense -id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -all
|
||||
A return all results, works with -offset and other parameters
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 19
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -category_id
|
||||
{{ Fill category_id Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 13
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -company_id
|
||||
{{ Fill company_id Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 4
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -depreciation_id
|
||||
{{ Fill depreciation_id Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 12
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -id
|
||||
A id of specific License
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 2
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -license_email
|
||||
{{ Fill license_email Description }}
|
||||
|
||||
```yaml
|
||||
Type: MailAddress
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 9
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -license_name
|
||||
{{ Fill license_name Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 8
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -limit
|
||||
Specify the number of results you wish to return.
|
||||
Defaults to 50.
|
||||
Defines batch size for -all
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 16
|
||||
Default value: 50
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -manufacturer_id
|
||||
{{ Fill manufacturer_id Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 10
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -name
|
||||
{{ Fill name Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 3
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -offset
|
||||
Offset to use
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 17
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -order
|
||||
{{ Fill order Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 14
|
||||
Default value: Desc
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -order_number
|
||||
{{ Fill order_number Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 6
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -product_key
|
||||
{{ Fill product_key Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 5
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -purchase_order
|
||||
{{ Fill purchase_order Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 7
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -search
|
||||
A text string to search the Licenses data
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -sort
|
||||
{{ Fill sort Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 15
|
||||
Default value: Created_at
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -supplier_id
|
||||
{{ Fill supplier_id Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 11
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 18
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
## INPUTS
|
||||
|
||||
## OUTPUTS
|
||||
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
148
docs/Get-SnipeItLicenseSeat.md
Normal file
148
docs/Get-SnipeItLicenseSeat.md
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
---
|
||||
external help file: SnipeItPS-help.xml
|
||||
Module Name: SnipeitPS
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-SnipeItLicenseSeat
|
||||
|
||||
## SYNOPSIS
|
||||
Gets a list of Snipe-it Licenses Seats or specific Seat
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Get-SnipeItLicenseSeat [-id] <Int32> [[-seat_id] <Int32>] [[-limit] <Int32>] [[-offset] <Int32>] [-all]
|
||||
[-url] <String> [-apiKey] <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{ Fill in the Description }}
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-SnipeItLicenseSeat -id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -all
|
||||
A return all results, works with -offset and other parameters
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 6
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -id
|
||||
A id of specific License
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 1
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -limit
|
||||
Specify the number of results you wish to return.
|
||||
Defaults to 50.
|
||||
Defines batch size for -all
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 3
|
||||
Default value: 50
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -offset
|
||||
Offset to use
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 4
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -seat_id
|
||||
A id of specific seat
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 2
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 5
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
## INPUTS
|
||||
|
||||
## OUTPUTS
|
||||
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
|
@ -24,14 +24,14 @@ Get-SnipeItManufacturer [[-search] <String>] [[-id] <Int32>] [[-order] <String>]
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Manufacturer -search HP
|
||||
Get-SnipeItManufacturer -search HP
|
||||
```
|
||||
|
||||
Search all manufacturers for string HP
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Manufacturer -id 3
|
||||
Get-SnipeItManufacturer -id 3
|
||||
```
|
||||
|
||||
Returns manufacturer with id 3
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@ Get-SnipeItModel [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-lim
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Model -search "DL380"
|
||||
Get-SnipeItModel -search "DL380"
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Model -id 1
|
||||
Get-SnipeItModel -id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -50,7 +50,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -142,7 +142,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@ Get-SnipeItStatus [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-li
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Status -search "Ready to Deploy"
|
||||
Get-SnipeItStatus -search "Ready to Deploy"
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Status -id 3
|
||||
Get-SnipeItStatus -id 3
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -50,7 +50,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -142,7 +142,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@ Get-SnipeItSupplier [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Supplier -search MySupplier
|
||||
Get-SnipeItSupplier -search MySupplier
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Supplier -id 2
|
||||
Get-SnipeItSupplier -id 2
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
|
|||
|
|
@ -26,22 +26,22 @@ Get-SnipeItUser [[-search] <String>] [[-id] <String>] [[-company_id] <Int32>] [[
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-User -search SomeSurname
|
||||
Get-SnipeItUser -search SomeSurname
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-User -id 3
|
||||
Get-SnipeItUser -id 3
|
||||
```
|
||||
|
||||
### EXAMPLE 3
|
||||
```
|
||||
Get-User -username someuser
|
||||
Get-SnipeItUser -username someuser
|
||||
```
|
||||
|
||||
### EXAMPLE 4
|
||||
```
|
||||
Get-User -email user@somedomain.com
|
||||
Get-SnipeItUser -email user@somedomain.com
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
---
|
||||
---
|
||||
external help file: SnipeItPS-help.xml
|
||||
Module Name: SnipeitPS
|
||||
online version:
|
||||
|
|
@ -24,12 +24,12 @@ Get-SnipeitLocation [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Get-Location -search Location1
|
||||
Get-SnipeItLocation -search Location1
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Get-Location -id 3
|
||||
Get-SnipeItLocation -id 3
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
|
|||
|
|
@ -27,21 +27,21 @@ Long description
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Asset -status_id 1 -model_id 1 -name "Machine1"
|
||||
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1"
|
||||
```
|
||||
|
||||
Create asset with automatic tag if tag genaration is enabled on snipe-it, other wise without tag
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
New-Asset -status_id 1 -model_id 1 -name "Machine1" -asset_tag "DEV123"
|
||||
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1" -asset_tag "DEV123"
|
||||
```
|
||||
|
||||
Specifying asset tag when creating asset
|
||||
|
||||
### EXAMPLE 3
|
||||
```
|
||||
New-Asset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5" = "Windows 10 Pro" }
|
||||
New-SnipeItAsset -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5" = "Windows 10 Pro" }
|
||||
```
|
||||
|
||||
Using customfields when creating asset.
|
||||
|
|
@ -49,7 +49,7 @@ Using customfields when creating asset.
|
|||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -260,7 +260,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ Long description
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-AssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
|
||||
New-SnipeItAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" -start_date 2021-01-01
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -182,7 +182,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ New-SnipeItCategory [-name] <String> [-category_type] <String> [-url] <String> [
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Category -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
|
||||
New-SnipeItCategory -name "Laptops" -category_type asset -url "Snipe-IT URL here..." -apiKey "API key here..."
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -105,7 +105,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ An example
|
|||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -151,7 +151,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -25,13 +25,13 @@ Add a new Custom Field to Snipe-it asset system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Field -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
|
||||
New-SnipeItCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset"
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -136,7 +136,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ Creates a new department on Snipe-It system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Department -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
|
||||
New-SnipeItDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager_id 3
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -120,7 +120,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -28,13 +28,13 @@ Creates a new licence on Snipe-It system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Licence -name "License" -seats 3 -company_id 1
|
||||
New-SnipeItLicence -name "License" -seats 3 -company_id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -304,7 +304,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Long description
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Location -name "Room 1" -address "123 Asset Street" -parent_id 14
|
||||
New-SnipeItLocation -name "Room 1" -address "123 Asset Street" -parent_id 14
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
|
@ -61,7 +61,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -166,7 +166,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ Long description
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Manufacturer -name "HP"
|
||||
New-SnipeItManufacturer -name "HP"
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -60,7 +60,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -25,13 +25,13 @@ Long description
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
|
||||
New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -136,7 +136,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ Creates a new user to Snipe-IT system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-user -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
|
||||
New-SnipeItuser -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
|
||||
```
|
||||
|
||||
Creates new a new user who can't login to system
|
||||
|
|
@ -50,7 +50,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -260,7 +260,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ schema: 2.0.0
|
|||
# Remove-SnipeItAsset
|
||||
|
||||
## SYNOPSIS
|
||||
Removes Asset to Snipe-it asset system
|
||||
Removes Asset from Snipe-it asset system
|
||||
|
||||
## SYNTAX
|
||||
|
||||
|
|
@ -17,19 +17,19 @@ Remove-SnipeItAsset [-ID] <Int32> [-URL] <String> [-APIKey] <String> [-WhatIf] [
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Long description
|
||||
Removes Asset from Snipe-it asset system
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Remove-Asset -ID 44 -Verbose
|
||||
Remove-SnipeItAsset -ID 44 -Verbose
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -APIKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -59,7 +59,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -URL
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -23,13 +23,13 @@ Long description
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
|
||||
Remove-SnipeItUser -ID 44 -url $url -apiKey $secret -Verbose
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -APIKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -59,7 +59,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -URL
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ Updates accessory on Snipe-It system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Set-Accessory -id 1 -qty 3
|
||||
Set-SnipeItAccessory -id 1 -qty 3
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfoeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -212,7 +212,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -27,18 +27,18 @@ Long description
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1"
|
||||
Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1"
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
|
||||
Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" }
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfoeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -279,7 +279,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfoeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -25,13 +25,13 @@ Checkout asset to user/localtion/asset
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Remove-User -ID 44 -url $url -apiKey $secret -Verbose
|
||||
Set-SnipeItAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing check out to user"
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -154,7 +154,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ An example
|
|||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -151,7 +151,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -23,13 +23,13 @@ Set apikey and url user to connect Snipe-It system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Set-Info -url $url -apiKey -Verbose
|
||||
Set-SnipeItInfo -url $url -apiKey -Verbose
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -44,7 +44,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: Uri
|
||||
|
|
|
|||
|
|
@ -28,13 +28,13 @@ Updates licence on Snipe-It system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Set-Licence -name "License" -seats 3 -company_id 1
|
||||
Set-SnipeItLicence -name "License" -seats 3 -company_id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -319,7 +319,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
186
docs/Set-SnipeItLicenseSeat.md
Normal file
186
docs/Set-SnipeItLicenseSeat.md
Normal file
|
|
@ -0,0 +1,186 @@
|
|||
---
|
||||
external help file: SnipeItPS-help.xml
|
||||
Module Name: SnipeitPS
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Set-SnipeItLicenseSeat
|
||||
|
||||
## SYNOPSIS
|
||||
Set license seat or checkout license seat
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Set-SnipeItLicenseSeat [-id] <Int32> [-seat_id] <Int32> [[-assigned_id] <Int32>] [[-asset_id] <Int32>]
|
||||
[[-note] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Checkout specific license seat to user, asset or both
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Set-SnipeItLicenceSeat -ID 1 -seat_id 1 -assigned_id 3 -Verbose
|
||||
```
|
||||
|
||||
Checkout licence to user id 3
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Set-SnipeItLicenceSeat -ID 1 -seat_id 1 -asset_id 3 -Verbose
|
||||
```
|
||||
|
||||
Checkout licence to asset id 3
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 7
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -asset_id
|
||||
Id of target asset
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 4
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -assigned_id
|
||||
{{ Fill assigned_id Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 3
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -id
|
||||
Unique ID For asset to checkout
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 1
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -note
|
||||
Notes about checkout
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 5
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -seat_id
|
||||
{{ Fill seat_id Description }}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 2
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 6
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Confirm
|
||||
Prompts you for confirmation before running the cmdlet.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: cf
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -WhatIf
|
||||
Shows what would happen if the cmdlet runs.
|
||||
The cmdlet is not run.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: wi
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
## INPUTS
|
||||
|
||||
## OUTPUTS
|
||||
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
|
@ -25,13 +25,13 @@ Updates Model on Snipe-it asset system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
|
||||
New-SnipeItModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -apiKey
|
||||
Users API Key for Snipeit, can be set using Set-Info command
|
||||
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -151,7 +151,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ Creates a new user to Snipe-IT system
|
|||
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Update-user -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
|
||||
Update-SnipeItUser -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
|
||||
```
|
||||
|
||||
Updates user with id 3
|
||||
|
|
@ -50,7 +50,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -apiKey
|
||||
User's API Key for Snipeit, can be set using Set-Info command
|
||||
User's API Key for Snipeit, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -245,7 +245,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -url
|
||||
URL of Snipeit system, can be set using Set-Info command
|
||||
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
---
|
||||
---
|
||||
external help file: SnipeItPS-help.xml
|
||||
Module Name: SnipeitPS
|
||||
online version:
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Locale: en-US
|
|||
|
||||
# SnipeitPS Module
|
||||
## Description
|
||||
Powershell API for SnipeIt Asset Management
|
||||
{{ Fill in the Description }}
|
||||
|
||||
## SnipeitPS Cmdlets
|
||||
### [Get-SnipeItAccessory](Get-SnipeItAccessory.md)
|
||||
|
|
@ -38,6 +38,15 @@ Gets a list of Snipe-it Departments
|
|||
### [Get-SnipeItFieldset](Get-SnipeItFieldset.md)
|
||||
Returns a fieldset or list of Snipe-it Fieldsets
|
||||
|
||||
### [Get-SnipeItLicense](Get-SnipeItLicense.md)
|
||||
Gets a list of Snipe-it Licenses
|
||||
|
||||
### [Get-SnipeItLicenseSeat](Get-SnipeItLicenseSeat.md)
|
||||
Gets a list of Snipe-it Licenses Seats or specific Seat
|
||||
|
||||
### [Get-SnipeitLocation](Get-SnipeitLocation.md)
|
||||
Gets a list of Snipe-it Locations
|
||||
|
||||
### [Get-SnipeItModel](Get-SnipeItModel.md)
|
||||
Gets a list of Snipe-it Models
|
||||
|
||||
|
|
@ -78,7 +87,7 @@ Add a new Model to Snipe-it asset system
|
|||
Creates a new user
|
||||
|
||||
### [Remove-SnipeItAsset](Remove-SnipeItAsset.md)
|
||||
Removes Asset to Snipe-it asset system
|
||||
Removes Asset from Snipe-it asset system
|
||||
|
||||
### [Remove-SnipeItUser](Remove-SnipeItUser.md)
|
||||
Removes User from Snipe-it asset system
|
||||
|
|
@ -101,6 +110,9 @@ Sets authetication information
|
|||
### [Set-SnipeItLicense](Set-SnipeItLicense.md)
|
||||
Updates a licence
|
||||
|
||||
### [Set-SnipeItLicenseSeat](Set-SnipeItLicenseSeat.md)
|
||||
Set license seat or checkout license seat
|
||||
|
||||
### [Set-SnipeitLocation](Set-SnipeitLocation.md)
|
||||
Updates Location in Snipe-it asset system
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue