Skip to main content

Get-IMServer

SYNOPSIS​

Retrieves comprehensive Immich server information.

SYNTAX​

about (Default)​

Get-IMServer [-Session <ImmichSession>] [-About] [-ProgressAction <ActionPreference>] [<CommonParameters>]

version​

Get-IMServer [-Session <ImmichSession>] [-Version] [-ProgressAction <ActionPreference>] [<CommonParameters>]

version-history​

Get-IMServer [-Session <ImmichSession>] [-VersionHistory] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

features​

Get-IMServer [-Session <ImmichSession>] [-Features] [-ProgressAction <ActionPreference>] [<CommonParameters>]

statistics​

Get-IMServer [-Session <ImmichSession>] [-Statistics] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configuration​

Get-IMServer [-Session <ImmichSession>] [-Configuration] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

appliedsystemconfiguration​

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

defaultsystemconfiguration​

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

storagetemplateoptions​

Get-IMServer [-Session <ImmichSession>] [-StorageTemplateOptions] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

storage​

Get-IMServer [-Session <ImmichSession>] [-Storage] [-ProgressAction <ActionPreference>] [<CommonParameters>]

mediatypes​

Get-IMServer [-Session <ImmichSession>] [-MediaTypes] [-ProgressAction <ActionPreference>] [<CommonParameters>]

theme​

Get-IMServer [-Session <ImmichSession>] [-Theme] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-IMServer [-Session <ImmichSession>] [-APKLinks] [-ProgressAction <ActionPreference>] [<CommonParameters>]

versioncheck​

Get-IMServer [-Session <ImmichSession>] [-VersionCheck] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

ping​

Get-IMServer [-Session <ImmichSession>] [-Ping] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Gets detailed server properties including version, features, statistics, and configuration. Use different parameter sets to retrieve specific information about the Immich server.

EXAMPLES​

EXAMPLE 1​

Get-IMServer

Retrieves general server information and about details (default).

EXAMPLE 2​

Get-IMServer -Version

Gets the server version in a formatted object.

EXAMPLE 3​

Get-IMServer -Statistics

Retrieves server usage statistics.

EXAMPLE 4​

Get-IMServer -AppliedSystemConfiguration -ReturnRawJSON

Gets current system configuration as raw JSON.

EXAMPLE 5​

Get-IMServer -Ping

Tests if the server is responding.

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-About​

Retrieves general server information and about details.

Type: SwitchParameter
Parameter Sets: about
Aliases:

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

-Version​

Retrieves server version information in a formatted object.

Type: SwitchParameter
Parameter Sets: version
Aliases:

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

-VersionHistory​

Retrieves server version history and release information.

Type: SwitchParameter
Parameter Sets: version-history
Aliases:

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

-Features​

Retrieves information about enabled server features.

Type: SwitchParameter
Parameter Sets: features
Aliases:

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

-Statistics​

Retrieves server usage statistics.

Type: SwitchParameter
Parameter Sets: statistics
Aliases:

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

-Configuration​

Retrieves server configuration settings.

Type: SwitchParameter
Parameter Sets: configuration
Aliases:

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

-AppliedSystemConfiguration​

Retrieves currently applied system configuration.

Type: SwitchParameter
Parameter Sets: appliedsystemconfiguration
Aliases:

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

-DefaultSystemConfiguration​

Retrieves default system configuration values.

Type: SwitchParameter
Parameter Sets: defaultsystemconfiguration
Aliases:

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

-ReturnRawJSON​

Returns system configuration as raw JSON instead of PowerShell object. Only valid with AppliedSystemConfiguration or DefaultSystemConfiguration.

Type: SwitchParameter
Parameter Sets: appliedsystemconfiguration, defaultsystemconfiguration
Aliases:

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

-StorageTemplateOptions​

Retrieves available storage template options.

Type: SwitchParameter
Parameter Sets: storagetemplateoptions
Aliases:

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

-Storage​

Retrieves server storage information and usage.

Type: SwitchParameter
Parameter Sets: storage
Aliases:

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

-MediaTypes​

Retrieves supported media types and formats.

Type: SwitchParameter
Parameter Sets: mediatypes
Aliases:

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

-Theme​

Retrieves server theme configuration.

Type: SwitchParameter
Parameter Sets: theme
Aliases:

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

-APKLinks​

Retrieves mobile application download links.

Type: SwitchParameter
Parameter Sets: apklinks
Aliases:

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

-VersionCheck​

Checks for available server updates.

Type: SwitchParameter
Parameter Sets: versioncheck
Aliases:

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

-Ping​

Tests server connectivity and responsiveness.

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