diff --git a/SnipeitPS/Public/Get-Asset.ps1 b/SnipeitPS/Public/Get-Asset.ps1 index 51ddb64..018da35 100644 --- a/SnipeitPS/Public/Get-Asset.ps1 +++ b/SnipeitPS/Public/Get-Asset.ps1 @@ -1,6 +1,45 @@ <# .SYNOPSIS -# Gets a list of Snipe-it Assets + Gets a list of Snipe-it Assets + +.PARAMETER search +A text string to search the assets data + +.PARAMETER order_number +Optionally restrict asset results to this order number + +.PARAMETER model_id +Optionally restrict asset results to this asset model ID + +.PARAMETER category_id +Optionally restrict asset results to this category ID + +.PARAMETER manufacturer_id +Optionally restrict asset results to this manufacturer ID + +.PARAMETER company_id +Optionally restrict asset results to this company ID + +.PARAMETER location_id +Optionally restrict asset results to this location ID + +.PARAMETER status +Optionally restrict asset results to one of these status types: RTD, Deployed, Undeployable, Deleted, Archived, Requestable + +.PARAMETER status_id +Optionally restrict asset results to this status label ID + +.PARAMETER sort +Specify the column name you wish to sort by + +.PARAMETER order +Specify the order (asc or desc) you wish to order by on your sort column + +.PARAMETER limit +Specify the number of results you wish to return. Defaults to 50. + +.PARAMETER offset +Offset to use .PARAMETER url URL of Snipeit system, can be set using Set-Info command @@ -13,9 +52,7 @@ Get-Asset -url "https://assets.example.com" -token "token..." .EXAMPLE Get-Asset -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MyMachine" } - #> - function Get-Asset() { Param( [string]$search, diff --git a/SnipeitPS/Public/Set-Asset.ps1 b/SnipeitPS/Public/Set-Asset.ps1 index a7decfb..fd11788 100644 --- a/SnipeitPS/Public/Set-Asset.ps1 +++ b/SnipeitPS/Public/Set-Asset.ps1 @@ -44,13 +44,10 @@ function Set-Asset() [parameter(mandatory = $true)] [int]$id, - [parameter(mandatory = $true)] [string]$Name, - [parameter(mandatory = $true)] [string]$Status_id, - [parameter(mandatory = $true)] [string]$Model_id, [parameter(mandatory = $true)] diff --git a/docs/Get-Asset.md b/docs/Get-Asset.md index deaafc9..3c992bd 100644 --- a/docs/Get-Asset.md +++ b/docs/Get-Asset.md @@ -13,7 +13,10 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Asset [-url] [-apiKey] +Get-Asset [[-search] ] [[-order_number] ] [[-model_id] ] [[-category_id] ] + [[-manufacturer_id] ] [[-company_id] ] [[-location_id] ] [[-status] ] + [[-status_id] ] [[-sort] ] [[-order] ] [[-limit] ] [[-offset] ] + [-url] [-apiKey] ``` ## DESCRIPTION @@ -33,6 +36,201 @@ Get-Asset -url "https://assets.example.com" -token "token..." | Where-Object {$_ ## PARAMETERS +### -search +{{Fill search 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: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -model_id +{{Fill model_id Description}} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -category_id +{{Fill category_id Description}} + +```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: + +Required: False +Position: 7 +Default value: 0 +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}} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -sort +{{Fill sort Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: Created_at +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -order +{{Fill order Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: Desc +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -limit +{{Fill limit Description}} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -offset +{{Fill offset Description}} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -url URL of Snipeit system, can be set using Set-Info command @@ -42,7 +240,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 14 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,7 +255,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 15 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-Category.md b/docs/Get-Category.md index b63484f..4432464 100644 --- a/docs/Get-Category.md +++ b/docs/Get-Category.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Category [-url] [-apiKey] +Get-Category [[-search] ] [-url] [-apiKey] ``` ## DESCRIPTION @@ -33,6 +33,21 @@ Get-Category -url "https://assets.example.com" -token "token..." | Where-Object ## PARAMETERS +### -search +{{Fill search Description}} + +```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 @@ -42,7 +57,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,7 +72,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-Company.md b/docs/Get-Company.md new file mode 100644 index 0000000..023e7e1 --- /dev/null +++ b/docs/Get-Company.md @@ -0,0 +1,88 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeItPS +online version: +schema: 2.0.0 +--- + +# Get-Company + +## SYNOPSIS +# Gets a list of Snipe-it Companies + +## SYNTAX + +``` +Get-Company [[-search] ] [-url] [-apiKey] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-Company -url "https://assets.example.com" -token "token..." +``` + +### -------------------------- EXAMPLE 2 -------------------------- +``` +Get-Company -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Company1" } +``` + +## PARAMETERS + +### -search +{{Fill search Description}} + +```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: 2 +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 +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + diff --git a/docs/Get-Component.md b/docs/Get-Component.md index e780747..2dc00ee 100644 --- a/docs/Get-Component.md +++ b/docs/Get-Component.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Component [-url] [-apiKey] +Get-Component [[-search] ] [-url] [-apiKey] ``` ## DESCRIPTION @@ -33,6 +33,21 @@ Get-Component -url "https://assets.example.com" -token "token..." | Where-Object ## PARAMETERS +### -search +{{Fill search Description}} + +```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 @@ -42,7 +57,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,7 +72,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-Department.md b/docs/Get-Department.md new file mode 100644 index 0000000..a705897 --- /dev/null +++ b/docs/Get-Department.md @@ -0,0 +1,88 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeItPS +online version: +schema: 2.0.0 +--- + +# Get-Department + +## SYNOPSIS +# Gets a list of Snipe-it Departments + +## SYNTAX + +``` +Get-Department [[-search] ] [-url] [-apiKey] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-Department -url "https://assets.example.com" -token "token..." +``` + +### -------------------------- EXAMPLE 2 -------------------------- +``` +Get-Department -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "Department1" } +``` + +## PARAMETERS + +### -search +{{Fill search Description}} + +```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: 2 +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 +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + diff --git a/docs/Get-Manufacturer.md b/docs/Get-Manufacturer.md index df5ca85..1665104 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: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Manufacturer [-url] [-apiKey] +Get-Manufacturer [[-search] ] [-url] [-apiKey] ``` ## DESCRIPTION @@ -33,6 +33,21 @@ Get-Manufacturer -url "https://assets.example.com" -token "token..." | Where-Obj ## PARAMETERS +### -search +{{Fill search Description}} + +```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 @@ -42,7 +57,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,7 +72,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-Model.md b/docs/Get-Model.md index 55c1504..8292c0a 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: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Model [-url] [-apiKey] +Get-Model [[-search] ] [-url] [-apiKey] ``` ## DESCRIPTION @@ -33,6 +33,21 @@ Get-Models -url "https://assets.example.com" -token "token..." | Where-Object {$ ## PARAMETERS +### -search +{{Fill search Description}} + +```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 @@ -42,7 +57,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,7 +72,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-Status.md b/docs/Get-Status.md index be5c90a..fb81f34 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: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-Status [-url] [-apiKey] +Get-Status [[-search] ] [-url] [-apiKey] ``` ## DESCRIPTION @@ -33,6 +33,21 @@ Get-Status -url "https://assets.example.com" -token "token..." | Where-Object {$ ## PARAMETERS +### -search +{{Fill search Description}} + +```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 @@ -42,7 +57,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,7 +72,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-Supplier.md b/docs/Get-Supplier.md new file mode 100644 index 0000000..07e5e99 --- /dev/null +++ b/docs/Get-Supplier.md @@ -0,0 +1,88 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeItPS +online version: http://go.microsoft.com/fwlink/?LinkId=821589 +schema: 2.0.0 +--- + +# Get-Supplier + +## SYNOPSIS +# Gets a list of Snipe-it Suppliers + +## SYNTAX + +``` +Get-Supplier [[-search] ] [-url] [-apiKey] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-Supplier -url "https://assets.example.com" -token "token..." +``` + +### -------------------------- EXAMPLE 2 -------------------------- +``` +Get-Supplier -url "https://assets.example.com" -token "token..." | Where-Object {$_.name -eq "MySupplier" } +``` + +## PARAMETERS + +### -search +{{Fill search Description}} + +```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: 2 +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 +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + diff --git a/docs/Get-User.md b/docs/Get-User.md index 5f1610d..d64c735 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: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Get-User [-url] [-apiKey] +Get-User [[-search] ] [-url] [-apiKey] ``` ## DESCRIPTION @@ -33,6 +33,21 @@ Get-User -url "https://assets.example.com" -token "token..." | Where-Object {$_. ## PARAMETERS +### -search +{{Fill search Description}} + +```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 @@ -42,7 +57,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,7 +72,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/New-Asset.md b/docs/New-Asset.md index 334c85e..ad49eb1 100644 --- a/docs/New-Asset.md +++ b/docs/New-Asset.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,8 +13,8 @@ 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 [[-tag] ] [-Name] [-Status_id] [-Model_id] [-url] + [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,13 +68,13 @@ Accept wildcard characters: False Status ID of the asset, this can be got using Get-Status ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 3 -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -83,13 +83,13 @@ Accept wildcard characters: False Model ID of the asset, this can be got using Get-Model ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 4 -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -170,6 +170,9 @@ 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 diff --git a/docs/New-Component.md b/docs/New-Component.md index ff564f9..b869aeb 100644 --- a/docs/New-Component.md +++ b/docs/New-Component.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -14,7 +14,7 @@ Short description ``` New-Component [-name] [-category_id] [-qty] [-url] [-apiKey] - [-WhatIf] [-Confirm] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -135,6 +135,9 @@ 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 diff --git a/docs/New-Department.md b/docs/New-Department.md new file mode 100644 index 0000000..caf9700 --- /dev/null +++ b/docs/New-Department.md @@ -0,0 +1,164 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeItPS +online version: http://go.microsoft.com/fwlink/?LinkId=821589 +schema: 2.0.0 +--- + +# New-Department + +## SYNOPSIS +Short description + +## SYNTAX + +``` +New-Department [-name] [[-company_id] ] [[-location_id] ] [[-manager_id] ] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +An example +``` + +## PARAMETERS + +### -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 +``` + +### -company_id +{{Fill company_id Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -location_id +{{Fill location_id Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manager_id +{{Fill manager_id Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +General notes + +## RELATED LINKS + diff --git a/docs/New-Location.md b/docs/New-Location.md new file mode 100644 index 0000000..f2aa65c --- /dev/null +++ b/docs/New-Location.md @@ -0,0 +1,194 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeItPS +online version: http://go.microsoft.com/fwlink/?LinkId=821589 +schema: 2.0.0 +--- + +# New-Location + +## SYNOPSIS +Add a new Model to Snipe-it asset system + +## SYNTAX + +``` +New-Location [-name] [[-address] ] [[-address2] ] [[-state] ] + [[-country] ] [[-zip] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### -------------------------- 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: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -address2 +{{Fill address2 Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +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: + +Required: True +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + diff --git a/docs/New-Manufacturer.md b/docs/New-Manufacturer.md index 8f32b60..6455225 100644 --- a/docs/New-Manufacturer.md +++ b/docs/New-Manufacturer.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,7 +13,7 @@ Add a new Manufacturer to Snipe-it asset system ## SYNTAX ``` -New-Manufacturer [-Name] [-url] [-apiKey] [-WhatIf] [-Confirm] +New-Manufacturer [-Name] [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -104,6 +104,9 @@ 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 diff --git a/docs/New-Model.md b/docs/New-Model.md index 6202855..516443a 100644 --- a/docs/New-Model.md +++ b/docs/New-Model.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -14,7 +14,7 @@ Add a new Model to Snipe-it asset system ``` New-Model [-name] [-category_id] [-manufacturer_id] [-fieldset_id] - [-url] [-apiKey] [-WhatIf] [-Confirm] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -150,6 +150,9 @@ 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 diff --git a/docs/New-User.md b/docs/New-User.md new file mode 100644 index 0000000..c733afa --- /dev/null +++ b/docs/New-User.md @@ -0,0 +1,286 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeItPS +online version: http://go.microsoft.com/fwlink/?LinkId=821589 +schema: 2.0.0 +--- + +# New-User + +## SYNOPSIS +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] [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +An example +``` + +## PARAMETERS + +### -firstName +Parameter description + +```yaml +Type: String +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: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -phone +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +Parameter description + +```yaml +Type: Int32 +Parameter Sets: (All) +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 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -department_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: + +Required: False +Position: 10 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -employee_num +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ldap_user +Parameter description + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 14 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +General notes + +## RELATED LINKS + diff --git a/docs/Set-Asset.md b/docs/Set-Asset.md index 11ff0e6..50913d3 100644 --- a/docs/Set-Asset.md +++ b/docs/Set-Asset.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -14,7 +14,7 @@ Update a Asset in the Snipe-it asset system ``` Set-Asset [-id] [-Name] [-Status_id] [-Model_id] [-url] - [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] + [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -170,6 +170,9 @@ 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 diff --git a/docs/Set-AssetOwner.md b/docs/Set-AssetOwner.md index 1e3b9f2..03b6c94 100644 --- a/docs/Set-AssetOwner.md +++ b/docs/Set-AssetOwner.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,7 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -Set-AssetOwner [-id] [-user_id] [-url] [-apiKey] [-WhatIf] [-Confirm] +Set-AssetOwner [-id] [-assigned_id] [[-checkout_to_type] ] [-url] + [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -70,7 +71,38 @@ Parameter Sets: (All) Aliases: Required: True -Position: 3 +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 @@ -100,32 +132,19 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -user_id -{{Fill user_id Description}} - -```yaml -Type: Int32 -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 ### None - ## OUTPUTS ### System.Object diff --git a/docs/Set-Component.md b/docs/Set-Component.md index 79a41d0..819c19c 100644 --- a/docs/Set-Component.md +++ b/docs/Set-Component.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -14,6 +14,7 @@ schema: 2.0.0 ``` Set-Component [-id] [-qty] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -121,11 +122,13 @@ 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 diff --git a/docs/Set-Info.md b/docs/Set-Info.md index 53cb63a..6334fb4 100644 --- a/docs/Set-Info.md +++ b/docs/Set-Info.md @@ -1,7 +1,7 @@ --- external help file: SnipeItPS-help.xml Module Name: SnipeItPS -online version: +online version: http://go.microsoft.com/fwlink/?LinkId=821589 schema: 2.0.0 --- @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Set-Info [[-url] ] [[-apiKey] ] +Set-Info [[-url] ] [[-apiKey] ] [] ``` ## DESCRIPTION @@ -60,11 +60,13 @@ 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 diff --git a/docs/Set-User.md b/docs/Set-User.md new file mode 100644 index 0000000..b8bbaa1 --- /dev/null +++ b/docs/Set-User.md @@ -0,0 +1,317 @@ +--- +external help file: SnipeItPS-help.xml +Module Name: SnipeItPS +online version: http://go.microsoft.com/fwlink/?LinkId=821589 +schema: 2.0.0 +--- + +# Set-User + +## SYNOPSIS +Short description + +## SYNTAX + +``` +Set-User [-id] [[-first_name] ] [[-last_name] ] [[-userName] ] + [[-jobtitle] ] [[-email] ] [[-phone] ] [[-company_id] ] + [[-location_id] ] [[-department_id] ] [[-manager_id] ] [[-employee_num] ] + [[-activated] ] [[-notes] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Long description + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +An example +``` + +## PARAMETERS + +### -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 +``` + +### -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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -company_id +Parameter description + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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: 9 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -department_id +Parameter description + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -manager_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 +``` + +### -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: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 15 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -apiKey +Parameter description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 16 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +General notes + +## RELATED LINKS +