diff --git a/docs/Connect-SnipeitPS.md b/docs/Connect-SnipeitPS.md new file mode 100644 index 0000000..137649a --- /dev/null +++ b/docs/Connect-SnipeitPS.md @@ -0,0 +1,137 @@ +--- +external help file: SnipeitPS-help.xml +Module Name: snipeitps +online version: +schema: 2.0.0 +--- + +# Connect-SnipeitPS + +## SYNOPSIS +Sets authetication information + +## SYNTAX + +### Connect with url and apikey (Default) +``` +Connect-SnipeitPS -url -apiKey [] +``` + +### Connect with url and secure apikey +``` +Connect-SnipeitPS -url -secureApiKey [] +``` + +### Connect with credential +``` +Connect-SnipeitPS -siteCred [] +``` + +## DESCRIPTION +Sets apikey and url to connect Snipe-It system. +Based on Set-SnipeitInfo command, what is now just combatipility wrapper +and calls Connect-SnipeitPS + +## EXAMPLES + +### EXAMPLE 1 +``` +Connect-SnipeitPS -Url $url -apiKey $myapikey +Connect to Snipe it api. +``` + +### EXAMPLE 2 +``` +Connect-SnipeitPS -Url $url -SecureApiKey $myapikey +Connects to Snipe it api with apikey stored to securestring +``` + +### EXAMPLE 3 +``` +Connect-SnipeitPS -siteCred (Get-Credential -message "Use site url as username and apikey as password") +Connect to Snipe It with PSCredential object. +To use saved creadentials yu can use export-clixml and import-clixml commandlets. +``` + +### EXAMPLE 4 +``` +Build credential with apikey value from secret vault (Microsoft.PowerShell.SecretManagement) +$siteurl = "https://mysnipeitsite.url" +$apikey = Get-SecretInfo -Name SnipeItApiKey +$siteCred = New-Object -Type PSCredential -Argumentlist $siteurl,$spikey +Connect-SnipeitPS -siteCred $siteCred +``` + +## PARAMETERS + +### -apiKey +User's API Key for Snipeit. + +```yaml +Type: String +Parameter Sets: Connect with url and apikey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -secureApiKey +Snipe it Api key as securestring + +```yaml +Type: SecureString +Parameter Sets: Connect with url and secure apikey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -siteCred +PSCredential where username shoul be snipe it url and password should be +snipe it apikey. + +```yaml +Type: PSCredential +Parameter Sets: Connect with credential +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -url +URL of Snipeit system. + +```yaml +Type: Uri +Parameter Sets: Connect with url and apikey, Connect with url and secure apikey +Aliases: + +Required: True +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/Get-SnipeitAccessory.md b/docs/Get-SnipeitAccessory.md index 680c5a1..8f13557 100644 --- a/docs/Get-SnipeitAccessory.md +++ b/docs/Get-SnipeitAccessory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,17 +16,17 @@ Gets a list of Snipe-it Accessories ``` Get-SnipeitAccessory [-search ] [-company_id ] [-category_id ] [-manufacturer_id ] [-supplier_id ] [-sort ] [-order ] [-limit ] [-offset ] [-all] - -url -apiKey [] + [-url ] [-apiKey ] [] ``` ### Get by ID ``` -Get-SnipeitAccessory [-id ] -url -apiKey [] +Get-SnipeitAccessory [-id ] [-url ] [-apiKey ] [] ``` ### Accessories checked out to user id ``` -Get-SnipeitAccessory [-user_id ] [-all] -url -apiKey [] +Get-SnipeitAccessory [-user_id ] [-all] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -68,14 +68,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -235,14 +236,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitAccessoryOwner.md b/docs/Get-SnipeitAccessoryOwner.md index 914d9ea..f89f528 100644 --- a/docs/Get-SnipeitAccessoryOwner.md +++ b/docs/Get-SnipeitAccessoryOwner.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Get list of checked out accessories ## SYNTAX ``` -Get-SnipeitAccessoryOwner [-id] [-url] [-apiKey] [-WhatIf] [-Confirm] +Get-SnipeitAccessoryOwner [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -30,14 +30,15 @@ Get-SnipeitAccessoryOwner -id 1 ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -60,14 +61,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitActivity.md b/docs/Get-SnipeitActivity.md index 8e656b3..8aeaeff 100644 --- a/docs/Get-SnipeitActivity.md +++ b/docs/Get-SnipeitActivity.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,7 +15,7 @@ Gets and search Snipe-it Activity history ``` Get-SnipeitActivity [[-search] ] [[-target_type] ] [[-target_id] ] [[-item_type] ] [[-item_id] ] [[-action_type] ] [[-limit] ] [[-offset] ] - [-all] [-url] [-apiKey] [] + [-all] [[-url] ] [[-apiKey] ] [] ``` ## DESCRIPTION @@ -67,14 +67,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False @@ -189,14 +190,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 9 Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitAsset.md b/docs/Get-SnipeitAsset.md index db43ac2..d48be29 100644 --- a/docs/Get-SnipeitAsset.md +++ b/docs/Get-SnipeitAsset.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -17,46 +17,46 @@ Gets a list of Snipe-it Assets or specific asset Get-SnipeitAsset [-search ] [-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 [] + [-limit ] [-offset ] [-all] [-url ] [-apiKey ] [] ``` ### Get with id ``` -Get-SnipeitAsset [-id ] -url -apiKey [] +Get-SnipeitAsset [-id ] [-url ] [-apiKey ] [] ``` ### Get with asset tag ``` -Get-SnipeitAsset [-asset_tag ] -url -apiKey [] +Get-SnipeitAsset [-asset_tag ] [-url ] [-apiKey ] [] ``` ### Get with serial ``` -Get-SnipeitAsset [-serial ] -url -apiKey [] +Get-SnipeitAsset [-serial ] [-url ] [-apiKey ] [] ``` ### Assets due auditing soon ``` Get-SnipeitAsset [-audit_due] [-sort ] [-order ] [-limit ] [-offset ] [-all] - -url -apiKey [] + [-url ] [-apiKey ] [] ``` ### Assets overdue for auditing ``` Get-SnipeitAsset [-audit_overdue] [-sort ] [-order ] [-limit ] [-offset ] [-all] - -url -apiKey [] + [-url ] [-apiKey ] [] ``` ### Assets checked out to user id ``` Get-SnipeitAsset [-user_id ] [-sort ] [-order ] [-limit ] [-offset ] - [-all] -url -apiKey [] + [-all] [-url ] [-apiKey ] [] ``` ### Assets with component id ``` Get-SnipeitAsset [-component_id ] [-sort ] [-order ] [-limit ] [-offset ] - [-all] -url -apiKey [] + [-all] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -66,7 +66,7 @@ Get-SnipeitAsset [-component_id ] [-sort ] [-order ] [-li ### EXAMPLE 1 ``` -Get-SnipeitAsset -all -url "https://assets.example.com"-token "token..." +Get-SnipeitAsset -all Returens all assets ``` @@ -136,14 +136,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -468,14 +469,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitAssetMaintenance.md b/docs/Get-SnipeitAssetMaintenance.md index 8ca5d36..fb5fcc9 100644 --- a/docs/Get-SnipeitAssetMaintenance.md +++ b/docs/Get-SnipeitAssetMaintenance.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Lists Snipe-it Assets Maintenances ``` Get-SnipeitAssetMaintenance [[-search] ] [[-asset_id] ] [[-sort] ] [[-order] ] - [[-limit] ] [-all] [[-offset] ] [-url] [-apiKey] [] + [[-limit] ] [-all] [[-offset] ] [[-url] ] [[-apiKey] ] [] ``` ## DESCRIPTION @@ -24,17 +24,17 @@ Get-SnipeitAssetMaintenance [[-search] ] [[-asset_id] ] [[-sort] ### EXAMPLE 1 ``` -Get-SnipeitAssetMaintenances -url "https://assets.example.com" -token "token..." +Get-SnipeitAssetMaintenances ``` ### EXAMPLE 2 ``` -Get-SnipeitAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..." +Get-SnipeitAssetMaintenances -search "myMachine" ``` ### EXAMPLE 3 ``` -Get-SnipeitAssetMaintenances -search "myMachine" -url "https://assets.example.com" -token "token..." +Get-SnipeitAssetMaintenances -search "myMachine" ``` ## PARAMETERS @@ -55,14 +55,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 8 Default value: None Accept pipeline input: False @@ -162,14 +163,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 7 Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitCategory.md b/docs/Get-SnipeitCategory.md index d430813..903fd32 100644 --- a/docs/Get-SnipeitCategory.md +++ b/docs/Get-SnipeitCategory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,12 +15,12 @@ Gets a list of Snipe-it Categories ### Search (Default) ``` Get-SnipeitCategory [-search ] [-order ] [-limit ] [-offset ] [-all] - -url -apiKey [] + [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitCategory [-id ] -url -apiKey [] +Get-SnipeitCategory [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -56,14 +56,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -148,14 +149,15 @@ Accept wildcard characters: False ``` ### -url -Url of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Url of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitCompany.md b/docs/Get-SnipeitCompany.md index 6f46298..f69206c 100644 --- a/docs/Get-SnipeitCompany.md +++ b/docs/Get-SnipeitCompany.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,13 +14,13 @@ Gets a list of Snipe-it Companies ### Search (Default) ``` -Get-SnipeitCompany [-search ] [-order ] [-limit ] [-offset ] [-all] -url - -apiKey [] +Get-SnipeitCompany [-search ] [-order ] [-limit ] [-offset ] [-all] + [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitCompany [-id ] -url -apiKey [] +Get-SnipeitCompany [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -58,14 +58,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -150,14 +151,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitComponent.md b/docs/Get-SnipeitComponent.md index c8a6cfe..ce7efb4 100644 --- a/docs/Get-SnipeitComponent.md +++ b/docs/Get-SnipeitComponent.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,13 +15,13 @@ Gets a list of Snipe-it Components ### Search (Default) ``` Get-SnipeitComponent [-search ] [-category_id ] [-company_id ] [-location_id ] - [-order ] [-sort ] [-limit ] [-offset ] [-all] -url -apiKey - [] + [-order ] [-sort ] [-limit ] [-offset ] [-all] [-url ] + [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitComponent [-id ] -url -apiKey [] +Get-SnipeitComponent [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -65,14 +65,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -217,14 +218,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system,can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitConsumable.md b/docs/Get-SnipeitConsumable.md index 5286b59..c94552b 100644 --- a/docs/Get-SnipeitConsumable.md +++ b/docs/Get-SnipeitConsumable.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,12 +16,12 @@ Gets a list of Snipe-it consumables ``` Get-SnipeitConsumable [-search ] [-category_id ] [-company_id ] [-manufacturer_id ] [-location_id ] [-order ] [-sort ] [-expand] - [-limit ] [-offset ] [-all] -url -apiKey [] + [-limit ] [-offset ] [-all] [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitConsumable [-id ] -url -apiKey [] +Get-SnipeitConsumable [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -65,14 +65,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -247,14 +248,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system,can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitCustomField.md b/docs/Get-SnipeitCustomField.md index 7e60a99..de31e6a 100644 --- a/docs/Get-SnipeitCustomField.md +++ b/docs/Get-SnipeitCustomField.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Returns specific Snipe-IT custom field or a list of all custom field ## SYNTAX ``` -Get-SnipeitCustomField [[-id] ] [-url] [-apiKey] [] +Get-SnipeitCustomField [[-id] ] [[-url] ] [[-apiKey] ] [] ``` ## DESCRIPTION @@ -23,20 +23,28 @@ Get-SnipeitCustomField [[-id] ] [-url] [-apiKey] [] [-order ] [-limit ] [-offset ] [-all] - [-sort ] -url -apiKey [] + [-sort ] [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitDepartment [-id ] -url -apiKey [] +Get-SnipeitDepartment [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -30,7 +30,7 @@ Get-SnipeitDepartment [-id ] -url -apiKey [] [-url] [-apiKey] [] +Get-SnipeitFieldset [[-id] ] [[-url] ] [[-apiKey] ] [] ``` ## DESCRIPTION @@ -23,25 +23,28 @@ Get-SnipeitFieldset [[-id] ] [-url] [-apiKey] [] [-name ] [-company_id ] [-product_key ] [-order_number ] [-purchase_order ] [-license_name ] [-license_email ] [-manufacturer_id ] [-supplier_id ] [-depreciation_id ] [-category_id ] - [-order ] [-sort ] [-limit ] [-offset ] [-all] -url -apiKey - [] + [-order ] [-sort ] [-limit ] [-offset ] [-all] [-url ] + [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitLicense [-id ] -url -apiKey [] +Get-SnipeitLicense [-id ] [-url ] [-apiKey ] [] ``` ### Get licenses checked out to user ID ``` -Get-SnipeitLicense [-user_id ] [-all] -url -apiKey [] +Get-SnipeitLicense [-user_id ] [-all] [-url ] [-apiKey ] [] ``` ### Get licenses checked out to asset ID ``` -Get-SnipeitLicense [-asset_id ] [-all] -url -apiKey [] +Get-SnipeitLicense [-asset_id ] [-all] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -69,14 +69,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -356,14 +357,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitLicenseSeat.md b/docs/Get-SnipeitLicenseSeat.md index 7f74a74..cb07d28 100644 --- a/docs/Get-SnipeitLicenseSeat.md +++ b/docs/Get-SnipeitLicenseSeat.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Gets a list of Snipe-it Licenses Seats or specific Seat ``` Get-SnipeitLicenseSeat [-id] [[-seat_id] ] [[-limit] ] [[-offset] ] [-all] - [-url] [-apiKey] [] + [[-url] ] [[-apiKey] ] [] ``` ## DESCRIPTION @@ -45,14 +45,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 6 Default value: None Accept pipeline input: False @@ -122,14 +123,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 5 Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitLocation.md b/docs/Get-SnipeitLocation.md index a45b9cd..0f068eb 100644 --- a/docs/Get-SnipeitLocation.md +++ b/docs/Get-SnipeitLocation.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,12 +15,12 @@ Gets a list of Snipe-it Locations ### Search (Default) ``` Get-SnipeitLocation [-search ] [-order ] [-limit ] [-offset ] [-all] - -url -apiKey [] + [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitLocation [-id ] -url -apiKey [] +Get-SnipeitLocation [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -56,14 +56,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -148,14 +149,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitManufacturer.md b/docs/Get-SnipeitManufacturer.md index 533212a..00c9e6c 100644 --- a/docs/Get-SnipeitManufacturer.md +++ b/docs/Get-SnipeitManufacturer.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,12 +15,12 @@ schema: 2.0.0 ### Search (Default) ``` Get-SnipeitManufacturer [-search ] [-order ] [-limit ] [-offset ] [-all] - -url -apiKey [] + [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitManufacturer [-id ] -url -apiKey [] +Get-SnipeitManufacturer [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -58,14 +58,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -150,14 +151,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitModel.md b/docs/Get-SnipeitModel.md index 0094e59..6878f2e 100644 --- a/docs/Get-SnipeitModel.md +++ b/docs/Get-SnipeitModel.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,13 +14,13 @@ Gets a list of Snipe-it Models ### Search (Default) ``` -Get-SnipeitModel [-search ] [-order ] [-limit ] [-offset ] [-all] -url - -apiKey [] +Get-SnipeitModel [-search ] [-order ] [-limit ] [-offset ] [-all] [-url ] + [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitModel [-id ] -url -apiKey [] +Get-SnipeitModel [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -56,14 +56,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -148,14 +149,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitStatus.md b/docs/Get-SnipeitStatus.md index 9740cb4..320e210 100644 --- a/docs/Get-SnipeitStatus.md +++ b/docs/Get-SnipeitStatus.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,13 +14,13 @@ Gets a list of Snipe-it Status Labels ### Search (Default) ``` -Get-SnipeitStatus [-search ] [-order ] [-limit ] [-offset ] [-all] -url - -apiKey [] +Get-SnipeitStatus [-search ] [-order ] [-limit ] [-offset ] [-all] + [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitStatus [-id ] -url -apiKey [] +Get-SnipeitStatus [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -56,14 +56,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -148,14 +149,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitSupplier.md b/docs/Get-SnipeitSupplier.md index 6b7be7b..697c094 100644 --- a/docs/Get-SnipeitSupplier.md +++ b/docs/Get-SnipeitSupplier.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,12 +15,12 @@ schema: 2.0.0 ### Search (Default) ``` Get-SnipeitSupplier [-search ] [-order ] [-limit ] [-offset ] [-all] - -url -apiKey [] + [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitSupplier [-id ] -url -apiKey [] +Get-SnipeitSupplier [-id ] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -56,14 +56,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -148,14 +149,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/Get-SnipeitUser.md b/docs/Get-SnipeitUser.md index 05e6766..36c8fd5 100644 --- a/docs/Get-SnipeitUser.md +++ b/docs/Get-SnipeitUser.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,17 +16,17 @@ schema: 2.0.0 ``` Get-SnipeitUser [-search ] [-company_id ] [-location_id ] [-group_id ] [-department_id ] [-username ] [-email ] [-order ] [-limit ] - [-offset ] [-all] -url -apiKey [] + [-offset ] [-all] [-url ] [-apiKey ] [] ``` ### Get with ID ``` -Get-SnipeitUser [-id ] -url -apiKey [] +Get-SnipeitUser [-id ] [-url ] [-apiKey ] [] ``` ### Get users a specific accessory id has been checked out to ``` -Get-SnipeitUser [-accessory_id ] [-all] -url -apiKey [] +Get-SnipeitUser [-accessory_id ] [-all] [-url ] [-apiKey ] [] ``` ## DESCRIPTION @@ -93,14 +93,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -260,14 +261,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitAccessory.md b/docs/New-SnipeitAccessory.md index 27acd04..2c40405 100644 --- a/docs/New-SnipeitAccessory.md +++ b/docs/New-SnipeitAccessory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,7 +16,7 @@ Creates new accessory on Snipe-It system New-SnipeitAccessory [-name] [-qty] [-category_id] [[-company_id] ] [[-manufacturer_id] ] [[-order_number] ] [[-model_number] ] [[-purchase_cost] ] [[-purchase_date] ] [[-min_amt] ] [[-supplier_id] ] [[-location_id] ] - [[-image] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-image] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,14 +32,15 @@ New-SnipeitAccessory -name "Accessory" -qty 3 -category_id 1 ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 15 Default value: None Accept pipeline input: False @@ -242,14 +243,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 14 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitAsset.md b/docs/New-SnipeitAsset.md index 47ef1fa..a9676fb 100644 --- a/docs/New-SnipeitAsset.md +++ b/docs/New-SnipeitAsset.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -17,7 +17,7 @@ Add a new Asset to Snipe-it asset system New-SnipeitAsset -status_id -model_id [-name ] [-asset_tag ] [-serial ] [-company_id ] [-order_number ] [-notes ] [-warranty_months ] [-purchase_cost ] [-purchase_date ] [-supplier_id ] [-rtd_location_id ] - [-image ] -url -apiKey [-customfields ] [-WhatIf] [-Confirm] + [-image ] [-url ] [-apiKey ] [-customfields ] [-WhatIf] [-Confirm] [] ``` @@ -26,7 +26,7 @@ New-SnipeitAsset -status_id -model_id [-name ] [-asset_t New-SnipeitAsset -status_id -model_id [-name ] [-asset_tag ] [-serial ] [-company_id ] [-order_number ] [-notes ] [-warranty_months ] [-purchase_cost ] [-purchase_date ] [-supplier_id ] [-rtd_location_id ] - [-image ] -assigned_id -checkout_to_type -url -apiKey + [-image ] -assigned_id -checkout_to_type [-url ] [-apiKey ] [-customfields ] [-WhatIf] [-Confirm] [] ``` @@ -56,14 +56,15 @@ Using customfields when creating asset. ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -312,14 +313,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitAssetMaintenance.md b/docs/New-SnipeitAssetMaintenance.md index 9e047b9..d0cd6be 100644 --- a/docs/New-SnipeitAssetMaintenance.md +++ b/docs/New-SnipeitAssetMaintenance.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,7 +15,7 @@ Add a new Asset maintenence to Snipe-it asset system ``` New-SnipeitAssetMaintenance [-asset_id] [-supplier_id] [-asset_maintenance_type] [-title] [-start_date] [[-completion_date] ] [[-is_warranty] ] - [[-cost] ] [[-notes] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [[-cost] ] [[-notes] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -32,14 +32,15 @@ New-SnipeitAssetMaintenence -asset_id 1 -supplier_id 1 -title "replace keyboard" ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 11 Default value: None Accept pipeline input: False @@ -182,14 +183,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitAudit.md b/docs/New-SnipeitAudit.md index 5925779..742fa24 100644 --- a/docs/New-SnipeitAudit.md +++ b/docs/New-SnipeitAudit.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Add a new Audit to Snipe-it asset system ## SYNTAX ``` -New-SnipeitAudit [-tag] [[-location_id] ] [-url] [-apiKey] [-WhatIf] +New-SnipeitAudit [-tag] [[-location_id] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -37,7 +37,7 @@ Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 4 Default value: None Accept pipeline input: False @@ -82,7 +82,7 @@ Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitCategory.md b/docs/New-SnipeitCategory.md index 927766d..4586644 100644 --- a/docs/New-SnipeitCategory.md +++ b/docs/New-SnipeitCategory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Create a new Snipe-IT Category ``` New-SnipeitCategory [-name] [-category_type] [[-eula_text] ] [-use_default_eula] - [-require_acceptance] [-checkin_email] [[-image] ] [-url] [-apiKey] [-WhatIf] + [-require_acceptance] [-checkin_email] [[-image] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -25,20 +25,21 @@ New-SnipeitCategory [-name] [-category_type] [[-eula_text] [[-image] ] [-url] [-apiKey] [-WhatIf] [-Confirm] - [] +New-SnipeitCompany [-name] [[-image] ] [[-url] ] [[-apiKey] ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +30,15 @@ New-SnipeitCompany -name "Acme Company" ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 4 Default value: None Accept pipeline input: False @@ -75,14 +76,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitComponent.md b/docs/New-SnipeitComponent.md index 3f230a2..4680317 100644 --- a/docs/New-SnipeitComponent.md +++ b/docs/New-SnipeitComponent.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,7 +15,7 @@ Create a new component ``` New-SnipeitComponent [-name] [-category_id] [-qty] [[-company_id] ] [[-location_id] ] [[-order_number] ] [[-purchase_date] ] [[-purchase_cost] ] - [[-image] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-image] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -25,20 +25,21 @@ Createa new componen on Snipe-It system ### EXAMPLE 1 ``` -An example +New-SnipeitComponent -name 'Display adapter' -catecory_id 3 -qty 10 ``` ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 11 Default value: None Accept pipeline input: False @@ -181,14 +182,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False @@ -234,6 +236,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ## NOTES -General notes ## RELATED LINKS diff --git a/docs/New-SnipeitConsumable.md b/docs/New-SnipeitConsumable.md index 4778e65..e7bd1c2 100644 --- a/docs/New-SnipeitConsumable.md +++ b/docs/New-SnipeitConsumable.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,7 +16,7 @@ Add a new Consumable to Snipe-it asset system New-SnipeitConsumable [-name] [-qty] [-category_id] [[-min_amt] ] [[-company_id] ] [[-order_number] ] [[-manufacturer_id] ] [[-location_id] ] [[-requestable] ] [[-purchase_date] ] [[-purchase_cost] ] - [[-model_number] ] [[-item_no] ] [[-image] ] [-url] [-apiKey] + [[-model_number] ] [[-item_no] ] [[-image] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -34,14 +34,15 @@ Create consumable with stock count 20 , alert when stock is 5 or lower ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 16 Default value: None Accept pipeline input: False @@ -259,14 +260,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 15 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitCustomField.md b/docs/New-SnipeitCustomField.md index e30a6ab..f0563eb 100644 --- a/docs/New-SnipeitCustomField.md +++ b/docs/New-SnipeitCustomField.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,7 +15,7 @@ Add a new Custom Field to Snipe-it asset system ``` New-SnipeitCustomField [-name] [[-help_text] ] [-element] [-format] [[-field_values] ] [[-field_encrypted] ] [[-show_in_email] ] - [[-custom_format] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-custom_format] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,14 +31,15 @@ New-SnipeitCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False @@ -167,14 +168,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 9 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitDepartment.md b/docs/New-SnipeitDepartment.md index cd96ed7..b9b65e6 100644 --- a/docs/New-SnipeitDepartment.md +++ b/docs/New-SnipeitDepartment.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Creates a department ``` New-SnipeitDepartment [-name] [[-company_id] ] [[-location_id] ] [[-manager_id] ] - [[-notes] ] [[-image] ] [-image_delete] [-url] [-apiKey] [-WhatIf] + [[-notes] ] [[-image] ] [-image_delete] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -31,14 +31,15 @@ New-SnipeitDepartment -name "Department1" -company_id 1 -localtion_id 1 -manager ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 8 Default value: None Accept pipeline input: False @@ -151,14 +152,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 7 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitLicense.md b/docs/New-SnipeitLicense.md index 73f46b1..b675686 100644 --- a/docs/New-SnipeitLicense.md +++ b/docs/New-SnipeitLicense.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -17,7 +17,7 @@ New-SnipeitLicense [-name] [-seats] [[-category_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] + [[-supplier_id] ] [[-termination_date] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -34,14 +34,15 @@ New-SnipeitLicence -name "License" -seats 3 -company_id 1 ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 19 Default value: None Accept pipeline input: False @@ -304,14 +305,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 18 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitLocation.md b/docs/New-SnipeitLocation.md index 744b3f2..4d00b92 100644 --- a/docs/New-SnipeitLocation.md +++ b/docs/New-SnipeitLocation.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,8 +15,8 @@ Add a new Location to Snipe-it asset system ``` New-SnipeitLocation [-name] [[-address] ] [[-address2] ] [[-city] ] [[-state] ] [[-country] ] [[-zip] ] [[-currency] ] [[-parent_id] ] - [[-manager_id] ] [[-ldap_ou] ] [[-image] ] [-image_delete] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-manager_id] ] [[-ldap_ou] ] [[-image] ] [-image_delete] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -62,14 +62,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 14 Default value: None Accept pipeline input: False @@ -227,14 +228,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 13 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitManufacturer.md b/docs/New-SnipeitManufacturer.md index d5e266a..292c20e 100644 --- a/docs/New-SnipeitManufacturer.md +++ b/docs/New-SnipeitManufacturer.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,8 +13,8 @@ Add a new Manufacturer to Snipe-it asset system ## SYNTAX ``` -New-SnipeitManufacturer [-Name] [[-image] ] [-image_delete] [-url] [-apiKey] - [-WhatIf] [-Confirm] [] +New-SnipeitManufacturer [-Name] [[-image] ] [-image_delete] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +30,15 @@ New-SnipeitManufacturer -name "HP" ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 4 Default value: None Accept pipeline input: False @@ -90,14 +91,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitModel.md b/docs/New-SnipeitModel.md index 564f431..22ff905 100644 --- a/docs/New-SnipeitModel.md +++ b/docs/New-SnipeitModel.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Add a new Model to Snipe-it asset system ``` New-SnipeitModel [-name] [[-model_number] ] [-category_id] [-manufacturer_id] - [[-eol] ] [-fieldset_id] [[-image] ] [-url] [-apiKey] [-WhatIf] + [[-eol] ] [-fieldset_id] [[-image] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -31,14 +31,15 @@ New-SnipeitModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1 ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 9 Default value: None Accept pipeline input: False @@ -151,14 +152,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 8 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitSupplier.md b/docs/New-SnipeitSupplier.md index 3892b88..fd61645 100644 --- a/docs/New-SnipeitSupplier.md +++ b/docs/New-SnipeitSupplier.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,8 +15,8 @@ Creates a supplier ``` New-SnipeitSupplier [-name] [[-address] ] [[-address2] ] [[-city] ] [[-state] ] [[-country] ] [[-zip] ] [[-phone] ] [[-fax] ] - [[-email] ] [[-contact] ] [[-notes] ] [[-image] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-email] ] [[-contact] ] [[-notes] ] [[-image] ] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -62,14 +62,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 15 Default value: None Accept pipeline input: False @@ -227,14 +228,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 14 Default value: None Accept pipeline input: False diff --git a/docs/New-SnipeitUser.md b/docs/New-SnipeitUser.md index e830d0a..ce9d40d 100644 --- a/docs/New-SnipeitUser.md +++ b/docs/New-SnipeitUser.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,8 +16,8 @@ Creates a new user New-SnipeitUser [-first_name] [-last_name] [-username] [[-password] ] [[-activated] ] [[-notes] ] [[-jobtitle] ] [[-email] ] [[-phone] ] [[-company_id] ] [[-location_id] ] [[-department_id] ] [[-manager_id] ] - [[-employee_num] ] [[-ldap_import] ] [[-image] ] [-url] [-apiKey] - [-WhatIf] [-Confirm] [] + [[-employee_num] ] [[-ldap_import] ] [[-image] ] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,14 +49,15 @@ Accept wildcard characters: False ``` ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 18 Default value: None Accept pipeline input: False @@ -274,14 +275,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 17 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitAccessory.md b/docs/Remove-SnipeitAccessory.md index 51ea7a9..f2d23ac 100644 --- a/docs/Remove-SnipeitAccessory.md +++ b/docs/Remove-SnipeitAccessory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes Accessory from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitAccessory [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitAccessory [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -34,15 +34,16 @@ Get-SnipeitAccessory -search needle | Remove-SnipeitAccessory ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitAsset.md b/docs/Remove-SnipeitAsset.md index 8ee957a..e61ff5e 100644 --- a/docs/Remove-SnipeitAsset.md +++ b/docs/Remove-SnipeitAsset.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes Asset from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitAsset [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitAsset [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -34,15 +34,16 @@ Get-SnipeitAsset -serial 123456789 | Remove-SnipeitAsset ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitAssetMaintenance.md b/docs/Remove-SnipeitAssetMaintenance.md index 75f5e2f..4604a8a 100644 --- a/docs/Remove-SnipeitAssetMaintenance.md +++ b/docs/Remove-SnipeitAssetMaintenance.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Remove asset maintenance from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitAssetMaintenance [-id] [-url] [-apiKey] [-WhatIf] [-Confirm] +Remove-SnipeitAssetMaintenance [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,20 +24,20 @@ Removes asset maintenance event or events from Snipe-it asset system by ID ### EXAMPLE 1 ``` -Remove-SnipeitAssetMaintenance -ID 44 -url $url -apiKey $secret -Verbose +Remove-SnipeitAssetMaintenance -ID 44 ``` ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +{{ Fill apiKey Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -60,14 +60,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitCategory.md b/docs/Remove-SnipeitCategory.md index 34734d6..39366e9 100644 --- a/docs/Remove-SnipeitCategory.md +++ b/docs/Remove-SnipeitCategory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes category from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitCategory [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitCategory [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes category or multiple categories from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitCategory -ID 44 -Verbose +Remove-SnipeitCategory -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitCategory -search something | Remove-SnipeitCategory ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitCompany.md b/docs/Remove-SnipeitCompany.md index b1609af..6d97257 100644 --- a/docs/Remove-SnipeitCompany.md +++ b/docs/Remove-SnipeitCompany.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes Company from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitCompany [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitCompany [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes Company or multiple Companies from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitCompany -ID 44 -Verbose +Remove-SnipeitCompany -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitCompany | | Where-object {$_.name -like '*some*'} | Remove-SnipeitCom ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitComponent.md b/docs/Remove-SnipeitComponent.md index 0e68c5a..91a6ac7 100644 --- a/docs/Remove-SnipeitComponent.md +++ b/docs/Remove-SnipeitComponent.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes component from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitComponent [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitComponent [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes component or multiple components from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitComponent -ID 44 -Verbose +Remove-SnipeitComponent -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitComponent -search 123456789 | Remove-SnipeitComponent ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitConsumable.md b/docs/Remove-SnipeitConsumable.md index 82a0e2d..15f3726 100644 --- a/docs/Remove-SnipeitConsumable.md +++ b/docs/Remove-SnipeitConsumable.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes consumable from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitConsumable [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitConsumable [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,25 +24,26 @@ Removes consumable or multiple consumables from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitConsumable -ID 44 -Verbose +Remove-SnipeitConsumable -ID 44 ``` ### EXAMPLE 2 ``` -Get-SnipeitConsumable -search "paper" | Remove-Snipeitconsumable +Get-SnipeitConsumable -search "paper" | Remove-SnipeitConsumable ``` ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitCustomField.md b/docs/Remove-SnipeitCustomField.md index fa21c51..aa8c987 100644 --- a/docs/Remove-SnipeitCustomField.md +++ b/docs/Remove-SnipeitCustomField.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes custom field from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitCustomField [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitCustomField [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -34,15 +34,16 @@ Get-SnipeitCustomField | Where-object {$_.name -like '*address*'} | Remove-Snip ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitDepartment.md b/docs/Remove-SnipeitDepartment.md index a2f99e3..ca4f501 100644 --- a/docs/Remove-SnipeitDepartment.md +++ b/docs/Remove-SnipeitDepartment.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes department from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitDepartment [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitDepartment [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes department or multiple departments from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitDepartment -ID 44 -Verbose +Remove-SnipeitDepartment -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitDepartment | Where-object {$_.name -like '*head*'} | Remove-SnipeitDe ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitLicense.md b/docs/Remove-SnipeitLicense.md index e778b67..390a507 100644 --- a/docs/Remove-SnipeitLicense.md +++ b/docs/Remove-SnipeitLicense.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes licence from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitLicense [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitLicense [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes licence or multiple licenses from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitLicence -ID 44 -Verbose +Remove-SnipeitLicence -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitLicence -product_key 123456789 | Remove-SnipeitLicense ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitLocation.md b/docs/Remove-SnipeitLocation.md index a7e8d11..bc20d98 100644 --- a/docs/Remove-SnipeitLocation.md +++ b/docs/Remove-SnipeitLocation.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes Location from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitLocation [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitLocation [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes localtion or multiple locations from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitLocation -ID 44 -Verbose +Remove-SnipeitLocation -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitLocation -city Arkham | Remove-SnipeitLocation ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitManufacturer.md b/docs/Remove-SnipeitManufacturer.md index ab0a019..0d86a5f 100644 --- a/docs/Remove-SnipeitManufacturer.md +++ b/docs/Remove-SnipeitManufacturer.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes manufacturer from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitManufacturer [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitManufacturer [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes manufacturer or multiple manufacturers from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitManufacturer -ID 44 -Verbose +Remove-SnipeitManufacturer -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitManufacturer | Where-object {$_.name -like '*something*'} | Remove-S ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitModel.md b/docs/Remove-SnipeitModel.md index 04592bd..f42dd81 100644 --- a/docs/Remove-SnipeitModel.md +++ b/docs/Remove-SnipeitModel.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes Asset model from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitModel [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitModel [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +24,7 @@ Removes asset model or multiple assets models from Snipe-it asset system ### EXAMPLE 1 ``` -Remove-SnipeitModel -ID 44 -Verbose +Remove-SnipeitModel -ID 44 ``` ### EXAMPLE 2 @@ -34,15 +34,16 @@ Get-SnipeitModel -search needle | Remove-SnipeitModel ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitSupplier.md b/docs/Remove-SnipeitSupplier.md index 4fcae40..aebe6ae 100644 --- a/docs/Remove-SnipeitSupplier.md +++ b/docs/Remove-SnipeitSupplier.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Removes supplier from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitSupplier [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] +Remove-SnipeitSupplier [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -34,15 +34,16 @@ Get-SnipeitSupplier | Where-object {$_.name -like '*something*'} | Remove-Snipe ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -64,15 +65,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Remove-SnipeitUser.md b/docs/Remove-SnipeitUser.md index 850d37f..3241c7b 100644 --- a/docs/Remove-SnipeitUser.md +++ b/docs/Remove-SnipeitUser.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,8 @@ Removes User from Snipe-it asset system ## SYNTAX ``` -Remove-SnipeitUser [-id] [-URL] [-APIKey] [-WhatIf] [-Confirm] [] +Remove-SnipeitUser [-id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -28,15 +29,16 @@ Remove-SnipeitUser -ID 44 -url $url -apiKey $secret -Verbose ## PARAMETERS -### -APIKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +### -apiKey +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -47,26 +49,27 @@ Accept wildcard characters: False Unique ID For User to be removed ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 -Default value: 0 +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -URL -URL of Snipeit system, can be set using Set-SnipeitInfo command +### -url +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Reset-SnipeitAccessoryOwner.md b/docs/Reset-SnipeitAccessoryOwner.md index 8d8e733..61c6025 100644 --- a/docs/Reset-SnipeitAccessoryOwner.md +++ b/docs/Reset-SnipeitAccessoryOwner.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,7 +13,7 @@ Checkin accessories ## SYNTAX ``` -Reset-SnipeitAccessoryOwner [-assigned_pivot_id] [-url] [-apiKey] [-WhatIf] +Reset-SnipeitAccessoryOwner [-assigned_pivot_id] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -36,14 +36,15 @@ Get-SnipeitAccessoryOwner -assigned_pivot_id xxx ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 3 Default value: None Accept pipeline input: False @@ -67,14 +68,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False diff --git a/docs/Reset-SnipeitAssetOwner.md b/docs/Reset-SnipeitAssetOwner.md index f901aeb..d2488c5 100644 --- a/docs/Reset-SnipeitAssetOwner.md +++ b/docs/Reset-SnipeitAssetOwner.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Checkin asset ``` Reset-SnipeitAssetOwner [-id] [[-status_id] ] [[-location_id] ] [[-notes] ] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -24,20 +24,21 @@ Checks asset in from current user/localtion/asset ### EXAMPLE 1 ``` -Remove-SnipeitUser -ID 44 -url $url -apiKey $secret -Verbose +Remove-SnipeitUser -ID 44 ``` ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 6 Default value: None Accept pipeline input: False @@ -105,14 +106,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 5 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitAccessory.md b/docs/Set-SnipeitAccessory.md index 3d689f6..5795ed7 100644 --- a/docs/Set-SnipeitAccessory.md +++ b/docs/Set-SnipeitAccessory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,8 +16,8 @@ Updates accessory on Snipe-It system Set-SnipeitAccessory [-id] [[-name] ] [[-qty] ] [[-category_id] ] [[-company_id] ] [[-manufacturer_id] ] [[-model_number] ] [[-order_number] ] [[-purchase_cost] ] [[-purchase_date] ] [[-min_amt] ] [[-supplier_id] ] - [[-location_id] ] [[-image] ] [-image_delete] [[-RequestType] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-location_id] ] [[-image] ] [-image_delete] [[-RequestType] ] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,14 +33,15 @@ Set-SnipeitAccessory -id 1 -qty 3 ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfoeItInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 17 Default value: None Accept pipeline input: False @@ -289,14 +290,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 16 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitAccessoryOwner.md b/docs/Set-SnipeitAccessoryOwner.md index 52f65bc..448ce7a 100644 --- a/docs/Set-SnipeitAccessoryOwner.md +++ b/docs/Set-SnipeitAccessoryOwner.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,8 +13,8 @@ Checkout accessory ## SYNTAX ``` -Set-SnipeitAccessoryOwner [-id] [-assigned_to] [[-note] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] +Set-SnipeitAccessoryOwner [-id] [-assigned_to] [[-note] ] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +30,15 @@ Set-SnipeitAccessoryOwner -id 1 -assigned_id 1 -note "testing check out to user ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 5 Default value: None Accept pipeline input: False @@ -90,14 +91,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 4 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitAsset.md b/docs/Set-SnipeitAsset.md index 84476cf..190ce3c 100644 --- a/docs/Set-SnipeitAsset.md +++ b/docs/Set-SnipeitAsset.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -17,8 +17,8 @@ Set-SnipeitAsset [-id] [[-name] ] [[-status_id] ] [[-mo [[-last_checkout] ] [[-assigned_to] ] [[-company_id] ] [[-serial] ] [[-order_number] ] [[-warranty_months] ] [[-purchase_cost] ] [[-purchase_date] ] [[-requestable] ] [[-archived] ] [[-rtd_location_id] ] - [[-notes] ] [[-RequestType] ] [[-image] ] [-image_delete] [-url] - [-apiKey] [[-customfields] ] [-WhatIf] [-Confirm] [] + [[-notes] ] [[-RequestType] ] [[-image] ] [-image_delete] [[-url] ] + [[-apiKey] ] [[-customfields] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,14 +44,15 @@ Get-SnipeitAsset -serial 12345678 | Set-SnipeitAsset -notes 'Just updated' ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 20 Default value: None Accept pipeline input: False @@ -346,14 +347,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfoeItInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 19 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitAssetOwner.md b/docs/Set-SnipeitAssetOwner.md index 1408e93..3f6fbf8 100644 --- a/docs/Set-SnipeitAssetOwner.md +++ b/docs/Set-SnipeitAssetOwner.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,8 +14,8 @@ Checkout asset ``` Set-SnipeitAssetOwner [-id] [-assigned_id] [[-checkout_to_type] ] [[-name] ] - [[-note] ] [[-expected_checkin] ] [[-checkout_at] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-note] ] [[-expected_checkin] ] [[-checkout_at] ] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,14 +31,15 @@ Set-SnipeitAssetOwner -id 1 -assigned_id 1 -checkout_to_type user -note "testing ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 9 Default value: None Accept pipeline input: False @@ -154,14 +155,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 8 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitCategory.md b/docs/Set-SnipeitCategory.md index ffa7b95..bd0e875 100644 --- a/docs/Set-SnipeitCategory.md +++ b/docs/Set-SnipeitCategory.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,7 +15,7 @@ Create a new Snipe-IT Category ``` Set-SnipeitCategory [-id] [[-name] ] [[-category_type] ] [[-eula_text] ] [[-use_default_eula] ] [[-require_acceptance] ] [[-checkin_email] ] - [[-image] ] [-image_delete] [[-RequestType] ] [-url] [-apiKey] [-WhatIf] + [[-image] ] [-image_delete] [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -32,14 +32,15 @@ Set-SnipeitCategory -id 4 -name "Laptops" ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 11 Default value: None Accept pipeline input: False @@ -183,14 +184,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitCompany.md b/docs/Set-SnipeitCompany.md index 6c32fed..f607bde 100644 --- a/docs/Set-SnipeitCompany.md +++ b/docs/Set-SnipeitCompany.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Updates company name ``` Set-SnipeitCompany [-id] [-name] [[-image] ] [-image_delete] - [[-RequestType] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +30,15 @@ An example ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 6 Default value: None Accept pipeline input: False @@ -121,14 +122,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 5 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitComponent.md b/docs/Set-SnipeitComponent.md index 38312ae..47cea8b 100644 --- a/docs/Set-SnipeitComponent.md +++ b/docs/Set-SnipeitComponent.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,8 +15,8 @@ Updates component ``` Set-SnipeitComponent [-id] [-qty] [[-min_amt] ] [[-name] ] [[-company_id] ] [[-location_id] ] [[-order_number] ] [[-purchase_date] ] - [[-purchase_cost] ] [[-image] ] [-image_delete] [[-RequestType] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-purchase_cost] ] [[-image] ] [-image_delete] [[-RequestType] ] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -26,20 +26,22 @@ Updates component on Snipe-It system ### EXAMPLE 1 ``` -An example +Set-SnipeitComponent -id 42 -qty 12 +Sets count of component with ID 42 to 12 ``` ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 13 Default value: None Accept pipeline input: False @@ -228,14 +230,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 12 Default value: None Accept pipeline input: False @@ -281,6 +284,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ## NOTES -General notes ## RELATED LINKS diff --git a/docs/Set-SnipeitConsumable.md b/docs/Set-SnipeitConsumable.md index ec673c0..6cf3fb3 100644 --- a/docs/Set-SnipeitConsumable.md +++ b/docs/Set-SnipeitConsumable.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -17,7 +17,7 @@ Set-SnipeitConsumable [-id] [[-name] ] [[-qty] ] [[-cat [[-min_amt] ] [[-company_id] ] [[-order_number] ] [[-manufacturer_id] ] [[-location_id] ] [[-requestable] ] [[-purchase_date] ] [[-purchase_cost] ] [[-model_number] ] [[-item_no] ] [[-image] ] [-image_delete] [[-RequestType] ] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,14 +34,15 @@ Create consumable with stock count 20 , alert when stock is 5 or lower ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 18 Default value: None Accept pipeline input: False @@ -305,14 +306,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 17 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitCustomField.md b/docs/Set-SnipeitCustomField.md index 8606f6d..dba0b55 100644 --- a/docs/Set-SnipeitCustomField.md +++ b/docs/Set-SnipeitCustomField.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,8 +15,8 @@ Add a new Custom Field to Snipe-it asset system ``` Set-SnipeitCustomField [-id] [[-name] ] [[-help_text] ] [-element] [[-format] ] [[-field_values] ] [[-field_encrypted] ] [[-show_in_email] ] - [[-custom_format] ] [[-RequestType] ] [-url] [-apiKey] [-WhatIf] [-Confirm] - [] + [[-custom_format] ] [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -32,14 +32,15 @@ New-SnipeitCustomField -Name "AntivirusInstalled" -Format "BOOLEAN" -HelpText "I ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 12 Default value: None Accept pipeline input: False @@ -199,14 +200,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 11 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitDepartment.md b/docs/Set-SnipeitDepartment.md index e3de315..84f5a07 100644 --- a/docs/Set-SnipeitDepartment.md +++ b/docs/Set-SnipeitDepartment.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,7 +15,7 @@ Updates a department ``` Set-SnipeitDepartment [-id] [[-name] ] [[-company_id] ] [[-location_id] ] [[-manager_id] ] [[-notes] ] [[-image] ] [-image_delete] [[-RequestType] ] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,14 +31,15 @@ Set-SnipeitDepartment -id 4 -manager_id 3 ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False @@ -182,14 +183,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 9 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitInfo.md b/docs/Set-SnipeitInfo.md index cb41bfc..6c004cf 100644 --- a/docs/Set-SnipeitInfo.md +++ b/docs/Set-SnipeitInfo.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -8,16 +8,18 @@ schema: 2.0.0 # Set-SnipeitInfo ## SYNOPSIS -Sets authetication information +Sets authetication information. +Deprecated, use Connect-SnipeitPS instead. ## SYNTAX ``` -Set-SnipeitInfo [[-url] ] [[-apiKey] ] [] +Set-SnipeitInfo [-url] [-apiKey] [] ``` ## DESCRIPTION -Set apikey and url user to connect Snipe-It system +Deprecated combatibilty function that Set apikey and url user to connect Snipe-It system. +Please use Connect-SnipeitPS instead. ## EXAMPLES @@ -29,14 +31,14 @@ Set-SnipeitInfo -url $url -apiKey -Verbose ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: False @@ -44,14 +46,14 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +URL of Snipeit system. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Required: False +Required: True Position: 1 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitLicense.md b/docs/Set-SnipeitLicense.md index 00a36ea..1482a72 100644 --- a/docs/Set-SnipeitLicense.md +++ b/docs/Set-SnipeitLicense.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -18,7 +18,7 @@ Set-SnipeitLicense [-id] [[-name] ] [[-seats] ] [[-cate [[-license_name] ] [[-maintained] ] [[-manufacturer_id] ] [[-notes] ] [[-order_number] ] [[-purchase_cost] ] [[-purchase_date] ] [[-reassignable] ] [[-serial] ] [[-supplier_id] ] [[-termination_date] ] - [[-RequestType] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,14 +34,15 @@ Set-SnipeitLicence -name "License" -seats 3 -company_id 1 ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 21 Default value: None Accept pipeline input: False @@ -335,14 +336,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 20 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitLicenseSeat.md b/docs/Set-SnipeitLicenseSeat.md index f8ba02b..4948f93 100644 --- a/docs/Set-SnipeitLicenseSeat.md +++ b/docs/Set-SnipeitLicenseSeat.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Set license seat or checkout license seat ``` Set-SnipeitLicenseSeat [-id] [-seat_id] [[-assigned_to] ] [[-asset_id] ] - [[-note] ] [[-RequestType] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [[-note] ] [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -44,14 +44,15 @@ Checkin licence seat id 1 of licence id 1 ## PARAMETERS ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 8 Default value: None Accept pipeline input: False @@ -150,14 +151,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 7 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitLocation.md b/docs/Set-SnipeitLocation.md index c1ffa14..b5b37b6 100644 --- a/docs/Set-SnipeitLocation.md +++ b/docs/Set-SnipeitLocation.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,7 +16,7 @@ Updates Location in Snipe-it asset system Set-SnipeitLocation [-id] [[-name] ] [[-address] ] [[-address2] ] [[-state] ] [[-country] ] [[-zip] ] [[-city] ] [[-currency] ] [[-manager_id] ] [[-ldap_ou] ] [[-parent_id] ] [[-image] ] [-image_delete] - [[-RequestType] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -62,14 +62,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 16 Default value: None Accept pipeline input: False @@ -258,14 +259,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 15 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitManufacturer.md b/docs/Set-SnipeitManufacturer.md index 18ea40e..9eac04b 100644 --- a/docs/Set-SnipeitManufacturer.md +++ b/docs/Set-SnipeitManufacturer.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,7 +14,7 @@ Add a new Manufacturer to Snipe-it asset system ``` Set-SnipeitManufacturer [-Name] [[-image] ] [-image_delete] [[-RequestType] ] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +30,15 @@ New-SnipeitManufacturer -name "HP" ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 5 Default value: None Accept pipeline input: False @@ -106,14 +107,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 4 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitModel.md b/docs/Set-SnipeitModel.md index 41bb999..92a8c77 100644 --- a/docs/Set-SnipeitModel.md +++ b/docs/Set-SnipeitModel.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -15,7 +15,7 @@ Updates Model on Snipe-it asset system ``` Set-SnipeitModel [-id] [[-name] ] [[-model_number] ] [[-category_id] ] [[-manufacturer_id] ] [[-eol] ] [[-custom_fieldset_id] ] [[-image] ] - [-image_delete] [[-RequestType] ] [-url] [-apiKey] [-WhatIf] [-Confirm] + [-image_delete] [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` @@ -32,14 +32,15 @@ New-SnipeitModel -name "DL380" -manufacturer_id 2 -fieldset_id 2 -category_id 1 ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 11 Default value: None Accept pipeline input: False @@ -198,14 +199,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitStatus.md b/docs/Set-SnipeitStatus.md index e8f37c0..42f7f20 100644 --- a/docs/Set-SnipeitStatus.md +++ b/docs/Set-SnipeitStatus.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -14,8 +14,8 @@ Sets Snipe-it Status Labels ``` Set-SnipeitStatus [-id] [[-name] ] [-type] [[-notes] ] [[-color] ] - [[-show_in_nav] ] [[-default_label] ] [[-RequestType] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-show_in_nav] ] [[-default_label] ] [[-RequestType] ] [[-url] ] + [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,14 +36,15 @@ Set-SnipeitStatus -id 3 -name 'Waiting for arrival' -type pending ## PARAMETERS ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 10 Default value: None Accept pipeline input: False @@ -172,14 +173,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 9 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitSupplier.md b/docs/Set-SnipeitSupplier.md index c1e35e6..7431ec2 100644 --- a/docs/Set-SnipeitSupplier.md +++ b/docs/Set-SnipeitSupplier.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -16,7 +16,7 @@ Modify the supplier Set-SnipeitSupplier [-name] [[-address] ] [[-address2] ] [[-city] ] [[-state] ] [[-country] ] [[-zip] ] [[-phone] ] [[-fax] ] [[-email] ] [[-contact] ] [[-notes] ] [[-image] ] [-image_delete] - [[-RequestType] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -62,14 +62,15 @@ Accept wildcard characters: False ``` ### -apiKey -Users API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 16 Default value: None Accept pipeline input: False @@ -258,14 +259,15 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 15 Default value: None Accept pipeline input: False diff --git a/docs/Set-SnipeitUser.md b/docs/Set-SnipeitUser.md index d2ca9f5..6987a2e 100644 --- a/docs/Set-SnipeitUser.md +++ b/docs/Set-SnipeitUser.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 --- @@ -13,11 +13,11 @@ Creates a new user ## SYNTAX ``` -Set-SnipeitUser [-id] [[-first_name] ] [[-last_name] ] [[-userName] ] +Set-SnipeitUser [-id] [[-first_name] ] [[-last_name] ] [[-username] ] [[-jobtitle] ] [[-email] ] [[-phone] ] [[-password] ] [[-company_id] ] [[-location_id] ] [[-department_id] ] [[-manager_id] ] [[-employee_num] ] [[-activated] ] [[-notes] ] [[-image] ] [-image_delete] [[-RequestType] ] - [-url] [-apiKey] [-WhatIf] [-Confirm] [] + [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,14 +49,15 @@ Accept wildcard characters: False ``` ### -apiKey -User's API Key for Snipeit, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +User's API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 19 Default value: None Accept pipeline input: False @@ -305,21 +306,22 @@ Accept wildcard characters: False ``` ### -url -URL of Snipeit system, can be set using Set-SnipeitInfo command +Deprecated parameter, please use Connect-SnipeitPS instead. +URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 18 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -userName +### -username Username for user ```yaml diff --git a/docs/SnipeitPS.md b/docs/SnipeitPS.md index 2378a40..37d1842 100644 --- a/docs/SnipeitPS.md +++ b/docs/SnipeitPS.md @@ -1,16 +1,19 @@ --- -Module Name: SnipeitPS +Module Name: snipeitps Module Guid: f86f4db4-1cb1-45c4-b7bf-6762531bfdeb Download Help Link: {{ Update Download Link }} Help Version: {{ Please enter version of help manually (X.X.X.X) format }} Locale: en-US --- -# SnipeitPS Module +# snipeitps Module ## Description {{ Fill in the Description }} -## SnipeitPS Cmdlets +## snipeitps Cmdlets +### [Connect-SnipeitPS](Connect-SnipeitPS.md) +Sets authetication information + ### [Get-SnipeitAccessory](Get-SnipeitAccessory.md) Gets a list of Snipe-it Accessories @@ -192,7 +195,8 @@ Add a new Custom Field to Snipe-it asset system Updates a department ### [Set-SnipeitInfo](Set-SnipeitInfo.md) -Sets authetication information +Sets authetication information. +Deprecated, use Connect-SnipeitPS instead. ### [Set-SnipeitLicense](Set-SnipeitLicense.md) Updates a licence diff --git a/docs/Update-SnipeitAlias.md b/docs/Update-SnipeitAlias.md index 1dd3141..1ef58b5 100644 --- a/docs/Update-SnipeitAlias.md +++ b/docs/Update-SnipeitAlias.md @@ -1,6 +1,6 @@ --- external help file: SnipeitPS-help.xml -Module Name: SnipeitPS +Module Name: snipeitps online version: schema: 2.0.0 ---