PSImmich

Author(s)

• Hannes Palmquist

Tags

Windows Linux MacOS

Functions

Add-IMActivity Get-IMActivity Get-IMActivityStatistic Remove-IMActivity Add-IMAlbumUser Get-IMAlbum Get-IMAlbumCount New-IMAlbum Remove-IMAlbum Remove-IMAlbumUser Rename-IMAlbum Set-IMAlbum Set-IMAlbumUser Get-IMAPIKey New-IMAPIKey Remove-IMAPIKey Rename-IMAPIKey Export-IMAssetThumbnail Get-IMAsset Get-IMAssetMemoryLane Get-IMAssetStatistic Import-IMAsset Remove-IMAsset Restore-IMAsset Save-IMAsset Set-IMAsset Start-IMVideoTranscode Update-IMAssetMetadata Update-IMAssetThumbnail Get-IMAuditDelete Test-IMAccessToken Get-IMAuthSession Remove-IMAuthSession Get-IMFace Get-IMAuditFile Get-IMFileChecksum Clear-IMJob Get-IMJob Resume-IMJob Start-IMJob Suspend-IMJob Get-IMLibrary New-IMLibrary Remove-IMLibrary Remove-IMOfflineLibraryFile Set-IMLibrary Sync-IMLibrary Test-IMLibrary Get-IMMapMarker Get-IMMapStyle Get-IMMemory New-IMMemory Remove-IMMemory Set-IMMemory Send-IMTestMessage Add-IMPartner Get-IMPartner Remove-IMPartner Set-IMPartner Export-IMPersonThumbnail Get-IMPerson Merge-IMPerson New-IMPerson Set-IMPerson Find-IMAsset Find-IMCity Find-IMExploreData Find-IMPerson Find-IMPlace Get-IMConfig Set-IMConfig Get-IMServer Get-IMServerConfig Get-IMServerFeature Get-IMServerStatistic Get-IMServerStorage Get-IMServerVersion Get-IMSupportedMediaType Get-IMTheme Test-IMPing Connect-Immich Disconnect-Immich Get-IMSession Invoke-ImmichMethod Add-IMSharedLinkAsset Get-IMSharedLink New-IMSharedLink Remove-IMSharedLink Remove-IMSharedLinkAsset Set-IMSharedLink Get-IMTag New-IMTag Remove-IMTag Rename-IMTag Set-IMTag Get-IMTimeBucket Add-IMMyProfilePicture Export-IMProfilePicture Get-IMUser New-IMUser Remove-IMMyProfilePicture Remove-IMUser Restore-IMUser Set-IMUser

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

## [1.107.0] - 2024-07-02

### IMPORTANT NOTE

- The previous release had the aim to simplify the use of Get-IMAlbum and to align the cmdlet to how a powershell user would expect a cmdlet to function. However the changes caused quite a lot of breaking changes not motivated by the gains. And actually caused some behavior in itself that might be unexpected as a powershell user. Therefor the previous release has been yanked and a new version will be released with more moderate changes.

### Added

- Get-IMAlbum now has a -Name parameter allowing you to return a single album with the name specified.
- Get-IMAlbum now has a -SearchString parameter allowing you to do wildcard searches for album names.
- Many cmdlets, mainly "set"-cmdlets returned an empty string for each object that was updated, this noise is now suppressed.
- Most objects is now tagged with a type name that allows default table formatting to be applied.

### Fixed

- Find-IMPerson, fixed issue where parameter values was not sent correctly to the API
- Find-IMPlace, fixed issue where parameter values was not sent correctly to the API

### Changed

- Get-IMAlbum, Before you had to use -withoutAssets:$false to return assets which is not logical. This parameter has been changed to a switch parameter named IncludeAssets. This means that Get-IMAlbum will by default not return assets as part of the album object returned. You must specify -IncludeAssets if assets should be returned.
- Get-IMAlbum, the parameter -IncludeAssets can now be used in list-mode as well. Previously -IncludeAssets (withoutAssets) was only effective together with the -Id parameter.