Skip to main content

Get-IMLibrary

SYNOPSIS​

Retrieves Immich libraries

SYNTAX​

list (Default)​

Get-IMLibrary [-Session <ImmichSession>] [-ownerId <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

id​

Get-IMLibrary [-Session <ImmichSession>] -id <String[]> [-IncludeStatistics]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Retrieves one or more libraries from Immich. Libraries are collections of assets that can be managed separately with different settings, permissions, and storage locations.

EXAMPLES​

EXAMPLE 1​

Get-IMLibrary

Retrieves all libraries accessible to the current user.

EXAMPLE 2​

Get-IMLibrary -Id 'library-uuid' -IncludeStatistics

Retrieves a specific library with detailed statistics.

EXAMPLE 3​

Get-IMLibrary -OwnerId 'user-uuid'

Retrieves all libraries owned by a specific user.

EXAMPLE 4​

Get-IMLibrary | Where-Object {$_.type -eq 'EXTERNAL'}

Retrieves only external libraries (those that scan existing folders).

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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id​

The UUID(s) of specific library(ies) to retrieve. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-IncludeStatistics​

Includes detailed statistics (asset counts, sizes, etc.) in the returned library objects. Only applicable when retrieving specific libraries by ID.

Type: SwitchParameter
Parameter Sets: id
Aliases:

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

-ownerId​

Retrieves libraries owned by a specific user UUID. Only applicable when listing libraries.

Type: String
Parameter Sets: list
Aliases:

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​

Libraries can be either UPLOAD (for uploading new assets) or EXTERNAL (for scanning existing folders).

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