From 5d945b9327f8d7078badecdd486dc870438e0ff2 Mon Sep 17 00:00:00 2001 From: Petri Asikainen Date: Tue, 18 May 2021 05:57:40 +0300 Subject: [PATCH] update docs with platyps --- docs/Get-Accessory.md | 229 +++++++++++++++++++++ docs/Get-Asset.md | 359 +++++++++++++++++++++------------ docs/Get-AssetMaintenance.md | 188 +++++++++++++++++ docs/Get-Category.md | 132 +++++++++--- docs/Get-Company.md | 132 +++++++++--- docs/Get-Component.md | 201 +++++++++++++++--- docs/Get-CustomField.md | 70 +++++++ docs/Get-Department.md | 155 +++++++++++--- docs/Get-Fieldset.md | 75 +++++++ docs/Get-Manufacturer.md | 132 +++++++++--- docs/Get-Model.md | 136 ++++++++++--- docs/Get-SnipeitLocation.md | 168 +++++++++++++++ docs/Get-Status.md | 132 +++++++++--- docs/Get-Supplier.md | 132 +++++++++--- docs/Get-User.md | 206 +++++++++++++++++-- docs/New-Asset.md | 281 +++++++++++++++++++------- docs/New-AssetMaintenance.md | 244 ++++++++++++++++++++++ docs/New-Category.md | 177 ++++++++++++++++ docs/New-Component.md | 132 ++++++++---- docs/New-CustomField.md | 193 ++++++++++++++++++ docs/New-Department.md | 92 +++++---- docs/New-License.md | 366 +++++++++++++++++++++++++++++++++ docs/New-Location.md | 244 +++++++++++++--------- docs/New-Manufacturer.md | 55 +++-- docs/New-Model.md | 114 +++++++---- docs/New-User.md | 299 +++++++++++++++------------ docs/Remove-Asset.md | 116 +++++++++++ docs/Remove-User.md | 116 +++++++++++ docs/Set-Accessory.md | 274 +++++++++++++++++++++++++ docs/Set-Asset.md | 305 +++++++++++++++++++++------- docs/Set-AssetOwner.md | 160 ++++++++------- docs/Set-Component.md | 128 ++++++------ docs/Set-Info.md | 12 +- docs/Set-License.md | 381 +++++++++++++++++++++++++++++++++++ docs/Set-Model.md | 213 ++++++++++++++++++++ docs/Set-SnipeitLocation.md | 253 +++++++++++++++++++++++ docs/Set-User.md | 335 +++++++++++++++--------------- docs/SnipeItPS.md | 79 ++++++++ 38 files changed, 5820 insertions(+), 1196 deletions(-) create mode 100644 docs/Get-Accessory.md create mode 100644 docs/Get-AssetMaintenance.md create mode 100644 docs/Get-CustomField.md create mode 100644 docs/Get-Fieldset.md create mode 100644 docs/Get-SnipeitLocation.md create mode 100644 docs/New-AssetMaintenance.md create mode 100644 docs/New-Category.md create mode 100644 docs/New-CustomField.md create mode 100644 docs/New-License.md create mode 100644 docs/Remove-Asset.md create mode 100644 docs/Remove-User.md create mode 100644 docs/Set-Accessory.md create mode 100644 docs/Set-License.md create mode 100644 docs/Set-Model.md create mode 100644 docs/Set-SnipeitLocation.md create mode 100644 docs/SnipeItPS.md diff --git a/docs/Get-Accessory.md b/docs/Get-Accessory.md new file mode 100644 index 0000000..bb975e1 --- /dev/null +++ b/docs/Get-Accessory.md @@ -0,0 +1,229 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Get-Accessory + +## SYNOPSIS +# Gets a list of Snipe-it Accessories + +## SYNTAX + +``` +Get-Accessory [[-search] ] [[-company_id] ] [[-category_id] ] + [[-manufacturer_id] ] [[-supplier_id] ] [[-sort] ] [[-order] ] + [[-limit] ] [[-offset] ] [-all] [-url] [-apiKey] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-Accessory -url "https://assets.example.com" -token "token..." +``` + +### EXAMPLE 2 +``` +Get-Accessory -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "HP" } +``` + +## PARAMETERS + +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 11 +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: 3 +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: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -limit +Specify the number of results you wish to return. +Defaults to 50. +Defines batch size for -all + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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: 4 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -offset +Offset to use + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +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: 7 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Accessory data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -sort +{{ Fill sort Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: Created_at +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -supplier_id +{{ Fill supplier_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-Asset.md b/docs/Get-Asset.md index 3c992bd..a548017 100644 --- a/docs/Get-Asset.md +++ b/docs/Get-Asset.md @@ -1,138 +1,119 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: +Module Name: SnipeitPS +online version: schema: 2.0.0 --- # Get-Asset ## SYNOPSIS -# Gets a list of Snipe-it Assets +Gets a list of Snipe-it Assets ## SYNTAX ``` -Get-Asset [[-search] ] [[-order_number] ] [[-model_id] ] [[-category_id] ] - [[-manufacturer_id] ] [[-company_id] ] [[-location_id] ] [[-status] ] - [[-status_id] ] [[-sort] ] [[-order] ] [[-limit] ] [[-offset] ] - [-url] [-apiKey] +Get-Asset [[-search] ] [[-id] ] [[-asset_tag] ] [[-asset_serial] ] + [[-order_number] ] [[-model_id] ] [[-category_id] ] [[-manufacturer_id] ] + [[-company_id] ] [[-location_id] ] [[-depreciation_id] ] [[-requestable] ] + [[-status] ] [[-status_id] ] [[-sort] ] [[-order] ] [[-limit] ] + [[-offset] ] [-all] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` -Get-Asset -url "https://assets.example.com" -token "token..." +Get-Asset -url "https://assets.example.com"-token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` -Get-Asset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MyMachine" } +Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..." +``` + +### EXAMPLE 3 +``` +Get-Asset -search "myMachine"-url "https://assets.example.com"-token "token..." +``` + +### EXAMPLE 4 +``` +Get-Asset -asset_tag "myAssetTag"-url "https://assets.example.com"-token "token..." ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: -Required: False -Position: 1 +Required: True +Position: 20 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -order_number -{{Fill order_number Description}} +### -asset_serial +Specify exact asset serial to query ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 2 -Default value: 0 +Position: 4 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -model_id -{{Fill model_id Description}} +### -asset_tag +Specify exact asset tag to query ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 3 -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -category_id -{{Fill category_id Description}} +Optionally restrict asset results to this category ID ```yaml Type: Int32 Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -manufacturer_id -{{Fill manufacturer_id Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -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: 6 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -location_id -{{Fill location_id Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 7 @@ -141,28 +122,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -status -{{Fill status Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -status_id -{{Fill status_id Description}} +### -company_id +Optionally restrict asset results to this company ID ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 9 @@ -171,61 +137,213 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -sort -{{Fill sort Description}} +### -depreciation_id +{{ Fill depreciation_id Description }} ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 10 -Default value: Created_at +Position: 11 +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -order -{{Fill order Description}} +### -id +A text string to search the assets data ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 11 -Default value: Desc +Position: 2 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -limit -{{Fill limit Description}} +Specify the number of results you wish to return. +Defaults to 50. +Defines batch size for -all ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 12 +Position: 17 Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` -### -offset -{{Fill offset Description}} +### -location_id +Optionally restrict asset results to this location ID ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: + +Required: False +Position: 10 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manufacturer_id +Optionally restrict asset results to this manufacturer ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -model_id +Optionally restrict asset results to this asset model ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -offset +Offset to use + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 18 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order +Specify the order (asc or desc) you wish to order by on your sort column + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 16 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order_number +Optionally restrict asset results to this order number + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -requestable +{{ Fill requestable Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the assets data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -sort +Specify the column name you wish to sort by + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: Created_at +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -status +Optionally restrict asset results to one of these status types: RTD, Deployed, Undeployable, Deleted, Archived, Requestable + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -status_id +Optionally restrict asset results to this status label ID + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -237,29 +355,17 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 14 +Position: 19 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 15 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### 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 @@ -268,4 +374,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-AssetMaintenance.md b/docs/Get-AssetMaintenance.md new file mode 100644 index 0000000..83deee3 --- /dev/null +++ b/docs/Get-AssetMaintenance.md @@ -0,0 +1,188 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Get-AssetMaintenance + +## SYNOPSIS +Gets a list of Snipe-it Assets + +## SYNTAX + +``` +Get-AssetMaintenance [[-search] ] [[-asset_id] ] [[-sort] ] [[-order] ] + [[-limit] ] [-all] [[-offset] ] [-url] [-apiKey] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-AssetMaintenances -url "https://assets.example.com" -token "token..." +``` + +### EXAMPLE 2 +``` +Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..." +``` + +### EXAMPLE 3 +``` +Get-AssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..." +``` + +## PARAMETERS + +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -asset_id +{{ Fill asset_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -limit +Specify the number of results you wish to return. +Defaults to 50. +Defines batch size for -all + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +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: 6 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order +Specify the order (asc or desc) you wish to order by on your sort column + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the assets data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -sort +Specify the column name you wish to sort by + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: Created_at +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-Category.md b/docs/Get-Category.md index 4432464..cd21b3d 100644 --- a/docs/Get-Category.md +++ b/docs/Get-Category.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,33 +13,126 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Category [[-search] ] [-url] [-apiKey] +Get-Category [[-search] ] [[-id] ] [[-order] ] [[-limit] ] [[-offset] ] + [-all] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-Category -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-Category -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Laptop" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Category + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Categories data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 1 @@ -54,29 +147,17 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### 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 @@ -85,4 +166,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-Company.md b/docs/Get-Company.md index 023e7e1..1b13b0f 100644 --- a/docs/Get-Company.md +++ b/docs/Get-Company.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,33 +13,126 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Company [[-search] ] [-url] [-apiKey] +Get-Company [[-search] ] [[-id] ] [[-order] ] [[-limit] ] [[-offset] ] + [-all] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-Company -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-Company -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Company1" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Company + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Companies data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 1 @@ -54,29 +147,17 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### 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 @@ -85,4 +166,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-Component.md b/docs/Get-Component.md index 2dc00ee..98723e7 100644 --- a/docs/Get-Component.md +++ b/docs/Get-Component.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,52 +13,39 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Component [[-search] ] [-url] [-apiKey] +Get-Component [[-search] ] [[-id] ] [[-category_id] ] [[-company_id] ] + [[-location_id] ] [[-order] ] [[-sort] ] [[-limit] ] [[-offset] ] [-all] + [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-Component -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-Component -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Memory" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -url -URL of Snipeit system, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -69,15 +56,170 @@ Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 3 +Position: 11 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: 3 +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 +``` + +### -id +A id of specific Component + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 8 +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +{{ Fill location_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -offset +Offset to use + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order +{{ Fill order Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Components data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -sort +{{ Fill sort Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: Created_at +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 10 +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 @@ -85,4 +227,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-CustomField.md b/docs/Get-CustomField.md new file mode 100644 index 0000000..0cadf98 --- /dev/null +++ b/docs/Get-CustomField.md @@ -0,0 +1,70 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Get-CustomField + +## SYNOPSIS +# Returns a list of all Snipe-IT custom fields + +## SYNTAX + +``` +Get-CustomField [-url] [-apiKey] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-Field -url "https://assets.example.com" -token "token..." +``` + +## PARAMETERS + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command + +```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-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-Department.md b/docs/Get-Department.md index a705897..f5fd892 100644 --- a/docs/Get-Department.md +++ b/docs/Get-Department.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,52 +13,38 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Department [[-search] ] [-url] [-apiKey] +Get-Department [[-search] ] [[-id] ] [[-order] ] [[-limit] ] [[-offset] ] + [-all] [[-sort] ] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-Department -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-Department -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Department1" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -url -URL of Snipeit system, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -69,15 +55,125 @@ Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 3 +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -id +A id of specific Department + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Departments data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -sort +{{ Fill sort Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: Created_at +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -85,4 +181,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-Fieldset.md b/docs/Get-Fieldset.md new file mode 100644 index 0000000..0f19150 --- /dev/null +++ b/docs/Get-Fieldset.md @@ -0,0 +1,75 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Get-Fieldset + +## SYNOPSIS +# Gets a list of Snipe-it Fieldsets + +## SYNTAX + +``` +Get-Fieldset [-url] [-apiKey] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-Fieldset -url "https://assets.example.com" -token "token..." +``` + +### EXAMPLE 2 +``` +Get-Fieldset -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 + +```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-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-Manufacturer.md b/docs/Get-Manufacturer.md index 1665104..f6077f0 100644 --- a/docs/Get-Manufacturer.md +++ b/docs/Get-Manufacturer.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: http://go.microsoft.com/fwlink/?LinkId=821589 +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,33 +13,126 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Manufacturer [[-search] ] [-url] [-apiKey] +Get-Manufacturer [[-search] ] [[-id] ] [[-order] ] [[-limit] ] + [[-offset] ] [-all] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-Manufacturer -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-Manufacturer -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "HP" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Manufactuter + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Manufactures data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 1 @@ -54,29 +147,17 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### 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 @@ -85,4 +166,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-Model.md b/docs/Get-Model.md index 8292c0a..c85c244 100644 --- a/docs/Get-Model.md +++ b/docs/Get-Model.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: http://go.microsoft.com/fwlink/?LinkId=821589 +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,33 +13,126 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Model [[-search] ] [-url] [-apiKey] +Get-Model [[-search] ] [[-id] ] [[-order] ] [[-limit] ] [[-offset] ] + [-all] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` -Get-Models -url "https://assets.example.com" -token "token..." +Get-Model -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` -Get-Models -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "DL380" } +Get-Model -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "DL380" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific model + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -limit +Specify the number of results you wish to return. +Defaults to 50. +Defines batch size for -all + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Models data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 1 @@ -54,29 +147,17 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### 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 @@ -85,4 +166,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-SnipeitLocation.md b/docs/Get-SnipeitLocation.md new file mode 100644 index 0000000..7a90dc0 --- /dev/null +++ b/docs/Get-SnipeitLocation.md @@ -0,0 +1,168 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Get-SnipeitLocation + +## SYNOPSIS +# Gets a list of Snipe-it Locations + +## SYNTAX + +``` +Get-SnipeitLocation [[-search] ] [[-id] ] [[-order] ] [[-limit] ] + [[-offset] ] [-all] [-url] [-apiKey] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-Location -url "https://assets.example.com" -token "token..." +``` + +### EXAMPLE 2 +``` +Get-Location -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Location1" } +``` + +## PARAMETERS + +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Location + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Locations data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-Status.md b/docs/Get-Status.md index fb81f34..1f402b8 100644 --- a/docs/Get-Status.md +++ b/docs/Get-Status.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: http://go.microsoft.com/fwlink/?LinkId=821589 +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,33 +13,126 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Status [[-search] ] [-url] [-apiKey] +Get-Status [[-search] ] [[-id] ] [[-order] ] [[-limit] ] [[-offset] ] + [-all] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-Status -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-Status -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Ready to Deploy" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Status Label + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Status Labels data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 1 @@ -54,29 +147,17 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### 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 @@ -85,4 +166,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-Supplier.md b/docs/Get-Supplier.md index 07e5e99..2ed9a81 100644 --- a/docs/Get-Supplier.md +++ b/docs/Get-Supplier.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: http://go.microsoft.com/fwlink/?LinkId=821589 +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,33 +13,126 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Supplier [[-search] ] [-url] [-apiKey] +Get-Supplier [[-search] ] [[-id] ] [[-order] ] [[-limit] ] [[-offset] ] + [-all] [-url] [-apiKey] [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-Supplier -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-Supplier -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MySupplier" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Suplier + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 4 +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: 5 +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: 3 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the Supliers data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 1 @@ -54,29 +147,17 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### 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 @@ -85,4 +166,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/Get-User.md b/docs/Get-User.md index d64c735..5ecd014 100644 --- a/docs/Get-User.md +++ b/docs/Get-User.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS -online version: http://go.microsoft.com/fwlink/?LinkId=821589 +Module Name: SnipeitPS +online version: schema: 2.0.0 --- @@ -13,33 +13,203 @@ schema: 2.0.0 ## SYNTAX ``` -Get-User [[-search] ] [-url] [-apiKey] +Get-User [[-search] ] [[-id] ] [[-company_id] ] [[-location_id] ] + [[-group_id] ] [[-department_id] ] [[-username] ] [[-email] ] + [[-order] ] [[-limit] ] [[-offset] ] [-all] [-url] [-apiKey] + [] ``` ## DESCRIPTION -{{Fill in the Description}} +{{ Fill in the Description }} ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-User -url "https://assets.example.com" -token "token..." ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-User -url "https://assets.example.com" -token "token..." | Where-Object {$_.username -eq "stephenm" } ``` ## PARAMETERS -### -search -{{Fill search Description}} +### -all +A return all results, works with -offset and other parameters + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +{{ Fill company_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -department_id +{{ Fill department_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -email +{{ Fill email Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -group_id +{{ Fill group_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific User + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +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: 10 +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +{{ Fill location_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -offset +Offset to use + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +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: 9 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -search +A text string to search the User data + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: 1 @@ -54,30 +224,33 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 12 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +### -username +{{ Fill username Description }} ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: -Required: True -Position: 3 +Required: False +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -85,4 +258,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/docs/New-Asset.md b/docs/New-Asset.md index 7079d2c..247083a 100644 --- a/docs/New-Asset.md +++ b/docs/New-Asset.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,8 +13,11 @@ Add a new Asset to Snipe-it asset system ## SYNTAX ``` -New-Asset [[-tag] ] [-Name] [-Status_id] [-Model_id] [-url] - [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] [] +New-Asset [-status_id] [-model_id] [[-name] ] [[-asset_tag] ] + [[-serial] ] [[-company_id] ] [[-order_number] ] [[-notes] ] + [[-warranty_months] ] [[-purchase_cost] ] [[-purchase_date] ] [[-supplier_id] ] + [[-rtd_location_id] ] [-url] [-apiKey] [[-customfields] ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -22,73 +25,223 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-Asset -status_id 1 -model_id 1 -name "Machine1" ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-Asset -status_id 1 -model_id 1 -name "Machine1" -customfields = @{ "_snipeit_os_5" = "Windows 10 Pro" } ``` ## PARAMETERS -### -tag -Asset Tag for the Asset +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Asset - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 15 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Status_id -Status ID of the asset, this can be got using Get-Status +### -asset_tag +Asset Tag for the Asset, not required when snipe asset_tag autogeneration is on. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: tag + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +Optional Company id ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: -Required: True -Position: 3 +Required: False +Position: 6 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Model_id +### -customfields +Hastable of custom fields and extra fields that need passing through to Snipeit + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 16 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -model_id Model ID of the asset, this can be got using Get-Model ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 4 +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Name of the Asset + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -notes +Optional Notes + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order_number +Optional Order number + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_cost +Optional Purchase cost of the Asset + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_date +Optional Purchase cost of the Asset + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -rtd_location_id +Optional Default location id for the asset + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -serial +Optional Serial number of the Asset + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -status_id +Status ID of the asset, this can be got using Get-Status + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -supplier_id +{{ Fill supplier_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -100,40 +253,40 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 5 +Position: 14 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +### -warranty_months +{{ Fill warranty_months Description }} ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -customfields -Hastable of custom fields and extra fields that need passing through to Snipeit - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 7 +Position: 9 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -155,23 +308,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -180,4 +318,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/docs/New-AssetMaintenance.md b/docs/New-AssetMaintenance.md new file mode 100644 index 0000000..fb9553a --- /dev/null +++ b/docs/New-AssetMaintenance.md @@ -0,0 +1,244 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# New-AssetMaintenance + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-AssetMaintenance [-asset_id] [-supplier_id] [-asset_maintenance_type] + [-title] [-start_date] [[-completion_date] ] [[-is_warranty] ] + [[-cost] ] [[-notes] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -apiKey +{{ Fill apiKey Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -asset_id +{{ Fill asset_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -asset_maintenance_type +{{ Fill asset_maintenance_type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -completion_date +{{ Fill completion_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -cost +{{ Fill cost Description }} + +```yaml +Type: Decimal +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -is_warranty +{{ Fill is_warranty Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +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: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -start_date +{{ Fill start_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -supplier_id +{{ Fill supplier_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -title +{{ Fill title Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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: 9 +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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/New-Category.md b/docs/New-Category.md new file mode 100644 index 0000000..6805008 --- /dev/null +++ b/docs/New-Category.md @@ -0,0 +1,177 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# New-Category + +## SYNOPSIS +# Create a new Snipe-IT Category + +## SYNTAX + +``` +New-Category [-name] [-category_type] [-url] [-apiKey] [-use_default_eula] + [-require_acceptance] [-checkin_email] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +New-Category -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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +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: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -checkin_email +If switch is present, send email to user on checkin/checkout + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Name of new category to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -require_acceptance +If switch is present, require users to confirm acceptance of assets in this category + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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/New-Component.md b/docs/New-Component.md index b869aeb..d7b5280 100644 --- a/docs/New-Component.md +++ b/docs/New-Component.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,8 +13,9 @@ Short description ## SYNTAX ``` -New-Component [-name] [-category_id] [-qty] [-url] [-apiKey] - [-WhatIf] [-Confirm] [] +New-Component [-name] [-category_id] [-qty] [[-company_id] ] + [[-location_id] ] [[-purchase_date] ] [[-purchase_cost] ] [-url] + [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -22,23 +23,23 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` An example ``` ## PARAMETERS -### -name +### -apiKey Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 1 +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -48,9 +49,9 @@ Accept wildcard characters: False Parameter description ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -59,13 +60,88 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -company_id +{{ Fill company_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +{{ Fill location_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_cost +{{ Fill purchase_cost Description }} + +```yaml +Type: Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_date +{{ Fill purchase_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -qty Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -80,25 +156,25 @@ Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 4 +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Parameter description +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 5 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -120,23 +196,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -146,4 +207,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable General notes ## RELATED LINKS - diff --git a/docs/New-CustomField.md b/docs/New-CustomField.md new file mode 100644 index 0000000..fc035e2 --- /dev/null +++ b/docs/New-CustomField.md @@ -0,0 +1,193 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# New-CustomField + +## SYNOPSIS +Add a new Custom Field to Snipe-it asset system + +## SYNTAX + +``` +New-CustomField [-Name] [[-HelpText] ] [[-Element] ] [[-Format] ] + [[-field_encrypted] ] [[-CustomFormat] ] [-url] [-apiKey] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Add a new Custom Field to Snipe-it asset system + +## EXAMPLES + +### EXAMPLE 1 +``` +New-Field -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "Is AntiVirus installed on Asset" +``` + +## PARAMETERS + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFormat +{{ Fill CustomFormat Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Element +{{ Fill Element Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: Text +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -field_encrypted +{{ Fill field_encrypted Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +{{ Fill Format Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: ANY +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HelpText +{{ Fill HelpText Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Custom Field + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info 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/New-Department.md b/docs/New-Department.md index caf9700..1149c8f 100644 --- a/docs/New-Department.md +++ b/docs/New-Department.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,8 +13,8 @@ Short description ## SYNTAX ``` -New-Department [-name] [[-company_id] ] [[-location_id] ] [[-manager_id] ] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] +New-Department [-name] [[-company_id] ] [[-location_id] ] [[-manager_id] ] + [[-notes] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -22,23 +22,23 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` An example ``` ## PARAMETERS -### -name +### -apiKey Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 1 +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -48,9 +48,9 @@ Accept wildcard characters: False {{Fill company_id Description}} ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 2 @@ -63,9 +63,9 @@ Accept wildcard characters: False {{Fill location_id Description}} ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 3 @@ -78,9 +78,9 @@ Accept wildcard characters: False {{Fill manager_id Description}} ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 4 @@ -89,31 +89,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -name +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -notes +{{ Fill notes Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 5 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Parameter description +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 6 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -135,23 +165,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -161,4 +176,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable General notes ## RELATED LINKS - diff --git a/docs/New-License.md b/docs/New-License.md new file mode 100644 index 0000000..a3839b7 --- /dev/null +++ b/docs/New-License.md @@ -0,0 +1,366 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# New-License + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-License [-name] [-seats] [[-category_id] ] [[-company_id] ] + [[-expiration_date] ] [[-license_email] ] [[-license_name] ] + [[-maintained] ] [[-manufacturer_id] ] [[-notes] ] [[-order_number] ] + [[-purchase_cost] ] [[-purchase_date] ] [[-reassignable] ] [[-serial] ] + [[-supplier_id] ] [[-termination_date] ] [-url] [-apiKey] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -apiKey +{{ Fill apiKey Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 18 +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: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +{{ Fill company_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -expiration_date +{{ Fill expiration_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -license_email +{{ Fill license_email Description }} + +```yaml +Type: MailAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +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: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -maintained +{{ Fill maintained Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manufacturer_id +{{ Fill manufacturer_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +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: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order_number +{{ Fill order_number Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_cost +{{ Fill purchase_cost Description }} + +```yaml +Type: Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_date +{{ Fill purchase_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -reassignable +{{ Fill reassignable Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -seats +{{ Fill seats Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -serial +{{ Fill serial Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -supplier_id +{{ Fill supplier_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -termination_date +{{ Fill termination_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 16 +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: 17 +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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/New-Location.md b/docs/New-Location.md index f2aa65c..9e2c7ae 100644 --- a/docs/New-Location.md +++ b/docs/New-Location.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -14,8 +14,8 @@ Add a new Model to Snipe-it asset system ``` New-Location [-name] [[-address] ] [[-address2] ] [[-state] ] - [[-country] ] [[-zip] ] [-url] [-apiKey] [-WhatIf] [-Confirm] - [] + [[-country] ] [[-zip] ] [[-parent_id] ] [[-manager_id] ] [[-ldap_ou] ] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -23,35 +23,20 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1 ``` ## PARAMETERS -### -name -Name of the Asset Model - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -address {{Fill address Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 2 @@ -66,7 +51,7 @@ Accept wildcard characters: False ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 3 @@ -75,76 +60,151 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -state -{{Fill state Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -country -{{Fill country Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -zip -{{Fill zip 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-Info command - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -apiKey Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -country +{{Fill country Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ldap_ou +The LDAP OU of the location + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manager_id +The manager ID of the location + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False Position: 8 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Name of the Asset Model + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -parent_id +Parent location ID for the location + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -state +{{Fill state Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -zip +{{Fill zip Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -166,23 +226,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -191,4 +236,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/docs/New-Manufacturer.md b/docs/New-Manufacturer.md index 6455225..24c00c9 100644 --- a/docs/New-Manufacturer.md +++ b/docs/New-Manufacturer.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -21,20 +21,35 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-Manufacturer -name "HP" ``` ## PARAMETERS +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the Manufacturer ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -49,7 +64,7 @@ URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -58,16 +73,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 3 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -89,23 +104,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -114,4 +114,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/docs/New-Model.md b/docs/New-Model.md index 516443a..58a2e17 100644 --- a/docs/New-Model.md +++ b/docs/New-Model.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,8 +13,9 @@ Add a new Model to Snipe-it asset system ## SYNTAX ``` -New-Model [-name] [-category_id] [-manufacturer_id] [-fieldset_id] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] +New-Model [-name] [[-model_number] ] [-category_id] [-manufacturer_id] + [[-eol] ] [-fieldset_id] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -22,23 +23,23 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-Model -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1 ``` ## PARAMETERS -### -name -Name of the Asset Model +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 1 +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -50,25 +51,25 @@ Category ID that the asset belongs to this can be got using Get-Category ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 2 +Position: 3 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -manufacturer_id -Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer +### -eol +{{ Fill eol Description }} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: -Required: True -Position: 3 +Required: False +Position: 5 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -80,7 +81,22 @@ Fieldset ID that the asset uses (Custom fields) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: + +Required: True +Position: 6 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manufacturer_id +Manufacturer ID that the asset belongs to this can be got using Get-Manufacturer + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: Required: True Position: 4 @@ -89,31 +105,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -model_number +{{ Fill model_number Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Name of the Asset Model + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 5 +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 6 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -135,23 +181,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -160,4 +191,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/docs/New-User.md b/docs/New-User.md index c733afa..4e4cc92 100644 --- a/docs/New-User.md +++ b/docs/New-User.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,10 +13,11 @@ Short description ## SYNTAX ``` -New-User [-firstName] [-lastName] [-userName] [[-jobTitle] ] - [[-email] ] [[-phone] ] [[-company_id] ] [[-location_id] ] - [[-department_id] ] [[-manager_id] ] [[-employee_num] ] [[-ldap_user] ] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] +New-User [-first_name] [-last_name] [-username] [[-password] ] + [[-activated] ] [[-notes] ] [[-jobtitle] ] [[-email] ] [[-phone] ] + [[-company_id] ] [[-location_id] ] [[-department_id] ] [[-manager_id] ] + [[-employee_num] ] [[-ldap_import] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -24,98 +25,38 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` An example ``` ## PARAMETERS -### -firstName -Parameter description +### -activated +{{ Fill activated Description }} ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -lastName -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -userName -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -jobTitle -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -email -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 5 -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -phone +### -apiKey Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: -Required: False -Position: 6 +Required: True +Position: 17 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -127,25 +68,10 @@ Parameter description ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 7 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -location_id -Parameter description - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 +Position: 10 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -157,10 +83,115 @@ Parameter description ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 9 +Position: 12 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -email +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -employee_num +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -first_name +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -jobtitle +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -last_name +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ldap_import +Mark user as import from ldap + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +Parameter description + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -172,41 +203,56 @@ Parameter description ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 10 +Position: 13 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -employee_num +### -notes Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 11 +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ldap_user +### -password +{{ Fill password Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -phone Parameter description ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 12 -Default value: False +Position: 9 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -217,25 +263,40 @@ Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 13 +Position: 16 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey +### -username Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 14 +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 @@ -257,23 +318,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -283,4 +329,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable General notes ## RELATED LINKS - diff --git a/docs/Remove-Asset.md b/docs/Remove-Asset.md new file mode 100644 index 0000000..a66b6b4 --- /dev/null +++ b/docs/Remove-Asset.md @@ -0,0 +1,116 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Remove-Asset + +## SYNOPSIS +Removes Asset to Snipe-it asset system + +## SYNTAX + +``` +Remove-Asset [-ID] [-URL] [-APIKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-Asset -ID 44 -url $url -apiKey $secret -Verbose +``` + +## PARAMETERS + +### -APIKey +{{ Fill APIKey Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ID +Unique ID For Asset to be removed + +```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: 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-User.md b/docs/Remove-User.md new file mode 100644 index 0000000..52d3db8 --- /dev/null +++ b/docs/Remove-User.md @@ -0,0 +1,116 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Remove-User + +## SYNOPSIS +Removes User from Snipe-it asset system + +## SYNTAX + +``` +Remove-User [-ID] [-URL] [-APIKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-User -ID 44 -url $url -apiKey $secret -Verbose +``` + +## PARAMETERS + +### -APIKey +{{ Fill APIKey Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ID +Unique ID For User to be removed + +```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: 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/Set-Accessory.md b/docs/Set-Accessory.md new file mode 100644 index 0000000..2bd3450 --- /dev/null +++ b/docs/Set-Accessory.md @@ -0,0 +1,274 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-Accessory + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-Accessory [-id] [[-name] ] [[-qty] ] [[-category_id] ] + [[-company_id] ] [[-manufacturer_id] ] [[-order_number] ] [[-purchase_cost] ] + [[-purchase_date] ] [[-requestable] ] [[-supplier_id] ] [-url] + [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -apiKey +{{ Fill apiKey Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 12 +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: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +{{ Fill company_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +{{ Fill id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manufacturer_id +{{ Fill manufacturer_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order_number +{{ Fill order_number Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_cost +{{ Fill purchase_cost Description }} + +```yaml +Type: Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_date +{{ Fill purchase_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -qty +{{ Fill qty Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -requestable +{{ Fill requestable Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -supplier_id +{{ Fill supplier_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +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: 11 +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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/Set-Asset.md b/docs/Set-Asset.md index 50913d3..ae33fe7 100644 --- a/docs/Set-Asset.md +++ b/docs/Set-Asset.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,8 +13,11 @@ Update a Asset in the Snipe-it asset system ## SYNTAX ``` -Set-Asset [-id] [-Name] [-Status_id] [-Model_id] [-url] - [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] [] +Set-Asset [-id] [[-Name] ] [[-Status_id] ] [[-Model_id] ] + [[-last_checkout] ] [[-assigned_to] ] [[-company_id] ] [[-serial] ] + [[-order_number] ] [[-warranty_months] ] [[-purchase_cost] ] + [[-purchase_date] ] [[-requestable] ] [[-archived] ] [[-rtd_location_id] ] + [-url] [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -22,25 +25,100 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Set-Asset -id 1 -status_id 1 -model_id 1 -name "Machine1" ``` -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Set-Asset -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 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 17 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -archived +Whether or not the asset is archived. Archived assets cannot be checked out and do not show up in the deployable asset screens + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -assigned_to +The id of the user the asset is currently checked out to + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +The id of an associated company id + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -customfields +Hastable of custom fields and extra fields that need passing through to Snipeit + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 18 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -id ID of the Asset ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -49,31 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name of the Asset +### -last_checkout +Date the asset was last checked out ```yaml -Type: String +Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status_id -Status ID of the asset, this can be got using Get-Status - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 +Required: False +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -85,55 +148,175 @@ Model ID of the asset, this can be got using Get-Model ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: -Required: True +Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Name +Name of the Asset + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order_number +Order number for the asset + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_cost +Purchase cost of the asset, without a currency symbol + +```yaml +Type: Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_date +Date of asset purchase + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -requestable +Whether or not the asset can be requested by users with the permission to request assets + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -rtd_location_id +The id that corresponds to the location where the asset is usually located when not checked out + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -serial +Serial number of the asset + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status_id +Status ID of the asset, this can be got using Get-Status + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url URL of Snipeit system, can be set using Set-Info command ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 5 +Position: 16 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -Users API Key for Snipeit, can be set using Set-Info command +### -warranty_months +Number of months for the asset warranty ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -customfields -Hastable of custom fields and extra fields that need passing through to Snipeit - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: +Aliases: Required: False -Position: 7 +Position: 10 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -155,23 +338,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -180,4 +348,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/docs/Set-AssetOwner.md b/docs/Set-AssetOwner.md index 03b6c94..ddb6176 100644 --- a/docs/Set-AssetOwner.md +++ b/docs/Set-AssetOwner.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -31,6 +31,82 @@ PS C:\> {{ Add example code here }} ## 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 +``` + +### -assigned_id +{{Fill assigned_id Description}} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -checkout_to_type +{{Fill checkout_to_type Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: location, asset, user + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +{{Fill id Description}} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +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. @@ -62,84 +138,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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 -``` - -### -assigned_id -{{Fill assigned_id Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -checkout_to_type -{{Fill checkout_to_type Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: location, asset, user - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -id -{{Fill id Description}} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 -``` - ### 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). +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 @@ -148,8 +148,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object - ## NOTES ## RELATED LINKS - diff --git a/docs/Set-Component.md b/docs/Set-Component.md index 819c19c..43370e3 100644 --- a/docs/Set-Component.md +++ b/docs/Set-Component.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -31,6 +31,66 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -apiKey +{{Fill apiKey Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +{{Fill id Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -qty +{{Fill qty Description}} + +```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: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -62,68 +122,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey -{{Fill apiKey Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -id -{{Fill id Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -qty -{{Fill qty Description}} - -```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: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -132,8 +132,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object - ## NOTES ## RELATED LINKS - diff --git a/docs/Set-Info.md b/docs/Set-Info.md index 6334fb4..e70ef64 100644 --- a/docs/Set-Info.md +++ b/docs/Set-Info.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -36,7 +36,7 @@ PS C:\> {{ Add example code here }} ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -51,7 +51,7 @@ Accept wildcard characters: False ```yaml Type: Uri Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 0 @@ -61,7 +61,7 @@ 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). +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 @@ -70,8 +70,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object - ## NOTES ## RELATED LINKS - diff --git a/docs/Set-License.md b/docs/Set-License.md new file mode 100644 index 0000000..2786d92 --- /dev/null +++ b/docs/Set-License.md @@ -0,0 +1,381 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-License + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-License [-id] [[-name] ] [[-seats] ] [[-category_id] ] + [[-company_id] ] [[-expiration_date] ] [[-license_email] ] + [[-license_name] ] [[-maintained] ] [[-manufacturer_id] ] [[-notes] ] + [[-order_number] ] [[-purchase_cost] ] [[-purchase_date] ] + [[-reassignable] ] [[-serial] ] [[-supplier_id] ] [[-termination_date] ] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -apiKey +{{ Fill apiKey Description }} + +```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: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +{{ Fill company_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -expiration_date +{{ Fill expiration_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +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: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -license_email +{{ Fill license_email Description }} + +```yaml +Type: MailAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +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: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -maintained +{{ Fill maintained Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manufacturer_id +{{ Fill manufacturer_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order_number +{{ Fill order_number Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_cost +{{ Fill purchase_cost Description }} + +```yaml +Type: Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -purchase_date +{{ Fill purchase_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -reassignable +{{ Fill reassignable Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -seats +{{ Fill seats Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -serial +{{ Fill serial Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -supplier_id +{{ Fill supplier_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 16 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -termination_date +{{ Fill termination_date Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 17 +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: 18 +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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/Set-Model.md b/docs/Set-Model.md new file mode 100644 index 0000000..d68c438 --- /dev/null +++ b/docs/Set-Model.md @@ -0,0 +1,213 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-Model + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-Model [-id] [[-name] ] [[-model_number] ] [[-category_id] ] + [[-manufacturer_id] ] [[-eol] ] [[-custom_fieldset_id] ] [-url] + [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -apiKey +{{ Fill apiKey Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 8 +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: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -custom_fieldset_id +{{ Fill custom_fieldset_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: fieldset_id + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -eol +{{ Fill eol Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +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: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manufacturer_id +{{ Fill manufacturer_id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -model_number +{{ Fill model_number Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +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: 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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/Set-SnipeitLocation.md b/docs/Set-SnipeitLocation.md new file mode 100644 index 0000000..b06b2f4 --- /dev/null +++ b/docs/Set-SnipeitLocation.md @@ -0,0 +1,253 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeitPS +online version: +schema: 2.0.0 +--- + +# Set-SnipeitLocation + +## SYNOPSIS +Updates Location in Snipe-it asset system + +## SYNTAX + +``` +Set-SnipeitLocation [-id] [[-name] ] [[-address] ] [[-address2] ] + [[-state] ] [[-country] ] [[-zip] ] [[-manager_id] ] [[-ldap_ou] ] + [[-parent_id] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### EXAMPLE 1 +``` +Set-SnipeitLocation -id 123 -name "Some storage" -parent_id 100 +``` + +## PARAMETERS + +### -address +Address line 1 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -address2 +Address line 2 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Users API Key for Snipeit, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -country +Address Contry + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +{{ Fill id Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ldap_ou +LDAP OU of Location + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manager_id +Location manager as id + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -name +Name of Location + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -parent_id +Parent location as id + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -state +Address State + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system, can be set using Set-Info command + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -zip +Address zipcode + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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-User.md b/docs/Set-User.md index b8bbaa1..1de998d 100644 --- a/docs/Set-User.md +++ b/docs/Set-User.md @@ -1,6 +1,6 @@ ---- +--- external help file: SnipeItPS-help.xml -Module Name: SnipeItPS +Module Name: SnipeitPS online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -25,113 +25,38 @@ Long description ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` An example ``` ## PARAMETERS -### -id +### -activated Parameter description ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: + +Required: False +Position: 13 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: True -Position: 1 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -first_name -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -last_name -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -userName -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -jobtitle -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -email -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -phone -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 +Position: 16 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -143,7 +68,7 @@ Parameter description ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 8 @@ -152,28 +77,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -location_id -Parameter description - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -department_id Parameter description ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 10 @@ -182,13 +92,118 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -email +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -employee_num +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -first_name +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +Parameter description + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -jobtitle +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -last_name +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +Parameter description + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -manager_id Parameter description ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 11 @@ -197,43 +212,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -employee_num -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 12 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -activated -Parameter description - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 13 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -notes Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 14 @@ -242,13 +227,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -phone +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 15 @@ -257,16 +257,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -apiKey +### -userName Parameter description ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: -Required: True -Position: 16 +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -288,23 +303,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -314,4 +314,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable General notes ## RELATED LINKS - diff --git a/docs/SnipeItPS.md b/docs/SnipeItPS.md new file mode 100644 index 0000000..eea3b19 --- /dev/null +++ b/docs/SnipeItPS.md @@ -0,0 +1,79 @@ +--- +Module Name: SnipeitPS +Module Guid: {{ Update Module Guid }} +Download Help Link: {{ Update Download Link }} +Help Version: {{ Update Help Version }} +Locale: {{ Update Locale }} +--- + +# SnipeitPS Module +## Description +{{ Fill in the Description }} + +## SnipeitPS Cmdlets +### [Get-AssetMaintenance](Get-AssetMaintenance.md) +Gets a list of Snipe-it Assets + +### [New-Asset](New-Asset.md) +Add a new Asset to Snipe-it asset system + +### [New-AssetMaintenance](New-AssetMaintenance.md) +{{ Fill in the Synopsis }} + +### [New-Component](New-Component.md) +Short description + +### [New-CustomField](New-CustomField.md) +Add a new Custom Field to Snipe-it asset system + +### [New-Department](New-Department.md) +Short description + +### [New-License](New-License.md) +{{ Fill in the Synopsis }} + +### [New-Location](New-Location.md) +Add a new Model to Snipe-it asset system + +### [New-Manufacturer](New-Manufacturer.md) +Add a new Manufacturer to Snipe-it asset system + +### [New-Model](New-Model.md) +Add a new Model to Snipe-it asset system + +### [New-User](New-User.md) +Short description + +### [Remove-Asset](Remove-Asset.md) +Removes Asset to Snipe-it asset system + +### [Remove-User](Remove-User.md) +Removes User from Snipe-it asset system + +### [Set-Accessory](Set-Accessory.md) +{{ Fill in the Synopsis }} + +### [Set-Asset](Set-Asset.md) +Update a Asset in the Snipe-it asset system + +### [Set-AssetOwner](Set-AssetOwner.md) +{{Fill in the Synopsis}} + +### [Set-Component](Set-Component.md) +{{Fill in the Synopsis}} + +### [Set-Info](Set-Info.md) +{{Fill in the Synopsis}} + +### [Set-License](Set-License.md) +{{ Fill in the Synopsis }} + +### [Set-Model](Set-Model.md) +{{ Fill in the Synopsis }} + +### [Set-SnipeitLocation](Set-SnipeitLocation.md) +Updates Location in Snipe-it asset system + +### [Set-User](Set-User.md) +Short description +