Skip to main content

Get-IMPerson

SYNOPSIS​

SYNTAX​

list (Default)​

Get-IMPerson [-Session <ImmichSession>] [-withHidden] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id​

Get-IMPerson [-Session <ImmichSession>] -id <String> [-IncludeStatistics] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Retreives Immich person

EXAMPLES​

EXAMPLE 1​

Get-IMPerson

Retreives Immich person

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

-id​

Defines a specific person to be retreived

Type: String
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-withHidden​

Defines if hidden should be returned or not. Do not specify if either should be returned.

Type: SwitchParameter
Parameter Sets: list
Aliases:

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

-IncludeStatistics​

Defines if statistics should be returned for the person

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