Merge pull request #109 from snazy2000/develop

Fixed missed aliases on parameter rename. Updated docs.

Author: PetriAsi

CHANGELOG.md

@@ -5,4 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/),
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0] - 2017-11-18
+# [v1.1.x] - 2021-05-18
+
+## Pull request rollup release. Lots of new features including:
+
+### New features
+- Powershell 7 compatibility. So you can use SnipeItPS on macos or linux .
+- Get every asset, model, licence with snipeit id by using -id parameter
+- Get assets also by -asset_tag -or serialnumber
+- Get functions also return all results from snipe when using -all parameter (by @PetriAsi)
+
+### New functions
+- Reset-AssetOwner by @lunchboxrts
+- Remove-Asset by @sheppyh
+- Added Remove-AssetMaintenance by @sheppyh
+- Remove-User @gvoynov
+
+### Fixes
+- Fixed version number on powershell gallery
+- Fixed Set-AssetOwner when checking asset out to an other asset.
+
+## [v1.0] - 2017-11-18

README.md

@@ -32,3 +32,6 @@ Get-Help about_SnipeitPS
 Get-Command -Module SnipeitPS
 Get-Help Get-Asset -Full   # or any other command
 ```
+### Reporting bugs and issues
+Please use -Verbose switch with command you have problem with.
+Then create ticket here with all -Verbose output

SnipeitPS/Public/Get-Accessory.ps1

@@ -1,6 +1,9 @@
 <#
 .SYNOPSIS
-# Gets a list of Snipe-it Accessories
+Gets a list of Snipe-it Accessories
+
+.DESCRIPTION
+Gets a list of Snipe-it Accessories
 
 .PARAMETER search
 A text string to search the Accessory data
@@ -12,7 +15,7 @@ A id of specific Accessory
 Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all
 
 .PARAMETER offset
-Offset to use
+Result offset to use
 
 .PARAMETER all
 A return all results, works with -offset and other parameters
@@ -24,12 +27,13 @@ URL of Snipeit system, can be set using Set-Info command
 Users API Key for Snipeit, can be set using Set-Info command
 
 .EXAMPLE
-Get-Accessory -url "https://assets.example.com" -token "token..."
+Get-Accessory -search Keyboard
 
 .EXAMPLE
-Get-Accessory -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "HP" }
+Get-Accessory -id 1
 
 #>
+
 function Get-Accessory() {
     Param(
         [string]$search,

SnipeitPS/Public/Get-Asset.ps1

@@ -1,18 +1,18 @@
 <#
 .SYNOPSIS
- Gets a list of Snipe-it Assets
+Gets a list of Snipe-it Assets or specific asset
 
 .PARAMETER search
 A text string to search the assets data
 
 .PARAMETER id
-A text string to search the assets data
+ID number of excact snipeit asset
 
 .PARAMETER asset_tag
-Specify exact asset tag to query
+Exact asset tag to query
 
 .PARAMETER asset_serial
-Specify exact asset serial to query
+Exact asset serialnumber to query
 
 .PARAMETER order_number
 Optionally restrict asset results to this order number
@@ -71,6 +71,7 @@ Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..."
 .EXAMPLE
 Get-Asset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..."
 #>
+
 function Get-Asset() {
     Param(
         [string]$search,

SnipeitPS/Public/Get-AssetMaintenance.ps1

@@ -1,12 +1,12 @@
 <#
 .SYNOPSIS
- Gets a list of Snipe-it Assets
+Lists Snipe-it Assets Maintenances
 
 .PARAMETER asset_id
-
+Asset ID of the asset you'd like to return maintenances for
 
 .PARAMETER search
-A text string to search the assets data
+Search string
 
 .PARAMETER sort
 Specify the column name you wish to sort by

SnipeitPS/Public/Get-Category.ps1

@@ -1,6 +1,6 @@
 <#
 .SYNOPSIS
-# Gets a list of Snipe-it Categories
+Gets a list of Snipe-it Categories
 
 .PARAMETER search
 A text string to search the Categories data
@@ -18,16 +18,16 @@ Offset to use
 A return all results, works with -offset and other parameters
 
 .PARAMETER url
-URL of Snipeit system, can be set using Set-Info command
+Url of Snipeit system, can be set using Set-Info command
 
 .PARAMETER apiKey
 Users API Key for Snipeit, can be set using Set-Info command
 
 .EXAMPLE
-Get-Category -url "https://assets.example.com" -token "token..."
+Get-Category -id 1
 
 .EXAMPLE
-Get-Category -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Laptop" }
+Get-Category -search "Laptop"
 
 #>
 

SnipeitPS/Public/Get-Company.ps1

@@ -1,6 +1,6 @@
 <#
 .SYNOPSIS
-# Gets a list of Snipe-it Companies
+Gets a list of Snipe-it Companies
 
 .PARAMETER search
 A text string to search the Companies data
@@ -16,18 +16,19 @@ Offset to use
 
 .PARAMETER all
 A return all results, works with -offset and other parameters
-
 .PARAMETER url
 URL of Snipeit system, can be set using Set-Info command
 
 .PARAMETER apiKey
 Users API Key for Snipeit, can be set using Set-Info command
 
 .EXAMPLE
-Get-Company -url "https://assets.example.com" -token "token..."
+Get-Company
+Gets all companies
 
 .EXAMPLE
-Get-Company -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Company1" }
+Get-Company -id 1
+Gets specific company
 
 #>
 

SnipeitPS/Public/Get-Component.ps1

@@ -1,6 +1,6 @@
 <#
 .SYNOPSIS
-# Gets a list of Snipe-it Components
+Gets a list of Snipe-it Components
 
 .PARAMETER search
 A text string to search the Components data
@@ -18,16 +18,22 @@ Offset to use
 A return all results, works with -offset and other parameters
 
 .PARAMETER url
-URL of Snipeit system, can be set using Set-Info command
+URL of Snipeit system,can be set using Set-Info command
 
 .PARAMETER apiKey
 Users API Key for Snipeit, can be set using Set-Info command
 
 .EXAMPLE
-Get-Component -url "https://assets.example.com" -token "token..."
+Get-Component
+Returns all components
 
 .EXAMPLE
-Get-Component -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Memory" }
+Get-Component -search display
+Returns search results containeing string display
+
+.EXAMPLE
+Get-Component -id
+Returns specific component
 
 #>
 

SnipeitPS/Public/Get-CustomField.ps1

@@ -1,15 +1,15 @@
 <#
-.SYNOPSIS
-# Returns a list of all Snipe-IT custom fields
+    .SYNOPSIS
+    Returns a list of all Snipe-IT custom fields
 
-.PARAMETER url
-URL of Snipeit system, can be set using Set-Info command
+    .PARAMETER url
+    URL of Snipeit system, can be set using Set-Info command
 
-.PARAMETER apiKey
-Users API Key for Snipeit, can be set using Set-Info command
+    .PARAMETER apiKey
+    Users API Key for Snipeit, can be set using Set-Info command
 
-.EXAMPLE
-Get-Field -url "https://assets.example.com" -token "token..."
+    .EXAMPLE
+    Get-Field -url "https://assets.example.com" -token "token..."
 
 #>
 

SnipeitPS/Public/Get-Department.ps1

@@ -1,6 +1,6 @@
 <#
 .SYNOPSIS
-# Gets a list of Snipe-it Departments
+Gets a list of Snipe-it Departments
 
 .PARAMETER search
 A text string to search the Departments data
@@ -27,7 +27,10 @@ Users API Key for Snipeit, can be set using Set-Info command
 Get-Department -url "https://assets.example.com" -token "token..."
 
 .EXAMPLE
-Get-Department -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Department1" }
+Get-Department -search  Department1
+
+.EXAMPLE
+Get-Department -id 1
 
 #>