--- external help file: SnipeitPS-help.xml Module Name: SnipeitPS online version: schema: 2.0.0 --- # Set-SnipeitStatus ## SYNOPSIS Sets Snipe-it Status Labels ## SYNTAX ``` Set-SnipeitStatus [-id] [[-name] ] [-type] [[-notes] ] [[-color] ] [[-show_in_nav] ] [[-default_label] ] [[-RequestType] ] [[-url] ] [[-apiKey] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION {{ Fill in the Description }} ## EXAMPLES ### EXAMPLE 1 ``` Get-SnipeitStatus -search "Ready to Deploy" ``` ### EXAMPLE 2 ``` Set-SnipeitStatus -id 3 -name 'Waiting for arrival' -type pending ``` ## PARAMETERS ### -apiKey Deprecated parameter, please use Connect-SnipeitPS instead. Users API Key for Snipeit. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -color Hex code showing what color the status label should be on the pie chart in the dashboard ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -default_label 1 or 0 - determine whether it should be bubbled up to the top of the list of available statuses ```yaml Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: 7 Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -id A id of specific Status Label ```yaml Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -name {{ Fill name Description }} ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -notes {{ Fill notes Description }} ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -RequestType Http request type to send Snipe IT system. Defaults to Patch you could use Put if needed. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: 8 Default value: Patch Accept pipeline input: False Accept wildcard characters: False ``` ### -show_in_nav 1 or 0 - determine whether the status label should show in the left-side nav of the web GUI ```yaml Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: 6 Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -type {{ Fill type Description }} ```yaml Type: String Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -url Deprecated parameter, please use Connect-SnipeitPS instead. URL of Snipeit system. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES ## RELATED LINKS