ScheduleScan¶
Description
Scans the passed directory on the given first scan date at the given time, and scans thereafter in the given intervals.
Syntax
ScheduleScan (Path : <String>, ScanTime : <String>, Interval : <Integer>, FirstScanDate : <String>)
Parameters
- Path
An existing or new root path, for which the new scan should be scheduled.
- ScanTime
The time of day to perform the scan. Please use the ISO time format: “hh-mm”.
- Interval
The interval in days between each scan.
- FirstScanDate
The date of the first scheduled scan. Please use the ISO date format: “YYYY-MM-DD”.
Example
1.)
$SOS.ScheduleScan("\\Server1\C$\", "22-45", 7, "2010-01-01")
SOS.ScheduleScan "\\Server1\C$\", "22-45", 7, "2010-01-01"
Schedules a scan of the root share “\Server1C$" for the 1st of January 2010, a quarter to 11 o’clock in the evening. This scan will be repeated every week (7 days) at the same time.
Remarks
The scan can only be started if the observing server is running, the SpaceObServer scan service is running on this server and if the observing server is not executing any other scans (scans are always executed sequential).