Skip to main content

Update-IMAssetMetadata

SYNOPSIS​

Updates Immich asset metadata

SYNTAX​

Update-IMAssetMetadata [[-Session] <ImmichSession>] [-Id] <String[]> [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Triggers a metadata refresh job for one or more assets, causing Immich to re-extract and update metadata information such as EXIF data, location, and other file properties.

EXAMPLES​

EXAMPLE 1​

Update-IMAssetMetadata -Id 'asset-uuid'

Triggers metadata refresh for the specified asset with confirmation prompt.

EXAMPLE 2​

@('asset1-uuid', 'asset2-uuid') | Update-IMAssetMetadata

Refreshes metadata for multiple assets via pipeline.

EXAMPLE 3​

Get-IMAsset -TagId 'needs-update' | Update-IMAssetMetadata -Confirm:$false

Refreshes metadata for all assets with a specific tag without confirmation.

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

-Id​

The UUID(s) of the asset(s) to refresh metadata for. Accepts pipeline input and multiple values.

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

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 updating metadata. The operation creates a background job that may take time to complete for large numbers of assets.

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