Skip to content

Remove-AwtrixApp

SYNOPSIS

Removes a custom app from the AWTRIX device.

SYNTAX

Remove-AwtrixApp [-Name] <String> [-BaseUri <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Deletes a custom app from the AWTRIX 3 device by sending an empty payload to its endpoint. When deleting, AWTRIX matches apps that start with the specified name, so removing 'test' will also remove 'test0', 'test1', etc.

EXAMPLES

EXAMPLE 1

Remove-AwtrixApp -Name 'myapp'

Removes the custom app named 'myapp'.

EXAMPLE 2

Remove-AwtrixApp -Name 'test'

Removes all apps starting with 'test' (test0, test1, etc.).

PARAMETERS

-Name

The name of the custom app to remove.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BaseUri

The base URI of the AWTRIX device. If not specified, uses the connection from Connect-Awtrix.

Type: String
Parameter Sets: (All)
Aliases:

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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.

INPUTS

OUTPUTS

NOTES