Skip to main content

Remove-IMAlbum

SYNOPSIS​

Removes Immich albums

SYNTAX​

Remove-IMAlbum [[-Session] <ImmichSession>] [-AlbumId] <String[]> [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Removes one or more albums from the Immich server. This action is permanent and cannot be undone. All assets in the album will remain in the library but will no longer be organized in the deleted album.

EXAMPLES​

EXAMPLE 1​

Remove-IMAlbum -AlbumId 'bde7ceba-f301-4e9e-87a2-163937a2a3db'

Removes the specified album with confirmation prompt.

EXAMPLE 2​

Get-IMAlbum -SearchString 'temp*' | Remove-IMAlbum

Removes all albums with names starting with 'temp'.

EXAMPLE 3​

Remove-IMAlbum -AlbumId 'album-uuid' -Confirm:$false

Removes the album without confirmation prompt.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-AlbumId​

The UUID(s) of the album(s) to remove. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: (All)
Aliases: id

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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​

This cmdlet supports ShouldProcess and will prompt for confirmation before removing albums. Assets within the album are not deleted, only the album container is removed.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github