Search-IMAsset

SYNOPSIS

SYNTAX

Search-IMAsset [[-Session] <ImmichSession>] [[-city] <String>] [[-country] <String>]
 [[-createdAfter] <DateTime>] [[-createdBefore] <DateTime>] [[-deviceId] <String>] [[-isArchived] <Boolean>]
 [[-isEncoded] <Boolean>] [[-isFavorite] <Boolean>] [[-isMotion] <Boolean>] [[-isNotInAlbum] <Boolean>]
 [[-isOffline] <Boolean>] [[-isVisible] <Boolean>] [[-lensModel] <String>] [[-libraryId] <String>]
 [[-make] <String>] [[-model] <String>] [[-personIds] <String[]>] [-query] <String> [[-rating] <Int32>]
 [[-size] <Int32>] [[-state] <String>] [[-tagIds] <String[]>] [[-takenAfter] <DateTime>]
 [[-takenBefore] <DateTime>] [[-trashedAfter] <DateTime>] [[-trashedBefore] <DateTime>] [[-type] <String>]
 [[-updatedAfter] <DateTime>] [[-updatedBefore] <DateTime>] [[-withArchived] <Boolean>]
 [[-withDeleted] <Boolean>] [[-withExif] <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Search for assets using smart search

EXAMPLES

EXAMPLE 1

Search-IMAsset -Query 'Road'

Searches for assets matching content Road.

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: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-city

City filter

Type: String
Parameter Sets: (All)
Aliases:

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

-country

Country filter

Type: String
Parameter Sets: (All)
Aliases:

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

-createdAfter

CreatedAfter filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-createdBefore

CreatedBefore filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-deviceId

Device Id filter

Type: String
Parameter Sets: (All)
Aliases:

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

-isArchived

Archvied filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isEncoded

Encoded filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isFavorite

Favorite filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isMotion

Motion filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isNotInAlbum

Not in Album filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isOffline

Offline filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isVisible

Visible filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-lensModel

Lens model filter

Type: String
Parameter Sets: (All)
Aliases:

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

-libraryId

Library id filter

Type: String
Parameter Sets: (All)
Aliases:

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

-make

Make filter

Type: String
Parameter Sets: (All)
Aliases:

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

-model

Model filter

Type: String
Parameter Sets: (All)
Aliases:

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

-personIds

Person id filter

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

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

-query

Query filter

Type: String
Parameter Sets: (All)
Aliases: SearchString

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

-rating

Rating filter

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-size

Size of rest call page

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-state

State filter

Type: String
Parameter Sets: (All)
Aliases:

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

-tagIds

Tag id filter

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

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

-takenAfter

Taken after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-takenBefore

Taken before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-trashedAfter

Trashed after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-trashedBefore

Trashed before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-type

Type filter

Type: String
Parameter Sets: (All)
Aliases:

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

-updatedAfter

Updated after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-updatedBefore

Updated before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-withArchived

Archived filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-withDeleted

Deleted filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-withExif

Exif filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

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