Skip to main content

Get-IMJob

SYNOPSIS​

Retrieves Immich background job information

SYNTAX​

Get-IMJob [[-Session] <ImmichSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Retrieves information about all background jobs in Immich, including their status, progress, and queue information. This helps monitor system processing and job performance.

EXAMPLES​

EXAMPLE 1​

Get-IMJob

Retrieves information about all background jobs.

EXAMPLE 2​

$jobs = Get-IMJob
$jobs | Where-Object {$_.jobCounts.active -gt 0}

Gets jobs that are currently active.

EXAMPLE 3​

Get-IMJob | Format-Table name, @{Name='Active';Expression={$_.jobCounts.active}}, @{Name='Waiting';Expression={$_.jobCounts.waiting}}

Displays job information in a formatted table showing active and waiting job counts.

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

-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​

Job information includes queue status, active jobs, waiting jobs, and completed job counts for each job type.

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