Skip to main content

Resume-IMJob

SYNOPSIS​

Resumes suspended Immich background jobs

SYNTAX​

Resume-IMJob [[-Session] <ImmichSession>] [-Job] <String[]> [-Force] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Resumes processing of previously suspended job types in Immich. This allows the job queues to continue processing pending items and accept new jobs.

EXAMPLES​

EXAMPLE 1​

Resume-IMJob -Job 'thumbnailGeneration'

Resumes thumbnail generation processing.

EXAMPLE 2​

Resume-IMJob -Job 'videoConversion' -Force

Forcibly resumes video conversion jobs.

EXAMPLE 3​

Get-IMJob | Where-Object {$_.jobCounts.paused -gt 0} | ForEach-Object { Resume-IMJob -Job $_.name }

Resumes all job types that have paused jobs.

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

-Job​

The type of job to resume. Valid values include thumbnailGeneration, metadataExtraction, videoConversion, faceDetection, and other background job types.

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

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

-Force​

Forces the resumption without additional confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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​

Use this cmdlet to resume jobs that were previously suspended with Suspend-IMJob. Monitor job status with Get-IMJob to verify jobs are processing normally after resuming.

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