From 6254b82e3a84709d771ff0abcfe7a204ac6888c8 Mon Sep 17 00:00:00 2001 From: Petri Asikainen Date: Mon, 14 Jun 2021 00:19:47 +0300 Subject: [PATCH 1/2] updated docs for v1.6.x --- CHANGELOG.md | 26 +++ SnipeitPS/SnipeitPS.psd1 | 2 +- appveyor.yml | 2 +- docs/New-SnipeitAccessory.md | 269 +++++++++++++++++++++++++ docs/New-SnipeitAudit.md | 132 ++++++++++++ docs/New-SnipeitCategory.md | 24 ++- docs/New-SnipeitCustomField.md | 73 +++++-- docs/Remove-SnipeitAssetMaintenance.md | 117 +++++++++++ docs/Remove-SnipeitCategory.md | 122 +++++++++++ docs/Remove-SnipeitCompany.md | 2 +- docs/Remove-SnipeitComponent.md | 4 +- docs/Remove-SnipeitDepartment.md | 2 +- docs/Remove-SnipeitManufacturer.md | 2 +- docs/Reset-SnipeitAssetOwner.md | 162 +++++++++++++++ docs/Set-SnipeitCategory.md | 208 +++++++++++++++++++ docs/Set-SnipeitCompany.md | 133 ++++++++++++ docs/Set-SnipeitCustomField.md | 239 ++++++++++++++++++++++ docs/Set-SnipeitDepartment.md | 193 ++++++++++++++++++ docs/Set-SnipeitStatus.md | 213 ++++++++++++++++++++ docs/SnipeitPS.md | 30 +++ 20 files changed, 1923 insertions(+), 32 deletions(-) create mode 100644 docs/New-SnipeitAccessory.md create mode 100644 docs/New-SnipeitAudit.md create mode 100644 docs/Remove-SnipeitAssetMaintenance.md create mode 100644 docs/Remove-SnipeitCategory.md create mode 100644 docs/Reset-SnipeitAssetOwner.md create mode 100644 docs/Set-SnipeitCategory.md create mode 100644 docs/Set-SnipeitCompany.md create mode 100644 docs/Set-SnipeitCustomField.md create mode 100644 docs/Set-SnipeitDepartment.md create mode 100644 docs/Set-SnipeitStatus.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f8459a..7333372 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,32 @@ 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/). +# [v.1.6.x] + +## Remove more things ja set some more + +### New features +Added some set and remove functions. Pipelineinput supported +for all remove functions. + +### New functions + - Remove-SnipeitAccessory + - Remove-SnipeitCategory + - Remove-SnipeitCompany + - Remove-SnipeitComponent + - Remove-SnipeitCustomField + - Remove-SnipeitDepartment + - Remove-SnipeitLicense + - Remove-SnipeitLocation + - Remove-SnipeitManufacturer + - Remove-SnipeitModel + - Set-SnipeitCategory + - Set-SnipeitCompany + - Set-SnipeitCustomField + - Set-SnipeitDepartment + - Set-SnipeitStatus + + # [v1.5.x] - 2021-06-08 ## Piping input diff --git a/SnipeitPS/SnipeitPS.psd1 b/SnipeitPS/SnipeitPS.psd1 index d24b9a9..a4828f5 100644 --- a/SnipeitPS/SnipeitPS.psd1 +++ b/SnipeitPS/SnipeitPS.psd1 @@ -12,7 +12,7 @@ RootModule = 'SnipeitPS' # Version number of this module. -ModuleVersion = '1.5' +ModuleVersion = '1.6' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/appveyor.yml b/appveyor.yml index fe7d763..c5a6038 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,7 +14,7 @@ environment: PSGalleryAPIKey: secure: UdM6qhf5B0G8liHhUrwWERCZr44iSqmg4jUq0lwlTjZs4KyeoiwnBzdej0phqIAm -version: 1.5.{build} +version: 1.6.{build} # Don't rebuild when I tag a release on GitHub skip_tags: true diff --git a/docs/New-SnipeitAccessory.md b/docs/New-SnipeitAccessory.md new file mode 100644 index 0000000..a9e27c1 --- /dev/null +++ b/docs/New-SnipeitAccessory.md @@ -0,0 +1,269 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# New-SnipeitAccessory + +## SYNOPSIS +Creates new accessory on Snipe-It system + +## SYNTAX + +``` +New-SnipeitAccessory [-name] [-qty] [-category_id] [[-company_id] ] + [[-manufacturer_id] ] [[-order_number] ] [[-purchase_cost] ] + [[-purchase_date] ] [[-min_qty] ] [[-supplier_id] ] [[-location_id] ] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates new accessory on Snipe-It system + +## EXAMPLES + +### EXAMPLE 1 +``` +New-SnipeitAccessory -name "Accessory" -qty 3 -category_id 1 +``` + +## PARAMETERS + +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeitInfo command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -category_id +ID number of the category the accessory belongs to + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +ID Number of the company the accessory is assigned to + +```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: 11 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manufacturer_id +ID number of the manufacturer for this accessory. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -min_qty +Min quantity of the accessory before alert is triggered + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Accessory name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order_number +Order number for this accessory. + +```yaml +Type: String +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 +``` + +### -purchase_date +Date accessory was purchased + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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: True +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -supplier_id +ID number of the supplier for this accessory + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +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: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/New-SnipeitAudit.md b/docs/New-SnipeitAudit.md new file mode 100644 index 0000000..5925779 --- /dev/null +++ b/docs/New-SnipeitAudit.md @@ -0,0 +1,132 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# New-SnipeitAudit + +## SYNOPSIS +Add a new Audit to Snipe-it asset system + +## SYNTAX + +``` +New-SnipeitAudit [-tag] [[-location_id] ] [-url] [-apiKey] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### EXAMPLE 1 +``` +New-SnipeitAudit -tag 1 -location_id 1 +``` + +## PARAMETERS + +### -apiKey +{{ Fill apiKey Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +ID of the location you want to associate with the audit + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -tag +The asset tag of the asset you wish to audit + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +{{ Fill url Description }} + +```yaml +Type: String +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/New-SnipeitCategory.md b/docs/New-SnipeitCategory.md index e5091da..beaa7dc 100644 --- a/docs/New-SnipeitCategory.md +++ b/docs/New-SnipeitCategory.md @@ -13,8 +13,9 @@ Create a new Snipe-IT Category ## SYNTAX ``` -New-SnipeitCategory [-name] [-category_type] [-url] [-apiKey] - [-use_default_eula] [-require_acceptance] [-checkin_email] [-WhatIf] [-Confirm] [] +New-SnipeitCategory [-name] [-category_type] [[-eula_text] ] [-use_default_eula] + [-require_acceptance] [-checkin_email] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -38,7 +39,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 4 +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -74,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -eula_text +This allows you to customize your EULAs for specific types of assets + +```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 new category to be created @@ -113,7 +129,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 3 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/New-SnipeitCustomField.md b/docs/New-SnipeitCustomField.md index 3c3dab4..e30a6ab 100644 --- a/docs/New-SnipeitCustomField.md +++ b/docs/New-SnipeitCustomField.md @@ -13,9 +13,9 @@ Add a new Custom Field to Snipe-it asset system ## SYNTAX ``` -New-SnipeitCustomField [-Name] [[-HelpText] ] [[-Element] ] [[-Format] ] - [[-field_encrypted] ] [[-CustomFormat] ] [-url] [-apiKey] [-WhatIf] - [-Confirm] [] +New-SnipeitCustomField [-name] [[-help_text] ] [-element] [-format] + [[-field_values] ] [[-field_encrypted] ] [[-show_in_email] ] + [[-custom_format] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,14 +39,14 @@ Parameter Sets: (All) Aliases: Required: True -Position: 8 +Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomFormat -{{ Fill CustomFormat Description }} +### -custom_format +In the case of format 'CUSTOM REGEX', this should be validation regex this field ```yaml Type: String @@ -54,29 +54,30 @@ Parameter Sets: (All) Aliases: Required: False -Position: 6 +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Element -{{ Fill Element Description }} +### -element +Form field type that should be displayed. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: 3 -Default value: Text +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -field_encrypted -{{ Fill field_encrypted Description }} +Whether the field should be encrypted. +(This can cause issues if you change it after the field was created.) ```yaml Type: Boolean @@ -84,14 +85,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 5 +Position: 6 Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Format -{{ Fill Format Description }} +### -field_values +In the case of list boxes, etc, this should be a list of the options available ```yaml Type: String @@ -99,14 +100,29 @@ Parameter Sets: (All) Aliases: Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -format +How the field should be validated + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True Position: 4 -Default value: ANY +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpText -{{ Fill HelpText Description }} +### -help_text +Any additional text you wish to display under the new form field to make it clearer what the gauges should be. ```yaml Type: String @@ -120,8 +136,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name of the Custom Field +### -name +The field's name, which is also the form label ```yaml Type: String @@ -135,6 +151,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -show_in_email +Whether or not to show the custom field in email notifications + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url URL of Snipeit system, can be set using Set-SnipeitInfo command @@ -144,7 +175,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Remove-SnipeitAssetMaintenance.md b/docs/Remove-SnipeitAssetMaintenance.md new file mode 100644 index 0000000..75f5e2f --- /dev/null +++ b/docs/Remove-SnipeitAssetMaintenance.md @@ -0,0 +1,117 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Remove-SnipeitAssetMaintenance + +## SYNOPSIS +Remove asset maintenance from Snipe-it asset system + +## SYNTAX + +``` +Remove-SnipeitAssetMaintenance [-id] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Removes asset maintenance event or events from Snipe-it asset system by ID + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-SnipeitAssetMaintenance -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 of the asset maintenance to be removed + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-SnipeitCategory.md b/docs/Remove-SnipeitCategory.md new file mode 100644 index 0000000..34734d6 --- /dev/null +++ b/docs/Remove-SnipeitCategory.md @@ -0,0 +1,122 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Remove-SnipeitCategory + +## SYNOPSIS +Removes category from Snipe-it asset system + +## SYNTAX + +``` +Remove-SnipeitCategory [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Removes category or multiple categories from Snipe-it asset system + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-SnipeitCategory -ID 44 -Verbose +``` + +### EXAMPLE 2 +``` +Get-SnipeitCategory -search something | Remove-SnipeitCategory +``` + +## 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 categoryto be removed + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-SnipeitCompany.md b/docs/Remove-SnipeitCompany.md index e771629..b1609af 100644 --- a/docs/Remove-SnipeitCompany.md +++ b/docs/Remove-SnipeitCompany.md @@ -29,7 +29,7 @@ Remove-SnipeitCompany -ID 44 -Verbose ### EXAMPLE 2 ``` -Get-SnipeitCompany -search "some corp" | Remove-SnipeitCompany +Get-SnipeitCompany | | Where-object {$_.name -like '*some*'} | Remove-SnipeitCompany ``` ## PARAMETERS diff --git a/docs/Remove-SnipeitComponent.md b/docs/Remove-SnipeitComponent.md index d664225..0e68c5a 100644 --- a/docs/Remove-SnipeitComponent.md +++ b/docs/Remove-SnipeitComponent.md @@ -18,7 +18,7 @@ Remove-SnipeitComponent [-id] [-URL] [-APIKey] [-Wha ``` ## DESCRIPTION -Removes comoponent or multiple components from Snipe-it asset system +Removes component or multiple components from Snipe-it asset system ## EXAMPLES @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### -id -Unique ID For component to be removed +{{ Fill id Description }} ```yaml Type: Int32[] diff --git a/docs/Remove-SnipeitDepartment.md b/docs/Remove-SnipeitDepartment.md index 5f61818..a2f99e3 100644 --- a/docs/Remove-SnipeitDepartment.md +++ b/docs/Remove-SnipeitDepartment.md @@ -29,7 +29,7 @@ Remove-SnipeitDepartment -ID 44 -Verbose ### EXAMPLE 2 ``` -Get-SnipeitDepartment -search head | Remove-SnipeitDepartment +Get-SnipeitDepartment | Where-object {$_.name -like '*head*'} | Remove-SnipeitDepartment ``` ## PARAMETERS diff --git a/docs/Remove-SnipeitManufacturer.md b/docs/Remove-SnipeitManufacturer.md index 2995b69..ab0a019 100644 --- a/docs/Remove-SnipeitManufacturer.md +++ b/docs/Remove-SnipeitManufacturer.md @@ -29,7 +29,7 @@ Remove-SnipeitManufacturer -ID 44 -Verbose ### EXAMPLE 2 ``` -Get-SnipeitManufacturer -search needle | Remove-SnipeitManufacturer +Get-SnipeitManufacturer | Where-object {$_.name -like '*something*'} | Remove-SnipeitManufacturer ``` ## PARAMETERS diff --git a/docs/Reset-SnipeitAssetOwner.md b/docs/Reset-SnipeitAssetOwner.md new file mode 100644 index 0000000..f901aeb --- /dev/null +++ b/docs/Reset-SnipeitAssetOwner.md @@ -0,0 +1,162 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Reset-SnipeitAssetOwner + +## SYNOPSIS +Checkin asset + +## SYNTAX + +``` +Reset-SnipeitAssetOwner [-id] [[-status_id] ] [[-location_id] ] [[-notes] ] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Checks asset in from current user/localtion/asset + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-SnipeitUser -ID 44 -url $url -apiKey $secret -Verbose +``` + +## PARAMETERS + +### -apiKey +User's API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +Unique ID For asset to checkin + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +Location id to change asset location to + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -notes +Notes about checkin + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -status_id +Change asset status to + +```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-SnipeitInfoeItInfo command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-SnipeitCategory.md b/docs/Set-SnipeitCategory.md new file mode 100644 index 0000000..a380ae5 --- /dev/null +++ b/docs/Set-SnipeitCategory.md @@ -0,0 +1,208 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-SnipeitCategory + +## SYNOPSIS +Create a new Snipe-IT Category + +## SYNTAX + +``` +Set-SnipeitCategory [-id] [[-name] ] [[-category_type] ] [[-eula_text] ] + [[-use_default_eula] ] [[-require_acceptance] ] [[-checkin_email] ] [-url] + [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Set-SnipeitCategory -id 4 -name "Laptops" +``` + +## 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: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -category_type +{{ Fill category_type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -checkin_email +Should the user be emailed the EULA and/or an acceptance confirmation email when this item is checked in? + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -eula_text +This allows you to customize your EULAs for specific types of assets + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +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: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Name of new category to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +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: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -use_default_eula +If switch is present, use the primary default EULA + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-SnipeitCompany.md b/docs/Set-SnipeitCompany.md new file mode 100644 index 0000000..53ee457 --- /dev/null +++ b/docs/Set-SnipeitCompany.md @@ -0,0 +1,133 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-SnipeitCompany + +## SYNOPSIS +Updates company name + +## SYNTAX + +``` +Set-SnipeitCompany [-id] [-name] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Updates companyt name on Snipe-It system + +## EXAMPLES + +### EXAMPLE 1 +``` +An example +``` + +## 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: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +ID number of company + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -name +Company name + +```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 + +```yaml +Type: String +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 +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 +General notes + +## RELATED LINKS diff --git a/docs/Set-SnipeitCustomField.md b/docs/Set-SnipeitCustomField.md new file mode 100644 index 0000000..78fe1f3 --- /dev/null +++ b/docs/Set-SnipeitCustomField.md @@ -0,0 +1,239 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-SnipeitCustomField + +## SYNOPSIS +Add a new Custom Field to Snipe-it asset system + +## SYNTAX + +``` +Set-SnipeitCustomField [-id] [[-name] ] [[-help_text] ] [-element] + [[-format] ] [[-field_values] ] [[-field_encrypted] ] [[-show_in_email] ] + [[-custom_format] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Add a new Custom Field to Snipe-it asset system + +## EXAMPLES + +### EXAMPLE 1 +``` +New-SnipeitCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset" +``` + +## 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 +``` + +### -custom_format +In the case of format 'CUSTOM REGEX', this should be validation regex this field + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -element +Form field type that should be displayed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -field_encrypted +Whether the field should be encrypted. +(This can cause issues if you change it after the field was created.) + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -field_values +In the case of list boxes, etc, this should be a list of the options available + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -format +How the field should be validated + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -help_text +Any additional text you wish to display under the new form field to make it clearer what the gauges should be. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +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: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -name +The field's name, which is also the form label + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -show_in_email +Whether or not to show the custom field in email notifications + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-SnipeitDepartment.md b/docs/Set-SnipeitDepartment.md new file mode 100644 index 0000000..0c0e0ae --- /dev/null +++ b/docs/Set-SnipeitDepartment.md @@ -0,0 +1,193 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-SnipeitDepartment + +## SYNOPSIS +Updates a department + +## SYNTAX + +``` +Set-SnipeitDepartment [-id] [[-name] ] [[-company_id] ] [[-location_id] ] + [[-manager_id] ] [[-notes] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Updates the department on Snipe-It system + +## EXAMPLES + +### EXAMPLE 1 +``` +Set-SnipeitDepartment -id 4 -manager_id 3 +``` + +## PARAMETERS + +### -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 +``` + +### -company_id +ID number of company + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +Id number of Department + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -location_id +ID number of location + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +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: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Department Name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -notes +{{ Fill notes Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +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: 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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-SnipeitStatus.md b/docs/Set-SnipeitStatus.md new file mode 100644 index 0000000..2e23b50 --- /dev/null +++ b/docs/Set-SnipeitStatus.md @@ -0,0 +1,213 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-SnipeitStatus + +## SYNOPSIS +Sets Snipe-it Status Labels + +## SYNTAX + +``` +Set-SnipeitStatus [-id] [[-name] ] [-type] [[-notes] ] [[-color] ] + [[-show_in_nav] ] [[-default_label] ] [-url] [-apiKey] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-SnipeitStatus -search "Ready to Deploy" +``` + +### EXAMPLE 2 +``` +Set-SnipeitStatus -id 3 -name 'Waiting for arrival' -type pending +``` + +## PARAMETERS + +### -apiKey +Users API Key for Snipeit, can be set using Set-SnipeitInfo command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -color +Hex code showing what color the status label should be on the pie chart in the dashboard + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -default_label +1 or 0 - determine whether it should be bubbled up to the top of the list of available statuses + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Status Label + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -notes +{{ Fill notes Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -show_in_nav +1 or 0 - determine whether the status label should show in the left-side nav of the web GUI + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -type +{{ Fill type Description }} + +```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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/SnipeitPS.md b/docs/SnipeitPS.md index 881a1d9..c9d02b2 100644 --- a/docs/SnipeitPS.md +++ b/docs/SnipeitPS.md @@ -59,12 +59,18 @@ Gets a list of Snipe-it Models ### [Get-SnipeitStatus](Get-SnipeitStatus.md) Gets a list of Snipe-it Status Labels +### [New-SnipeitAccessory](New-SnipeitAccessory.md) +Creates new accessory on Snipe-It system + ### [New-SnipeitAsset](New-SnipeitAsset.md) Add a new Asset to Snipe-it asset system ### [New-SnipeitAssetMaintenance](New-SnipeitAssetMaintenance.md) Add a new Asset maintenence to Snipe-it asset system +### [New-SnipeitAudit](New-SnipeitAudit.md) +Add a new Audit to Snipe-it asset system + ### [New-SnipeitCategory](New-SnipeitCategory.md) Create a new Snipe-IT Category @@ -98,6 +104,12 @@ Removes Accessory from Snipe-it asset system ### [Remove-SnipeitAsset](Remove-SnipeitAsset.md) Removes Asset from Snipe-it asset system +### [Remove-SnipeitAssetMaintenance](Remove-SnipeitAssetMaintenance.md) +Remove asset maintenance from Snipe-it asset system + +### [Remove-SnipeitCategory](Remove-SnipeitCategory.md) +Removes category from Snipe-it asset system + ### [Remove-SnipeitCompany](Remove-SnipeitCompany.md) Removes Company from Snipe-it asset system @@ -128,6 +140,9 @@ Removes User from Snipe-it asset system ### [Reset-SnipeitAccessoryOwner](Reset-SnipeitAccessoryOwner.md) Checkin accessories +### [Reset-SnipeitAssetOwner](Reset-SnipeitAssetOwner.md) +Checkin asset + ### [Set-SnipeitAccessory](Set-SnipeitAccessory.md) Updates accessory on Snipe-It system @@ -140,9 +155,21 @@ Update a specific Asset in the Snipe-it asset system ### [Set-SnipeitAssetOwner](Set-SnipeitAssetOwner.md) Checkout asset +### [Set-SnipeitCategory](Set-SnipeitCategory.md) +Create a new Snipe-IT Category + +### [Set-SnipeitCompany](Set-SnipeitCompany.md) +Updates company name + ### [Set-SnipeitComponent](Set-SnipeitComponent.md) Updates component +### [Set-SnipeitCustomField](Set-SnipeitCustomField.md) +Add a new Custom Field to Snipe-it asset system + +### [Set-SnipeitDepartment](Set-SnipeitDepartment.md) +Updates a department + ### [Set-SnipeitInfo](Set-SnipeitInfo.md) Sets authetication information @@ -158,6 +185,9 @@ Updates Location in Snipe-it asset system ### [Set-SnipeitModel](Set-SnipeitModel.md) Updates Model on Snipe-it asset system +### [Set-SnipeitStatus](Set-SnipeitStatus.md) +Sets Snipe-it Status Labels + ### [Set-SnipeitUser](Set-SnipeitUser.md) Creates a new user From bb00f1bc5ed80316d4cb2217b4dfa13c494c872c Mon Sep 17 00:00:00 2001 From: Petri Asikainen Date: Mon, 14 Jun 2021 00:21:12 +0300 Subject: [PATCH 2/2] updated docs for v1.6.x --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d3adc1d..294f257 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Set-SnipeitInfo -URL 'https://asset.example.com' -apiKey 'tokenKey' ```powershell # Review the help at any time! +Get-Help about_SnipeitPS Get-Command -Module SnipeitPS Get-Help Get-SnipeitAsset -Full # or any other command ```