Skip to main content

Get-IMConfig

SYNOPSIS

SYNTAX

applied (Default)

Get-IMConfig [-Session <ImmichSession>] [-ReturnRawJSON] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

default

Get-IMConfig [-Session <ImmichSession>] [-ReturnRawJSON] [-Default] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

storage

Get-IMConfig [-Session <ImmichSession>] [-StorageTemplate] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION

Retreives Immich config

EXAMPLES

EXAMPLE 1

Get-IMConfig

Retreives Immich config

PARAMETERS

-Session

Optionally define a immich session object to use. This is useful when you are connected to more than one immich instance.

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-ReturnRawJSON

This is useful if you want to alter the current config and pass it on to Set-IMConfig

Type: SwitchParameter
Parameter Sets: applied, default
Aliases:

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

-Default

Retreives default config instead of current applied

Type: SwitchParameter
Parameter Sets: default
Aliases:

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

-StorageTemplate

Specifies that storage template configuration should be returned.

Type: SwitchParameter
Parameter Sets: storage
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

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