Skip to main content

New-IMPerson

SYNOPSIS​

Creates a new person record.

SYNTAX​

New-IMPerson [[-Session] <ImmichSession>] [-Name] <String> [-IsHidden] [[-BirthDate] <DateTime>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Manually creates a person entry for face recognition training and organization.

EXAMPLES​

EXAMPLE 1​

New-IMPerson -Name 'John Smith' -BirthDate '1990-01-01'

Creates a new person with name and birth date.

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-Name​

Display name for the person.

Type: String
Parameter Sets: (All)
Aliases:

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

-IsHidden​

Set to $true to hide person from main interface.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BirthDate​

Person's birth date for timeline context.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
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​

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