Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 2.42 KB

Start-ArchivialLocalSourceRescan.md

File metadata and controls

103 lines (75 loc) · 2.42 KB
external help file Module Name online version schema
ArchivialPowerShell.dll-Help.xml
ArchivialPowerShell
2.0.0

Start-ArchivialLocalSourceRescan

SYNOPSIS

Forces the re-scan of a Local Source being monitored by Archivial.

SYNTAX

ByName

Start-ArchivialLocalSourceRescan -SourceID <Int32> [<CommonParameters>]

ByObject

Start-ArchivialLocalSourceRescan -LocalSource <LocalSourceLocation> [<CommonParameters>]

DESCRIPTION

All sources are monitored for new or updated files on a regular schedule. This cmdlet is used to request an immediate rescan, outside of its regular schedule. The rescan will start as soon as there is scanning engine availability.

The automated scanning schedule for Low priority sources is once every 48 hours. Medium priority sources are scanned every 12 hours. High priority sources are scanned every hour.

Please see the Get-ArchivialLocalSources command to find the ID of an existing source you would like to rescan.

EXAMPLES

EXAMPLE 1

C:\> Start-ArchivialLocalSourceRescan -SourceID 2

Forces a rescan of the Local Source with the specified ID.

EXAMPLE 2

C:\> Get-ArchivialLocalSources | Start-ArchivialLocalSourceRescan

Forces a rescan of all defined Local Sources being monitored by Archivial.

EXAMPLE 3

C:\> Get-ArchivialLocalSources | Where Path -like "*D:\temp*" | Start-ArchivialLocalSourceRescan

Forces a rescan of any Local Sources that match the path filter.

PARAMETERS

-SourceID

Specify the ID of the Local Source to rescan.

Type: Int32
Parameter Sets: ByName
Aliases:

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

-LocalSource

Specify the Local Source object to rescan.

Type: LocalSourceLocation
Parameter Sets: ByObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

ArchivialLibrary.Folders.LocalSourceLocation

Specify the Local Source object to rescan.

OUTPUTS

NOTES

RELATED LINKS