--- external help file: SnipeitPS-help.xml Module Name: SnipeitPS online version: schema: 2.0.0 --- # Get-SnipeitLicense ## SYNOPSIS Gets a list of Snipe-it Licenses ## SYNTAX ### Search (Default) ``` Get-SnipeitLicense [-search ] [-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 [] ``` ### Get with ID ``` Get-SnipeitLicense [-id ] -url -apiKey [] ``` ### Get licenses checked out to user ID ``` Get-SnipeitLicense [-user_id ] [-all] -url -apiKey [] ``` ### Get licenses checked out to asset ID ``` Get-SnipeitLicense [-asset_id ] [-all] -url -apiKey [] ``` ## DESCRIPTION {{ Fill in the Description }} ## EXAMPLES ### EXAMPLE 1 ``` Get-SnipeitLicense -search SomeLicense ``` ### EXAMPLE 2 ``` Get-SnipeitLicense -id 1 ``` ## PARAMETERS ### -search A text string to search the Licenses data ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -id A id of specific License ```yaml Type: Int32 Parameter Sets: Get with ID Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -user_id {{ Fill user_id Description }} ```yaml Type: Int32 Parameter Sets: Get licenses checked out to user ID Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -asset_id {{ Fill asset_id Description }} ```yaml Type: Int32 Parameter Sets: Get licenses checked out to asset ID Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -name {{ Fill name Description }} ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -company_id {{ Fill company_id Description }} ```yaml Type: Int32 Parameter Sets: Search Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -product_key {{ Fill product_key Description }} ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -order_number {{ Fill order_number Description }} ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -purchase_order {{ Fill purchase_order Description }} ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -license_name {{ Fill license_name Description }} ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -license_email {{ Fill license_email Description }} ```yaml Type: MailAddress Parameter Sets: Search Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -manufacturer_id {{ Fill manufacturer_id Description }} ```yaml Type: Int32 Parameter Sets: Search Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -supplier_id {{ Fill supplier_id Description }} ```yaml Type: Int32 Parameter Sets: Search Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -depreciation_id {{ Fill depreciation_id Description }} ```yaml Type: Int32 Parameter Sets: Search Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -category_id {{ Fill category_id Description }} ```yaml Type: Int32 Parameter Sets: Search Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -order {{ Fill order Description }} ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False ``` ### -sort {{ Fill sort Description }} ```yaml Type: String Parameter Sets: Search Aliases: Required: False Position: Named Default value: Created_at Accept pipeline input: False Accept wildcard characters: False ``` ### -limit Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all ```yaml Type: Int32 Parameter Sets: Search Aliases: Required: False Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` ### -offset Offset to use ```yaml Type: Int32 Parameter Sets: Search Aliases: Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -all A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter Parameter Sets: Search, Get licenses checked out to user ID, Get licenses checked out to asset ID Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -url URL of Snipeit system, can be set using Set-SnipeitInfo command ```yaml Type: String Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -apiKey Users API Key for Snipeit, can be set using Set-SnipeitInfo command ```yaml Type: String Parameter Sets: (All) 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