Set-IMWorkflow

SYNOPSIS

Updates an Immich workflow

SYNTAX

Set-IMWorkflow [[-Session] <ImmichSession>] [-Id] <String[]> [[-Name] <String>] [[-Description] <String>]
 [[-TriggerType] <String>] [[-Enabled] <Boolean>] [[-Actions] <Hashtable[]>] [[-Filters] <Hashtable[]>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates various properties of an Immich workflow including name, description, trigger type, enabled state, filters, and actions. Note: Workflow functionality is in Alpha state as of Immich v2.3.1.

EXAMPLES

EXAMPLE 1

Set-IMWorkflow -Id 'workflow-uuid' -Description 'Updated workflow for processing new photos'

Updates the workflow description.

EXAMPLE 2

Set-IMWorkflow -Id 'workflow-uuid' -Enabled:$false

Disables the workflow.

EXAMPLE 3

Set-IMWorkflow -Id 'workflow-uuid' -Name 'New Workflow Name' -TriggerType 'schedule'

Renames the workflow and changes its trigger type.

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 workflow(s) to update. 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

-Name

The new name for the workflow.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

The new description for the workflow.

Type: String
Parameter Sets: (All)
Aliases:

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

-TriggerType

The trigger type for the workflow. This determines when the workflow will be executed.

Type: String
Parameter Sets: (All)
Aliases:

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

-Enabled

Specifies whether the workflow should be enabled or disabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Actions

An array of workflow action objects that define what the workflow will do when triggered.

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

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

-Filters

An array of workflow filter objects that define the conditions for workflow execution.

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

Required: False
Position: 8
Default value: None
Accept pipeline input: False
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 making changes. This feature is in Alpha state and may be subject to changes in future Immich versions.

RELATED LINKS

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